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

Click here to view the sample XML response
Sample XML response
<XML>
 <json>
   <rest-adapter-response>
     <header-lines>
       <Transfer-Encoding>chunked</Transfer-Encoding>
       <Server>Apache-Coyote/1.1</Server>
       <Date>Wed, 23 Aug 2017 09:13:41 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>
       <peerName>null</peerName>
       <configuration>&lt;config&gt;&lt;target&gt;clm-aus-017310.bmc.com&lt;/target&gt;&lt;user-name&gt;Administrator&lt;/user-name&gt;&lt;password encryption-type="Plain"&gt;bmcAdm1n&lt;/password&gt;&lt;impersonate-user&gt;false&lt;/impersonate-user&gt;&lt;use-userprofile&gt;false&lt;/use-userprofile&gt;&lt;script-file-path&gt;local&lt;/script-file-path&gt;&lt;enable-psremoting&gt;true&lt;/enable-psremoting&gt;&lt;logon-with-user-credentials&gt;false&lt;/logon-with-user-credentials&gt;&lt;prefix-script-enable-command&gt;true&lt;/prefix-script-enable-command&gt;&lt;log-file-size&gt;4MB&lt;/log-file-size&gt;&lt;log-file-max-backup-index&gt;10&lt;/log-file-max-backup-index&gt;&lt;log-file-append&gt;true&lt;/log-file-append&gt;&lt;log-level&gt;info&lt;/log-level&gt;&lt;redirect-error-to-success-output-stream&gt;false&lt;/redirect-error-to-success-output-stream&gt;&lt;/config&gt;</configuration>
       <configurationDataType>XML</configurationDataType>
       <name>PowerShell</name>
       <description />
       <id>AdapterConfiguration1486963204142-2122848057</id>
       <adapterType>bmc-adapter-microsoft-windows-powershell-actor</adapterType>
       <version>20.17.01.00</version>
       <revision>2</revision>
       <status>
         <peerName>CDP</peerName>
         <peerId>null</peerId>
         <name>PowerShell</name>
         <adapterId>null</adapterId>
         <status>Currently running</status>
       </status>
     </message-body>
     <message-body>
       <peerName>null</peerName>
       <configuration>&lt;config&gt;&lt;clear-asynchronous-cache&gt;true&lt;/clear-asynchronous-cache&gt;&lt;delay&gt;10&lt;/delay&gt;&lt;/config&gt;</configuration>
       <configurationDataType>XML</configurationDataType>
       <name>WebServiceAdapter</name>
       <description>Web Services adapter</description>
       <id>AdapterConfiguration1503476037900-279586438</id>
       <adapterType>ro-adapter-ws</adapterType>
       <version>20.17.01.00</version>
       <revision>5</revision>
       <status>
         <peerName>CDP</peerName>
         <peerId>null</peerId>
         <name>WebServiceAdapter</name>
         <adapterId>null</adapterId>
         <status>Not Enabled</status>
       </status>
     </message-body>
     <message-body>
       <peerName>null</peerName>
       <configuration>&lt;config&gt;&lt;log-file-size&gt;4MB&lt;/log-file-size&gt;&lt;log-file-max-backup-index&gt;10&lt;/log-file-max-backup-index&gt;&lt;log-file-append&gt;true&lt;/log-file-append&gt;&lt;log-level&gt;info&lt;/log-level&gt;&lt;/config&gt;</configuration>
       <configurationDataType>XML</configurationDataType>
       <name>file</name>
       <description />
       <id>AdapterConfiguration1481879783178--561816825</id>
       <adapterType>ro-adapter-file</adapterType>
       <version>20.16.03.00</version>
       <revision>6</revision>
       <status>
         <peerName>CDP</peerName>
         <peerId>null</peerId>
         <name>file</name>
         <adapterId>null</adapterId>
         <status>Currently running</status>
       </status>
     </message-body>
     <message-body>
       <peerName>null</peerName>
       <configuration>&lt;config&gt;&lt;return-data-format&gt;JSON&lt;/return-data-format&gt;&lt;request-timeout&gt;10&lt;/request-timeout&gt;&lt;enable-redirects&gt;true&lt;/enable-redirects&gt;&lt;download-attachment&gt;false&lt;/download-attachment&gt;&lt;log-file-size&gt;4MB&lt;/log-file-size&gt;&lt;log-file-max-backup-index&gt;10&lt;/log-file-max-backup-index&gt;&lt;log-file-append&gt;true&lt;/log-file-append&gt;&lt;log-level&gt;info&lt;/log-level&gt;&lt;/config&gt;</configuration>
       <configurationDataType>XML</configurationDataType>
       <name>REST</name>
       <description />
       <id>AdapterConfiguration1495519634107--2092556225</id>
       <adapterType>ro-adapter-rest</adapterType>
       <version>20.17.01.00</version>
       <revision>5</revision>
       <status>
         <peerName>CDP</peerName>
         <peerId>null</peerId>
         <name>REST</name>
         <adapterId>null</adapterId>
         <status>Currently running</status>
       </status>
     </message-body>
     <message-body>
       <peerName>null</peerName>
       <configuration>&lt;config&gt;&lt;data-format&gt;HTML&lt;/data-format&gt;&lt;request-timeout&gt;10&lt;/request-timeout&gt;&lt;enable-json-conversion&gt;false&lt;/enable-json-conversion&gt;&lt;enable-redirects&gt;true&lt;/enable-redirects&gt;&lt;download-attachment&gt;false&lt;/download-attachment&gt;&lt;log-file-size&gt;4MB&lt;/log-file-size&gt;&lt;log-file-max-backup-index&gt;10&lt;/log-file-max-backup-index&gt;&lt;log-file-append&gt;true&lt;/log-file-append&gt;&lt;log-level&gt;info&lt;/log-level&gt;&lt;/config&gt;</configuration>
       <configurationDataType>XML</configurationDataType>
       <name>http</name>
       <description />
       <id>AdapterConfiguration1485938466028--259588126</id>
       <adapterType>ro-adapter-http</adapterType>
       <version>20.17.01.00</version>
       <revision>4</revision>
       <status>
         <peerName>CDP</peerName>
         <peerId>null</peerId>
         <name>http</name>
         <adapterId>null</adapterId>
         <status>Currently running</status>
       </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 adapter response in a JSON format

