VirtualHost class (Provider API)

The VirtualHost class represents a physical server used to host virtual guests.

VirtualHost class APIs

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

Basic APIs

Name

HTTP
method

URI

Description

get

GET

csm/VirtualHost/guid

Retrieves a VirtualHost object.

Operation APIs

Name

HTTP
method

URI

Description

offboard

POST

csm/VirtualHost/offboard

Offboards virtual hosts.

onboard

POST

csm/VirtualHost/onboard

Onboards virtual hosts.

Relationship APIs

The VirtualHost class has no relationship APIs.

VirtualHost class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

cpuSensor

BaseCPUSensor

0..1

CPU sensor that monitors the virtual host

memorySensor

BaseMemorySensor

0..1

Memory sensor that monitors the virtual host

virtualCluster

VirtualCluster

1

Virtual cluster associated with the virtual host

VMs

VirtualGuest

0..*

Virtual machines hosted by the virtual host

operatingSystem

OperatingSystem

0..1

Server operating system

software

ApplicationSoftware

0..*

Software that runs on the server

Attributes

Name

Type

Multi-
plicity

Description

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