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.

health-sensor

This topic describes the verb, command-line arguments, and API parameters available for the health-sensor noun in the BMC Cloud Lifecycle Management SDK.

list

Use health-sensor-list from the command line to list available sensor attributes for the specified service.

Command-line syntax
clm health-sensor-list [-h] [-l] [-u] [-n] [-s] [-k FIELD_NAME [FIELD_NAME ...]] [--filter FIELD_NAME=VALUE [FIELD_NAME=VALUE ...]] --service NAME --resourceset NAME

Use health_sensor_list in the API to list available sensor attributes for the specified service. This command returns a list of SensorAttribute API objects with the same attributes and relationships.

API syntax
obj = health_sensor_list(gcac, service=None, resourceset=None, filters=None)

obj[n].guid returns the GUID
obj[n].name returns the name
...

Command-line argument

API parameter

Description

Required?

--service
service

Name or GUID of the service for which to list sensor attributes.

Yes

--resourceset
resourceset

Name or GUID of the resource set.

 

-l

 

List all fields. This parameter does not need a value.

 

-u

 

List only GUIDs. This parameter does not need a value.

 

-n

 

List only names. This parameter does not need a value.

 

-s

 

List GUIDs, names, and status (if applicable). This parameter does not need a value.

 

-k

 

List the field names specified in the value for this parameter.

 

--filter
filters

Filter the output according to the specified criteria.

 

 

gcac

GenericCloudAPIClient instance/user authentication.

 

 

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