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
admin
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
options |
object |
yes |
the options containing the criteria |
Copied to Clipboard
{
"options": {
"start": 0,
"limit": 20,
"functionName": "contains",
"filter": {
"address": "10.1.98.234",
"name": "est fugiat dolor consectetur",
"names": [
"ad eiusmod amet dolor occaecat",
"incididunt sunt consectetur dolor id",
"tempor",
"dolor",
"aliqua adipisicing dolore ad"
],
"ostype": "velit",
"ostypes": [
"enim voluptate est",
"occaecat",
"laborum ullamco Ut in sunt"
],
"port": "22"
},
"sort": [
{
"name": 1,
"address": -1,
"port": -1
},
{
"name": 1,
"address": 1,
"port": 1
},
{
"name": 1,
"address": -1,
"port": 1
},
{
"name": 1,
"address": -1,
"port": 1
}
],
"order": "descending",
"adapterType": [
"NSO",
"AutomationGateway"
],
"adapterId": [
"ansible-us-east",
"ansible-us-east",
"ansible-us-east",
"ansible-us-east"
],
"exactMatch": false
}
}
Copied to Clipboard
{
"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
DetailsExampleSchema
Name |
Type |
Description |
devices |
object |
A JSON Object containing the device(s) |
Copied to Clipboard
{
"entity": "device",
"total": 66023815,
"unique_device_count": 19963872,
"return_count": 29837409,
"start_index": 48599149,
"list": [
{
"name": "xr9kv01-aws",
"device-type": "cli",
"ipaddress": "10.1.6.100",
"port": "22",
"ostype": "cisco-ios-xr",
"host": "nso46",
"actions": [
"getTemplates",
"getDevices",
"removeDeviceFromGroup",
"getOutOfSyncConfig",
"verifyConfig"
],
"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": [
"turnUpDevice",
"runCommand"
],
"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": [
"applyTemplates",
"setConfig",
"liveStatus"
],
"authgroup": "xr9kv-aws",
"address": "10.1.6.100",
"ned": "cisco-ios-xr",
"admin": false,
"origins": [
"nso46"
]
}
]
}
Copied to Clipboard
{
"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"
}
}
}
}