soamdeploy

Deploys, removes, and displays information about service packages for consumers.

Synopsis

soamdeploy
soamdeploy subcommand [options ]
soamdeploy subcommand -h
soamdeploy -h
soamdeploy -V

Description

Use the soamdeploy command to deploy, verify, and delete service packages

-h

Prints command usage to stdout and exits.

-V

Prints product version to stdout and exits.

Subcommand synopsis

add package_name -p package_file -c consumer_ID [-f ] [-n ] [-u  user_name ] [-x  password ]
remove package_name -c consumer_ID [-f ] [-u user_name ] [-x password ]
view -c consumer_ID [-u user_name ] [-x password ]

add package_name -p package_file -c consumer_ID [-f] [-n] [-u user_name] [-x password]

Copies the specified package to the central repository.

When you add a package with a new package name to the repository, the package file is stored in the repository. When you add a package with an existing package name:

Note:

If a package is shared among multiple applications, then the following points are applicable for each application.

  • The package in the repository is replaced.

  • If the package is being used by an enabled application, workload continues to run with the next scheduled task using the updated service package.

When a new session requests the service in the package, the package is deployed and uncompressed on to compute hosts on-demand.

package_name

Name you want to assign to the service package. The service package name must be unique within a consumer, with a maximum of 1024 characters. Valid characters are alphanumeric characters, periods, and underscores. Spaces are not allowed.

-p package_file

Path and file of the service package to deploy.

-c consumer_ID

Consumer for which to deploy the service packages. Only applications registered to this consumer and below in the consumer tree can use the service packages.

Enclose the consumer ID in double quotes (" ") if it contains spaces.

If a service package is deployed to the root consumer ("/"), the package is shared by the leaf consumers.

Note:

For Symphony DE, -a application profile file name can be used instead of -c consumer_ID.

-f

Forces package deployment without prompting. Note that if you use this option and the package was previously deployed, any running workload is terminated without prompting. Use this option when you are issuing soamdeploy add from within a script, and do not want the script to stop running to respond to prompts.

-n

Turns off package verification during deployment. Use this option if you are deploying the same package repeatedly and you know it is valid, and deployment takes a long time because of the verification process.

-u user _name

Specifies the name of the user to connect to Symphony for this command. If you are already logged on to Symphony using soamlogon, for this command only the user name specified here overrides the user name entered in soamlogon.

-x password

Specifies the user password to connect to Symphony for this command. If you are already logged on to Symphony using soamlogon, for this command only the password specified here overrides the password entered in soamlogon.

Examples: Windows

Deploy a service package

Deploy the service package for consumer /SampleApplications/SOASamples.

soamdeploy add Mypackage -p sampleService.zip -c /SampleApplications/SOASamples

Update a service package

Update and replace the service package sampleService.zip.

soamdeploy add Mypackage -p sampleService.zip -c /SampleApplications/SOASamples

Examples: Linux

Deploy a service package

Deploy the service package for consumer /SampleApplications/SOASamples.

soamdeploy add Mypackage -p sampleService.tar.gz -c /SampleApplications/SOASamples

Update a service package

Update and replace the service package

soamdeploy add Mypackage -p sampleService.tar.gz -c /SampleApplications/SOASamples

remove package_name -c consumer_ID [-f] [-u user_name] [-x password]

Deletes the specified service package from the central repository under the specified consumer.

Attention:

The package is removed only from the central repository and is not removed from the remote deploy directory until another package is uploaded to the same consumer on that host.

You cannot remove a package if there are registered applications using the package. Unregister the application(s) with soamunreg before attempting to remove the package.

Note:

If your application no longer needs to reference the service package and you do not want to unregister it, you can remove reference to the package in the application profile and update the application profile with the soamreg command.

package_name
package_name

Name you assigned to the service package during deployment.

-c consumer_ID

Consumer from which to remove the service package.

Enclose the consumer ID in double quotes (" ") if it contains spaces.

-f

Forces package removal without prompting. Use this option when you are issuing soamdeploy remove from within a script, and do not want the script to stop running to respond to prompts.

-u user _name

Specifies the name of the user to connect to Symphony for this command. If you are already logged on to Symphony using soamlogon, for this command only the user name specified here overrides the user name entered in soamlogon.

-x password

Specifies the user password to connect to Symphony for this command. If you are already logged on to Symphony using soamlogon, for this command only the password specified here overrides the password entered in soamlogon.

Remove a service package

Remove the service package for consumer /SampleApplications/SOASamples.

soamdeploy remove Mypackage -c /SampleApplications/SOASamples

view -c consumer_ID [-u user_name] [-x password]

Lists all deployed service packages for the specified consumer.

-c consumer_ID

Displays a list of all deployed service packages for the specified consumer. Enclose the consumer ID in double quotes (" ") if it contains spaces.

Note:

For Symphony DE, -c consumer_ID is optional.

-u user _name

Specifies the name of the user to connect to Symphony for this command. If you are already logged on to Symphony using soamlogon, for this command only the user name specified here overrides the user name entered in soamlogon.

-x password

Specifies the user password to connect to Symphony for this command. If you are already logged on to Symphony using soamlogon, for this command only the password specified here overrides the password entered in soamlogon.

View deployed packages for consumer /SampleApplications/SOASamples

soamdeploy view -c /SampleApplications/SOASamples