19 Command Line Interface

Synopsis

Oracle Solaris OS

/opt/SUNWxvmoc/bin/ecadm -V
/opt/SUNWxvmoc/bin/ecadm [ -h | --help ]
/opt/SUNWxvmoc/bin/ecadm subcommand [ options ]

Linux OS

/opt/sun/xvmoc/bin/ecadm -V
/opt/sun/xvmoc/bin/ecadm [ -h | --help ]
/opt/sun/xvmoc/bin/ecadm subcommand [ options ]

Options

The following common options are supported:

-h| --help: Displays the usage synopsis for ecadm.

-V| --version: Displays the version of Oracle Enterprise Manager Ops Center.

Subcommands

The subcommands of ecadm are as follows:

start

Starts the Enterprise Controller services running on the host.

stop

Stops the Enterprise Controller services running on the host.

status

Displays the status of the Enterprise Controller services. Displays either online or offline to the standard output and sets the exit status to reflect the Enterprise Controller service state.

configure

Performs configuration tasks for the Enterprise Controller services. Registers the Enterprise Controller with My Oracle Support.

unconfigure

Performs the inverse operation of configuring the Enterprise Controller. Deregisters the Enterprise Controller.

backup

Creates a backup archive of the state data of the Enterprise Controller. This command does not back up any installed software.

restore

Restores the state data of an Enterprise Controller from a backup archive. If a new system is being used, it must have the same hostname as the original Enterprise Controller. After the successful completion of this command, the Enterprise Controller is in the same operational state that existed at the time of the backup.

If the registration of the Enterprise Controller to My Oracle Support is invalidated with the ecadm unconfigure command, any backup archives created during the time the Enterprise Controller was registered become unusable. The Enterprise Controller is no longer able to communicate with My Oracle Support, and the asset data shared between the Enterprise Controller and the hosted servers lose their synchronization.

verify-db

Verifies that the database used for the Enterprise Controller data persistence is available, reachable, and the schemas are setup with the proper permissions.

change-db-password

Changes the Enterprise Controller password for the application or read only database schema that is used by Oracle Enterprise Manager Ops Center database password for the local or remote database. The Enterprise Controller services are restarted after using this command.

maintenance

Changes the state of the database to maintenance state.

migrate

Moves Enterprise Controller data persistence from a local database to a customer-managed database, then removes the local database and the local database server binaries from the Enterprise Controller. The database must be installed in the destination location before beginning this procedure. The Enterprise Controller is shutdown and is restarted on successful completion.

sqlplus

Opens a sqlplus console to the underlying database.

ha-status

Checks the status of the Oracle Clusterware Enterprise Controller resource.

ha-configure-primary

Configures the system as the primary Enterprise Controller in an Oracle Clusterware framework.

ha-configure-standby

Configures the system as a standby Enterprise Controller in an Oracle Clusterware framework.

ha-modify-resource

Modifies the Enterprise Controller Clusterware resource attributes. To modify the Clusterware resource attributes, edit the /var/opt/sun/xvm/ha/EnterpriseController_HA_clusterware.properties file with the appropriate changes, and run this command to take effect.

ha-relocate

Switches from the currently active Enterprise Controller node to a different node.

ha-start

Starts the Enterprise Controller Clusterware resource on one of the Clusterware nodes. Starting the Enterprise Controller Clusterware resource causes the Enterprise Controller services to start.

ha-stop-no-relocate

Stops the Enterprise Controller Clusterware resource. Stopping the Enterprise Controller resource causes the currently active node hosting the Enterprise Controller services to be stopped.

ha-unconfigure-primary

Removes the last node hosting the Enterprise Controller in an Oracle Clusterware framework.

ha-unconfigure-standby

Removes a Enterprise Controller node from the Oracle Clusterware framework.

Subcommand options

Common options for all subcommands:

-h| --help: Displays the usage synopsis for the subcommand.

-v| --verbose: Displays verbose error and informational messages.

-l| --logfile <logfile>: Captures any output from ecadm in the <logfile>.

start

Enter ecadm start [ -h | --help ] [ -v | --verbose ] [ -c | --cluster ] [ -t | --temporary ] [ -w | --wait ] [ -l | --logfile <logfile> ].

-c|--cluster: Cluster environment.

-w| --wait: ecadm does not exit until all services have been started.

-t| --temporary: The state change is made temporary until next reboot.

stop

Enter ecadm stop [ -h | --help ] [ -v | --verbose ] [ -c | --cluster ] [ -t | --temporary ] [ -w | --wait ] [ -l | --logfile <logfile> ].

-c|--cluster: Cluster environment.

-w| --wait: ecadm does not exit until all services have been stopped.

-t| --temporary: The state change is made temporary until next reboot.

status

Enter ecadm status [ -h | --help ].

configure

Enter ecadm configure [ -h | --help ] [ -f | --config <config-file>] [ -p | --proxy ] [ -P | --noproxy ] [ -v | --verbose ] [ -l | --logfile <logfile> ].

-f| --config <config-file>: Uses the contents of <config-file> to register the Proxy Controller with My Oracle Support.

-p| --proxy: By default, enables the local Proxy Controller after the Enterprise Controller is configured.

-P| --noproxy: The local control proxy is not enabled.

Note:

Ensure that the file permission for the configuration file properties is set to 400 because it contains the Online Account username and password. It must not be accessible to unauthorized users.

unconfigure

Enter ecadm unconfigure [ -h | --help ] [ -v | --verbose ] [ -l | --logfile <logfile> ].

backup

Enter ecadm backup [ -o | --output <backup-file> ] [ -t | --tag <tag> ] [ -d | --description <description> ] [ -r | --remotedb ] [ -c | --configdir <config-dir>] [ -T | --tempdir <temp-dir> ] [ -h | --help ] [ -v | --verbose ] [ -l | --logfile <logfile> ].

