Stop Adapter
The Stop Adapter workflow stops the adapter on a specified peer.
The following table describes the input elements for the workflow.
Input elements for the workflow
Input element | 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, in a JSON format, to stop an adapter on the specified peer Example JSON request { "adapters":[ { "name": "CommandLineAdapter", "version":"20.17.01.00", "revision": "1", "peerName":"CDP" }, { "name": "HttpAdapter", "version":"20.17.01.00", "revision": "1", "peerName":"CDP" } ] } For the supported body elements, see Stop-adapter-on-peer REST API call in TrueSight Orchestration Platform documentation. | Yes |
The following table describes the output elements for the Stop Adapter workflow.
Output elements for the 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 |
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 |
response message | Contains the message included in the adapter response |
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 |