eezcs

Purpose

eezcs — opens the Application Manager command shell in line or in shell mode.

Format

eezcs [-h] [–S server_name[:port]] [–D domain_name] [-T] [-V] [-c command [-u WAS_username -p WAS_password] [-du domain_username -dp domain_password]]

Comments

Use this command to run one or more commands against resources, groups, and relationships that are hosted on any automation domain that is currently connected to the Application Manager:

If you use the -c option, you open the command shell in line mode. In this mode, the shell connects to the automation manager, run the command (against resources of the selected domain), display the results, and quit with the relevant exit status.
When you omit the -c option, you open the command shell in shell mode. In this mode, a subshell opens in which you can enter an arbitrary number of commands against the selected automation domain until you close the subshell with the quit command. The subshell is indicated with the prompt EEZCS [username@domainame] >. To display a list of all commands that can be entered within the currently selected domain, use the help command.

To display a command's usage statement, enter the command with the -h option, for example:

In line mode, enter:
```
eezcs -c "lsres -h"
```
In shell mode, enter:
```
EEZCS [username@domainame] > lsres -h
```

Flags

–S server_name [:port]

Specifies the information that is needed to connect to the server that hosts the Application Manager. For the server_name, specify either a host name, an IPv4 address, or an IPv6 address that is enclosed by brackets (for example, [::1]). If the option is not specified, the default host name of the local host with the configured port number is used.

Note: This parameter is required when eezcs is started on a system other than the one on which the Application Manager is running. This is especially true in the case when the Application Manager is kept highly available and might move. To find the appropriate <server_name> value in this scenario, issue the command eezdmn status. You can either use the host name where the automation engine is located or the System Automation Application Manager service IP address.

Note: If this parameter is used for the first time to connect to WebSphere Application Server, which is running on another system, you might be asked to accept an SSL signer from the target host to the local truststore. Review the signer information. If the signer information is correct, then add it to the truststore. A signer must be added to the local truststore before the eezcs command can connect to the target host.

-D domain_name

Specifies the domain name for which the command is run. This parameter is optional. The default is the first online end-to-end domain that is found.

Note: Depending on the type of the connected automation domain, only a subset of command shell commands is available. See also Command overview for a list of supported commands per domain type.

-c command

Specifies an automation manager command in line mode. The command shell connects to the automation manager, runs the command, writes the output to standard output, and quits with the relevant exit status. When the option is omitted, the command shell is opened in shell mode.

-u WAS_username

Specifies the user ID to be used for authentication to the end-to-end automation manager. Here you must specify the user ID, which you also use in the login window of the Dashboard Application Services Hub when you open the web-based operations console. The option can be used only together with the -c option. This ensures that user ID and password specification is only used in line mode.

-p WAS_password

Specifies the password for the user ID specified with the option -u. The option can be used only together with the -c option. This ensures that user ID and password specification is only used in line mode.

-du domain_username

Specifies the optional user ID to be used for authentication to the contacted first-level automation domain. Here you must specify the user ID you also use when you select the specific automation domain in the web-based operations console. This user ID is verified by the selected automation domain.

If you choose to contact the first available end-to-end automation domain (by not specifying the –D option), you do not have to specify the –du option. In this case, authentication with –u is sufficient.

This option can be used only together with the -c option. This ensures that user ID and password specification is only used in line mode.

If the specified FLA domain has no security that is enabled, a specification of –du and –dp is not required.

If you specified to use the user credentials that are specified in cfgeezdmn for the end-to-end automation engine also for the command shell, –du and –dp is also not required.

Note: Even if you authenticate earlier to the specific FLA domain, it is still required to specify these user credentials. For example, with the graphical operations console or with an earlier invocation of the eezcs command. The eezcs command does not use the credential vault feature, which can be used with the graphical operations console.

-dp domain_password

Specifies the password for the domain_username value that is specified with the option -du. The option can be used only together with the -c option. This ensures that user ID and password specification is only used in line mode.

-V

Writes the verbose messages of the command to standard output.

-T

Writes the trace messages of the command to standard output. For your software-service organization's use only.

-h

Writes the usage statement of the command to standard output.

