Summary
Get device(s) from Automation Gateway
Description
This method will get device(s) from Automation Gateway based on the provided criteria
Route
No Northbound API Available
Roles
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| options | object | yes | the options containing the criteria |
{ "options": { "start": 0, "limit": 20, "functionName": "startswith", "filter": { "address": "10.1.98.234", "name": "ad", "names": [ "ut magna Duis anim quis", "magna Lorem", "et officia", "fugiat incididunt irure" ], "ostype": "fugiat consequat", "ostypes": [ "est exercitation Ut minim laborum", "cillum", "ad sed do" ], "port": "22" }, "sort": [ { "name": 1, "address": 1, "port": -1 } ], "order": "descending", "adapterType": [ "AutomationGateway" ], "adapterId": [ "ansible-us-east" ], "exactMatch": true } }
{ "type": "object", "properties": { "options": { "title": "options", "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "examples": [ 0 ] }, "limit": { "type": "integer", "minimum": 1, "examples": [ 20 ] }, "functionName": { "type": "string", "enum": [ "contains", "equals", "startswith" ] }, "filter": { "type": "object", "properties": { "address": { "type": "string", "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "examples": [ "10.1.98.234" ] }, "name": { "type": "string" }, "names": { "type": "array", "items": { "type": "string" } }, "ostype": { "type": "string" }, "ostypes": { "type": "array", "items": { "type": "string" } }, "port": { "type": "string", "pattern": "^[0-9]+$", "examples": [ "22" ] } }, "required": [] }, "sort": { "type": "array", "items": { "type": "object", "properties": { "name": { "enum": [ -1, 1 ] }, "address": { "enum": [ -1, 1 ] }, "port": { "enum": [ -1, 1 ] } }, "required": [] } }, "order": { "type": "string", "enum": [ "ascending", "descending" ] }, "adapterType": { "type": "array", "items": { "type": "string", "examples": [ "NSO", "AutomationGateway" ] }, "uniqueItems": true }, "adapterId": { "type": "array", "items": { "type": "string", "examples": [ "ansible-us-east" ], "uniqueItems": true } }, "exactMatch": { "type": "boolean", "enum": [ true, false ] } }, "required": [] } }, "required": [ "options" ], "additionalProperties": false }
Return
| Name | Type | Description |
|---|---|---|
| devices | object | A JSON Object containing the device(s) |
{ "entity": "device", "total": 30350156, "unique_device_count": 36659429, "return_count": 12748658, "start_index": 5527319, "list": [ { "name": "xr9kv01-aws", "device-type": "cli", "ipaddress": "10.1.6.100", "port": "22", "ostype": "cisco-ios-xr", "host": "nso46", "actions": [ "applyVariableTemplate", "getDeviceGroups", "syncTo" ], "authgroup": "xr9kv-aws", "address": "10.1.6.100", "ned": "cisco-ios-xr", "admin": true, "origins": [ "nso46" ] }, { "name": "xr9kv01-aws", "device-type": "cli", "ipaddress": "10.1.6.100", "port": "22", "ostype": "cisco-ios-xr", "host": "nso46", "actions": [ "checkSyncDevices", "applyTemplates" ], "authgroup": "xr9kv-aws", "address": "10.1.6.100", "ned": "cisco-ios-xr", "admin": true, "origins": [ "nso46", "nso46", "nso46" ] }, { "name": "xr9kv01-aws", "device-type": "cli", "ipaddress": "10.1.6.100", "port": "22", "ostype": "cisco-ios-xr", "host": "nso46", "actions": [ "getDeviceGroups", "getDevices", "loadConfig", "removeDeviceFromGroup" ], "authgroup": "xr9kv-aws", "address": "10.1.6.100", "ned": "cisco-ios-xr", "admin": false, "origins": [ "nso46", "nso46" ] }, { "name": "xr9kv01-aws", "device-type": "cli", "ipaddress": "10.1.6.100", "port": "22", "ostype": "cisco-ios-xr", "host": "nso46", "actions": [ "checkSyncDevices", "syncFromDevices", "removeDeviceFromGroup", "syncToDevices" ], "authgroup": "xr9kv-aws", "address": "10.1.6.100", "ned": "cisco-ios-xr", "admin": true, "origins": [ "nso46", "nso46", "nso46", "nso46", "nso46" ] } ] }
{ "title": "devices", "type": "object", "properties": { "entity": { "const": "device" }, "total": { "type": "integer", "minimum": 0 }, "unique_device_count": { "type": "integer", "minimum": 0 }, "return_count": { "type": "integer", "minimum": 0 }, "start_index": { "type": "integer", "minimum": 0 }, "list": { "type": "array", "items": { "$ref": "deviceData#/definitions/deviceDetails" } } } }