-o | --output <backup-file>: Stores the backup archive in tar format in <backup-file>. Do not specify the path inside the xvm install directories (/opt/*xvm*). Default: /var/tmp/sat-backup-<date>-<time>.tar

-t | --tag <tag>: Stores the string <tag> as a property of the backup archive which is displayed by restore operation when referencing the <backup-file>.

-d | --description <description>: Stores the string <description> as a descriptive property of the backup archive (the description is informational and it is displayed during restore operation).

-r|--remotedb: If Enterprise Controller uses a remote database, export the schema to a file on the database server. This option must be specified if the Enterprise Controller uses a remote database, otherwise data is not exported from the database.

-c | --configdir <config-dir>: <config-dir> is an alternative collection of backup modules when performing the backup. ecadm backup is modular in design and executes a set of backup tasks in the configuration directory. This option provides a means to use an alternate set of modules to produce a backup archive in a specialized way.

-T | --tempdir <temp-dir>: Uses <temp-dir> instead of the temporary directory in /var/tmp for intermediate storage needs during the backup. This temporary directory is required to hold a large quantity of data during the backup operation.

restore

Enter ecadm restore -i | --input <backup-file> [ -c | --configdir <config-dir>] [ -r | --remotedb ] [ -d | --tempdir <temp-dir> ] [ -h | --help ] [ -v | --verbose ] [ -l | --logfile <logfile>] .

-i | --input <backup-file>: Restores state data from <backup-file> which is the archive created by ecadm backup operation. This parameter is required.

-r|--remotedb: If EC uses a remote database, export the schema to a file on the database server. This option must be specified if the Enterprise Controller uses a remote database, otherwise data is not exported from the database.

-c | --configdir <config-dir>: <config-dir> is an alternative collection of restore modules when performing the backup. ecadm restore is modular in design and executes a set of restore tasks in the configuration directory. This option provides a means to use an alternate set of modules to restore a backup archive in a specialized way.

-d | --tempdir <temp-dir>: Uses <temp-dir> instead of the temporary directory in /var/tmp for intermediate storage needs during the restore. This temporary directory is required to hold a large quantity of data during the restore operation.

verify-db

Enter ecadm verify-db [ -v | --verbose ].

change-db-password

Enter ecadm change-db-password -p| --passwordfile <password-file> [ -v | --verbose ].

-p| --password-file <password-file>: Specifies the file containing the new password.

-r| --as_read_only_user: Specifies if the operation is done for a read only user. If this option is used, the password for the read only user is specified in the <password file>, and the read only user is the target of the change.

maintenance

Enter ecadm maintenance [ -h | --help ] [ -v | --verbose ] [ -c | --cluster ] [ -r | --reason <reason-file>] [ -t | --temporary ] [ -w | --wait ] [ -l | --logfile <logfile> ].

-c| --cluster: Cluster environment.

-r| --reason <reason-file>: Record reason for shutdown from message in <reason-file>.

-w| --wait: ecadm does not exit until all services have been stopped.

-t| --temporary: The state change is made temporary until next reboot.

migrate

Enter ecadm migrate -r | --remoteDBprops <credentials-file> [ -h | --help ] [ -v | --verbose ] [ -l | --logfile <logfile>].

-r| --remoteDBprops <credentials-file>: Specify the file containing credentials and url for the target database.

sqlplus

Enter ecadm sqlplus [ -h | --help ] [ -r | --as_read_only_user] [ -c | --command] [ -f| --filedbprop <db.properties file] [ -p | --propfile <dbpw.properties file] [ -d | --directory <directory to run in> ].

-r| --as_read_only_user: Logs into the database as the read only user.

-c| --command: Reads the input stream commands that are passed to sqlplus.

-f| --filedbprop <db.properties file>: Contains the properties to get the schema name and database URL to set the dabatase properties. The default location of db.properties file is /var/opt/sun/xvm/db.properties

-p| --propfile <dbpw.properties file>: Contains the passwords for the schema names in db.properties. The dbpw.properties file is found by default in /var/opt/sun/xvm/dbpw.properties

-d| --directory <directory to run in>: Uses the directory passed in as the working directory for the sqlplus session.

ha-status

Enter ecadm ha-status [ -h | --help ] [ -v | --verbose ] [ -d | --display] [ -l | --logfile <logfile> ].

-d| --as_read_only_user: Displays full High Availability status info.

ha-configure-primary

Enter ecadm ha-configure-primary [ -h | --help ] [ -v | --verbose ] [ -l | --logfile <logfile> ].

ha-configure-standby

Enter ecadm ha-configure-standby [ -h | --help ] [ -p | --credentialsfilename <credentials-file> ] [ -v | --verbose ] [ -l | --logfile <logfile> ].

-p| --credentialsfilename<credentials-file>: Specifies the file containing the username and password for privileged access. The first line of the file must contain the username in this format: username=<user>. The second line of the file must contain the password in this format: password=<password>.

ha-modify-resource

Enter ecadm ha-modify-resource [ -h | --help ] [ -p | --credentialsfilename <credentials-file> ] [ -v | --verbose ] [ -l | --logfile <logfile> ].

-p| --credentialsfilename <credentials-file>: Specifies the file containing the username and password for privileged access. The first line of the file must contain the username in this format: username=<user>. The second line of the file must contain the password in this format: password=<password>.

ha-relocate

Enter ecadm ha-relocate [ -h | --help ] [ -n | --node <standby node> ] [ -v | --verbose ] [ -l | --logfile <logfile> ].

-n| --node <standby node>: Relocates to node in <standby node>.

ha-start

Enter ecadm ha-start [ -h | --help ] [ -n | --node <standby node> ] [ -v | --verbose ] [ -l | --logfile <logfile>].

-n| --node <standby node>: Relocates to node in <standby node>.

ha-stop-no-relocate

Enter ecadm ha-stop-no-relocate [ -h | --help ] [ -v | --verbose ] [ -l | --logfile <logfile> ].

ha-unconfigure-primary

Enter ecadm ha-unconfigure-primary [ -h | --help ] [ -v | --verbose ] [ -l | --logfile <logfile> ].

ha-unconfigure-standby

Enter ecadm ha-unconfigure-standby [ -h | --help ] [ -n | --node <standby node>] [ -v | --verbose ] [ -l | --logfile <logfile>].

-n| --node <standby node>: Unconfigures the standby node when run from another cluster node. Use this option when the standby node is down.

Exit status

The exit status displays the status of the Enterprise Controller services. It currently displays either offline or online to the standard output. The exit status displays one of the following codes:

0 - Online

2 - Offline (only for status subcommand)

1 - Error occurred during processing

Synopsis

Oracle Solaris OS

/opt/SUNWxvmoc/bin/proxyadm -V
/opt/SUNWxvmoc/bin/proxyadm [ -h | --help ]
/opt/SUNWxvmoc/bin/proxyadm subcommand [ options ]

Linux OS

/opt/sun/xvmoc/bin/proxyadm -V
/opt/sun/xvmoc/bin/proxyadm [ -h | --help ]
/opt/sun/xvmoc/bin/proxyadm subcommand [ options ]

Options

The proxyadm command supports the following options:

-h| --help: Displays the usage synopsis for proxyadm.

-V: Displays the version of Oracle Enterprise Manager Ops Center.

Subcommands

The proxyadm command includes the following subcommands:

start

Starts the Proxy Controller services running on the host.

stop

Stops the Proxy Controller services running on the host.

status

Displays the online or offline status of the Proxy Controller services to the standard output, and sets the exit status to reflect the Proxy Controller service state.

configure

Performs configuration tasks for the Proxy Controller services.

You can set the following classes of configuration information:

• Registering the Proxy Controller with the Enterprise Controller.

• Configuring the type of DHCP server that the Proxy Controller runs and the parameters for that DHCP server.

unconfigure

Performs the inverse operation of configuring the Proxy Controller. Deregisters and unconfigures the connection between the Proxy Controller and the Enterprise Controller it is associated with.

Subcommand options

The following common options are supported for all the subcommands:

-h| --help: Displays the usage synopsis for that subcommand.

-v| --verbose: Displays verbose error and informational messages.

start

Enter proxyadm start [ -h | --help ] [ -v | --verbose ] [ -w | --wait ] [ -t | --temporary ] [ -l | --logfile <logfile> ].

-w| --wait: proxyadm does not exit until all the services are started.

-l| --logfile <logfile>: Captures any output from proxyadm in the logfile.

-t| --temporary: The state change is made temporary until next reboot.

stop

Enter proxyadm stop [ -h | --help ] [ -v | --verbose ] [ -w | --wait ] [ -t | --temporary ] [ -l | --logfile <logfile> ].

-w| --wait: proxyadm does not exit until all the services are stopped.

-l| --logfile <logfile>: Captures any output from proxyadm in the logfile.

-t| --temporary: The state change is made temporary until next reboot.

status

Enter proxyadm status [ -h |--help ].

configure

Enter proxyadm configure [ -h | --help ] [ -v | --verbose ] [ -a | --proxy-ip ] [ -u | --user <username> ] [ -p | --passwordfile ] [ -t | --tokenfile <password-file> ] [ -x | --proxy <hostname>[:<port>] ] [ -U | --proxy-user <proxyusername> ] [ -P | --proxy-passwordfile <password-file> ] [ -a | --proxy-ip ].

-u | --user <username>: Specifies the Enterprise Controller administrator username.

-p| --passwordfile <passwordfile>: Specifies a filename containing the password for the Enterprise Controller administrator.

The following parameters are optional for registering the Proxy Controller with the Enterprise Controller:

-t| --tokenfile <autoregistration_tokenfile>: Specifies an autoregistration token stored in a file. This is used as an alternative for Enterprise Controller administrator username and password.

-x| --proxy <hostname>[:<port>]: If an HTTPS proxy is required to reach the Enterprise Controller, specify the <hostname> for that proxy. Specifying the IP port is optional. The default proxy port is 8080.

-U | --proxy-user <proxyusername>: If a proxy requires a username for authentication, use <proxyusername>.

-P | --proxy-passwordfile <password-file>: Uses the password in <password-file> for proxy authentication.

-a | --proxy-ip: Explicitly enter the IP address of the control proxy.

Note:

The password file must be secured to prevent unauthorized users from examining the file. The file permission must be set to 400.

unconfigure

Enter proxyadm unconfigure [ -h | --help ] [ -k| --keep ].

-k|--keep: Keeps the local Proxy Controller database.

Exit status

The exit status displays the status of the proxy services. The states currently display either offline or online on the standard output. The exit status displays one of the following codes:

0 - Online

2 - Offline (only for status subcommand)

1 - Error occurred during processing

Synopsis

Oracle Solaris OS

/opt/SUNWxvmoc/bin/agentadm
/opt/SUNWxvmoc/bin/agentadm [ -h | --help ]
/opt/SUNWxvmoc/bin/agentadm subcommand [ options ]

Linux OS

/opt/sun/xvmoc/bin/agentadm -V
/opt/sun/xvmoc/bin/agentadm [ -h | --help ]
/opt/sun/xvmoc/bin/agentadm subcommand [ options ]

Usage

agentadm [-V | --version ] [ -K | --property-keys <file>] [ -q | --quiet ] [ -v | --verbose ] [ -f | --force ] [ -n | --norefresh ] [ -o | --output-file ] [ -h | --help]

agentadm subcommand [ options ]

Options

The following common options are supported:

-K| --property-keys <file>: The properties filename for the subcommands.

-V| --version: Displays the version number of the Agent Controller software.

-h| --help: Displays the usage synopsis for all configuration steps supported by agentadm.

-v| --verbose: Display verbose error and informational messages. Use multiple occurrences of this option to increase the verbosity level.

-q| --quiet: Does not display anything and returns only the return code.

-f| --force: Ignores non critical errors during steps operations.

-n| --norefresh: Does not overwrite the existing operation.

-o| --output-file: Sends the output to the specified logfile.

Subcommands

The subcommands of agentadm are as follows:

start

Starts the Agent Controller services running on the host.

stop

Stops the Agent Controller services running on the host.

configure

Performs configuration tasks for the Agent Controller services.

unconfigure

Performs the inverse operation of configuring the Agent Controller.

usage

Equivalent to [ -h | --help ]

Subcommand options

start

Enter agentadm start.

stop

Enter agentadm stop.

configure

The configuration step consists of:

• sc-console registration of the agent to proxy.

• scn-agent cacao instance creation.

• uce-agent cacao instance creation.

• Registration of the agent's products to the proxy.

The registration of the agent to the proxy is as follows: agentadm configure [ -u | --user <username> ] [ -p | --passwordfile<password-file> ] [ -a | --agent-ip <IP address> ] [ -t | --token <tokenfilename> ] [ -x | --proxy <URI> ] [ -I | --non-interactive ] [ -k | --keep-connection ]

-u | --user <username>: The Online Account user name.

-p | --passwordfile <passwordfile>: Filename with the Online Account credentials.

-a | --agent-ip <IP address>: Specify the IP address to be used during registration.

-t | --token <tokenfilename>: Filename containing auto registration token.

-x | --proxy <URI>: URI of the proxy to be registered.

-I | --non-interactive: Launch sc-console in non-interactive mode (without -i). Default is interactive mode.

-k | --keep-connection: Do not re-register to proxy if the connection already exists.

unconfigure

Enter agentadm unconfigure

Starting User Mode

You must switch to user mode to run these commands.

• Enter user in the CLI prompt.

  EnterpriseController > user
  EnterpriseController/user >
  

Viewing Users

You can view the existing users in the Enterprise Controller.

• Enter show_local_users.

  A list of users is shown.

  Use the -r| --roles <role name> option to view users with <role name> role. A list of users and their roles are shown.

Viewing Role Types

You can view the available role types in the Enterprise Controller.

• Enter show_all_local_roles.

Viewing User Roles

You can view the roles assigned to a specific user in the Enterprise Controller.

• Enter show_local_user_roles -u| --user <username>.

Adding a User to the Enterprise Controller

You can add a user to the Enterprise Controller and grant a role to the new user. The user must already exist in the host where the Enterprise Controller is installed.

• Enter add_local_user -u| --user <username> -r| --role <role or comma-separated roles list>.

  For information about the available role types you can grant to a user, see Viewing Role Types.

Granting Roles to a User

You can grant a user role to a user of the Enterprise Controller.

• Enter grant_local_role -u| --user <username> -r| --role <role or comma-separated roles list>.

  For information about the available role types you can grant to a user, see Viewing Role Types.

Replicating User Roles

You can replicate the roles from a source user to a recipient user. The current roles and privileges of the recipient users are overwritten with the roles and privileges of the source user.

• Enter replicate_user_roles -u|--user <source user> -r| --role <recipient user>.

Removing Roles From a User

You can remove a role from a user of the Enterprise Controller. For more information about how to see the roles of a user, see Viewing User Roles.

• Enter revoke_local_role -u| --user <username> -r| --role <role or list of comma-separated roles to remove>.

Adding a Directory Server

You can add a directory server.

1. Enter configureds.

   EnterpriseController/user > configureds
   EnterpriseController/user/configureds >
   

2. Enter set name=<name> to set the directory server name.

3. Enter set hostname=<hostname> to set a fully qualified host name.

4. Enter set use_ssl=<false|true> if you want to enable or disable SSL. Default is false.

5. Enter set port=<port> to set a port.

6. Enter set user=<username> to set a username to connect with.

7. Enter set password=<password> to set a password.

8. Enter set root_suffix=<root suffix> to set the root suffix.

9. Enter set user_dn=<user DN> to set the user search DN.

10. Enter set user_scope=<user scope> to set the user search scope.

11. Enter set search_filter=<search filter> to set the user search filter.

12. (Optional) Use the show command to show the values of all directory server properties. If necessary, use the unset <property> command to unset a property or the reset command to reset all properties.

13. Use the commit command to finish configuring the directory server.

Viewing Directory Servers

You can view a list of directory servers and their IDs.

• Enter get_directory_servers.

  Use the -d| --details option to show directory server details.

Viewing Remote Users

You can get a list of directory server users and their roles.

• Enter get_ds_users -d| --directory <directory server name>.

  Use the -r| --roles <role> option to filter users with <role> role.

Synchronizing All Remote Users

You can synchronize all directory server users and their roles with the cache on the Enterprise Controller.

• Enter sync_all_ds_users -d| --directory <directory server name>.

Synchronizing a Single User

You can synchronize a specific user on the directory server with the cache on the Enteprise Controller.

• Enter sync_ds_users -d| --directory <directory server name> -u| --user <user>.

Removing a Directory Server

You can remove a directory server from the Enterprise Controller.

• Enter remove_directory_service -d| --directory <directory server name>.

Deleting a User

You can delete a local user in the Enterprise Controller.

• Enter delete_local_user -u| --user <username>.

Starting Incidents Mode

You must switch to incidents mode to run incidents commands.

• Enter incidents in the CLI prompt.

  EnterpriseController > incidents
  EnterpriseController/incidents >
  

Viewing Incidents

You can view a list of existing incidents.

• Enter list.

  Use the -l| --details option to display detailed incidents information.

  Use the -s| --state <state> option to filter incidents by <state>.

  Use the -u| --user <owner> to filter incidents by <owner>.

Viewing Incident Details

You can view details of the existing incidents or a specific incident.

• Enter show --i| --incidents <incident ID or comma-separated incident IDs list>.

Acknowledging an Incident

You can indicate that you are investigating one or more incidents.

• Enter acknowledge -i| --incidents <comma-separated incident IDs list>

  Use the -n| --note <note> option to add a note.

Adding an Annotation to One or More Incidents

You can add an annotation to one ore more incidents.

• Enter annotate -i| --incidents <comma-sepatared incident IDs list>

  Use the -t| --type <annotation type> option to specify an annotation type. Annotation types are comment or suggested_action.

  Use the -s| --synopsis <synopsis> option to specify an annotation sypnosis.

  Use the -n| --note <note> option to add a note.

Assigning Incidents

You can assign one or more incidents to a user.

• Enter assign -i| --incidents <comma-separated incident IDs list> -u| --user <user>.

  Use the -n| --note <note> option to add a note.

Closing Incident

You can close one or more incidents.

• Enter close -i| --incidents <comma-separated incident IDs list>.

  Use the -d| --disable-delay <disable delay> option to disable the incident monitoring conditions, and reactivate the monitors after <disable delay> minutes.

  Use the -n| --note <note> option to add a note.

Starting Discover Mode

You must switch to discover mode to run discovery commands.

• Enter discover in the CLI prompt.

EnterpriseController > discover
EnterpriseController/discover >

Creating a Discovery Job

The create submode is used to create and launch new discovery jobs. This submode has its own set of commands.

1. Enter create.

   EnterpriseController/discover > create
   EnterpriseController/discover/create >
   

2. Set the type of discovery job, for example, OS, ILOM, ALOM.

Discovering an OS

1. Enter set type=os.

2. Enter the discovery credentials.

   • Enter set ssh_user=<user> to set the login user name.

   • Enter set ssh_password=<password> to set the login password.

   • (Optional) If the login user name is not the root user, enter set ssh_root_user=<root user> to set the root user name.

   • (Optional) If the login user name is not the root user, enter set ssh_root_password=<root password> to set the root password.

3. Enter set ipaddrs=<IP address or addresses> to specify the target IP address or addresses. The following formats can be used:

   • A single IP address.

   • A comma-separated list of IP addresses enclosed in parentheses. Example: (192.168.1.1, 192.168.1.2).

   • An IP range in Classless Inter-Domain Routing (CIDR) subnet notation. Example: 192.168.1.0/24.

   • An IP range in hyphen notation. Example: 192.168.1.1 - 192.168.1.10.

4. (Optional) Enter set ssh_port=<port> to specify a port.

5. (Optional) Enter set use_default=true|false to specify if the factory default credentials are used or not for the discovery job.

6. (Optional) Enter the show command to display all discovery information. If necessary, use the unset <parameter> command to unset a discovery parameter or clear to reset and revert to default values all configuration data.

7. Enter commit to start the configured discovery job.

   The job is launched, and the job ID is displayed.

   Example of OS discovery:

   EnterpriseController/discover > create
   EnterpriseController/discover/create > set type=os
   EnterpriseController/discover/create > set ssh_user=sysmgmt
   EnterpriseController/discover/create > set ssh_password=l0ckit
   EnterpriseController/discover/create > set ipaddrs=172.20.28.202
   EnterpriseController/discover/create > show
   discovery type: Solaris,Linux OS
   use_default=False
   ipaddrs=172.20.28.202
   ssh_user=sysmgmt
   ssh_password=l0ckit
   ssh_root_user=
   ssh_root_password=
   ssh_port=
   EnterpriseController/discover/create > commit
   

Discovering an ILOM Service Processor

ILOM is the service processor used in some Oracle Sun servers. An ILOM discovery also discovers operating systems.

1. Enter set type=ilom.

2. Enter the discovery credentials.

   • Enter set ssh_user=<user> to set the login user name.

   • Enter set ssh_password=<password> to set the login password.

   • (Optional) If the login user name is not the root user, enter set ssh_root_user=<root user> to set the root user name.

   • (Optional) If the login user name is not the root user, enter set ssh_root_password=<root password> to set the root password.

3. Enter set ipaddrs=<IP address or addresses> to specify the target IP address or addresses. The following formats can be used:

   • A single IP address.

   • A comma-separated list of IP addresses enclosed in parentheses. Example: (192.168.1.1, 192.168.1.2).

   • An IP range in CIDR subnet notation. Example: 192.168.1.0/24.

   • An IP range in hyphen notation. Example: 192.1681.1 - 192.168.1.10.

4. Enter set ipmi_user=<IPMI user name>.

5. Enter set ipmi_password=<IPMI user password>.

6. (Optional) Enter the show command to display all discovery information. If necessary, use the unset <parameter> command to unset a discovery parameter or clear to reset and revert to default values all configuration data.

7. Enter commit to start the configured discovery job.

   The job is launched, and the job ID is displayed.

Discovering an ALOM Service Processor

ALOM is the service processor used in some Oracle Sun servers. An ALOM discovery also discovers operating systems and systems with ILOM service processors.

1. Enter set type=alom.

2. Enter the discovery credentials.

   • Enter set ssh_user=<user> to set the login user name.

   • Enter set ssh_password=<password> to set the login password.

   • (Optional) If the login user name is not the root user, enter set ssh_root_user=<root user> to set the root user name.

   • (Optional) If the login user name is not the root user, enter set ssh_root_password=<root password> to set the root password.

3. Enter set ipaddrs=<IP address or addresses> to specify the target IP address or addresses. The following formats can be used:

   • A single IP address.

   • A comma-separated list of IP addresses enclosed in parentheses. Example: (192.168.1.1, 192.168.1.2).

   • An IP range in CIDR subnet notation. Example: 192.168.1.0/24.

   • An IP range in hyphen notation. Example: 192.168.1.1 - 192.168.1.10.

4. Enter set telnet_user=<telnet user name>.

5. Enter set ipmi_password=<password for telnet user name>.

6. (Optional) Enter the show command to display all discovery information. If necessary, use the unset <parameter> command to unset a discovery parameter or clear to reset and revert to default values all configuration data.

7. Enter commit to start the configured discovery job.

   The job is launched, and the job ID is displayed.

Viewing Discovery Profiles

You can list all discovery profiles that can be used to discover systems.

• Enter list_profiles.

  Use the -i| --ids <IDs> option to give a list of discovery profile IDs to be displayed. IDs must be separated by a comma.

Viewing Discovery Ranges

You can list all the existing discovery ranges that can be used to discover systems.

• Enter list_ranges.

  Use the -i| --ids <IDs> option to give a list of discovery ranges IDs to be displayed. IDs must be separated by a comma.

Viewing Driver Credentials

You can list all driver credentials that can be used to discover systems with.

• Enter list_credentials.

  Use the -i| --ids <IDs> option to give a list of driver credentials IDs. IDs must be separated by a comma.

Viewing Discovery Profile Credentials

You can list all driver credentials for a discovery profile that can be used to discover systems with.

• Enter list_profile_credentials -i| --id <discovery profile iD>.

Viewing Discovery Ranges

You can list all driver ranges for a discovery profile that can be used to discover systems with.

• Enter list_profile_ranges -i| --id <discovery profile iD>.

Viewing Networks

You can list all proxy networks that can be used to discover systems with.

• Enter list_networks.

Executing Discovery Profiles

You can execute a discovery profile to discover systems.

• Enter execute -i| --id <discovery profile id> -t| --targets <target friendly names>.

  Use -i| --id <ID> to execute the discovery profile with ID <ID>.

  Use -t| --targets <target friendly names> to give a list of target friendly names. Target names must be separated by a comma.

  Use the -n| --networkuuid <network UUID> option to give a network UUID.

  Use the -c| --credentials <discovery credentials IDs> option to give a list of discovery credentials IDs. IDs must be separated by a comma.

  Use the -m| --management <management credential ID> option to give a management credential ID.

  Use the -s| --serviceTag <servicetag credential ID> option to give a service tag credential ID.

  Use the -a| --agentLess option to set agentless deployment on.

  Use the -r| --ranges <discovery ranges IDs> option to give a list of discovery ranges IDs. IDs must be separated by a comma.

Starting Gear Mode

You must switch to gear mode before using other gear subcommands.

• Enter gear in the CLI prompt.

  EnterpriseController > gear
  EnterpriseController/gear >
  

Viewing Assets

You can list the assets managed by Oracle Enterprise Manager Ops Center

• Enter list.

  EnterpriseController/gear > list
  Registered Gear:
  UFN |Manage state|Description |Asset Type|               UUID                 |
  -------------------------------------------------------------------------------
  v64v|   MANAGED  |10.79.103.14|  Server  | 6f1f1dg9-f8sc-8b1b-9c81-ddaab86a261d
  c4pr|   MANAGED  |10.68.102.26|  Server  | 5a5fff44-d17c-4ca3-8282-ef8cb8aed88d
  

  Use the -l option to show asset details.

  Example

  EnterpriseController/gear > list -l
  Registered Gear:
  -------------------------------------------------------------------------------
  Name : v64v
    Description : 10.79.103.14
    Managed State : MANAGED
    Status : OK
    Lock Info : None
    Is a Zone : False
    Public UUID : 6f1f1dg9-f8sc-8b1b-9c81-ddaab86a261d
    Asset Type : Server
  Name : c4pr
    Description : 10.68.102.26
    Managed State : MANAGED
    Status : OK
    Lock Info : None
    Is a Zone : False
    Public UUID : 5a5fff44-d17c-4ca3-8282-ef8cb8aed88d
    Asset Type : Server
  

  Use the f| --filter <filter term> option to filter the assets list.

  Example

  EnterpriseController/gear > list --filter v64v
  Registered Gear:
  UFN |Manage state|Description |Asset Type|               UUID                 |
  -------------------------------------------------------------------------------
          v64v|   MANAGED  |10.79.103.14|  Server  | 6f1f1dg9-f8sc-8b1b-9c81-ddaab86a261d
  

Updating Asset Information

You can update the name of any asset, including the Enterprise Controller. You can also update an asset's description and associated tags.

• Enter update -g| --gear <asset name>.

  Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

  Use the --attributes <attribute list> option to give a list of asset attributes instead of the asset name. This is useful when assets might have the same name. The asset attributes that can be used are the type, UUID, UFN, and ip. Attributes must be separated by a comma. The type attribute must be os, server or chassis, and the ip attribute must be a valid IPv4 address.

  Examples:

  --attributes=ip=192.168.1.1,type='server'
  
  --attributes=type='server',UFN='foo'
  

  Use the -n| --name <new name> option to give the asset a new name.

  Use the -d| --description <description> option to update the asset's description.

  Use the -t| --tags <space-separated list of tags> option to update the asset's tags.

Viewing Jobs Associated With Assets

You can view current and historical jobs associated with an OS, server, or chassis.

• Enter show_jobs -g| --gear <asset name>.

  Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

  Use the --attributes <attribute list> option to give a list of asset attributes instead of the asset name. This is useful when assets might have the same name. The asset attributes that can be used are the type, UUID, UFN, and ip. Attributes must be separated by a comma. The type attribute must be os, server or chassis, and the ip attribute must be a valid IPv4 address.

  Examples:

  --attributes=ip=192.168.1.1,type='server'
  
  --attributes=type='server',UFN='foo'
  

Managing an Asset

You can manage discovered assets.

• Enter manage -g| --gear <asset name> -u| --user <user name with access to asset> -p| --password <username's password>.

  Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

  Use the --attributes <attribute list> option to give a list of asset attributes instead of the asset name. This is useful when assets might have the same name. The asset attributes that can be used are the type, UUID, UFN, and ip. Attributes must be separated by a comma. The type attribute must be os, server or chassis, and the ip attribute must be a valid IPv4 address.

  Examples:

  --attributes=ip=192.168.1.1,type='server'
  
  --attributes=type='server',UFN='foo'
  

  Use the -t| --type <type> option to give the asset type. This is useful when assets might have the same name.

Unmanaging an Asset

You can unmanage a managed asset, removing the asset from the managed asset list and removing any agent.

• Enter unmanage -g| --gear <asset name> .

  Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

  Use the --attributes <attribute list> option to give a list of asset attributes instead of the asset name. This is useful when assets might have the same name. The asset attributes that can be used are the type, UUID, UFN, and ip. Attributes must be separated by a comma. The type attribute must be os, server or chassis, and the ip attribute must be a valid IPv4 address.

  Examples:

  --attributes=ip=192.168.1.1,type='server'
  
  --attributes=type='server',UFN='foo'
  

  Use the -u| --user <user> option to give the user name to be used for unmanage action.

  Use the -p| --password <password> option to give the user name's password.

  Use the -t| --type <type> option to give the asset type. This is useful when assets might have the same name.

Deleting an Asset

You can delete discovered assets to remove it from Oracle Enterprise Manager Ops Center.

• Enter delete -g| --gear <asset name> .

  Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

  Use the --attributes <attribute list> option to give a list of asset attributes instead of the asset name. This is useful when assets might have the same name. The asset attributes that can be used are the type, UUID, UFN, and ip. Attributes must be separated by a comma. The type attribute must be os, server or chassis, and the ip attribute must be a valid IPv4 address.

  Examples:

  --attributes=ip=192.168.1.1,type='server'
  
  --attributes=type='server',UFN='foo'
  

Reinstalling an Agent Controller on an Operating System

You can reinstall an agent on one or more managed operating systems.

• Enter reinstall_agent -g| --gear <comma-separated asset list> -v| --version <Agent version to install> -u| --user <user name> -p| --password <password>.

  Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

  Use the --attributes <attribute list> option to give a list of asset attributes instead of the asset name. This is useful when assets might have the same name. The asset attributes that can be used are the type, UUID, UFN, and ip. Attributes must be separated by a comma. The type attribute must be os, server or chassis, and the ip attribute must be a valid IPv4 address.

  Examples:

  --attributes=ip=192.168.1.1,type='server'
  
  --attributes=type='server',UFN='foo'
  

Rebooting an Operating System

You can reboot a managed operating system.

• Enter reboot -g| --gear <OS asset name>.

  Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

  Use the --attributes <attribute list> option to give a list of asset attributes instead of the asset name. This is useful when assets might have the same name. The asset attributes that can be used are the type, UUID, UFN, and ip. Attributes must be separated by a comma. The type attribute must be os, server or chassis, and the ip attribute must be a valid IPv4 address.

  Examples:

  --attributes=ip=192.168.1.1,type='server'
  
  --attributes=type='server',UFN='foo'
  

Updating Firmware

You can provision updated firmware on one or more systems using an existing firmware profile.

• Enter apply_firmware -g| --gear <comma-separated asset list> -p| --profile <firmware profile>.

  Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

Checking Firmware Compliance

You can compare the firmware for a list of assets to a firmware profile.

• Enter fwprofile_compliance -g| --gear <comma-separated asset list> -p| --profile <firmware profile>.

Provisioning an OS

You can provision a new operating system to a managed system. The provision_os command starts a submode with its own set of subcommands.

1. Enter provision_os -g| --gear <asset name> -p| --profile <profile>.

   EnterpriseController/gear > provision_os -g targetsystem -p S10
   EnterpriseController/gear/provision_os# >
   

2. Use the set command to set the provisioning properties. The properties are:

   • profile – The OS profile to use for the provisioning job. Required.

   • register – Specifies whether the new OS will be registered. Values are true or false.

   • manualnetboot – Values are true or false.

   • system_type – The OS that is provisioned. Values are redhat, suse or solaris.

   • server_name – The name of the target system. Required.

   • hostname – The new host name. Required.

   • domain

   • netmask

   • gateway

   • nameserver

   • ip_address – The IP address for the OS. Required.

   • boot_path

   • boot_device

   • console_baud

   • console

3. (Optional) Use the show command to show the values of all provisioning properties. If necessary, use the unset <property> command to unset a property or the reset command to reset all properties.

4. Use the commit command to launch the OS provisioning job.

Changing Locator Lights

You can activate or deactivate locator lights.

• Enter set -g| --gear <asset name> -l| --locator <on|off>.

  Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

  Use the --attributes <attribute list> option to give a list of asset attributes instead of the asset name. This is useful when assets might have the same name. The asset attributes that can be used are the type, UUID, UFN, and ip. Attributes must be separated by a comma. The type attribute must be os, server or chassis, and the ip attribute must be a valid IPv4 address.

  Examples:

  --attributes=ip=192.168.1.1,type='server'
  
  --attributes=type='server',UFN='foo'
  

Enabling or Disabling Notifications

You can enable or disable notifications for a specific OS, server, or chassis.

• Enter set -g| --gear <asset name> -n| --notifications <on|off>.

  Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

  Use the --attributes <attribute list> option to give a list of asset attributes instead of the asset name. This is useful when assets might have the same name. The asset attributes that can be used are the type, UUID, UFN, and ip. Attributes must be separated by a comma. The type attribute must be os, server or chassis, and the ip attribute must be a valid IPv4 address.

  Examples:

  --attributes=ip=192.168.1.1,type='server'
  
  --attributes=type='server',UFN='foo'
  

Powering Off a Server or Chassis

You can deactivate a managed server or a chassis.

• Enter poweroff -g| --gear <asset name>.

  Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

  Use the --attributes <attribute list> option to give a list of asset attributes instead of the asset name. This is useful when assets might have the same name. The asset attributes that can be used are the type, UUID, UFN, and ip. Attributes must be separated by a comma. The type attribute must be os, server or chassis, and the ip attribute must be a valid IPv4 address.

  Examples:

  --attributes=ip=192.168.1.1,type='server'
  
  --attributes=type='server',UFN='foo'
  

  Use the -f| --force option to force the server or chassis to power off.

Powering On a Server or Chassis

You can activate a managed server or a chassis.

• Enter poweron -g| --gear <asset name>.

  Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

  Use the --attributes <attribute list> option to give a list of asset attributes instead of the asset name. This is useful when assets might have the same name. The asset attributes that can be used are the type, UUID, UFN, and ip. Attributes must be separated by a comma. The type attribute must be os, server or chassis, and the ip attribute must be a valid IPv4 address.

  Examples:

  --attributes=ip=192.168.1.1,type='server'
  
  --attributes=type='server',UFN='foo'
  

Reseting a Server or Chassis

You can reset a managed server or chassis.

• Enter reset -g| --gear <server or chassis name>.

  Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

  Use the --attributes <attribute list> option to give a list of asset attributes instead of the asset name. This is useful when assets might have the same name. The asset attributes that can be used are the type, UUID, UFN, and ip. Attributes must be separated by a comma. The type attribute must be os, server or chassis, and the ip attribute must be a valid IPv4 address.

  Examples:

  --attributes=ip=192.168.1.1,type='server'
  
  --attributes=type='server',UFN='foo'
  

  Use -n| --netboot to cause each server to do a netboot instead of booting from disk.

  Use the -f| --force option to force the server or chassis to power off.

Refreshing a Server

You can refresh the data for a server.

• Enter refresh -g| --gear <server name>.

  Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

  Use the --attributes <attribute list> option to give a list of asset attributes instead of the asset name. This is useful when assets might have the same name. The asset attributes that can be used are the type, UUID, UFN, and ip. Attributes must be separated by a comma. The type attribute must be os, server or chassis, and the ip attribute must be a valid IPv4 address.

  Examples:

  --attributes=ip=192.168.1.1,type='server'
  
  --attributes=type='server',UFN='foo'
  

Starting Groups Mode

You must change to groups mode to run these commands.

• Enter groups in the CLI prompt.

  EnterpriseController > groups
  EnterpriseController/groups >
  

Viewing Groups

You can view the list of existing groups.

• Enter list.

  Use the -l| --detail option to view a list showing group details.

  Use the -b| --brief option to limit the output to group names.

Viewing Members of a Group

You can view the members of a group.

• Enter list_members -g| --group <group name>.

Viewing Group Memberships

You can view the groups to which an asset belongs.

• Enter list_membership -n| --gear <asset name>.

  Use the -U| --uuid <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

Creating a Group

You can create a group.

• Enter create -g| --group <group> -d| --description <description> -p| --parent <parent group>.

  The parent group must already exist.

Updating Group Attributes

You can change the name, description, and parent group of a group.

• Enter update -g| --group <group>.

  Use the -n| --name <new name> option to rename the group.

  Use the -d| --description <new description> option to give the group a new description.

  Use the -p| --parent <new description> option to give the group a new parent group.

Adding an Asset To a Group

You can add an asset to a group.

• Enter attach -n| --gear <asset name> -g| --group <group>.

  Use the -U| --uuid <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

Removing an Asset From a Group

You can remove an asset from a group.

• Enter detach -n| --gear <asset name> -g| --group <group>.

  Use the -U| --uuid <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

Moving an Asset From One Group To Another Group

You can move an asset from one group to another group.

• Enter move -n| --gear <name of gear> -f| --from_group <current group> -g| --group <destination group>.

  Use the -U| --uuid <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

Deleting a Group

You can delete a group. Deleting a group does not affect the assets within the group.

• Enter delete -g| --group <group>.

  Use the -c| --child option to indicate if sub-groups under the specified group must be also deleted.

Powering On the Assets in a Group

You can power on assets within a group.

• Enter poweron -g| --group <group name>.

  Use the -n| --netboot option to cause each server to do a netboot instead of booting from disk.

  Deactivated hardware within the group is powered on.

Powering Off the Assets in a Group

You can power off assets within a group.

• Enter poweroff -g| --group <group name>.

  Use the -f | --force option to force the hardware to power off.

  Activated hardware within the group is powered off.

Reset Servers in a Group

You can reset servers inside a group.

• Enter reset -g| --group <group>

  Use the -f| --force option to force the operation.

  Use the -n| --netboot option to cause each server to do a netboot instead of booting from disk.

Starting Jobs Mode

You must change to jobs mode to run job commands.

• Enter jobs in the CLI prompt.

  EnterpriseController > jobs
  EnterpriseController/jobs >
  

Viewing Jobs

You can view a list of jobs.

• Enter list.

  The list of current and historical jobs is displayed.

  EnterpriseController/jobs > list
  Job ID                Status               Owner           Job Type 
  -------------------------------------------------------------------------------
  amritsar.5            SUCCESS              root            UpdateGearJob
  amritsar.4            SUCCESS              root            DeleteAssetJob
  amritsar.3            SUCCESS              root            AgentProvisioningJob
  amritsar.2            SUCCESS              root            AgentProvisioningJob
  amritsar.1            PARTIALLYSUCCESSFUL  root            DeleteAssetJob
  

  Use the -l| --detail option to view detailed job information.

  Use the -f| --filter <term> option to filter the job list.

  Use the -o| --owner <job_owner> option to list jobs owned by job_owner.

  Use the -s| --status <job_status> option to list jobs with status job_status.

  Use the -t| --type <job_type> option to list jobs with job type job_type.

  Use the -x| --id <job_id> option to list jobs with job id job_id.

  Use the -m| --matchAll option to list jobs that match all of the criteria indicated; default is for any search criteria to match.

  Use the -r| --runid <run ID> option to retrieve information of a job with a specific runID.

  Use the -C| --limit <limit> option to limit the number of jobs returned.

  Use the -A| --ascend option to sort results ascending; default is descending.

  Use the -S| --sort <job_attribute> option to sort results on <job_attribute>; default is to sort on job id.

  Use the -L| --nologdetails option to not include log details in detailed listing of jobs.

Starting a Job

You can run an existing job using its job ID.

• Enter run -x| --id <Job ID>.

  Use the --simulate option to run the job in simulation mode.

Repeating a Job on Failed Targets

You can re-run a partially successful job on its failed targets.

• Enter rerun_on_failed -x| --id <Job ID>.

Deleting a Job

Deleting a job removes the job information from Oracle Enterprise Manager Ops Center. You can only delete jobs that are stopped or completed.

• Enter delete -x| --id <Job ID>.

Stopping a Job

Stopping a job ends progress on the job.

• Enter stop -x| --id <Job ID>.

  Use the -f| --force option to force the operation.

Starting Stats Mode

You must switch to stats mode to run stats commands.

• Enter stats in the CLI prompt.

  EnterpriseController > stats
  EnterpriseController/stats >
  

Viewing Statistics

You can view statistics about the Enterprise Controller.

• Enter show.

  Name                  Used Mem %   Free Mem (MB)  Avg Load 15min  CPU Util %
  -------------------------------------------------------------------------------
  EnterpriseController  34.28         6646          1.74             75.00
  EnterpriseController  34.28         6646          1.74             75.00
  EnterpriseController  34.28         6646          1.74             75.00
  

  Use the -i| --interval <interval> option to specify a repeat interval in seconds.

Starting Notifications Mode

You must switch to notifications mode to run notifications commands.

• Enter notifications in the CLI prompt.

  EnterpriseController > notifications
  EnterpriseController/notifications >
  

Viewing Notifications

You can view all current notifications.

• Enter list.

  A list of notifications is displayed.

  EnterpriseController/notifications > list
  ID   Severity  Type    Message
  -------------------------------------------------------------------------------
  1    MEDIUM    INFO    Enterprise Controller registered with Sun. (70002)
  2    MEDIUM    INFO    Proxy Controller proxyone (172.20.27.185) has b...
  3    MEDIUM    INFO    Proxy Controller proxytwo (172.20.26.218) has b...
  

  Use the -l| --detail option to display a detailed list.

  Use the -f| --filter <filter term> option to filter the notifications.

  Use the -s| --severity <severity> option to display only notifications of given severity [HIGH|MEDIUM|LOW].

  Use the -c| --count <max> option to specify a maximum count of notifications to display.

  Use the -u| --username <user> option to display only notifications belonging to a user.

  Use the -i| --notification_id <ID> option to display notifications of a specific ID.

  Use the -r| --status <status> option to display only notifications according to their status [READ|UNREAD]. Default is to display both.

Deleting a Notification

You can delete a notification using its ID number.

• Enter delete -i| notification_id <notification ID number>.

  EnterpriseController > delete -i 43
  Successfully deleted notification
  

  Use the -u| --username <user> option to delete notifications belonging to a user.

Starting Update Mode

You must change to update mode to run these commands.

• Enter update in the CLI prompt.

  EnterpriseController > update
  EnterpriseController/update >
  

Viewing OS Update Policies

You can view the available OS update policies.

1. Enter list_policies.

   Use the -l| --detail option to display a detailed list.

Viewing OS Update Profiles

You can view the available OS update profiles.

• Enter list_profiles.

  Use the -l| --detail option to display a detailed list.

  Use the -p| --profile_name <profile_name> option to display profiles with a specific profile name.

Viewing OS Distributions

You can view the available distributions. By default, this command shows only active distributions.

• Enter list_distros.

  Use the -a| --all option to display inactive and active distributions.

Viewing Snapshots

You can view the snapshots for a specific asset.

• Enter list_snapshots -g| --gear <asset name>.

  The list of snapshots is displayed.

Searching Inventory

You can search an OS asset or all assets for inventory whose name matches a search string. The search string used for this command must be a regular expression. For a summary of regular expression constructs, visit http://docs.oracle.com/javase/1.4.2/docs/api/java/util/regex/Pattern.html#sum

• Enter search_inventory -s| --search_string <search string>.

  Enter the -g| --gear <asset name> option to search a specific asset, or use the -a| --allgear option to search all gear. You must use one of these two options.

  Use the -t| --snapshot <snapshot name> option to search for a specific snapshot. This option can only be used with the -g option.

  Use the -n| --description_string option to search descriptions.

  Use the -c| --cvs option to output to comma-separated values (CSV).

  Use the -f| --filename <filename> option to specify a filename for CSV output.

  Use the -d| --delimiter <delimiter> option to specify a delimiter character. The default is the pipe (|) character.

  Use the -e| --enclosure <enclosure> option to specify an enclosure character. The default is the quote (") character.

  Use the -p| --append option to append the data to an existing file.

  Use the -l| --detail option to display detailed data.

Checking Inventory

You can check an OS asset to see if inventory is available for it.

• Enter check_inventory.

  Enter the -g| --gear <asset name> option to check a specific asset, or use the -a| --allgear option to check all assets. You must use one of these two options.

  Use the -t| --snapshot <snapshot name> option to check a specific snapshot. This option can only be used with the -g option.

  Use the -c| --cvs option to output to comma-separated values (CSV).

  Use the -f| --filename <filename> option to specify a filename for CSV output.

  Use the -d| --delimiter <delimiter> option to specify a delimiter character. The default is the pipe (|) character.

  Use the -e| --enclosure <enclosure> option to specify an enclosure character. The default is the quote (") character.

  Use the -r| --header option to include a header line.

  Use the -p| --append option to append the asset data to an existing file.

Checking Connectivity to the Knowledge Base

You can check the connectivity to the knowledge base.

• Enter check_guus.

  Use the -u| --user <user name> option to specify a user name.

  Use the -p| --password <password> option to specify a password.

  Use the --proxy <proxy hostname> option to specify a proxy.

  Use the --port <proxy port> option to specify a proxy port.

  Use the --proxyuser <proxy user name> option to specify a proxy user name.

  Use the --proxypass <proxy password> option to specify a proxy password.

Querying Job History

You can view the job history for a specific OS asset.

• Enter job_history -g| --gear <asset list>.

  Use the -f| --fromdate <from date YYYYMMDD> option to specify a from date. The default is seven days ago.

  Use the -t| --todate <to date YYYYMMDD> option to specify an end date. The default is today.

  Use the -i| --jobids <ID> option to query a specific job or jobs, you must still supply the asset name.

  Use the -l| --log option to print logs.

  Use the --fail option to query failed status.

  Use the --ok option to query ok status.

  Use the --warning option to query warning status.

  Use the --nostatus option to query nostatus status.

  Use the --install option to query install action.

  Use the --upgrade option to query upgrade action.

  Use the --uninstall option to query uninstall action.

  Use the --downgrade option to query downgrade action.

  Use the --detail option to show a detailed listing.

Querying Job Status

You can query job staus.

• Enter get_job_status.

  Enter the -i| --jobids <job id> option to query specific jobs, or use the -a| --alljobs option to query all jobs. You must use one of these two options.

  Use the -l| --detail option to print out detail, including logs if available.

  Use the -c| --cvs option to output to comma-separated values (CSV).

  Use the -f| --filename <filename> option to specify a filename for CSV output.

  Use the -d| --delimiter <delimiter> option to specify a delimiter character. The default is the pipe (|) character.

  Use the -e| --enclosure <enclosure> option to specify an enclosure character. The default is the quote (") character.

  Use the -r| --header option to include a header line.

  Use the -p| --append option to append the asset data to an existing file.

Uploading a Knowledge Base Bundle

Knowledge base bundles contain current patch data. A knowledge base bundle must be moved to the system running the Enterprise Controller before it can be uploaded.

• Enter load_kb_bundle -f <path to KB bundle>.

Checking the Connection Mode

You can check the connection mode.

• Enter check_disconnected.

Changing to Connected Mode

You can change the Enterprise Controller from disconnected to connected mode.

• Enter set_connected_mode -c| --connected.

Changing to Disconnected Mode

You can change the Enterprise Controller from connected to disconnected mode.

• Enter set_connected_mode -d| --disconnected

Modifying an OS Asset

You can update a specific OS asset by installing, upgrading, and uninstalling specific packages and patches

• Enter modify_gear -g| --gear <assetname> -y| --policy <policy name> -a| --actual.

  Omit the -a option to run the job as a simulation.

  Use the --si <search string> option to specify a search term to add to the install list.

  Use the --sisubstring <search string> option to make the --si search a substring search.

  Use the --su <search string> option to specify a search term to add to the upgrade list.

  Use the --susubstring option to make the --su search a substring search.

  Use the --sr <search string> option to specify a search term to add to the uninstall list.

  Use the --srsubstring <search string> option to make the --sr search a substring search.

  The search strings used for this command must be regular expressions. For a summary of regular expression constructs, visit http://docs.oracle.com/javase/1.4.2/docs/api/java/util/regex/Pattern.html#sum

  Use the --ni <node ids to install> option to specify node IDs for install.

  Use the --nu <node ids to upgrade> option to specify node IDs for upgrade.

  Use the --nr <node ids to uninstall> option to specify node IDs for uninstall.

  Use the -j| --jobname <job name> option to specify a job name.

  Use the -e| --job-desc <job description> option to specify a job description.

  Use the -k| --taskname <taskname> option to specify a task name.

  Use the -f| --profile <profile name> option to specify a profile name.

  Use the -l| --profiledesc <profile description> option to specify a profile description.

  Use the -r| --failure_policy <failure policy> option to specify a failure policy.

  Use the -x| --execution_policy <execution policy> option to specify an execution policy.

  Use the -n <creator name> option to specify a creator name.

  Use the -o| --seconds <number of seconds> option to wait a specified number of seconds before running the job.

  Use the -c| --case option to run a case sensitive search.

  Use the -d| --desc option to search the description.

  Example:

  EnterpriseController/update > modify_gear -g "foo.us.oracle.com" --sr SUNWbzip -y "Yes To All" -a
  

Applying an Update Profile to an OS Asset

You can apply a profile to an asset, updating all packages and patches to match the profile.

• Enter apply_profile_to_gear -g | --gear <assetname> -y| --policy <policy name> -f| --profile_name <profile name> -a| --acutal

  Omit the -a option to run the job as a simulation.

  Use the -j| --jobname <job name> option to specify a job name.

  Use the -e| --job-desc <job description> option to specify a job description.

  Use the -k| --taskname <taskname> option to specify a task name.

  Use the -f| --profile <profile name> option to specify a profile name.

  Use the -r| --failure_policy <failure policy> option to specify a failure policy.

  Use the -x| --execution_policy <execution policy> option to specify an execution policy.

  Use the -o| --seconds <number of seconds> option to wait a specified number of seconds before running the job.

  The following is an example of a CLI command to deploy a profile job to one or more hosts:

  EnterpriseController/update > apply_profile_to_gear -g <space separated list of hostnames> -y "Yes To All" -f <profile name>
  

Creating a Historical Snapshot

You can create a historical snapshot.

• Enter create_historical_snapshot -g| --gear <asset name> -s| --snapshot <snapshot name> -d| --description <snapshot description>.

Deleting a Snapshot

You can delete an existing snapshot of an asset.

• Enter delete_snapshots -g| --gear <asset name> -s| --snapshot <snapshot name>.

Creating a Profile

You can create a new profile by specifying packages and patches to install, upgrade, and uninstall.

• Enter create_profile.

  You must supply a search string or node id. The search string used for this command must be a regular expression. For a summary of regular expression constructs, visit http://docs.oracle.com/javase/1.4.2/docs/api/java/util/regex/Pattern.html#sum

  Use the --si <search string> option to specify a search term to add to the install list.

  Use the --sisubstring <search string> option to make the --si search a substring search.

  Use the --su <search string> option to specify a search term to add to the upgrade list.

  Use the --susubstring option to make the --su search a substring search.

  Use the --sr <search string> option to specify a search term to add to the uninstall list.

  Use the --srsubstring <search string> option to make the --sr search a substring search.

  Use the --ni <node ids to install> option to specify node IDs for install.

  Use the --nu <node ids to upgrade> option to specify node IDs for upgrade.

  Use the --nr <node ids to uninstall> option to specify node IDs for uninstall.

  Use the -f| --profile <distribution name> option to specify a profile name.

  Use the -o| --distro <profile name> option to limit by distro name.

  Use the -l| --profiledesc <profile description> option to specify a profile description.

  Use the -a| --all option to include all matched packages/patches.

  Use the -c| --case option to run a case sensitive search.

  Use the -d| --desc option to search the description.

  Use the -r| --replace option to replace an existing profile if the names are the same.

Creating a Profile From Inventory

You can create a new OS profile based on an existing system.

• Enter create_profile_from_inventory -g| --gear <gear name>.

  Use the -t| --snapshot <snapshot name> option to search for a specific snapshot. This option can only be used with the -g option.

  Use the -f| --profile_name <profile name> option to specify a profile name.

  Use the -l| --profile_desc <profile description> option to specify a profile description.

  Use the -r| --include_removes option to include removed packages.

Deleting a Profile

You can delete a profile.

• Enter delete_profiles -p| --profilename <profile name>.

Adding a File to a Distribution

You can add a file stored on the Enterprise Controller to a distribution.

• Enter add_file_to_distro -f| --file_path <full path to distribution> -o| --distro_name <distro name> -a| --category_name <category name>.

  Use the -s| --security option to mark the distribution as security.

Uploading Local Software in Bulk From a Directory

You can upload the content from a directory and its subdirectories to the Updates software library.

• Enter bulk_upload_directory -D| --distribution <distribution name of uploaded files> -d| --directory <full path to the source directory>.

Adding a Local Action

You can add a local action.

• Enter add_local_action -a| --actionname <action name> -f| --filename <file name> -p| --parentname <parent category name> -d| --description <description> -c| --channelname <channel name> -t | --actiontype <action type>.

  The action type must be macro, postaction, preaction, or probe.

Adding a Local Category

You can add a local category.

• Enter add_local_category -c| --category_name <category name> -p| --parent_name <parent name> -d| --description <description> -o| --distro <distribution name>.

  Use the -r| --refresh option to refresh the hierarchy.

Deleting a Component

You can delete a component.

• Enter delete_component -i| --nodeid <node id> -d| --distro <distro>.

  Use the -k| --donotcheckforinstall option to refrain from checking for install.

Adding a Configuration File

You can add a configuration file.

• Enter add_configuration_file -f| --filename <filename> -p| --pathname <pathname to file> -v| --version <version> -c| --categoryname <category name> -d| --description <description> -c| --channelname <channel name>.

Setting a Component File

You can set a component file.

• Enter set_component_file -n| --componentname <component name> -d| --distro <distribution> -f| --filename <filename>.

Finding Nodes

You can find nodes whose names match a search string. The search string used for this command must be a regular expression. For a summary of regular expression constructs, visit http://docs.oracle.com/javase/1.4.2/docs/api/java/util/regex/Pattern.html#sum

• Enter find_nodes -s| --search_string <search string>.

  Use the -a| --all option to list all nodes.

  Use the -l| --detail option to print details.

  Use the -c| --case option to specify a case-sensitive search.

  Use the -d| --desc option to search descriptions.

  As the following examples shows, when regular expressions are not used correctly, any node is listed as a result:

  EnterpriseController/update > find_nodes -s SMCcurl-7.21* -a
  Name                           Node id    Distro          Available  Certified
  -------------------------------------------------------------------------------
  
  EnterpriseController/update > find_nodes -s SMCcurl-7.21.2-0 [1/1/2012] -a
  Name                           Node id    Distro          Available  Certified
  -------------------------------------------------------------------------------
  

  Correct examples:

  EnterpriseController/update > find_nodes -s SMCcurl-7.21.* -a
  Name                           Node id    Distro          Available  Certified
  -------------------------------------------------------------------------------
  SMCcurl-7.21.0-0 [1/1/2012]   41025315   SOLARIS10_SPARC  True       True
  SMCcurl-7.21.1-0 [1/1/2012]   41125695   SOLARIS10_SPARC  True       True
  SMCcurl-7.21.2-0 [1/1/2012]   42327548   SOLARIS10_SPARC  True       True
  
  EnterpriseContoller/update > find_nodes -s SMCcurl-* -a
  Name                           Node id    Distro          Available  Certified
  -------------------------------------------------------------------------------
  SMCcurl                        41002397   SOLARIS10_SPARC False      True
  SMCcurl                        46108251   SOLARIS9_SPARC  False      True
  SMCcurl                        52104822   SOLARIS10_X86   False      True
  

Starting OS Image Mode

You must switch to OS image mode to run OS image commands.

• Enter osimage in the CLI prompt.

  EnterpriseController > osimage
  EnterpriseController/osimage >
  

Viewing OS Images

You can view OS images.

• Enter list.

  Use the -l| --detail option to view a detailed list.

Importing an OS Image

You can import an OS image when it is located to the Enterprise Controller's local file system.

• Enter import -f| --filename <image file name and location> -d| --description <description> -n| --name <image name>.

  EnterpriseController/osimage > import -f folder/location/image.iso -d Solaris 10 -n Solaris 10
  JobId = EnterpriseController.47
  

Deleting an OS Image

You can delete OS images.

• Enter delete -n| --name <image name>.

Starting OS Profile Mode

You must switch to OS profile mode to run OS profile commands.

• Enter osprofile in the CLI prompt.

  EnterpriseController > osprofile
  EnterpriseController/osprofile >
  

Viewing OS Profiles

You can view OS profiles.

• Enter list.

  Use the -l| --detail option to view a detailed list.

  EnterpriseController/osprofile > list
   Profile Name: sles10Jeff1
     Description: sles10Jeff1
     Distro Name: sles10
     OS Version: SUSE-Linux-Enterprise-Server-SP2-10.2-0
     Platform: x86
  

Importing a JET Template

You can import a JET template.

• Enter import_jet_template -p| --profile <profile name> -i| --image <OS image> -t| --template <local template path>.

Importing an OS Profile

You can import an OS profile file. If you are importing a profile that you have previously exported, change the 'Name' and 'Payload_Name' fields before importing.

• Enter import -f| --file <profile name>

Exporting an OS Profile

You can export an OS profile to a designated file.

• Enter export -p| --profile <profile name> -f| --file <file name.prof>.

Copying an OS Profile

You can make a new profile by copying an existing profile.

• Enter clone -p| --profile <original profile name> -n| --name <new profile name>.

Deleting an OS Profile

You can delete an existing profile.

• Enter delete -p| --profile <profile name>.

Starting Fwimage Mode

You must switch to fwimage mode to run firmware image commands.

• Enter fwimage in the CLI prompt.

  EnterpriseController > fwimage
  EnterpriseController/fwimage >
  

Viewing Firmware Images

You can view a list of available firmware images.

• Enter list.

  Use the -l| --detail option to display a detailed list.

Creating a Firmware Image

You can create a firmware image.

1. Enter create.

   The image creation submode is launched.

2. Enter add_device -v | --vendor <vendor> -m| --model <model> to add a device for the firmware image.

   Use the -v| --validated option to specify a validated image.

3. Enter the criteria for the image using the set command.

   • Enter set name=<name> to set the firmware image name.

   • Enter set version=<version> to set the firmware version.

   • Enter set type=<type>.

   • Enter set make=<make>.

   • (Optional) Enter set description=<description>.

   • (Optional) Enter set size=<size>.

   • (Optional) Enter set powerOffRequired=<True|False>. This criteria is set to False by default.

   • (Optional) Enter set dependeeFirmwarePackageName=<dependencies>. This criteria is set to None by default.

   • (Optional) Enter set updateCount=<update count>.

4. (Optional) Use the show command to show the current criteria. If necessary, use the unset <property> command to unset a property, or use the reset command to clear all criteria.

5. Enter commit to create the new image using your criteria.

Updating a Firmware Image

You can update an existing firmware image.

1. Enter update -i| --image <image name>.

   The image update submode is launched.

2. Enter the new criteria for the image using the set command.

   • Enter set version=<version> to set the firmware version.

   • Enter set type=<type> to set the firmware type.

3. Enter commit to update the firmware image.

   EnterpriseController/fwimage > update -i myimage
   EnterpriseController/fwimage/update > set version=1.1
   EnterpriseController/fwimage/update > set type=ALOM-CMT
   EnterpriseController/fwimage/update > commit
   Firmware image updated successfully
   

Deleting a Firmware Image

You can delete any firmware image.

• Enter delete -i| --image <firmware image name>.

  The firmware image is deleted.

Starting FW Profile Mode

You must switch to fwprofile mode to run firmware profile commands.

• Enter fwprofile in the CLI prompt.

  EnterpriseController > fwprofile
  EnterpriseController/fwprofile >
  

Viewing Firmware Profiles

You can view the existing firmware profiles.

• Enter list.

  Use the -l| --detail option to display a detailed list.

  A list of firmware profiles is displayed.

Checking the Status of a Firmware Profile

You can check the status of a firmware profile.

• Enter status -p| --profile <profile name>.

  The firmware profile status is displayed.

Creating a Firmware Profile

You can create a firmware profile using one or more existing firmware images.

• Enter create -p| --profile <firmware profile name> -i| --images <list of images separated by comma>.

  Use the -d| --description <description> option to add a description to the profile.

  Use the -r| --reinstall option to force a reinstall when provisioning the firmware.

  Use the -g| --downgrade option to force a downgrade when provisioning the firmware.

  The firmware profile is created.

Updating a Firmware Profile

You can update an existing firmware profile.

• Enter update -p| --profile <firmware profile name> -i | --images <list of images separated by comma>.

  Use the -d| --description <description> option to add a description to the profile.

  Use the -r| --reinstall option to force a reinstall when provisioning the firmware.

  Use the -g| --downgrade option to force a downgrade when provisioning the firmware.

  The firmware profile is updated.

Deleting a Firmware Profile

You can delete a firmware profile.

• Enter delete -p| --profile <firmware profile name>.

  The firmware profile is deleted.

Starting Virtualization Mode

You must switch to virtualization mode to run virtualization commands.

• Enter virtualization in the CLI prompt.

  EnterpriseController > virtualization
  EnterpriseController/virtualization > 
  

Viewing Hosts

You can view the list of guest containers (global zones).

• Enter list_hosts.

Viewing Guests

You can view the list of non-global zones for a specific global zone.

• Enter list_guests -c| --container <global zone name>.

Migrating a Non-Global Zone

You can detach a non-global zone from its non-functioning global zone and attach the non-global zone to a different global zone.

• Enter startup (-z zonename -S ObjectName | -Z ObjectName) -D ObjectName.

  Use the -z| --zonename option to specify a guest (non-global zone). If you select this option you must specify a source global zone object name.

  Use the -S| --source-on option if you specify a zonename before. Using this option you specify a source global zone object name.

  Use the -Z| --zone-on option in case you did not select the -z| --zonename option. Using this option you indicate the host (global zone) object name.

  Use the -D| --destination option to indicate the destination (global zone).

Starting Deploy-Setup Mode

You must switch to deploy-setup mode to run commands for deploying assets. To start the deploy-setup mode, enter the deploy mode, which redirects you to the deploy-setup mode.

• Enter deploy in the CLI prompt.

  EnterpriseController > deploy
  EnterpriseController/deploy-setup >
  

Selecting a Deployment Plan

You must select an existing deployment plan.

• Enter plan <plan name>

  Use the -v| --version option to specify a version of a plan.

  EnterpriseController/deploy-setup > plan plan-fwp
  Plan "plan-fwp" selected: version 1, description "None"
  

Selecting a Target Asset

You must select an asset as the target of the deployment plan. You must always indicate an asset name or public UUID. In case of ambiguity, where multiple assets have the same user friendly name, the user is informed to use UUID instead.

• Enter target <asset name or public UUID>

  You can also add some other options:

  Use the -a| --add option to add assets to current set of targets.

  Use the -d| --delete option to delete assets from the current set of targets.

  Use the -g| --gear <asset name> option to give an asset name or a list of asset names, separated by comma.

  Use the -U| --UUID <public UUID> option to give an asset UUID or a list of asset UUIDs, separated by comma.

  Example using an asset's friendly user name:

  EnterpriseController/deploy-setup > target foo.us.oracle.com
  

  Example using an asset public UUID:

  EnterpriseController/deploy-setup > target 53f6e87f-3582-4cda-9c63-9121a3a8beb3
  

After you specify the plan and target, the mode changes from the deploy-setup mode to the deploy mode. This is reflected at the command prompt as follows:

EnterpriseController/deploy>

Viewing the Plan

You can view the attributes of the deployment plan or the deployment plan structure.

To view the attributes of a deployment plan:

• Enter show plan.

  EnterpriseController/deploy > show plan
  Target: foo.us.oracle.com
  __________________________________________________
  Step: Update Firmware
  __________________________________________________
  Associated Profile:
  {
  firmwarePackages:
  [
  ILOM-3_0_3_31_a-Sun_Fire_X4600M2
  ]
  dryRun: False
  subType: Server
  resetSP: False
  profileDescription:
  forceDowngrade: False
  forceReinstall: False
  profileName: fwp-profile
  network: None
  ip: None
   
  }
  

If you wish to view the structure of a plan:

• Enter show.

  EnterpriseController/deploy > show
  Step: Update Firmware
  __________________________________________________
  {
  isDryRun: Dry run?
  type: boolean
   
  firmwarePackages: Firmware Packages
  type: array of [
  type:java.lang.String
  ]
   
  resetSP: Reset SP?
  type: boolean
   
  forceDowngrade: Force Downgrade?
  type: boolean
   
  forceReinstall: Force Reinstall?
  type: boolean
   
  ip: IP Address
  type: java.lang.String
   
  network: Network Information
  {
  gateway: Gateway IP Address
  type: java.lang.String
   
  objectName: Object Name
  type: java.lang.String
   
  userFriendlyName: User Friendly Name
  type: java.lang.String
   
  netmask: Network Address Mask
  type: java.lang.String
   
  ip: IP Address
  type: java.lang.String
   
  }
  }
  

There are deployment plans that have results, if you wish to view these results:

• Enter show results.

  Example:

  EnterpriseController/deploy > show results
  Step: Provision OS
  Operating-System-1
  

Setting the Attributes of a Deployment Plan

You can modify the value of the attributes of a deployment plan. Some deployment plans require specific information during the deployment. See Table 19-5 for the names of the attributes you must set before applying the plan.

Use the following syntax to set an attribute or list of attributes of a deployment plan:

• For simple types:

  Enter set "<attribute-name> = <'string-value'>"|<int>|<true|false>

  Examples:

  EnterpriseController/deploy > set "forceReinstall = false"
  EnterpriseController/deploy > set "ip = '213.123.123.23'"
  

• For attributes that are backed by other struct-like value objects, use the following syntax:

  Enter set "<attribute-name> = list or nested object"

  set "network={gateway='213.123.123.111', userFriendlyName='ip address', ip='213.123.123.4'}"
  

• If you use JavaScript Object Notation (JSON) format, use the following syntax:

  set "{'resourcePlans':[{'hostName':'myhostname','networks':[{'networkBindings':[{'ipAddress':'123.123.123.1'}]}]}]}"
  

  Or

  set "resourcePlans=[{hostName='myhostname',networks=[{networkBindings=[{ipAddress='123.123.123.1'}]}]}]"
  

  Or

  set "<json-string> "
  

• For deployment plans on multiple targets that require unique values for each target, use the set command as follows:

  EnterpriseController/deploy > set "@<target-uuid or dynamic-target>:<key>=<'string-value'>"|<int>|<true|false>|list of nested objects"
  set "<@target-uuid or dynamic-target>:<json-string>"
  

  Example:

  EnterpriseController/deploy > set @<target-UUID>:"network={gateway='213.123.123.111', userFriendlyName='ip address', ip='213.123.123.4'}"
  

Adding Attributes to a Deployment Plan

You can add attributes to a deployment plan. The syntax for adding attributes is similar to the syntax for setting attributes. However, in the case of arrays, the add command appends an element to the array while the set command modifies the attribute of an existing element within the array.

Use the following syntax to add attributes to a deployment plan:

• For simple types:

  Enter add "<attribute-name> = {<'string-value'>"|<int>|<true|false>}

  Examples:

  EnterpriseController/deploy > add "forceReinstall = false"
  EnterpriseController/deploy > add "ip = '213.123.123.23'"
  

• For attributes that are backed by other struct-like value objects, use the following syntax:

  Enter add"<attribute-name> = list or nested object"

  EnterpriseController/deploy > add "network={gateway='213.123.123.111', userFriendlyName='ip address', ip='213.123.123.4'}"
  

• If you use JavaScript Object Notation (JSON) format, use the following syntax:

  "{'resourcePlans':[{'hostName':'myhostname','networks':[{'networkBindings':[{'ipAddress':'123.123.123.1'}]}]}]}"
  

  Or

  add "resourcePlans=[{hostName='myhostname',networks=[{networkBindings=[{ipAddress='123.123.123.1'}]}]}]"
  

  Or

  add "<json-string> "
  

• For deployment plans on multiple targets that require unique values for each target, use the set command as follows:

  add "@<target-uuid or dynamic-target>:<key>=<'string-value'>"|<int>|<true|false>|list of nested objects"
  add "<@target-uuid or dynamic-target>:<json-string>"
  

  Example:

  EnterpriseController/deploy > add @<target-UUID>:"network={gateway='213.123.123.111', userFriendlyName='ip address', ip='213.123.123.4'}"
  

Testing a Deployment Plan

To test a deployment plan, use the dryrun command to create the tasks without committing the job, this ensures no errors with data.

To dry run a deployment plan:

• Enter dryrun.

  EnterpriseController/deploy > dryrun
  

Applying a Deployment Plan

To execute a deployment plan, set the attributes if required and then apply the plan. Some deployment plans need to have their attributes set before applying the plan.

To apply a deployment plan to an asset:

• Enter apply.

  EnterpriseController/deploy > apply