Parameters

None.

Return codes

0: The command ran successfully.
1: The command was unable to contact the end-to-end automation manager.
2: An unknown flag was specified on the command line or a required parameter was not specified.
4: The command encountered a security problem.
11: 11 or higher. A problem occurred when the specified automation manager command run.

Authorization

To use the command shell, the user ID used to log in must have the right to run the eezcs command. After the installation of the System Automation Application Manager on UNIX and Linux® systems, you need root authority.

The user name must have at least the EEZMonitor and EEZEndToEndAccess roles to contact an end-to-end automation domain. If the command shell is used to contact another automation domain, EEZMonitor role is sufficient – with the same restrictions that this user name has when the web-based operations console is used.

Examples

To open a command shell in shell mode, contacting the end-to-end automation domain that runs on the local host by using the verbose option, enter:
```
eezcs -V
```

To list all top-level resources that are defined in the currently active policy of the end-to-end automation domain that is running on server saamsrv1 on port 2810, enter:

eezcs -S saamsrv1:2810 -c "lsres -m -Adt" -u eezadmin -p eezadmin

Sample output:

Research                 ResourceGroup     false     Online  Online   Ok          Ok
AppServerResearch_ref    ResourceReference false     Online  Online   Ok          Ok
WebServerResearch_ref    ResourceReference false     Online  Online   Ok          Ok
DatabaseResearch_ref     ResourceReference false     Online  Online   Ok          Ok
Development              ResourceGroup     false     Online  Online   Ok          Ok
AppServerDevelopment_ref ResourceReference false     Online  Online   Ok          Ok
WebServerDevelopment_ref ResourceReference false     Online  Online   Ok          Ok
DatabaseDevelopment_ref  ResourceReference false     Online  Online   Ok          Ok

To display all relationships that are defined on domain FECluster, which is connected to the local System Automation Application Manager in line mode, enter:

eezcs -D FECluster -c "lsrel" -u eezadmin -p eezadmin -du root -dp eezadmin

Sample output:

Connecting to System Automation Application Manager on Server localhost using domain FECluster.
EEZS0120I Using domain FECluster.
IBM.Application:samadapter
  DependsOn IBM.ServiceIP:samadapter-ip
IBM.ServiceIP:samadapter-ip
  DependsOn IBM.Equivalency:samadapter-nieq

Enter the following command to apply the following behavior: Open a command shell in shell mode, which connects to the local System Automation Application Manager. Use the domain FECluster. List all available commands that are supported on the domain type. Close the command shell.

eezcs -D FECluster

Sample input and output:

Connecting to System Automation Application Manager on Server localhost using domain FECluster.
Realm/Cell Name: defaultWIMFileBasedRealm
User Identity: eezadmin
User Password:                                                                                                       
Specify user name and password to access domain: FECluster
Username: root
Password: 
EEZS0120I Using domain FECluster.
EEZCS[username@domainame]>help
Possible Commands:

  lseezdom - List information about automation domains.
  resreq - issues requests against resources or cancels previously entered requests.
  nodereq - issues commands against nodes of an automation domain.
  resetres - resets the operational state of end-to-end automation resources.
  lsrel - lists information about managed relationships.
  lsres - lists information about resources.
  lsnode - lists information about one ore many nodes.
  lsresreq - lists requests and orders that were issued against resources.
  help - displays a command's usage statement or a list of all possible commands.
  quit - closes the command shell.

EEZCS[eezadmin@FECluster]>quit
Goodbye.

After you configured the command shell to use specified user credentials for accessing the System Automation Application Manager and to use FLA domain access credentials as defined under the tab "User credentials" with the command cfgeezdmn, it is not required to specify any user and password anymore. For more information, see User Credentials tab. To open a command shell in line mode (connecting to the domain FECluster connected to the local System Automation Application Manager) and show all relationships, enter:
```
# eezcs -D FECluster -c "lsrel"
```
Sample output:
```
IBM.Application:samadapter
  DependsOn IBM.ServiceIP:samadapter-ip
IBM.ServiceIP:samadapter-ip
  DependsOn IBM.Equivalency:samadapter-nieq
```