Request and response for the Get Devices operation
The Get Devices operation enables you to retrieve a list containing detailed information about devices corresponding to the filtering criteria. The following table describes the elements for the <items> XML element and adapter request for the Get Devices operation.
Elements for the <items> XML element and adapter request for the Get Devices operation
The following table lists the access-mode constants.
The following table lists the devices and their supported IDs.
The following table lists the online constants.
The following table lists the transfer mode constants.
The following table lists the vendors IDs.
The following figure shows a sample <items> XML element for the Get Devices operation.
<items> XML element for the Get Devices operation
<items>
<item>
<parameters>
<device-filter>
<dynamic-field-range>
<element>
<dynamic-field-key-string>a</dynamic-field-key-string>
<range>
<key>a</key>
</range>
</element>
<element>
<dynamic-field-key-string>b</dynamic-field-key-string>
<range>
<key>b</key>
</range>
</element>
</dynamic-field-range>
<dynamic-fields>
<element>
<name>a</name>
<value>a</value>
</element>
<element>
<name>b</name>
<value>b</value>
</element>
</dynamic-fields>
<key>a</key>
<access-mode>1</access-mode>
<address-match>a</address-match>
<created>
<key>a</key>
<end-date>1215098375937</end-date>
<start-date>1215098375937</start-date>
<time-period-type-id>1</time-period-type-id>
</created>
<device-agent-info-name>a</device-agent-info-name>
<device-security-profile-name>a</device-security-profile-name>
<device-security-profile-name>a</device-security-profile-name>
<group-name>a</group-name>
<ios-hw-filter>
<entity-descr-match>a</entity-descr-match>
<entity-name-match>a</entity-name-match>
<entity-pid-match>a</entity-pid-match>
<entity-sn-match>a</entity-sn-match>
<entity-vid-match>a</entity-vid-match>
<file-system-free-size>
<key>a</key>
<max>1</max>
<max-inclusive>true</max-inclusive>
<min>1</min>
<min-inclusive>true</min-inclusive>
<range-type-id>1</range-type-id>
</file-system-free-size>
<file-system-name-match>a</file-system-name-match>
<file-system-total-size>
<key>a</key>
<max>1</max>
<max-inclusive>true</max-inclusive>
<min>1</min>
<min-inclusive>true</min-inclusive>
<range-type-id>1</range-type-id>
</file-system-total-size>
<memory-name-match>a</memory-name-match>
<memory-size>
<key>a</key>
<max>1</max>
<max-inclusive>true</max-inclusive>
<min>1</min>
<min-inclusive>true</min-inclusive>
<range-type-id>1</range-type-id>
</memory-size>
</ios-hw-filter>
<last-span-action-days>1</last-span-action-days>
<last-span-action-days-action-type>1</last-span-action-days-action-type>
<last-span-action-days-flag>true</last-span-action-days-flag>
<last-span-action-error-match>a</last-span-action-error-match>
<last-span-action-status>1</last-span-action-status>
<last-span-action-status-action-type>1</last-span-action-status-action-type>
<last-span-action-status-flag>true</last-span-action-status-flag>
<last-span-action-success-date-action-type>1</last-span-action-success-date-action-type>
<last-span-action-success-date-flag>true</last-span-action-success-date-flag>
<last-span-action-success-days>1</last-span-action-success-days>
<key>a</key>
<end-date>1215098375937</end-date>
<start-date>1215098375937</start-date>
<time-period-type-id>1</time-period-type-id>
</last-span-action-success-time-period>
<model-match>a</model-match>
<name-match>a</name-match>
<no-discrepancies-flag>true</no-discrepancies-flag>
<no-discrepancies-include>true</no-discrepancies-include>
<no-violations-flag>true</no-violations-flag>
<no-violations-include>true</no-violations-include>
<online>1</online>
<os-image-discrepancy-flag>true</os-image-discrepancy-flag>
<os-image-discrepancy-include>true</os-image-discrepancy-include>
<os-image-match>a</os-image-match>
<realm-name>a</realm-name>
<running-startup-discrepancy-flag>true</running-startup-discrepancy-flag>
<running-startup-discrepancy-include>true</running-startup-discrepancy-include>
<running-trusted-discrepancy-flag>true</running-trusted-discrepancy-flag>
<running-trusted-discrepancy-include>true</running-trusted-discrepancy-include>
<running-violation-flag>true</running-violation-flag>
<running-violation-include>true</running-violation-include>
<startup-trusted-discrepancy-flag>true</startup-trusted-discrepancy-flag>
<startup-trusted-discrepancy-include>true</startup-trusted-discrepancy-include>
<startup-violation-flag>true</startup-violation-flag>
<startup-violation-include>true</startup-violation-include>
<transfer-mode>1</transfer-mode>
<vendor-id>1</vendor-id>
</device-filter>
</parameters>
</item>
</items>
<item>
<parameters>
<device-filter>
<dynamic-field-range>
<element>
<dynamic-field-key-string>a</dynamic-field-key-string>
<range>
<key>a</key>
</range>
</element>
<element>
<dynamic-field-key-string>b</dynamic-field-key-string>
<range>
<key>b</key>
</range>
</element>
</dynamic-field-range>
<dynamic-fields>
<element>
<name>a</name>
<value>a</value>
</element>
<element>
<name>b</name>
<value>b</value>
</element>
</dynamic-fields>
<key>a</key>
<access-mode>1</access-mode>
<address-match>a</address-match>
<created>
<key>a</key>
<end-date>1215098375937</end-date>
<start-date>1215098375937</start-date>
<time-period-type-id>1</time-period-type-id>
</created>
<device-agent-info-name>a</device-agent-info-name>
<device-security-profile-name>a</device-security-profile-name>
<device-security-profile-name>a</device-security-profile-name>
<group-name>a</group-name>
<ios-hw-filter>
<entity-descr-match>a</entity-descr-match>
<entity-name-match>a</entity-name-match>
<entity-pid-match>a</entity-pid-match>
<entity-sn-match>a</entity-sn-match>
<entity-vid-match>a</entity-vid-match>
<file-system-free-size>
<key>a</key>
<max>1</max>
<max-inclusive>true</max-inclusive>
<min>1</min>
<min-inclusive>true</min-inclusive>
<range-type-id>1</range-type-id>
</file-system-free-size>
<file-system-name-match>a</file-system-name-match>
<file-system-total-size>
<key>a</key>
<max>1</max>
<max-inclusive>true</max-inclusive>
<min>1</min>
<min-inclusive>true</min-inclusive>
<range-type-id>1</range-type-id>
</file-system-total-size>
<memory-name-match>a</memory-name-match>
<memory-size>
<key>a</key>
<max>1</max>
<max-inclusive>true</max-inclusive>
<min>1</min>
<min-inclusive>true</min-inclusive>
<range-type-id>1</range-type-id>
</memory-size>
</ios-hw-filter>
<last-span-action-days>1</last-span-action-days>
<last-span-action-days-action-type>1</last-span-action-days-action-type>
<last-span-action-days-flag>true</last-span-action-days-flag>
<last-span-action-error-match>a</last-span-action-error-match>
<last-span-action-status>1</last-span-action-status>
<last-span-action-status-action-type>1</last-span-action-status-action-type>
<last-span-action-status-flag>true</last-span-action-status-flag>
<last-span-action-success-date-action-type>1</last-span-action-success-date-action-type>
<last-span-action-success-date-flag>true</last-span-action-success-date-flag>
<last-span-action-success-days>1</last-span-action-success-days>
<key>a</key>
<end-date>1215098375937</end-date>
<start-date>1215098375937</start-date>
<time-period-type-id>1</time-period-type-id>
</last-span-action-success-time-period>
<model-match>a</model-match>
<name-match>a</name-match>
<no-discrepancies-flag>true</no-discrepancies-flag>
<no-discrepancies-include>true</no-discrepancies-include>
<no-violations-flag>true</no-violations-flag>
<no-violations-include>true</no-violations-include>
<online>1</online>
<os-image-discrepancy-flag>true</os-image-discrepancy-flag>
<os-image-discrepancy-include>true</os-image-discrepancy-include>
<os-image-match>a</os-image-match>
<realm-name>a</realm-name>
<running-startup-discrepancy-flag>true</running-startup-discrepancy-flag>
<running-startup-discrepancy-include>true</running-startup-discrepancy-include>
<running-trusted-discrepancy-flag>true</running-trusted-discrepancy-flag>
<running-trusted-discrepancy-include>true</running-trusted-discrepancy-include>
<running-violation-flag>true</running-violation-flag>
<running-violation-include>true</running-violation-include>
<startup-trusted-discrepancy-flag>true</startup-trusted-discrepancy-flag>
<startup-trusted-discrepancy-include>true</startup-trusted-discrepancy-include>
<startup-violation-flag>true</startup-violation-flag>
<startup-violation-include>true</startup-violation-include>
<transfer-mode>1</transfer-mode>
<vendor-id>1</vendor-id>
</device-filter>
</parameters>
</item>
</items>
The following figure shows a sample adapter request for the Get Devices operation.
Sample adapter request for the Get Devices operation
<bmc-configuration-automation-networks-request>
<entity>device</entity>
<request>
<operation-name>get-devices</operation-name>
<device-filter>
<vendor-id>1</vendor-id>
</device-filter>
</request>
</bmc-configuration-automation-networks-request>
<entity>device</entity>
<request>
<operation-name>get-devices</operation-name>
<device-filter>
<vendor-id>1</vendor-id>
</device-filter>
</request>
</bmc-configuration-automation-networks-request>
The following figure illustrates the response for the sample Get Devices operation.
Adapter response for the sample Get Devices operation
<bmc-configuration-automation-networks-response>
<metadata>
<status>success</status>
</metadata>
<parameters>
<output>
<element>
<dynamic-fields>
<element>
<name>DeviceType</name>
<values>
<element>Cisco IOS Switch/Router</element>
</values>
</element>
<element>
<name>Description</name>
<values>
<element></element>
</values>
</element>
</dynamic-fields>
<key>714294386-12</key>
<name>router</name>
<realm>
<key>955703509-1</key>
<name>Default</name>
</realm>
<access-mode>1</access-mode>
<address>10.10.75.50</address>
<agent-info-key>1892835679-1</agent-info-key>
<created>1217526664843</created>
<current-running-config-key>1754072615-20</current-running-config-key>
<current-startup-config-key>1754072615-22</current-startup-config-key>
<device-security-profile-name>dsp</device-security-profile-name>
<device-type-id>0</device-type-id>
<online>true</online>
<transfer-mode>1</transfer-mode>
<trusted-running-config-key>1754072615-20</trusted-running-config-key>
<trusted-startup-config-key>1754072615-22</trusted-startup-config-key>
</element>
</output>
</parameters>
</bmc-configuration-automation-networks-response>
<metadata>
<status>success</status>
</metadata>
<parameters>
<output>
<element>
<dynamic-fields>
<element>
<name>DeviceType</name>
<values>
<element>Cisco IOS Switch/Router</element>
</values>
</element>
<element>
<name>Description</name>
<values>
<element></element>
</values>
</element>
</dynamic-fields>
<key>714294386-12</key>
<name>router</name>
<realm>
<key>955703509-1</key>
<name>Default</name>
</realm>
<access-mode>1</access-mode>
<address>10.10.75.50</address>
<agent-info-key>1892835679-1</agent-info-key>
<created>1217526664843</created>
<current-running-config-key>1754072615-20</current-running-config-key>
<current-startup-config-key>1754072615-22</current-startup-config-key>
<device-security-profile-name>dsp</device-security-profile-name>
<device-type-id>0</device-type-id>
<online>true</online>
<transfer-mode>1</transfer-mode>
<trusted-running-config-key>1754072615-20</trusted-running-config-key>
<trusted-startup-config-key>1754072615-22</trusted-startup-config-key>
</element>
</output>
</parameters>
</bmc-configuration-automation-networks-response>
Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*