org.jclouds.dmtf.cim

Class VirtualSystemSettingData

java.lang.Object

org.jclouds.dmtf.cim.VirtualSystemSettingData

public class VirtualSystemSettingData
extends Object

VirtualSystemSettingData defines the virtual aspects of a virtual system through a set of virtualization specific properties. VirtualSystemSettingData is also used as the top level class of virtual system configurations. Virtual system configurations model configuration information about virtual systems and their components. A virtual system configuration consists of one top-level instance of class VirtualSystemSettingData that aggregates a number of instances of class ResourceAllocationSettingData, using association {@link ConcreteComponent).

Virtual system configurations may for example be used to reflect configurations of:

• virtual systems that are defined at a virtualization platform
• virtual systems that are currently active
• input requests to create new virtual systems
• input requests to modify existing virtual systems
• snapshots of virtual systems

Author:

Adrian Cole, grkvlt@apache.org

See Also:

CIM_VirtualSystemSettingData

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VirtualSystemSettingData.AutomaticRecoveryAction Action to take for the virtual system when the software executed by the virtual system fails.
static class	VirtualSystemSettingData.AutomaticShutdownAction Action to take for the virtual system when the host is shut down.
static class	VirtualSystemSettingData.AutomaticStartupAction Action to take for the virtual system when the host is started.
static class	VirtualSystemSettingData.Builder<B extends VirtualSystemSettingData.Builder<B>>

Method Summary

Methods

Modifier and Type	Method and Description
static VirtualSystemSettingData.Builder<?>	builder()
boolean	equals(Object obj)
VirtualSystemSettingData.AutomaticRecoveryAction	getAutomaticRecoveryAction() Action to take for the virtual system when the software executed by the virtual system fails.
VirtualSystemSettingData.AutomaticShutdownAction	getAutomaticShutdownAction() Action to take for the virtual system when the host is shut down.
VirtualSystemSettingData.AutomaticStartupAction	getAutomaticStartupAction() Action to take for the virtual system when the host is started.
BigInteger	getAutomaticStartupActionDelay() Delay applicable to startup action.
Long	getAutomaticStartupActionSequenceNumber() Number indicating the relative sequence of virtual system activation when the host system is started.
String	getCaption() The Caption property is a short textual description (one- line string) of the object.
String	getConfigurationDataRoot() Filepath of a directory where information about the virtual system configuration is stored.
String	getConfigurationFile() Filepath of a file where information about the virtual system configuration is stored.
String	getConfigurationID() Unique id of the virtual system configuration.
Date	getCreationTime() Time when the virtual system configuration was created.
String	getDescription() The Description property provides a textual description of the object.
String	getElementName() The user-friendly name for this instance of SettingData.
String	getInstanceID() Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class.
String	getLogDataRoot() Filepath of a directory where log information about the virtual system is stored.
String	getNotes() End-user supplied notes that are related to the virtual system.
String	getRecoveryFile() Filepath of a file where recovery related information of the virtual system is stored.
String	getSnapshotDataRoot() Filepath of a directory where information about virtual system snapshots is stored.
String	getSuspendDataRoot() Filepath of a directory where suspend related information about the virtual system is stored.
String	getSwapFileDataRoot() Filepath of a directory where swapfiles of the virtual system are stored.
String	getVirtualSystemIdentifier() VirtualSystemIdentifier shall reflect a unique name for the system as it is used within the virtualization platform.
String	getVirtualSystemType() VirtualSystemType shall reflect a particular type of virtual system.
int	hashCode()
VirtualSystemSettingData.Builder<?>	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

builder

public static VirtualSystemSettingData.Builder<?> builder()

toBuilder

public VirtualSystemSettingData.Builder<?> toBuilder()

getElementName

public String getElementName()

The user-friendly name for this instance of SettingData. In addition, the user-friendly name can be used as an index property for a search or query. (Note: The name does not have to be unique within a namespace.)

getInstanceID

public String getInstanceID()

Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class.

getCaption

public String getCaption()

The Caption property is a short textual description (one- line string) of the object.

getDescription

public String getDescription()

The Description property provides a textual description of the object.

getAutomaticRecoveryAction

public VirtualSystemSettingData.AutomaticRecoveryAction getAutomaticRecoveryAction()

Action to take for the virtual system when the software executed by the virtual system fails. Failures in this case means a failure that is detectable by the host platform, such as a non-interuptable wait state condition.

getAutomaticShutdownAction

public VirtualSystemSettingData.AutomaticShutdownAction getAutomaticShutdownAction()

Action to take for the virtual system when the host is shut down.

getAutomaticStartupAction

public VirtualSystemSettingData.AutomaticStartupAction getAutomaticStartupAction()

Action to take for the virtual system when the host is started.

getAutomaticStartupActionDelay

public BigInteger getAutomaticStartupActionDelay()

Delay applicable to startup action. The value shall be in the interval variant of the datetime datatype.

getAutomaticStartupActionSequenceNumber

public Long getAutomaticStartupActionSequenceNumber()

Number indicating the relative sequence of virtual system activation when the host system is started. A lower number indicates earlier activation. If one or more configurations show the same value, the sequence is implementation dependent. A value of 0 indicates that the sequence is implementation dependent.

getConfigurationDataRoot

public String getConfigurationDataRoot()

Filepath of a directory where information about the virtual system configuration is stored. Format shall be String based on RFC-2079.

getConfigurationFile

public String getConfigurationFile()

Filepath of a file where information about the virtual system configuration is stored. A relative path appends to the value of the getConfigurationDataRoot() property.

Format shall be String based on RFC-2079.

getConfigurationID

public String getConfigurationID()

Unique id of the virtual system configuration. Note that the ConfigurationID is different from the InstanceID as it is assigned by the implementation to a virtual system or a virtual system configuration. It is not a key, and the same value may occur within more than one instance.

getCreationTime

public Date getCreationTime()

Time when the virtual system configuration was created.

getLogDataRoot

public String getLogDataRoot()

Filepath of a directory where log information about the virtual system is stored. A relative path appends to the value of the getConfigurationDataRoot() property.

Format shall be String based on RFC-2079.

getRecoveryFile

public String getRecoveryFile()

Filepath of a file where recovery related information of the virtual system is stored. Format shall be String based on RFC-2079.

getSnapshotDataRoot

public String getSnapshotDataRoot()

Filepath of a directory where information about virtual system snapshots is stored. A relative path appends to the value of the getConfigurationDataRoot() property.

Format shall be String based on RFC-2079.

getSuspendDataRoot

public String getSuspendDataRoot()

Filepath of a directory where suspend related information about the virtual system is stored. A relative path appends to the value of the getConfigurationDataRoot() property.

Format shall be String based on RFC-2079.

getSwapFileDataRoot

public String getSwapFileDataRoot()

Filepath of a directory where swapfiles of the virtual system are stored. A relative path appends to the value of the getConfigurationDataRoot() property.

Format shall be String based on RFC-2079.

getVirtualSystemIdentifier

public String getVirtualSystemIdentifier()

VirtualSystemIdentifier shall reflect a unique name for the system as it is used within the virtualization platform. Note that the VirtualSystemIdentifier is not the hostname assigned to the operating system instance running within the virtual system, nor is it an IP address or MAC address assigned to any of its network ports. On create requests VirtualSystemIdentifier may contain implementation specific rules (like simple patterns or regular expression) that may be interpreted by the implementation when assigning a VirtualSystemIdentifier.

getVirtualSystemType

public String getVirtualSystemType()

VirtualSystemType shall reflect a particular type of virtual system.

getNotes

public String getNotes()

End-user supplied notes that are related to the virtual system.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object