Appendix A CLI Command Reference

This appendix gives the full syntax of each CLI command, with usage examples.

A.1 abort Job

Aborts a job.

Syntax

abort Job instance

Where instance is:

{ id=value | name=value }

Description

This command aborts a running job.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyJob.

Examples

Example A.1 Aborting a job

OVM> abort job id=1342399962239

See Also

• Section A.110, “getDebugTranscript”

• Section A.115, “getJobs”

• Section A.138, “list”

• Section A.171, “show”

A.2 ackEvent

Acknowledges an event.

Syntax

ackEvent eventId=value

Description

This command acknowledges an event.

Options

The following table shows the available options for this command.

Option	Description
eventId=value	The ID of the event. To get the ID of an event, use the getEvents or getEventsForObject command.

Examples

Example A.2 Acknowledging an event

OVM> ackEvent eventId=1342155856562

See Also

• Section A.113, “getEvents”

• Section A.114, “getEventsForObject”

A.3 addAccessHost

Adds an access host to an ISCSI server.

Syntax

addAccessHost StorageArray instance accessHost=value [ accessPort=value ] [ accessUsername=value accessPassword=value ]

Where instance is:

{ id=value | name=value }

Description

This command adds an access host to an ISCSI storage array. Adding more than one access host provides multiple network paths to the storage. Create an access host for each path when using multipathing. At least one access host must be set. This is not applicable to fibre channel storage. To remove an access host, use the removeAccessHost command.

Options

The following table shows the available options for this command.

Option	Description
accessHost=value	The hostname or IP address for the access host.
accessPort=value	The port on which to connect to the access host. The default port of 3260 is used if no value is provided.
accessUsername=value	The username to use when using CHAP authentication.
accessPassword=value	The password for the accessUsername user.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyISCSIServer.

Examples

Example A.3 Adding a storage array access host

OVM> addAccessHost StorageArray name=MyISCSIServer accessHost=10.172.76.131

See Also

• Section A.146, “removeAccessHost”

• Section A.49, “create StorageArray”

• Section A.86, “edit StorageArray”

• Section A.138, “list”

• Section A.171, “show”

A.4 addAdminServer

Adds an administrative Oracle VM Server to a file server or storage array.

Syntax

addAdminServer { FileServer | StorageArray } instance server=value

Where instance is:

{ id=value | name=value }

Description

This command adds an administrative Oracle VM Server to a file server or storage array.

Options

The following table shows the available options for this command.

Option	Description
server=value	The name or ID of the administrative Oracle VM Server.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyFileServer.

Examples

Example A.4 Adding an admin server to a file server

OVM> addAdminServer FileServer name=MyNFSServer server=MyServer

Example A.5 Adding an admin server to a storage array

OVM> addAdminServer StorageArray name=MyISCSIServer server=MyServer

See Also

• Section A.147, “removeAdminServer”

• Section A.38, “create FileServer”

• Section A.49, “create StorageArray”

• Section A.70, “edit FileServer”

• Section A.86, “edit StorageArray”

• Section A.154, “remove Server”

• Section A.11, “add Server”

• Section A.6, “addRefreshServer”

• Section A.149, “removeRefreshServer”

• Section A.86, “edit StorageArray”

A.5 addPolicyServer

Adds a server pool policy to a server.

Syntax

addPolicyServer ServerPool instance server=value

Where instance is:

{ id=value | name=value }

Description

This command adds a server pool policy to a server.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServerPool.
server=value	The name or ID of an Oracle VM Server to which the policy is added.

Examples

Example A.6 Adding a policy to a server

OVM> addPolicyServer ServerPool name=MyServerPool server=MyServer

See Also

• Section A.148, “removePolicyServer”

• Section A.46, “create ServerPoolNetworkPolicy”

• Section A.83, “edit ServerPoolNetworkPolicy”

A.6 addRefreshServer

Adds a refresh server to a file server.

Syntax

addRefreshServer FileServer instance server=value

Where instance is:

{ id=value | name=value }

Description

This command adds a refresh server to a file server. The refresh server is an Oracle VM Server that is used to refresh the file systems on an NFS file server. You can add multiple refresh servers to a file server. A file server must have at least one refresh server assigned to it.

Options

The following table shows the available options for this command.

Option	Description
server=value	The name or ID of the Oracle VM Server to be used as a refresh server.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServer.

Examples

Example A.7 Adding a refresh server to file server

OVM> addRefreshServer FileServer name=MyNFSServer server=MyServer

See Also

• Section A.149, “removeRefreshServer”

• Section A.38, “create FileServer”

• Section A.70, “edit FileServer”

• Section A.154, “remove Server”

• Section A.11, “add Server”

• Section A.4, “addAdminServer”

• Section A.147, “removeAdminServer”

• Section A.142, “refresh”

A.7 add BondPort

Adds an bonded port to a network object.

Syntax

add BondPort instance to Network instance

Where instance is:

{ id=value | name=value }

Description

This command adds a bonded port to a network object.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyNetwork.

Examples

Example A.8 Adding a bonded port to a network

OVM> add BondPort id=0004fb000020000065822cb7bb9ec296 to Network name=MyVMNetwork

See Also

• Section A.36, “create BondPort”

• Section A.66, “edit BondPort”

• Section A.150, “remove BondPort”

• Section A.153, “remove Port”

• Section A.102, “embeddedCreate”

• Section A.103, “embeddedDelete”

• Section A.104, “embeddedEdit”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.8 add FileSystem

Adds a file system to an access group.

Syntax

add FileSystem instance to AccessGroup instance

Where instance is:

{ id=value | name=value }

Note that if the instance name contains forward slashes, these must be escaped using an additional forward slash. This is illustrated in the examples for this command.

Description

This command adds a file system to an access group.

A file system may only be associated with one access group. If you create a new access group for a file system that is already associated with an existing access group, the file system is disassociated from the original access group.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyAccessGroup .

Examples

Example A.9 Adding a file system to an access group

OVM> add FileSystem name="nfs on 10.172.76.125://mnt//vol2//repo03" to AccessGroup \
  name=MyAccessGroup

See Also

• Section A.39, “create FileSystem”

• Section A.72, “edit FileSystem”

• Section A.151, “remove FileSystem”

• Section A.34, “create AccessGroup”

• Section A.61, “edit AccessGroup”

• Section A.138, “list”

• Section A.171, “show”

• Section A.59, “delete”

A.9 add PhysicalDisk

Adds a physical disk to a SAN storage access group.

Syntax

add PhysicalDisk instance to AccessGroup instance

Where instance is:

{ id=value | name=value }

Description

This command adds a physical disk to a SAN storage access group. Local storage and generic storage plug-ins are not supported with this command.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyAccessGroup.

Examples

Example A.10 Adding a physical disk to a SAN storage access group

OVM> add PhysicalDisk id=0004fb00001800007ee6dbda7b4461cb to AccessGroup \
  name='Default access group @ MyISCSIServer'

See Also

• Section A.41, “create PhysicalDisk”

• Section A.76, “edit PhysicalDisk”

• Section A.152, “remove PhysicalDisk”

• Section A.59, “delete”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.10 add Port

Adds an Ethernet port to a network object.

Syntax

add Port instance to { BondPort | Network } instance

Where instance is:

{ id=value | name=value }

Description

This command adds an Ethernet port to a network object.

To configure the IP address for a port, use the embeddedCreate command.

Options

The following table shows the available options for this command.

Option	Description
{ BondPort | Network }	The network object to which to add the Ethernet port.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyNetwork.

Examples

Example A.11 Adding an Ethernet port to a network

OVM> add Port id=0004fb0000200000d2e7d2d352a6654e to Network name=MyVMNetwork

See Also

• Section A.77, “edit Port”

• Section A.153, “remove Port”

• Section A.40, “create Network”

• Section A.74, “edit Network”

• Section A.36, “create BondPort”

• Section A.102, “embeddedCreate”

• Section A.103, “embeddedDelete”

• Section A.104, “embeddedEdit”

• Section A.138, “list”

• Section A.171, “show”

A.11 add Server

Adds an Oracle VM Server to an object.

Syntax

add Server instance to { AccessGroup | CpuCompatibilityGroup | Repository | ServerPool } instance

Where instance is:

{ id=value | name=value }

Description

This command adds an Oracle VM Server to either a CPU compatibility group, server pool, storage repository or access group.

When you add an Oracle VM Server to a storage repository, you are making that Oracle VM Server available to perform admin duties for that storage object.

To present a storage repository to all Oracle VM Servers in a server pool, use the add ServerPool command.

To add admin servers to a file server or storage array, use the addAdminServer command.

Options

The following table shows the available options for this command.

Option	Description
{ AccessGroup | CpuCompatibilityGroup | Repository | ServerPool }	The object on which to assign the Oracle VM Server as an admin server.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServer.

Examples

Example A.12 Adding an Oracle VM Server to a CPU compatibility group

OVM> add Server name=MyServer to CpuCompatibilityGroup name=MyCPUGroup

Example A.13 Adding an Oracle VM Server to a server pool

OVM> add Server name=MyServer to ServerPool name=MyServerPool

Note

It is not possible to add an Oracle VM Server to a server pool if the Oracle VM Server is running software prior to the 3.4 release and the server pool has not been configured with a virtual IP address. See What is a Master Server and a Virtual IP Address? in the Oracle VM Concepts Guide for more information.

Example A.14 Adding an Oracle VM Server to an access group

OVM> add Server name=MyServer to AccessGroup name=MyAccessGroup

Example A.15 Adding (presenting) an Oracle VM Server to a storage repository

OVM> add Server name=MyServer to Repository name=MyRepository

See Also

• Section A.12, “add ServerPool”

• Section A.60, “discoverServer”

• Section A.80, “edit Server”

• Section A.142, “refresh”

• Section A.177, “start”

• Section A.178, “stop”

• Section A.162, “restart”

• Section A.137, “kill”

• Section A.181, “upgrade”

• Section A.4, “addAdminServer”

• Section A.147, “removeAdminServer”

• Section A.6, “addRefreshServer”

• Section A.149, “removeRefreshServer”

• Section A.154, “remove Server”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.12 add ServerPool

Adds a server pool to a storage repository or to an access group.

Syntax

add ServerPool instance to { AccessGroup | Repository } instance

Where instance is:

{ id=value | name=value }

Description

This command presents a storage repository to all Oracle VM Servers in a server pool. To present a storage repository to an individual Oracle VM Server, use the add Server command.

This command also adds a server pool to an access group.

Important

The option to add or present an entire server pool is a convenience that automatically selects all of the servers that belong to the specified pool and then performs the action on those servers. There is no actual relationship between the server pool and the repository or access group stored within Oracle VM Manager. This means that if you add a server to a server pool after having presented a repository to the server pool, the repository is not automatically presented to the new server. Equally, removing a server from the server pool does not automatically update the configuration.

Options

The following table shows the available options for this command.

Option	Description
{ AccessGroup | Repository }	The object on which to add or present the server pool.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServerPool.

Examples

Example A.16 Presenting a storage repository to a server pool

OVM> add ServerPool name=MyServerPool to Repository name=MyRepository

Example A.17 Adding a server pool to an access group

OVM> add ServerPool name=MyServerPool to AccessGroup name=MyAccessGroup

See Also

• Section A.155, “remove ServerPool”

• Section A.11, “add Server”

• Section A.138, “list”

• Section A.171, “show”

A.13 add StorageInitiator

Adds a storage initiator to an access group for a SAN storage server.

Syntax

add StorageInitiator instance to AccessGroup instance

Where instance is:

{ id=value | name=value }

Description

This command adds a storage initiator to an access group for a SAN storage server.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyAccessGroup.

Examples

Example A.18 Adding a storage initiator

OVM> add StorageInitiator name=iqn.1988-12.com.oracle:d72d82d0817f to AccessGroup \
  name='Default access group @ MyISCSIServer' 

See Also

• Section A.156, “remove StorageInitiator”

• Section A.138, “list”

• Section A.171, “show”

A.14 add Tag

Adds a tag to an object.

Syntax

add Tag instance to { Server | ServerPool | Vm } instance

Where instance is:

{ id=value | name=value }

Description

This command adds a tag used to identify and group objects to an object.

Options

The following table shows the available options for this command.

Option	Description
{ Server | ServerPool | Vm }	The object on which to add the tag.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyTag.

Examples

Example A.19 Adding a tag to a server pool

OVM> add Tag name=MyTag to ServerPool name=MyServerPool

See Also

• Section A.50, “create Tag”

• Section A.88, “edit Tag”

• Section A.157, “remove Tag”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.15 add VlanInterface

Adds a VLAN interface to a network.

Syntax

add VlanInterface instance to Network instance

Where instance is:

{ id=value | name=value }

Description

This command adds a VLAN interface to a network. To create a VLAN interface, use the create VlanInterface command.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyNetwork.

Examples

Example A.20 Adding a VLAN interface to a network

OVM> add VlanInterface name=MyVLANInterface to Network name=MyNetwork

See Also

• Section A.52, “create VlanInterface”

• Section A.94, “edit VlanInterface”

• Section A.158, “remove VlanInterface”

• Section A.102, “embeddedCreate”

• Section A.103, “embeddedDelete”

• Section A.104, “embeddedEdit”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.16 add Vm

Adds a virtual machine to an Oracle VM Server, server pool, or anti affinity group.

Syntax

add Vm instance to { AntiAffinityGroup | Server | ServerPool } instance

Where instance is:

{ id=value | name=value }

Description

This command adds a virtual machine to an Oracle VM Server, server pool, or anti affinity group. The virtual machine cannot be running, and must be stopped before using this command.

Options

The following table shows the available options for this command.

Option	Description
{ AntiAffinityGroup | Server | ServerPool }	The object on which to add the virtual machine.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServerPool.

Examples

Example A.21 Adding a virtual machine to a server pool

OVM> add Vm name=MyVM to ServerPool name=MyServerPool

Example A.22 Adding a virtual machine to an Oracle VM Server

OVM> add Vm name=MyVM to Server name=MyServer

Example A.23 Adding a virtual machine to an anti affinity group

OVM> add Vm name=MyVM to AntiAffinityGroup name=MyAAGroup

See Also

• Section A.53, “create Vm”

• Section A.136, “importVirtualMachine”

• Section A.35, “create AntiAffinityGroup”

• Section A.159, “remove Vm”

• Section A.139, “migrate Vm”

• Section A.140, “migrateWithLocalStorage Vm”

• Section A.24, “clone Vm”

• Section A.177, “start”

• Section A.171, “show”

• Section A.138, “list”

A.17 add Vnic

Adds a VNIC to a network.

Syntax

add Vnic instance to Network instance

Where instance is:

{ id=value | name=value }

Description

This command adds a VNIC to a network.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyNetwork.

Examples

Example A.24 Adding a VNIC to a network

OVM> add Vnic name=00:21:f6:00:00:00 to Network name=MyNetwork

See Also

• Section A.58, “create Vnic”

• Section A.100, “edit Vnic”

• Section A.160, “remove Vnic”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.18 changeServerAgentPassword

Changes the Oracle VM Agent password on an Oracle VM Server.

Syntax

changeServerAgentPassword Server instance oldPassword=value newPassword=value confirmPassword=value

Where instance is:

{ id=value | name=value }

Description

This command changes the Oracle VM Agent password on an Oracle VM Server.

Options

The following table shows the available options for this command.

Option	Description
oldPassword=value	The existing password for the Oracle VM Agent on the Oracle VM Server. The password is displayed as asterisks.
newPassword=value	The new password for the Oracle VM Agent on the Oracle VM Server. The password is displayed as asterisks.
confirmPassword=value	The new password for the Oracle VM Agent on the Oracle VM Server. The password is displayed as asterisks.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServer.

Examples

Example A.25 Changing the Oracle VM Agent password on an Oracle VM Server

OVM> changeServerAgentPassword Server name=MyServer oldPassword=***** \
  newPassword=******* confirmPassword=*******

See Also

• Section A.138, “list”

• Section A.171, “show”

A.19 checkUpToDate

Checks whether the Oracle VM Server software is up-to-date according to the server update repository.

Syntax

checkUpToDate Server instance

Where instance is:

{ id=value | name=value }

Description

This command checks whether the Oracle VM Server software is up-to-date according to the server update repository. This command sets the Up To Date parameter of the Server object, and does not display any output other than a success or failure message. This command may be useful to check whether an Oracle VM Server is up-to-date in between any regular checking by the recurring job that checks for available updates. To see the value of the Server object's Up To Date parameter, use the show Server command. To update an Oracle VM Server, use the upgrade command.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServer.

Examples

Example A.26 Checking whether an Oracle VM Server is up-to-date

OVM> checkUpToDate Server name=MyServer    

See Also

• Section A.48, “create ServerUpdateRepository”

• Section A.85, “edit ServerUpdateRepository”

• Section A.47, “create ServerUpdateGroup”

• Section A.84, “edit ServerUpdateGroup”

• Section A.19, “checkUpToDate”

• Section A.181, “upgrade”

• Section A.171, “show”

A.20 clearVmAllRcvdMessages

Clears all the key/value pair messages received by a running virtual machine.

Syntax

clearVmAllRcvdMessages Vm instance

Where instance is:

{ id=value | name=value }

Description

This command clears all the key/value pair messages received by a running virtual machine.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVM.

Examples

Example A.27 Clearing all messages received by a virtual machine

OVM> clearVmAllRcvdMessages Vm name=MyVm

See Also

• Section A.164, “sendVmMessage”

• Section A.128, “getVmSentMessages”

• Section A.127, “getVmReceivedMessages”

• Section A.22, “clearVmRcvdMessage”

• Section A.23, “clearVmSentMessage”

• Section A.21, “clearVmAllSentMessages”

A.21 clearVmAllSentMessages

Clears all the key/value pair messages sent to a running virtual machine.

Syntax

clearVmAllSentMessages Vm instance

Where instance is:

{ id=value | name=value }

Description

This command clears all the key/value pair messages sent to a running virtual machine.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVM.

Examples

Example A.28 Clearing all messages sent to a virtual machine

OVM> clearVmAllSentMessages Vm name=MyVm

See Also

• Section A.164, “sendVmMessage”

• Section A.128, “getVmSentMessages”

• Section A.127, “getVmReceivedMessages”

• Section A.22, “clearVmRcvdMessage”

• Section A.23, “clearVmSentMessage”

• Section A.20, “clearVmAllRcvdMessages”

A.22 clearVmRcvdMessage

Clears a key/value pair message received by a running virtual machine.

Syntax

clearVmRcvdMessage Vm instance key=value

Where instance is:

{ id=value | name=value }

Description

This command clears a key/value pair message received by a running virtual machine.

Options

The following table shows the available options for this command.

Option	Description
key=value	The name or ID of the message key.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVM.

Examples

Example A.29 Clearing a message received by a virtual machine

OVM> clearVmRcvdMessage Vm name=MyVm key="com.oracle.linux.network.device.0"

See Also

• Section A.164, “sendVmMessage”

• Section A.128, “getVmSentMessages”

• Section A.127, “getVmReceivedMessages”

• Section A.23, “clearVmSentMessage”

• Section A.21, “clearVmAllSentMessages”

• Section A.20, “clearVmAllRcvdMessages”

A.23 clearVmSentMessage

Clears a key/value pair message sent to a running virtual machine.

Syntax

clearVmSentMessage Vm instance key=value

Where instance is:

{ id=value | name=value }

Description

This command clears a key/value pair message sent to a running virtual machine.

Options

The following table shows the available options for this command.

Option	Description
key=value	The name or ID of the message key.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVM.

Examples

Example A.30 Clearing a message sent to a virtual machine

OVM> clearVmSentMessage Vm name=MyVm key="com.oracle.linux.network.device.0"

See Also

• Section A.164, “sendVmMessage”

• Section A.128, “getVmSentMessages”

• Section A.127, “getVmReceivedMessages”

• Section A.22, “clearVmRcvdMessage”

• Section A.21, “clearVmAllSentMessages”

• Section A.20, “clearVmAllRcvdMessages”

A.24 clone Vm

Clones a virtual machine or template to a new virtual machine or template.

Syntax

clone Vm instance destType= { Vm | VmTemplate } [ destName=value ] serverPool=value [ cloneCustomizer=value ] [ targetRepository=value ]

Where instance is:

{ id=value | name=value }

Description

This command clones a virtual machine or template to a new virtual machine or template.

Options

The following table shows the available options for this command.

Option	Description
destType= { Vm | VmTemplate }	The object to create from the virtual machine, either a virtual machine or a template.
destName=value	The name of the cloned virtual machine or template.
serverPool=value	The name or ID of the server pool on which to deploy the cloned virtual machine. Note Although you must enter this when cloning a virtual machine to a template, the template is not deployed to a server pool, it is located in the storage repository.
cloneCustomizer=value	The name or ID of the cloneCustomizer that should be used when deploying the cloned virtual machine or template.
targetRepository=value	The name or ID of the repository that should be used when deploying the cloned virtual machine or template.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVM.

Examples

Example A.31 Cloning a virtual machine to a virtual machine

OVM> clone Vm name=MyVM destType=Vm destName=MyNewVM serverPool=MyServerPool

Example A.32 Cloning a virtual machine to a template

OVM> clone Vm name=MyVM destType=VmTemplate destName=MyVMTemplate serverPool=MyServerPool

Example A.33 Cloning a template to a virtual machine

OVM> clone Vm name=MyVMTemplate.tgz destType=Vm destName=MyNewVM serverPool=MyServerPool

Example A.34 Cloning a template to a template

OVM> clone Vm name=MyVMTemplate.tgz destType=VmTemplate destName=MyVMTemplate \
  serverPool=MyServerPool

Example A.35 Cloning a virtual machine to a virtual machine using a clone customizer

OVM> clone Vm name=MyVM destType=Vm destName=MyNewVM serverPool=MyServerPool \
    cloneCustomizer=MyCloneCustomizer targetRepository=MyRepository

See Also

• Section A.53, “create Vm”

• Section A.16, “add Vm”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.25 cloneCdToRepo

Clones a virtual CDROM to a storage repository.

Syntax

cloneCdToRepo VirtualCdrom instance target=value cloneType= { SPARSE_COPY | NON_SPARSE_COPY | THIN_CLONE }

Where instance is:

{ id=value | name=value }

Description

This command clones a virtual CDROM to a target repository.

Options

The following table shows the available options for this command.

Option	Description
target=value	The repository on which to locate the cloned physical disk.
cloneType= { SPARSE_COPY | NON_SPARSE_COPY | THIN_CLONE }	Whether to clone a sparse, non-sparse or thin-clone virtual cdrom. The THIN_CLONE parameter is only applicable when using an Oracle VM Storage Connect plug-in that supports thin provisioned cloning. The clone target must be an OCFS2-based storage repository, or a storage array.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyDisk1.

Examples

Example A.36 Cloning a virtual CDROM to a repository

OVM> cloneCdToRepo VirtualCdrom name=MyCD.iso target=MyRepository cloneType=SPARSE_COPY

See Also

• Section A.134, “importVirtualCdrom”

• Section A.92, “edit VirtualCdrom”

• Section A.26, “clonePdToPd”

• Section A.28, “clonePdToStorageArray”

• Section A.41, “create PhysicalDisk”

• Section A.76, “edit PhysicalDisk”

• Section A.59, “delete”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.26 clonePdToPd

Clones a physical disk to a physical disk.

Syntax

clonePdToPd PhysicalDisk instance target=value cloneType= { SPARSE_COPY | NON_SPARSE_COPY | THIN_CLONE }

Where instance is:

{ id=value | name=value }

Description

This command clones a physical disk to a target physical disk. You cannot clone a physical disk using this command if the disk contains a file system or storage repository.

Options

The following table shows the available options for this command.

Option	Description
target=value	The physical disk on which to locate the cloned physical disk.
cloneType= { SPARSE_COPY | NON_SPARSE_COPY | THIN_CLONE }	Whether to clone a sparse, non-sparse or thin-clone physical disk. The THIN_CLONE parameter is only applicable when using an Oracle VM Storage Connect plug-in that supports thin provisioned cloning. The clone target must be an OCFS2-based storage repository, or a storage array.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyDisk1.

Examples

Example A.37 Cloning a physical disk to a physical disk

OVM> clonePdToPd PhysicalDisk name=MyDisk1 target=MyRepository cloneType=SPARSE_COPY

See Also

• Section A.29, “cloneVdToPd”

• Section A.28, “clonePdToStorageArray”

• Section A.41, “create PhysicalDisk”

• Section A.76, “edit PhysicalDisk”

• Section A.59, “delete”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.27 clonePdToRepo

Clones a physical disk to a repository.

Syntax

clonePdToRepo PhysicalDisk instance target=value cloneType= { SPARSE_COPY | NON_SPARSE_COPY | THIN_CLONE }

Where instance is:

{ id=value | name=value }

Description

This command clones a physical disk to a target repository. The physical disk data is copied to a virtual disk image (.img file) file in the storage repository.

Options

The following table shows the available options for this command.

Option	Description
target=value	The repository on which to locate the cloned physical disk. The target repository must be on a physical disk.
cloneType= { SPARSE_COPY | NON_SPARSE_COPY | THIN_CLONE }	Whether to clone a sparse, non-sparse or thin-clone physical disk. The THIN_CLONE parameter is only applicable when using an Oracle VM Storage Connect plug-in that supports thin provisioned cloning. The clone target must be an OCFS2-based storage repository, or a storage array.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyDisk1.

Examples

Example A.38 Cloning a physical disk to a repository

OVM> clonePdToRepo PhysicalDisk name=MyDisk1 target=MyRepository cloneType=SPARSE_COPY

See Also

• Section A.26, “clonePdToPd”

• Section A.28, “clonePdToStorageArray”

• Section A.41, “create PhysicalDisk”

• Section A.76, “edit PhysicalDisk”

• Section A.59, “delete”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.28 clonePdToStorageArray

Clones a physical disk to a storage array.

Syntax

clonePdToStorageArray PhysicalDisk instance target=value cloneType= { SPARSE_COPY | NON_SPARSE_COPY | THIN_CLONE } userFriendlyName=value

Where instance is:

{ id=value | name=value }

Description

This command clones a physical disk to a target storage array.

This command is not supported with a generic ISCSI Oracle VM Storage Connect plug-in. The clone target must be on the same storage array as the source. You cannot clone a disk from one storage array to another.

Options

The following table shows the available options for this command.

Option	Description
target=value	The storage array on which to locate the cloned physical disk.
cloneType= { SPARSE_COPY | NON_SPARSE_COPY | THIN_CLONE }	Whether to clone a sparse, non-sparse or thin-clone physical disk.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyDisk1.
userFriendlyName=value	An optional parameter to specify a user-friendly name that can be used to identify the physical disk object.

Examples

Example A.39 Cloning a physical disk to a storage array

OVM> clonePdToStorageArray PhysicalDisk name=MyDisk1 target=MyRepository cloneType=SPARSE_COPY

See Also

• Section A.26, “clonePdToPd”

• Section A.28, “clonePdToStorageArray”

• Section A.41, “create PhysicalDisk”

• Section A.76, “edit PhysicalDisk”

• Section A.59, “delete”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.29 cloneVdToPd

Clones a virtual disk to a physical disk.

Syntax

cloneVdToPd VirtualDisk instance target=value cloneType= { SPARSE_COPY | NON_SPARSE_COPY | THIN_CLONE }

Where instance is:

{ id=value | name=value }

Description

This command clones a virtual disk to a target physical disk.

Options

The following table shows the available options for this command.

Option	Description
target=value	The physical disk on which to locate the cloned virtual disk.
cloneType= { SPARSE_COPY | NON_SPARSE_COPY | THIN_CLONE }	Whether to clone a sparse, non-sparse or thin-clone virtual disk.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVMDisk.

Examples

Example A.40 Cloning a virtual disk to a physical disk

OVM> cloneVdToPd VirtualDisk name=MyVMDisk target=MyDisk1 cloneType=SPARSE_COPY

See Also

• Section A.30, “cloneVdToRepo”

• Section A.135, “importVirtualDisk”

• Section A.51, “create VirtualDisk”

• Section A.93, “edit VirtualDisk”

• Section A.59, “delete”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.30 cloneVdToRepo

Clones a virtual disk to a repository.

Syntax

cloneVdToRepo VirtualDisk instance target=value cloneType= { SPARSE_COPY | NON_SPARSE_COPY | THIN_CLONE }

Where instance is:

{ id=value | name=value }

Description

This command clones a virtual disk to a target repository.

The virtual disk instance must be in a storage repository on a physical disk.

Options

The following table shows the available options for this command.

Option	Description
target=value	The repository on which to locate the cloned virtual disk. The target repository must be on a physical disk.
cloneType= { SPARSE_COPY | NON_SPARSE_COPY | THIN_CLONE }	Whether to clone a sparse, non-sparse or thin-clone virtual disk. The THIN_CLONE parameter is only applicable when using an Oracle VM Storage Connect plug-in that supports thin provisioned cloning. The clone target must be an OCFS2-based storage repository, or a storage array.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVMDisk.

Examples

Example A.41 Cloning a virtual disk to a repository

OVM> cloneVdToRepo VirtualDisk name=MyVirtualDisk target=MyRepository cloneType=SPARSE_COPY

See Also

• Section A.29, “cloneVdToPd”

