VirtualGuest class

The VirtualGuest class represents a virtual guest hosted on a virtual resource pool, virtual cluster or virtual host. Different provisioning scenarios provision to different targets (pool, cluster or host). We track that the VM has been created, the compute container it underpins, and the object hosting it (pool, cluster or host).

VirtualGuest class APIs

The following tables list the basic APIs, operation APIs, and relationship APIs for the VirtualGuest class.

Basic APIs

Name	HTTP method	URI	Description
get	`GET`	`csm/VirtualGuest/guid`	Retrieves a `VirtualGuest` object.
search	`POST`	`csm/VirtualGuest/search`	Searches for `VirtualGuest` objects.

Operation APIs

The VirtualGuest class has no operation APIs.

Relationship APIs

Name	HTTP method	URI	Description
relation	`GET`	`csm/VirtualGuest/guid/cpuSensor`	Retrieves the `cpuSensor` relationship.
relation	`GET`	`csm/VirtualGuest/guid/memorySensor`	Retrieves the `memorySensor` relationship.
relation	`GET`	`csm/VirtualGuest/guid/virtualCluster`	Retrieves the `virtualCluster` relationship.
relation	`GET`	`csm/VirtualGuest/guid/virtualHost`	Retrieves the `virtualHost` relationship.
relation	`GET`	`csm/VirtualGuest/guid/virtualResourcePools`	Retrieves the `virtualResourcePools` relationship.
relation	`GET`	`csm/VirtualGuest/guid/hostedContainers`	Retrieves the `hostedContainers` relationship.
relation	`GET`	`csm/VirtualGuest/guid/localDisks`	Retrieves the `localDisks` relationship.
relation	`GET`	`csm/VirtualGuest/guid/nics`	Retrieves the `nics` relationship.
relation	`GET`	`csm/VirtualGuest/guid/operatingSystem`	Retrieves the `operatingSystem` relationship.
relation	`GET`	`csm/VirtualGuest/guid/serverNetworkInterface`	Retrieves the `serverNetworkInterface` relationship.
relation	`GET`	`csm/VirtualGuest/guid/software`	Retrieves the `software` relationship.
relation	`GET`	`csm/VirtualGuest/guid/storageConnection`	Retrieves the `storageConnection` relationship.
relation	`GET`	`csm/VirtualGuest/guid/provider`	Retrieves the `provider` relationship.
relation	`GET`	`csm/VirtualGuest/guid/tags`	Retrieves the `tags` relationship.

VirtualGuest class relationships and attributes

The following tables list the relationships and attributes of the VirtualGuest class.

Relationships

Name	Type	Multi- plicity	Description
`cpuSensor`	`BaseCPUSensor`	0..1	CPU sensor that monitors the virtual guest
`memorySensor`	`BaseMemorySensor`	0..1	Memory sensor that monitors the virtual guest
`virtualCluster`	`VirtualCluster`	0..1	Virtual cluster that hosts the virtual guest
`virtualHost`	`VirtualHost`	0..1	Virtual host that hosts the virtual guest
`virtualResourcePools`	`VirtualResourcePool`	0..1	Virtual resource pool that hosts the virtual guest
`hostedContainers`	`ComputeContainer`	0..1	Compute containers hosted on the server
`localDisks`	`LocalDisk`	0..*	Local disks
`nics`	`NetworkInterface`	1..*	Network interface cards that can access the server
`operatingSystem`	`OperatingSystem`	0..1	Server operating system
`serverNetworkInterface`	`ServerNetworkInterface`	1..*	Server network interfaces that can access the server
`software`	`ApplicationSoftware`	0..*	Software that runs on the server
`storageConnection`	`StorageConnection`	0..*	Storage connections the server can access
`cloudClass`	`CloudClass`	1	Fully-qualified name of the class to which the object belongs
`provider`	`Provider`	1	Provider that created the object
`tags`	`Tag`	0..*	Tags associated with the object

Attributes

Name	Type	Multi- plicity	Description
`state`	`VirtualGuestState`	1	Current state of the virtual guest
`vmuuid`	`String`	1	Unique identifier of the server provided by the virtualization vendor
`cpuClockSpeed`	`Float`	0..1	CPU clock speed measured in GHz
`domain`	`String`	0..1	Primary domain for the server
`hostName`	`String`	0..1	Host name of the server
`serialNumber`	`String`	0..1	The server serial number, as reported by the operating system.
`totalCpus`	`Integer`	0..1	Number of CPU cores on the server
`hwArchitecture`	`HardwareArchitectureType`	0..1	Hardware architecture of the server
`providerCategorizationTier3`	`String`	0..*	Values from the `InstallableResource` class `categorizationTier3` attribute that are valid installable resource types for this infrastructure resource
`totalMemory`	`Integer`	0..1	Total amount of memory available to be allocated to guests. Measured in GB.
`vendor`	`String`	0..1	Name of the virtualization vendor, such as VMWare
`isOnboarded`	`Boolean`	1	Indicates whether the object is onboarded
`externalID`	`String`	0..1	Identifier used for the object by an external provider
`owner`	`String`	0..1	Name of the owner of the object
`reconciliationID`	`String`	0..1	Reconciliation identity value for the object from the BMC Atrium CMDB
`tokenID`	`String`	0..1	Token identifier
`description`	`String`	0..1	Text that describes the object
`guid`	`String`	1	Globally unique identifier for the object
`name`	`String`	1	Human-readable name of the object