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": "startswith",
    "filter": {
      "name": "dolore ullamco mollit esse",
      "address": "10.1.98.234",
      "port": "22"
    },
    "sort": [
      {
        "name": -1,
        "address": 1,
        "port": -1
      }
    ],
    "order": "descending",
    "adapterType": [
      "AutomationGateway",
      "NSO"
    ],
    "adapterId": [
      "ansible-us-east",
      "ansible-us-east",
      "ansible-us-east",
      "ansible-us-east"
    ]
  }
}
           
          
            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": {
            "name": {
              "type": "string"
            },
            "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"
              ]
            },
            "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
          }
        }
      },
      "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": 19690909,
  "unique_device_count": 37028184,
  "return_count": 52488296,
  "start_index": 69936354,
  "list": [
    {
      "name": "xr9kv01-aws",
      "device-type": "cli",
      "ipaddress": "10.1.6.100",
      "port": "22",
      "ostype": "cisco-ios-xr",
      "host": "nso46",
      "actions": [
        "getDevicesFiltered",
        "addDeviceGroup"
      ],
      "authgroup": "xr9kv-aws",
      "address": "10.1.6.100",
      "ned": "cisco-ios-xr",
      "admin": true,
      "origins": [
        "nso46",
        "nso46",
        "nso46",
        "nso46",
        "nso46"
      ]
    },
    {
      "name": "xr9kv01-aws",
      "device-type": "cli",
      "ipaddress": "10.1.6.100",
      "port": "22",
      "ostype": "cisco-ios-xr",
      "host": "nso46",
      "actions": [
        "applyVariableTemplate",
        "applyTemplate"
      ],
      "authgroup": "xr9kv-aws",
      "address": "10.1.6.100",
      "ned": "cisco-ios-xr",
      "admin": true,
      "origins": [
        "nso46",
        "nso46",
        "nso46",
        "nso46"
      ]
    },
    {
      "name": "xr9kv01-aws",
      "device-type": "cli",
      "ipaddress": "10.1.6.100",
      "port": "22",
      "ostype": "cisco-ios-xr",
      "host": "nso46",
      "actions": [
        "dryRunVariableTemplate",
        "getDevicesFiltered"
      ],
      "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": [
        "syncTo"
      ],
      "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": [
        "getDeviceGroups",
        "addDeviceToGroup"
      ],
      "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"
      }
    }
  }
}