Sensor class

Represents a set of Sensor Attributes that measure aspects of a specific cloud object being monitored. Example: Sensor attached to a specific server 'myserver'.

Sensor class APIs

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

Basic APIs

Name

HTTP
method

URI

Description

refresh

POST

csm/Sensor/guid

Refreshes a Sensor object.

search

POST

csm/Sensor/search

Searches for Sensor objects.

Operation APIs

Name

HTTP
method

URI

Description

decommission

POST

csm/Sensor/decommission

This operation removes sensors from cloudObjects associated with Service Offering Instance.
This operation is called after Service Offering Instance is de-provisioned.
It groups Sensors attached to Service Offering Instance components by provider and
then invokes bulkDisableSensors() operation implemented by monitoring providers.
Monitoring providers can then release resources associated with Sensors.

provision

POST

csm/Sensor/provision

This operation orchestrates various other sensor operations in order to create and attach sensors to target cloud object. It then persists newly created sensor instances.
Parameters are target cloud object and list of ReferenceSensorCatalogEntries for which Sensors should be created and attached. It creates sensors only when
monitoring is enabled in given Service Deployment blueprint.

Relationship APIs

The Sensor class has no relationship APIs.

Sensor class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

childSensors

Sensor

0..*

parentSensors

Sensor

0..*

referenceSensorCatalogEntry

ReferenceSensorCatalogEntry

1

sensorAttributes

SensorAttribute

0..*

targetCloudObject

CloudObject

1

nameValuePairs

NameValuePair

0..*

tickets

Ticket

0..*

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

label

String

0..1

sensorAttributeCategories

SensorAttributeMeasurementCategory

0..*

validUntil

Date

0..1

Metric expiration date

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