JavaScript must be enabled to correctly display this content

Chapter 1 What's New in the Oracle VM Manager Command Line Interface (CLI)?

This section lists the syntax changes in the Oracle VM Manager Command Line Interface (CLI) from previous releases. Included in this section are any changes or deletions to existing commands and options, as well as new commands or options. This section may be useful when migrating your CLI scripts from previous releases of the CLI.

1.1 CLI Changes in Release 3.4

This section lists the changes and new features to the CLI in Release 3.4.

1.1.1 CLI Modifications

This section lists the modifications made to existing CLI commands.

Table 1.1 CLI Modifications in Release 3.4

Object Type	Description
N/A	You can set some command options to be empty strings. You may want to do this to clear Oracle VM Server roles, network roles, clear NTP servers, or clear an object's description. No syntax changes have been made in commands, but the logic behind string options has changed. Where these changes are appropriate, they are noted in the commands in Appendix A, CLI Command Reference. For example, to clear Oracle VM Server roles you would use: edit Server name=MyServer roles=""
N/A	You can mask attribute values on screen, as they are entered, by appending an asterisk (``) to the attribute name. This security measure is described in Section 2.6.2, “Masking Sensitive Data”. For example: OVM> sendVmMessage Vm name=MyVM key=com.oracle.linux.root-password message=`*****` log=No
AccessGroup	The edit AccessGroup command now includes a `nameOnArray` option to change the name on the storage array.
Assembly	The Assembly object, and the commands related to the Assembly object, have been deprecated. From this release, you should instead use the new VirtualAppliance object and associated commands. The commands related to the Assembly object are honored by the CLI, but there will be no future improvements to those commands. The following commands have been deprecated: The `Assembly`, `AssemblyVirtualDisk`, and `AssemblyVm` options of the list command. The `Assembly`, `AssemblyVirtualDisk`, and `AssemblyVm` options of the show command. The `Assembly` option of the delete command. The `Assembly` option of the refresh command. The `Assembly` option of the getDescriptor command. The edit Assembly (Deprecated) command. The edit AssemblyVirtualDisk (Deprecated) command. The edit AssemblyVm (Deprecated) command. The createVmFromAssembly (Deprecated) command. The importAssembly (Deprecated) command.
ServerPool	The `virtualIP` option of the create ServerPool command is now optional and deprecated. This is no longer required when creating a server pool.
Vm	The `hugePagesEnabled` option has been deprecated and will be removed in a future release. This option applies to the create Vm and edit Vm commands.

1.1.2 CLI New Features

This section lists the new commands introduced in Release 3.4.

Table 1.2 CLI New Features in Release 3.4

Object Type	Description
N/A	A new setArchiveConfig command configures how Oracle VM Manager manages archived statistics.
N/A	A new getArchiveConfig command shows the configuration for managing archived statistics.
N/A	A new showclisession command lists the CLI session options set using the set command.
N/A	The set command now includes an `AlphabetizeAttributes` option to display the output of the show command in alphabetical order.
Event	The getEventListByQuery command lists events for objects using a query to narrow results.
Event	The getTriageEventSeverityList command lists the highest severity event for one or more objects.
Manager	A new getManagerTime command displays the Oracle VM Manager time.
Manager	There are two new commands to list and set Oracle VM Manager automated database backup configuration parameters. The new commands are: getDbBackupConfig: Lists the values for configuration parameters related to database backup configuration. setDbBackupConfig: Sets the values for configuration parameters related to database backup configuration.
StorageArray	The edit StorageArray command now has a `lipScan` option that allows you to enable a Loop Initialization (LIP) for an Unmanaged FibreChannel Storage Array.
ServerPool, Vm	The `startPolicy` command now includes a `BALANCE_SERVER` option that can be used when defining the default start-up policy for all of your virtual machines. This option applies to the following commands: create ServerPool edit ServerPool create Vm edit Vm
Statistic	The getStatListByQuery command lists statistic for objects using a query to narrow results.
Statistic, Server, Vm	There are four new commands to list statistics for an Oracle VM Server or virtual machine. The new commands are: getAverageStat: Lists the average value of a statistic type for an object during a time range. getLatestStat: Lists the latest value of a statistic type for an object. getLatestStatForList: Lists the latest value of a statistic type for a list of objects. getStatList: Lists statistic types for an object.
VirtualAppliance	A new VirtualAppliance object has been added. This should be used instead of the Assembly object, which has been deprecated in this release. The new commands related to the VirtualAppliance object are: New `VirtualAppliance`, `VirtualApplianceVirtualDisk`, and `VirtualApplianceVm` options of the list command. New `VirtualAppliance`, `VirtualApplianceVirtualDisk`, and `VirtualApplianceVm` options of the show command. A new `VirtualAppliance` option of the delete command. A new `VirtualAppliance` option of the refresh command. A new `VirtualAppliance` option of the getDescriptor command. The edit VirtualAppliance command. The edit VirtualApplianceVirtualDisk command. The edit VirtualApplianceVm command. The createVmFromVirtualAppliance command. The createVmFromVirtualApplianceVm command. The importVirtualAppliance command. The exportVirtualAppliance command.
Vm	The create Vm and edit Vm commands have a new `viridian` option that enables the exposure of Windows virtualization compatible entitlements to Microsoft Windows guest operating systems.
Vm	The create Vm and edit Vm commands have a new `restartActionOnCrash` option to set the action to perform in the case where a virtual machine crashes.
Vm	The migrateWithLocalStorage Vm command migrates a virtual machine to an Oracle VM Server in the same server pool, including moving the local storage to a storage repository.

1.1.3 CLI Object Attribute Changes

This section lists the changes to the attributes of CLI objects in Release 3.4. 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.4

Object	Attributes Added	Attributes Removed	Attributes Modified
PhysicalDisk	`absolutePaths` `storageArray`	N/A	N/A
Repository	`apparentSize` `oversubscription`	N/A	N/A
ServerAbility	`vmRestartActions` `vmLiveStorageMigration` `abilities`	N/A	N/A
ServerPool	`BALANCE_SERVER`	N/A	N/A
StorageArray	`lipScan`	N/A	N/A
VirtualApplianceVirtualDisk, which replaces the deprecated AssemblyVirtualDisk object.	N/A	N/A	Display names of attributes have changed: From `Populated Size` to `Populated Size (Bytes)`. From `Capacity` to `Capacity (Bytes)`.
VirtualDisk	`absolutePath` `mountedPath`	N/A	N/A
Vm	`vmConfigFileAbsolutePath` `vmConfigFileMountedPath` `restartActionOnCrash` `viridian` `BALANCE_SERVER`	N/A	N/A