
Introduction
The page is captured for reference purpose. Beginning with Oracle VM Manager 3.2.1, CLI is a fully supported feature of the product. Please review the product documentation for details.
Oracle VM Manager 3 CLI provides a command line interface for the Oracle VM Manager 3. You can use the CLI to perform the same functions as the Oracle VM Manager Web Interface, such as managing all your server pools, servers and guests. The CLI commands can be scripted and run in conjunction with the Web Interface, thus bringing more flexibility to help you deploy and manage an Oracle VM environment.The CLI automatically starts and stops with the rest of Oracle VM Manager components via the /etc/init.d/ovmm script. When Oracle VM Manager starts up, it reads config/CLIConfigParams.xml which contains the ssh port (by default set to 10,000), etc. Then to access the CLI, start an ssh client to connect to port 10000 of the Oracle VM Manager server.There is an expect script within OVMCLI/expectscripts which should give you a pretty complete inventory of all the supported commands at this point. To customize the script for your setup, go into testscript with an editor and provide a name of a server (servername), pool (poolname), and VM (vmname) at the beginning of the file. This should be a server, pool and VM that you have already configured.Aside from reviewing the expect script please note some of the cool features:1. Use the up and down arrows for a history of commands (currently the last 50).
2. Use tab to complete tokens.
3. Use ? to get help or the command "help"; also use ? after a token to get the rest of the possible options
based on context.
4. You can have multiple clients connected concurrently.
5. You set to configure output mode and endline characters, e.g. if your ssh client adds on a
line feed (double spacing) you can set endline characters to "CR".
6. To close down the ssh session either close the ssh client or use the exit command.Visit http://www.oracle.com/us/technologies/virtualization/oraclevm/index.html for more information about Oracle VM. Login
You can login to the CLI via puTTY or ssh directly. You will be prompted for password, e.g., ssh --l admin --p 10000 oraclevm-manager-host# ssh -l <management server username> -p 10000 <management server IP or DNS name> |
login as: admin admin @ovm -mgr-host's password: OVM> |
Learning the CLI
The CLI is intended to be a self-learning tool.
help, showallcustomcmds, showobjtypes, and the context sensitive ? (e.g. show ?, clone ?), along w/ tab completion, up/down arrow history help a user learn the capabilities:
- help
- showallcustomcmds
- showobjtypes
- context sensitive ? (e.g. show ?, clone ?)
- tab completion
- up/down arrow history help a user learn the capabilities
For example say you don't know the format of the show server command.
Type "show ?" to see what object types are supported:
OVM> show ? AccessGroup Assembly BondPort EthernetNetwork EthernetPort FileServer FileSystem ISO Job LocalNetwork PhysicalDisk Repository SanServer Server ServerPool StorageInitiator VirtualDisk VlanGroup VlanInterface VlanSegment Vm VmDiskMapping Vnic VolumeGroup YumConfig |
Use up arrow to bring back the command (save you from typing again) and then add "server":
OVM> show server ? id=<object identifier> OR name=<object name> |
Finally up arrow again and give the CLI the name of the server you are interested in, e.g., "name=ovs038" Be sure to use the tab to save typing, e.g. type "na <tab>" to get "name=".
OVM> show server name=ovs038 Command: show server name=ovs038 Status: Success Time: 2012 - 06 - 23 03 : 30 : 25.789 Data: Name = ovs038 Id = 44 : 45 :4c:4c: 35 : 00 : 10 :4d: 80 : 54 :b5:c0:4f: 51 : 47 : 31 Status = Running Mgmt MAC Address = 00 :1e:4f:3f: 08 : 15 Processors = 4 Ethernet Ports = 4 iSCSI Ports = 1 Maintenance Mode = Off IP Address = xx.xx.xx.xx Processor Speed (GHz) = 2.500063 Memory (GB) = 7 Dom0 Memory (MB) = 522 FiberChannel Ports = 0 Network Failover Groups = 1 CPU Compatibility Group = Default_Intel_Family:6_Model: 23 Server Architecture Type = x86-64b Hypervisor Type = OVM/Xen Manufacturer = Dell Inc. Serial Number = 55MTQG1 Product Name = PowerEdge R300 Processor Family = GenuineIntel Processor Model = Intel(R) Xeon(R) CPU X3323 @ 2 .50GHz L1 Cache Size = 0 L2 Cache Size = 3072
|