Enter ? or help to display
help on a token. You can also enter ? after a
token to display the possible options based on context. For
example, if you want to display information about an Oracle VM Server, you
can work your way through the command options to find the commands
to perform this action.
To keep the output to a minimum in the examples in this book, we have set the output mode to sparse using the following command:
OVM> set OutputMode=Sparse
Your output may vary depending on which setting you use for this command; see Section A.147, “set” for more information.
To find the command to list Oracle VM Servers, start with the
? option and work your way through the
commands:
OVM>?add create delete edit embeddedcreate embeddeddelete embeddededit exit help list Perhaps this is the command? Let's drill down further. remove set show showallcustomcmds showcustomcmds showobjtypes showversion OVM>list ?AccessGroup AntiAffinityGroup Assembly ... Port Repository RepositoryExport Server This looks like the command to use to list Oracle VM Servers ServerController ServerPool ServerPoolNetworkPolicy ... VmDiskMapping Vnic VolumeGroup OVM>list ServerNo more options can be entered so the results are automatically displayed id:00:e0:81:4d:5f:2f:00:e0:81:4d:29:ee:00:e0:81:4d name:MyServer1 id:00:e0:81:4d:5e:16:00:e0:81:4d:5e:17:ff:ff:ff:ff name:MyServer2 id:00:e0:81:4d:40:16:00:e0:81:4d:40:17:ff:ff:ff:ff name:MyServer3 OVM>
Now you have a list of the Oracle VM Servers, you can display information
about them with another command. To find the command to display
information about an Oracle VM Server, drill down again through the
commands to find the most appropriate command using the
? option:
OVM>?add create delete edit embeddedcreate embeddeddelete embeddededit exit help list remove set show This looks like the command to use to show information showallcustomcmds commands available for all objects showcustomcmds commands specific to an object (requires object as argument) showobjtypes showversion OVM>show ?AccessGroup AntiAffinityGroup Assembly ... Port Repository RepositoryExport Server This looks like the command to use to show information about an Oracle VM Server ServerController ServerPool ServerPoolNetworkPolicy ... VmDiskMapping Vnic VolumeGroup OVM>show Server ?id=<object identifier> OR name=<object name> OVM>
If you have forgotten the name of the Oracle VM Server, use the up arrow
to scroll through the history until you see the list
Server command and press
Enter. Then use the
show Server name= option to display information
about an Oracle VM Server.
OVM> show Server name=MyServer1
Status = Running
Role 1 = Utility
Role 2 = Vm
Ip Address = 10.172.76.79
...
Name = MyServer1
Locked = false
OVM>The CLI is a self-learning tool; built in help and tab auto-completion guide you when working with the commands. The following commands assist you to use the CLI.
Table 2.1 Helpful CLI commands
Command/Feature | Description |
|---|---|
? |
Context sensitive help, for example, |
help | Displays the syntax to use for the top level commands. |
showallcustomcmds | Displays a list of the all custom commands for all object types. |
showcustomcmds [object type] | Displays a list of the custom commands for a specific object type provided as a parameter. |
showobjtypes | Displays a list of the object types. |
tab completion | Press the Tab key to auto-complete the command. |
history | Use the up or down arrow keys to step through the history of commands entered in the current session. Up to 50 commands are listed. |
You can configure the end of line characters used by your SSH
client, for example, if your SSH client adds a line feed (double
spacing) to the end of a line, you can set the endline characters
to CR. Set the end of line characters using the
set
command.
You can configure the output mode to define how the CLI returns results, for example in plain text or in XML. Set the output mode using the set command.
The values you enter for parameters are case sensitive, unless
explicitly stated in this Guide. For example, entering
name=MyServer is not the same as entering
name=myserver. The CLI treats these parameter
strings as case sensitive, and are considered different.
Special characters are considered any of these:
", ', ?,
\, /,
<, >. You can escape
special characters within a set of quotes to make sure they are
treated as a literal string using a / (forward
slash) before the character. For example:
OVM>create Tag name=MyTag description="HR/'s VMs from http:////example.com//vms// /<Delete/?/>"id:0004fb0000260000b351e52e3abbe192 name:MyTag OVM>show Tag name=MyTagName = MyTag Id = 0004fb0000260000b351e52e3abbe192 description = HR's VMs from http://example.com/vms/ <Delete?>
Parameters are unique for each time you run a command. Providing more than one object of the same attribute type as a parameter always results in the last attribute value taking precedence. Therefore, a command similar to the following succeeds, but the values of these repeated parameters override each other:
OVM>discoverServer ipAddress=server1 ipAddress=server2 takeOwnership=No\ takeOwnership=Yes password=** password=******Command: discoverServer ipAddress=server1 ipAddress=server2 takeOwnership=No takeOwnership=Yes password=** password=****** Status: Success Time: 2013-12-23 00:34:38,398 PST JobId: 1387787665552 OVM>list serverCommand: list server Status: Success Time: 2013-12-23 00:34:43,602 PST Data: id:44:45:4c:4c:59:00:10:35:80:34:c7:c0:4f:57:48:31 name:server2
In this example, only one Oracle VM Server is discovered. The second
parameter in each instance of the command overrides the first.
Therefore, server2 is discovered, and ownership
is set to Yes, and the password in this
instance is the second one specified.
If a command is issued, but no changes to an object are performed,
a success message is displayed. For example, if you change the
name of an object to the same name, Status:
Success is returned and displayed.
Operations that trigger job creation within Oracle VM Manager, such as create or modify operations, always return the status of the job. The status is referred to as the Return Status. If a job is successful, the status returned is set to Success. If a job fails, the status returned is set to Failure.
Job status is obtained by consistently polling Oracle VM Manager with the generated Job ID to query the job status. For operations that may take too long, the CLI may timeout the polling period. In this case, the status returned is set to Running to indicate that the job is still running. In this case, you may need to query the job status manually before continuing with any other operations.
Since all commands that result in some form of change within Oracle VM Manager trigger the creation of a job, these commands also return the job ID in the response output. The value for this appears in the JobId field. In the case where a command has returned a Running status, you can use this field to obtain the job ID for the task that you are performing, and then use the show job command to monitor its status.
The default job timeout value is 7200 seconds (120 minutes). The
value can be set in the common configuration file, used by both
the Oracle VM Manager CLI and the Oracle VM Manager Web Interface, at
/u01/app/oracle/ovm-manager-3/ovm_cli/config/common_config.xml.
The attribute to set is called
defaultCommandTimeout.