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. Note that this API requires Super User privileges.

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

modify

PUT

Modifies a ComputeContainer object.

get

GET

Retrieves a ComputeContainer object.

refresh

POST

Refreshes a ComputeContainer object.

search

POST

Searches for ComputeContainer objects.


 


Operation APIs


 

Name 

HTTP
method

URI

Description

addLocalDisk

POST

Adds a local disk to the compute container.

bulkDecommission

POST

 

bulkDestructor

POST

 

bulkProvisionSecOpsSensors

POST

This API provisions the sensors for compliance.

bulkShare

POST

Refreshes the specified service offering instance.

decommission

POST

Decommissions the specified compute container.

executeAction

POST

 

executeHostScript

POST

Executes a script.

executeScript

POST

Executes a script on the specified compute container.

fence

POST

Changes the compute container state to Fenced.

quiesce

POST

Changes the compute container state to Quiesced.

removeLocalDisk

POST

Removes a local disk from the compute container.

removeNic

POST

 

resizeLocalDisk

POST

 

resume

POST

Changes the state of the compute container to Running.

restart

POST

Restarts the specified computer container.

start

POST

Starts the specified computer container.

stop

POST

Stops the specified computer container.

suspend

POST

Changes the state of the compute container to Suspended.

transferOwnership

POST

Transfers the ownership from existing user to the new user

unfence

POST

Changes the state of the compute container to Running.

unquiesce

POST

Changes the state of the compute container to Running.

 


Relationship APIs


 


Name

HTTP
method

URI

Description

relation

GET

Retrieves the computeContainerNetworkInterface relationship.

relation

GET

Retrieves the cpuSensor relationship.

relation

GET

Retrieves the localDisks relationship.

relation

GET

Retrieves the memorySensor relationship.

relation

GET

Retrieves the nics relationship.

relation

GET

Retrieves the operatingSystem relationship.

relation

GET

Retrieves the server relationship.

relation

GET

Retrieves the software relationship.

relation

GET

Retrieves the storageConnection relationship.

relation

GET

Retrieves the resourceSet relationship.

relation

GET

Retrieves the tenant relationship.

relation

GET

Retrieves the tickets relationship.

relation

GET

Retrieves the provider relationship.

relation

GET

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

1..*

Network interfaces used to access the compute container

cpuSensor

0..1

CPU sensor that monitors the compute container

localDisks

0..*

Local disks associated with the compute container

memorySensor

0..1

Memory sensor that monitors the compute container

nics

1..*

Network interfaces used to access the compute container

operatingSystem

1

Operating system of the compute container

server

1

Server the compute container is hosted on

software

0..*

 

storageConnection

0..*

Storage connections that the compute container can access

resourceSet

1

Associated resource set

tenant

1

Tenant assigned to the resource

tickets

0..*

 

cloudClass

1

Fully-qualified name of the class to which the object belongs

provider

1

Provider that created the object

tags

0..*

Tags associated with the object


 


Attributes


 


Name

Type

Multi-
plicity

Description

actualDecommissionDate

0..1

Date the compute container was decommissioned

cpus
Integer

1

Number of CPUs

cpuSpeed
String

1

CPU speed

hwArchitecture

0..1

Hardware architecture of the compute container

modificationDate

0..1

Modification date of the compute container

proposedDecommissionDate

0..1

Planned date to decommission the compute container

provisionDate

1

Date the compute container was provisioned

state

1

Current state according to the resource's state machine

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

labels
String

0..*

 

modifiedDate

0..1

Date the Cloudobject was modified

name
String

1

Human-readable name of the object


 


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*