1.1 CLI Changes in Release 3.3

This section lists the changes and new features to the CLI in Release 3.3. In this release, a lot of changes have been introduced due to the move to the Web Services API.

Important

A major change to the way in which the CLI interacts with Oracle VM Manager means that CLI-based transactions have changed in Release 3.3. From Release 3.3 onwards, if a CLI command that contains child operations fails, it is important to check the state of all objects affected by the parent and child operations. For example, during the creation of a server pool, the parent command calls a number of child operations. If any of these child operations fail, the command returns an error, but the server pool object may still be created by the parent operation. In this case, the server pool object must be removed manually before attempting to create the server pool again.

1.1.1 CLI Modifications

This section lists the modifications made to existing CLI commands.

Table 1.1 CLI Modifications in Release 3.3

Object Type	Description
	The getEvents command has a completely different syntax.
AccessGroup	The edit AccessGroup command now includes a `nameOnArray` option to change the name on the storage array. Note This change was introduced after the initial release of Oracle VM 3.3, so may not be available if you are not running the latest patched version of this release.
AccessGroup (was NfsAccessGroup)	The `NfsAccessGroup` object type has been renamed and is now referred to as `AccessGroup`. This affects the following commands: create NFSAccessGroup is now create AccessGroup edit NFSAccessGroup is now edit AccessGroup remove FileSystem option renamed add FileSystem option renamed add Server option renamed remove Server option renamed add ServerPool option renamed remove ServerPool option renamed delete option renamed show option renamed list option renamed
Assembly	The createTemplatesFromAssembly command has been removed and replaced with the new createVmFromAssembly command.
Assembly, VirtualCdrom, VirtualDisk, Vm	The following commands no longer require or have the `server` option to enter the Oracle VM Server to perform the import job: importAssembly importTemplate importVirtualCdrom importVirtualDisk importVirtualMachine
BondPort, Port, VlanInterface	The `netmask` option for various commands has been renamed and is now referred to as `ipNetmask`. This affects the following commands: add VlanInterface option renamed create BondPort option renamed edit BondPort option renamed edit Port option renamed
BondPort, Port	The commands to manage ports and bond ports have changed. The following commands have been significantly modified: create BondPort edit BondPort edit Port
FileServer	The create FileServer and edit FileServer commands no longer have the `adminHost`, `adminUsername`, and `adminPassword` options.
FileServer	The `addNfsRefreshServer` command has been renamed to addRefreshServer, and the `nfsRefreshServer` option for this command has been renamed to `server`. The removeNfsRefreshServer command has been renamed to removeRefreshServer, and the `nfsRefreshServer` option for this command has been renamed to `server`.
Job	The getJobsUsingRange and getLatestNumberOfJobs commands have been removed and are no longer available. Instead, use the getJobs command.
Network	The create Network option to create a local network on an Oracle VM Server, `server=value`, has been changed to `Server instance`.
PhysicalDisk	The `thinProvision` option of the create PhysicalDisk command is now mandatory.
PhysicalDisk, VirtualDisk	The edit PhysicalDisk and edit VirtualDisk commands no longer have the `size` option to enable resizing of a disk. Instead, there is a new resize command to perform this task for both virtual and physical disks.
Repository	The create Repository command has significantly changed to allow a repository to be created only on a file system and no longer allows you to create a repository on a physical disk.
Repository	The edit Repository command has removed the `ownership` option to take or release ownership of a repository. To perform this action, two new commands have been added, takeOwnership and releaseOwnership.
Server	The discoverServer command `username` option has been removed, the default username of `oracle` is used. The `port` option has been removed, the default port of `8899` is used.
Server	The add Server command options `FileServer` and `StorageArray` have been removed. These options set an Oracle VM Server as an admin server for those objects. Instead, you should now use the addAdminServer command. The remove Server command options `FileServer` and `StorageArray` have been removed. These options remove an Oracle VM Server as an admin server from those objects. Instead, you should now use the removeAdminServer command.
Server	The `takeOwnership` option has been removed from the edit Server command. Instead use the takeOwnership command to take ownership of an Oracle VM Server or the releaseOwnership command to release ownership. The `maintenanceMode` option has been removed from the edit Server command. Instead use the setMaintenanceMode command to set whether an Oracle VM Server is in maintenance mode.
Server	The setNtp, showNtp and syncNtp commands have been removed. Instead, use the edit Server command with the new `ntpServers` option to set or edit the time using one or more NTP servers on an Oracle VM Server. The show command with the `Server` option displays the NTP servers associated with an Oracle VM Server. There is no command that replaces the syncNtp command.
Server	The initiateYumUpgrade command has been removed. Instead, use the upgrade command to update the software on an Oracle VM Server.
ServerPool	The create ServerPool and edit ServerPool commands `keymapName` option now has a list of options available instead of the option having to be entered manually.
StorageArray (was SanServer)	The `SanServer` object type has been renamed and is now referred to as `StorageArray`. This affects the following commands: create SanServer is now create StorageArray edit SanServer is now edit StorageArray delete SanServer is now delete StorageArray Other commands that relate to this object type, such as commands specific to `AccessGroup` and `Server` objects are also affected.
StorageArray	The create StorageArray and edit StorageArray commands have different values for the `storageType` option parameters.
VlanInterface (was VlanGroup and VlanSegment)	The commands to manage VLANs have changed. You should now use the VlanInterface object type instead of the VlanGroup and VlanSegment object types. The following commands have been removed: create VlanGroup edit VlanGroup create VlanSegment edit VlanSegment The following commands have been modified to remove the `VlanGroup` option: add BondPort remove BondPort add Port remove Port list show delete The following commands have been modified to remove the `VlanSegment` option: create Network edit Network list show delete The edit VlanInterface command no longer has the options `addressType`, `ipAddress`, or `ipNetmask`.
Vm	The add Vm and remove Vm commands have additional syntax options and functions. In addition to adding or removing a virtual machine to/from an Oracle VM Server, you can now add or remove a virtual machine to/from a server pool or an anti affinity group.
Vm	The clone Vm command `destName` option is now optional.
VmDiskMapping	The create VmDiskMapping command has changed. Instead of specifying the `storageDevice` option to map a disk, you must now specify either a `physcialDisk`, `virtualCd`, or a `virtualDisk`.
Vnic	You can no longer add a VNIC to a virtual machine. To support this change, the add Vnic command no longer allows to add a VNIC to a virtual machine. Instead, you may add a VNIC to either a `LocalNetwork` or `Network` object type. Similarly, the remove Vnic command now has a `LocalNetwork` or `Network` object type. In addition, the addAvailableVnic Vm command has been removed.
Vnic	The create Vnic command has a completely different syntax. The command now uses syntax that forces the specification of the virtual machine to which the VNIC must be attached. The edit Vnic command no longer allows you to specify the network (the `network` option as been removed), but does allow you to specify the VNIC MAC address with the new `macAddress` option.
Vnic	The vnicCreate command to create multiple VNICs has been removed as VNICs can no longer exist within Oracle VM Manager outside of the context of a virtual machine.
Vnic	The show command can now take either the ID or name of a VNIC to display the properties of a VNIC object. Previously, you could only use the VNIC name.
Vm	The getIncompatibleReasons command is no longer available.
Vm	The create Vm command syntax to create a virtual machine on an Oracle VM Server has changed. A new `server` option is available and the `on Server` option has been removed.
YumConfig	The edit yumConfig command is no longer available. Instead, use the create ServerUpdateRepository command to set a YUM repository for Oracle VM Server software updates. The show YumConfig command has also been removed.

