Search

Class GEFMachine

Extends com.vmware.o11n.plugin.genericendpoint.model.ContainerWithProperties
Operation request information

Attributes

Name Type Description
allowsHotCpu boolean If true allow CPUs to be changed on a running machine
allowsHotMemory boolean If true allow memory to be changed on a running machine
archiveDays Number Gets the number of days to archive the machine after the lease expires. (readonly)
blueprintType Number Blueprint type of the virtual machine 0 - General Workstation 1 - General Server 2 - Hypervisor 3 - Container (required)
cdroms GEFMachineCdrom[]
childMachines GEFMachine[]
computeResource GEFComputeResource Gets or sets The host the virtual machine resides on. Data Collection: Required, but only the uniqueID is expected to be provided. Provisioning: The entire object will be provided by vCAC
connectAddress String Address that should be used fro RDP/SSH sessions to the machine.
cpuCount Number Gets or sets the number of CPUs of the virtual machine. (required)
dnsName String Gets or sets The fully qualified domain name of the virtual machine. (optional)
expires java.util.Date Gets the expiration date of the virtual machine. (readonly)
externalReferenceId String
guestOperatingSystem String Gets or sets the Guest OS of the machine. Note: This is a free form string that represents the specific OS. (required)
guestOperatingSystemFamily String Gets or sets the Guest OS family of the machine. Note: While this is a free form text field, any windows based OS is expected to start with the prefix 'win'. (required)
instanceTypeId String Gets or sets the instance type id. (required)
instanceTypeName String Gets or sets the instance type name. (required)
isComponent boolean True is the machine is a component of a multimachine.
isTemplate boolean Whether the current machine is a template that can be cloned from or a usable machine.
leaseDays java.lang.Integer Gets the number of days the machine is leased for. (readonly)
machineName String Gets or sets the name of the virtual machine. (required)
memoryBytes Number Gets or sets the total memory in MB of the machine. (required)
networks GEFMachineNetwork[]
notes String Gets or sets user entered notes about the virtual machine. (optional)
ownerUserName String Gets or sets the owner user name. This is the account of the owner within vCAC. Data Collection: This value is expected to be null. Provisioning: This value will be provided by vCAC and should not be altered. (readonly)
parentMachine GEFMachine If this is a component of a multimachine then this is the parent machine.
running boolean Gets or sets a value indicating whether the machine is running or not. (optional)
state String Gets or sets The current state of the virtual machine (on, off, etc). (required)
storagePath String Gets or sets the storage path of the machine. (optional)
storages GEFMachineStorage[]
totalStorageBytes Number Gets or sets the total disk storage used by the machine. (required)
uniqueId String Gets or sets External System Identifier for the machine entry. (required)

Methods

Name Returns
addAnnotation(String name, String value) void
addCdrom(GEFMachineCdrom cdrom) void
addChildMachine(GEFMachine machine) void
addCustomProperty(String name, String value) void
addNetwork(GEFMachineNetwork network) void
addStorage(GEFMachineStorage storage) void
addVendorCustomProperty(String name, String value) void
build(String uniqueId) GEFMachine
getAnnotation(String name) GEFPropertyItem
getAnnotations() GEFPropertyItem[]
getCustomProperties() GEFPropertyItem[]
getCustomProperty(String name) GEFPropertyItem
getVendorCustomProperties() GEFPropertyItem[]
getVendorCustomProperty(String name) GEFPropertyItem

Returned by

Method Returns
GEFMachine.build(String uniqueId) GEFMachine

Referenced in

Method Returns
GEFMachine.addChildMachine(GEFMachine machine) void