soamreg

Registers an application or updates the application profile of a registered application.

Synopsis

soamreg application_profile_file [-d][-f] [-u user_name] [-x password]
soamreg fragment_profile_file -p [-f] [-u user_name] [-x password]
soamreg -h
soamreg -V

Description

Use soamreg to register a new application or update an application with an existing profile or profile fragment.

Before you register an application in Symphony:

  • The consumer specified in the application profile must already exist in the resource group names specified, or in the default resource groups.

  • The service packages specified in the application profile or profile fragment must have already been deployed for the consumer

Remember:

If the application profile resourceGroupName attribute for the session manager and service instance manager is not defined, the default compute and management host groups are used. In this case, the consumer must be defined in the ComputeHost and the ManagementHost. Otherwise, the application cannot be enabled after registration.

In Symphony DE, the consumer name is optional and not used.

The table that follows describes Symphony behavior when registering an application, based on existing conditions when soamreg was issued:

No enabled application in consumer

No enabled application in consumer

Enabled application in consumer

Enabled application in consumer

Enabled application in consumer

Enabled application in consumer

Application has open or suspended sessions

Application has open or suspended sessions

Application has no open or suspended sessions

Application has no open or suspended sessions

System action resulting from issuing soamreg

Register new application

Update existing application

Register new application

Update existing application

Register new application

Update existing application

Registers and enables the application

Registers the application, and it remains disabled

Registers the application profile fragment

Terminates all sessions

Shuts down session manager, releases resources, and starts up a new session manager

Updates the application profile

Dynamic update for application profile

-h

Prints command usage to stdout and exits.

-V

Prints product version to stdout and exits.

Options

application_profile_file

Specify the path and name of the application profile or profile fragment file for the application. If any part of the path or file name contains spaces, enclose it in double quotes (" "). Specify the path for the application profile using absolute, relative, or UNC format.

You can specify file paths using absolute or relative paths:

  • Absolute—Provide the full path to the file, from the root directory. If you specify an absolute path, all hosts must have the same path. For example:
    • Windows: “%SOAM_HOME%\5.0\samples\CPP\SampleApp\SampleApp.xml"

    • Linux: "$SOAM_HOME/5.0\samples/CPP/SampleApp/SampleApp.xml"

  • Relative—Provide the path to the file relative to the Symphony work directory, %SOAM_HOME%\work in Windows and $SOAM_HOME/work in Linux. For example:
    • Windows: "..\5.0\samples\CPP\SampleApp\SampleApp.xml"

    • Linux: "../5.0/samples/CPP/SampleApp/SampleApp.xml"

fragments_profile_file

Register a profile fragment file that contains either a new session type or a new service section, or both. When you add a new session type or Service section, the system does not terminate running workload. When you update an existing Service section or session type, the system only terminates running workload associated with the updated service or session type. The add, update, and remove actions are also applicable for multiple session types and services.

You can specify file paths using absolute or relative paths as explained in application_profile_file.

-f

Registers a new application without warning. For existing applications, updates the existing application profile and terminates application workload without warning, if there is active workload for the application.

Registers a profile fragment and does not prompt you to confirm the addition or update.

-p

Registers a profile fragment with the new session types and Service sections, or with the updated or removed session types and Service sections. You can refer to the profile fragment templates to create your own profiles. You can find templates in the $SOAM_HOME/5.0/samples/Templates directory.

-d

Updates the application profile dynamically. If you use this option with -f, then affected workload will be terminated without any warning.

-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.

Register an application

Register an application on Linux:

soamreg soam/5.0/samples/CPP/SampleApp/SampleApp.xml

Register a profile fragment:

soamreg soam/5.0/samples/CPP/SampleApp/SampleAppFragment.xml -p

Register an application on Windows:

soamreg "\\hostA\share\SampleApp.xml"

Register a profile fragment:

soamreg "\\hostA\share\SampleAppFragment.xml" -p
Related reference
soamunreg