manageSolutionKits command

Example: Install a simple Solution Kit
gateway10cr1
Purpose and Usage
Use to install, upgrade, or remove Solution Kits. The manageSolutionKits command contains these subcommands for each action:
  • install
  • upgrade
  • uninstall
Refer to the on-screen help for a complete list of the parameters for each command:
$ ./GatewayMigrationUtility.sh manageSolutionKits install $ ./GatewayMigrationUtility.sh manageSolutionKits upgrade $ ./GatewayMigrationUtility.sh manageSolutionKits uninstall
New for Gateway Version 10 CR1: solutionKitSelectByName Parameter
Available as of Gateway Version 10 CR1, you can now identify Solution Kits and applicable child Solution Kits by a text-based name instead of a GUID with the new
solutionkitSelectByName
,
--name
, and
--childName
parameters. The following tables compare the existing GUID-based Solution Kit identification parameters and the new name-based equivalents in the install, upgrade, and uninstall contexts. Parameters such as the instance modifier (IM) were deliberately excluded from the examples for simplicity. Additional detailed examples of the install, upgrade, and uninstall commands are available on this page.
Installing Solution Kits
Base command: manageSolutionKits install
Solution Kit GUID
Solution Kit Name (New)
solutionkitSelect
Example:
--solutionKitSelect "33b16742-d62d-4095-8f8d-4db707e9ad53"
solutionkitSelectByName
Example:
--solutionKitSelectByName "ACME Solution Kit"
Both parameters identify the Solution kit to be installed from the SKAR. Note that GUID and name parameters both cannot co-exist in a single command, otherwise an error is returned.
Upgrading Solution Kits
Base command: manageSolutionKits upgrade
Solution Kit GUID
Solution Kit Name (New)
--id
Example:
--id "33b16742-d62d-4095-8f8d-4db707e9ad54"
--name
Example:
--name "ACME Solution Kit"
Both parameters identify the Solution Kit to upgrade - they apply to either a parent or child Solution Kit.
Solution Kit GUID
Solution Kit Name (New)
solutionkitSelect
Example:
--id "879ceb21-ba60-443f-a484-11e59ee04da4" --solutionKitSelect "33b16742-d62d-4095-8f8d-4db707e9ad53"
solutionkitSelectByName
Example:
--name "Parent Solution Kit" --solutionKitSelectByName "Child Solution Kit"
Both parameters identify individual child Solution Kit(s) for the upgrade. Note that you must use the child identifier in conjunction with the parent identifier as shown in the examples.
Uninstalling Solution Kits
Base command: manageSolutionKits uninstall
Solution Kit GUID
Solution Kit Name (New)
id
Example:
--id "33b16742-d62d-4095-8f8d-4db707e9ad54"
name
Example:
--name "ACME Solution Kit"
Both parameters identify the Solution Kit to uninstall.
Solution Kit GUID
Solution Kit Name (New)
childId
Example:
--id "879ceb21-ba60-443f-a484-11e59ee04da4" --childId "DE8230BE-4875-71DE-4C4C-EDFED1E95F4A"
childName
Example:
--name "Parent Solution Kit" --childName "Child Solution Kit"
Both parameters identify individual child Solution Kit(s) to uninstall. Note that you must use the child identifier in conjunction with the parent identifier as shown in the examples.
Addendum Bundles
The
install
and
upgrade
subcommands support the use of "addendum" bundles, specified by the "
--addendum
" parameter. If the Solution Kit author enabled the use of such bundles, then you can specify an addendum bundle to override an original Solution Kit bundle. Example usage: You are configuring your Gateway for use with the API Portal. Addendum bundles allows you to customize the API Portal enrollment bundle with values not known until the tenant enrollment process has begun.
Tip:
The Solution Kit author or system administrator will notify you if any addendum bundles are available.
Prerequisites:
  • Only one Solution Kit is in scope. If your Solution Kit contains child kits, then specify the ID of the kit to use via the "
    --solutionKitSelect
    " or the "
    --solutionKitSelectByName
    " parameter.
  • When upgrading a Solution Kit, ensure that you have an addendum bundle specifically intended for upgrading. The mapping actions for upgrade bundles are "NewOrUpdate"  instead of "AlwaysCreateNew". See "Mapping Actions" in Manage Solution Kits for more information.
