Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

CommandSub-commandDescription
[--server <uri>]-

This option is used to specify either the remote server you want to connect to or a folder on disk which contains a .nupkg file. If you do not use this command (it is not mandatory), all remote servers specified in the %programdata%\CAST\CAST\Extensions\ServerList.xml file will be used.

Remote Server

For example https://extend.castsoftware.com:443/product.

Folder - note that this option is to be used if you have a raw .nupkg file that requires unpacking

D:\USER_DATA\Downloads

[--username <username>]-

When connecting to a server that requires authentication (for example https://extend.castsoftware.com:443/V2/api/v2) to download an extension (with the install option), use these two options to specify your credentials.

Info

Note that:

  • these two commands are ONLY available in the standalone version (≥ 1.1.0) of the CAST Extension Downloader which is available for download from https://confluence.castsoftware.com/display/download/Extension+Downloader. The commands are not available in the CAST Extension Downloader provided in the CAST AIP setup or the custom release specifically for CAST AIP 7.3.x.
  • you will require an account on the remote server to use these commands - if you are using CAST Extend (https://extend.castsoftware.com:443/V2/api/v2) you can find out about registering for an account in CAST Extend website.
[--password <password>]-
listavailable|installed|upgradable|all

Use this option to produce a list of the extensions as follows:

OptionDescription
availableThis option displays all the extensions that are available on the remote server that have not already been downloaded to the local machine.
installed

This option displays all the extensions that have already been downloaded on to the local machine. Extensions are downloaded to:

No Format
AIP 8.x.x: %PROGRAMDATA%\CAST\CAST\Extensions
AIP 7.3.x <CAST_installation_folder>\CustomPlugins
Info
Note that for CAST AIP 8.x.x and above, you can modify the download location as described in Download an extension.
upgradeableupgradableThis option displays all extensions that are available on the remote server that are a more recent version of an extension that has already been downloaded to the local machine.
allThis option displays all extensions on the specified remote server, regardless of whether they have already been downloaded to the local machine or their CAST AIP version compatibility.
install

<extensionId>

[--version <version>]

[--ignore-dependencies]


Use this option to specify an extension that you want to download on to your machine. Note that you may also need to specify the --username and --password options if the remote server requires authentication

OptionDescription
<extensionId>

This option allows you to specify a particular extension for download using its ID - this is a mandatory option. The ID of a CAST AIP extension always takes the form com.castsoftware.<name>, without any version numbers. You can determine the ID of an extension using the CAST Extension Downloader in GUI mode:

Info
Note that the most recent versions of an extension's dependencies will always be downloaded alongside the extension, unless you are using the [--ignore-dependencies] option - see below.
[--version <version>]

This option allows you to specify a specific version of the extension for download using its version number. You can determine the ID of an extension using the CAST Extension Downloader in GUI mode:

Info
This option is not mandatory. When not included, the most recent version of the extension you require will always be downloaded.
[--ignore-dependencies]

This option allows you to download an extension without any dependencies. CAST only recommends using this option if you understand the implication - an extension will not function correctly without its dependencies.

Info
This option is not mandatory. When not included, the most recent versions of an extension's dependencies will always be downloaded.
uninstall

extensionId

[--version <version>]

Use this option to specify an extension that you have downloaded to your machine and that you now want to remove from your machine:

OptionDescription
extensionIdThis option allows you to specify a particular extension for removal using its ID - this is a mandatory option. The ID of a CAST AIP extension always takes the form com.castsoftware.<name>, without any version numbers. You can determine the ID of an extension using the CAST Extension Downloader in GUI mode - see same option described above.
[--version <version>]

This option allows you to specify a specific version of the extension for download using its version number. You can determine the ID of an extension using the CAST Extension Downloader in GUI mode - see same option described above.

Info
This option is not mandatory. When not included, the most recent version of the extension you require will always be deleted from your machine.
Info

Note that:

  • removing an extension will only delete the extension files on the local machine. It does not remove the extension from any CAST AIP databases/schemas that it has been installed to.
  • removing an extension only removes the specific extension. Any dependencies are left on the machine as other extensions may require them.
  • removing an extension from your machine will cause the following log message to be displayed in CAST Server Manager when CAST AIP databases/schemas that use the extension are detected:
No Format
Extension com.castsoftware.test version : 1.2.0-funcrel is not present on this machine,
and some schemas are using it. Please use ExtensionDownloader to download it and rerun Servman.

...

Code Block
languagetext
themeDJango
ExtensionDownloader.exe --server https://extend.castsoftware.com:443/V2/api/v2 list upgradeableupgradable

Download the most recent version of a specific extension on a specific remote server with authentication:

...