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.92, “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 exit help list Perhaps this is the command? Let's drill down further. remove set show showallcustomcmds showcustomcmds showobjtypes showversion OVM>list ?
AccessGroup Assembly BondPort FileServer FileSystem Job Network PhysicalDisk Port Repository SanServer Server This looks like the command to use to list ServerPool Oracle VM Servers StorageInitiator Tag VirtualCdrom VirtualDisk VlanGroup VlanInterface VlanSegment Vm VmDiskMapping Vnic VolumeGroup OVM>list Server
No more options can be entered so the results are automatically displayed id:00:e0:81:4d:40:c6:00:e0:81:4d:40:c7:ff:ff:ff:ff name:MyServer1 id:00:e0:81:4d:5e:82:00:e0:81:4d:5e:83:ff:ff:ff:ff name:MyServer2 id:00:e0:81:4d:40:f5:00:e0:81:4d:40:be:00:e0:81:4d 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 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 Assembly BondPort FileServer FileSystem Job Network PhysicalDisk Port Repository SanServer Server This looks like the command to use to show information ServerPool about Oracle VM Servers StorageInitiator Tag VirtualCdrom VirtualDisk VlanGroup VlanInterface VlanSegment Vm VmDiskMapping Vnic VolumeGroup YumConfig OVM>show Server ?
id=<object identifier> OR name=<object name>
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
Name = MyServer1
Id = 00:e0:81:4d:40:c6:00:e0:81:4d:40:c7:ff:ff:ff:ff
Status = Running
Mgmt MAC Address = 00:e0:81:4d:40:c6
Processors = 4
Ethernet Ports = 2
iSCSI Ports = 1
Maintenance Mode = Off
TakeOwnership = Yes
Role 1 = Utility Server
Role 2 = Virtual Machine Server
IP Address = 10.172.76.73
Processor Speed (GHz) = 1.995107
Memory (GiB) = 24.0
Dom0 Memory (GiB) = 0.96
FiberChannel Ports = 0
Network Failover Groups = 1
CPU Compatibility Group = Default_AMD_Family:15_Model:65
Server Architecture Type = x86-64b
Hypervisor Type = OVM/Xen
Manufacturer = empty
Serial Number = empty
Product Name = empty
Processor Family = AuthenticAMD
Processor Model = Dual-Core AMD Opteron(tm) Processor 2212
L1 Cache Size = 0
L2 Cache Size = 1024
L3 Cache Size = 0
BIOS Version = 'V1.02.B10 '
BIOS Release Date = 11/30/2007
Sockets Filled = 2
Manager UUID = 0004fb00000100008e2c477634f634c9
Ethernet Port 1 = 0004fb0000200000182e64895a3318ba [eth0 on MyServer1]
Ethernet Port 2 = 0004fb0000200000939f6e9ea1ae5562 [eth1 on MyServer1]
Bond Port 1 = 0004fb00002000002c9078c717247e87 [bond0 on MyServer1]
Physical Disk 1 = 0004fb0000180000707410381f2bfca5 [FreeBSD (2)]
Physical Disk 2 = 0004fb0000180000a0286fc8bc74ab94 [FreeBSD (10)]
Physical Disk 3 = 0004fb00001800008feee8ef5d311c1c [FreeBSD (5)]
Physical Disk 4 = 0004fb0000180000f33d1cd098bc0561 [FreeBSD (9)]
Physical Disk 5 = 0004fb0000180000df407c862d9924bb [FreeBSD (6)]
Physical Disk 6 = 0004fb000018000064cddacad73641a6 [FreeBSD (8)]
Physical Disk 7 = 0004fb0000180000d9b142fa8a4eb3cb [FreeBSD (1)]
Physical Disk 8 = 0004fb0000180000f195b73d4c15f64f [FreeBSD (7)]
Physical Disk 9 = 0004fb000018000043b42ad2924b9b48 [FreeBSD (3)]
Physical Disk 10 = 0004fb0000180000b9b3201691841100 [SATA_WDC_WD5001ABYS-_WD-WCAS86575890]
Storage Initiator 1 = iqn.1988-12.com.oracle:eae1e2b65d3
Storage Initiator 2 = storage.LocalStorageInitiator in 00:e0:81:4d:40:c6:00:e0:81:4d:40:c7
:ff:ff:ff:ff
Version = 3.2.1-422
Vm 1 = 0004fb0000060000a0050840c71be743 [MyOL5VM]
Server Pool = 0004fb0000020000e2c7f63c784ba711 [MyServerPool]
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 1.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.
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=MyTag
Name = MyTag Id = 0004fb0000260000b351e52e3abbe192 description = HR's VMs from http://example.com/vms/ <Delete?>