• Section A.135, “importVirtualDisk”

• Section A.51, “create VirtualDisk”

• Section A.93, “edit VirtualDisk”

• Section A.59, “delete”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.31 createVmFromAssembly (Deprecated)

Creates a virtual machine template from an assembly file.

Important

This command has been deprecated. Instead, use the createVmFromVirtualAppliance command.

Syntax

createVmFromAssembly AssemblyVm instance

Where instance is:

{ id=value | name=value }

Description

This command creates a virtual machine template from an AssemblyVm object. An AssemblyVm object is created for each virtual machine in an assembly file when an assembly file is imported using the importAssembly (Deprecated) command. The virtual machine template files are created in the same storage repository as the original AssemblyVm object. To create a virtual machine from the template, use the clone Vm command.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyAssembly.ova.

Note

Any create command only creates a single instance of an object, and therefore only accepts a single object instance as an attribute. Providing more than one object of the same attribute type as a parameter always results in the last attribute value taking precedence.

Examples

Example A.42 Creating virtual machines from an assembly

OVM> createVmFromAssembly AssemblyVm name=myassembly.ova

See Also

• Section A.131, “importAssembly (Deprecated)”

• Section A.24, “clone Vm”

• Section A.63, “edit Assembly (Deprecated)”

• Section A.64, “edit AssemblyVirtualDisk (Deprecated)”

• Section A.65, “edit AssemblyVm (Deprecated)”

• Section A.111, “getDescriptor”

• Section A.59, “delete”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

A.32 createVmFromVirtualAppliance

Creates a virtual machine (template) from a virtual machine in an virtual appliance.

Syntax

createVmFromVirtualAppliance VirtualApplianceVm instance

Where instance is:

{ id=value | name=value }

Description

This command creates a virtual machine from a VirtualApplianceVm object. A VirtualApplianceVm object is created for each virtual machine in a virtual appliance file when a virtual appliance file is imported using the importVirtualAppliance command. The virtual machine files are created in the same storage repository as the original VirtualApplianceVm object. To see a list of VirtualApplianceVm objects, use the list VirtualApplianceVm command.

The virtual machine is created and listed in the VM Templates folder in the Repositories tab in Oracle VM Manager.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVirtualMachine.

Note

Any create command only creates a single instance of an object, and therefore only accepts a single object instance as an attribute. Providing more than one object of the same attribute type as a parameter always results in the last attribute value taking precedence.

Examples

Example A.43 Creating a virtual machine (template) from a virtual appliance

OVM> createVmFromVirtualAppliance VirtualApplianceVm name=MyVm

See Also

• Section A.33, “createVmFromVirtualApplianceVm”

• Section A.91, “edit VirtualApplianceVm”

• Section A.89, “edit VirtualAppliance”

• Section A.90, “edit VirtualApplianceVirtualDisk”

• Section A.133, “importVirtualAppliance”

• Section A.106, “exportVirtualAppliance”

• Section A.111, “getDescriptor”

• Section A.59, “delete”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

A.33 createVmFromVirtualApplianceVm

Creates a virtual machine from a virtual machine in a virtual appliance.

Syntax

createVmFromVirtualApplianceVm VirtualApplianceVm instance

Where instance is:

{ id=value | name=value }

Description

This command creates a virtual machine from a VirtualApplianceVm object. A VirtualApplianceVm object is created for each virtual machine in a virtual appliance file when a virtual appliance file is imported using the importVirtualAppliance command. The virtual machine files are created in the same storage repository as the original VirtualApplianceVm object. To see a list of VirtualApplianceVm objects, use the list VirtualApplianceVm command.

The virtual machine is created and deployed to the Unassigned Virtual Machines folder in in the Servers and VMs tab in Oracle VM Manager.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVirtualAppliance.ova.

Note

Any create command only creates a single instance of an object, and therefore only accepts a single object instance as an attribute. Providing more than one object of the same attribute type as a parameter always results in the last attribute value taking precedence.

Examples

Example A.44 Creating a virtual machine from a virtual appliance

OVM> createVmFromVirtualApplianceVm VirtualApplianceVm name=MyVm

See Also

• Section A.32, “createVmFromVirtualAppliance”

• Section A.91, “edit VirtualApplianceVm”

• Section A.89, “edit VirtualAppliance”

• Section A.90, “edit VirtualApplianceVirtualDisk”

• Section A.133, “importVirtualAppliance”

• Section A.106, “exportVirtualAppliance”

• Section A.111, “getDescriptor”

• Section A.59, “delete”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

A.34 create AccessGroup

Creates an access group.

Syntax

create AccessGroup name=value [ description=value ] on { FileServer | StorageArray } instance

Where instance is:

{ id=value | name=value }

Description

This command creates an access group for either a file server or storage array. Generic storage array plug-ins are not supported with this command.

Options

The following table shows the available options for this command.

Option	Description
name=value	A name for the access group.
description=value	Optional description for the access group. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyFileServer.

Note

Any create command only creates a single instance of an object, and therefore only accepts a single object instance as an attribute. Providing more than one object of the same attribute type as a parameter always results in the last attribute value taking precedence.

Examples

Example A.45 Creating an access group on a storage array

OVM> create AccessGroup name=MyAccessGroup on StorageArray name=MyISCSIServer

Example A.46 Creating an access group on a file system

OVM> create AccessGroup name=MyAccessGroup on FileServer name=MyNFSServer

See Also

• Section A.61, “edit AccessGroup”

• Section A.9, “add PhysicalDisk”

• Section A.152, “remove PhysicalDisk”

• Section A.39, “create FileSystem”

• Section A.72, “edit FileSystem”

• Section A.8, “add FileSystem”

• Section A.151, “remove FileSystem”

• Section A.11, “add Server”

• Section A.154, “remove Server”

• Section A.138, “list”

• Section A.171, “show”

• Section A.59, “delete”

• Section A.113, “getEvents”

A.35 create AntiAffinityGroup

Creates an anti affinity group in a server pool.

Syntax

create AntiAffinityGroup name=value [ description=value ] on ServerPool instance

Where instance is:

{ id=value | name=value }

Description

This command creates an anti affinity group in a server pool. To add a virtual machine to an anti affinity group, use the add Vm command. To remove a virtual machine from an anti affinity group, use the remove Vm command.

Options

The following table shows the available options for this command.

Option	Description
name=value	A name to identify the anti affinity group.
description=value	Optional description for the anti affinity group. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServerPool.

Note

Any create command only creates a single instance of an object, and therefore only accepts a single object instance as an attribute. Providing more than one object of the same attribute type as a parameter always results in the last attribute value taking precedence.

Examples

Example A.47 Creating an anti affinity group

OVM> create AntiAffinityGroup name=MyAAGroup on ServerPool name=MyServerPool

See Also

• Section A.62, “edit AntiAffinityGroup”

• Section A.16, “add Vm”

• Section A.159, “remove Vm”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.36 create BondPort

Creates a bond port on an Oracle VM Server.

Syntax

create BondPort ethernetPorts=value mode= { ACTIVE_PASSIVE | LINK_AGGREGATION | LOAD_BALANCED } mtu=value [ interfaceName=value ] name=value [ description=value ] on Server instance

Where instance is:

{ id=value | name=value }

Description

This command creates a bond port on an Oracle VM Server .

To configure the IP address for a bond port, use the embeddedCreate command.

Options

The following table shows the available options for this command.

Option	Description
ethernetPorts=value	The name or ID of at least two Ethernet ports in a comma separated list. The name or ID must match the name or ID as it is stored for each port within Oracle VM Manager.
mode= { ACTIVE_PASSIVE | LINK_AGGREGATION | LOAD_BALANCED }	The network bonding mode.
mtu=value	The MTU value. May be an integer between 1500 and 64000.
interfaceName=value	An optional name for the bond in the format bondN, for example bond1, or bond2. If you do not enter a name, the default of bondN is used, where N is the next available bond number. This cannot be changed after the bond is created.
name=value	A name to identify the bond.
description=value	Optional description for the bond. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServer.

Note

Any create command only creates a single instance of an object, and therefore only accepts a single object instance as an attribute. Providing more than one object of the same attribute type as a parameter always results in the last attribute value taking precedence.

Examples

Example A.48 Creating a bond port

OVM> create BondPort mode=LINK_AGGREGATION mtu=1500 name=MyPortBond \
  ethernetPorts="0004fb0000200000d9394992f8ba06d4,0004fb0000200000c2a5f26641825be5" \
  on Server name=MyServer

OVM> create bondPort name=MyPortBond2 mode=ACTIVE_PASSIVE mtu=1500 \ 
  ethernetPorts="eth3 on MyServer,eth5 on MyServer" on server name=MyServer

See Also

• Section A.7, “add BondPort”

• Section A.66, “edit BondPort”

• Section A.150, “remove BondPort”

• Section A.153, “remove Port”

• Section A.102, “embeddedCreate”

• Section A.103, “embeddedDelete”

• Section A.104, “embeddedEdit”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.37 create CpuCompatibilityGroup

Creates a CPU compatibility group to which Oracle VM Servers sharing a common processor can be assigned.

Syntax

create CpuCompatibilityGroup name=value [ description=value ]

Description

This command creates a CPU compatibility group to which Oracle VM Servers sharing a common processor can be assigned.

Options

The following table shows the available options for this command.

Option	Description
name=value	A name for the CPU compatibility group.
description=value	Optional description for the CPU compatibility group. value is a maximum of 4,000 characters. To set an empty description, use description="".

Note

Any create command only creates a single instance of an object, and therefore only accepts a single object instance as an attribute. Providing more than one object of the same attribute type as a parameter always results in the last attribute value taking precedence.

Examples

Example A.49 Creating a CPU compatibility group

OVM> create CpuCompatibilityGroup name=MyCPUGroup

See Also

• Section A.69, “edit CpuCompatibilityGroup”

• Section A.11, “add Server”

• Section A.154, “remove Server”

• Section A.138, “list”

• Section A.171, “show”

• Section A.59, “delete”

• Section A.113, “getEvents”

A.38 create FileServer

Discovers a file server.

Syntax

create FileServer plugin=value accessHost=value adminServers=value [ refreshServers=value ] [ uniformedExports= { Yes | No } ] [ name=value ] [ description=value ]

Description

This command discovers a file server.

After discovering a file server, you should:

• Optionally, if you are using non-uniformed file system exports, you can create an access group using the create AccessGroup command. Add file systems to the access group using the add FileSystem command. Add Oracle VM Servers to the access group using the add Server command.

• Refresh the file server and file systems using the refresh command.

Options

The following table shows the available options for this command.

Option	Description
plugin=value	The name or ID of storage plug-in to use for the file server to be discovered. To obtain a list of existing plug-ins enter: OVM> list FileServerPlugin If a vendor specific plug-in is configured it is made available as an option here.
accessHost=value	The host name or IP address for the file server to be discovered.
adminServers=value	The names or IDs of the Oracle VM Servers to perform administration on the file server, in a comma separated list.
refreshServers=value	Optionally, the host names or IP addresses of the Oracle VM Servers to perform refresh jobs on the file server, in a comma separated list.
uniformedExports= { Yes | No }	Whether the file server has uniformed file system exports. The default is Yes.
name=value	A name to identify the file server.
description=value	Optional description for the file server. value is a maximum of 4,000 characters. To set an empty description, use description="".

Note

Any create command only creates a single instance of an object, and therefore only accepts a single object instance as an attribute. Providing more than one object of the same attribute type as a parameter always results in the last attribute value taking precedence.

Examples

Example A.50 Discovering a file server

OVM> create FileServer plugin="Oracle Generic Network File System" \
  accessHost=10.172.76.125 adminServers="MyServer1.virtlab.info,MyServer2.virtlab.info" \
  name=MyNFSServer

See Also

• Section A.70, “edit FileServer”

• Section A.11, “add Server”

• Section A.154, “remove Server”

• Section A.4, “addAdminServer”

• Section A.147, “removeAdminServer”

• Section A.6, “addRefreshServer”

• Section A.149, “removeRefreshServer”

• Section A.142, “refresh”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.39 create FileSystem

Creates an OCFS2 file system on a physical disk on a file server.

Syntax

create FileSystem physicalDisk=value name=value [ description=value ] on FileServer instance

Where instance is:

{ id=value | name=value }

Description

This command creates an OCFS2 file system on a physical disk on a file server. When creating a file system on an NFS file server, you can use the file server itself to create the file system. When creating an OCFS2 file system on a LUN, you should use a local file server on an Oracle VM Server that has access to the LUN to create the file system. See Section 7.2, “To create a storage repository on a storage array” for an example.

Options

The following table shows the available options for this command.

Option	Description
physicalDisk=value	The name or ID of the physical disk on which to create the OCFS2 file system.
name=value	A name for the file system.
description=value	Optional description for the file system. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyFileSystem.

Note

Any create command only creates a single instance of an object, and therefore only accepts a single object instance as an attribute. Providing more than one object of the same attribute type as a parameter always results in the last attribute value taking precedence.

Examples

Example A.51 Creating an OCFS2 file system on physical disk on a file server

OVM> create FileSystem physicalDisk=0004fb0000180000e3c93dc542901b7a name=MyRepoFileSystem \
 on FileServer id=0004fb00000900007e1ce0c83b3f136f

Example A.52 Creating an OCFS2 file system on a LUN

OVM> create FileSystem name=MyRepoFileSystem physicalDisk="MyLUN1" on FileServer \
  name="Local FS MyServer1"

See Also

• Section A.72, “edit FileSystem”

• Section A.8, “add FileSystem”

• Section A.151, “remove FileSystem”

• Section A.34, “create AccessGroup”

• Section A.61, “edit AccessGroup”

• Section A.11, “add Server”

• Section A.154, “remove Server”

• Section A.138, “list”

• Section A.171, “show”

• Section A.59, “delete”

• Section A.113, “getEvents”

A.40 create Network

Creates an Ethernet-based network.

Syntax

create Network [ roles= { MANAGEMENT | LIVE_MIGRATE | CLUSTER_HEARTBEAT | VIRTUAL_MACHINE | STORAGE } ] name=value [ description=value ] [ on Server instance ]

Where instance is:

{ id=value | name=value }

Description

This command creates an Ethernet-based network. To create a local network on an Oracle VM Server, use the on Server instance option. You can only create a local network for virtual machine networks (using the roles=VIRTUAL_MACHINE option), as shown in Example A.54, “Creating a local network on an Oracle VM Server”. You cannot use a local network for traffic such as storage, or cluster heartbeat. If you attempt to create a local network and do not specify the role, its value is automatically set to VIRTUAL_MACHINE.

Options

The following table shows the available options for this command.

Option	Description
roles= { MANAGEMENT | LIVE_MIGRATE | CLUSTER_HEARTBEAT | VIRTUAL_MACHINE | STORAGE }	The network roles. Enter options separated by commas (,), for example: roles='VIRTUAL_MACHINE,STORAGE' To set an empty roles option, use roles="". Note that this attribute is automatically assigned the value VIRTUAL_MACHINE if this option is not specified, since a local network may only support this role. An exception is returned if you attempt to specify multiple roles for this network type.
name=value	A name to identify the network.
description=value	Optional description for the network. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServer.

Note

Any create command only creates a single instance of an object, and therefore only accepts a single object instance as an attribute. Providing more than one object of the same attribute type as a parameter always results in the last attribute value taking precedence.

Examples

Example A.53 Creating a network

OVM> create Network name=MyVMNetwork roles=VIRTUAL_MACHINE 

Example A.54 Creating a local network on an Oracle VM Server

OVM> create Network name=MyLocalNetwork roles=VIRTUAL_MACHINE on Server name=MyServer

See Also

• Section A.10, “add Port”

• Section A.77, “edit Port”

• Section A.153, “remove Port”

• Section A.74, “edit Network”

• Section A.36, “create BondPort”

• Section A.138, “list”

• Section A.171, “show”

A.41 create PhysicalDisk

Creates a physical disk on a volume group.

Syntax

create PhysicalDisk size=value [ extraInfo=value ] shareable= { Yes | No } thinProvision= { Yes | No } userFriendlyName=value name=value [ description=value ] on VolumeGroup instance

Where instance is:

{ id=value | name=value }

Description

This command creates a physical disk on a volume group. Local storage and generic storage plug-ins are not supported with this command.

Options

The following table shows the available options for this command.

Option	Description
size=value	The size of the physical disk in GiB. The value can be from 1 to 2048.
extraInfo=value	The value of the extra information field. Oracle VM Manager does not use the extra information field. However, the value that you set might be passed to a storage array plug-in. Refer to the help content for the storage array plug-in for more information about the extra information field.
shareable= { Yes | No }	Whether the physical disk is shareable. Shareable disks have read/write privileges in multiple virtual machines and should be used with caution.
thinProvision= { Yes | No }	Whether to create a thin or non-thin physical disk.
userFriendlyName=value	A user friendly name to identify the disk.
name=value	A name to identify the physical disk.
description=value	Optional description for the physical disk. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVolumeGroup.

Note

Any create command only creates a single instance of an object, and therefore only accepts a single object instance as an attribute. Providing more than one object of the same attribute type as a parameter always results in the last attribute value taking precedence.

Examples

Example A.55 Creating a physical disk on a volume group

OVM> create PhysicalDisk size=10 name=MyPhysicalDisk shareable=No \
  thinProvision=No userFriendlyName="My Disk" on VolumeGroup \
  id='Storage_Volume_Group @ 0004fb0000090000325a36dad3b3b7d8'

See Also

• Section A.9, “add PhysicalDisk”

• Section A.76, “edit PhysicalDisk”

• Section A.152, “remove PhysicalDisk”

• Section A.161, “resize”

• Section A.59, “delete”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.42 create Repository

Creates a storage repository.

Syntax

create Repository [ sharePath=value ] name=value [ description=value ] on FileSystem instance

Where instance is:

{ id=value | name=value }

Note that if the instance name contains forward slashes and you need to quote the name, you must escape forward slashes by using additional forward slashes. This is illustrated in the example.

Description

This command creates a storage repository on a file system. To create a repository on a LUN, you should first create an OCFS2 file system on it using the create FileSystem command.

After you create a repository, you should refresh it.

Options

The following table shows the available options for this command.

Option	Description
sharePath=value	A path to a subdirectory on the selected file system.
name=value	A name to identify the storage repository.
description=value	Optional description for the storage repository. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyFileSystem.

Note

Any create command only creates a single instance of an object, and therefore only accepts a single object instance as an attribute. Providing more than one object of the same attribute type as a parameter always results in the last attribute value taking precedence.

Examples

Example A.56 Creating a storage repository on a file server

OVM> create Repository name=MyRepository on FileSystem \
  name="nfs on 10.172.76.125://mnt//vol2//repo01"

Example A.57 Creating a storage repository on a SAN server

OVM> create Repository name=MyRepository on FileSystem name=MyRepoFileSystem

See Also

• Section A.11, “add Server”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

A.43 create RepositoryExport

Creates a repository export.

Syntax

create RepositoryExport clientHostName=value name=value repository=value [ description=value ] options=value on Serverinstance

Where instance is:

{ id=value | name=value }

Description

This command creates an export on an Oracle VM Server to enable access for a third party back up tool to back up the contents of an OCFS2-based storage repository .

Options

The following table shows the available options for this command.

Option	Description
clientHostName=value	The hostname or IP address of the computer for which to grant access to the storage repository contents. This is likely to be the machine on which the third party back up and restore software is running.
name=value	A name to identify the export on the file server.
repository=value	An OCFS2-based storage repository presented to the Oracle VM Server. This is the repository to configure for back up.
description=value	Optional description for the export on the file server. value is a maximum of 4,000 characters. To set an empty description, use description="".
options=value	The parameters to include in the NFS mount configuration, for example: rw, async, no_root_squash, wdelay. When no options are specified, the default NFS options on the Oracle VM Server are used.
Serverinstance	An Oracle VM Server on which the storage repository is presented.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=Server.

Examples

Example A.58 Creating a repository export on an Oracle VM Server

OVM> create RepositoryExport clientHostName=10.172.76.146 name="My NFS Export" \
  repository=MyISCSIRepository options="rw, async, no_root_squash" \
  on Server name=MyServer1

See Also

• Section A.79, “edit RepositoryExport”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.44 create ServerController

Creates a server controller object to configure IPMI on an Oracle VM Server.

Syntax

create ServerController ipAddress=value userName=value [ password=value ] name=value [ description=value ] on Serverinstance

Where instance is:

{ id=value | name=value }

Description

This command creates a server controller object to configure IPMI on an Oracle VM Server.

Options

The following table shows the available options for this command.

Option	Description
virtualIP=value	The IP address of the IPMI.
userName=value	The user name for the IPMI.
password=value	An optional password for the IPMI.
name=value	A name to identify the server control object.
description=value	Optional description for the server control object. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServerController.

Examples

Example A.59 Configuring IPMI for an Oracle VM Server

OVM> create ServerController ipAddress=192.168.10.3 userName=admin password=password \
  name=MyServerController description="IPMI controller for MyServer1" on Server name=MyServer1

See Also

• Section A.81, “edit ServerController”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.45 create ServerPool

Creates a server pool.

Syntax

create ServerPool clusterEnable= { Yes | No } [ clusterTimeout= value ] [ fileSystem=value ] [ physicalDisk=value ] [ keymapName= { en-us | ar | da | de | de-ch | en-gb | es | et | fi | fo | fr | fr-be | fr-ca | fr-ch | hr | hu | is | it | ja | lt | lv | mk | nl | nl-be | No | pl | pt | pt-br | ru | sl | sv | th | tr } ] [ migrateUsingSsl= { Yes | No } ] [ startPolicy= { BEST_SERVER | BALANCE_SERVER | CURRENT_SERVER } ] [ policyMode= { OFF | DRS | DPM } ] [ policyCpuEnable= { Yes | No } ] [ policyPeriod=value ] [ policyCpuThreshold=value ] name=value [ description=value ] [ virtualIP=value ]

Description

This command creates a server pool.

Options

The following table shows the available options for this command.

Option	Description
clusterEnable= { Yes | No }	Whether to enable a clustered server pool. If this parameter is not included, the default is No, so the server pool is not clustered. If this parameter is set to Yes, you must also include either the fileSystem or physicalDisk option to provide a location for the server pool file system.
clusterTimeout= value	Set the timeout value for the cluster in seconds. value is an integer between 30 and 300. SPARC-based server pools do not recognise the cluster timeout parameter. Setting this value for a server pool consisting of SPARC servers has no effect and the parameter is ignored by the Oracle VM Agent for SPARC.
fileSystem=value	The file system to use for the server pool file system. Note that if you specify the name as the value for the file system, and the name is specified in quotes, any forward slashes in the name must be escaped using additional forward slashes. This is illustrated in the examples for this command.
physicalDisk=value	The physical disk to use for the server pool file system. Note You cannot create a server pool file system on a local physical disk as the server pool file system needs to be accessible by all Oracle VM Servers in the server pool.
keymapName= { en-us | ar | da | de | de-ch | en-gb | es | et | fi | fo | fr | fr-be | fr-ca | fr-ch | hr | hu | is | it | ja | lt | lv | mk | nl | nl-be | No | pl | pt | pt-br | ru | sl | sv | th | tr }	The key mapping to be used when connecting to a virtual machine's console.
migrateUsingSsl= { Yes | No }	Whether to enable secure migration of virtual machines using SSL.
startPolicy= { BEST_SERVER | BALANCE_SERVER | CURRENT_SERVER }	The policy by which virtual machines are located when created in the server pool. If none is provided, the CURRENT_SERVER option is used by default.
policyMode= { OFF | DRS | DPM }	Set the policy to use for the server pool.
policyCpuEnable= { Yes | No }	Set whether to enable the policy set in the policyMode option for the server pool.
policyPeriod=value	The time period for the policy job to run. This sets the policy job to run every n minutes, for example, 10 sets the policy job to run every 10 minutes. value can be an integer between 2 and 60.
policyCpuThreshold=value	The maximum amount of CPU percentage usage allowed before the policy must be enacted. value can be an integer between 25 and 99.
[ virtualIP=value ]	An optional virtual IP address for the server pool. This is a deprecated parameter. Only specify a virtual IP address for a server pool if you intend to add Oracle VM Servers running a version of the software from prior to a 3.4 release.
name=value	A name to identify the server pool.
description=value	Optional description for the server pool. value is a maximum of 4,000 characters. To set an empty description, use description="".

Note

Any create command only creates a single instance of an object, and therefore only accepts a single object instance as an attribute. Providing more than one object of the same attribute type as a parameter always results in the last attribute value taking precedence.

Examples

Example A.60 Creating a clustered server pool

OVM> create ServerPool clusterEnable=Yes \
  filesystem="nfs on 10.172.76.125://mnt//vol1//poolfs01" name=MyServerPool \
  description='Clustered server pool'

Example A.61 Creating an unclustered server pool

OVM> create ServerPool clusterEnable=No name=MyServerPool \
  description='Unclustered server pool'

See Also

• Section A.82, “edit ServerPool”

• Section A.46, “create ServerPoolNetworkPolicy”

• Section A.83, “edit ServerPoolNetworkPolicy”

• Section A.11, “add Server”

• Section A.154, “remove Server”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.46 create ServerPoolNetworkPolicy

Creates a server pool network policy.

Syntax

create ServerPoolNetworkPolicy [ policyEnable= { Yes | No } ] [ policyThreshold=value ] network=value name=value [ description=value ] on ServerPool instance

Where instance is:

{ id=value | name=value }

Description

This command creates a server pool network policy. A server pool network policy is the object that controls DPM/DRS behavior of the virtual machines associated with the server pool based on network bandwidth usage.

Options

The following table shows the available options for this command.

Option	Description
policyEnable= { Yes | No }	Set whether to enable the policy set in the policyMode option of the create ServerPool or edit ServerPool command.
policyThreshold=value	The percentage (%) of network bandwidth the policy uses to move virtual machines. value can be an integer between 0 and 100.
network=value	The name or ID of the network associated with the policy, which is used to administer the policy for the server pool.
name=value	A name to identify the server pool network policy.
description=value	Optional description for the server pool network policy. value is a maximum of 4,000 characters. To set an empty description, use description="".

Note

Any create command only creates a single instance of an object, and therefore only accepts a single object instance as an attribute. Providing more than one object of the same attribute type as a parameter always results in the last attribute value taking precedence.

Examples

Example A.62 Creating a server pool network policy

OVM> create ServerPoolNetworkPolicy network=MyNetwork policyEnable=Yes name=MyNetworkPolicy \
  on ServerPool name=MyServerPool

See Also

• Section A.83, “edit ServerPoolNetworkPolicy”

• Section A.5, “addPolicyServer”

• Section A.148, “removePolicyServer”

• Section A.45, “create ServerPool”

• Section A.82, “edit ServerPool”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.47 create ServerUpdateGroup

Creates an Oracle VM Server update group in a server pool.

Syntax

create ServerUpdateGroup name=value [ description=value ] on ServerPool instance

Where instance is:

{ id=value | name=value }

Description

This command creates an Oracle VM Server update group in a server pool. This allows you to override the default update group for a server pool. The default update groups:

• For x86-based server pools, have the ID of GlobalX86ServerUpdateConfiguration.

• For SPARC-based server pools, have the ID of GlobalSparcServerUpdateConfiguration.

When you have created a server update group for a server pool, you should then assign the update repository using the create ServerUpdateRepository command. To update an Oracle VM Server, use the upgrade command.

Options

The following table shows the available options for this command.

Option	Description
name=value	A name to identify the server update group.
description=value	Optional description for the server update group. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServerPool.

Examples

Example A.63 Creating an update group for a server pool

OVM> create ServerUpdateGroup name=MyServerUpdateGroup on ServerPool name=MyServerPool

See Also

• Section A.84, “edit ServerUpdateGroup”

• Section A.48, “create ServerUpdateRepository”

• Section A.85, “edit ServerUpdateRepository”

• Section A.19, “checkUpToDate”

• Section A.181, “upgrade”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.48 create ServerUpdateRepository

Creates an Oracle VM Server update repository.

Syntax

create ServerUpdateRepository repositoryName=value url=value enabled= { Yes | No } pkgSignatureType= { NONE | GPG | CA } [ pkgSignatureKey=value ] name=value [ description=value ] on ServerUpdateGroup instance

Where instance is:

{ id=value | name=value }

Description

This command sets the location for the YUM (for x86) or IPS (for SPARC) repository that contains the files to update Oracle VM Servers. This command creates an Oracle VM Server update repository and assigns it to a server update group. The default server update groups:

• For x86-based Oracle VM Servers, have the ID of GlobalX86ServerUpdateConfiguration.

• For SPARC-based Oracle VM Servers, have the ID of GlobalSparcServerUpdateConfiguration.

To override either of these default repositories and create a repository that is restricted to a particular server pool, you should first create a server update group for the server pool using the create ServerUpdateGroup command, then create an update repository and assign it to the new server update group. To update an Oracle VM Server, use the upgrade command.

Note that when a new server update repository is created, the repository is added to each of the servers that belong to the server update group. If there is a problem adding the repository to a server in the server update group, an error event is generated for that server within Oracle VM Manager. Oracle VM Manager does not attempt to validate the repository before it is added to each server. If the repository is invalid or, in the case of a SPARC repository, the repository name does not match a valid publisher at the URL specified, an error event is generated for the servers affected.

