Deactivate Module
This workflow deactivates one or more modules on the Grid.
The following table describes the input elements for the Deactivate Module workflow.
Input elements for the Deactivate Module workflow
Input | Type | Description | Required |
|---|---|---|---|
authentication token | string | Specifies the authentication token generated by running the Login workflow. | Yes |
url | string | Specifies the URL to the TrueSight Orchestration peer in the following format: https://<hostname>:<port>/<name of the peer> For example, https://clm-aus-123456:58080/baocdp | Conditional; required if not specified in the module configuration |
input | string | Specifies the input for activating one or more modules in the JSON format. Example format { "modules":[{ "name":"AutoPilot-OA-Common_Utilities", "version":"20.17.01.00", "revision":"1" }, { "name":"AutoPilot-AD-Utilities", "version":"20.17.01.00", "revision":"1" }] } For the supported body elements, see Deactivate-module REST API call in TrueSight Orchestration Platform documentation. | Yes |
The following table describes the output elements for the Deactivate Module workflow.
Output elements for the Deactivate Module workflow
Output element | Description |
|---|---|
remediation message | Contains the resolution if an error occurs |
error number | Contains more information about the error |
status reason | Indicates the reason for success or failure Example: OK |
response in XML doc | Contains the XML response for the request Example <XML> <json> <rest-adapter-response> <header-lines> <Transfer-Encoding>chunked</Transfer-Encoding> <Server>Apache-Coyote/1.1</Server> <Date>Fri, 18 Aug 2017 06:42:04 GMT</Date> <Content-Type>application/json;charset=UTF-8</Content-Type> </header-lines> <metadata> <status>success</status> </metadata> <status-line> <reason>OK</reason> <code>200</code> </status-line> <message-body> <id>null</id> <message>Requested module/s successfully de-activated.</message> <status>Success</status> </message-body> </rest-adapter-response> </json> </XML> |
error message | Contains the error message if the request fails |
status code | Contains the response code for the request Example: 200 For more information about status codes, see HTTP response codes. |
adapter response | Contains the XML adapter response Example { "rest-adapter-response": { "metadata": { "status": "success" }, "status-line": { "code": "200", "reason": "OK" }, "header-lines": { "Server": "Apache-Coyote/1.1", "Content-Type": "application/json;charset=UTF-8", "Transfer-Encoding": "chunked", "Date": "Fri, 18 Aug 2017 06:42:04 GMT" }, "message-body": [ { "status": "Success", "message": "Requested module/s successfully de-activated.", "id": null } ] } } |
response message | Contains the message included in the adapter response Example: Requested module/s successfully deactivated. |
response status | Indicates whether the adapter response is generated successfully Valid values: Success, Failure |
status | Indicates whether the workflow is run successfully Valid values: success, failure |