A.165 set

Sets CLI session configuration options.


set { AlphabetizeAttributes= { Yes | No } | CommandMode= { Asynchronous | Synchronous } | CommandTimeout= value | EndlineChars= { CRLF | CR | LF } | OutputMode= { Verbose | Sparse | Xml } }


This command sets the CLI session configuration options. To show the values for the CLI session options, use the showclisession command.


The following table shows the available options for this command.



AlphabetizeAttributes= { Yes | No }

Sets whether the CLI should return output from the show command in alphabetical order. The default is No.


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.


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