Options

The following table shows the available options for this command.

Option	Description
repositoryName=value	A name for the server update repository. This may only contain alphanumeric characters and underscores. No spaces are permitted. For SPARC repositories, this must match a valid publisher for the repository, hosted at the provided URL.
url=value	The URL to access the repository. If you enclose the URL in quotes, you must escape each forward slash (/) with another, for example: url="http:////10.172.77.200//ovs"
enabled= { Yes | No }	Whether to enable the repository.
pkgSignatureType= { NONE | GPG | CA }	The signature type to verify the validity of the repository, either GPG key (or GnuPG key), CA (Certificate Authority). Use NONE if there is no verification required.
pkgSignatureKey=value	The verification signature for the repository, for example, the location of the GPG key using any of the HTTP, FTP, FILE or HTTPS protocols. If you enclose the value for the option in quotes, you must escape each forward slash (/) with another, for example: pkgSignatureKey="http:////10.172.77.200//ovs//RPM-GPG-KEY"
name=value	A name to identify the server update repository.
description=value	Optional description for the server update repository. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServerPool.

Examples

Example A.64 Creating an Oracle VM Server update repository

OVM> create ServerUpdateRepository repositoryName=MyUpdateRepository url=http://10.172.77.200/ovs \
   enabled=Yes pkgSignatureType=GPG pkgSignatureKey=http://10.172.77.200/ovs/RPM-GPG-KEY \
   name=Myx86Repository on ServerUpdateGroup id=GlobalX86ServerUpdateConfiguration

See Also

• Section A.85, “edit ServerUpdateRepository”

• Section A.47, “create ServerUpdateGroup”

• Section A.84, “edit ServerUpdateGroup”

• Section A.19, “checkUpToDate”

• Section A.181, “upgrade”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.49 create StorageArray

Discovers a storage array.

Syntax

create StorageArray plugin=value storageType= { FIBRECHANNEL | ISCSI | LOCAL | UNKNOWN } [ storageName=value ] [ accessHost=value ] [ accessPort=value ] [ accessUsername=value accessPassword=value ] [ useChap= { Yes | No } ] [ adminHost=value adminUserName=value adminPassword=value ] [ pluginPrivateData=value ] name=value [ description=value ] [ lipScan= { Yes | No } ]

Description

This command discovers a storage array and adds it to Oracle VM Manager. If you are adding a non-generic storage array also enter the additional plug-in options to enable Oracle VM Manager to access the storage array's configuration management functions using the adminHost option. To add more access hosts to enable multipathing on ISCSI servers, use the addAccessHost command.

After discovering a storage array, you should add storage initiators to it, add admin servers to it, validate it, then refresh it.

Options

The following table shows the available options for this command.

Option	Description
plugin=value	The name or ID of the Oracle VM Storage Connect plug-in to use for the storage array.
storageType= { FIBRECHANNEL | ISCSI | LOCAL | UNKNOWN }	The storage type for the storage array.
storageName=value	A name to identify the storage for a storage array behind a concentrator.
accessHost=value	The hostname or IP address for the storage array. This is not applicable to fibre channel storage arrays.
accessPort=value	The port on which access to the storage array is allowed. When adding iSCSI storage, add the access port as well. The default access port for iSCSI is 3260. If not specified, the default port is used automatically.
accessUsername=value	A username with administrative access to the storage array, used with accesshostname. This option should only be used where CHAP is enabled on the storage array.
accessPassword=value	The password for the accessusername user. This option should only be used where CHAP is enabled on the storage array.
useChap= { Yes | No }	Whether to use CHAP authentication.
adminHost=value	The host name or IP address where administrative access to the storage array is allowed.
adminUserName=value	A user name with administrative access to the storage array, used with adminHost.
adminPassword=value	The administrator password for the adminUserName user.
pluginPrivateData=value	This option is used to pass additional parameters that a non-generic Oracle VM Storage Connect plug-in may accept to control functionality. For instance, in the case of an Oracle NetApp file system, you can enable SSL using this parameter in the following way: pluginPrivateData="ssl=Yes"
name=value	A name to identify the storage array.
description=value	Optional description for the storage array. value is a maximum of 4,000 characters. To set an empty description, use description="".
lipScan= { Yes | No }	This option is only applicable to an Unmanaged FibreChannel Storage Array and should only be used when modifying an existing Unmanaged FibreChannel Storage Array using the edit StorageArray command. An Unmanaged FibreChannel Storage Array is not user created and only gets populated upon the first server discovery.

Note

Any create command only creates a single instance of an object, and therefore only accepts a single object instance as an attribute. Providing more than one object of the same attribute type as a parameter always results in the last attribute value taking precedence.

Examples

Example A.65 Discovering a storage array

OVM> create StorageArray plugin="Oracle Generic SCSI Plugin" name=MyISCSIServer \
  storageType=ISCSI accessHost=10.172.76.130 accessPort=3260

See Also

• Section A.3, “addAccessHost”

• Section A.86, “edit StorageArray”

• Section A.11, “add Server”

• Section A.154, “remove Server”

• Section A.4, “addAdminServer”

• Section A.147, “removeAdminServer”

• Section A.142, “refresh”

• Section A.34, “create AccessGroup”

• Section A.13, “add StorageInitiator”

• Section A.182, “validate”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.50 create Tag

Creates a tag.

Syntax

create Tag name=value [ description=value ]

Description

This command creates a tag to identify and group objects.

Options

The following table shows the available options for this command.

Option	Description
name=value	A name to identify the tag.
description=value	Optional description for the tag. value is a maximum of 4,000 characters. To set an empty description, use description="".

Note

Any create command only creates a single instance of an object, and therefore only accepts a single object instance as an attribute. Providing more than one object of the same attribute type as a parameter always results in the last attribute value taking precedence.

Examples

Example A.66 Creating a tag

OVM> create Tag name=MyTag description="My tag."

See Also

• Section A.88, “edit Tag”

• Section A.14, “add Tag”

• Section A.157, “remove Tag”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.51 create VirtualDisk

Creates a virtual disk.

Syntax

create VirtualDisk size=value shareable= { Yes | No } sparse= { Yes | No } name=value [ description=value ] on Repository instance

Where instance is:

{ id=value | name=value }

Description

This command creates a virtual disk in a storage repository.

Options

The following table shows the available options for this command.

Option	Description
size=value	The size of the virtual disk in GiB. value can be an integer between 1 and 1000000.
shareable= { Yes | No }	Whether the virtual disk is shareable. Shareable disks have read/write privileges in multiple virtual machines and should be used with caution.
sparse= { Yes | No }	Whether to create a sparse or non-sparse virtual disk.
name=value	A name to identify the virtual disk.
description=value	Optional description for the virtual disk. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyRepository.

Note

Any create command only creates a single instance of an object, and therefore only accepts a single object instance as an attribute. Providing more than one object of the same attribute type as a parameter always results in the last attribute value taking precedence.

Examples

Example A.67 Creating a virtual disk in a storage repository

OVM> create VirtualDisk name=MyVMDisk size=10 sparse=Yes shareable=No on Repository \
  name=MyRepository

See Also

• Section A.135, “importVirtualDisk”

• Section A.93, “edit VirtualDisk”

• Section A.161, “resize”

• Section A.59, “delete”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.52 create VlanInterface

Creates a VLAN interface.

Syntax

create VlanInterface vlanId=value [ mtu=value ] name=value [ description=value ] on { Port | BondPort } instance

Where instance is:

{ id=value | name=value }

Description

This command creates a VLAN interface on either a port or a bond port.

To configure the IP address for a VLAN interface, use the embeddedCreate command.

Options

The following table shows the available options for this command.

Option	Description
vlanId=value	The ID of the VLAN interface. May be an integer between 2 and 4095.
mtu=value	The MTU value. May be an integer between 1500 and 64000.
name=value	A name to identify the VLAN interface.
description=value	Optional description for the VLAN interface. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyPort.

Note

Any create command only creates a single instance of an object, and therefore only accepts a single object instance as an attribute. Providing more than one object of the same attribute type as a parameter always results in the last attribute value taking precedence.

Examples

Example A.68 Creating a VLAN interface

OVM> create VlanInterface vlanId=20 mtu=1500 name=MyVLANInterface on Port \
  id=0004fb0000200000229dbcccf17efec5

See Also

• Section A.94, “edit VlanInterface”

• Section A.15, “add VlanInterface”

• Section A.7, “add BondPort”

• Section A.66, “edit BondPort”

• Section A.150, “remove BondPort”

• Section A.153, “remove Port”

• Section A.102, “embeddedCreate”

• Section A.103, “embeddedDelete”

• Section A.104, “embeddedEdit”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.53 create Vm

Creates a virtual machine.

Syntax

create Vm [ memory=value ] [ memoryLimit=value ] [ cpuCount=value ] [ cpuCountLimit=value ] [ cpuPriority=value ] [ cpuUtilizationCap=value ] [ highAvailability= { Yes | No } ] [ hugePagesEnabled= { Yes | No } ] [ osType=value ] [ restartActionOnCrash= { RESTART | STOP | RESTART_AFTER_DUMP | STOP_AFTER_DUMP } ] [ mouseType= { OS_DEFAULT | PS2_MOUSE | USB_MOUSE | USB_TABLET } ] domainType= { XEN_HVM | XEN_HVM_PV_DRIVERS | XEN_PVM | LDOMS_PVM | UNKNOWN } [ keymapName= { en-us | ar | da | de | de-ch | en-gb | es | et | fi | fo | fr | fr-be | fr-ca | fr-ch | hr | hu | is | it | ja | lt | lv | mk | nl | nl-be | No | pl | pt | pt-br | ru | sl | sv | th | tr } ] [ bootOrder= { PXE | DISK | CDROM } ] [ networkInstallPath=value ] repository=value [ server=value ] [ startPolicy= { BEST_SERVER | BALANCE_SERVER | CURRENT_SERVER | USE_POOL_POLICY } ] [ viridian= { Yes | No } ] name=value [ description=value ] on ServerPool instance

Where instance is:

{ id=value | name=value }

Description

This command creates a virtual machine.

Options

The following table shows the available options for this command.

Option	Description
memory=value	The memory size the virtual machine is allocated in MB. May be an integer between 32 and 512000. The default is 512.
memoryLimit=value	The maximum memory size the virtual machine can be allocated in MB. May be an integer between 32 and 512000. The default is 512.
cpuCount=value	The number of processors the virtual machine is allocated. May be an integer between 1 and 999999, but cannot exceed the maximum limit for the domain type, as follows: PVM: 256. Important As of Oracle VM Release 3.4.6, support for PVM guests is removed. For more information, see Disabling Paravirtualized Guests on Oracle VM Server in the Oracle VM Administrator's Guide. HVM: 128; or 32 for Microsoft Windows guests. Note As of Release 3.4.6, the HVM limit is 64 for Microsoft Windows guests. PVHVM: 128; or 32 if using Oracle VM Paravirtual Drivers for Microsoft Windows. Note As of Release 3.4.6, the PVHVM limit is 64 if using Oracle VM Paravirtual Drivers for Microsoft Windows. LDOMS_PVM: Equivalent to the number of available CPUs on the server.
cpuCountLimit=value	The maximum number of processors the virtual machine can be allocated. May be an integer between 1 and 999999, but cannot exceed the maximum limit for the domain type, as follows: PVM: 256. Important As of Oracle VM Release 3.4.6, support for PVM guests is removed. For more information, see Disabling Paravirtualized Guests on Oracle VM Server in the Oracle VM Administrator's Guide. HVM: 128; or 32 for Microsoft Windows guests. Note As of Release 3.4.6, the HVM limit is 64 for Microsoft Windows guests. PVHVM: 128; or 32 if using Oracle VM Paravirtual Drivers for Microsoft Windows. Note As of Release 3.4.6, the PVHVM limit is 64 if using Oracle VM Paravirtual Drivers for Microsoft Windows. LDOMS_PVM: Equivalent to the number of available CPUs on the server.
cpuPriority=value	The CPU priority of the virtual machine. A value between 1 and 100; the higher the number, the more priority the CPU is given.
cpuUtilizationCap=value	The maximum percentage to which the virtual CPUs can receive scheduled time. A value between 10 and 100; the higher the number, the more scheduled time the CPU is given.
highAvailability= { Yes | No }	Whether to enable High Availability (HA).
hugePagesEnabled= { Yes | No }	Whether to enable HugePages. Note The HugePages feature is deprecated in Oracle VM Release 3.4.1. You should not enable HugePages when creating or editing virtual machines in the Oracle VM Manager Web Interface or Oracle VM Manager Command Line Interface. This feature will be removed in a future release of Oracle VM. If you have HugePages enabled for any PVM guests, Oracle recommends that you change the domain type for virtual machines from Paravirtualized (PVM) to Hardware virtualized, with paravirtualized drivers (PVHVM). If you cannot change the domain type for a virtual machine, you should disable the HugePages setting and then restart the virtual machine.
osType= value	The operating system of the virtual machine. To find the operating system type, use the getVmOsTypes command.
[ restartActionOnCrash= { RESTART | STOP | RESTART_AFTER_DUMP | STOP_AFTER_DUMP } ]	The action to perform in the case where a virtual machine crashes. This option must only be used for virtual machines that are running on the Xen hypervisor and that have been configured to run on a particular Oracle VM Server. Note that in the case where High Availability (HA) is enabled for a virtual machine, the virtual machine is always restarted in the event of a crash, since HA takes precedence over this setting. Therefore, you should be aware that if the highAvailability parameter is set to the value of Yes, any value for this option, other than RESTART and RESTART_AFTER_DUMP, is effectively ignored. If you select and option to generate a core dump file, you should be aware that these are saved to /var/xen/dump on the Oracle VM Server where the virtual machine is hosted. Each core dump file is named uniquely so that files are not overwritten. This can use up disk space rapidly. You must ensure that there is either enough disk space available at this path on the Oracle VM Server where the virtual machine will run; or you should mount additional storage at this path to avoid using up disk space required to host dom0.
mouseType= { OS_DEFAULT | PS2_MOUSE | USB_MOUSE | USB_TABLET }	The mouse type of the virtual machine.
domainType= { XEN_HVM | XEN_HVM_PV_DRIVERS | XEN_PVM | LDOMS_PVM | UNKNOWN }	The domain type of the virtual machine.
keymapName= { en-us | ar | da | de | de-ch | en-gb | es | et | fi | fo | fr | fr-be | fr-ca | fr-ch | hr | hu | is | it | ja | lt | lv | mk | nl | nl-be | No | pl | pt | pt-br | ru | sl | sv | th | tr }	The keyboard mapping to use for the virtual machine.
bootOrder= { PXE | DISK | CDROM }	The boot media order for the virtual machine. Enter options separated by commas (,), for example: bootOrder='CDROM,DISK' If you use the PXE boot option to boot from network-based installation media, also use the networkInstallPath parameter. To set an empty bootOrder option, use bootOrder="".
networkInstallPath=value	The location at which the installation media (mounted ISO file) is located when creating a PVM guest.
repository=value	The name or ID of the storage repository in which to create the virtual machine configuration file.
server=value	The name or ID of the Oracle VM Server on which to create the virtual machine.
startPolicy= { BEST_SERVER | BALANCE_SERVER | CURRENT_SERVER | USE_POOL_POLICY }	Optional virtual machine start up policy.
viridian= { Yes | No }	Viridian support enables the exposure of Windows virtualization compatible entitlements to Microsoft Windows guest operating systems. Enabling viridian support is strongly recommended to ensure improved performance for Microsoft Windows guest operating systems. Enabling viridian support is permitted for all Microsoft Windows guest operating system types. However, it is only effective from Microsoft Windows Vista and Microsoft Windows Server 2008 onwards.
name=value	A name to identify the virtual machine.
description=value	Optional description for the virtual machine. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServer.

Note

Any create command only creates a single instance of an object, and therefore only accepts a single object instance as an attribute. Providing more than one object of the same attribute type as a parameter always results in the last attribute value taking precedence.

Examples

Example A.69 Creating a virtual machine

OVM> create Vm name=MyVM repository=MyRepository domainType=XEN_HVM \ 
  server=MyServer startPolicy=USE_POOL_POLICY on ServerPool name=MyServerPool

See Also

• Section A.126, “getVmOsTypes”

• Section A.24, “clone Vm”

• Section A.95, “edit Vm”

• Section A.16, “add Vm”

• Section A.177, “start”

• Section A.138, “list”

• Section A.171, “show”

A.54 create VmCloneCustomizer

Creates a clone customizer for a virtual machine.

Syntax

create VmCloneCustomizer name=value [ description=value ] on Vm instance

Where instance is:

{ id=value | name=value }

Description

This command allows you to create a new clone customizer for a virtual machine. When the clone customizer is created, you may want to create clone network and storage mappings that can be used by the clone customizer. See Section A.55, “create VmCloneNetworkMapping” and Section A.56, “create VmCloneStorageMapping” for more information.

Options

The following table shows the available options for this command.

Option	Description
name=value	A name to identify the clone customizer. Tip To find this name after the clone customizer is created, use the list VmCloneCustomizer command. You need the name or ID of this to delete a clone customizer from a virtual machine with the delete VmCloneCustomizer command.
description=value	Optional description for the clone customizer object. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVM.

Note

Any create command only creates a single instance of an object, and therefore only accepts a single object instance as an attribute. Providing more than one object of the same attribute type as a parameter always results in the last attribute value taking precedence.

Examples

Example A.70 Create a virtual machine clone customizer

OVM> create VmCloneCustomizer name=MyVmCloneCustomizer on Vm name=MyVM

See Also

• Section A.56, “create VmCloneStorageMapping”

• Section A.55, “create VmCloneNetworkMapping”

• Section A.96, “edit VmCloneCustomizer”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.55 create VmCloneNetworkMapping

Maps the network that should be used by a virtual machine clone customizer.

Syntax

create VmCloneNetworkMapping network=value vnic=value name=value [ description=value ] on vmCloneCustomizer instance

Where instance is:

{ id=value | name=value }

Description

Creates a new network mapping for use by a virtual machine clone customizer. To create a clone network mapping, a virtual machine with an assigned VNIC must already exist within your environment.

Options

The following table shows the available options for this command.

Option	Description
network=value	The name or ID value of an existing network to which the cloned virtual machine should be connected.
vnic=value	The name or ID value of an existing VNIC that is attached to the existing virtual machine that is this clone customizer's parent.
name=value	A name to identify the clone network mapping. Tip To find this name after the network is mapped to a virtual machine clone customizer, use the list vmCloneNetworkMapping command. You need the name or ID of this to delete a network mapping from a virtual machine with the delete vmCloneNetworkMapping command.
description=value	Optional description for the clone network mapping object. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVMCloneCustomizer.

Note

Any create command only creates a single instance of an object, and therefore only accepts a single object instance as an attribute. Providing more than one object of the same attribute type as a parameter always results in the last attribute value taking precedence.

Examples

Example A.71 Creating a virtual machine clone network mapping

OVM> create VmCloneNetworkMapping name=MyCloneNet network=MyVMNetwork \
    vnic=0004fb0000070000277ecade9b897469 on VmCloneCustomizer name=MyVMCloneCustomizer

See Also

• Section A.54, “create VmCloneCustomizer”

• Section A.97, “edit VmCloneNetworkMapping”

• Section A.56, “create VmCloneStorageMapping”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.56 create VmCloneStorageMapping

Maps the storage for a virtual machine disk that should be used by a virtual machine clone customizer.

Syntax

create VmCloneStorageMapping cloneType= { SPARSE_COPY | NON_SPARSE_COPY | THIN_CLONE } vmDiskMapping=value { physicalDisk=value | repository=value | storageArray=value } name=value [ description=value ] on vmCloneCustomizer instance

Where instance is:

{ id=value | name=value }

Description

Maps the storage for a virtual machine disk that should be used by a virtual machine clone customizer. A disk mapping that is already used by virtual machine that is this clone customizer's parent must already exist.

Options

The following table shows the available options for this command.

Option	Description
cloneType= { SPARSE_COPY | NON_SPARSE_COPY | THIN_CLONE }	The type of clone storage that should be created.
vmDiskMapping=value	The name or ID of an existing virtual machine disk mapping.
{ physicalDisk=value | repository=value | storageArray=value }	The name or ID of either a physicalDisk, repository or storageArray object where the clone disk is to be created. You must specify at least one of these options and its associated value.
name=value	A name to identify the clone storage mapping. Tip To find this name after virtual storage is mapped to a virtual machine clone customizer, use the list vmCloneStorageMapping command. You need the name or ID of this to delete a disk mapping from a virtual machine clone customizer with the delete vmCloneStorageMapping command.
description=value	Optional description for the clone storage mapping object. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVMCloneCustomizer.

Note

Any create command only creates a single instance of an object, and therefore only accepts a single object instance as an attribute. Providing more than one object of the same attribute type as a parameter always results in the last attribute value taking precedence.

Examples

Example A.72 Creating a virtual machine clone storage mapping

OVM> create VmCloneStorageMapping name=BootDisk cloneType=SPARSE_COPY \
    vmDiskMapping=0004fb000013000096e5d46c5f5e6a52 repository=MyRepository \
    on VmCloneCustomizer name=MyVMCloneCustomizer

See Also

• Section A.54, “create VmCloneCustomizer”

• Section A.98, “edit VmCloneStorageMapping”

• Section A.55, “create VmCloneNetworkMapping”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.57 create VmDiskMapping

Maps a virtual disk, physical disk, or CDROM to a virtual machine disk slot.

Syntax

create VmDiskMapping slot=value { physicalDisk=value | virtualDisk=value | virtualCd= { value | EMPTY_CDROM } } name=value [ description=value ] on Vm instance

Where instance is:

{ id=value | name=value }

Description

This command maps a virtual disk, physical disk, or CDROM to a virtual machine disk slot. To create an empty CDROM drive, use the virtualCd=EMPTY_CDROM option. To edit a virtual disk or eject a CDROM, remove it using the delete VmDiskMapping command, then use the create VmDiskMapping command again to remap it to a virtual machine with any changed settings.

Options

The following table shows the available options for this command.

Option	Description
slot=value	The slot number for the disk in the virtual machine This can be an integer between 0 and 1000000.
physicalDisk=value	The name or ID of the physical disk.
VirtualDisk=value	The name or ID of the virtual disk.
virtualCd= { value | EMPTY_CDROM }	The name or ID of the ISO file (virtual CDROM). Alternatively, to create an empty CDROM, use the EMPTY_CDROM option.
name=value	A name to identify the disk mapping. Tip To find this name after a virtual disk is mapped to a virtual machine, use the list VmDiskMapping command. You will need the name or ID of this to delete a disk mapping from a virtual machine with the delete VmDiskMapping command.
description=value	Optional description for the disk mapping object. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVM.

Note

Any create command only creates a single instance of an object, and therefore only accepts a single object instance as an attribute. Providing more than one object of the same attribute type as a parameter always results in the last attribute value taking precedence.

Examples

Example A.73 Mapping a virtual disk to a virtual machine

OVM> create VmDiskMapping slot=0 virtualDisk=MyVMDisk name="Boot Disk" on Vm name=MyVM

Example A.74 Mapping an ISO file (CDROM) to a virtual machine

OVM> create VmDiskMapping slot=1 virtualCd=OracleLinux-dvd.iso \
  name="CDROM Drive" on Vm name=MyVM

Example A.75 Mapping an empty CDROM drive to a virtual machine

OVM> create VmDiskMapping slot=2 virtualCd=EMPTY_CDROM name="CDROM Drive" on Vm name=MyVM

Example A.76 Mapping a physical disk to a virtual machine

OVM> create VmDiskMapping slot=3 physicalDisk=MyPhysicalDisk name="D Drive" on Vm name=MyVM

See Also

• Section A.99, “edit VmDiskMapping”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.58 create Vnic

Creates a VNIC on a virtual machine.

Syntax

create Vnic network=value name=value [ macAddress=value ] [ description=value ] on Vm instance

Where instance is:

{ id=value | name=value }

Description

This command creates a VNIC and associates it to a virtual machine.

Options

The following table shows the available options for this command.

Option	Description
network=value	The name or ID of the network to which the VNIC is to be assigned.
name=value	A name to identify the VNIC.
macAddress=value	Optional parameter to specify the MAC address for the VNIC. If no MAC address is provided, one is automatically assigned from the default range. To change the default range of MAC addresses, use the setVnicMacAddrRange command. To display the MAC address range, use the getVnicMacAddrRange command.
description=value	Optional description for the VNIC. value is a maximum of 4,000 characters. To set an empty description, use description="".

Note

Any create command only creates a single instance of an object, and therefore only accepts a single object instance as an attribute. Providing more than one object of the same attribute type as a parameter always results in the last attribute value taking precedence.

Examples

Example A.77 Creating a VNIC

OVM> create Vnic name=MyVNIC network=MyVMNetwork on Vm name=MyVM

See Also

• Section A.100, “edit Vnic”

• Section A.17, “add Vnic”

• Section A.160, “remove Vnic”

• Section A.170, “setVnicMacAddrRange”

• Section A.129, “getVnicMacAddrRange”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.59 delete

Deletes an object.

Syntax

delete { AccessGroup | AntiAffinityGroup | Assembly | BondPort | CpuCompatibilityGroup | FileServer | FileSystem | Network | PhysicalDisk | Repository | RepositoryExport | Server | ServerController | ServerPool | ServerPoolNetworkPolicy | ServerUpdateGroup | ServerUpdateRepository | StorageArray | Tag | VirtualAppliance | VirtualCdrom | VirtualDisk | VlanInterface | Vm | VmCloneCustomizer | VmCloneNetworkMapping | VmCloneStorageMapping | VmDiskMapping | Vnic } instance

Where instance is:

{ id=value | name=value }

Description

This command deletes an object.

Virtual machines and virtual machine templates are treated as equivalent within the CLI. Therefore, to delete a virtual machine template you should use the delete Vm command. Since it is possible that a virtual machine template and a virtual machine may share the same name, it is recommended that you use the object's unique ID to perform this operation.

Options

The following table shows the available options for this command.

Option	Description
{ AccessGroup | AntiAffinityGroup | Assembly | BondPort | CpuCompatibilityGroup | FileServer | FileSystem | Network | PhysicalDisk | Repository | RepositoryExport | Server | ServerController | ServerPool | ServerPoolNetworkPolicy | ServerUpdateGroup | ServerUpdateRepository | StorageArray | Tag | VirtualAppliance | VirtualCdrom | VirtualDisk | VlanInterface | Vm | VmCloneCustomizer | VmCloneNetworkMapping | VmCloneStorageMapping | VmDiskMapping | Vnic }	The object to delete. Before you delete a virtual machine (Vm object), you should make sure all disks have been removed from it using the delete VmDiskMapping command. Important The Assembly option has been deprecated. You should instead use VirtualAppliance.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServer.

Examples

Example A.78 Deleting an Oracle VM Server

OVM> delete Server name=MyServer

Example A.79 Deleting a virtual machine or virtual machine template

OVM> delete Vm id=0004fb00001400007be890778aedc7b8 

Example A.80 Deleting a network

OVM> delete Network name=MyVMNetwork

Example A.81 Deleting a virtual machine disk mapping

OVM> delete VmDiskMapping id=0004fb00001300009d46acbb77de919e

See Also

• Section A.138, “list”

• Section A.171, “show”

A.60 discoverServer

Discovers an Oracle VM Server.

Syntax

discoverServer ipAddress=value password=value takeOwnership= { Yes | No }

Description

This command discovers an Oracle VM Server and adds it to Oracle VM Manager. The username used to connect to the Oracle VM Agent on the Oracle VM Server is oracle. The port number on which access is made to the Oracle VM Agent on the Oracle VM Server is 8899.

Options

The following table shows the available options for this command.

Option	Description
ipAddress=value	The IP address or hostname of the Oracle VM Server.
password=value	The password to use when connecting to the Oracle VM Agent on the Oracle VM Server.
takeOwnership= { Yes | No }	Whether to take ownership of the Oracle VM Server. Important The takeOwnership option should only be used if the Oracle VM Server is not already owned by an existing Oracle VM Manager. If specified for an Oracle VM Server that is already owned, the option is silently ignored.

Examples

Example A.82 Discovering an Oracle VM Server

OVM> discoverServer ipAddress=10.172.76.73 password=password takeOwnership=Yes

See Also

• Section A.80, “edit Server”

• Section A.11, “add Server”

• Section A.154, “remove Server”

• Section A.177, “start”

• Section A.162, “restart”

• Section A.178, “stop”

• Section A.137, “kill”

• Section A.181, “upgrade”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.61 edit AccessGroup

Edits an access group.

Syntax

