The Oracle Enterprise Manager Ops Center Command Line Interface (CLI) is an alternative to the browser user interface for Oracle Enterprise Manager Ops Center.
This chapter explains how to use the Oracle Enterprise Ops Center CLI and all the commands included within this tool.
The following information is included:
The Oracle Enterprise Manager Ops Center CLI can perform many, but not all, functions of Oracle Enterprise Manager Ops Center. The following charts show the available features.
Table 19-1 shows the functions that the CLI can perform for asset discovery, management, and grouping.
Table 19-1 Asset Discovery, Management, and Grouping
Function | Possible with CLI | Mode |
---|---|---|
Find asset |
Yes |
Discover |
Execute discovery profiles |
Yes |
Discover |
Add asset |
No |
n/a |
Declare asset |
No |
n/a |
Manage asset |
Yes |
Gear |
Unmanage asset |
Yes |
Gear |
Register asset |
Yes |
Gear |
View asset data |
Yes |
Gear |
Update asset data |
Yes |
Gear |
Reset a server |
Yes |
Gear |
Refresh a server |
Yes |
Gear |
Manage locator lights |
Yes |
Gear |
Manage power settings |
Yes |
Gear |
Reboot an OS |
Yes |
Gear |
Reinstall an asset on an OS |
Yes |
Gear |
Create a group |
Yes |
Groups |
Add asset to a group |
Yes |
Groups |
Move assets between groups |
Yes |
Group |
Manage power settings of an asset in a group |
Yes |
Group |
Delete a group |
Yes |
Group |
Delete an asset |
Yes |
Gear |
Table 19-2 shows the functions that the CLI can perform for operating system provisioning and patching.
Table 19-2 Operating System Provisioning and Patching
Function | Possible with CLI | Mode |
---|---|---|
Import an OS image |
Yes |
OSImage |
Delete an OS image |
Yes |
OSImage |
Create an OS profile |
No |
n/a |
Import an OS profile |
Yes |
OSProfile |
Export an OS profile |
Yes |
OSProfile |
Clone an OS profile |
Yes |
OSProfile |
Delete an OS profile |
Yes |
OSProfile |
Import a JET template |
Yes |
OSProfile |
Provision an OS |
Yes |
Gear |
Check inventory |
Yes |
Update |
Upload a knowledge base bundle |
Yes |
Update |
Update operating systems |
Yes |
Update |
Create OS update profiles |
Yes |
Update |
Apply OS update profiles |
Yes |
Update |
Add a configuration file |
Yes |
Update |
Add a file to a distribution |
Yes |
Update |
Run OS update profiles |
No |
n/a |
Table 19-3 shows the functions that the CLI can perform for firmware provisioning.
Table 19-3 Firmware Provisioning
Function | Possible with CLI | Mode |
---|---|---|
Create a firmware image |
Yes |
FWImage |
Update a firmware image |
Yes |
FWImage |
Delete a firmware image |
Yes |
FWImage |
Create a firmware profile |
Yes |
FWProfile |
Update a firmware profile |
Yes |
FWProfile |
Delete a firmware profile |
Yes |
FWProfile |
Update firmware |
Yes |
Gear |
Check firmware compliance |
Yes |
Gear |
Run firmware reports |
No |
n/a |
Table 19-4 shows the functions that the CLI can perform for administration.
Function | Possible with CLI | Mode |
---|---|---|
Change connection mode |
Yes |
Update |
Deploy a Proxy Controller |
No |
n/a |
Manage users and roles |
Yes |
User |
View roles |
Yes |
Jobs |
Manage jobs |
Yes |
Jobs |
View notifications |
Yes |
Notifications |
Delete notifications |
Yes |
Notifications |
Manage incidents |
Yes |
Incidents |
The CLI must share information with the Enterprise Controller, therefore you must connect the CLI to the Enterprise Controller.
When the CLI runs on a system other than the Enterprise Controller, the system's credentials are necessary to connect to the Enterprise Controller. When the CLI runs on the same system as the Enterprise Controller, the CLI does not need credentials.
You get access to the command line interface from the following locations:
Oracle Solaris: /opt/SUNWoccli/bin
Linux: /opt/sun/occli/bin
Enter the oc
command.
# ./oc xvmSh>
You can also add some options. For more information about the options for the oc
command, see Using the CLI.
Enter the connect
command.
xvmSh > connect
localhost >
The CLI is connected to the Enterprise Controller.
Enter the oc
command.
# ./oc xvmSh>
You can also add some options. For more information about the options for the oc
command, see Using the CLI.
Enter the connect
command with the -h <enterprise controller>
, -u <user name>
, and -p <password>|
-p@<filename for password
> options.
Examples:
xvmSh > connect -h EnterpriseController -u root -p rootpass
EnterpriseController > xvmSh > connect -h EnterpriseController -u root -p@/tmp/pwd EnterpriseController >
The CLI is connected to the Enterprise Controller.
Note:
If you do not use the-h
, -u
, and -p
options, you are prompted for the Enterprise Controller name, user name, and password.The CLI is accessed with the oc
command. The oc
command can be run with the following options:
Use -V| --version
to show the CLI version and exit.
Use -h| --help
to show the CLI help and exit.
Use -q| --quiet
to be as quiet as possible.
Use -d| --debug <debug level>
to specify a debug logging level. Debug logging levels are DEBUG
, FINEDEBUG
, CMDSTAT
, INFO
, WARNING
, ERROR
, CRITICAL
, OFF
, and ALL
.
Use -c| --cmdfile <file>
to execute the <file>
command file.
Use -e| --eval <command>
for one-line execution. The <command>
command is the only command to be executed. This option can be run with one-liners. For more information about one-liners see Using the CLI One-Liner.
Use -o| --outfile <file>
to write the output to the <file>
file.
Examples:
#./oc -V OpsCenter Command Line Interface 12.1.0 #./oc -e history 495 connect 496 version
Variables can be defined and then used within any command.
To define a user variable, enter set <variable name>=<value>
in the command prompt.
Example:
#./oc xvmSh> set JOBID=foo.3 xvmSh> connect localhost> jobs.list -x $JOBID
The CLI accepts a list of commands as an argument.
To use the CLI one-liner, enter ./oc -e 'list commands separated by a semicolon'
in the command prompt.
Example:
#./oc -e 'connect ; jobs.list | grep FAILED'
The following are general commands used either for CLI execution or as universal commands.
Note:
You can use the Tab key to see a list of the available commands or as a completion key when typing a command.The ping
command checks connectivity to the Enterprise Controller.
To check the connectivity to the Enterprise Controller, enter ping
in the command prompt.
Example:
localhost > ping OEMEC None is alive, version : 12.1.0.1848
The printenv
command displays the current user configuration. The variables included in the user configuration are:
Output_format: Format for the command output.
Parsable_text_separator: Text separator for parsable command output.
Log_level: Logging level.
History_length: Number of commands saved in the history.
Debug: Debug logging.
Pager: Pager for long output.
Continue_on_error: Continue when a command fails.
Text_wrap_width: Maximum width, in characters, to be displayed in a line.
To display the current user configuration, enter printenv
in the command prompt.
Example:
localhost > printenv output_format=textparsable_text_separator=log_level=OFFhistory_length=500debug=falsepager=falsecontinue_on_error=falsetext_wrap_width=-1
The user configuration can be changed using the setenv
command.
The setenv
command sets the user environment in the following ways:
output_format=text|parsable parsable_text_separator=text log_level=OFF|ON history_length=integer debug=true|false pager=true|false continue_on_error=true|false text_wrap_width=integer
To set the user environment, enter sentenv <variable>=<value>
in the command prompt.
Example:
localhost > setenv pager=true
Note:
You must set the pager variable totrue
before running some commands, such as the man
command.The record
command copies all console inputs and outputs to a text file. You can save the resulting file in the directory you prefer. Issue the command without a file name to stop the recording.
To record the console inputs and outputs into a text file, enter record <filename>
in the command prompt.
Example:
localhost > record foo.file
Note:
Use the Tab key for filename completion.The source
command uses command script files to source commands as if they were entered at the prompt. For more information about command scripts, see Command Scripts. This command is also used to specify a file as the source of an operation when executing other commands. This file can be used for information that is shared by more than one script, or to keep secure information separate.
To use a source file, enter source <filename>
in the command prompt.
Example:
EnterpriseControler > source /tmp/cmds
The version
command displays the version of the CLI, the Oracle Enterprise Manager Ops Center software, the Java SE Runtime Environment, and the Java HotSpot Server VM software.
To view the version of the CLI, enter version
in the command prompt.
Example:
localhost > version CLI version: 12.1.0OpsCenter version: 12.1.0.1848Platform: Java-1.6.0_21-Java_HotSpot-TM-_Server_VM,_17.0-b16,_Sun_Microsystems_Inc.-on-SunOS-5.10-x86Jython Version: 2.5.1
You can set the CLI to wait until either the most recent job or a specific job finishes before launching a new job, using the wait
command. This can be useful if one job, such as a discovery, is a requirement for another job, such as grouping or managing discovered assets. You can identify a job by its jobID or by its runID.
The wait
command is used in command scripts where many commands are run almost at the same time, and a command must wait to be executed until the job launched by the previous command is completed. For more information about command scripts, see Command Scripts. This command can be used from within any mode at any time or from the main command line.
To wait for a job to complete, enter wait
in the command prompt.
Use the -i| --jobid <job ID>
option to specify a job ID. The CLI waits for that job to complete.
Use the -r| --runid <run ID>
option to specify a job runID. The CLI waits for that job to complete. Default is to wait for the last job.
Use the -a| --all
option to wait for all jobs.
Use the -n| --maxwait <maximum wait time>
to specify a timeout, a maximum number of seconds to wait for a job to complete.
Note:
To interrupt a wait operation during interactive session, press Ctrl+C.You can use the help
command to show the available commands. This command can be used from within any mode at any time or from the main command line.
To show the available commands, enter help
in the command prompt.
Use the -l
option to include detailed usage information.
The history
command shows recent commands. This command can be used from within any mode at any time or from the main command line.
To show the recent commands, enter history
in the command prompt.
Use the -n <number of commands>
option to limit the history list.
Example:
localhost > history -n 3
The history includes a command number for the sequence. To repeat a command in the history enter the !
character with the command number and press the Tab key, as shown in the following example:
localhost > history -n 3 495 connect 496 version 498 history -n 3 #!496 <TAB> #version
You can display the man page for a specific mode, using the man
command. The syntax usage and description for all mode subcommands are included in the man page. This command can be used from within any mode at any time or from the main command line.
To display the man page for a specific mode, enter man
<mode name>
in the command prompt.
Example:
localhost > man gear
If no mode name is given, the CLI man page is displayed.
To see a list of man pages, enter the command and press the Tab key.
Note:
Theman
command requires the pager
environment variable to be set to true
for multipage output before being run. For more information about how to set the pager
variable to true
, see Setting the User Environment.You can exit a mode and return to the initial CLI prompt, using the end
command. This command can be used from within any mode at any time or from the main command line.
To exit a mode, enter end
in the command prompt.
Example:
localhost/gear > end localhost >
The disconnect
command closes the connection between the Oracle Enterprise Manager Ops Center Command Line Interface and the Enterprise Controller.
To disconnect from the Enterprise Controller, enter disconnect
in the command prompt.
Example:
localhost > disconnect xvmSh >
For any main or mode command, you can constrain the output by appending one of the following filters to the command:
|grep
regexp to filter by the regular expression
|count
integer to display only the number of output lines
|tee
filename to write the output to a file
Example:
localhost/jobs > list | tee /var/tmp/todays_jobs.txt
Note:
For better results withgrep
and count
filters, activate parsable output, using the setenv
command.The CLI can also be used in a non-interactive way, using command scripts. The following example shows a script named update.xvm
that writes the inventory of a server to a file:
connect finance_svr -u zz3282134 -p b@seba11 update csv_inventory -h finance_svr -f ~/inventory_latest.csv wait end
To create the file at any time, issue the following command:
oc --cmdfile update.xvm
To run a command script use the source
command.
Example:
xvmSh > source update.xvm
The commands in this section start a mode that includes a set of subcommands. Use the man
command to display the man page for each mode.
Controllers – Use controllers mode to migrate assets from one Proxy Controller to another Proxy Controller.
Credentials – Use credentials mode to view and manage driver credentials.
Deploy-Setup – Use deploy-setup mode to set up the plan and target to deploy an asset.
Deploy – Use deploy mode to deploy an asset.
Discover – Use discovery mode to discover gear (assets).
FWImage – Use fwimage mode to create, view, and manage firmware images.
FWProfile – Use fwprofile mode to create, view, and manage firmware profiles.
Gear – Use gear mode to view and manage gear (assets) and provision operating systems and firmware.
Groups – Use groups mode to view, create, and manage groups.
Jobs – Use jobs mode to view and manage jobs.
Incidents – Use incidents mode to view and manage incidents.
Notifications – Use notifications mode to view notifications and change notification settings.
OSImage – Use osimage mode to view, manage, and install OS images.
OSProfile – Use opsrofile mode to view, manage, and import OS profiles.
ServerPools – Use serverpools mode to view, and manage server pools.
Stats – Use stats mode to view statistics about the Enterprise Controller.
Update – Use update mode to view and manage OS update profiles, policies, snapshots, and distributions, and view and change the connection mode.
User – Use user mode to create, view and manage users and roles.
Virtualization – Use virtualization mode to view, and manage virtual hosts and virtual machines.
Unlike the ecadm
and proxyadm
commands, which are used for administering the Enterprise Controller and its Proxy Controllers, the CLI operates on the assets of the data center.
To execute a subcommand within a mode:
Enter the mode, then enter the subcommand.
Enter <mode name>.<subcommand name>
.
Example:
localhost > jobs.list
For information about the mode commands that have a corresponding action in the browser user interface, see Finding the Equivalent Browser User Interface Actions For the Mode Commands.
Controller mode allows you to evacuate the assets managed by a failed Proxy Controller to other available Proxy Controllers. This mode also allows you to view the available Proxy Controllers that you can use to evacuate the assets.
You can view a list of the available Proxy Controllers, Enterprise Controllers, and Virtualization Controllers.
Enter list
.
localhost/controllers > list Controller list: Name | UUID |Status | Version | ----------------------------------------------------------------------------- 10.131.110.95-PC | h4fm76fd-28be-4892-8uae-4i8b20b780e1 |UNKNOWN| 12.1.4.2311 | 10.131.105.97-PC | 6485cdab-7654-ac6b-a781-4fg796791054 | OK | 12.1.4.2311 | 10.131.105.97-EC | abcd2f30-ef67-4564-ab12-bc989b6ab671 | OK | 12.1.4.2311 | x44-sa1-oracl-VC | 987me955-1edt-4678-adi5-192ggg1e74e6 | OK | 12.1.4.2311 |
You can evacuate the assets managed by a failed Proxy Controller to other available Proxy Controllers. The Proxy Controller to which the assets can be migrated is automatically determined based on the networks managed by the remaining available Proxy Controllers and their load.
Credentials mode allows you to view and manage the driver credentials necessary to discover and manage assets. The credentials also help to establish trust between internal components.
You can view a list of existing driver credentials
localhost/credentials > list Driver Credentials: ID | Name | Type | Description | -------------------------------------------------------------- 6850 | admin | SSH | root/admin SSH creds | 6840 | occosIPMI | IPMI | IPMI |
Use the -i| --ids
<credential IDs>
option to give a specific credential ID or a list of credential IDs. IDs must be separated by a comma.
Use the -l
| --detail option to include detailed credential information.
You can modify the values of a driver credential. The modify
command starts a submode with its own set of subcommands.
Enter modify
-i
| --id <credential ID>
.
localhost/credentials > modify -i 6840 localhost/credentials/modify >
(Optional) Use the show
command to display the current properties of the credential.
localhost/credentials/modify > show description=IPMI *sharedSecret=***** *login=IPMI_user *name=occosIPMI
Note:
Properties marked with an asterisk (*) at the beginning must be set.Enter set <property>=<value>
to modify a property value of the credential.
localhost/credentials/modify > set name=IPMI_cred
If necessary, use the unset <property>
command to unset a property or the reset
command to reset all properties.
Use the commit
command to apply the change.
Deploy-setup mode allows you to specify a deployment plan and its target. The deployment plan must exist already and the asset must be already a managed asset.
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.
localhost > deploy localhost/deploy-setup >
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:
localhost/deploy-setup > target foo.us.oracle.com
Example using an asset public UUID:
localhost/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:
localhost/deploy>
Deploy mode allows you to deploy an asset.
You can view the attributes of the deployment plan or the deployment plan structure.
To view the attributes of a deployment plan:
localhost/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 }
To view the structure of a plan:
localhost/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 } }
To view the results of a deployment plan:
You can modify the value of the attributes of a deployment plan using the set
command. 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.
Table 19-5 Deployment Plans and Attributes
Deployment Plan | Attributes |
---|---|
Configure M-Series Hardware, Create and Install Domain |
No per-target attribute collection required. |
Configure RAID |
No per-target attribute collection required. |
Configure Server Hardware and Install OS |
No per-target attribute collection required. |
Configure Service Processor |
No per-target attribute collection required. |
Configure and Install Dynamic System Domain |
No per-target attribute collection required. |
Configure and Install Logical Domains |
No per-target attribute collection required. |
Configure and Install Virtual Machines |
No per-target attribute collection required. |
Create Boot Environment |
No per-target attribute collection required. |
Create Dynamic System Domain |
No per-target attribute collection required. |
Create Logical Domains |
(Optional) Logical domains creation requires the setting of resource plan structures per each logical domain to create. |
Create Solaris Zones |
(Optional) Solaris zones creation requires the setting of resource plan structures per each logical domain to create. |
Configure and Install Solaris Zones |
The only parameters that must be set are the same as those used in creating an Oracle Solaris zones deployment plan. |
Create Virtual Machines |
No per-target attribute collection required. |
Provision Network |
No per-target attribute collection required. |
Provision OS |
|
Install Server |
The only parameters that must be set are the same than in provision OS. |
Software Deployment / Update |
No per-target attribute collection required. |
Update Solaris 11 OS |
No per-target attribute collection required. |
Update BIOS Configuration |
No per-target attribute collection required. |
Update Firmware |
No per-target attribute collection required. |
Update Firmware and Install Oracle VM Server for SPARC |
No per-target attribute collection required. |
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:
localhost/deploy > set "forceReinstall = false" localhost/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 Objet 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:
localhost/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:
localhost/deploy > set @<target-UUID>:"network={gateway='213.123.123.111', userFriendlyName='ip address', ip='213.123.123.4'}"
You can add attributes to a deployment plan using the add
command. The syntax for adding attributes is similar to the syntax for setting attributes. However, for 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:
localhost/deploy > add "forceReinstall = false" localhost/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"
localhost/deploy > add "network={gateway='213.123.123.111', userFriendlyName='ip address', ip='213.123.123.4'}"
If you use JavaScript Objet 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:
localhost/deploy > add @<target-UUID>:"network={gateway='213.123.123.111', userFriendlyName='ip address', ip='213.123.123.4'}"
Discover mode allows you to set up and run discovery jobs. You can create a discovery job or use a discovery profile to discover an asset. You can also execute an existing discovery profile.
You must switch to discover mode to run discovery commands.
Enter discover
in the CLI prompt.
localhost > discover localhost/discover >
The create submode is used to create and launch new discovery jobs. This submode has its own set of commands.
Enter set type=os
.
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.
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.
(Optional) Enter set ssh_port=<port>
to specify a port.
(Optional) Enter set use_default
=true|false
to specify if the factory default credentials are used or not for the discovery job.
(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.
Enter commit
to start the configured discovery job.
The job is launched, and the job ID is displayed.
Example of OS discovery:
localhost/discover > create localhost/discover/create > set type=os localhost/discover/create > set ssh_user=sysmgmt localhost/discover/create > set ssh_password=l0ckit localhost/discover/create > set ipaddrs=172.20.28.202 localhost/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= localhost/discover/create > commit
ILOM is the service processor used in some Oracle Sun servers. An ILOM discovery also discovers operating systems.
Enter set type=ilom
.
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.
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.
Enter set ipmi_user=<IPMI user name>
.
Enter set ipmi_password=<IPMI user password>
.
(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.
Enter commit
to start the configured discovery job.
The job is launched, and the job ID is displayed.
ALOM is the service processor used in some Oracle Sun servers. An ALOM discovery also discovers operating systems and systems with ILOM service processors.
Enter set type=alom
.
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.
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.
Enter set telnet_user=<telnet user name>
.
Enter set ipmi_password=<password for telnet user name>
.
(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.
Enter commit
to start the configured discovery job.
The job is launched, and the job ID is displayed.
You can list all the existing discovery ranges that discover systems.
You can list all driver credentials for a discovery profile used to discover systems.
You can list all driver ranges for a discovery profile used to discover systems.
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 specific discovery credential ID or a list of discovery credential 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.
Fwimage mode allows you to view and delete firmware images.
You must switch to fwimage mode to run firmware image commands.
Enter fwimage
in the CLI prompt.
localhost > fwimage localhost/fwimage >
You can create a firmware image.
The image creation submode is launched.
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.
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>
.
(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.
Enter commit
to create the new image using your criteria.
You can update an existing firmware image.
Enter update
-i| --image <image name>
.
The image update submode is launched.
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.
Enter commit
to update the firmware image.
localhost/fwimage > update -i myimage localhost/fwimage/update > set version=1.1 localhost/fwimage/update > set type=ALOM-CMT localhost/fwimage/update > commit Firmware image updated successfully
Fwprofile mode allows you to view and delete firmware profiles.
You must switch to fwprofile mode to run firmware profile commands.
Enter fwprofile
in the CLI prompt.
localhost > fwprofile localhost/fwprofile >
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.
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.
Use gear mode to view and manage all assets, including operating systems, hardware, and chassis. Although the term for objects that the Enterprise Manager Ops Center software manages is "asset", the CLI uses the term "gear".
You must switch to gear mode before using other gear subcommands.
Enter gear
in the CLI prompt.
localhost > gear localhost/gear >
You can list the assets managed by Oracle Enterprise Manager Ops Center
localhost/gear > list Registered Gear: UFN |Manage state|Description |Asset Type| UUID | Maintenance| ------------------------------------------------------------------------------- v64v| MANAGED |10.79.103.14| Server |6fdg9-fc-8b-91-dd2651d|NO_MAINTENANCE c4pr| MANAGED |10.68.102.26| Server |5a544-dc-43-82-ef8886d|NO_MAINTENANCE
Use the -l
| --detail
option to show asset details.
Example
localhost/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 : 6fdg9-fc-8b-91-dd2651d Asset Type : Server Name : c4pr Description : 10.68.102.26 Managed State : MANAGED Status : OK Lock Info : None Is a Zone : False Public UUID : 5a544-dc-43-82-ef8886d Asset Type : Server
Use the f| --filter <filter term>
option to filter the assets list.
Example
localhost/gear > list --filter v64v Registered Gear: UFN |Manage state|Description |Asset Type| UUID | ------------------------------------------------------------------------------- v64v| MANAGED |10.79.103.14| Server | 6fdg9-fc-8b-91-dd2651
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.
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'
You can manage discovered assets.
Enter manage
-g| --gear <asset name> -u| --user <user name with access to asset> -p| --password <user'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.
You can unmanage a managed asset, removing the asset from the managed asset list and removing any agent.
Enter unmanage
-g| --gear <asset name>
-u| --user <user name with access to asset> -p| --password <user'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.
You can place an asset in maintenance mode or remove an asset from maintenance mode.
Enter set_maintenance
-g| --gear <asset name> 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'
Use the on
option to set the asset in maintenance mode.
Use the off
option to unset the maintenance mode of 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'
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'
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'
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.
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'
You can compare the firmware for a list of assets to a firmware profile.
You can provision a new operating system to a managed system. The provision_os
command starts a submode with its own set of subcommands.
Enter provision_os
-g| --gear <asset name> -p| --profile <profile>
.
localhost/gear > provision_os -g targetsystem -p S10 localhost/gear/provision_os# >
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
(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.
Use the commit
command to launch the OS provisioning job.
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'
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'
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.
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'
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.
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'
Groups mode allows you to view and manage groups.
You must change to groups mode to run these commands.
Enter groups
in the CLI prompt.
localhost > groups localhost/groups >
You can change the name, description, and parent group of a group.
You can move an asset from one group to another group.
You can delete a group. Deleting a group does not affect the assets within the group.
Incidents mode allows you to view and manage existing incidents.
You must switch to incidents mode to run incidents commands.
Enter incidents
in the CLI prompt.
localhost > incidents localhost/incidents >
You can view details of the existing incidents or a specific incident.
You can view the alerts associated with one or more incidents.
Enter show_alerts
-i| --incidents <incident ID or comma-separated incident IDs list>.
Use the -l| --detail
option to display detailed incidents information.
You can indicate that you are investigating 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.
Use the jobs mode to view existing jobs.
You must change to jobs mode to run job commands.
Enter jobs
in the CLI prompt.
localhost > jobs localhost/jobs >
You can view a list of jobs.
The list of current and historical jobs is displayed.
localhost/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.
You can re-run a partially successful job on its failed targets.
Notifications mode allows you to view notifications.
You must switch to notifications mode to run notifications commands.
Enter notifications
in the CLI prompt.
localhost > notifications localhost/notifications >
You can view all current notifications.
A list of notifications is displayed.
localhost/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.
OS image mode allows you to view and manage OS images.
You must switch to OS image mode to run OS image commands.
Enter osimage
in the CLI prompt.
localhost > osimage localhost/osimage >
OS profile mode allows you to view, import, and export operating system profiles.
You must switch to OS profile mode to run OS profile commands.
Enter osprofile
in the CLI prompt.
localhost > osprofile localhost/osprofile >
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.
Serverpools mode allows you to view the existing server pools, and to list and remove a member from a server pool.
You must switch to serverpools mode to run server pool commands.
Enter serverpools
in the CLI prompt.
localhost > serverpools localhost/serverpools >
In stats mode, you view statistics about the Enterprise Controller:
Percentage of memory used
Free memory (MB)
Average load (15 minutes)
CPU utilization percentage
You must switch to stats mode to run stats commands.
Enter stats
in the CLI prompt.
localhost > stats localhost/stats >
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.
Update mode allows you to view and manage policies, profiles, and snapshots for OS updates.
You must change to update mode to run these commands.
Enter update
in the CLI prompt.
localhost > update localhost/update >
You can view the available distributions. By default, this command shows only active distributions.
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 -D| --description
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.
You can check an OS asset to see if inventory is available for it.
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.
You can check the connectivity to the knowledge base.
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 host name>
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.
You can view the job history for a specific OS asset.
Enter job_history
-g| --gear <asset list>
.
Use the -l| --detail
option to show a detailed listing.
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 < job 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.
You can query 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.
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.
You can change the Enterprise Controller from disconnected to connected mode.
You can change the Enterprise Controller from connected to disconnected mode.
Enter set_connected_mode -d| --disconnected
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 --su
<search string>
option to specify a search term to add to the upgrade list.
Use the --sr <search string
> option to specify a search term to add to the uninstall list.
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| --jobdesc <job description>
option to specify a job description.
Use the -k| --taskname <taskname>
option to specify a task name.
Use the -f| --profilename <profile name>
option to specify a profile name.
Use the -D| --description <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 -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:
localhost/update > modify_gear -g "foo.us.oracle.com" --sr SUNWbzip -y "Yes To All" -a
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| --profilename <profile name> -a| --actual
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| --jobdesc <job description>
option to specify a job description.
Use the -k| --taskname <taskname>
option to specify a task 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:
localhost/update > apply_profile_to_gear -g <space separated list of host names> -y "Yes To All" -f <profile name>
You can create a new profile by specifying packages and patches to install, upgrade, and uninstall.
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 --su <search string>
option to specify a search term to add to the upgrade list.
Use the -sr <search string>
option to specify a search term to add to the uninstall list.
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| --profilename <distribution name>
option to specify a profile name.
Use the -o| --distro <profile name>
option to limit by distro name.
Use the -D| --description <profile description>
option to specify a profile description.
Use the -t| --type <profile description>
option to specify a profile type.
Use the -a| --all
option to include all matched packages/patches.
Use the -c| --case
option to run a case sensitive search.
Use the -r| --replace
option to replace an existing profile if the names are the same.
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| --profilename <profile name>
option to specify a profile name.
Use the -D| --description <profile description>
option to specify a profile description.
Use the -r| --include_removes
option to include removed packages.
You can add a file stored on the Enterprise Controller to a distribution.
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>.
Note:
For more information about how to view the available distributions, see Viewing OS DistributionsYou 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.
As the following examples shows, when regular expressions are not used correctly, any node is listed as a result:
localhost/update > find_nodes -s SMCcurl-7.21* -a Name Node id Distro Available Certified ------------------------------------------------------------------------------- localhost/update > find_nodes -s SMCcurl-7.21.2-0 [1/1/2012] -a Name Node id Distro Available Certified -------------------------------------------------------------------------------
Correct examples:
localhost/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
User mode allows you to view and manage local and remote users and their roles.
You must switch to user mode to run these commands.
Enter user
in the CLI prompt.
localhost > user localhost/user >
You can view the existing users in the Enterprise Controller.
You can view the available role types in the Enterprise Controller.
You can view the roles assigned to a specific user in 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 <user name> -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.
You can grant a user role to a user of the Enterprise Controller.
Enter grant_local_role
-u| --user <user name> -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.
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.
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.
You can add a directory server.
localhost/user > configureds localhost/user/configureds >
Enter set name=<name>
to set the directory server name.
Enter set hostname=<host name>
to set a fully qualified host name.
Enter set use_ssl=<false|true>
if you want to enable or disable SSL. Default is false
.
Enter set port=<port>
to set a port.
Enter set user=<user name>
to set a user name to connect with.
Enter set password=<password>
to set a password.
Enter set root_suffix=<root suffix>
to set the root suffix.
Enter set user_dn=<user DN>
to set the user search DN.
Enter set user_scope=<user scope>
to set the user search scope.
Enter set search_filter=<search filter>
to set the user search filter.
(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.
Use the commit
command to finish configuring the directory server.
You can synchronize all directory server users and their roles with the cache on the Enterprise Controller.
You can synchronize a specific user on the directory server with the cache on the Enterprise Controller.
The virtualization mode manages virtual hosts and virtual machines (Oracle Solaris zones only).
You must switch to virtualization mode to run virtualization commands.
Enter virtualization
in the CLI prompt.
localhost > virtualization localhost/virtualization >
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).
You can use the Oracle Enterprise Manager Ops Center browser user interface (BUI) instead of using the command-line interface. You can find in the browser user interface many, but not all, equivalent actions for the CLI mode commands.
The following charts show the mode commands that have a corresponding action in the browser user interface:
Table 19-7 shows the commands included in the Controllers mode and their equivalent actions in the BUI.
Table 19-6 Controllers Mode Commands and Their Equivalent Actions in the BUI
CLI Command | BUI Action |
---|---|
Open the alert indicating that a Proxy Controller has failed> Migrate Assets> Auto Balance across Proxy Controllers> Migrate |
|
Open the alert indicating that a Proxy Controller has failed> Migrate Assets> Auto Balance across Proxy Controllers> Migrate |
Table 19-7 shows the commands included in the Credentials mode and their equivalent actions in the BUI.
Table 19-8 shows the commands included in the Deploy-Setup mode and their equivalent actions in the BUI.
Table 19-9 shows the commands included in the Deploy mode and their equivalent actions in the BUI.
Table 19-9 Deploy Mode Commands and Their Equivalent Actions in the BUI
CLI Command | BUI Action |
---|---|
Navigation Pane> Plan Management> Deployment Plans> Select a type of plan> Select a plan> Center Pane> Details tab |
|
NA |
|
Navigation Pane> Plan Management> Deployment Plans> Select a type of plan> Select a plan> Center Pane> Results tab |
|
Navigation Pane> Plan Management> Deployment Plans> Select a type of plan> Select a plan> Actions Pane> Edit Deployment Plan |
|
NA |
|
NA |
|
Navigation Pane> Plan Management> Deployment Plans> Select a type of plan> Select a plan> Actions Pane> Apply Deployment Plan |
Table 19-10 shows the commands included in the Discover mode and their equivalent actions in the BUI.
Table 19-10 Discover Mode Commands and Their Equivalent Actions in the BUI
CLI Command | BUI Action |
---|---|
NA |
|
Navigation Pane> Plan Management> Profiles and Policies> Discovery |
|
NA |
|
Navigation Pane> Administration> Enterprise Controller> Credentials |
|
Navigation Pane> Plan Management> Profiles and Policies> Discovery> Select a Discovery Profile> Discovery Credentials table in the Center Pane. |
|
NA |
|
NA |
|
Navigation Pane> Plan Management> Profiles and Policies> Discovery> Select a Discovery Profile> Actions Pane> Add Assets |
Table 19-11 shows the commands included in the FWImage mode and their equivalent actions in the BUI.
Table 19-12 shows the commands included in the FWProfile mode and their equivalent actions in the BUI.
Table 19-12 FWProfile Mode Commands and Their Equivalent Actions in the BUI
CLI Command | BUI Action |
---|---|
Navigation Pane> Plan Management> Profiles and Policies> Firmware |
|
NA |
|
Navigation Pane> Plan Management> Profiles and Policies> Firmware> Actions Pane> Create Profile |
|
Navigation Pane> Plan Management> Profiles and Policies> Firmware> Center Pane> Edit |
|
Navigation Pane> Plan Management> Profiles and Policies> Firmware> Center Pane> Delete |
Table 19-13 shows the commands included in the Gear mode and their equivalent actions in the BUI.
Table 19-13 Gear Mode Commands and Their Equivalent Actions in the BUI
CLI Command | BUI Action |
---|---|
Navigation Pane> Assets> All Assets |
|
Navigation Pane> Assets> All Assets> Select an asset> Actions Pane> Edit Attributes or Edit Tags |
|
Navigation Pane> Assets> All Assets> Jobs tab |
|
NA |
|
NA |
|
Navigation Pane> Assets> All Assets> Select an asset> Actions Pane> Place in Maintenance Mode or Remove From Maintenance Mode |
|
Navigation Pane> Assets> All Assets> Select an asset> Actions Pane> Delete Assets |
|
Navigation Pane> Assets> All Assets> Select an OS> Actions Pane> Switch Management Access |
|
Navigation Pane> Assets> All Assets> Select an OS> Actions Pane> Reboot |
|
Navigation Pane> Assets> All Assets> Select an asset> Actions Pane> Update Firmware |
|
NA |
|
Navigation Pane> Plan Management> Deployment Plans> Provision OS> Select a Plan> Actions Pane> Apply Deployment Plan |
|
set (locator lights) |
Navigation Pane> Assets> All Assets> Select an asset> Actions Pane> Locator Lights On or Locator Lights Off |
set (notifications) |
NA |
Navigation Pane> Assets> All Assets> Select an asset> Actions Pane> Power Off |
|
Navigation Pane> Assets> All Assets> Select an asset> Actions Pane> Power On |
|
Navigation Pane> Assets> All Assets> Select a server Actions Pane> Reset Server(s) |
|
Navigation Pane> Assets> All Assets> Select a server Actions Pane> Refresh |
Table 19-14 shows the commands included in the Groups mode and their equivalent actions in the BUI.
Table 19-14 Groups Mode Commands and Their Equivalent Actions in the BUI
CLI Command | BUI Action |
---|---|
list (Predefined Groups) |
Navigation Pane> Assets> Server, Chassis, Operating Systems or All User Defined Groups |
Navigation Pane> Assets> Server, Chassis, Operating Systems or All User Defined Groups |
|
Navigation Pane> Assets> Server, Chassis, Operating Systems or All User Defined Groups |
|
Navigation Pane> Assets> All User Defined Groups> Actions Pane> Create Group |
|
Navigation Pane> Assets> All User Defined Groups> Actions Pane> Edit Group |
|
Navigation Pane> Assets> All User Defined Groups> Actions Pane> Add Asset to Group |
|
Navigation Pane> Assets> All User Defined Groups> Actions Pane> Remove Asset from Group |
|
Navigation Pane> Assets> All User Defined Groups> Actions Pane> Move Asset to Group |
|
Navigation Pane> Assets> All User Defined Groups> Actions Pane> Delete Group |
|
Navigation Pane> Assets> All User Defined Groups> Actions Pane> Power On |
|
Navigation Pane> Assets> All User Defined Groups> Actions Pane> Power Off |
|
Navigation Pane> Assets> All User Defined Groups> Actions Pane> Reset Server (s) |
Table 19-15 shows the commands included in the Incidents mode and their equivalent actions in the BUI.
Table 19-15 Incidents Mode Commands and Their Equivalent Actions in the BUI
CLI Command | BUI Action |
---|---|
Navigation Pane> Message Center> Unassigned Incidents, My Incidents or Incidents Assigned to Others |
|
Navigation Pane> Message Center> Unassigned Incidents, My Incidents or Incidents Assigned to Others |
|
Navigation Pane> Message Center> Unassigned Incidents, My Incidents or Incidents Assigned to Others> Acknowledge Incident(s) |
|
Navigation Pane> Message Center> Unassigned Incidents, My Incidents or Incidents Assigned to Others> Add Annotation to Incident(s) |
|
Navigation Pane> Message Center> Unassigned Incidents, My Incidents or Incidents Assigned to Others> Assign Incident(s) |
|
Navigation Pane> Message Center> Unassigned Incidents, My Incidents or Incidents Assigned to Others> Close Incident(s) |
Table 19-16 shows the commands included in the Jobs mode and their equivalent actions in the BUI.
Table 19-17 shows the commands included in the Notifications mode and their equivalent actions in the BUI.
Table 19-18 shows the commands included in the OSImage mode and their equivalent actions in the BUI.
Table 19-19 shows the commands included in the OSProfile mode and their equivalent actions in the BUI.
Table 19-19 OSProfile Mode Commands and Their Equivalent Actions in the BUI
CLI Command | BUI Action |
---|---|
Navigation Pane> Plan Management> Profiles and Policies> OS Provisioning |
|
Navigation Pane> Plan Management> Profiles and Policies> OS Provisioning> Create Profile> Select JET Template in the Subtype |
|
Navigation Pane> Plan Management> Profiles and Policies> Update Profiles> Center Pane> Import Profile |
|
Navigation Pane> Plan Management> Profiles and Policies> Update Profiles> Center Pane> Export Profile |
|
Navigation Pane> Plan Management> Profiles and Policies> OS Provisioning> Center Pane> Copy Profile |
|
Navigation Pane> Plan Management> Profiles and Policies> OS Provisioning> Center Pane> Delete Profile |
Table 19-23 shows the commands included in the ServerPools mode and their equivalent actions in the BUI.
Table 19-20 ServerPools Mode Commands and Their Equivalent Actions in the BUI
CLI Command | BUI Action |
---|---|
Navigation Pane> Assets> Server Pools |
|
Navigation Pane> Assets> Server Pools> Select a server pool |
|
Navigation Pane> Assets> Server Pools> Select a server pool> Select a server> Actions Pane> Remove from Server Pool |
Table 19-21 shows the commands included in the Update mode and their equivalent actions in the BUI.
Table 19-21 Update Mode Commands and Their Equivalent Actions in the BUI
CLI Command | BUI Action |
---|---|
Navigation Pane> Plan Management> Profiles and Policies> Update Policies |
|
Navigation Pane> Plan Management> Profiles and Policies> Update Profiles |
|
Navigation Pane> Libraries> Software Libraries> Linux, Solaris 8-10 Software Update Library> Content tab> Search Criteria Menu> Distribution list |
|
NA |
|
NA |
|
NA |
|
NA |
|
Navigation Pane> Assets> Select an asset> Jobs tab |
|
Jobs Pane> Status column |
|
Navigation Pane> Administration> Enterprise Controller> Actions Pane> Setup Connection Mode |
|
Navigation Pane> Administration> Enterprise Controller> Actions Pane> Setup Connection Mode |
|
Navigation Pane> Administration> Enterprise Controller> Actions Pane> Setup Connection Mode> Switch to Connected Mode or Switch to Disconnected Mode. |
|
Navigation Pane> Assets> All Assets> Select an asset> Actions Pane> New Update OS Job |
|
Navigation Pane> Assets> All Assets> Select an asset> Actions Pane> New Update OS Job |
|
NA |
|
NA |
|
Navigation Pane> Plan Management> Profiles and Policies> Update Profiles> Actions Pane> New Profile |
|
NA |
|
Navigation Pane> Plan Management> Profiles and Policies> Update Profiles> Select a profile> Delete Profile |
|
NA |
|
Navigation Pane> Libraries> Software Libraries> Linux, Solaris 8-10 Software Update Library> Actions Pane> Bulk Upload Packages |
|
Navigation Pane> Libraries> Software Libraries> Linux, Solaris 8-10 Software Update Library> Actions Pane> Upload Local Action |
|
Navigation Pane> Libraries> Software Libraries> Linux, Solaris 8-10 Software Update Library> Actions Pane> Add Local Category |
|
Navigation Pane> Libraries> Software Libraries> Linux, Solaris 8-10 Software Update Library> Actions Pane> Delete Local Component |
|
Navigation Pane> Libraries> Software Libraries> Linux, Solaris 8-10 Software Update Library> Actions Pane> Upload Local Configuration |
|
Navigation Pane> Libraries> Software Libraries> Linux, Solaris 8-10 Software Update Library> Actions Pane> Edit Local Component File |
|
NA |
Table 19-22 shows the commands included in the User mode and their equivalent actions in the BUI.
Table 19-22 User Mode Commands and Their Equivalent Actions in the BUI
CLI Command | BUI Action |
---|---|
Navigation Pane> Administration> Enterprise Controller> Local Users |
|
Navigation Pane> Administration> Enterprise Controller> Local Users> Role Permission Mapping tab |
|
Navigation Pane> Administration> Enterprise Controller> Local Users |
|
Navigation Pane> Administration> Enterprise Controller> Local Users > Actions Pane> Add User |
|
Navigation Pane> Administration> Enterprise Controller> Local Users> Manage User Roles icon |
|
Navigation Pane> Administration> Enterprise Controller> Local Users> Replicate User Roles icon |
|
Navigation Pane> Administration> Enterprise Controller> Local Users> Manage User Roles icon |
|
Navigation Pane> Administration> Enterprise Controller> Directory Serves> Add Directory Server |
|
Navigation Pane> Administration> Enterprise Controller> Directory Serves> |
|
Navigation Pane> Administration> Enterprise Controller> Directory Serves> Select a Directory Server from the list> User tab |
|
Navigation Pane> Administration> Enterprise Controller> Directory Serves> Select a Directory Server from the list> Actions Pane> Sync all remote users and roles |
|
NA |
|
Navigation Pane> Administration> Enterprise Controller> Directory Serves> Select a Directory Server from the list> Delete Directory Server |
|
Navigation Pane> Administration> Enterprise Controller> Directory Serves> Select a Directory Server from the list> User tab> Select a user> Delete User |
Table 19-23 shows the commands included in the Virtualization mode and their equivalent actions in the BUI.