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.

SensorCatalog class


This is a monitoring provider supplied Sensor Catalog. It supports Reference Sensor Catalog.

SensorCatalog class APIs

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

Basic APIs

Name

HTTP
method

URI

Description

search

POST

Searches for SensorCatalog objects.

Operation APIs

Name

HTTP
method

URI

Description

bulkOnboard

POST

Operation for onboarding various monitoring provider supplied Sensor Catalogs. It finds all providers that implement onboard operation from provider registry and invokes onboard operation of each provider.

onboard

POST

This operation is typically implemented by monitoring providers.
 Monitoring provider maps input Reference Sensor Catalog to monitoring provider supplied Sensor Catalog. It returns mapped SensorCatalog. Monitoring provider keeps track of changes to SensorCatalog and supplies only delta entries in subsequent invocations.
 opsProvider implements same operation to invoke monitoring provider's onboard operation and store monitoring provider supplied Sensor Catalog to database.

Relationship APIs

The SensorCatalog class has no relationship APIs.

SensorCatalog class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

sensorCatalogEntries

1..*

 

referenceSensorCatalog

1

 

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

label
String

1

 

version
String

1

 

validUntil

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

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*