edit AccessGroup instance [ name=value ] [ nameOnArray=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of an access group. Generic Oracle VM Storage Connect plug-ins are not supported with this command.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
name=value	A name for the access group.
nameOnArray=value	A name for the access group as known on the storage array.
description=value	Optional description for the access group. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyAccessGroup.

Examples

Example A.83 Changing the name of an access group

OVM> edit AccessGroup name=MyAccessGroup nameOnArray=MyNewName

See Also

• Section A.34, “create AccessGroup”

• Section A.9, “add PhysicalDisk”

• Section A.152, “remove PhysicalDisk”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.62 edit AntiAffinityGroup

Edits an anti affinity group in a server pool.

Syntax

edit AntiAffinityGroup instance [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of an anti affinity group in a server pool. To add a virtual machine to an anti affinity group, use the add Vm command. To remove a virtual machine from an anti affinity group, use the remove Vm command.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
name=value	A name to identify the anti affinity group.
description=value	Optional description for the anti affinity group. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyAAGroup.

Examples

Example A.84 Editing an anti affinity group

OVM> edit AntiAffinityGroup name=MyAAGroup description="My Anti Affinity Group"

See Also

• Section A.35, “create AntiAffinityGroup”

• Section A.16, “add Vm”

• Section A.159, “remove Vm”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.63 edit Assembly (Deprecated)

Edits an assembly.

Important

This command has been deprecated. Instead, use the edit VirtualAppliance command.

Syntax

edit Assembly instance [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of assembly.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
name=value	A name to identify the assembly.
description=value	Optional description for the assembly. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyAssembly.ova.

Examples

Example A.85 Editing an assembly

OVM> edit Assembly name=myassembly.ova description='Oracle Linux Release 6'

See Also

• Section A.64, “edit AssemblyVirtualDisk (Deprecated)”

• Section A.65, “edit AssemblyVm (Deprecated)”

• Section A.131, “importAssembly (Deprecated)”

• Section A.111, “getDescriptor”

• Section A.59, “delete”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

A.64 edit AssemblyVirtualDisk (Deprecated)

Edits a virtual disk in an assembly.

Important

This command has been deprecated. Instead, use the edit VirtualApplianceVirtualDisk command.

Syntax

edit AssemblyVirtualDisk instance [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of a virtual disk in an assembly. You cannot delete an AssemblyVirtualDisk object. You can only delete it by deleting the assembly itself.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
name=value	A name to identify the assembly virtual disk.
description=value	Optional description for the assembly virtual disk. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyAssemblyVirtualDisk.

Examples

Example A.86 Editing an assembly virtual disk

OVM> edit AssemblyVirtualDisk name=MyAssemblyVirtualDisk description='Oracle Linux Release 6'

See Also

• Section A.63, “edit Assembly (Deprecated)”

• Section A.65, “edit AssemblyVm (Deprecated)”

• Section A.131, “importAssembly (Deprecated)”

• Section A.111, “getDescriptor”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

A.65 edit AssemblyVm (Deprecated)

Edits a virtual machine in an assembly.

Important

This command has been deprecated. Instead, use the edit VirtualApplianceVm command.

Syntax

edit AssemblyVm instance [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of a virtual machine in an assembly. You cannot delete an AssemblyVm object. You can only delete it by deleting the assembly itself.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
name=value	A name to identify the assembly virtual machine.
description=value	Optional description for the assembly virtual machine. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyAssemblyVM.

Examples

Example A.87 Editing an assembly virtual machine

OVM> edit AssemblyVm name=MyAssemblyVM description='Oracle Linux Release 6'

See Also

• Section A.63, “edit Assembly (Deprecated)”

• Section A.64, “edit AssemblyVirtualDisk (Deprecated)”

• Section A.131, “importAssembly (Deprecated)”

• Section A.111, “getDescriptor”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

A.66 edit BondPort

Edits a bond port.

Syntax

edit BondPort instance [ mode= { ACTIVE_PASSIVE | LINK_AGGREGATION | LOAD_BALANCED } ] [ mtu=value ] [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of a bond port on an Oracle VM Server.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
mode= { ACTIVE_PASSIVE | LINK_AGGREGATION | LOAD_BALANCED }	The network bonding mode.
mtu=value	The MTU value. May be an integer between 1500 and 64000.
name=value	A name to identify the bond.
description=value	Optional description for the bond. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyPortBond.

Examples

Example A.88 Editing a bond port

OVM> edit BondPort id=0004fb0000200000884da42c23947622 mode=LOAD_BALANCED

See Also

• Section A.36, “create BondPort”

• Section A.7, “add BondPort”

• Section A.150, “remove BondPort”

• Section A.153, “remove Port”

• Section A.102, “embeddedCreate”

• Section A.103, “embeddedDelete”

• Section A.104, “embeddedEdit”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.67 edit ControlDomain

Edits a control domain.

Syntax

edit ControlDomain instance [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of a control domain. You cannot create or delete a control domain; you can only edit the name and description.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
name=value	A name to identify the control domain.
description=value	Optional description for the control domain. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyControlDomain.

Examples

Example A.89 Editing a control domain

OVM> edit ControlDomain id=0004fb0000210000308f567ae2cbdc4c description="SPARC control domain"

See Also

• Section A.138, “list”

• Section A.171, “show”

A.68 edit Cpu

Edits a control domain.

Syntax

edit Cpu instance [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of a CPU. You cannot create or delete a CPU; you can only edit the name and description.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
name=value	A name to identify the CPU.
description=value	Optional description for the CPU. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyCPU.

Examples

Example A.90 Editing a CPU

OVM> edit Cpu id="Processor (1) in 00:e0:81:4d:40:c6:00:e0:81:4d:40:c7:ff:ff:ff:ff" \
  description="CPU 1 on MyServer1"

See Also

• Section A.138, “list”

• Section A.171, “show”

A.69 edit CpuCompatibilityGroup

Edits a CPU compatibility group.

Syntax

edit CpuCompatibilityGroup instance [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of a CPU compatibility group.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
name=value	A name to identify the CPU compatibility group.
description=value	Optional description for the CPU compatibility group. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyCPUGroup.

Examples

Example A.91 Editing a CPU compatibility group

OVM> edit CpuCompatibilityGroup name=MyCPUGroup description='SPARC-based CPU compatibility group'

See Also

• Section A.11, “add Server”

• Section A.154, “remove Server”

• Section A.37, “create CpuCompatibilityGroup”

• Section A.138, “list”

• Section A.171, “show”

• Section A.59, “delete”

A.70 edit FileServer

Edits a file server.

Syntax

edit FileServer instance [ plugin=value ] [ accessHost=value ] [ uniformedExports= { Yes | No } ] [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of a file server.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
plugin=value	The name or ID for the Oracle VM Storage Connect plug-in for the file server. To see a list of the available plug-ins, use the list StorageArrayPlugin command.
accessHost=value	The host name or IP address for the file server.
uniformedExports= { Yes | No }	Whether the file server has uniformed file system exports. The default is Yes.
name=value	A name to identify the file server.
description=value	Optional description for the file server. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyNFSServer.

Examples

Example A.92 Editing a file server

OVM> edit FileServer id=0004fb00000900000ef55b2f96a564c8 name=MyNFSServer \
  description='My NFS Server'

See Also

• Section A.38, “create FileServer”

• Section A.11, “add Server”

• Section A.154, “remove Server”

• Section A.4, “addAdminServer”

• Section A.147, “removeAdminServer”

• Section A.6, “addRefreshServer”

• Section A.149, “removeRefreshServer”

• Section A.142, “refresh”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.71 edit FileServerPlugin

Edits a file server plug-in.

Syntax

edit FileServerPlugin instance [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of a file server plug-in. You cannot create or delete a file server plug-in; you can only edit the name and description.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
name=value	A name to identify the file server plug-in.
description=value	Optional description for the file server plug-in. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyFileServerPlugin.

Examples

Example A.93 Editing a file server plug-in

OVM> edit FileServerPlugin id="oracle.generic.NFSPlugin.GenericNFSPlugin (1.1.0)" \
  description="File Server Plugin for NFS Server"

See Also

• Section A.138, “list”

• Section A.171, “show”

A.72 edit FileSystem

Edits an OCFS2 file system.

Syntax

edit FileSystem instance [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of an OCFS2 file system.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
name=value	A name to identify the file system.
description=value	Optional description for the file system. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyFileSystem.

Examples

Example A.94 Editing a file system

OVM> edit FileSystem id=0004fb0000050000002618dec56ee0e8 name=MyFileSystem \
  description='My File System'

See Also

• Section A.39, “create FileSystem”

• Section A.8, “add FileSystem”

• Section A.151, “remove FileSystem”

• Section A.34, “create AccessGroup”

• Section A.61, “edit AccessGroup”

• Section A.142, “refresh”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.73 edit Manager

Edits a Manager object.

Syntax

edit Manager instance name=value [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of a Manager (Oracle VM Manager) object.

Options

The following table shows the available options for this command.

Option	Description
name=value	A name to identify the Manager object.
description=value	Optional description for the Manager object. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name="OVM Manager".

Examples

Example A.95 Renaming a Manager object

OVM> edit Manager name="OVM Manager" name="Oracle VM Manager"

See Also

• Section A.138, “list”

• Section A.171, “show”

A.74 edit Network

Edits an Ethernet-based network.

Syntax

edit Network instance [ roles= { MANAGEMENT | LIVE_MIGRATE | CLUSTER_HEARTBEAT | VIRTUAL_MACHINE | STORAGE } ] [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of an Ethernet-based network.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
roles= { MANAGEMENT | LIVE_MIGRATE | CLUSTER_HEARTBEAT | VIRTUAL_MACHINE | STORAGE }	The network roles. Enter options separated by commas (,), for example: roles='VIRTUAL_MACHINE,STORAGE' To set an empty roles option, use roles="". It is not possible to edit the roles for a local network. Any attempts to do so are simply ignored. Note If the network is used by many servers, modifying this parameter may cause the edit operation to take several minutes to complete.
name=value	A name to identify the network.
description=value	Optional description for the network. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyNetwork.

Examples

Example A.96 Editing a network

OVM> edit Network name=MyVMNetwork roles='VIRTUAL_MACHINE,LIVE_MIGRATION'

See Also

• Section A.10, “add Port”

• Section A.77, “edit Port”

• Section A.153, “remove Port”

• Section A.40, “create Network”

• Section A.36, “create BondPort”

• Section A.138, “list”

• Section A.171, “show”

A.75 edit PeriodicTask

Edits a periodic task.

Syntax

edit PeriodicTask instance [ taskInterval=value ] [ enabled= { Yes | No } ] [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of a periodic task. A periodic task is a task (job) that can be run multiple times, with an interval in between, such as checking server updates repositories for available Oracle VM Server software updates.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
taskInterval=value	The interval between which the periodic task should run, in minutes. value may be an integer between 1 and 999999999.
enabled= { Yes | No }	Whether to enable the periodic task.
name=value	A name to identify the periodic task.
description=value	Optional description for the periodic task. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name="Server Upgrade Checker Task".

Examples

Example A.97 Disabling a periodic task

OVM> edit PeriodicTask name="Server Upgrade Checker Task" enabled=No

See Also

• Section A.138, “list”

• Section A.171, “show”

A.76 edit PhysicalDisk

Edits a physical disk.

Syntax

edit PhysicalDisk instance shareable= { Yes | No } [ extraInfo=value ] name=value [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of a physical disk. Local storage and generic storage plug-ins are not supported with this command. To resize a physical disk, use the resize command.

Options

The following table shows the available options for this command.

Option	Description
shareable= { Yes | No }	Whether the physical disk is shareable. Shareable disks have read/write privileges in multiple virtual machines and should be used with caution.
extraInfo=value	Any extra parameters for your Oracle VM Storage Connect plug-in.
name=value	A name to identify the physical disk.
description=value	Optional description for the physical disk. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyDisk.

Examples

Example A.98 Editing a physical disk

OVM> edit PhysicalDisk id=0004fb000018000034a2da375d08990e shareable=Yes

See Also

• Section A.41, “create PhysicalDisk”

• Section A.9, “add PhysicalDisk”

• Section A.152, “remove PhysicalDisk”

• Section A.161, “resize”

• Section A.59, “delete”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.77 edit Port

Edits an Ethernet port on an Oracle VM Server.

Syntax

edit Port instance [ mtu=value ] [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of an Ethernet port on an Oracle VM Server .

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
mtu=value	The MTU value. May be an integer between 1500 and 64000.
name=value	A name to identify the port.
description=value	Optional description for the port. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example id=0004fb0000200000c2a5f26641825be5.

Examples

Example A.99 Editing an Ethernet port

OVM> edit Port id=0004fb0000200000b0f9d86788b94a0e mtu=1500

See Also

• Section A.10, “add Port”

• Section A.36, “create BondPort”

• Section A.7, “add BondPort”

• Section A.150, “remove BondPort”

• Section A.153, “remove Port”

• Section A.102, “embeddedCreate”

• Section A.103, “embeddedDelete”

• Section A.104, “embeddedEdit”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.78 edit Repository

Edits a storage repository.

Syntax

edit Repository instance [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of a storage repository.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
name=value	A name to identify the storage repository.
description=value	Optional description for the storage repository. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyRepository.

Examples

Example A.100 Editing a storage repository

OVM> edit Repository id=0004fb00000300003ab65ab35e3fea7a name=MyRepository \
  description="My Storage Repository"

See Also

• Section A.42, “create Repository”

• Section A.11, “add Server”

• Section A.154, “remove Server”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.79 edit RepositoryExport

Edits a repository export.

Syntax

edit RepositoryExport instance name=value [ description=value ] [ options=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of an export on an Oracle VM Server to enable access for a third party back up tool to back up the contents of an OCFS2-based storage repository .

Options

The following table shows the available options for this command.

Option	Description
name=value	A name to identify the export on the file server.
description=value	Optional description for the export on the file server. value is a maximum of 4,000 characters. To set an empty description, use description="".
options=value	The parameters to include in the NFS mount configuration, for example: rw, async, no_root_squash, wdelay.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServer.

Examples

Example A.101 Editing a repository export on an Oracle VM Server

OVM> edit RepositoryExport name="My NFS Export" name=MyExport \
  options="rw, async, no_root_squash"

See Also

• Section A.43, “create RepositoryExport”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.80 edit Server

Edits an Oracle VM Server.

Syntax

edit Server instance [ ntpServers=value ] [ roles= { VM | UTILITY } ] [ inboundMigrationLocked= { Yes | No } ] [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of an Oracle VM Server. Use this command set the NTP servers, role, and whether to allow running of virtual machines.

To place an Oracle VM Server into or out of maintenance mode,use the setMaintenanceMode command.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
ntpServers=value	The hostname or IP address of one or more NTP servers to set the time on the Oracle VM Server. Enter options separated by commas (,), for example: ntpServers="ntp1.example.com,ntp2.example.com" To set an empty ntpServers option, use ntpServers="".
roles= { VM | UTILITY }	The role for the Oracle VM Server. To set an empty roles option, use roles="".
inboundMigrationLocked= { Yes | No }	Whether to allow additional virtual machines to run on the Oracle VM Server. Setting this option to Yes prevents new or migrated virtual machines from running on the Oracle VM Server. Setting this option to No allows new or migrated virtual machines to run on the Oracle VM Server. This option does not prevent virtual machines running on the Oracle VM Server from being migrated to another.
name=value	A name to identify the Oracle VM Server.
description=value	Optional description for the Oracle VM Server . value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServer.

Examples

Example A.102 Adding NTP servers to an Oracle VM Server

OVM> edit Server name=MyServer ntpServer="ntp1.example.com,ntp2.example.com"

Example A.103 Changing the role of an Oracle VM Server

OVM> edit Server name=MyServer role=UTILITY runVmsEnabled=No

See Also

• Section A.60, “discoverServer”

• Section A.11, “add Server”

• Section A.154, “remove Server”

• Section A.177, “start”

• Section A.162, “restart”

• Section A.178, “stop”

• Section A.137, “kill”

• Section A.168, “setMaintenanceMode”

• Section A.181, “upgrade”

• Section A.4, “addAdminServer”

• Section A.147, “removeAdminServer”

• Section A.6, “addRefreshServer”

• Section A.149, “removeRefreshServer”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.81 edit ServerController

Edits a server controller object to configure IPMI on an Oracle VM Server.

Syntax

edit ServerController instance ipAddress=value userName=value [ password=value ] name=value [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of a server controller object to configure IPMI on an Oracle VM Server.

Options

The following table shows the available options for this command.

Option	Description
virtualIP=value	The IP address of the IPMI.
userName=value	The user name for the IPMI.
password=value	An optional password for the IPMI.
name=value	A name to identify the server control object.
description=value	Optional description for the server control object. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServerController.

Examples

Example A.104 Editing IPMI configuration for an Oracle VM Server

OVM> edit ServerController id=mgtCtl_00:e0:81:4d:40:c6:00:e0:81:4d:40:c7:ff:ff:ff:ff \
  ipAddress=192.168.10.4 userName=admin password=password name=MyServerController

See Also

• Section A.44, “create ServerController”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.82 edit ServerPool

Syntax

edit ServerPool instance clusterEnable= { Yes | No } [ clusterTimeout= value ] [ keymapName= { en-us | ar | da | de | de-ch | en-gb | es | et | fi | fo | fr | fr-be | fr-ca | fr-ch | hr | hu | is | it | ja | lt | lv | mk | nl | nl-be | No | pl | pt | pt-br | ru | sl | sv | th | tr } ] [ migrateUsingSsl= { Yes | No } ] [ masterServer=value ] [ startPolicy= { BEST_SERVER | BALANCE_SERVER | CURRENT_SERVER } ] [ policyMode= { OFF | DRS | DPM } ] [ policyCpuEnable= { Yes | No } ] [ policyPeriod=value ] [ policyCpuThreshold=value ] [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of a server pool. Use this command to change the master Oracle VM Server, change the keyboard mapping, set whether to use secure migration of virtual machines, and to manage server pool policies.

Although none of the options are mandatory, you must supply at least one option.

It is not possible to edit the cluster enable flag for a server pool if there are Oracle VM Servers in the server pool. Attempts to edit this attribute for a server pool that already contain Oracle VM Servers fail and result in an error.

Options

The following table shows the available options for this command.

Option	Description
clusterEnable= { Yes | No }	Whether to enable a clustered server pool. If this parameter is not included, the default is No, so the server pool is not clustered. If this parameter is set to Yes, you must also include either the fileSystem or physicalDisk option to provide a location for the server pool file system.
clusterTimeout= value	Set the timeout value for the cluster in seconds. value is an integer between 30 and 300. Note that you can only change this value for a server pool if the pool contains no servers. SPARC-based server pools do not recognise the cluster timeout parameter. Setting this value for a server pool consisting of SPARC servers has no effect and the parameter is ignored by the Oracle VM Agent for SPARC.
keymapName= { en-us | ar | da | de | de-ch | en-gb | es | et | fi | fo | fr | fr-be | fr-ca | fr-ch | hr | hu | is | it | ja | lt | lv | mk | nl | nl-be | No | pl | pt | pt-br | ru | sl | sv | th | tr }	The key mapping to be used when connecting to a virtual machine's console.
migrateUsingSsl= { Yes | No }	Whether to enable secure migration of virtual machines using SSL.
masterServer=value	The name or ID of the Oracle VM Server to use as the master server for the server pool.
startPolicy= { BEST_SERVER | BALANCE_SERVER | CURRENT_SERVER }	The policy by which virtual machines are located when created in the server pool. The default is CURRENT_SERVER.
policyMode= { OFF | DRS | DPM }	Set the policy to use for the server pool.
policyCpuEnable= { Yes | No }	Set whether to enable the policy set in the policyMode option for the server pool.
policyPeriod=value	The time period for the policy job to run. This sets the policy job to run every n minutes, for example, 10 sets the policy job to run every 10 minutes. value can be an integer between 2 and 60.
policyCpuThreshold=value	The maximum amount of CPU percentage usage allowed before the policy must be enacted. value can be an integer between 25 and 99.
name=value	A name to identify the server pool.
description=value	Optional description for the server pool. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServer.

Examples

Example A.105 Editing a server pool

OVM> edit ServerPool name=MyServerPool name=MyOtherServerPool migrateUsingSsl=Yes

Example A.106 Changing the master Oracle VM Server

OVM> edit ServerPool id=0004fb000002000037db5e362c85a3fe masterServer=MyServer

Example A.107 Changing the virtual machine start policy

OVM> edit ServerPool name=MyServerPool startPolicy=BEST_SERVER

See Also

• Section A.45, “create ServerPool”

• Section A.46, “create ServerPoolNetworkPolicy”

• Section A.83, “edit ServerPoolNetworkPolicy”

• Section A.11, “add Server”

• Section A.154, “remove Server”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.83 edit ServerPoolNetworkPolicy

Edits a server pool network policy.

Syntax

edit ServerPoolNetworkPolicy instance [ policyEnable= { Yes | No } ] [ policyThreshold=value ] name=value [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of a server pool network policy.

Options

The following table shows the available options for this command.

Option	Description
policyEnable= { Yes | No }	Set whether to enable the policy set in the policyMode option of the create ServerPool or edit ServerPool command.
policyThreshold=value	The percentage (%) of network bandwidth the policy uses to move virtual machines. value can be an integer between 0 and 100.
name=value	A name to identify the server pool network policy.
description=value	Optional description for the server pool network policy. value is a maximum of 4,000 characters. To set an empty description, use description="".

Examples

Example A.108 Editing a server pool network policy

OVM> edit ServerPoolNetworkPolicy name=MyNetworkPolicy policyEnable=No name="My Network Policy"

See Also

• Section A.46, “create ServerPoolNetworkPolicy”

• Section A.5, “addPolicyServer”

• Section A.148, “removePolicyServer”

• Section A.45, “create ServerPool”

• Section A.82, “edit ServerPool”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.84 edit ServerUpdateGroup

Edits an Oracle VM Server update group in a server pool.

Syntax

edit ServerUpdateGroup instance [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits an Oracle VM Server update group in a server pool.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
name=value	A name to identify the server update group.
description=value	Optional description for the server update group. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServerPool.

Examples

Example A.109 Editing the name of an update group for a server pool

OVM> edit ServerUpdateGroup name=MyServerUpdateGroup name="My Server Update Group"

See Also

• Section A.47, “create ServerUpdateGroup”

• Section A.48, “create ServerUpdateRepository”

• Section A.85, “edit ServerUpdateRepository”

• Section A.19, “checkUpToDate”

• Section A.181, “upgrade”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.85 edit ServerUpdateRepository

Edits an Oracle VM Server update repository.

Syntax

edit ServerUpdateRepository instance [ repositoryName=value ] [ url=value ] [ enabled= { Yes | No } ] [ pkgSignatureType= { NONE | GPG | CA } ] [ pkgSignatureKey=value ] [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits an Oracle VM Server update repository.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
repositoryName=value	A name for the server update repository. This may only contain alphanumeric characters and underscores. No spaces are permitted.
url=value	The URL to access the repository. If you enclose the URL in quotes, you must escape each forward slash (/) with another, for example: url="http:////10.172.77.200//ovs"
enabled= { Yes | No }	Whether to enable the repository.
pkgSignatureType= { NONE | GPG | CA }	The signature type to verify the validity of the repository, either GPG key (or GnuPG key), CA (Certificate Authority). Use NONE if there is no verification required.
pkgSignatureKey=value	The verification signature for the repository, for example, the location of the GPG key using any of the HTTP, FTP, FILE or HTTPS protocols. If you enclose the value for the option in quotes, you must escape each forward slash (/) with another, for example: pkgSignatureKey="http:////10.172.77.200//ovs//RPM-GPG-KEY"
name=value	A name to identify the server update repository.
description=value	Optional description for the server update repository. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServerPool.

Examples

Example A.110 Editing an Oracle VM Server update repository

OVM> edit ServerUpdateRepository url=http://10.172.77.200/ovs enabled=No pkgSignatureType=GPG \
   pkgSignatureKey=http://10.172.77.200/ovs/RPM-GPG-KEY-oracle

See Also

• Section A.48, “create ServerUpdateRepository”

• Section A.47, “create ServerUpdateGroup”

• Section A.84, “edit ServerUpdateGroup”

• Section A.19, “checkUpToDate”

• Section A.181, “upgrade”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.86 edit StorageArray

Edits a storage array.

Syntax

edit StorageArray instance [ plugin=value ] [ storageName=value ] [ useChap= { Yes | No } ] [ adminHost=value adminUserName=value adminPassword=value ] [ name=value ] [ description=value ] [ lipScan= { Yes | No } ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of a storage array.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
plugin=value	The name or ID for the Oracle VM Storage Connect plug-in for the storage array. To see a list of the available plug-ins, use the list StorageArrayPlugin command.
storageName=value	The storage name associated with the storage array. The storage name uniquely identifies the correct storage array if multiple storage devices are concentrated behind a single endpoint.
useChap= { Yes | No }	Whether to use CHAP authentication.
adminHost=value	The host name or IP address where administrative access to the storage array is allowed.
adminUserName=value	A user name with administrative access to the storage array, used with adminHost.
adminPassword=value	The administrator password for the adminUserName user.
name=value	A name to identify the storage array.
description=value	Optional description for the storage array. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyStorageArray.
lipScan= { Yes | No }	Whether to request each Unmanaged FibreChannel Storage Array Admin Server to initiate a Loop Initialization Protocol (LIP) during a refresh. Note This option is only applicable to an Unmanaged FibreChannel Storage Array.

Examples

Example A.111 Editing the name of a storage array

OVM> edit StorageArray name=MyISCSIServer name="My ISCI Server"

See Also

• Section A.49, “create StorageArray”

• Section A.11, “add Server”

• Section A.154, “remove Server”

• Section A.4, “addAdminServer”

• Section A.147, “removeAdminServer”

• Section A.182, “validate”

• Section A.142, “refresh”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.87 edit StorageArrayPlugin

Edits a storage array plug-in.

Syntax

edit StorageArrayPlugin instance [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of a storage array plug-in. You cannot create or delete a storage array plug-in; you can only edit the name and description.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
name=value	A name to identify the storage array plug-in.
description=value	Optional description for the storage array plug-in. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyStorageArrayPlugin.

Examples

Example A.112 Editing a storage array plug-in

OVM> edit StorageArrayPlugin name="oracle.generic.SCSIPlugin.GenericPlugin (1.1.0)" \
  description="Generic storage array plug-in"

See Also

• Section A.182, “validate”

• Section A.138, “list”

• Section A.171, “show”

A.88 edit Tag

Edits a tag.

Syntax

edit Tag instance name=value [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of a tag used to identify and group objects.

Options

The following table shows the available options for this command.

Option	Description
name=value	A name to identify the tag.
description=value	Optional description for the tag. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyTag.

Examples

Example A.113 Editing a tag

OVM> edit Tag name=MyTag name=MyNewTagName description="My new tag name."

See Also

• Section A.50, “create Tag”

• Section A.14, “add Tag”

• Section A.157, “remove Tag”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.89 edit VirtualAppliance

Edits a virtual appliance.

Syntax

edit VirtualAppliance instance [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of a VirtualAppliance object.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
name=value	A name to identify the virtual appliance.
description=value	Optional description for the virtual appliance. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVirtualAppliance.ova.

Examples

Example A.114 Editing a virtual appliance

OVM> edit VirtualAppliance name=virtualappliance.ova description='Oracle Linux Release 6'

See Also

• Section A.90, “edit VirtualApplianceVirtualDisk”

• Section A.91, “edit VirtualApplianceVm”

• Section A.32, “createVmFromVirtualAppliance”

• Section A.33, “createVmFromVirtualApplianceVm”

• Section A.133, “importVirtualAppliance”

• Section A.106, “exportVirtualAppliance”

• Section A.111, “getDescriptor”

• Section A.59, “delete”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

A.90 edit VirtualApplianceVirtualDisk

Edits a virtual disk in a virtual appliance.

Syntax

edit VirtualApplianceVirtualDisk instance [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of a virtual disk in a virtual appliance. You cannot delete a VirtualApplianceVirtualDisk object. You can only delete it by deleting the virtual appliance itself.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
name=value	A name to identify the virtual appliance virtual disk.
description=value	Optional description for the virtual appliance virtual disk. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVirtualApplianceVirtualDisk.

Examples

Example A.115 Editing a virtual appliance virtual disk

OVM> edit VirtualApplianceVirtualDisk name=MyVirtualApplianceVirtualDisk description='Oracle Linux Release 6'

See Also

• Section A.89, “edit VirtualAppliance”

• Section A.91, “edit VirtualApplianceVm”

• Section A.32, “createVmFromVirtualAppliance”

• Section A.33, “createVmFromVirtualApplianceVm”

• Section A.133, “importVirtualAppliance”

• Section A.106, “exportVirtualAppliance”

• Section A.111, “getDescriptor”

• Section A.59, “delete”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

A.91 edit VirtualApplianceVm

Edits a virtual machine in a virtual appliance.

Syntax

edit VirtualApplianceVm instance [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of a virtual machine in a virtual appliance. You cannot delete a VirtualApplianceVm object. You can only delete it by deleting the virtual appliance itself.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
name=value	A name to identify the virtual appliance virtual machine.
description=value	Optional description for the virtual appliance virtual machine. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVirtualApplianceVM.

Examples

Example A.116 Editing a virtual appliance virtual machine

OVM> edit VirtualApplianceVm name=MyVirtualApplianceVm description='Oracle Linux Release 6'

See Also

• Section A.89, “edit VirtualAppliance”

• Section A.90, “edit VirtualApplianceVirtualDisk”

• Section A.32, “createVmFromVirtualAppliance”

• Section A.33, “createVmFromVirtualApplianceVm”

• Section A.133, “importVirtualAppliance”

• Section A.106, “exportVirtualAppliance”

• Section A.111, “getDescriptor”

• Section A.59, “delete”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

A.92 edit VirtualCdrom

Edits an ISO file/CDROM.

Syntax

edit VirtualCdrom instance [ sharable= { Yes | No } ] [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of an ISO file/CDROM.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
sharable= { Yes | No }	Whether the ISO file/CDROM may be shared.
name=value	A name to identify the ISO file/CDROM.
description=value	Optional description for the ISO file/CDROM. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyISOFile.

Examples

Example A.117 Editing a ISO file/CDROM

OVM> edit VirtualCdrom id=0004fb0000150000cd7223d8105042c5.iso name="OL6" \
  description="Oracle Linux 6"

See Also

• Section A.134, “importVirtualCdrom”

• Section A.25, “cloneCdToRepo”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.93 edit VirtualDisk

Edits a virtual disk.

Syntax

edit VirtualDisk instance [ shareable= { Yes | No } ] [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of a virtual disk in a storage repository. To resize a virtual disk, use the resize command.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
shareable= { Yes | No }	Whether the virtual disk is shareable. Shareable disks have read/write privileges in multiple virtual machines and should be used with caution.
name=value	A name to identify the virtual disk.
description=value	Optional description for the virtual disk. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVirtualDisk.

Examples

Example A.118 Editing a virtual disk

OVM> edit VirtualDisk name=MyVMDisk name='New name for MyVMDisk' description='My virtual disk'

See Also

• Section A.135, “importVirtualDisk”

• Section A.51, “create VirtualDisk”

• Section A.161, “resize”

• Section A.59, “delete”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.94 edit VlanInterface

Edits a VLAN interface.

Syntax

edit VlanInterface instance [ mtu=value ] [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of a VLAN interface.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
mtu=value	The MTU value. May be an integer between 1500 and 64000.
name=value	A name to identify the VLAN interface.
description=value	Optional description for the VLAN interface. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVlanInterface.

Examples

Example A.119 Editing a VLAN interface

OVM> edit VlanInterface name=MyVlanInterface mtu=1500

See Also

• Section A.52, “create VlanInterface”

• Section A.15, “add VlanInterface”

• Section A.158, “remove VlanInterface”

• Section A.102, “embeddedCreate”

• Section A.103, “embeddedDelete”

• Section A.104, “embeddedEdit”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.95 edit Vm

Edits a virtual machine.

Syntax

edit Vm instance [ memory=value ] [ memoryLimit=value ] [ cpuCount=value ] [ cpuCountLimit=value ] [ cpuPriority=value ] [ cpuUtilizationCap=value ] [ highAvailability= { Yes | No } ] [ hugePagesEnabled= { Yes | No } ] [ osType=value ] [ restartActionOnCrash= { RESTART | STOP | RESTART_AFTER_DUMP | STOP_AFTER_DUMP } ] [ mouseType= { OS_DEFAULT | PS2_MOUSE | USB_MOUSE | USB_TABLET } ] [ domainType= { XEN_HVM | XEN_HVM_PV_DRIVERS | XEN_PVM | LDOMS_PVM | UNKNOWN } ] [ keymapName= { en-us | ar | da | de | de-ch | en-gb | es | et | fi | fo | fr | fr-be | fr-ca | fr-ch | hr | hu | is | it | ja | lt | lv | mk | nl | nl-be | No | pl | pt | pt-br | ru | sl | sv | th | tr } ] [ bootOrder= { PXE | DISK | CDROM } ] [ networkInstallpath=value ] [ startPolicy= { BEST_SERVER | BALANCE_SERVER | CURRENT_SERVER | USE_POOL_POLICY } ] [ viridian= { Yes | No } ] [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of a virtual machine to change the configuration options.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
memory=value	The memory size the virtual machine is allocated in MB. May be an integer between 32 and 512000. The default is 512.
memoryLimit=value	The maximum memory size the virtual machine can be allocated in MB. May be an integer between 32 and 512000. The default is 512.
cpuCount=value	The number of processors the virtual machine is allocated. May be an integer between 1 and 999999, but cannot exceed the maximum limit for the domain type, as follows: PVM: 256. Important As of Oracle VM Release 3.4.6, support for PVM guests is removed. For more information, see Disabling Paravirtualized Guests on Oracle VM Server in the Oracle VM Administrator's Guide. HVM: 128; or 32 for Microsoft Windows guests. Note As of Release 3.4.6, the HVM limit is 64 for Microsoft Windows guests. PVHVM: 128; or 32 if using Oracle VM Paravirtual Drivers for Microsoft Windows. Note As of Release 3.4.6, the PVHVM limit is 64 if using Oracle VM Paravirtual Drivers for Microsoft Windows. LDOMS_PVM: Equivalent to the number of available CPUs on the server.
cpuCountLimit=value	The maximum number of processors the virtual machine can be allocated. May be an integer between 1 and 999999, but cannot exceed the maximum limit for the domain type, as follows: PVM: 256. Important As of Oracle VM Release 3.4.6, support for PVM guests is removed. For more information, see Disabling Paravirtualized Guests on Oracle VM Server in the Oracle VM Administrator's Guide. HVM: 128; or 32 for Microsoft Windows guests. Note As of Release 3.4.6, the HVM limit is 64 for Microsoft Windows guests. PVHVM: 128; or 32 if using Oracle VM Paravirtual Drivers for Microsoft Windows. Note As of Release 3.4.6, the PVHVM limit is 64 if using Oracle VM Paravirtual Drivers for Microsoft Windows. LDOMS_PVM: Equivalent to the number of available CPUs on the server.
cpuPriority=value	The CPU priority of the virtual machine. A value between 1 and 100; the higher the number, the more priority the CPU is given.
cpuUtilizationCap=value	The maximum percentage to which the virtual CPUs can receive scheduled time. A value between 10 and 100; the higher the number, the more scheduled time the CPU is given.
highAvailability= { Yes | No }	Whether to enable High Availability (HA).
hugePagesEnabled= { Yes | No }	Whether to enable HugePages. Note The HugePages feature is deprecated in Oracle VM Release 3.4.1. You should not enable HugePages when creating or editing virtual machines in the Oracle VM Manager Web Interface or Oracle VM Manager Command Line Interface. This feature will be removed in a future release of Oracle VM. If you have HugePages enabled for any PVM guests, Oracle recommends that you change the domain type for virtual machines from Paravirtualized (PVM) to Hardware virtualized, with paravirtualized drivers (PVHVM). If you cannot change the domain type for a virtual machine, you should disable the HugePages setting and then restart the virtual machine.
osType= value	The operating system of the virtual machine. To find the operating system type, use the getVmOsTypes command.
[ restartActionOnCrash= { RESTART | STOP | RESTART_AFTER_DUMP | STOP_AFTER_DUMP } ]	The action to perform in the case where a virtual machine crashes. This option must only be used for virtual machines that are running on the Xen hypervisor and that have been configured to run on a particular Oracle VM Server. Note that in the case where High Availability (HA) is enabled for a virtual machine, the virtual machine is always restarted in the event of a crash, since HA takes precedence over this setting. Therefore, you should be aware that if the highAvailability parameter is set to the value of Yes, any value for this option, other than RESTART and RESTART_AFTER_DUMP, is effectively ignored. If you select and option to generate a core dump file, you should be aware that these are saved to /var/xen/dump on the Oracle VM Server where the virtual machine is hosted. Each core dump file is named uniquely so that files are not overwritten. This can use up disk space rapidly. You must ensure that there is either enough disk space available at this path on the Oracle VM Server where the virtual machine will run; or you should mount additional storage at this path to avoid using up disk space required to host dom0.
mouseType= { OS_DEFAULT | PS2_MOUSE | USB_MOUSE | USB_TABLET }	The mouse type of the virtual machine.
domainType= { XEN_HVM | XEN_HVM_PV_DRIVERS | XEN_PVM | LDOMS_PVM | UNKNOWN }	The domain type of the virtual machine.
keymapName= { en-us | ar | da | de | de-ch | en-gb | es | et | fi | fo | fr | fr-be | fr-ca | fr-ch | hr | hu | is | it | ja | lt | lv | mk | nl | nl-be | No | pl | pt | pt-br | ru | sl | sv | th | tr }	The keyboard mapping to use for the virtual machine.
bootOrder= { PXE | DISK | CDROM }	The boot media order for the virtual machine. Enter options separated by commas (,), for example: bootOrder='CDROM,DISK' If you use the PXE boot option to boot from network-based installation media, also use the networkInstallpath parameter. To set an empty bootOrder option, use bootOrder="".
networkInstallpath=value	The location at which the installation media (mounted ISO file) is located when creating a PVM guest.
startPolicy= { BEST_SERVER | BALANCE_SERVER | CURRENT_SERVER | USE_POOL_POLICY }	Optional virtual machine start up policy.
viridian= { Yes | No }	Viridian support enables the exposure of Windows virtualization compatible entitlements to Microsoft Windows guest operating systems. Enabling viridian support is strongly recommended to ensure improved performance for Microsoft Windows guest operating systems. Enabling viridian support is permitted for all Microsoft Windows guest operating system types. However, it is only effective from Microsoft Windows Vista and Microsoft Windows Server 2008 onwards.
name=value	A name to identify the virtual machine.
description=value	Optional description for the virtual machine. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVM.

Examples

Example A.120 Edit a virtual machine

OVM> edit Vm name=MyVM bootOrder='CDROM,DISK' startPolicy=BEST_SERVER

See Also

• Section A.126, “getVmOsTypes”

• Section A.24, “clone Vm”

• Section A.16, “add Vm”

• Section A.177, “start”

• Section A.138, “list”

• Section A.171, “show”

A.96 edit VmCloneCustomizer

Edits an existing clone customizer for a virtual machine.

Syntax

edit VmCloneCustomizer instance [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command allows you to edit an existing clone customizer for a virtual machine.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
name=value	A name to identify the clone customizer. Tip To find this name after the clone customizer has been created on a virtual machine, use the list VmCloneCustomizer command. You need the name or ID of this to delete a clone customizer from a virtual machine with the delete VmCloneCustomizer command.
description=value	Optional description for the clone customizer object. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVMCloneCustomizer.

Examples

Example A.121 Edit a virtual machine clone customizer

OVM> edit VmCloneCustomizer name=MyVmCloneCustomizer name=MyCloneCustomizer \
description="A test clone customizer"

See Also

• Section A.98, “edit VmCloneStorageMapping”

• Section A.97, “edit VmCloneNetworkMapping”

• Section A.54, “create VmCloneCustomizer”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.97 edit VmCloneNetworkMapping

Edits an existing network mapping for a virtual machine clone customizer.

Syntax

edit VmCloneNetworkMapping instance [ network=value ] [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

Edits an existing network mapping for a virtual machine clone customizer.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
network=value	The name or ID value of an existing network.
name=value	A name to identify the clone network mapping.
description=value	Optional description for the clone network mapping object. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyCloneNet.

Examples

Example A.122 Editing a virtual machine clone network mapping

OVM> edit VmCloneNetworkMapping name=MyCloneNet description="A clone network mapping"

See Also

• Section A.54, “create VmCloneCustomizer”

• Section A.55, “create VmCloneNetworkMapping”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.98 edit VmCloneStorageMapping

Edits an existing clone customizer storage mapping.

Syntax

edit VmCloneStorageMapping instance [ cloneType= { SPARSE_COPY | NON_SPARSE_COPY | THIN_CLONE } ] { physicalDisk=value | repository=value | storageArray=value } [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

Edits an existing clone customizer storage mapping.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
cloneType= { SPARSE_COPY | NON_SPARSE_COPY | THIN_CLONE }	The type of clone storage that should be created.
{ physicalDisk=value | repository=value | storageArray=value }	The name or ID of either a physicalDisk, repository or storageArray object where the clone disk is located.
name=value	A name to identify the clone storage mapping.
description=value	Optional description for the clone storage mapping object. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVMCloneStorage.

Examples

Example A.123 Editing a virtual machine clone storage mapping

OVM> edit VmCloneStorageMapping name=MyVMCloneStorage cloneType=THIN_CLONE

See Also

• Section A.54, “create VmCloneCustomizer”

• Section A.98, “edit VmCloneStorageMapping”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.99 edit VmDiskMapping

Edits the virtual machine disk mapping object.

Syntax

edit VmDiskMapping instance [ virtualCd=instance ] [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the virtual machine disk mapping object. Do not use this command to change the disk mapping in a virtual machine, this is just for the object that contains the disk mapping information. To edit a virtual disk or CDROM mapped to a virtual machine, remove it using the delete VmDiskMapping command, then use the create VmDiskMapping command again to remap it to a virtual machine with any changed settings.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
virtualCd=instance	The name or ID of the ISO file (virtual CDROM).
name=value	A name to identify the disk mapping. Tip To find this name after a virtual disk is mapped to a virtual machine, use the list VmDiskMapping command.
description=value	Optional description for the disk mapping object. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyDiskMap.

Examples

Example A.124 Editing a virtual disk mapping object

OVM> edit VmDiskMapping id=0004fb0000130000409cd9340443e257 name=MyDiskMap

See Also

• Section A.57, “create VmDiskMapping”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.100 edit Vnic

Edits a VNIC.

Syntax

edit Vnic instance [ name=value ] [ description=value ] [ macAddress=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of a VNIC on a network.

To change the network assignment of a VNIC, please see Section A.17, “add Vnic”.

Options

The following table shows the available options for this command.

Option	Description
name=value	A name for the VNIC.
description=value	Optional description for the VNIC. value is a maximum of 4,000 characters. To set an empty description, use description="".
macAddress=value	The MAC address that should be applied to this VNIC.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVNIC.

Examples

Example A.125 Editing a VNIC

OVM> edit Vnic id=0004fb00000700007fa68ffd2011539f name=Server1Vnic macAddress=00:21:f6:00:00:18

See Also

• Section A.58, “create Vnic”

• Section A.17, “add Vnic”

• Section A.160, “remove Vnic”

• Section A.170, “setVnicMacAddrRange”

• Section A.129, “getVnicMacAddrRange”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.101 edit VolumeGroup

Edits a volume group object.

Syntax

edit VolumeGroup instance [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of a volume group object.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
network=value	The name or ID of the volume group object.
name=value	A name for the volume group object.
description=value	Optional description for the volume group object. value is a maximum of 4,000 characters. To set an empty description, use description="".
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVolumeGroup.

Examples

Example A.126 Editing a volume group

OVM> edit VolumeGroup name=MyVolumeGroup name=MyNewName

See Also

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.102 embeddedCreate

Creates an IP address object and adds it to a network related object.

Syntax

embeddedCreate { BondPort | Port | VlanInterface } instance ipAddressConfig ipAddressConfigType= { STATIC | DYNAMIC } [ ipAddress=value ] [ ipNetmask=value ]

Where instance is:

{ id=value | name=value }

Description

This command adds an IP address and its associated configuration (ipAddressConfig object) to a bond port, port, or VLAN interface. Note that if the ipAddressConfigType is set to DYNAMIC, then any values specified for ipAddress or ipNetmask are ignored.

Options

The following table shows the available options for this command.

Option	Description
{ BondPort | Port | VlanInterface }	The network related object to which to add the IP address (ipAddressConfig object).
ipAddressConfigType= { STATIC | DYNAMIC }	The IP addressing configuration type.
[ ipAddress=value ]	The IP address. Note that this value is ignored if the ipAddressConfigType is set to DYNAMIC.
[ ipNetmask=value ]	The netmask. Note that this value is ignored if the ipAddressConfigType is set to DYNAMIC.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyPort.

Examples

Example A.127 Adding an IP address to a port

OVM> embeddedCreate Port id=0004fb00002000003ea1bffb91ece960 ipAddressConfig \
  ipAddressConfigType=STATIC ipAddress=10.172.76.100 ipNetmask=255.255.254.0

Example A.128 Adding an IP address to a bond port

OVM> embeddedCreate BondPort id=0004fb00002000000a5389824228bdf1 ipAddressConfig \
  ipAddressConfigType=STATIC ipAddress=10.172.76.100 ipNetmask=255.255.254.0

See Also

• Section A.103, “embeddedDelete”

• Section A.104, “embeddedEdit”

• Section A.138, “list”

• Section A.171, “show”

A.103 embeddedDelete

Deletes an IP address object and removes it from a network related object.

Syntax

embeddedDelete { BondPort | Port | VlanInterface } instance ipAddressConfig id=value

Where instance is:

{ id=value | name=value }

Description

This command removes an IP address and its associated configuration (ipAddressConfig object) from a bond port, port, or VLAN interface.

Options

The following table shows the available options for this command.

Option	Description
{ BondPort | Port | VlanInterface }	The network related object from which to remove the IP address (ipAddressConfig object).
id=value	The index value of the ipAddressConfig object. To find the index value, use the show command and look for the embedded object's IP address information. For example, to find the index value for an IP address object on a port: OVM> show Port id=0004fb00002000003ea1bffb91ece960 ... Ip Address Config 1 - Address Type = Ipv4 Ip Address Config 1 - Config Type = Static Ip Address Config 1 - Address = 10.172.76.100 Ip Address Config 1 - Netmask = 255.255.254.0 Interface Name = eth2 ... The index value in this case is 1.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyPort.

Examples

Example A.129 Deleting an IP address from a port

OVM> embeddedDelete Port id=0004fb00002000003ea1bffb91ece960 ipAddressConfig id=1

Example A.130 Deleting an IP address from a bond port

OVM> embeddedDelete BondPort id=0004fb00002000000a5389824228bdf1 ipAddressConfig id=1

See Also

• Section A.102, “embeddedCreate”

• Section A.104, “embeddedEdit”

• Section A.138, “list”

• Section A.171, “show”

A.104 embeddedEdit

Edits an IP address object on a network related object.

Syntax

embeddedEdit { BondPort | Port | VlanInterface } instance ipAddressConfig id=value ipAddressConfigType= { STATIC | DYNAMIC } [ ipAddress=value ] [ ipNetmask=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of an IP address and its associated configuration (ipAddressConfig object) on a bond port, port, or VLAN interface. Note that if the ipAddressConfigType is set to DYNAMIC, then any values specified for ipAddress or ipNetmask are ignored.

Options

The following table shows the available options for this command.

Option	Description
{ BondPort | Port | VlanInterface }	The network related object on which to edit the IP address (ipAddressConfig object).
id=value	The index value of the ipAddressConfig object. To find the index value, use the show command and look for the embedded object's IP address information. For example, to find the index value for an IP address object on a port: OVM> show Port id=0004fb00002000003ea1bffb91ece960 ... Ip Address Config 1 - Address Type = Ipv4 Ip Address Config 1 - Config Type = Static Ip Address Config 1 - Address = 10.172.76.100 Ip Address Config 1 - Netmask = 255.255.254.0 Interface Name = eth2 ... The index value in this case is 1.
ipAddressConfigType= { STATIC | DYNAMIC }	The IP addressing configuration type.
[ ipAddress=value ]	The IP address. Note that this value is ignored if the ipAddressConfigType is set to DYNAMIC.
[ ipNetmask=value ]	The netmask. Note that this value is ignored if the ipAddressConfigType is set to DYNAMIC.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyPort.

Examples

Example A.131 Editing an IP address on a port

OVM> embeddedEdit Port id=0004fb00002000003ea1bffb91ece960 ipAddressConfig \
  id=1 ipAddressConfigType=STATIC ipAddress=10.172.76.100 ipNetmask=255.255.254.0

Example A.132 Editing an IP address on a bond port

OVM> embeddedEdit BondPort id=0004fb00002000000a5389824228bdf1 ipAddressConfig \
  id=1 ipAddressConfigType=STATIC ipAddress=10.172.76.100 ipNetmask=255.255.254.0

See Also

• Section A.102, “embeddedCreate”

• Section A.103, “embeddedDelete”

• Section A.138, “list”

• Section A.171, “show”

A.105 exit

Exits/Quits the CLI.

Syntax

exit

Description

This command exits/quits the CLI.

Options

This command does not take any arguments or provide any options.

Examples

Example A.133 Exiting the CLI

OVM> exit  

See Also

• Section A.130, “help”

A.106 exportVirtualAppliance

Exports a virtual appliance to a storage repository.

Syntax

exportVirtualAppliance Repository instance name=value vms=value

Where instance is:

{ id=value | name=value }

Description

This command creates a virtual appliance from one or more virtual machines, then saves the virtual appliance in a storage repository.

Options

The following table shows the available options for this command.

Option	Description
Repository instance	The storage repository in which to export the virtual appliance.
name=value	The name of the virtual appliance.
vms=value	The names or IDs of the virtual machines to be exported in the virtual appliance, in a comma separated list. Note Virtual machines must be in the Stopped state before you can export them.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyRepository.

Examples

Example A.134 Exporting a virtual appliance to a storage repository

OVM> exportVirtualAppliance Repository name=MyRepository name=MyVirtualAppliance \
  vms=0004fb00000600004b291334d6730d57,0004fb00000600006c67aa9bfb6ca0f6

See Also

• Section A.32, “createVmFromVirtualAppliance”

• Section A.33, “createVmFromVirtualApplianceVm”

• Section A.133, “importVirtualAppliance”

• Section A.89, “edit VirtualAppliance”

• Section A.90, “edit VirtualApplianceVirtualDisk”

• Section A.91, “edit VirtualApplianceVm”

• Section A.111, “getDescriptor”

• Section A.59, “delete”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

A.107 getArchiveConfig

Shows the configuration for managing archived statistics.

Syntax

getArchiveConfig

Description

This command shows the configuration for how Oracle VM Manager manages archived statistics. To set the configuration, use the setArchiveConfig command.

Options

This command does not take any arguments or provide any options.

Examples

Example A.135 Showing the configuration for managing archived statistics

OVM> getArchiveConfig

See Also

• Section A.166, “setArchiveConfig”

A.108 getAverageStat

Lists the average value of a statistic type for an object during a time range.

Syntax

getAverageStat objType= { Server | Vm | FileSystem } objId=value statType= { CPU_UTILIZATION | CPU_COUNT | MEMORY_USED | FREE_MEMORY | MEMORY_UTILIZATION | FILE_SYSTEM_SPACE_FREE | FILE_SYSTEM_SPACE_UTILIZATION | FILE_SYSTEM_SPACE_TOTAL } startTime=value [ endTime=value ]

Description

This command lists the average statistic for an object during a time range. Statistics are held for a limited amount of time and there may be no statistics of the particular type that occurred during all or part of the specified time range.

Options

The following table shows the available options for this command.

Option	Description
objType= { Server | Vm | FileSystem }	The object type for which to list the average statistic. The value of objType may be Server, Vm, or FileSystem. The value for objType is case insensitive.
objId=value	The name or ID of the object for which statistics should be listed. This must be the ID of a Server, Vm, or FileSystem object.
statType= { CPU_UTILIZATION | CPU_COUNT | MEMORY_USED | FREE_MEMORY | MEMORY_UTILIZATION | FILE_SYSTEM_SPACE_FREE | FILE_SYSTEM_SPACE_UTILIZATION | FILE_SYSTEM_SPACE_TOTAL }	The type of statistic to list: CPU_UTILIZATION: The percentage of the total CPU power being used by the object CPU_COUNT: The number of CPUs. MEMORY_USED: The amount of memory, in MBs, used by the object. FREE_MEMORY: The amount of memory, in MBs, available on the server. MEMORY_UTILIZATION: The percentage of the total memory being used by the object. FILE_SYSTEM_SPACE_FREE: The amount of file system space, in GiB, that is not currently used. FILE_SYSTEM_SPACE_UTILIZATION: The percentage of the total file system space currently in use. FILE_SYSTEM_SPACE_TOTAL: The total size of the file system, in GiB. The FILE_SYSTEM_SPACE_FREE, FILE_SYSTEM_SPACE_UTILIZATION, FILE_SYSTEM_SPACE_TOTAL parameters are supported for the FileSystem object type only. The CPU_COUNT parameter is not supported by the Server object type. An error is returned when an incompatible object type and parameter are requested. A value of 0 may be returned for any parameter if there are no statistics available for the object on Oracle VM Manager
startTime=value	The start date and time from which to list the average statistic. The format to use is "MM-dd-yyyy HH:mm". The value must not be later than the current time or after the value of endTime.
endTime=value	The end date and time from which to list the average statistic. The format to use is "MM-dd-yyyy HH:mm". This is an optional parameter.

Examples

Example A.136 Listing average statistics for an Oracle VM Server

OVM> getAverageStat objType=Server objId=00:e0:81:4d:41:05:00:e0:81:4d:40:de:00:e0:81:4d \
  statType=CPU_UTILIZATION startTime="08-20-2014 00:00"

See Also

• Section A.116, “getLatestStat”

• Section A.117, “getLatestStatForList”

• Section A.121, “getStatList”

• Section A.122, “getStatListByQuery”

• Section A.169, “setStatsConfig”

• Section A.120, “getStatsConfig”

• Section A.138, “list”

• Section A.171, “show”

A.109 getDbBackupConfig

Shows the configuration for the automated database backup facility within Oracle VM Manager.

Syntax

getDbBackupConfig

Description

This command shows the configuration for the automated database backup facility within Oracle VM Manager. Further information on the automated database backup facility is provided in Backing up the MySQL Database Repository in the Oracle VM Administrator's Guide.

Options

This command does not take any arguments or provide any options.

Examples

Example A.137 Showing the Oracle VM Manager database backup configuration

OVM> getDbBackupConfig  

See Also

• Section A.167, “setDbBackupConfig”

A.110 getDebugTranscript

Shows the debug transcript of a job.

Syntax

getDebugTranscript Job instance

Where instance is:

{ id=value | name=value }

Description

This command shows shows the debug transcript of a job.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyJob.

Examples

Example A.138 Showing the debug transcript of a job

OVM> getDebugTranscript Job id=1373345941846

See Also

• Section A.1, “abort Job”

• Section A.115, “getJobs”

• Section A.138, “list”

• Section A.171, “show”

A.111 getDescriptor

Lists the descriptor file for a virtual appliance or assembly.

Syntax

getDescriptor { Assembly | VirtualAppliance } instance

Where instance is:

{ id=value | name=value }

Description

This command lists the descriptor file for a virtual appliance or assembly. The descriptor (.ovf file) is the main file in a virtual appliance or assembly package, and contains meta-data for the virtual appliance or assembly, including links to external files, such as virtual disks.

Important

The Assembly option has been deprecated. You should instead use VirtualAppliance.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVirtualAppliance.

Examples

Example A.139 Listing the descriptor for a virtual appliance

OVM> getDescriptor VirtualAppliance name=MyVirtualAppliance.ova

See Also

• Section A.131, “importAssembly (Deprecated)”

• Section A.31, “createVmFromAssembly (Deprecated)”

• Section A.24, “clone Vm”

• Section A.63, “edit Assembly (Deprecated)”

• Section A.64, “edit AssemblyVirtualDisk (Deprecated)”

• Section A.65, “edit AssemblyVm (Deprecated)”

• Section A.59, “delete”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

A.112 getEventListByQuery

Lists the events for an object using a query to narrow results.

Syntax

getEventListByQuery [ [ objType=value ] [ objIds=value ] ] [ severity= { UNKNOWN | CRITICAL | WARNING | INFORMATIONAL } ] severityEqualityType= { LT | LTE | GT | GTE | EQ | NE } [ eventTypes= value ] eventEqualityType= { LIKE | NOT_LIKE } [ acknowledged= { Yes | No } ] [ userAckable= { Yes | No } ] [ startTime=value ] [ endTime=value ] [ maxResults=value ]

Description

This command lists the events for an object using a query to narrow results. To acknowledge an event, use the ackEvent command.

Options

The following table shows the available options for this command.

Option	Description
objType=value	The object type for which to list the events. The value of objType is an object such as FileServer, Repository, or Server. To get a list of all object types, use the showobjtypes. The value for objType is case insensitive. This is an optional parameter and must be used with the objIds option.
objIds=value	The ID of the objects for which events should be listed. To enter one or more objects, use a comma separated list. This is an optional parameter and must be used with the objType option.
severity= { UNKNOWN | CRITICAL | WARNING | INFORMATIONAL }	The severity of the event to list. Use this in combination with the equalityType option. The events are ranked in the order from low to high: UNKNOWN: The event does not have a specific severity. INFORMATIONAL: An event which is used to convey information about the system. WARNING: An event which is only likely to have a minor impact to system functionality. CRITICAL: An event which could cause a critical loss of functionality which requires immediate attention. When you use this in conjunction with the severityEqualityType option, the comparison is performed using this ranking. For example, if you use: severity=WARNING severityEqualityType=GTE All events greater than or equal to WARNING are returned. This means all WARNING and all CRITICAL events are returned. This is an optional parameter.
severityEqualityType= { LT | LTE | GT | GTE | EQ | NE }	The equality type for the severity comparison. Use this in combination with the severity option. The parameters are: LT: Less than (<). LTE: Less than or equal to (<=). GT: Greater than (>). GTE: Greater than or equal to (>=). EQ: Equal to (=). NE: Not equal to (<>, or !=).
eventTypes=value	The event type. Use this to filter the results to a specific event or events. For example: eventTypes=server.maintenance.mode. Note the period (.) at the end of the event type. This is important. You cannot truncate the event type; it must be in full. No wild cards are allowed. For a list of the available options, see Table A.1, “eventTypes Values”. For the most up-to-date list of event types, see the Oracle VM Manager Web Services API 3.4 documentation at: http://hostname/WSAPI/doc/api/webservices_s/com/oracle/ovm/mgr/ws/model/Event.html This documentation is available on the Oracle VM Manager ISO/CD. You should deploy it to a web server to access the content.
eventEqualityType= { LIKE | NOT_LIKE }	The event equality type for the event types comparison. Use this in combination with the eventTypes option. The parameters are: LIKE: Is like the value of eventTypes. NOT_LIKE: Is not like the value of eventTypes.
acknowledged= { Yes | No }	Whether to include acknowledged events in the listing. The default is No, so all events that have been acknowledged are not displayed. This is an optional parameter.
userAckable= { Yes | No }	Whether to include events that can be acknowledged by a user in the listing. The default is No, so all events that cannot be acknowledged by a user are removed from the results. This is an optional parameter.
startTime=value	The start date and time from which to list events. The format to use is "MM-dd-yyyy HH:mm:ss". This is an optional parameter.
endTime=value	The end date and time from which to list events. The format to use is "MM-dd-yyyy HH:mm:ss". This is an optional parameter.
maxResults=value	The maximum number of events to list. This is an optional parameter.

eventTypes Values

This table shows the available options for the eventTypes option of this command.

Table A.1 eventTypes Values

eventType Value	Event Severity	Description
Lifecycle Events
lifecycle.	INFORMATIONAL	This eventType is not used directly. However, you can use this when retrieving Events by type to retrieve all lifecycle eventTypes.
lifecycle.create.	INFORMATIONAL	Object has been created.
lifecycle.modify.	INFORMATIONAL	Object has been modified.
lifecycle.delete.	INFORMATIONAL	Object has been deleted.
Runstate Events
runstate.	INFORMATIONAL	This eventType is not used directly. However, you can use this when retrieving Events by type to retrieve all runstate eventTypes.
runstate.starting.	INFORMATIONAL	Object is in the process of starting.
runstate.running.	INFORMATIONAL	Object is running.
runstate.stopping.	INFORMATIONAL	Object is in the process of stopping.
runstate.stopped.	INFORMATIONAL	Object is stopped.
runstate.suspended.	INFORMATIONAL	Object is suspended.
Discover Events
discover.failure.	INFORMATIONAL	There was a failure during server discovery.
Virtual machine Events
vm.api.incomming.	INFORMATIONAL	Virtual machine incoming message.
vm.api.outgoing.	INFORMATIONAL	Virtual machine outgoing message.
vm.error.	CRITICAL	This eventType is not used directly. However, you can use this when retrieving Events by type to retrieve all vm.error eventTypes.
vm.error.disconnected.	CRITICAL	Virtual machine has disconnected.
vm.error.migration.	CRITICAL	Virtual machine migration failed.
vm.warn.migration.	WARNING	This eventType is not used directly. However, you can use this when retrieving Events by type to retrieve all vm.warn.migration eventTypes.
vm.warn.migration.src.	WARNING	Virtual machine migration warning from the server that holds the source (from) the virtual machine.
vm.warn.migration.tgt.	WARNING	Virtual machine migration warning from the server that is the target (to) for the virtual machine.
vm.domain.mismatch.	INFORMATIONAL	Virtual machine domain type mismatch.
vm.migrating.	INFORMATIONAL	Virtual machine is migrating.
vm.misplaced.	INFORMATIONAL	Virtual machine has been found on an incompatible server.
vm.os.mismatch.	INFORMATIONAL	Virtual machine operating system type mismatch.
vm.disk.missing.	CRITICAL	Virtual machine is missing a virtual disk.
vm.error.offline.	CRITICAL	Virtual machine is offline.
Server Events
server.failure.	CRITICAL	Server has experienced a failure.
server.discovery.failed.	CRITICAL	Server discovery has failed.
server.discovery.started.	INFORMATIONAL	Server discovery is in progress.
server.repository.error.	CRITICAL	The server repository has experienced an error.
server.cluster.failure.	CRITICAL	The server cluster has experienced a failure.
server.cluster.state.	INFORMATIONAL	This eventType is not used directly. However, you can use this when retrieving Events by type to retrieve all server.cluster.state eventTypes.
server.cluster.state.down	INFORMATIONAL	The server's cluster is down.
server.cluster.state.up	INFORMATIONAL	The server's cluster is up.
server.disconnected.	CRITICAL	The server has disconnected.
server.authentication.error.	CRITICAL	There was a server authentication error.
server.disk.reserved.	INFORMATIONAL	The server disk is reserved.
server.disk.unreserved.	INFORMATIONAL	The server disk is unreserved.
server.kernel.invalid.	CRITICAL	The server kernel is invalid.
server.maintenance.mode.	INFORMATIONAL	The server is in maintenance mode.
server.out.of.date.	INFORMATIONAL	The server software is out of date with regards to that found in the update repository.
server.pool.	INFORMATIONAL	This eventType is not used directly. However, you can use this when retrieving Events by type to retrieve all server.pool eventTypes.
server.pool.failure.	CRITICAL	There has been a failure with the server pool.
server.pool.file.system.missing.	CRITICAL	The server pool file system is missing.
server.pool.master.missing.	CRITICAL	Server pool is missing the master.
server.pool.vip.unavailable.	WARNING	Server pool virtual IP address is unavailable.
server.evacuate.failed.	WARNING	Server failed to evacuate.
server.mount.missing.	WARNING	Server mount is missing.
server.network.operation.failed.	WARNING	Server network operation failed.
server.offline.	CRITICAL	Server is offline.
server.ownership.mismatch.	WARNING	Server is owned by another Oracle VM Manager.
server.version.mismatch.	WARNING	There is an API version mismatch with the server.
server.update.repository.mismatch.	INFORMATIONAL	The repository information on the server is not the same as configured in Oracle VM Manager. This will trigger an update process so the information on the server is reconfigured.
server.update.repository.check.	INFORMATIONAL	Server is being checked if its software update repository is up to date.
server.update.repository.check.failed.	INFORMATIONAL	There was a failure during the update repository configuration.
server.update.repository.config.failed.	INFORMATIONAL	There was a failure during the repository configuration update check.
server.duplicate.storage.initiator.	WARNING	Server has a duplicate storage initiator.
server.network.mismatch.	WARNING	A networking device was found during discovery on this server with a network definition that includes the Virtual Machine role. This network already exists in Oracle VM Manager without the Virtual Machine role. This role will not be automatically added to the network and the server's view of the network is out of sync with Oracle VM Manager. If the Virtual Machine role is needed on this network, it will need to be added manually.
server.upgrade.in.progress.	INFORMATIONAL	Server upgrade in progress.
server.upgrade.config.in.progress.	INFORMATIONAL	A configuration of the server upgrade repositories is in progress.
File Server Events
fileserver.error.	CRITICAL	A critical fileserver error.
fileserver.invalid.exports.	CRITICAL	Invalid exports exist.
File System Events
filesystem.missing.	WARNING	File system is missing.
filesystem.size.mismatch.	CRITICAL	File system is larger than its underlying storage device.
Repository Events
repository.empty.	CRITICAL	Repository is empty.
repository.error.	CRITICAL	There is a repository error.
repository.missing.	WARNING	Repository is missing.
repository.unmounted.	CRITICAL	Repository is unmounted
Storage Device Events
storage.device.	INFORMATIONAL
storage.device.offline.	WARNING	Storage device is offline.
storage.device.online.	INFORMATIONAL	Storage device is online.
storage.device.off.path.	WARNING	At least one path is missing for storage element
Manager Events
mgr.db.scan.error.	CRITICAL	Database scan error.
mgr.db.scan.ok.	INFORMATIONAL	Database scan succeeded.
mgr.db.backup.fail.	WARNING	Database backup failed.
mgr.db.timeshift.	WARNING	System time has gone backwards.
Port Events
port.status.	INFORMATIONAL	This eventType is not used directly. However, you can use this when retrieving Events by type to retrieve all port.status eventTypes.
port.status.down.	INFORMATIONAL	Ethernet port is down.
port.status.up.	INFORMATIONAL	Ethernet port is up.
Path Events
path.status.	INFORMATIONAL	This eventType is not used directly. However, you can use this when retrieving Events by type to retrieve all path.status eventTypes.
path.status.down.	INFORMATIONAL	Storage path status is down.
path.status.up.	INFORMATIONAL	Storage path status is up.
path.missing.storage.device.	WARNING	Storage path is missing a storage device.
Volume Events
volume.group.missing.	CRITICAL	A volume group is missing.
Object Events
object.needs.refresh.	INFORMATIONAL	Object needs to be refreshed to obtain valid object information.

Examples

Example A.140 Listing all events

OVM> getEventListByQuery

Example A.141 Listing all events for specified Oracle VM Servers

OVM> getEventListByQuery objType=Server objIds=00:e0:81:4d:41:05:00:e0:81:4d:40:de:00:e0:81:4d, \
  00:e0:81:4d:41:59:00:e0:81:4d:41:2c:00:e0:81:4d

Example A.142 Listing events types for Oracle VM Servers

OVM> getEventListByQuery eventEqualityType=LIKE eventTypes=server.disconnected.

Example A.143 Listing high priority events for Oracle VM Servers

OVM> getEventListByQuery severity=WARNING severityEqualityType=GTE \
  eventTypes=server.disconnected. eventEqualityType=LIKE

See Also

• Section A.175, “showobjtypes”

• Section A.113, “getEvents”

• Section A.114, “getEventsForObject”

• Section A.2, “ackEvent”

A.113 getEvents

Lists the events for an object.

Syntax

getEvents [ [ objType=value ] [ objId=value ] ] [ severity= { UNKNOWN | CRITICAL | WARNING | INFORMATIONAL } ] [ acknowledged= { Yes | No } ] [ startTime=value ] [ endTime=value ] [ amount=value ]

Description

This command lists the event for an object. To acknowledge an event, use the ackEvent command.

Options

The following table shows the available options for this command.

Option	Description
objType=value	The object type for which to list the events. The value of objType is an object such as FileServer, Repository, or Server. To get a list of all object types, use the showobjtypes. The value for objType is case insensitive. This is an optional parameter and must be used with the objId option.
objId=value	The name or ID of the object. This is an optional parameter and must be used with the objType option.
severity= { UNKNOWN | CRITICAL | WARNING | INFORMATIONAL }	The severity of the event to list. The value returns events that match the given severity level as well as all events with a higher severity level. For example, specifying severity=WARNING returns all warning events and all critical events. The UNKNOWN option returns all events. This is an optional parameter.
acknowledged= { Yes | No }	Whether to include acknowledged events in the listing. The default is No, so all events that have been acknowledged are not displayed. This is an optional parameter.
startTime=value	The start date and time from which to list events. The format to use is "MM-dd-yyyy HH:mm:ss". This is an optional parameter.
endTime=value	The end date and time from which to list events. The format to use is "MM-dd-yyyy HH:mm:ss". This is an optional parameter.
amount=value	The maximum number of events to list. This is an optional parameter.

Examples

Example A.144 Listing all events

OVM> getEvents

Example A.145 Listing all critical error events

OVM> getEvents severity=CRITICAL

Example A.146 Listing Oracle VM Server events using all options

OVM> getEvents objType=Server objId=00:e0:81:4d:40:c6:00:e0:81:4d:40:c7:ff:ff:ff:ff \
  severity=UNKNOWN acknowledged=Yes startTime="05-20-2013 00:00:00" \
  endTime="05-21-2013 23:59:00" amount=100

Example A.147 Listing all unacknowledged critical error events for a virtual machine

OVM> getEvents objType=Vm objId=0004fb00001400003f45fc117b56c135 severity=CRITICAL \
  acknowledged=No

See Also

• Section A.175, “showobjtypes”

• Section A.114, “getEventsForObject”

• Section A.112, “getEventListByQuery”

• Section A.2, “ackEvent”

A.114 getEventsForObject

Lists the events for an object.

Syntax

getEventsForObject objType=value objId=value

Description

This command lists the events for an object. To acknowledge an event, use the ackEvent command.

Options

The following table shows the available options for this command.

Option	Description
objType=value	The object type for which to list the events. The value of objType is an object such as FileServer, Repository, or Server. To get a list of all object types, use the showobjtypes command. The value for objType is case insensitive.
objId=value	The name or ID of the object.

Examples

Example A.148 Listing events for an Oracle VM Server

OVM> getEventsForObject objType=Server objId=MyServer

See Also

• Section A.175, “showobjtypes”

• Section A.113, “getEvents”

• Section A.112, “getEventListByQuery”

• Section A.123, “getTriageEvent”

• Section A.2, “ackEvent”

A.115 getJobs

Lists jobs.

Syntax

getJobs [ startTime=value ] [ endTime=value ] [ amount=value ]

Description

This command lists all jobs, or jobs within a date range.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option	Description
startTime=value	The start date and time from which to list jobs. The format to use is "MM-dd-yyyy HH:mm".
endTime=value	The end date and time from which to list jobs. The format to use is "MM-dd-yyyy HH:mm".
amount=value	The number of jobs to list. For example, if you specify amount=2, the command returns the latest two jobs.

Examples

Example A.149 Listing jobs in a date range

OVM> getJobs startTime="07-20-2012 12:00" endTime="07-22-2012 24:00"

See Also

• Section A.119, “getQueuedJobInfo”

• Section A.110, “getDebugTranscript”

• Section A.1, “abort Job”

• Section A.138, “list”

• Section A.171, “show”

A.116 getLatestStat

Lists the latest value of a statistic type for an object.

Syntax

getLatestStat objType= { Server | Vm | FileSystem } objId=value statType= { CPU_UTILIZATION | CPU_COUNT | MEMORY_USED | FREE_MEMORY | MEMORY_UTILIZATION | FILE_SYSTEM_SPACE_FREE | FILE_SYSTEM_SPACE_UTILIZATION | FILE_SYSTEM_SPACE_TOTAL | FILE_SYSTEM_TOTAL_FILES_SIZE }

Description

This command lists the latest value of a statistic type for an object. Statistics are held for a limited amount of time and there may be no statistics of the particular type that occurred.

Options

The following table shows the available options for this command.

Option	Description
objType= { Server | Vm | FileSystem }	The object type for which to list the average statistic. The value of objType may be Server, Vm, or FileSystem. The value for objType is case insensitive.
objId=value	The name or ID of the object for which statistics should be listed. This must be the ID of a Server, Vm or FileSystem object.
statType= { CPU_UTILIZATION | CPU_COUNT | MEMORY_USED | FREE_MEMORY | MEMORY_UTILIZATION | FILE_SYSTEM_SPACE_FREE | FILE_SYSTEM_SPACE_UTILIZATION | FILE_SYSTEM_SPACE_TOTAL | FILE_SYSTEM_TOTAL_FILES_SIZE }	The type of statistic to list: CPU_UTILIZATION: The percentage of the total CPU power being used by the object CPU_COUNT: The number of CPUs. MEMORY_USED: The amount of memory, in MBs, used by the object. FREE_MEMORY: The amount of memory, in MBs, available on the server. MEMORY_UTILIZATION: The percentage of the total memory being used by the object. FILE_SYSTEM_SPACE_FREE: The amount of file system space, in GiB, that is not currently used. FILE_SYSTEM_SPACE_UTILIZATION: The percentage of the total file system space currently in use. FILE_SYSTEM_SPACE_TOTAL: The total size of the file system, in GiB. FILE_SYSTEM_SPACE_TOTAL: The total size of the file system, in GiB. FILE_SYSTEM_TOTAL_FILES_SIZE: The total of all the maximum sizes of all virtual disks on the file system, in GiB. The FILE_SYSTEM_SPACE_FREE, FILE_SYSTEM_SPACE_UTILIZATION, FILE_SYSTEM_SPACE_TOTAL, and FILE_SYSTEM_TOTAL_FILES_SIZE parameters are supported for the FileSystem object type only. The CPU_COUNT parameter is not supported by the Server object type. An error is returned when an incompatible object type and parameter are requested. A value of 0 may be returned for any parameter if there are no statistics available for the object on Oracle VM Manager

Examples

Example A.150 Listing latest statistics for an Oracle VM Server

OVM> getLatestStat objType=Server objId=00:e0:81:4d:41:05:00:e0:81:4d:40:de:00:e0:81:4d \
  statType=MEMORY_USED

See Also

• Section A.117, “getLatestStatForList”

• Section A.108, “getAverageStat”

• Section A.121, “getStatList”

• Section A.122, “getStatListByQuery”

• Section A.120, “getStatsConfig”

• Section A.169, “setStatsConfig”

• Section A.138, “list”

• Section A.171, “show”

A.117 getLatestStatForList

Lists the latest value of a statistic type for objects.

Syntax

getLatestStatForList objType= { Server | Vm | FileSystem } ids=value statType= { CPU_UTILIZATION | CPU_COUNT | MEMORY_USED | FREE_MEMORY | MEMORY_UTILIZATION | FILE_SYSTEM_SPACE_FREE | FILE_SYSTEM_SPACE_UTILIZATION | FILE_SYSTEM_SPACE_TOTAL }

Description

This command lists the latest value of a statistic type for objects.

Options

The following table shows the available options for this command.

Option	Description
objType= { Server | Vm | FileSystem }	The object type for which to list the average statistic. The value of objType may be Server, Vm, or FileSystem. The value for objType is case insensitive.
ids=value	A comma separated list of the IDs of the objects for which statistics should be listed. This must contain be the IDs of Server, Vm or FileSystem objects.
statType= { CPU_UTILIZATION | CPU_COUNT | MEMORY_USED | FREE_MEMORY | MEMORY_UTILIZATION | FILE_SYSTEM_SPACE_FREE | FILE_SYSTEM_SPACE_UTILIZATION | FILE_SYSTEM_SPACE_TOTAL }	The type of statistic to list: CPU_UTILIZATION: The percentage of the total CPU power being used by the object CPU_COUNT: The number of CPUs. MEMORY_USED: The amount of memory, in MBs, used by the object. FREE_MEMORY: The amount of memory, in MBs, available on the server. MEMORY_UTILIZATION: The percentage of the total memory being used by the object. FILE_SYSTEM_SPACE_FREE: The amount of file system space, in GiB, that is not currently used. FILE_SYSTEM_SPACE_UTILIZATION: The percentage of the total file system space currently in use. FILE_SYSTEM_SPACE_TOTAL: The total size of the file system, in GiB. The FILE_SYSTEM_SPACE_FREE, FILE_SYSTEM_SPACE_UTILIZATION, FILE_SYSTEM_SPACE_TOTAL parameters are supported for the FileSystem object type only. The CPU_COUNT parameter is not supported by the Server object type. An error is returned when an incompatible object type and parameter are requested. A value of 0 may be returned for any parameter if there are no statistics available for the object on Oracle VM Manager.

Examples

Example A.151 Listing latest statistics for Oracle VM Servers

OVM> getLatestStatForList objType=Server \
  ids=00:e0:81:4d:41:05:00:e0:81:4d:40:de:00:e0:81:4d,00:e0:81:4d:5f:2f:00:e0:81:4d:29:ee:00:e0:81:4d \
  statType=CPU_UTILIZATION

See Also

• Section A.116, “getLatestStat”

• Section A.108, “getAverageStat”

• Section A.121, “getStatList”

• Section A.122, “getStatListByQuery”

• Section A.120, “getStatsConfig”

• Section A.169, “setStatsConfig”

• Section A.138, “list”

• Section A.171, “show”

A.118 getManagerTime

Displays the time for Oracle VM Manager.

Syntax

getManagerTime

Description

This command displays the time for Oracle VM Manager.

Options

This command does not take any arguments or provide any options.

Examples

Example A.152 Display the Oracle VM Manager time

OVM> getManagerTime

A.119 getQueuedJobInfo

Lists information about a queued job.

Syntax

getQueuedJobInfo Job instance

Where instance is:

{ id=value | name=value }

Description

This command lists information about a queued job.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyJob.

Examples

Example A.153 Listing information about a queued job

OVM> getQueuedJobInfo Job id=1394647459371

See Also

• Section A.115, “getJobs”

• Section A.110, “getDebugTranscript”

• Section A.1, “abort Job”

• Section A.138, “list”

• Section A.171, “show”

A.120 getStatsConfig

Shows the configuration for the statistics displayed in Oracle VM Manager.

Syntax

getStatsConfig

Description

This command shows the configuration for the statistics displayed in Oracle VM Manager.

Options

This command does not take any arguments or provide any options.

Examples

Example A.154 Showing the Oracle VM Manager statistics configuration

OVM> getStatsConfig  

See Also

• Section A.169, “setStatsConfig”

• Section A.108, “getAverageStat”

• Section A.116, “getLatestStat”

• Section A.117, “getLatestStatForList”

• Section A.108, “getAverageStat”

A.121 getStatList

Lists statistic types for an object.

Syntax

getStatList objType= { Server | Vm | FileSystem } objId=value statType= { CPU_UTILIZATION | CPU_COUNT | MEMORY_USED | FREE_MEMORY | MEMORY_UTILIZATION | FILE_SYSTEM_SPACE_FREE | FILE_SYSTEM_SPACE_UTILIZATION | FILE_SYSTEM_SPACE_TOTAL } startTime=value [ endTime=value ]

Description

This command lists statistics, that are stored within Oracle VM Manager, for an object.

Note that statistics are only stored for the length of time specified for the value of the statistics holdTime, as described in Section A.169, “setStatsConfig”. The default holdTime is 60 minutes. Every 60 minutes, an archive manager runs to trim the statistics to the value specified for the holdTime. Therefore, just prior to cleanup it is possible that statistics are available for the holdTime value in addition to 60 minutes. For example, if the holdTime is specified as the default 60 minutes, then it is possible that statistics of up to 120 minutes old may be returned if the command is run at exactly the same time that the archive manager runs.

Options

The following table shows the available options for this command.

Option	Description
objType= { Server | Vm | FileSystem }	The object type for which to list the average statistic. The value of objType may be Server, Vm, or FileSystem. The value for objType is case insensitive.
objId=value	The name or ID of the object for which statistics should be listed. This must be the ID of either a Server, Vm or FileSystem object.
statType= { CPU_UTILIZATION | CPU_COUNT | MEMORY_USED | FREE_MEMORY | MEMORY_UTILIZATION | FILE_SYSTEM_SPACE_FREE | FILE_SYSTEM_SPACE_UTILIZATION | FILE_SYSTEM_SPACE_TOTAL }	The type of statistic to list: CPU_UTILIZATION: The percentage of the total CPU power being used by the object CPU_COUNT: The number of CPUs. MEMORY_USED: The amount of memory, in MBs, used by the object. FREE_MEMORY: The amount of memory, in MBs, available on the server. MEMORY_UTILIZATION: The percentage of the total memory being used by the object. This option applies only to objects associated with a server. FILE_SYSTEM_SPACE_FREE: The amount of file system space, in GiB, that is not currently used. FILE_SYSTEM_SPACE_UTILIZATION: The percentage of the total file system space currently in use. FILE_SYSTEM_SPACE_TOTAL: The total size of the file system, in GiB. The FILE_SYSTEM_SPACE_FREE, FILE_SYSTEM_SPACE_UTILIZATION, FILE_SYSTEM_SPACE_TOTAL parameters are supported for the FileSystem object type only. The CPU_COUNT parameter is not supported by the Server object type. An error is returned when an incompatible object type and parameter are requested. A value of 0 may be returned for any parameter if there are no statistics available for the object on Oracle VM Manager in the time frame when the statistics were requested.
startTime=value	The start date and time from which to list the average statistic. The format to use is "MM-dd-yyyy HH:mm:ss". The value must not be later than the current time or after the value of endTime.
endTime=value	The end date and time from which to list the average statistic. The format to use is "MM-dd-yyyy HH:mm:ss". This is an optional parameter.

Examples

Example A.155 Listing statistics for an Oracle VM Server

OVM> getStatList objType=Server objId=00:e0:81:4d:41:05:00:e0:81:4d:40:de:00:e0:81:4d \
  statType=MEMORY_USED startTime="08-20-2014 00:00"

See Also

• Section A.122, “getStatListByQuery”

• Section A.116, “getLatestStat”

• Section A.117, “getLatestStatForList”

• Section A.108, “getAverageStat”

• Section A.120, “getStatsConfig”

• Section A.169, “setStatsConfig”

• Section A.138, “list”

• Section A.171, “show”

A.122 getStatListByQuery

Lists statistic types for an object using a query to narrow results.

Syntax

getStatListByQuery objType= { Server | Vm | FileSystem } objIds=value statType= { CPU_UTILIZATION | CPU_COUNT | MEMORY_USED | FREE_MEMORY | MEMORY_UTILIZATION | FILE_SYSTEM_SPACE_FREE | FILE_SYSTEM_SPACE_UTILIZATION | FILE_SYSTEM_SPACE_TOTAL } equalityType= { LT | LTE | GT | GTE | EQ | NE } statValue=value [ startTime=value ] [ endTime=value ] [ maxResults=value ]

Description

This command lists statistics for an object using a query to refine results.

Options

The following table shows the available options for this command.

Option	Description
objType= { Server | Vm | FileSystem }	The object type for which to list the statistics. The value of objType may be Server, Vm, or FileSystem. The value for objType is case insensitive.
objIds=value	The name or ID of the objects for which statistics should be listed. This must be the ID of a Server, Vm, or FileSystem object. To enter one or more objects, use a comma separated list, for example: objIds=UUID1,UUID2,UUID3
statType= { CPU_UTILIZATION | CPU_COUNT | MEMORY_USED | FREE_MEMORY | MEMORY_UTILIZATION | FILE_SYSTEM_SPACE_FREE | FILE_SYSTEM_SPACE_UTILIZATION | FILE_SYSTEM_SPACE_TOTAL }	The type of statistic to list: CPU_UTILIZATION: The percentage of the total CPU power being used by the object CPU_COUNT: The number of CPUs. MEMORY_USED: The amount of memory, in MBs, used by the object. FREE_MEMORY: The amount of memory, in MBs, available on the server. MEMORY_UTILIZATION: The percentage of the total memory being used by the object. FILE_SYSTEM_SPACE_FREE: The amount of file system space, in GiB, that is not currently used. FILE_SYSTEM_SPACE_UTILIZATION: The percentage of the total file system space currently in use. FILE_SYSTEM_SPACE_TOTAL: The total size of the file system, in GiB. The FILE_SYSTEM_SPACE_FREE, FILE_SYSTEM_SPACE_UTILIZATION, FILE_SYSTEM_SPACE_TOTAL parameters are supported for the FileSystem object type only. The CPU_COUNT parameter is not supported by the Server object type. An error is returned when an incompatible object type and parameter are requested. A value of 0 may be returned for any parameter if there are no statistics available for the object on Oracle VM Manager in the time frame when the statistics were requested.
equalityType= { LT | LTE | GT | GTE | EQ | NE }	The equality type for the statistics. Use this in combination with the value option. The parameters are: LT: Less than (<). LTE: Less than or equal to (<=). GT: Greater than (>). GTE: Greater than or equal to (>=). EQ: Equal to (=). NE: Not equal to (<>, or !=).
statValue=value	The value to use with the equalityType option. Use this option to search and filter the results. For example, when you want to find when a server is under 20% CPU utilization, use: equalityType=LT statValue=20 Another example might be for querying when a virtual machine is using more than two CPUs. In this case you might use: equalityType=GT statValue=2 Note that when entering non-integer values for values such as the number of GiB in a file system, the value may lose precision due to internal conversion algorithms. Be careful when working with equality for non-integer values as the results may not match the values that you expect.
startTime=value	The start date and time from which to list statistics. The format to use is "MM-dd-yyyy HH:mm:ss". This is an optional parameter. The value must not be later than the current time or after the value of endTime.
endTime=value	The end date and time from which to list statistics. The format to use is "MM-dd-yyyy HH:mm:ss". This is an optional parameter.
maxResults=value	The maximum number of statistics to list. This is an optional parameter.

Examples

Example A.156 Listing statistics for an Oracle VM Server using a query to filter results

OVM> getStatListByQuery objType=Server objIds=00:e0:81:4d:41:05:00:e0:81:4d:40:de:00:e0:81:4d \
  statType=CPU_UTILIZATION equalityType=GT statValue=80

Example A.157 Listing statistics during a date range

OVM> getStatListByQuery objType=Server objIds=00:e0:81:4d:5f:2f:00:e0:81:4d:29:ee:00:e0:81:4d \
  statType=CPU_UTILIZATION equalityType=GT statValue=80 startTime="02-01-2015 00:00:00" \
  endTime="02-09-2015 23:59:00" maxResults=10

Example A.158 Listing statistics for a virtual machine using a query to filter results

OVM> getStatListByQuery objtype=Vm objIds=0004fb000006000044f5ee8585b1d59c statType=MEMORY_USED \
  equalityType=GT statValue=2048

See Also

• Section A.121, “getStatList”

• Section A.116, “getLatestStat”

• Section A.117, “getLatestStatForList”

• Section A.108, “getAverageStat”

• Section A.120, “getStatsConfig”

• Section A.169, “setStatsConfig”

• Section A.138, “list”

• Section A.171, “show”

A.123 getTriageEvent

Lists the highest severity event for an object.

Syntax

getTriageEvent objType=value objId=value

Description

This command lists the highest severity event for an object. To acknowledge an event, use the ackEvent command.

Options

The following table shows the available options for this command.

Option	Description
objType=value	The object type for which to list the event. The value of objType is an object such as FileServer, Repository, or Server. To get a list of all object types, use the showobjtypes command. The value for objType is case insensitive.
objId=value	The name or ID of the object.

Examples

Example A.159 Listing the highest severity event for an Oracle VM Server

OVM> getTriageEvent objType=Server objId=MyServer

See Also

• Section A.124, “getTriageEventSeverityList”

• Section A.175, “showobjtypes”

• Section A.113, “getEvents”

• Section A.114, “getEventsForObject”

• Section A.2, “ackEvent”

A.124 getTriageEventSeverityList

Lists the highest severity event for one or more objects.

Syntax

getTriageEventSeverityList objList=value

Description

This command lists the highest severity event for one or more objects. To acknowledge an event, use the ackEvent command.

Options

The following table shows the available options for this command.

Option	Description
objList=value	A comma delimited list of object IDs or names for which to list the event. The value of objList is a list of object IDs or names for objects such as FileServer, Repository, or Server. The value for objType is case insensitive.

Examples

Example A.160 Listing the highest severity event for a list of objects

OVM> getTriageEventSeverityList objList=0004fb0000140000121afb1823ad9d87,\
  0004fb000006000044f5ee8585b1d59c,MyRepository

See Also

• Section A.123, “getTriageEvent”

• Section A.175, “showobjtypes”

• Section A.113, “getEvents”

• Section A.114, “getEventsForObject”

• Section A.2, “ackEvent”

A.125 getVmCfgFileContent

Shows the contents of a virtual machine configuration file.

Syntax

getVmCfgFileContent Vm instance

Where instance is:

{ id=value | name=value }

Description

This command shows the contents of a virtual machine configuration file (vm.cfg).

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVm.

Examples

Example A.161 Showing the contents of a virtual machine configuration file

OVM> getVmCfgFileContent Vm name=MyVM

See Also

• Section A.138, “list”

• Section A.171, “show”

A.126 getVmOsTypes

Shows the virtual machine operating system types.

Syntax

getVmOsTypes

Description

This command shows the virtual machine operating types used when creating or editing a virtual machine.

Options

This command does not take any arguments or provide any options.

Examples

Example A.162 Showing virtual machine operating system types

OVM> getVmOsTypes  

See Also

• Section A.53, “create Vm”

• Section A.95, “edit Vm”

A.127 getVmReceivedMessages

Lists the key/value pair messages received from a running virtual machine.

Syntax

getVmReceivedMessages Vm instance

Where instance is:

{ id=value | name=value }

Description

This command lists the key/value pair messages received from a running virtual machine.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVM.

Examples

Example A.163 Listing messages received from a virtual machine

OVM> getVmReceivedMessages Vm name=MyVm

See Also

• Section A.164, “sendVmMessage”

• Section A.128, “getVmSentMessages”

• Section A.22, “clearVmRcvdMessage”

• Section A.23, “clearVmSentMessage”

• Section A.21, “clearVmAllSentMessages”

• Section A.20, “clearVmAllRcvdMessages”

A.128 getVmSentMessages

Lists the key/value pair messages sent to a running virtual machine.

Syntax

getVmSentMessages Vm instance

Where instance is:

{ id=value | name=value }

Description

This command lists the key/value pair messages sent to a running virtual machine.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVM.

Examples

Example A.164 Listing messages sent to a virtual machine

OVM> getVmSentMessages Vm name=MyVm

See Also

• Section A.164, “sendVmMessage”

• Section A.127, “getVmReceivedMessages”

• Section A.22, “clearVmRcvdMessage”

• Section A.23, “clearVmSentMessage”

• Section A.21, “clearVmAllSentMessages”

• Section A.20, “clearVmAllRcvdMessages”

A.129 getVnicMacAddrRange

Displays the range of MAC addresses that are available to VNICs.

Syntax

getVnicMacAddrRange

Description

This command displays the range of MAC addresses that can be used when creating a VNIC. To set the MAC address range, use the setVnicMacAddrRange command.

Options

This command does not take any arguments or provide any options.

Examples

Example A.165 Displaying the VNIC MAC Address Range

OVM> getVnicMacAddrRange

See Also

• Section A.170, “setVnicMacAddrRange”

• Section A.58, “create Vnic”

• Section A.100, “edit Vnic”

• Section A.17, “add Vnic”

• Section A.160, “remove Vnic”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.130 help

Provides a list of commonly used commands and their syntax.

Syntax

help

Description

This command provides a list of commonly used commands and their syntax. It groups the commands according to how they are generally used.

Options

This command does not take any arguments or provide any options.

Examples

Example A.166 Using the Help Command

OVM> help

See Also

• Section A.172, “showallcustomcmds”

• Section A.174, “showcustomcmds”

• Section A.175, “showobjtypes”

A.131 importAssembly (Deprecated)

Imports and adds an assembly to a storage repository.

Important

This command has been deprecated. Instead, use the importVirtualAppliance command.

Syntax

importAssembly Repository instance url=value [ proxy=value ]

Where instance is:

{ id=value | name=value }

Description

This command imports and adds an assembly file to a storage repository. The imported assembly is unpacked and each virtual machine is contained within an AssemblyVm object. The AssemblyVm objects are created in the same storage repository as the original assembly file. Use the list AssemblyVm command to find the name and ID of the new AssemblyVm objects, then use the createVmFromAssembly (Deprecated) command to create a virtual machine templates from each AssemblyVm object.

Options

The following table shows the available options for this command.

Option	Description
Repository instance	The storage repository in which to import the assembly.
url=value	The URL of the assembly. Note that if you quote this argument, the forward slashes in the URL should be escaped. This is illustrated in the example.
proxy=value	The IP address or hostname of a proxy server to use when importing the assembly.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServer.

Examples

Example A.167 Importing an assembly to a storage repository

OVM> importAssembly Repository name=MyRepository url="http:////example.com//myassembly.ova"

See Also

• Section A.31, “createVmFromAssembly (Deprecated)”

• Section A.63, “edit Assembly (Deprecated)”

• Section A.64, “edit AssemblyVirtualDisk (Deprecated)”

• Section A.65, “edit AssemblyVm (Deprecated)”

• Section A.111, “getDescriptor”

• Section A.59, “delete”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

A.132 importTemplate

Imports and adds a virtual machine template to a storage repository.

Syntax

importTemplate Repository instance url=value [ proxy=value ]

Where instance is:

{ id=value | name=value }

Description

This command imports and adds a virtual machine template to a storage repository.

Virtual machines and virtual machine templates are treated the same in the CLI, so many of the commands you use to manage templates are handled by the same commands as managing virtual machines, for example, to list templates, use the list Vm command, and to delete a template, use the delete Vm command.

Options

The following table shows the available options for this command.

Option	Description
Repository instance	The storage repository in which to import the virtual machine template.
url=value	The URL of the virtual machine template. Note that if you quote this argument, the forward slashes in the URL should be escaped. This is illustrated in the example.
proxy=value	The IP address or hostname of a proxy server to use when importing the template.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyRepository.

Examples

Example A.168 Importing a virtual machine template to a storage repository

OVM> importTemplate Repository name=MyRepository url="http:////example.com//mytemplate.tgz"

See Also

• Section A.136, “importVirtualMachine”

• Section A.24, “clone Vm”

• Section A.142, “refresh”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.133 importVirtualAppliance

Imports and adds a virtual appliance to a storage repository.

Syntax

importVirtualAppliance Repository instance url=value [ proxy=value ]

Where instance is:

{ id=value | name=value }

Description

This command imports and adds a virtual appliance to a storage repository. The imported virtual appliance is unpacked and each virtual machine is contained within an VirtualApplianceVm object. The VirtualApplianceVm objects are created in the same storage repository as the original virtual appliance. Use the list VirtualApplianceVm command to find the name and ID of the new VirtualApplianceVm objects, then use the createVmFromVirtualAppliance command to create virtual machines from each VirtualApplianceVm object.

Options

The following table shows the available options for this command.

Option	Description
Repository instance	The storage repository in which to import the virtual appliance.
url=value	The URL of the virtual appliance. Note that if you quote this argument, the forward slashes in the URL should be escaped. This is illustrated in the example.
proxy=value	The IP address or hostname of a proxy server to use when importing the virtual appliance.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServer.

Examples

Example A.169 Importing a virtual appliance to a storage repository

OVM> importVirtualAppliance Repository name=MyRepository url="http:////example.com//myvirtualappliance.ova"

See Also

• Section A.32, “createVmFromVirtualAppliance”

• Section A.33, “createVmFromVirtualApplianceVm”

• Section A.106, “exportVirtualAppliance”

• Section A.89, “edit VirtualAppliance”

• Section A.90, “edit VirtualApplianceVirtualDisk”

• Section A.91, “edit VirtualApplianceVm”

• Section A.111, “getDescriptor”

• Section A.59, “delete”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

A.134 importVirtualCdrom

Imports and adds a virtual CDROM/ISO file to a storage repository.

Syntax

importVirtualCdrom Repository instance url=value [ proxy=value ]

Where instance is:

{ id=value | name=value }

Description

This command imports and adds a virtual CDROM/ISO file to a storage repository.

Options

The following table shows the available options for this command.

Option	Description
Repository instance	The storage repository in which to import the virtual CDROM/ISO file.
url=value	The URL of the virtual CDROM/ISO file. Note that if you quote this argument, the forward slashes in the URL should be escaped. This is illustrated in the example.
proxy=value	The IP address or hostname of a proxy server to use when importing the virtual CDROM/ISO file.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyRepository.

Examples

Example A.170 Importing a virtual CDROM/ISO file to a storage repository

OVM> importVirtualCdrom Repository name=MyRepository url="http:////example.com//myiso.iso"

Tip

Note that, in the above example, forward slashes are used to escape the forward slashes that appear in the URL. Hence the doubling up of forward slashes.

See Also

• Section A.92, “edit VirtualCdrom”

• Section A.25, “cloneCdToRepo”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.135 importVirtualDisk

Imports and adds a virtual disk file to a storage repository.

Syntax

importVirtualDisk Repository instance url=value [ proxy=value ]

Where instance is:

{ id=value | name=value }

Description

This command imports and adds a virtual disk file to a storage repository.

Options

The following table shows the available options for this command.

Option	Description
Repository instance	The storage repository in which to import the virtual disk file.
url=value	The URL of the virtual disk file. Note that if you quote this argument, the forward slashes in the URL should be escaped. This is illustrated in the example.
proxy=value	The IP address or hostname of a proxy server to use when importing the virtual disk file.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyRepository.

Examples

Example A.171 Importing a virtual disk file to a storage repository

OVM> importVirtualDisk Repository name=MyRepository url="http:////example.com//myvdisk.img"

See Also

• Section A.51, “create VirtualDisk”

• Section A.93, “edit VirtualDisk”

• Section A.59, “delete”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.136 importVirtualMachine

Imports and adds a virtual machine to a storage repository.

Syntax

importVirtualMachine Repository instance url=value [ proxy=value ]

Where instance is:

{ id=value | name=value }

Description

This command imports and adds a virtual machine to a storage repository. The virtual machine is placed in the Unassigned Virtual Machines folder in Oracle VM Manager. To deploy the virtual machine to an Oracle VM Server, use the add Vm command.

Options

The following table shows the available options for this command.

Option	Description
Repository instance	The storage repository in which to import the virtual machine.
url=value	The URL of the virtual machine. To import a multi-file virtual machine, enter each URL in a comma separated list, for example: url=http://example.com/Sys.img,http://example.com/vm.cfg Note that if you quote this argument, the forward slashes in the URL should be escaped. This is illustrated in the example.
proxy=value	The IP address or hostname of a proxy server to use when importing the virtual machine.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyRepository.

Examples

Example A.172 Importing a virtual machine to a storage repository

OVM> importVirtualMachine Repository name=MyRepository url="http:////example.com//mytemplate.tgz"

See Also

• Section A.16, “add Vm”

• Section A.132, “importTemplate”

• Section A.24, “clone Vm”

• Section A.142, “refresh”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.137 kill

Kills an Oracle VM Server or virtual machine.

Syntax

kill { Server | Vm } instance

Where instance is:

{ id=value | name=value }

Description

This command kills an Oracle VM Server or virtual machine.

Options

The following table shows the available options for this command.

Option	Description
{ Server | Vm }	The object to kill, either an Oracle VM Server or a virtual machine.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVM.

Examples

Example A.173 Killing an Oracle VM Server

OVM> kill Server name=MyServer

Example A.174 Killing a virtual machine

OVM> kill Vm name=MyVM

See Also

• Section A.177, “start”

• Section A.162, “restart”

• Section A.178, “stop”

A.138 list

Lists all instances of an object.

Syntax

list { AccessGroup | AntiAffinityGroup | Assembly | AssemblyVirtualDisk | AssemblyVm | BondPort | ControlDomain | Cpu | CpuCompatibilityGroup | FileServer | FileServerPlugin | FileSystem | Job | Manager | Network | PeriodicTask | PhysicalDisk | Port | Repository | RepositoryExport | Server | ServerController | ServerPool | ServerPoolNetworkPolicy | ServerUpdateGroup | ServerUpdateRepository | StorageArray | StorageArrayPlugin | StorageInitiator | Tag | VirtualAppliance | VirtualApplianceVirtualDisk | VirtualApplianceVm | VirtualCdrom | VirtualDisk | VlanInterface | Vm | VmCloneCustomizer | VmCloneNetworkMapping | VmCloneStorageMapping | VmDiskMapping | Vnic | VolumeGroup }

Description

This command lists all instances of an object.

Options

The following table shows the available options for this command.

Option

Description

{ AccessGroup | AntiAffinityGroup | Assembly | AssemblyVirtualDisk | AssemblyVm | BondPort | ControlDomain | Cpu | CpuCompatibilityGroup | FileServer | FileServerPlugin | FileSystem | Job | Manager | Network | PeriodicTask | PhysicalDisk | Port | Repository | RepositoryExport | Server | ServerController | ServerPool | ServerPoolNetworkPolicy | ServerUpdateGroup | ServerUpdateRepository | StorageArray | StorageArrayPlugin | StorageInitiator | Tag | VirtualAppliance | VirtualApplianceVirtualDisk | VirtualApplianceVm | VirtualCdrom | VirtualDisk | VlanInterface | Vm | VmCloneCustomizer | VmCloneNetworkMapping | VmCloneStorageMapping | VmDiskMapping | Vnic | VolumeGroup }

The object to list. The Vm option lists both virtual machines and virtual machine templates. You can use the show command with either the Repository or Vm option to distinguish between a virtual machine and a virtual machine template. The VmDiskMapping option lists the disk mapping objects for both virtual machines and virtual machine templates. Important The Assembly, AssemblyVirtualDisk and AssemblyVm options have been deprecated. You should instead use VirtualAppliance, VirtualApplianceVirtualDisk, and VirtualApplianceVm, respectively.

Examples

Example A.175 Listing Oracle VM Servers

OVM> list Server

Example A.176 Listing virtual machines and virtual machine templates

OVM> list Vm

Example A.177 Listing networks

OVM> list Network

Example A.178 Listing virtual machine and virtual machine templates disk mapping

OVM> list VmDiskMapping

See Also

• Section A.171, “show”

A.139 migrate Vm

Migrates a virtual machine.

Syntax

migrate Vm instance [ destServer=value | destServerPool=value ]

Where instance is:

{ id=value | name=value }

Description

This command migrates a virtual machine to an Oracle VM Server or server pool.

You can migrate a running virtual machine to an Oracle VM Server within the same server pool. To migrate the virtual machine to the Unassigned Virtual Machines folder (undeploy it), do not supply a destination.

It is not possible to migrate a stopped virtual machine using this command. To do this, you should use the remove Vm and add Vm commands instead.

To migrate a virtual machine, including the local storage, use the migrateWithLocalStorage Vm command.

Options

The following table shows the available options for this command.

Option	Description
[ destServer=value | destServerPool=value ]	The name or ID of the Oracle VM Server or server pool on which to migrate the virtual machine.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServer.

Examples

Example A.179 Migrating a virtual machine to an Oracle VM Server

OVM> migrate Vm name=MyVM destServer=MyServer

Example A.180 Migrating a virtual machine to a server pool

OVM> migrate Vm name=MyVM destServerPool=MyServerPool

Example A.181 Migrating a virtual machine to the Unassigned Virtual Machines folder

OVM> migrate Vm name=MyVM

See Also

• Section A.140, “migrateWithLocalStorage Vm”

• Section A.16, “add Vm”

• Section A.159, “remove Vm”

• Section A.177, “start”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.140 migrateWithLocalStorage Vm

Migrates a virtual machine to another Oracle VM Server within the same server pool, and moves its local storage to another storage repository.

Syntax

migrateWithLocalStorage Vm instance destServer=value repository=value

Where instance is:

{ id=value | name=value }

Description

This command migrates a virtual machine to another Oracle VM Server within the same server pool, and moves its local storage to another storage repository.

Options

The following table shows the available options for this command.

Option	Description
destServer=value	The name or ID of the Oracle VM Server on which to migrate the virtual machine. The Oracle VM Server must be in the same server pool as the source Oracle VM Server.
repository=value	The name or ID of the storage repository on which to migrate the virtual machine local storage. Only repositories hosted on an OCFS2 file system may be used if you are moving the virtual machine storage of a running virtual machine. This command moves the virtual machine configuration and virtual disks to the target repository. However, the virtual machine configuration is moved only if it resides in a local repository, not in a shared repository.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServer.

Examples

Example A.182 Migrating a virtual machine to an Oracle VM Server, including local storage

OVM> migrateWithLocalStorage Vm name=MyVM destServer=MyServer repository=MyRepository

See Also

• Section A.139, “migrate Vm”

• Section A.16, “add Vm”

• Section A.159, “remove Vm”

• Section A.177, “start”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.141 moveVmToRepository

Moves a virtual machine to a storage repository that has been defined within a clone customizer.

Syntax

moveVmToRepository Vm instance cloneCustomizer=value targetRepository=value

Where instance is:

{ id=value | name=value }

Description

This command moves a virtual machine to a target storage repository. The target storage repository is set using a predefined clone customizer. Use the create VmCloneCustomizer command to create a clone customizer.

Any VmDiskMapping objects are renamed during the move operation. The move job copies any virtual disks to the target storage repository, and, consequently, the new virtual disks have new UUIDs. New VmDiskMapping objects are created to map the newly created virtual disks and added to the virtual machine. The old VmDiskMapping objects are then deleted. Deleting the VmDiskMapping object also causes any associated VmCloneStorageMapping objects to be deleted.

Options

The following table shows the available options for this command.

Option	Description
cloneCustomizer=value	The name or ID of the clone customizer to use to move the virtual machine to a storage repository.
targetRepository=value	The name or ID of the storage repository to which the virtual machine is to be moved.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVm.

Examples

Example A.183 Moving a virtual machine to a storage repository

OVM> moveVmToRepository Vm name=MyVm cloneCustomizer=MyVMCloneCustomizer \
  targetRepository=MyRepository

See Also

• Section A.54, “create VmCloneCustomizer”

• Section A.41, “create PhysicalDisk”

• Section A.76, “edit PhysicalDisk”

• Section A.59, “delete”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.142 refresh

Refreshes configuration information about an object in Oracle VM Manager.

Syntax

refresh { AccessGroup | Assembly | FileServer | FileSystem | PhysicalDisk | Repository | Server | StorageArray | VirtualAppliance } instance

Where instance is:

{ id=value | name=value }

Description

This command reads the configuration information about the object and updates the Oracle VM Manager database repository.

When refreshing the file systems or a file server with non-uniform exports, all of the refresh servers for the file server must be available. If a refresh server is out of commission and you need to perform a refresh, you can remove that refresh server from the file server and add an alternate that has access to the same set of exports on the file server. For more information on uniform and non-uniform exports, please refer to What are Uniform and Non-uniform Exports? in the Oracle VM Concepts Guide.

Options

The following table shows the available options for this command.

Option	Description
{ AccessGroup | Assembly | FileServer | FileSystem | PhysicalDisk | Repository | Server | StorageArray | VirtualAppliance }	The object to be refreshed. Important The Assembly option has been deprecated. You should instead use VirtualAppliance.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServer. Note that if the object name contains forward slashes, these must be escaped using an additional forward slash. This is illustrated in the examples for this command.

Examples

Example A.184 Refreshing a file server

OVM> refresh FileServer name=MyNFSServer 

Example A.185 Refreshing a storage array

OVM> refresh StorageArray name=MyISCSIServer

Example A.186 Refreshing a physical disk

OVM> refresh PhysicalDisk id=0004fb000018000035ce16ee4d58dc4d

Example A.187 Refreshing a file system

OVM> refresh FileSystem name="nfs on 10.172.76.125://mnt//vol1//repo01"

Example A.188 Refreshing a storage repository

OVM> refresh Repository name=MyRepository

See Also

• Section A.143, “refreshAll”

• Section A.144, “refreshStorageLayer”

A.143 refreshAll

Rediscovers all Oracle VM Server instances, file servers, and storage arrays.

Syntax

refreshAll

Description

This command rediscovers all Oracle VM Server instances, file servers, and storage arrays.

Important

The Refresh All function does not pick up the contents of file systems that have never been refreshed before. Furthermore, it does not refresh repositories that are not already presented on at least one server. It is important to keep this in mind if you have restored a configuration from a backup, since some items may not have been refreshed before at the time that the backup was created.

Options

This command does not take any arguments or provide any options.

Examples

Example A.189 Rediscovering Oracle VM Servers, file servers and storage arrays

OVM> refreshAll

See Also

• Section A.142, “refresh”

• Section A.144, “refreshStorageLayer”

A.144 refreshStorageLayer

Refreshes the storage visible to an Oracle VM Server.

Syntax

refreshStorageLayer Server instance

Where instance is:

{ id=value | name=value }

Description

This command refreshes the storage visible to an Oracle VM Server. This command discovers:

• Exported NFS shares residing on any NFS file servers. The Oracle VM Server must be an admin server or refresh server.

• Presented physical disks on any iSCSI or unmanaged Fibre Channel storage arrays. The Oracle VM Server must be an admin server.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServer.

Examples

Example A.190 Refreshing Oracle VM Server storage

OVM> refreshStorageLayer Server name=MyServer

See Also

• Section A.142, “refresh”

• Section A.143, “refreshAll”

• Section A.138, “list”

• Section A.171, “show”

A.145 releaseOwnership

Releases ownership of an Oracle VM Server or storage repository.

Syntax

releaseOwnership { Repository | Server } instance

Where instance is:

{ id=value | name=value }

Description

This command releases ownership of an Oracle VM Server or storage repository.

Options

The following table shows the available options for this command.

Option	Description
{ Repository | Server }	The object for which to release ownership, either an Oracle VM Server or a storage repository.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServer.

Examples

Example A.191 Releasing ownership of an Oracle VM Server

OVM> releaseOwnership Server name=MyServer

Example A.192 Releasing ownership of a storage repository

OVM> releaseOwnership Repository name=MyRepository

See Also

• Section A.180, “takeOwnership”

A.146 removeAccessHost

Removes an access host from an ISCSI server.

Syntax

removeAccessHost StorageArray instance accessHost=value

Where instance is:

{ id=value | name=value }

Description

This command removes an access host from an ISCSI server when using a storage array with multipath capability. At least one access host must be set. Multipath is not supported with the generic ISCSI storage array plug-in. This is not applicable to fibre channel storage.

Options

The following table shows the available options for this command.

Option	Description
accessHost=value	The hostname or IP address for the access host. To find the hostname or IP address, use the show command to display information about the storage array.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyISCSIServer.

Examples

Example A.193 Removing a storage array access host

OVM> removeAccessHost StorageArray name=MyISCSIServer accessHost=10.172.76.131

See Also

• Section A.3, “addAccessHost”

• Section A.49, “create StorageArray”

• Section A.86, “edit StorageArray”

• Section A.138, “list”

• Section A.171, “show”

A.147 removeAdminServer

Removes an administrative Oracle VM Server from a file server or storage array.

Syntax

removeAdminServer { FileServer | StorageArray } instance server=value

Where instance is:

{ id=value | name=value }

Description

This command removes an administrative Oracle VM Server from a file server or storage array.

Options

The following table shows the available options for this command.

Option	Description
server=value	The name or ID of the administrative Oracle VM Server.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyFileServer.

Examples

Example A.194 Removing an admin server from a file server

OVM> removeAdminServer FileServer name=MyNFSServer server=MyServer

See Also

• Section A.4, “addAdminServer”

• Section A.38, “create FileServer”

• Section A.49, “create StorageArray”

• Section A.70, “edit FileServer”

• Section A.86, “edit StorageArray”

• Section A.154, “remove Server”

• Section A.11, “add Server”

• Section A.6, “addRefreshServer”

• Section A.149, “removeRefreshServer”

• Section A.86, “edit StorageArray”

A.148 removePolicyServer

Removes a server pool policy from a server.

Syntax

removePolicyServer ServerPool instance server=value

Where instance is:

{ id=value | name=value }

Description

This command removes a server pool policy from a server.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServerPool.
server=value	The name or ID of an Oracle VM Server from which the policy is removed.

Examples

Example A.195 Removing a policy from a server

OVM> removePolicyServer ServerPool name=MyServerPool server=MyServer

See Also

• Section A.5, “addPolicyServer”

• Section A.46, “create ServerPoolNetworkPolicy”

• Section A.83, “edit ServerPoolNetworkPolicy”

A.149 removeRefreshServer

Removes an Oracle VM Server that is able to refresh a file server.

Syntax

removeRefreshServer FileServer instance server=value

Where instance is:

{ id=value | name=value }

Description

This command removes a refresh server from a file server. The refresh server is an Oracle VM Server that is used to refresh the file systems on an NFS file server. A file server must have at least one refresh server assigned to it.

Options

The following table shows the available options for this command.

Option	Description
FileServer instance	The name or ID of the file server.
server=value	The name or ID of the Oracle VM Server to be removed as a refresh server.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServer.

Examples

Example A.196 Removing a refresh server from a file server

OVM> removeRefreshServer FileServer name=MyNFSServer server=MyServer1

See Also

• Section A.6, “addRefreshServer”

• Section A.38, “create FileServer”

• Section A.70, “edit FileServer”

• Section A.154, “remove Server”

• Section A.11, “add Server”

• Section A.4, “addAdminServer”

• Section A.147, “removeAdminServer”

• Section A.142, “refresh”

A.150 remove BondPort

Removes a bond port from a network object.

Syntax

remove BondPort instance from Network instance

Where instance is:

{ id=value | name=value }

Description

This command removes a bond port from a network object.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyBondPort.

Examples

Example A.197 Removing a bonded port from a network

OVM> remove BondPort id=0004fb000020000065822cb7bb9ec296 from Network name=MyVMNetwork

See Also

• Section A.36, “create BondPort”

• Section A.66, “edit BondPort”

• Section A.7, “add BondPort”

• Section A.153, “remove Port”

• Section A.10, “add Port”

• Section A.102, “embeddedCreate”

• Section A.103, “embeddedDelete”

• Section A.104, “embeddedEdit”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.151 remove FileSystem

Removes a file system from an access group.

Syntax

remove FileSystem instance from AccessGroup instance

Where instance is:

{ id=value | name=value }

Note that if you need to quote the instance name and it contains forward slashes, you need to escape those forward slashes with additional forward slashes. This is illustrated in the example for this command.

Description

This command removes a file system from an access group.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyFileSystem.

Examples

Example A.198 Removing a file system from an access group

OVM> remove FileSystem name="nfs on 10.172.76.125://mnt//vol2//repo03" from AccessGroup \
  name=MyAccessGroup

See Also

• Section A.39, “create FileSystem”

• Section A.72, “edit FileSystem”

• Section A.8, “add FileSystem”

• Section A.34, “create AccessGroup”

• Section A.61, “edit AccessGroup”

• Section A.138, “list”

• Section A.171, “show”

• Section A.59, “delete”

A.152 remove PhysicalDisk

Removes a physical disk from a SAN storage access group.

Syntax

remove PhysicalDisk instance from AccessGroup instance

Where instance is:

{ id=value | name=value }

Description

This command removes a physical disk from a SAN storage access group. Local storage and generic storage plug-ins are not supported with this command.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyDisk.

Examples

Example A.199 Removing physical disk from a SAN storage access group

OVM> remove PhysicalDisk id=0004fb00001800007ee6dbda7b4461cb from AccessGroup \
  name='Default access group @ MyISCSIServer'

See Also

• Section A.41, “create PhysicalDisk”

• Section A.9, “add PhysicalDisk”

• Section A.76, “edit PhysicalDisk”

• Section A.59, “delete”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.153 remove Port

Removes an Ethernet port from a network object.

Syntax

remove Port instance from { BondPort | Network } instance

Where instance is:

{ id=value | name=value }

Description

This command removes an Ethernet port from a network object.

Options

The following table shows the available options for this command.

Option	Description
{ BondPort | Network }	The network object from which to remove the Ethernet port.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyPort.

Examples

Example A.200 Removing an Ethernet port from a network

OVM> remove Port id=0004fb0000200000be8fa354cb7d98ae from Network name=MyVMNetwork

See Also

• Section A.36, “create BondPort”

• Section A.66, “edit BondPort”

• Section A.7, “add BondPort”

• Section A.10, “add Port”

• Section A.102, “embeddedCreate”

• Section A.103, “embeddedDelete”

• Section A.104, “embeddedEdit”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.154 remove Server

Removes an Oracle VM Server from an object.

Syntax

remove Server instance from { AccessGroup | CpuCompatibilityGroup | Repository | ServerPool } instance

Where instance is:

{ id=value | name=value }

Description

This command removes an Oracle VM Server from either a CPU compatibility group, server pool, storage repository or access group.

To remove admin servers from a file server or storage array, use the removeAdminServer command.

Options

The following table shows the available options for this command.

Option	Description
{ AccessGroup | CpuCompatibilityGroup | Repository | ServerPool }	The object from which to remove the Oracle VM Server.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServer.

Examples

Example A.201 Removing an Oracle VM Server from a CPU compatibility group

OVM> remove Server name=MyServer from CpuCompatibilityGroup name=MyCPUGroup

Example A.202 Removing an Oracle VM Server from a server pool

OVM> remove Server name=MyServer from ServerPool name=MyServerPool

Example A.203 Removing an Oracle VM Server from an access group

OVM> remove Server name=MyServer from AccessGroup name=MyAccessGroup

Example A.204 Removing (unpresenting) an Oracle VM Server from a storage repository

OVM> remove Server name=MyServer from Repository name=MyRepository

See Also

• Section A.60, “discoverServer”

• Section A.11, “add Server”

• Section A.80, “edit Server”

• Section A.142, “refresh”

• Section A.177, “start”

• Section A.178, “stop”

• Section A.162, “restart”

• Section A.137, “kill”

• Section A.181, “upgrade”

• Section A.154, “remove Server”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.155 remove ServerPool

Removes a server pool from a storage repository or file system access group.

Syntax

remove ServerPool instance from { AccessGroup | Repository } instance

Where instance is:

{ id=value | name=value }

Description

This command unpresents a storage repository from the Oracle VM Servers in a server pool. To unpresent a storage repository to an individual Oracle VM Server, use the remove Server command.

This command also removes a server pool from an access group.

Options

The following table shows the available options for this command.

Option	Description
{ AccessGroup | Repository }	The object from which to remove the server pool.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServerPool.

Examples

Example A.205 Unpresenting a storage repository from a server pool

OVM> remove ServerPool name=MyServerPool from Repository name=MyNFSRepository

Example A.206 Removing a server pool from an access group

OVM> remove ServerPool name=MyServerPool from AccessGroup name=MyAccessGroup

See Also

• Section A.12, “add ServerPool”

• Section A.154, “remove Server”

• Section A.138, “list”

• Section A.171, “show”

A.156 remove StorageInitiator

Removes a storage initiator from an access group for a SAN storage server.

Syntax

remove StorageInitiator instance from AccessGroup instance

Where instance is:

{ id=value | name=value }

Description

This command removes a storage initiator from an access group for a SAN storage server.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyStorageInitiator.

Examples

Example A.207 Removing a storage initiator

OVM> remove StorageInitiator name=iqn.1988-12.com.oracle:d72d82d0817f from AccessGroup \
  name='Default access group @ MyISCSIServer' 

See Also

• Section A.13, “add StorageInitiator”

• Section A.138, “list”

• Section A.171, “show”

A.157 remove Tag

Removes a tag from an object.

Syntax

remove Tag instance from { Server | ServerPool | Vm } instance

Where instance is:

{ id=value | name=value }

Description

This command removes a tag used to identify and group objects from an object.

Options

The following table shows the available options for this command.

Option	Description
{ Server | ServerPool | Vm }	The object from which to remove the tag.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyTag.

Examples

Example A.208 Removing a tag from a server pool

OVM> remove Tag name=MyTag from ServerPool name=MyServerPool

See Also

• Section A.50, “create Tag”

• Section A.88, “edit Tag”

• Section A.14, “add Tag”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.158 remove VlanInterface

Removes a VLAN interface from a network.

Syntax

remove VlanInterface instance from Network instance

Where instance is:

{ id=value | name=value }

Description

This command removes a VLAN interface from a network.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVlanInterface.

Examples

Example A.209 Removing a VLAN interface from a network

OVM> remove VlanInterface name=MyVLANInterface from Network name=MyNetwork

See Also

• Section A.52, “create VlanInterface”

• Section A.15, “add VlanInterface”

• Section A.94, “edit VlanInterface”

• Section A.102, “embeddedCreate”

• Section A.103, “embeddedDelete”

• Section A.104, “embeddedEdit”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.159 remove Vm

Removes a virtual machine from an Oracle VM Server, server pool, or anti affinity group.

Syntax

remove Vm instance from { AntiAffinityGroup | Server | ServerPool } instance

Where instance is:

{ id=value | name=value }

Description

This command removes a virtual machine from an Oracle VM Server, server pool, or anti affinity group. The virtual machine cannot be running, and must be stopped before using this command.

In the Oracle VM Manager Web Interface:

• When you remove a virtual machine from an Oracle VM Server, it is moved to the server pool and is available by displaying the Virtual Machines perspective at the server pool level in the Servers and VMs tab.

• When you remove a virtual machine from a server pool, it is moved to the Unassigned Virtual Machines folder in the Servers and VMs tab.

Options

The following table shows the available options for this command.

Option	Description
{ AntiAffinityGroup | Server | ServerPool }	The object from which to remove the virtual machine.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVM.

Examples

Example A.210 Removing a virtual machine from a server pool

OVM> remove Vm name=MyVM from ServerPool name=MyServerPool

Example A.211 Removing a virtual machine from an Oracle VM Server

OVM> remove Vm name=MyVM from Server name=MyServer

Example A.212 Removing a virtual machine from an anti affinity group

OVM> remove Vm name=MyVM from AntiAffinityGroup name=MyAAGroup

See Also

• Section A.16, “add Vm”

• Section A.138, “list”

• Section A.171, “show”

A.160 remove Vnic

Removes a VNIC from a network.

Syntax

remove Vnic instance from Network instance

Where instance is:

{ id=value | name=value }

Description

This command removes a VNIC from a network.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVNIC.

Examples

Example A.213 Removing a VNIC from a network

OVM> remove Vnic name=00:21:f6:00:00:00 from Network name=MyNetwork

See Also

• Section A.58, “create Vnic”

• Section A.100, “edit Vnic”

• Section A.17, “add Vnic”

• Section A.170, “setVnicMacAddrRange”

• Section A.129, “getVnicMacAddrRange”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.161 resize

Resizes a physical or virtual disk.

Syntax

resize { PhysicalDisk | VirtualDisk } instance size=value sparse= { Yes | No }

Where instance is:

{ id=value | name=value }

Description

This command resizes a physical or virtual disk. The sparse option is only available when resizing a virtual disk.

Options

The following table shows the available options for this command.

Option	Description
size=value	The size of the physical or virtual disk in GiB.
sparse= { Yes | No }	Whether to create a sparse or non-sparse virtual disk. This option is only available with the resize VirtualDisk command.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVirtualDisk.

Examples

Example A.214 Resizing a virtual disk

OVM> resize VirtualDisk name=MyVMDisk size=200 sparse=Yes

Example A.215 Resizing a physical disk

OVM> resize PhysicalDisk name=MyVMDisk size=200

See Also

• Section A.41, “create PhysicalDisk”

• Section A.9, “add PhysicalDisk”

• Section A.76, “edit PhysicalDisk”

• Section A.152, “remove PhysicalDisk”

• Section A.135, “importVirtualDisk”

• Section A.51, “create VirtualDisk”

• Section A.93, “edit VirtualDisk”

• Section A.59, “delete”

• Section A.142, “refresh”

• Section A.138, “list”

• Section A.171, “show”

• Section A.113, “getEvents”

A.162 restart

Restarting an Oracle VM Server or virtual machine.

Syntax

restart { Server | Vm } instance

Where instance is:

{ id=value | name=value }

Description

This command restarts an Oracle VM Server or virtual machine.

Options

The following table shows the available options for this command.

Option	Description
{ Server | Vm }	The object to restart, either an Oracle VM Server or a virtual machine.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVM.

Examples

Example A.216 Restarting an Oracle VM Server

OVM> restart Server name=MyServer

Example A.217 Restarting a virtual machine

OVM> restart Vm name=MyVM

See Also

• Section A.177, “start”

• Section A.178, “stop”

• Section A.137, “kill”

A.163 resume

Resumes a suspended virtual machine.

Syntax

resume Vm instance

Where instance is:

{ id=value | name=value }

Description

This command resumes a suspended virtual machine.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVM.

Examples

Example A.218 Resuming a virtual machine

OVM> resume Vm name=MyVM

See Also

• Section A.179, “suspend”

• Section A.138, “list”

• Section A.171, “show”

A.164 sendVmMessage

Sends a key/value pair message to a running virtual machine.

Syntax

sendVmMessage Vm instance key=value message=value log= { Yes | No }

Where instance is:

{ id=value | name=value }

Description

This command sends a key/value pair message to a running virtual machine.

Options

The following table shows the available options for this command.

Option	Description
key=value	The message key.
message=value	The message content.
log= { Yes | No }	Whether to log the message.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVM.

Examples

Example A.219 Sending a message to a virtual machine

OVM> sendVmMessage Vm name=MyVM key=com.oracle.linux.network.device.0 message=eth0 log=No

See Also

• Section A.128, “getVmSentMessages”

• Section A.127, “getVmReceivedMessages”

• Section A.22, “clearVmRcvdMessage”

• Section A.23, “clearVmSentMessage”

• Section A.21, “clearVmAllSentMessages”

• Section A.20, “clearVmAllRcvdMessages”

A.165 set

Sets CLI session configuration options.

Syntax

set { AlphabetizeAttributes= { Yes | No } | CommandMode= { Asynchronous | Synchronous } | CommandTimeout= value | EndlineChars= { CRLF | CR | LF } | OutputMode= { Verbose | Sparse | Xml } }

Description

This command sets the CLI session configuration options. To show the values for the CLI session options, use the showclisession command.

Options

The following table shows the available options for this command.

Option	Description
AlphabetizeAttributes= { Yes | No }	Sets whether the CLI should return output from the show command in alphabetical order. The default is No. Note Deprecated attributes are returned at the end of the output from the show command and do not appear in alphabetic order.
CommandMode= { Asynchronous | Synchronous }	Sets whether the CLI should be run in synchronous or asynchronous mode. The default is Synchronous. Synchronous mode waits for a command to complete with a success or failure status. When writing scripts, this mode is useful for when a command should execute and a known result occurs, before moving on to the next command. You may instead want to use asynchronous mode where you want to run a series of commands in parallel to increase execution speed, for example, to start a number of virtual machines. In this case, it may not matter if one machine fails to start, before you start another. When you use synchronous mode, there is a built in lock retry if an object is locked when a command is issued on it. In asynchronous mode, Oracle VM Manager returns a lock exception if a lock is in place on an object. If you use asynchronous mode, you may need to manage lock retries as part of your CLI script by implementing a loop around the lock exception with a small sleep timer between retries. Alternatively, check the object settings to see if the Locked attribute is true or false before issuing a command on the object.
CommandTimeout= value	Sets when the CLI will timeout. value is seconds, and can be an integer between 1 and 43200. The default is 7200 seconds (two hours).
EndlineChars= { CRLF | CR | LF }	Sets the end of line character to use for your SSH client. CRLF is used on Microsoft Windows systems and terminates lines with two characters, \n\r. CR is used on early Apple systems and terminates lines with one character, \n. LF is used on Linux, and Unix-like systems, such a modern Apple systems, and terminates lines with one character, \r. CRLF is the default, and works best with SSH clients on Linux and is the default setting of PuTTY on Windows.
OutputMode= { Verbose | Sparse | Xml }	Sets the output mode for command results. Verbose includes the command, status, time and time zone. Sparse returns just the results without the header files provided by Verbose. Xml returns the results in XML format. Note that XML format does not apply to content returned for commands specific to the CLI session itself. For instance, if the OutputMode is set to Xml, XML is not returned for commands like showobjtypes or showclisession, but the standard output for the CLI is used instead in these cases.

Examples

Example A.220 Setting end of line characters

OVM> set EndlineChars=LF

Example A.221 Setting output mode to XML

OVM> set OutputMode=Xml

See Also

• Section A.173, “showclisession”

A.166 setArchiveConfig

Sets the configuration for managing archived statistics.

Syntax

setArchiveConfig interval=value

Description

This command configures how Oracle VM Manager manages archived statistics. To show the configuration, use the getArchiveConfig command.

Options

The following table shows the available options for this command.

Option

Description

interval=value

The interval, in minutes, at which Oracle VM Manager deletes archived statistics. Oracle VM Manager uses the statistics hold time to calculate how many archived statistics to delete. For example, you set the hold time to 15 minutes and the archive interval to 2 days. In this case, every 2 days Oracle VM Manager deletes archived statistics that are older than 15 minutes from the current time. The value for this field can be between 30 minutes and 525600 minutes (1 year). The default value is 60 minutes.

Examples

Example A.222 Setting the interval to delete archived statistics

OVM> setArchiveConfig interval=1200

See Also

• Section A.107, “getArchiveConfig”

• Section A.169, “setStatsConfig”

A.167 setDbBackupConfig

Sets the configuration for the automated database backup facility within Oracle VM Manager.

Syntax

setDbBackupConfig interval=value numberToKeep=value

Description

This command sets the configuration for the automated database backup facility within Oracle VM Manager. Further information on the automated database backup facility is provided in Backing up the MySQL Database Repository in the Oracle VM Administrator's Guide.

Options

The following table shows the available options for this command.

Option	Description
interval=value	Sets how frequently the automated backups of the Oracle VM Manager database are performed. The value is measured in minutes and can be any integer between 360 minutes (6 hours) and 43200 minutes (30 days).
numberToKeep=value	Sets how many automated backups of the Oracle VM Manager database are retained before they are rotated. The value can be between 1 and 500.

Examples

Example A.223 Setting the Oracle VM Manager database backup configuration

OVM> setDbBackupConfig interval=1440 numberToKeep=14

See Also

• Section A.109, “getDbBackupConfig”

A.168 setMaintenanceMode

Sets maintenance mode on an Oracle VM Server.

Syntax

setMaintenanceMode Server instance mode= { on | off }

Where instance is:

{ id=value | name=value }

Description

This command sets whether an Oracle VM Server is in maintenance mode in order to perform software updates.

Options

The following table shows the available options for this command.

Option	Description
mode= { on | off }	Whether to place the Oracle VM Server into maintenance mode.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServer.

Examples

Example A.224 Placing an Oracle VM Server into maintenance mode

OVM> setMaintenanceMode Server name=MyServer mode=on

See Also

• Section A.181, “upgrade”

• Section A.138, “list”

• Section A.171, “show”

A.169 setStatsConfig

Sets the configuration for the statistics displayed in Oracle VM Manager.

Syntax

setStatsConfig statisticsEnabled= { Yes | No } samplingInterval=value holdTime=value fsSamplingInterval=value

Description

This command sets the configuration for the statistics displayed in Oracle VM Manager.

Options

The following table shows the available options for this command.

Option	Description
statisticsEnabled= { Yes | No }	Whether or not the statistics collection service should be enabled.
samplingInterval=value	The number of seconds between which statistics should be recorded. value may be an integer between 20 and 31536000.
holdTime=value	The number of minutes to retain the statistics. value may be an integer between 15 and 4320.
fsSamplingInterval=value	The number of seconds between which file system statistics should be recorded. value may be an integer between 60 and 31536000.

Examples

Example A.225 Setting the Oracle VM Manager statistics configuration

OVM> setStatsConfig samplingInterval=60 holdTime=15

See Also

• Section A.120, “getStatsConfig”

• Section A.108, “getAverageStat”

• Section A.116, “getLatestStat”

• Section A.117, “getLatestStatForList”

• Section A.108, “getAverageStat”

A.170 setVnicMacAddrRange

Sets the range of MAC addresses that are available to VNICs.

Syntax

setVnicMacAddrRange [ oui=value ] [ start=value ] [ end=value ]

Description

This command sets the range of MAC addresses that can be used when creating a VNIC. To display the MAC address range, use the getVnicMacAddrRange command.

Options

The following table shows the available options for this command.

Option	Description
oui=value	The OUI (Organizationally Unique Identifier) is used as the first three octets of the MAC address. The MAC address is created by combining the OUI as the first three octets with the randomly selected second three octets in the range of start to end values specified, inclusive. Therefore, the value specified here should represent the first three octets that make up the MAC address. The default OUI is 00:21:f6 and is owned by Oracle. Changing the OUI can result in an overlap of MAC addresses on your network causing MAC address spooking, network conflicts and unexpected network behavior. It is recommended that you do not change this value.
start=value	The parameter used to specify the first possible value for the second three octets that form the MAC address. The default start value is 00:00:00.
end=value	The parameter used to specify the final possible value for the second three octets that form the MAC address. The default start value is FF:FF:FF.

Examples

Example A.226 Setting the VNIC MAC Address Range

OVM> setVnicMacAddrRange oui=00:21:f6 start=00:00:00 end=FF:FF:FF

See Also

• Section A.129, “getVnicMacAddrRange”

• Section A.58, “create Vnic”

• Section A.100, “edit Vnic”

• Section A.17, “add Vnic”

• Section A.160, “remove Vnic”

• Section A.59, “delete”

• Section A.138, “list”

• Section A.171, “show”

A.171 show

Shows information about an object.

Syntax

show { AccessGroup | AntiAffinityGroup | Assembly | AssemblyVirtualDisk | AssemblyVm | BondPort | ControlDomain | Cpu | CpuCompatibilityGroup | FileServer | FileServerPlugin | FileSystem | Job | Manager | Network | PeriodicTask | PhysicalDisk | Port | Repository | RepositoryExport | Server | ServerController | ServerPool | ServerPoolNetworkPolicy | ServerUpdateGroup | ServerUpdateRepository | StorageArray | StorageArrayPlugin | StorageInitiator | Tag | VirtualAppliance | VirtualApplianceVirtualDisk | VirtualApplianceVm | VirtualCdrom | VirtualDisk | VlanInterface | Vm | VmCloneCustomizer | VmCloneNetworkMapping | VmCloneStorageMapping | VmDiskMapping | Vnic | VolumeGroup } instance

Where instance is:

{ id=value | name=value }

Description

This command shows information about an object. Use the list command to find all instances of an object type, then use the show command to show more detailed information about the object.

To display the output in alphabetical order, use the set AlphabetizeAttributes=Yes command. To show CLI session options set using the set command, use the showclisession command.

A Job object does not have a name attribute, only an id attribute. The show Job name=value command is the same as entering show Job id=value. You can use these two options interchangeably. Any name attributes are automatically converted to ids.

Options

The following table shows the available options for this command.

Option	Description
{ AccessGroup | AntiAffinityGroup | Assembly | AssemblyVirtualDisk | AssemblyVm | BondPort | ControlDomain | Cpu | CpuCompatibilityGroup | FileServer | FileServerPlugin | FileSystem | Job | Manager | Network | PeriodicTask | PhysicalDisk | Port | Repository | RepositoryExport | Server | ServerController | ServerPool | ServerPoolNetworkPolicy | ServerUpdateGroup | ServerUpdateRepository | StorageArray | StorageArrayPlugin | StorageInitiator | Tag | VirtualAppliance | VirtualApplianceVirtualDisk | VirtualApplianceVm | VirtualCdrom | VirtualDisk | VlanInterface | Vm | VmCloneCustomizer | VmCloneNetworkMapping | VmCloneStorageMapping | VmDiskMapping | Vnic | VolumeGroup }	The object about which to show information. Important The Assembly, AssemblyVirtualDisk and AssemblyVm options have been deprecated. You should instead use VirtualAppliance, VirtualApplianceVirtualDisk, and VirtualApplianceVm, respectively.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServer.

Examples

Example A.227 Showing details about an Oracle VM Server

OVM> show Server name=MyServer

Example A.228 Showing details about a virtual machine

OVM> show Vm name=MyVM

Example A.229 Showing details about a network

OVM> show Network id=0004fb0010ff705

Example A.230 Showing details about a VNIC

OVM> show Vnic name=00:21:f6:00:00:0b

Using the show Vnic command can provide you with information such as the virtual machine that is using a particular VNIC, as well as the IP addresses that are configured for that VNIC.

Note

IP addresses are only displayed for VNICs attached to virtual machines that have been properly set up with the Oracle VM Guest Additions packages. See the Oracle VM Administrator's Guide for information on using the Oracle VM Guest Additions packages.

See Also

• Section A.138, “list”

• Section A.165, “set”

• Section A.173, “showclisession”

A.172 showallcustomcmds

Provides a list of all commands and the objects that they relate to.

Syntax

showallcustomcmds

Description

This command provides a list of all commands along with the objects that the commands relate to.

Options

This command does not take any arguments or provide any options.

Examples

Example A.231 Showing all custom commands

OVM> showallcustomcmds  

See Also

• Section A.130, “help”

• Section A.174, “showcustomcmds”

A.173 showclisession

Provides a list of CLI session options and their settings.

Syntax

showclisession

Description

This command provides a list of the CLI session options and their settings. The CLI session options are set using the set command.

Options

This command does not take any arguments or provide any options.

Examples

Example A.232 Showing CLI session options and settings

OVM> showclisession  

See Also

• Section A.165, “set”

• Section A.171, “show”

A.174 showcustomcmds

Shows available custom commands for an object type.

Syntax

showcustomcmds {{ AccessGroup | AntiAffinityGroup | BondPort | ControlDomain | Cpu | CpuCompatibilityGroup | FileServer | FileServerPlugin | FileSystem | Job | Manager | Network | PeriodicTask | PhysicalDisk | Port | Repository | RepositoryExport | Server | ServerController | ServerPool | ServerPoolNetworkPolicy | ServerUpdateGroup | ServerUpdateRepository | StorageArray | StorageArrayPlugin | StorageInitiator | Tag | VirtualAppliance | VirtualApplianceVirtualDisk | VirtualApplianceVm | VirtualCdrom | VirtualDisk | VlanInterface | Vm | VmCloneCustomizer | VmCloneNetworkMapping | VmCloneStorageMapping | VmDiskMapping | Vnic | VolumeGroup }}

Description

This command shows the available custom commands specific to an object. Use the showobjtypes command to find all object types, then use the showcustomcmds command to show associated commands.

Note

Not all object types have custom commands associated. For example, the YumConfig object type does not have any custom commands.

Options

The following table shows the available options for this command.

Option

Description

{ AccessGroup | AntiAffinityGroup | BondPort | ControlDomain | Cpu | CpuCompatibilityGroup | FileServer | FileServerPlugin | FileSystem | Job | Manager | Network | PeriodicTask | PhysicalDisk | Port | Repository | RepositoryExport | Server | ServerController | ServerPool | ServerPoolNetworkPolicy | ServerUpdateGroup | ServerUpdateRepository | StorageArray | StorageArrayPlugin | StorageInitiator | Tag | VirtualAppliance | VirtualApplianceVirtualDisk | VirtualApplianceVm | VirtualCdrom | VirtualDisk | VlanInterface | Vm | VmCloneCustomizer | VmCloneNetworkMapping | VmCloneStorageMapping | VmDiskMapping | Vnic | VolumeGroup }

The object type for which to list the custom commands.

Examples

Example A.233 Showing custom commands for an Oracle VM Server

OVM> showcustomcmds Server

Example A.234 Showing custom commands for a virtual machine

OVM> showcustomcmds VM    

Example A.235 Showing custom commands for a repository

OVM> showcustomcmds Repository

See Also

• Section A.130, “help”

• Section A.172, “showallcustomcmds”

• Section A.175, “showobjtypes”

A.175 showobjtypes

Provides a list of all object types.

Syntax

showobjtypes

Description

This command provides a list of all object types. This command is useful to assist in determining which object types can be acted upon.

Options

This command does not take any arguments or provide any options.

Examples

Example A.236 Showing all object types

OVM> showobjtypes                  

See Also

• Section A.113, “getEvents”

• Section A.114, “getEventsForObject”

• Section A.130, “help”

• Section A.174, “showcustomcmds”

A.176 showversion

Shows the version number of the CLI/Oracle VM Manager.

Syntax

showversion

Description

This command shows the version number of the CLI/Oracle VM Manager.

Options

This command does not take any arguments or provide any options.

Examples

Example A.237 Showing the CLI/Oracle VM Manager version number

OVM> showversion  

See Also

• Section A.130, “help”

A.177 start

Starts an Oracle VM Server or virtual machine.

Syntax

start { Server | Vm } instance

Where instance is:

{ id=value | name=value }

Description

This command starts an Oracle VM Server or virtual machine.

Options

The following table shows the available options for this command.

Option	Description
{ Server | Vm }	The object to start, either an Oracle VM Server or a virtual machine.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVM.

Examples

Example A.238 Starting an Oracle VM Server

OVM> start Server name=MyServer

Example A.239 Starting a virtual machine

OVM> start Vm name=MyVM

See Also

• Section A.162, “restart”

• Section A.178, “stop”

• Section A.137, “kill”

A.178 stop

Stops an Oracle VM Server or virtual machine.

Syntax

stop { Server | Vm } instance

Where instance is:

{ id=value | name=value }

Description

This command stops an Oracle VM Server or virtual machine.

Options

The following table shows the available options for this command.

Option	Description
{ Server | Vm }	The object to stop, either an Oracle VM Server or a virtual machine.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVM.

Examples

Example A.240 Stopping an Oracle VM Server

OVM> stop Server name=MyServer

Example A.241 Stopping a virtual machine

OVM> stop Vm name=MyVM

See Also

• Section A.177, “start”

• Section A.162, “restart”

• Section A.137, “kill”

A.179 suspend

Suspends a running virtual machine.

Syntax

suspend Vm instance

Where instance is:

{ id=value | name=value }

Description

This command suspends a running virtual machine.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyVM.

Examples

Example A.242 Suspending a virtual machine

OVM> suspend Vm name=MyVM

See Also

• Section A.163, “resume”

• Section A.138, “list”

• Section A.171, “show”

A.180 takeOwnership

Take ownership of an Oracle VM Server or storage repository.

Syntax

takeOwnership { Repository instance [ serverpool=value ] | Server instance password=value }

Where instance is:

{ id=value | name=value }

Description

This command takes ownership of an Oracle VM Server or storage repository. After taking ownership of a repository, you should refresh it using the refresh command. If a server is only partially discovered, in the sense that it is already under the ownership of another Oracle VM Manager instance, and ownership is subsequently released, you may need to rediscover the server before you are able to take ownership of it in the current Oracle VM Manager instance.

Options

The following table shows the available options for this command.

Option	Description
{ Repository instance [ serverpool=value ] | Server instance password=value }	The object for which to take ownership, either an Oracle VM Server or a storage repository. When taking ownership of a storage repository that uses an OCFS2-based file system, you should enter the server pool to which the repository is provided using the serverpool option. When taking ownership of an Oracle VM Server, you should provide the password for the Oracle VM Agent using the password option.
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServer.

Examples

Example A.243 Taking ownership of an Oracle VM Server

OVM> takeOwnership Server name=MyServer password=********

Example A.244 Taking ownership of a storage repository

OVM> takeOwnership Repository name=MyRepository serverpool=MyServerPool

See Also

• Section A.145, “releaseOwnership”

• Section A.142, “refresh”

A.181 upgrade

Upgrades an Oracle VM Server.

Syntax

upgrade Server instance

Where instance is:

{ id=value | name=value }

Description

This command updates or upgrades an Oracle VM Server using a server update repository. The repository used for the upgrade is set using the create ServerUpdateRepository command. This command places the Oracle VM Server into maintenance mode, checks for any updates in the server update repository, installs any updates, restarts the Oracle VM Server, then takes it out of maintenance mode and returns it to the server pool as a fully functioning member of the pool.

You can check if an Oracle VM Server has an update available using the checkUpToDate command.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyServer.

Examples

Example A.245 Upgrading an Oracle VM Server

OVM> upgrade Server name=MyServer

See Also

• Section A.47, “create ServerUpdateGroup”

• Section A.84, “edit ServerUpdateGroup”

• Section A.48, “create ServerUpdateRepository”

• Section A.85, “edit ServerUpdateRepository”

• Section A.19, “checkUpToDate”

• Section A.168, “setMaintenanceMode”

• Section A.138, “list”

• Section A.171, “show”

A.182 validate

Validates a storage array.

Syntax

validate StorageArray instance

Where instance is:

{ id=value | name=value }

Description

This command validates a storage array using the storage array plug-in. Validation is required after the storage array is discovered and after modification of storage array attributes. At least one administrative Oracle VM Server must be configured before using this command.

Options

The following table shows the available options for this command.

Option	Description
{ id=value | name=value }	The instance of the object using either the id or name option, for example name=MyStorageArray.

Examples

Example A.246 Validating a storage array

OVM> validate StorageArray name=MyISCSIServer

See Also

• Section A.142, “refresh”

• Section A.143, “refreshAll”

• Section A.138, “list”

• Section A.171, “show”

Copyright © 2012, 2021 Oracle and/or its affiliates. All rights reserved. Legal Notices