1.1.2 CLI New Features

This section lists the new commands introduced in Release 3.3.

Table 1.2 CLI New Features in Release 3.3

Object Type	Description
N/A	The set command now includes options to set the `CommandMode` to be synchronous or asynchronous, and the `CommandTimeout` to set when the CLI times out.
N/A	The setStatsConfig and getStatsConfig commands set and display the statistics information displayed in Oracle VM Manager.
N/A	The getDebugTranscript command displays the debug transcript of a job.
All	The getEventsForObject command displays the events for an object.
All	The getTriageEvent command displays the highest severity event for an object.
AccessGroup	The refresh command has a new `AccessGroup` option to refresh the configuration information for an AccessGroup object.
AntiAffinityGroup	The create AntiAffinityGroup command provides a way to create an anti affinity group for virtual machines in a server pool. There is also an edit AntiAffinityGroup to edit an anti affinity group. The add Vm and remove Vm commands now allow you to add and remove virtual machines to and from an anti affinity group respectively using the `AntiAffinityGroup` option. The show, list, and delete commands include the `AntiAffinityGroup` option to support this new feature.
Assembly	A new createVmFromAssembly command replaces the now removed createTemplatesFromAssembly command.
Assembly	A new getDescriptor command lists the contents of the OVF descriptor file for the assembly.
AssemblyVirtualDisk	A new command edit AssemblyVirtualDisk allows you to edit an AssemblyVirtualDisk object type. The show, and list, commands now have the `AssemblyVirtualDisk` option to support this new feature.
AssemblyVm	A new command edit AssemblyVm allows you to edit an AssemblyVm object type. The show, and list, commands now have the `AssemblyVm` option to support this new feature.
Assembly, VirtualCdrom, VirtualDisk, Vm	The following commands include a `proxy` option to include a proxy server during the import job if required. importAssembly importTemplate importVirtualCdrom importVirtualDisk importVirtualMachine
Bond, BondPort, VlanInterface	Three new commands allow editing of the ipAddressConfig object, which is an object associated with a parent network-related object that cannot be accessed directly with other CLI commands. This allows you to configure IP addresses on a port, bond port or VLAN interface. The new commands are: embeddedCreate embeddedEdit embeddedDelete
ControlDomain	A new edit ControlDomain command allows you to edit the ControlDomain object type. The show, and list, commands now have a `ControlDomain` option to support this new feature.
Cpu	A new edit Cpu command allows you to edit the Cpu object type. The show, and list, commands now an have a `Cpu` option to support this new feature.
CPUCompatibilityGroup	New commands to access the `CPUCompatibilityGroup` object type: create CpuCompatibilityGroup edit CpuCompatibilityGroup Commands that contain a new `CPUCompatibilityGroup` option: list show delete add Server remove Server
FileServer	The create FileServer command includes two new options to set `adminServers` and `refreshServers`.
FileServer	The edit FileServer command includes a new `plugin` option to set the Oracle VM Storage Connect plug-in for the file server.
FileServer, StorageArray	The addAdminServer command allows you to add an administrative Oracle VM Server to a file server or storage array. There is also a new removeAdminServer command that allows you to remove an administrative Oracle VM Server from a file server or storage array.
FileServer, FileSystem	The create FileSystem command creates an OCFS2 file system on a physical disk on a file server.
FileServerPlugin	A new edit FileServerPlugin command allows you to edit the FileServerPlugin object type. The show, and list, commands now an have a `FileServerPlugin` option to support this new feature.
Job	A new getJobs command lists jobs. A new getQueuedJobInfo command lists information about a queued job.
Manager	A new edit Manager command allows you to edit the Manager object type. The show, and list, commands now an have a `Manager` option to support this new feature.
PeriodicTask	A new edit PeriodicTask command allows you to edit the PeriodicTask object type. The show, and list, commands now an have a `PeriodicTask` option to support this new feature.
PhysicalDisk	The create PhysicalDisk command has a new mandatory `userFriendlyName` option.
PhysicalDisk, VirtualDisk	The resize command resizes a physical or virtual disk.
Repository	The show command with the Repository option displays a new parameter to show the share path.
RepositoryExport	The create RepositoryExport command provides a way to create a repository export to enable back up of an OCFS2-based storage repository. The show, list, and delete commands now have a `RepositoryExport` option to support this new feature. The show Server command now lists the repository exports on an Oracle VM Server.
Server	The setMaintenanceMode command sets whether an Oracle VM Server is in maintenance mode.
Server	The create ServerUpdateGroup command creates an object to contain a repository for updating the software on Oracle VM Servers. This group can be associated with a single server pool. There is also an associated edit ServerUpdateGroup command. The show, list, and delete commands include the `ServerUpdateGroup` option to support this new feature.
Server	The create ServerUpdateRepository command sets a repository for updating the software on Oracle VM Servers. This repository is then used in a server update group. There is also an associated edit ServerUpdateRepository command. The show, list, and delete commands include the `ServerUpdateRepository` option to support this new feature.
Server	The checkUpToDate command checks whether the Oracle VM Server software is up-to-date, according to the server update repository.
Server	The edit Server command now includes the `ntpServers` option to set one or more NTP servers on an Oracle VM Server to set the time. It also includes a `runVmsEnabled` option to set whether to allow additional virtual machines to run on the server.
Server	The show command with the Server option displays several new parameters: The new `Up To Date` parameter displays whether a software update is available for an Oracle VM Server from a server update repository. The new `Control Domains` parameter displays the details of any control domains that are running on the Oracle VM Server instance. The new `CPU Compatibility Groups` parameter describes the server processor compatibility group to which the Oracle VM Server belongs.
Server	The changeServerAgentPassword allows you to change the Oracle VM Agent password on an Oracle VM Server.
Server, FileServer, StorageArray	The refreshAll command rediscovers all Oracle VM Server instances, file servers, and storage arrays.
Server, Repository	A new takeOwnership command provides a way to take ownership of an Oracle VM Server or storage repository. There is also an associated releaseOwnership command.
ServerController	A new create ServerController command provides a way to configure IMPI on an Oracle VM Server. There is also an associated edit ServerController command. The show, list, and delete commands include the `ServerController` option to support this new feature.
ServerPool	The create ServerPool and edit ServerPool commands have new options for setting the cluster timeout (`clusterEnable`, and `clusterTimeout`) and setting the server pool policy (`policyMode`, `policyCpuEnable`, `policyPeriod`, and `policyCpuThreshold`).
ServerPool	The add ServerPool command has a new `AccessGroup` option. This option allows you to add a server pool to a file server access group (previously called NFS access group). In addition, the remove ServerPool command has a new `AccessGroup` option. This option allows you to remove a server pool from a file server access group.
ServerPoolNetworkPolicy	The create ServerPoolNetworkPolicy and edit ServerPoolNetworkPolicy commands provide a way manage the network policy for a server pool. The addPolicyServer and removePolicyServer commands allow to you add a policy server to a server pool, or to remove one. The show, list, and delete commands now have a `ServerPoolNetworkPolicy` option to support this new feature.
StorageArray	The create StorageArray command includes a `pluginPrivateData` option to allow the specification of additional Oracle VM Storage Connect plug-in parameters that are outside the scope of the parameters used to attach a generic storage array.
StorageArray	The create StorageArray and edit StorageArray commands have a new `storageName` option.
StorageArray	The edit StorageArray command includes a new `plugin` option to set the Oracle VM Storage Connect plug-in for the storage array.
StorageArray	The validate 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.
StorageArrayPlugin	The edit StorageArrayPlugin command allows you to edit the StorageArrayPlugin object type. The show, and list, commands now an have a `StorageArrayPlugin` option to support this new feature.
VirtualCdrom	The edit VirtualCdrom command now includes a `sharable` option to make the virtual CDROM/ISO file shareable.
VlanInterface	The commands to manage VLANs have changed significantly. The following commands have been introduced: create VlanInterface add VlanInterface remove VlanInterface The following commands now include a `VlanInterface` option: delete list show
Vm	The create Vm and edit Vm commands have an new `startPolicy` option to set the virtual machine start up policy. The show Vm command also shows the value for this parameter if it is set. The create Vm and edit Vm commands have an new `hugePagesEnabled` option to set whether to use HugePages.
Vm	The add Vm and remove Vm have a `ServerPool` option to add or remove a virtual machine to or from a server pool.
Vm	New commands are available to list all, or clear one or all messages sent or received by a virtual machine: getVmReceivedMessages getVmSentMessages clearVmSentMessage clearVmRcvdMessage clearVmAllSentMessages clearVmAllRcvdMessages
Vm	The getVmOsTypes command displays the operating system types used when creating or editing a virtual machine.
Vm	The getVmCfgFileContent command displays the contents of the virtual machine configuration file.
Vm, Repository	The moveVmToRepository command allows you to move a virtual machine to another storage repository.
VmCloneCustomizer, VmCloneNetworkMapping, VmCloneStorageMapping	The ability to add and manage virtual machine clone customizers is now available in the CLI. This includes the introduction of three new object types: `VmCloneCustomizer` `VmCloneNetworkMapping` `VmCloneStorageMapping` As with most object types, you can use the respective create, edit, delete, show, and list commands to manage these new object types: create VmCloneCustomizer edit VmCloneCustomizer create VmCloneNetworkMapping edit VmCloneNetworkMapping create VmCloneStorageMapping edit VmCloneStorageMapping list show delete This feature also facilitates a variety of cloning options. Newly added cloning commands are: cloneCdToRepo clonePdToPd clonePdToRepo clonePdToStorageArray cloneVdToPd cloneVdToRepo moveVmToRepository The clone Vm command also has a new `cloneCustomizer` option to include a clone customizer, and a `targetRepository` option to specify the target repository.
Vnic	The setVnicMacAddrRange command changes the range of MAC addresses that are available to use for newly created VNICs. The getVnicMacAddrRange lists the MAC address range.

