Unsupported content

 

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

ComputeContainer class

The ComputeContainer class represents all types of compute capability, including physical, virtual, and external providers such as Amazon EC2. It provides a level of abstraction that facilitates consistent administration of all types of compute resources.

ComputeContainer class APIs

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

Basic APIs

Name

HTTP
method

URI

Description

get

GET

csm/ComputeContainer/guid

Retrieves a ComputeContainer object.

search

POST

csm/ComputeContainer/search

Searches for ComputeContainer objects.

Operation APIs

Name

HTTP
method

URI

Description

addLocalDisk

POST

csm/ComputeContainer/guid/addLocalDisk

Adds a local disk to the compute container.

decommission

POST

csm/ComputeContainer/guid/decommission

Decommissions the specified compute container.

executeHostScript

POST

csm/ComputeContainer/guid/executeHostScript

Executes a script.

executeScript

POST

csm/ComputeContainer/guid/executeScript

Executes a script on the specified compute container.

fence

POST

csm/ComputeContainer/guid/fence

Changes the compute container state to Fenced.

quiesce

POST

csm/ComputeContainer/guid/quiesce

Changes the compute container state to Quiesced.

refreshIPPOSTcsm/ComputeContainer/guid/refreshIP Refreshes IP address of a VM.

removeLocalDisk

POST

csm/ComputeContainer/guid/removeLocalDisk

Removes a local disk from the compute container.

resizeLocalDiskPOST

csm/ComputeContainer/guid/resizeLocalDisk

Resizes the local disk on the compute container.

removeNic

POST

csm/ComputeContainer/guid/removeNic

resume

POST

csm/ComputeContainer/guid/resume

Changes the state of the compute container to Running.

start

POST

csm/ComputeContainer/guid/start

Starts the specified computer container.

stop

POST

csm/ComputeContainer/guid/stop

Stops the specified computer container.

suspend

POST

csm/ComputeContainer/guid/suspend

Changes the state of the compute container to Suspended.

unfence

POST

csm/ComputeContainer/guid/unfence

Changes the state of the compute container to Running.

unquiesce

POST

csm/ComputeContainer/guid/unquiesce

Changes the state of the compute container to Running.

Relationship APIs

Name

HTTP
method

URI

Description

relation

GET

csm/ComputeContainer/guid/computeContainerNetworkInterface

Retrieves the computeContainerNetworkInterface relationship.

relation

GET

csm/ComputeContainer/guid/cpuSensor

Retrieves the cpuSensor relationship.

relation

GET

csm/ComputeContainer/guid/localDisks

Retrieves the localDisks relationship.

relation

GET

csm/ComputeContainer/guid/memorySensor

Retrieves the memorySensor relationship.

relation

GET

csm/ComputeContainer/guid/nics

Retrieves the nics relationship.

relation

GET

csm/ComputeContainer/guid/operatingSystem

Retrieves the operatingSystem relationship.

relation

GET

csm/ComputeContainer/guid/server

Retrieves the server relationship.

relation

GET

csm/ComputeContainer/guid/software

Retrieves the software relationship.

relation

GET

csm/ComputeContainer/guid/storageConnection

Retrieves the storageConnection relationship.

relation

GET

csm/ComputeContainer/guid/resourceSet

Retrieves the resourceSet relationship.

relation

GET

csm/ComputeContainer/guid/tenant

Retrieves the tenant relationship.

relation

GET

csm/ComputeContainer/guid/provider

Retrieves the provider relationship.

relation

GET

csm/ComputeContainer/guid/tags

Retrieves the tags relationship.

ComputeContainer class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

computeContainerNetworkInterface

ComputeContainerNetworkInterface

1..*

Network interfaces used to access the compute container

cpuSensor

BaseCPUSensor

0..1

CPU sensor that monitors the compute container

localDisks

LocalDisk

0..*

Local disks associated with the compute container

memorySensor

BaseMemorySensor

0..1

Memory sensor that monitors the compute container

nics

NetworkInterface

1..*

Network interfaces used to access the compute container

operatingSystem

OperatingSystem

1

Operating system of the compute container

server

Server

1

Server the compute container is hosted on

software

ApplicationSoftware

0..*

Application software that runs on the compute container

storageConnection

StorageConnection

0..*

Storage connections that the compute container can access

resourceSet

ResourceSet

1

Associated resource set

tenant

Organization

1

Tenant assigned to the resource

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

actualDecommissionDate

Date

0..1

Date the compute container was decommissioned

cpus

Integer

1

Number of CPUs

cpuSpeed

String

1

CPU speed

hwArchitecture

HardwareArchitectureType

0..1

Hardware architecture of the compute container

modificationDate

Date

0..1

Modification date of the compute container

proposedDecommissionDate

Date

0..1

Planned date to decommission the compute container

provisionDate

Date

1

Date the compute container was provisioned

state

ProvisionedResourceState

1

Current state according to the resource's state machine

systemType

SystemType

1

Type of compute container

totalMemory

Integer

1

Total RAM available to the compute container

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

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

Comments