Oracle® VM

Command Line Interface User's Guide for Release 3.2

Oracle Legal Notices

E35336-06

March 2014

Abstract

Document generated on: 2014-03-05 (revision: 3776)


Table of Contents

Preface
1 Audience
2 Documentation Accessibility
3 Related Documents
4 Command Syntax
5 Conventions
1 Introduction to the Oracle VM Command Line Interface (CLI)
1.1 Connecting to the Oracle VM CLI
1.2 SSH Host Keys
1.3 Key-Based Authentication
1.4 Using the Oracle VM CLI and Getting Help
1.5 Passing in a CLI Command at the Command Line
1.6 Using Expect Scripts
1.6.1 Expect Script Prerequisites
1.6.2 Writing Expect Scripts
1.7 Sample Scripts
1.8 Integrating the CLI into Your Applications
1.9 Configuring the Oracle VM CLI
1.9.1 SSH Port
1.9.2 Timeout
1.9.3 Case Sensitivity
1.9.4 Public Key Authentication Expiry
1.9.5 Lock Exceptions
1.10 CLI Logs
I Using the CLI
2 Discovering Oracle VM Servers
2.1 Discovering an Oracle VM Server
3 Discovering Storage
3.1 Discovering a File Server
3.2 Discovering a SAN Server
4 Networking
4.1 To create a virtual machine network
4.2 To create VNICs
5 Managing Server Pools
5.1 To create a server pool
5.2 To add Oracle VM Servers to a server pool
6 Managing Storage Repositories
6.1 To create a storage repository on a file server
6.2 To create a storage repository on a SAN server
6.3 To add resources to a storage repository
6.3.1 Adding an assembly
6.3.2 Adding a virtual machine template
6.3.3 Adding an ISO file
7 Managing Virtual Machines
7.1 To create a virtual machine from a template:
7.2 To create a virtual machine from an assembly:
7.3 To create a virtual machine from an ISO:
7.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 addAvailableVnic Vm
A.5 addNfsRefreshServer
A.6 add BondPort
A.7 add FileSystem
A.8 add PhysicalDisk
A.9 add Port
A.10 add Server
A.11 add ServerPool
A.12 add StorageInitiator
A.13 add Tag
A.14 add Vm
A.15 add Vnic
A.16 clone VirtualDisk
A.17 clone Vm
A.18 create AccessGroup
A.19 create BondPort
A.20 create FileServer
A.21 create Network
A.22 create NfsAccessGroup
A.23 create PhysicalDisk
A.24 create Repository
A.25 create SanServer
A.26 create ServerPool
A.27 create Tag
A.28 create VirtualDisk
A.29 create VlanGroup
A.30 create VlanSegment
A.31 create Vm
A.32 create VmDiskMapping
A.33 create Vnic
A.34 createTemplatesFromAssembly
A.35 delete
A.36 discoverServer
A.37 edit AccessGroup
A.38 edit Assembly
A.39 edit BondPort
A.40 edit FileServer
A.41 edit FileSystem
A.42 edit Network
A.43 edit NfsAccessGroup
A.44 edit PhysicalDisk
A.45 edit Port
A.46 edit Repository
A.47 edit SanServer
A.48 edit Server
A.49 edit ServerPool
A.50 edit Tag
A.51 edit VirtualCdrom
A.52 edit VirtualDisk
A.53 edit VlanGroup
A.54 edit VlanInterface
A.55 edit Vm
A.56 edit VmDiskMapping
A.57 edit Vnic
A.58 edit VolumeGroup
A.59 edit YumConfig
A.60 exit
A.61 getEvents
A.62 getIncompatibleReasons
A.63 getJobsUsingRange
A.64 getLatestNumberOfJobs
A.65 help
A.66 importAssembly
A.67 importTemplate
A.68 importVirtualCdrom
A.69 importVirtualDisk
A.70 importVirtualMachine
A.71 initiateYumUpgrade
A.72 kill
A.73 list
A.74 migrate Vm
A.75 refresh
A.76 refreshStorageLayer
A.77 remove BondPort
A.78 remove FileSystem
A.79 remove PhysicalDisk
A.80 remove Port
A.81 remove Server
A.82 remove ServerPool
A.83 remove StorageInitiator
A.84 remove Tag
A.85 remove Vm
A.86 remove Vnic
A.87 removeAccessHost
A.88 removeNfsRefreshServer
A.89 restart
A.90 resume Vm
A.91 sendVmMessage
A.92 set
A.93 setNtp
A.94 show
A.95 showallcustomcmds
A.96 showcustomcmds
A.97 showNtp
A.98 showobjtypes
A.99 showversion
A.100 start
A.101 stop
A.102 suspend Vm
A.103 syncNtp
A.104 vnicCreate
Index

List of Examples

