CLASS VM

This class requires the licenses CONWRKS-ESXSERV, CONWRKS-VCSERV, CONWRKS-XENSERV, and CONWRKS-CTXXENSERV. It uses standard functions and actions to perform VM related operations.

Required Licenses

License
CONWRKS-ESXSERV
CONWRKS-VCSERV
CONWRKS-XENSERV
CONWRKS-CTXXENSERV

Class Field Properties

Name	Codename	Description	Ability	Length
curpriv	CurrentPrivs	Current Privileges	RO	255
consolename	ConsoleName	Console Name	RO	140

Class Functions

Name	Description
static add	VM.add(name) takes an argument, VM name. The VM name can be explicit or checked for existence then retrieved with VM.getNames(). User must have create privileges. VM.add() creates a named VM object.
static AddConsole	AddConsole() takes no arguments. This standard function adds a console with the named asset object.
static cancel	cancel() takes no arguments. User must have cancel privileges. This standard function removes any pending edits on the object. Used with VM.get(name).
static close	VM.close() takes no arguments.
static ConfigureSerial	ConfigureSerial() takes no arguments. This standard function configures the serial connection of the named asset object.
static connect	VM.connect() takes no arguments.
static create	VM.create() takes no arguments.
static delete	VM.delete() takes no arguments.
static DeleteConsole	DeleteConsole() takes no arguments. This standard function deletes the associated console of the named asset object.
static DropConsole	DropConsole() takes no arguments. This standard function drops the connection to the associated console of the named asset object.
static ExclusiveConnect	VM.ExclusiveConnect() takes no arguments.
static exists	VM.exists() takes no arguments.
static get	VM.get(name) takes an argument, name. This standard function gets and returns the named VM object. If the object name exists, it returns the object name. If the object name does not exist, it throws an exception.
static getCount	VM.getCount() takes no arguments. This standard function gets the number of defined VM resources.
static getFetchLevel	VM.getFetchLevel() takes no arguments.
static getList	VM.getList() takes no arguments. This standard function gets and returns an arrary (list) of UserPreference resources.
static getLog	VM.getLog() takes no arguments.
static getLogCalendar	VM.getLogCalendar() takes no arguments.
static getNames	VM.getNames() takes no arguments. This standard function gets and returns an array of strings object with the VM names.
static getRange	VM.getRange() takes no arguments.
static getUsage	VM.getUsage() takes no arguments.
static isConnected	VM.isConnected() takes no arguments.
static isNew	isNew() takes no arguments and returns a boolean value. This standard function checks for object existence, to create or update when save is called. The function returns true if the object does not exist on the server and will create one when save() is called. It returns false if the object exists and will update the object when save() is called.
static log	VM.log() takes no arguments.
static logScannable	VM.logScannable() takes no arguments.
static Migrate	Migrate() takes no arguments. This standard function performs the migration action on the named asset object.
static monitor	VM.monitor() takes no arguments.
static Pause	Pause() takes no arguments. This standard function pauses the current connection of the named asset object.
static PowerOff	PowerOff() takes no arguments. This standard function turns off the named asset object.
static PowerOn	PowerOn() takes no arguments. This standard function turns on the named asset object.
static PowerOnToHost	PowerOnToHost() takes no arguments. This standard function gets the state of the power to the named asset object.
static read	VM.read() takes no arguments.
static refresh	VM.refresh() takes no arguments.
static Restart	Restart() takes no arguments. This standard function restarts the named asset object.
static Resume	Resume() takes no arguments. This standard function resumes the named asset object, restoring it to normal if it had been paused.
static ResumeToHost	ResumeToHost() takes no arguments. This standard function checks to see if the connection to the named asset object is currently suspended.
static save	save() takes no arguments. User must have save privileges. This standard function saves to the server a VM object and the appropriate logs. This includes any pending edits made on the object. save() throws an exception if validation or save fails.
static setFetchLevel	VM.setFetchLevel() takes no arguments.
static Stop	Stop() takes no arguments. This standard function stops the connection with the named asset object.
static Suspend	Suspend() takes no arguments. This standard function suspends the connection of the named asset object.
static TestMigrate	TestMigrate() takes no arguments. This standard function performs a test migration on the named asset object.
static UnconfigureSerial	UnconfigureSerial() takes no arguments. This standard function unconfigures the serial connection of the named asset object.
static Unpause	Unpause() takes no arguments. This standard function unpauses the named asset object.
static update	VM.update() takes no arguments.
static VMSetup	VMSetup() takes no arguments. This standard function runs the VMSetup actiton on the named asset object.
static write	VM.write() takes no arguments.
static XENChngAuth	XENChngAuth() takes no arguments. This standard function changes the authentication of the associated XEN object.
static XENChngPass	XENChngPass() takes no arguments. This standard function changes the password of the associated XEN object.
static XENGetHost	XENGetHost() takes no arguments. This standard function gets the host of the associated XEN object.
static XENMigrate	XENMigrate() takes no arguments. This standard function migrates the associated XEN object.

Class Privilege Properties

Type	Name
CREATE	Add
DELETE	Delete
VIEW	View
MODIFY	Edit
AWARE	Aware
POWERON	Power On
POWERONTOHOST	Power On to Host
POWEROFF	Power Off
STOP	Guest Shutdown
PAUSE	Pause VM
CONTINUE	Unpause VM
SUSPEND	Suspend
RESUME	Resume
RESUMETOHOST	Resume to Host
RESTART	Guest Restart
MIGRATE	Migrate
ADDCONSOLE	Add Console
DROPCONSOLE	Drop Console
DELCONSOLE	Delete Console
CONFIGSERIAL	Configure serial
UNCONFIGSERIAL	Unconfigure serial
XENCHNGPASS	Change XEN Password
XENCHNGAUTH	Change XEN Auth
XENGETHOST	Get Possible XEN Hosts
XENMIGRATE	XEN Migrate
VMSETUP	Setup VM