OpsManager refreshComplianceSensors request

Note

This API is available in version 4.6.04 and later.

Description

This API refreshes the compliance sensors by running the configured Compliance jobs in BMC Server Automation.

API stability classification

API overview

HTTP method	URI	Return type	Return type multiplicity
POST	csm/OpsManager/refreshComplianceSensors	void	Not applicable

HTTP request message

Query string parameters

This API does not use query string parameters.

Request message headers

This API uses only common headers listed in HTTP-request-and-response-headers.

Request message body

This API uses the following objects in the request message body JSON.

Top-level objects

Name	Type	Multi- plicity	Description
callbackURL	String	0..1	URL to call when the operation finishes
postCallout	String	0..1	Identifier of a callout to run after the operation executes
preCallout	String	0..1	Identifier of a callout to run before the operation executes
timeout	Integer	0..1	Timeout setting. For more information about using the timeout, see Synchronous-and-asynchronous-operations. Timeout values: 0: Immediate timeout -1: Uses the system default timeout value 1..*: Times out in the specified number of seconds
operationParams	OperationParameter	1	Array of input parameters. The following table contains the list of input parameters. For information about setting up the input parameters, see Passing-input-parameters-with-an-API-request.

Input parameters to include in operationParams

Name	Type	Multi- plicity	Description
ccGuids	String	1..*	Compute Container GUID(s) against which the Compliance jobs need to be run

HTTP response message

Response message headers

This API uses only common headers listed in HTTP-request-and-response-headers.

Response message body

The response message body contains a Task object.

Example

The following example shows an HTTP request that refreshes compliance sensors by running the configured Compliance jobs in BMC Server Automation. To formulate this request, you need to know the ccGuids of the Compute Container against which the Compliance jobs need to be run so you can include it in the URI of the request.

    "timeout": -1,
    "preCallout": "",
    "postCallout": "",
    "operationParams":[

          ],
          "type":"com.bmc.cloud.model.beans.NameValuePair",
          "multiplicity":"1..*"
    },
    {
         "name":"providerURI",
         "value":"/provider/936fdd9a-42e2-49aa-bd18-248a4d5ce61f",
         "type":"java.lang.String",
         "multiplicity":"1"
      }

    ]
}

The following example shows an HTTP response to the previous request:

    "timeout": -1,
    "preCallout": "",
    "postCallout": "",
    "operationParams":