1.1 list_server.exp Expect script
A.1 Aborting a job
A.2 Acknowledging an event
A.3 Adding a SAN server access host
A.4 Adding the next available VNIC to a virtual machine
A.5 Adding a refresh server to file server
A.6 Adding a bonded port to a network
A.7 Adding a file system to a file server access group
A.8 Adding a physical disk to a SAN storage access group
A.9 Adding an Ethernet port to a network
A.10 Adding an Oracle VM Server to a server pool
A.11 Adding an admin server to file server
A.12 Adding an admin server to a SAN server
A.13 Adding an Oracle VM Server to a file server access group
A.14 Adding (presenting) an Oracle VM Server to a storage repository
A.15 Presenting a storage repository to a server pool
A.16 Adding a storage initiator
A.17 Adding a tag to a server pool
A.18 Adding a virtual machine to an Oracle VM Server
A.19 Adding a VNIC to a virtual machine
A.20 Cloning a virtual disk
A.21 Cloning a virtual machine to a virtual machine
A.22 Cloning a virtual machine to a template
A.23 Cloning a template to a virtual machine
A.24 Cloning a template to a template
A.25 Creating an access group on a SAN server
A.26 Creating a bond port
A.27 Discovering a file server
A.28 Creating a network
A.29 Creating an access group on a file server
A.30 Creating a physical disk on a volume group
A.31 Creating a storage repository on a file server
A.32 Creating a storage repository on a physical disk
A.33 Discovering a SAN server
A.34 Creating a clustered server pool
A.35 Creating an unclustered server pool
A.36 Creating a tag
A.37 Creating a virtual disk in a storage repository
A.38 Creating a VLAN group
A.39 Creating a VLAN segment
A.40 Creating a virtual machine
A.41 Mapping a virtual disk to a virtual machine
A.42 Mapping an ISO file to a virtual machine
A.43 Mapping an empty CDROM drive
A.44 Creating a VNIC
A.45 Creating a virtual machine template from an assembly
A.46 Deleting an Oracle VM Server
A.47 Deleting a virtual machine or virtual machine template
A.48 Deleting a network
A.49 Deleting a virtual machine disk mapping
A.50 Discovering an Oracle VM Server
A.51 Editing an access group on a SAN server
A.52 Editing an assembly
A.53 Editing a bond port
A.54 Editing a file server
A.55 Editing a file system
A.56 Editing a network
A.57 Editing an access group on a file server
A.58 Editing a physical disk
A.59 Editing a port
A.60 Editing a storage repository
A.61 Editing a SAN server
A.62 Editing an Oracle VM Server
A.63 Taking ownership of an Oracle VM Server
A.64 Placing an Oracle VM Server into maintenance mode
A.65 Editing a server pool
A.66 Changing the master Oracle VM Server
A.67 Changing the virtual machine start policy
A.68 Editing a tag
A.69 Editing a ISO file/CDROM
A.70 Editing a virtual disk
A.71 Resizing a virtual disk
A.72 Editing a VLAN group
A.73 Editing a VLAN interface
A.74 Edit the disk boot order a virtual machine
A.75 Editing a virtual disk mapping object
A.76 Editing a VNIC
A.77 Editing a volume group
A.78 Editing a Yum repository
A.79 Exiting the CLI
A.80 Listing Oracle VM Server events
A.81 Listing virtual machine placement incompatibility reasons
A.82 Listing jobs in a date range
A.83 Listing recent jobs
A.84 Using the Help Command
A.85 Importing an assembly to a storage repository
A.86 Importing a virtual machine template to a storage repository
A.87 Importing a virtual CDROM/ISO file to a storage repository
A.88 Importing a virtual disk file to a storage repository
A.89 Importing a virtual machine to a storage repository
A.90 Upgrading an Oracle VM Server
A.91 Killing an Oracle VM Server
A.92 Killing a virtual machine
A.93 Listing Oracle VM Servers
A.94 Listing virtual machines and virtual machine templates
A.95 Listing networks
A.96 Listing virtual machine and virtual machine templates disk mapping
A.97 Migrating a virtual machine to an Oracle VM Server
A.98 Migrating a virtual machine to another server pool
A.99 Migrating a virtual machine to the Unassigned Virtual Machines folder
A.100 Refreshing a file server
A.101 Refreshing a SAN server
A.102 Refreshing a physical disk
A.103 Refresh a file system
A.104 Refresh a storage repository
A.105 Refreshing Oracle VM Server storage
A.106 Removing a bonded port from a network
A.107 Removing a file system from a file server access group
A.108 Removing physical disk from a SAN storage access group
A.109 Removing a port from a network
A.110 Removing an Oracle VM Server from a server pool
A.111 Removing an admin server from file server
A.112 Removing an admin server from a SAN server
A.113 Removing an Oracle VM Server from a file server access group
A.114 Removing (unpresenting) an Oracle VM Server from a storage repository
A.115 Unpresenting a storage repository from a server pool
A.116 Removing a storage initiator
A.117 Removing a tag from a server pool
A.118 Removing a virtual machine from an Oracle VM Server
A.119 Removing a VNIC from a virtual machine
A.120 Removing a SAN server access host
A.121 Removing a refresh server from a file server
A.122 Restarting an Oracle VM Server
A.123 Restarting a virtual machine
A.124 Resuming a virtual machine
A.125 Sending a message to a virtual machine
A.126 Setting end of line characters
A.127 Setting output mode to XML
A.128 Setting the list of NTP servers
A.129 Show details about an Oracle VM Server
A.130 Show details about a virtual machine
A.131 Show details about a network
A.132 Show Yum repository configuration
A.133 Show details about a VNIC
A.134 Showing all custom commands
A.135 Show Custom Commands for an Oracle VM Server
A.136 Show Custom Commands for a virtual machine
A.137 Show Custom Commands for a Repository
A.138 Showing the list of NTP servers
A.139 Showing all object types
A.140 Showing the CLI/Oracle VM Manager version number
A.141 Starting an Oracle VM Server
A.142 Starting a virtual machine
A.143 Stopping an Oracle VM Server
A.144 Stopping a virtual machine
A.145 Suspending a virtual machine
A.146 Pushing the list of NTP servers to Oracle VM Servers
A.147 Generating multiple VNICs