Get All Adapters
The Get All Adapters workflow retrieves a list of all adapters configured on the Grid.
The following table describes the input elements for the Get All Adapters workflow.
Input elements for the Get All Adapters 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 |
pattern | string | Specifies the pattern to retrieve adapters Patterns must be expressed as Java Regular Expressions. PCRE patterns are not supported. Do not specify a pattern to get the list of all adapters. | No |
matchon | string | Adapter attribute for which the value will be used to apply the regular expression for filtering (using the pattern provided) | No |
grid name | string | Specifies the name of the Grid For example, if you specify HA-CDP, all adapters configured on the HA-CDP are retrieved. | No |
config data type | string | Specifies the data type for adapter configuration If set to XML, the returned adapters' configuration attribute has an XML string value. If set to JSON, the returned adapters' configuration attribute has a JSON string value. | No |
The following table describes the output elements for the Get All Adapters workflow.
Output elements for the Get All Adapters 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 adapter response in a JSON format |
status | Indicates whether the workflow is run successfully Valid values: success, failure |
Comments
Log in or register to comment.