VirtualGuest class (Provider API)

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

create

POST

csm/VirtualGuest

Creates a VirtualGuest object.

delete

DELETE

csm/VirtualGuest/guid

Deletes a VirtualGuest object.

update

POST

csm/VirtualGuest/guid/update

Updates a VirtualGuest object.

Operation APIs

Name

HTTP
method

URI

Description

execute_host_script

POST

csm/VirtualGuest/guid/execute_host_script

Executes a host script.

execute_script

POST

csm/VirtualGuest/guid/execute_script

Executes a script.

restart

POST

csm/VirtualGuest/guid/restart

resume

POST

csm/VirtualGuest/resume

Resumes a virtual guest.

shutdown

POST

csm/VirtualGuest/guid/shutdown

Shuts down a virtual guest.

stop

POST

csm/VirtualGuest/stop

Stops a virtual guest.

suspend

POST

csm/VirtualGuest/suspend

Suspends a virtual guest.

vg_offboard

POST

csm/VirtualGuest/guid/vg_offboard

vg_onboard

POST

csm/VirtualGuest/vg_onboard

Onboards virtual guests.

Relationship APIs

The VirtualGuest class has no relationship APIs.

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

operatingSystem

OperatingSystem

0..1

Server operating system

software

ApplicationSoftware

0..*

Software that runs on the server

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

isAvailable

Boolean

0..1

This attribute lets one know about whether this instance is available. The value is derived from its provider when a sync/refresh operation happens

moRef

String

0..1

This represents the unique id from the virtualization vendor. This can be used to identify the instance uniquely

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

labels

String

0..*

modifiedDate

Date

0..1

Date the Cloudobject was modified

name

String

1

Human-readable name of the object

Was this page helpful? Yes No Submitting... Thank you

Comments