Oracle® VM

Manager Command Line Interface User's Guide for Release 3.3

Oracle Legal Notices
Oracle Documentation License


March 2016

Table of Contents

1 Audience
2 Related Documents
3 Command Syntax
4 Conventions
1 What's New in the Oracle VM Manager Command Line Interface (CLI)?
1.1 CLI Changes in Release 3.3
1.1.1 CLI Modifications
1.1.2 CLI New Features
1.1.3 CLI Object Attribute Changes
2 Introduction to the Oracle VM Manager Command Line Interface (CLI)
2.1 Starting and Stopping the CLI
2.2 Connecting to the CLI
2.3 SSH Host Keys
2.4 Key-Based Authentication
2.5 Using SSH to Run Background Processes
2.6 Using the Oracle VM CLI and Getting Help
2.6.1 Return Status Values
2.7 Passing in a CLI Command at the Command Line
2.8 Sample Scripts
2.9 Integrating the CLI into Your Applications
2.10 Configuring the Oracle VM CLI
2.10.1 SSH Port
2.10.2 Timeout
2.10.3 Case Sensitivity
2.10.4 Public Key Authentication Expiry
2.10.5 Lock Exceptions
2.11 CLI Logs
I Using the CLI
3 Discovering Oracle VM Servers
3.1 Discovering an Oracle VM Server
4 Discovering Storage
4.1 Discovering a file server
4.2 Discovering a storage array
5 Creating a Network
5.1 Creating a virtual machine network
6 Creating a Server Pool
6.1 Creating a server pool
6.2 Adding Oracle VM Servers to a server pool
7 Creating a Storage Repository
7.1 Creating a storage repository on a file server
7.2 To create a storage repository on a storage array
7.3 Importing resources to a storage repository
7.3.1 Importing an assembly
7.3.2 Importing a virtual machine template
7.3.3 Importing an ISO file
8 Creating a Virtual Machine
8.1 Creating a virtual machine from a template
8.2 Creating a virtual machine from an assembly
8.3 Creating a virtual machine from an ISO
8.4 To start a virtual machine:
II CLI Command Reference
A CLI Command Reference
A.1 abort Job
A.2 ackEvent
A.3 addAccessHost
A.4 addAdminServer
A.5 addPolicyServer
A.6 addRefreshServer
A.7 add BondPort
A.8 add FileSystem
A.9 add PhysicalDisk
A.10 add Port
A.11 add Server
A.12 add ServerPool
A.13 add StorageInitiator
A.14 add Tag
A.15 add VlanInterface
A.16 add Vm
A.17 add Vnic
A.18 changeServerAgentPassword
A.19 checkUpToDate
A.20 clearVmAllRcvdMessages
A.21 clearVmAllSentMessages
A.22 clearVmRcvdMessage
A.23 clearVmSentMessage
A.24 clone Vm
A.25 cloneCdToRepo
A.26 clonePdToPd
A.27 clonePdToRepo
A.28 clonePdToStorageArray
A.29 cloneVdToPd
A.30 cloneVdToRepo
A.31 createVmFromAssembly
A.32 create AccessGroup
A.33 create AntiAffinityGroup
A.34 create BondPort
A.35 create CpuCompatibilityGroup
A.36 create FileServer
A.37 create FileSystem
A.38 create Network
A.39 create PhysicalDisk
A.40 create Repository
A.41 create RepositoryExport
A.42 create ServerController
A.43 create ServerPool
A.44 create ServerPoolNetworkPolicy
A.45 create ServerUpdateGroup
A.46 create ServerUpdateRepository
A.47 create StorageArray
A.48 create Tag
A.49 create VirtualDisk
A.50 create VlanInterface
A.51 create Vm
A.52 create VmCloneCustomizer
A.53 create VmCloneNetworkMapping
A.54 create VmCloneStorageMapping
A.55 create VmDiskMapping
A.56 create Vnic
A.57 delete
A.58 discoverServer
A.59 edit AccessGroup
A.60 edit AntiAffinityGroup
A.61 edit Assembly
A.62 edit AssemblyVirtualDisk
A.63 edit AssemblyVm
A.64 edit BondPort
A.65 edit ControlDomain
A.66 edit Cpu
A.67 edit CpuCompatibilityGroup
A.68 edit FileServer
A.69 edit FileServerPlugin
A.70 edit FileSystem
A.71 edit Manager
A.72 edit Network
A.73 edit PeriodicTask
A.74 edit PhysicalDisk
A.75 edit Port
A.76 edit Repository
A.77 edit RepositoryExport
A.78 edit Server
A.79 edit ServerController
A.80 edit ServerPool
A.81 edit ServerPoolNetworkPolicy
A.82 edit ServerUpdateGroup
A.83 edit ServerUpdateRepository
A.84 edit StorageArray
A.85 edit StorageArrayPlugin
A.86 edit Tag
A.87 edit VirtualCdrom
A.88 edit VirtualDisk
A.89 edit VlanInterface
A.90 edit Vm
A.91 edit VmCloneCustomizer
A.92 edit VmCloneNetworkMapping
A.93 edit VmCloneStorageMapping
A.94 edit VmDiskMapping
A.95 edit Vnic
A.96 edit VolumeGroup
A.97 embeddedCreate
A.98 embeddedDelete
A.99 embeddedEdit
A.100 exit
A.101 getDebugTranscript
A.102 getDescriptor
A.103 getEvents
A.104 getEventsForObject
A.105 getJobs
A.106 getQueuedJobInfo
A.107 getStatsConfig
A.108 getTriageEvent
A.109 getVmCfgFileContent
A.110 getVmOsTypes
A.111 getVmReceivedMessages
A.112 getVmSentMessages
A.113 getVnicMacAddrRange
A.114 help
A.115 importAssembly
A.116 importTemplate
A.117 importVirtualCdrom
A.118 importVirtualDisk
A.119 importVirtualMachine
A.120 kill
A.121 list
A.122 migrate Vm
A.123 moveVmToRepository
A.124 refresh
A.125 refreshAll
A.126 refreshStorageLayer
A.127 releaseOwnership
A.128 removeAccessHost
A.129 removeAdminServer
A.130 removePolicyServer
A.131 removeRefreshServer
A.132 remove BondPort
A.133 remove FileSystem
A.134 remove PhysicalDisk
A.135 remove Port
A.136 remove Server
A.137 remove ServerPool
A.138 remove StorageInitiator
A.139 remove Tag
A.140 remove VlanInterface
A.141 remove Vm
A.142 remove Vnic
A.143 resize
A.144 restart
A.145 resume
A.146 sendVmMessage
A.147 set
A.148 setMaintenanceMode
A.149 setStatsConfig
A.150 setVnicMacAddrRange
A.151 show
A.152 showallcustomcmds
A.153 showcustomcmds
A.154 showobjtypes
A.155 showversion
A.156 start
A.157 stop
A.158 suspend
A.159 takeOwnership
A.160 upgrade
A.161 validate