Start Adapter

The Start Adapter workflow starts an adapter on the specified peer. 

The following table describes the input elements for the Start Adapter workflow.

Input elements for the Start Adapter workflow

Input elementTypeDescriptionRequired
authentication tokenstringSpecifies the authentication token generated by running the Login workflow.Yes
urlstring

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
inputstring

Specifies the input, in a JSON format, to start 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 Start adapter on peer REST API call in TrueSight Orchestration Platform documentation.

Yes

The following table describes the output elements for the Start Adapter workflow.

Output elements for the Start Adapter workflow

Output elementDescription
remediation messageContains the resolution if an error occurs
error numberContains 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 messageContains 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

Was this page helpful? Yes No Submitting... Thank you

Comments