Click here to view the sample adapter response
{
  "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": "Wed, 23 Aug 2017 09:13:41 GMT"
      },
     "message-body": [
         {
           "id": "AdapterConfiguration1486963204142-2122848057",
           "name": "PowerShell",
           "description": "",
           "adapterType": "bmc-adapter-microsoft-windows-powershell-actor",
           "version": "20.17.01.00",
           "revision": "2",
           "configuration": "<config><target>clm-aus-017310.bmc.com<\/target><user-name>Administrator<\/user-name><password encryption-type=\"Plain\">bmcAdm1n<\/password><impersonate-user>false<\/impersonate-user><use-userprofile>false<\/use-userprofile><script-file-path>local<\/script-file-path><enable-psremoting>true<\/enable-psremoting><logon-with-user-credentials>false<\/logon-with-user-credentials><prefix-script-enable-command>true<\/prefix-script-enable-command><log-file-size>4MB<\/log-file-size><log-file-max-backup-index>10<\/log-file-max-backup-index><log-file-append>true<\/log-file-append><log-level>info<\/log-level><redirect-error-to-success-output-stream>false<\/redirect-error-to-success-output-stream><\/config>",
           "configurationDataType": "XML",
           "status": [
               {
                 "adapterId": null,
                 "name": "PowerShell",
                 "status": "Currently running",
                 "peerName": "CDP",
                 "peerId": null
               }
            ],
           "peerName": null
         },
         {
           "id": "AdapterConfiguration1503476037900-279586438",
           "name": "WebServiceAdapter",
           "description": "Web Services adapter",
           "adapterType": "ro-adapter-ws",
           "version": "20.17.01.00",
           "revision": "5",
           "configuration": "<config><clear-asynchronous-cache>true<\/clear-asynchronous-cache><delay>10<\/delay><\/config>",
           "configurationDataType": "XML",
           "status": [
               {
                 "adapterId": null,
                 "name": "WebServiceAdapter",
                 "status": "Not Enabled",
                 "peerName": "CDP",
                 "peerId": null
               }
            ],
           "peerName": null
         },
         {
           "id": "AdapterConfiguration1481879783178--561816825",
           "name": "file",
           "description": "",
           "adapterType": "ro-adapter-file",
           "version": "20.16.03.00",
           "revision": "6",
           "configuration": "<config><log-file-size>4MB<\/log-file-size><log-file-max-backup-index>10<\/log-file-max-backup-index><log-file-append>true<\/log-file-append><log-level>info<\/log-level><\/config>",
           "configurationDataType": "XML",
           "status": [
               {
                 "adapterId": null,
                 "name": "file",
                 "status": "Currently running",
                 "peerName": "CDP",
                 "peerId": null
               }
            ],
           "peerName": null
         },
         {
           "id": "AdapterConfiguration1495519634107--2092556225",
           "name": "REST",
           "description": "",
           "adapterType": "ro-adapter-rest",
           "version": "20.17.01.00",
           "revision": "5",
           "configuration": "<config><return-data-format>JSON<\/return-data-format><request-timeout>10<\/request-timeout><enable-redirects>true<\/enable-redirects><download-attachment>false<\/download-attachment><log-file-size>4MB<\/log-file-size><log-file-max-backup-index>10<\/log-file-max-backup-index><log-file-append>true<\/log-file-append><log-level>info<\/log-level><\/config>",
           "configurationDataType": "XML",
           "status": [
               {
                 "adapterId": null,
                 "name": "REST",
                 "status": "Currently running",
                 "peerName": "CDP",
                 "peerId": null
               }
            ],
           "peerName": null
         },
         {
           "id": "AdapterConfiguration1485938466028--259588126",
           "name": "http",
           "description": "",
           "adapterType": "ro-adapter-http",
           "version": "20.17.01.00",
           "revision": "4",
           "configuration": "<config><data-format>HTML<\/data-format><request-timeout>10<\/request-timeout><enable-json-conversion>false<\/enable-json-conversion><enable-redirects>true<\/enable-redirects><download-attachment>false<\/download-attachment><log-file-size>4MB<\/log-file-size><log-file-max-backup-index>10<\/log-file-max-backup-index><log-file-append>true<\/log-file-append><log-level>info<\/log-level><\/config>",
           "configurationDataType": "XML",
           "status": [
               {
                 "adapterId": null,
                 "name": "http",
                 "status": "Currently running",
                 "peerName": "CDP",
                 "peerId": null
               }
            ],
           "peerName": null
         }
      ]
   }
}

status

Indicates whether the workflow is run successfully

Valid values: success, failure

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*