Install-Module
Command Reference
Description
Installs the specified module.
Installs the specified module. Downloads from the repository and extracts it.
Access
Managed-Entity includes this base implementation for retrieving and installing modules driven by the following two parameters.
- modules.dir: This property references the directory where the module archive will be extracted.
- modules.url: This property references a base URL that can be used to retrieve the modules archives from a repository.
The locations for either property above can be modified via the framework configuration file, ${antdepo.base}/etc/modules.properties.
For efficiency sake, this implementation uses a timestamp check to compare if the module archive found in ${modules.url} is newer than the locally installed one, and if so, will download a new copy and install the new one.
Usage
ctl -t Managed-Entity -o <objectname> -c Install-Module [-depot <>] [-downloaddir <${framework.var.dir}/tmp/downloads/${context.depot}>] -module <> [-modulesurl <>] [-version <head>]
Options
| Option | Description | Type | Default |
|---|---|---|---|
| depot | project depot | string | ${context.depot} |
| downloaddir | destination directory where module jars are downloaded | string | ${framework.var.dir}/tmp/downloads/${context.depot} |
| module | module name | string | |
| modulesurl |
base uri where published modules are staged
This command uses this URL base to construct a URL that includes the module name and version. The URL format is: ${opts.modulesurl} +"/" + ${opts.module}+"-"+${opts.version}+".jar" |
string | ${modules.url} |
| version |
required module version
Modules have a version associated with them and in archive form have a version identifier. Typically, these are numeric but by CTL convention one may also use the version named "head" to represent the latest version. |
string | head |