1.1.3 CLI Object Attribute Changes

This section lists the changes to the attributes of CLI objects in Release 3.3.1. The attribute changes affect the output of the show command, and the options available with create object and edit object commands.

Table 1.3 CLI Object Attributes Changes in Release 3.3.1

Object	Attributes Added	Attributes Removed	Attributes Modified
AccessGroup	agType storageArray fileSystems servers fileServer locked	sanServer	Attribute description's display name has changed. Old display name is `description`. New display name is `Description`.
Assembly	origin locales assemblyVms assemblyVirtualDisks locked		Attribute repository's display name has changed. Old display name is `Repository Id`. New display name is `Repository`. Attribute description's display name has changed. Old display name is `description`. New display name is `Description`.
BondPort	ipAddressConfig network portType vlanInterfaces locked	ethernetPort1 ethernetPort2 addressType ipAddress netMask	Attribute description's display name has changed. Old display name is `description`. New display name is `Description`.
FileServer	fstype storageDescription refreshServers server locked	nfsRefreshServers adminHost adminUserName adminPassword	Attribute uniformedExports's display name has changed. Old display name is `UniformedExports`. New display name is `UniformExports`. Attribute description's display name has changed. Old display name is `description`. New display name is `Description`.
FileSystem	clusterId fileServers accessGroup physicalDisk shared locked	fileServer	Attribute description's display name has changed. Old display name is `description`. New display name is `Description`.
Job	runState summaryState done summaryDone jobGroup childJobs creationTime creationTimeLong startTimeLong endTimeLong durationDouble progressMessage abortedUser isAborted isAbortable id name locked	uniqueId timestamp status
ManagedObj	locked		Attribute description's display name has changed. Old display name is `description`. New display name is `Description`.
Network	isLocal mtu roles vlanInterfaces locked	vlanSegment	Attribute description's display name has changed. Old display name is `description`. New display name is `Description`.
PhysicalDisk	deviceNames storageTargetNames page83Id qos serverReserved state status pdtype userFriendlyName vendor accessGroups fileSystems reservingServers vmDiskMappings locked	sanserver	Attribute volumeGroup's display name has changed. Old display name is `VolumeGroup`. New display name is `Volume Group`. Attribute description's display name has changed. Old display name is `description`. New display name is `Description`.
Port	ipAddressConfig network bondPort portType vlanInterfaces locked	addressType ipAddress netMask	Attribute description's display name has changed. Old display name is `description`. New display name is `Description`.
Repository	managerUuid repoPresented virtualCdroms locked	serverPool physicalDisk ownership VirtualCdroms templates	Attribute fileSystem's display name has changed. Old display name is `FileSystem`. New display name is `File System`. Attribute description's display name has changed. Old display name is `description`. New display name is `Description`.
Server	roles runVmsEnabled agentLogin statisticInterval ntpServers biosVendor biosVersion biosReleaseDate processorType populatedProcessorSockets threadsPerCore coresPerProcessorSocket totalProcessorCores enabledProcessorCores usableMemory noExecuteFlag ovmVersion hostName managerUuid serverAbilities productSerialNumber upToDate controlDomains cpus controllers repositoryExports networks fileServerPlugins storageArrayPlugins storageArray storageArrayPlugin fileServerPlugin refreshFileServers AccessGroups locked	MACAddress numProcessors numISCSIPorts numEthernetPorts numFibrePorts memoryOverhead networkFailOverGroupsCount architectureType serialNumber processorFamily processorModel takeOwnership l1CacheSize l2CacheSize l3CacheSize BIOSVersion BIOSReleaseDate socketsAvailable socketsFilled managerUUID version	Attribute ipAddress's display name has changed. Old display name is `IP Address`. New display name is `Ip Address`. Attribute memory's display name has changed. Old display name is `Memory (GiB)`. New display name is `Memory (MB)`. Attribute cpuCompatibilityGroup's display name has changed. Old display name is `CPU Compatibility Group`. New display name is `Cpu Compatibility Group`. Attribute tags' display name has changed. Old display name is `tag`. New display name is `Tag`. Attribute description's display name has changed. Old display name is `description`. New display name is `Description`.
ServerPool	antiAffinityGroups clusterTimeout policyId clusterId heartbeatDeviceId managerUuid poolFileSystem policyMode policyCpuEnable policyPeriod policyCpuThreshold policyServers networkPolicies serverUpdateGroup locked		Attribute tags' display name has changed. Old display name is `tag`. New display name is `Tag`. Attribute startPolicy's display name has changed. Old display name is `startPolicy`. New display name is `StartPolicy`. Attribute description's display name has changed. Old display name is `description`. New display name is `Description`.
StorageInitiator	accessGroupIds initType fcFabricName fcPortId fcPortType fcPortSpeed fcSupportedSpeeds fcNodeName locked		Attribute description's display name has changed. Old display name is `description`. New display name is `Description`.
Tag	locked		Attribute description's display name has changed. Old display name is `description`. New display name is `Description`.
VirtualCdrom	vmDiskMapping shareable assemblyVirtualDisk importFileName locked	vms	Attribute description's display name has changed. Old display name is `description`. New display name is `Description`.
VirtualDisk	file mountPoint vmDiskMapping assemblyVirtualDisk importFileName locked	status vms	Attribute description's display name has changed. Old display name is `description`. New display name is `Description`.
VlanInterface	interfaceName port portType vlanId ipAddressConfig network macAddress locked	vlansegment addressType ipAddress netMask	Attribute description's display name has changed. Old display name is `description`. New display name is `Description`.
Vm	currentMemory currentCpuCount startPolicy bootOrder diskLimit hugePagesEnabled serverPool vmCloneCustomizers locked	cpuCompatibilityGroupName networkBootPath	Attribute tags' display name has changed. Old display name is `tag`. New display name is `Tag`. Attribute description's display name has changed. Old display name is `description`. New display name is `Description`.
VmDiskMapping	slot virtualDisk virtualCd physicalDisk locked	storageDevice	Attribute vm's display name has changed. Old display name is `Vm Id`. New display name is `Vm`. Attribute description's display name has changed. Old display name is `description`. New display name is `Description`.
Vnic	ipAddresses interfaceName locked	ipAddress	Attribute vm's display name has changed. Old display name is `Vm Id`. New display name is `Vm`. Attribute network's display name has changed. Old display name is `Network Id`. New display name is `Network`. Attribute description's display name has changed. Old display name is `description`. New display name is `Description`.
VolumeGroup	allocatedSize volumeDescription storageArray locked	sanserver	Attribute description's display name has changed. Old display name is `description`. New display name is `Description`.