Install Command
The install command has the following permitted parameters:
install [--addendum <addendum bundle file>] [--clientCert <client certificate>] [--connectionTimeout <connection timeout>] [--enableSNISupport] [--entityIdReplace <[find_id]::[replace_with_id]>] [-h <host>] [--help][--hideProgress] [--instanceModifier <instance modifier>] [--loggingProperties <Logging Properties>] [-O <[param]=[value]>] [-p <port>] [--plaintextPassword <plaintext password>] [--readTimeout <read timeout>] [--skar <SKAR file>] [--solutionKitSelect <[ID]::[IM]>]
[--solutionKitSelectByName <[NAME]::[IM]>]*
[--trustCertificate] [--trustHostname] [-u <user name>] [-w <restman path>] [-x <encoded password>] [-z <arg file>]
*
Parameter available for Gateway Version 10 CR1+
Not all of the listed parameters are required to execute the
manageSolutionKits install command
. For a description of each of these parameters, refer to the on-screen help by running the
GatewayMigrationUtility.sh manageSolutionKits install
command.
Example: Install a simple Solution Kit
$./GatewayMigrationUtility.sh manageSolutionkits install --argFile commonarguments.properties --skar "/<some_path>/SimpleSolutionKit-1.1.sskar"
Example: Install a simple Solution Kit with an addendum bundle
$./GatewayMigrationUtility.sh manageSolutionkits install --argFile commonarguments.properties --skar "/<some_path>/SimpleSolutionKit-1.1.sskar" --addendum "/<some_path>/addendum_bundle.xml"
Example: Install a Solution Kit with child Solution Kits
The sample Solution Kit contains two child Solution Kits: Simple Service and Other (33b16742-d62d-4095-8f8d-4db707e9ad52) and a Simple Server Module File (33b16742-d62d-4095-8f8d-4db707e9ad53).
./GatewayMigrationUtility.sh manageSolutionKits install --argFile commonarguments.properties --skar "/<some_path>/SimpleSolutionKit-1.1.sskar" --instanceModifier=AAA --solutionKitSelect "33b16742-d62d-4095-8f8d-4db707e9ad52" --solutionKitSelect "33b16742-d62d-4095-8f8d-4db707e9ad53::BBB" --entityIdReplace "f1649a0664f1ebb6235ac238a6f71a6d::4d1ac939fb723edd819f7aace9848556" --entityIdReplace "0567c6a8f0c4cc2c9fb331cb03b4de6f::4d1ac939fb723edd819f7aace984855f" -OMyInputTextKey=Hello
After the installation, the first child (33b16742-d62d-4095-8f8d-4db707e9ad52) has the global instance modifier applied (AAA), and second one (33b16742-d62d-4095-8f8d-4db707e9ad53) has a dedicated instance modifier applied (BBB).
If an error occurs during the installation process, the resulting RESTMan mapping containing the error is displayed.
Example: Install a Solution Kit with its given name
The following example command uses the
solutionKitSelectByName
parameter to identify the same child Solution Kits for installation.
./GatewayMigrationUtility.sh manageSolutionKits install --argFile commonarguments.properties --skar "/<some_path>/SimpleSolutionKit-1.1.sskar" --instanceModifier=AAA --solutionKitSelectByName "Simple Service SK" --solutionKitSelectByName "Other SK::BBB" --entityIdReplace "f1649a0664f1ebb6235ac238a6f71a6d::4d1ac939fb723edd819f7aace9848556" --entityIdReplace "0567c6a8f0c4cc2c9fb331cb03b4de6f::4d1ac939fb723edd819f7aace984855f" -OMyInputTextKey=Hello
Upgrade Command
The upgrade command has the following permitted parameters:
upgrade [--addendum <addendum bundle file>] [--clientCert <client certificate>] [--connectionTimeout <connection timeout>] [--enableSNISupport] [--entityIdReplace <[find_id]::[replace_with_id]>] [-h <host>] [--help] [--hideProgress] [--id <solution kit to upgrade>] [--instanceModifier <[IM]>] [--loggingProperties <Logging Properties>]
[--name <solution kit to upgrade>]*
[-O <[param]=[value]>] [-p <port>] [--plaintextPassword <plaintext password>] [--readTimeout <read timeout>] [--skar <SKAR file>] [--solutionKitSelect <ID>]
[--solutionKitSelectByName <NAME>]*
[--trustCertificate] [--trustHostname] [-u <user name>] [-w <restman path>] [-x <encoded password>] [-z <arg file>]
*
Parameter available for Gateway Version 10 CR1+
Not all of the listed parameters are required to execute the
manageSolutionKits upgrade command
. For a description of each of these parameters, refer to the on-screen help by running the
GatewayMigrationUtility.sh manageSolutionKits upgrade
command.
Example: Upgrade a simple Solution Kit
$./GatewayMigrationUtility.sh manageSolutionkits upgrade --argFile commonarguments.properties --skar "/<some_path>/SimpleSolutionKit-1.2.sskar" --id "02ab3319-6eef-4860-afab-7f41e77739d5"
Example: Upgrade a single child Solution Kit within a parent
This example shows how to upgrade the first child (33b16742-d62d-4095-8f8d-4db707e9ad52) from the sample Solution Kit under "Install a Solution Kit with child Solution Kits" above.
./GatewayMigrationUtility.sh manageSolutionKits upgrade --argFile commonarguments.properties --skar "/<some_path>/SimpleSolutionKit-1.2.sskar" --id "33b16742-d62d-4095-8f8d-4db707e9ad54" --solutionKitSelect "33b16742-d62d-4095-8f8d-4db707e9ad52::AAA" -OMyInputTextKey=Hello
Example: Upgrade a Solution Kit with its given name
The following example command uses the
name
and
solutionKitSelectByName
parameters to identify the Solution Kit and child Solution kits for the upgrade.
./GatewayMigrationUtility.sh manageSolutionKits upgrade --argFile commonarguments.properties --skar "/<some_path>/SimpleSolutionKit-1.2.sskar" --name "Parent Solution Kit" --solutionKitSelectByName "Child Solution Kit::AAA" -OMyInputTextKey=Hello
Uninstall Command
The uninstall command has the following permitted parameters:
uninstall [--childId <ID>]
[--childName <NAME>]*
[--clientCert <client certificate>] [--connectionTimeout <connection timeout>] [--enableSNISupport] [-h <host>] [--help] [--hideProgress] [--id <<ID>[::[IM]]>] [--loggingProperties <Logging Properties>]
[--name <<NAME>[::[IM]]>]*
[-p <port>] [--plaintextPassword <plaintext password>] [--readTimeout <read timeout>] [--trustCertificate] [--trustHostname] [-u <user name>] [-w <restman path>] [-x <encoded password>] [-z <arg file>]
*
Parameter available for Gateway Version 10 CR1+
Not all of the listed parameters are required to execute the
manageSolutionKits uninstall
command. For a description of each of these parameters, refer to the on-screen help by running the
GatewayMigrationUtility.sh manageSolutionKits uninstall
command.
Example: Uninstall a Solution Kit
There are four different ways to target specific Solution Kits to uninstall:
  • Uninstalling a parent plus all child Solution Kits:
    ./GatewayMigrationUtility.sh manageSolutionkits uninstall --argFile commonarguments.properties --id "[Parent_GUID]
  • Uninstalling a single child Solution Kit:
    ./GatewayMigrationUtility.sh manageSolutionkits uninstall --argFile commonarguments.properties --id "[Non-Parent_GUID]::[IM]"
  • Uninstalling all child Solution Kits with a specific instance modifier:
    ./GatewayMigrationUtility.sh manageSolutionkits uninstall --argFile commonarguments.properties --id "[Parent_GUID]::[IM]"
Example: Uninstall a Solution Kit with its given name
The following example command uses the
name
 parameter to identify the Solution Kit to uninstall.
./GatewayMigrationUtility.sh manageSolutionkits uninstall --argFile commonarguments.properties --name "[Solution Kit Name]::[IM]"