Unsupported content

 

This version of the product has reached end of support. The documentation is available for your convenience. However, you must be logged in to access it. You will not be able to leave comments.

BaseMemorySensor class (Provider API)

The BaseMemorySensor class represents a basic set of metrics about memory.

BaseMemorySensor class APIs

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

Basic APIs

Name

HTTP
method

URI

Description

refresh

POST

csm/BaseMemorySensor/guid

Refreshes a BaseMemorySensor object.

Operation APIs

Name

HTTP
method

URI

Description

onboard

POST

csm/BaseMemorySensor/onboard

Onboards a base memory sensor

Relationship APIs

The BaseMemorySensor class has no relationship APIs.

BaseMemorySensor class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

virtualCluster

VirtualCluster

0..1

Virtual cluster monitored by the memory sensor

virtualGuest

VirtualGuest

0..1

Virtual guest monitored by the memory sensor

virtualHost

VirtualHost

0..1

Virtual host monitored by the memory sensor

Attributes

Name

Type

Multi-
plicity

Description

freeMemory

Integer

0..1

Amount of free memory in MB

memoryUtilization

Float

1

Memory utilization expressed as a percentage

totalMemory

Integer

0..1

Total memory expressed in MB

usedMemory

Integer

0..1

Memory used expressed in MB

validUntil

Date

0..1

Validity end date

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

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.

Comments