Download OpenAPI specification:Download
The Inventory/Asset Service APIs are used by multiple services to access network configuration/state data.
Get only specified Switch details. The Switch can be identified by IP Address
ip_address required | string IP Address of the Device |
OK
Authorization information is missing or invalid.
A device with the specified IP was not found.
Unexpected error.
Unexpected error
Delete the specified device from the inventory.
ip_address required | string IP Addresses of the device to be deleted. |
OK
Authorization information is missing or invalid.
A switch with the specified IP Address was not found.
Not able to delete the switch with specified IP Address.
Unexpected error.
Unexpected error
Update the specified device details in the inventory.
ip_address required | string IP Address of the device to be updated. |
Update switch if credentials changes provide new username and password
ip_address required | string |
username required | string |
password required | string |
OK
Authorization information is missing or invalid.
Couldnt connect to the device. Check device credentials.
Update switch failed because of invalid IP address in the request.
Switch update failed for the specified IP address.
Unexpected error.
Unexpected error
{- "ip_address": "string",
- "username": "string",
- "password": "string"
}
Register switch with the inventory service
Register a new Switch.
ip_address required | string |
username required | string |
password required | string |
OK
Authorization information is missing or invalid.
A switch with the specified IP already exists.
Invalid IP/Username/Password for registering the device.
Device connection or enabling interfaces failed while registering the device.
Unexpected error.
Unexpected error
{- "ip_address": "string",
- "username": "string",
- "password": "string"
}
Register switches with the inventory service
Register a new Switch.
device_ips required | Array of strings |
username required | string |
password required | string |
OK
Authorization information is missing or invalid.
A switch with the specified IP already exists.
Unexpected error.
Unexpected error
{- "device_ips": [
- "string"
], - "username": "string",
- "password": "string"
}
Replace the switch as part of an RMA. This will replace the asset information of the new switch in the Inventory.
ip_address required | string IP Addresses of the device to be replaced. |
OK
Authorization information is missing or invalid.
A switch with the specified IP doesnt exists.
Unexpected error
Unexpected error
Compare the Specified Switch configuration with whats in the Asset DB
ip_address required | string IP Addresses of the device which we want to compare configuration that is saved on the device vs actual configuration on the device. |
OK
A switch with the specified IP doesnt exists.
Unexpected error
Unexpected error
Get All switches in the specified fabric.
fabric_name | string Only devices which are associated to the fabric name specified as returned. |
device_ids | Array of integers non-empty Database Ids of switches to be fetched |
device_ips | Array of strings non-empty IPs of the devices to be fetched |
orphan | boolean This is a standalone parameter, which is used to return devices not associated to any fabric. fabric_name/device_ids/device_ips/role cannot be specified with this parameter |
role | string Enum: "Leaf" "Spine" "SuperSpine" "BorderLeaf" "SuperSuperSpine" Only devices with the specified role are returned. This parameter works in conjunction with fabric_name parameter and is not expected by itself |
OK
No switches found for the specified fabric.
Specified Fabric not found.
Unexpected error.
Unexpected error
Update All switches in the specified fabric.
device_ips | Array of strings non-empty IP Addresses of the device(s) to be updated. |
fabric_name | string Update devices which are associated to the fabric name. |
username | string Update username and password for the devices. |
password | string Update username and password for the devices. |
OK
No switches found for the specified fabric.
Specified Fabric not found.
Unexpected error.
Unexpected error
Delete the specified devices from the inventory.
device_ips | Array of strings non-empty IP Addresses of the device to be deleted. |
fabric_name | string Fabric name. Devices in this fabric will be deleted. |
OK
Authorization information is missing or invalid.
A switch with the specified IP Address was not found.
Unexpected error.
Unexpected error
Manage the running-config on the specified devices.
Managed the running-config for devices in the fabric or specified devices.
device_ips | Array of strings IP Addresses of the devices for managing the running-config. |
fabric_name | string Name of the fabric |
persist_local | boolean Default: true Save the running-config to the startup-config on the specified devices. |
OK
Authorization information is missing or invalid.
No switches found for the specified fabric.
Specified Fabric not found.
Unexpected error.
Unexpected error
{- "device_ips": [
- "10.24.39.204",
- "10.24.39.207"
], - "fabric_name": "string",
- "persist_local": true
}
Execute CLI commands on the specified devices.
Execute CLI commands on the devices in the fabric or specified devices.
device_ips | Array of strings IP Addresses of the devices to execute the CLI command. |
fabric_name | string Name of the fabric |
role | string Enum: "Spine" "Leaf" "Super Spine" "Border Leaf" "Standalone" role of the device |
commands | string CLI commands to be executed on the device. |
config | boolean Default: false Specifies if the command is to be executed on config-term or exec-mode of the device. |
OK
Authorization information is missing or invalid.
No switches found for the specified fabric.
Specified Fabric not found.
Unexpected error.
Unexpected error
{- "device_ips": [
- "10.24.39.204",
- "10.24.39.207"
], - "fabric_name": "default",
- "role": "Spine",
- "commands": "show version",
- "config": false
}
Get the status of the firmware download execution.
fabric_name | string Fabric name. Get the firmware download execution status for devices in the given fabric. |
execution_id | string Execution ID. Get the firmware download execution status for devices in the fabric by execution ID. |
OK
No firmware download execution switches found for the specified fabric.
Specified Fabric not found.
Unexpected error.
Unexpected error
Execute firmware download on the prepared switches.
fabric_name required | string Fabric name. Execute the firmware download for prepared devices in the given fabric. |
Accepted firmware download execution request
No prepared switches found for the specified fabric.
Specified Fabric not found.
Unexpected error.
Unexpected error
Get the prepared devices ready for a firmware download operation.
device_ips | Array of strings non-empty IPs of the devices to be fetched |
fabric_name | string Fabric name. Prepared devices in this fabric to be fetched. |
OK
No switches found for the specified fabric.
Specified Fabric not found.
Unexpected error.
Unexpected error
Prepare the devices for a firmware download operation.
IPs of the devices to be prepared for a firmware download.
device_ips | Array of strings |
fabric | string |
firmware_host required | string |
firmware_directory required | string |
OK
Authorization information is missing or invalid.
No switches found for the specified fabric.
Specified Fabric not found.
Unexpected error.
Unexpected error
{- "device_ips": [
- "string"
], - "fabric": "string",
- "firmware_host": "string",
- "firmware_directory": "string"
}
Un-prepare the devices from a firmware download operation.
device_ips | Array of strings non-empty IP Addresses of the devices to be unprepared from a firmware download operation. |
fabric_name | string Fabric name. Devices in this fabric will be un-prepared. |
OK
Authorization information is missing or invalid.
A switch with the specified IP Address was not found.
Unexpected error.
Unexpected error
Get only the interfaces with the specific parameters for the specified switch
device_ips | Array of strings non-empty IP address of the device for which the interfaces are being fetched for |
device_ids | Array of integers non-empty IP address of the device for which the interfaces are being fetched for |
type required | string Default: "All" Enum: "All" "Physical" "Loopback" "VE" "PO" Interface types. All, Ethernet interfaces, Loopback interfaces only, VE interfaces only or Port channels only |
fabric_intf_role | string Enum: "fabric" "edge" Fabric interface role , it can be either fabric or edge, Fabric means it will returns interfaces connected to other fabric devices otherwise it is edge ports. This parameter must be given in conjunction with device_ips or device_ids |
OK
Authorization information is missing or invalid.
A device with the specified IP was not found.
Unexpected error.
Unexpected error
Get only the POs with the specific parameters for the specified switches
device_ips | Array of strings non-empty IP address of the device for which the port channels are being fetched for |
device_ids | Array of integers non-empty IP address of the device for which the port channels are being fetched for |
po_numbers | Array of integers non-empty Numbers of the Port Channels to be fetched |
OK
Authorization information is missing or invalid.
A device with the specified IP was not found.
Unexpected error.
Unexpected error
Get LLDP data for a given input param
remote_macs | Array of strings non-empty fetch the lldp data for remote interface MACs in hhhh.hhhh.hhhh format |
OK
Get links request has invalid input params.
Authorization information is missing or invalid.
Links with specified device IP/ID or fabric name/ID or link ID was not found.
Unexpected error.
Unexpected error
Get only the links for the specified switches
device_ips | Array of strings non-empty IP address of the device for which the links are being fetched for |
device_ids | Array of integers non-empty DeviceIDs for which the links are being fetched for |
ids | Array of integers non-empty IDs of the links to be fetched |
fabric_name | string Name of the fabric |
fabric_id | integer <int32> Database ID of the fabric |
OK
Get links request has invalid input params.
Authorization information is missing or invalid.
Links with specified device IP/ID or fabric name/ID or link ID was not found.
Unexpected error.
Unexpected error
Get VLANS for the specified switches
device_ip | string IP address of the device for which the VLANs are being fetched for |
device_id | integer Device IDs for which the VLANs are being fetched for |
vlan_ids | Array of integers non-empty VLAN IDs to be fetched |
OK
Vlan request has invalid input params.
Authorization information is missing or invalid.
Vlans with specified device IP/ID or Vlan ID was not found.
Unexpected error.
Unexpected error
Get only the VEs with the specific parameters for the specified switches
device_ips | Array of strings non-empty IP address of the device for which the VEs are being fetched for |
device_ids | Array of integers non-empty IP address of the device for which the VEs are being fetched for |
ve_ids | Array of integers non-empty IDs of the VEs to be fetched |
OK
Authorization information is missing or invalid.
A device with the specified IP was not found.
Unexpected error.
Unexpected error
Get only the Router BGP with the specific parameters for the specified switch
device_ip | string IP address of the device for which the Router BGP are being fetched for |
device_id | integer IP address of the device for which the Router BGP are being fetched for |
OK
Authorization information is missing or invalid.
A device with the specified IP was not found.
Unexpected error.
Unexpected error
Get only the MCT cluster node details with the specific parameters for the specified switch
device_ip | string IP address of the device for which the cluster members are being fetched for |
device_id | integer ID of the device for which the cluster member are being fetched for |
node_ids | Array of integers non-empty IDs of the cluster nodes to be fetched. This is optional parameter along with device_id or device_ip |
ids | Array of integers non-empty IDs of the nodes to be fetched |
OK
Management cluster request has invalid input params.
Authorization information is missing or invalid.
Management Cluster with the specified device IP/ID or Node ID or instance ID was not found.
Unexpected error.
Unexpected error
Get the MCT cluster configuration with the specific parameters for the specified switch
device_ip | string IP address of the device for which the cluster members are being fetched for |
device_id | integer Device ID of the device for which the cluster member are being fetched for |
cluster_ids | Array of integers non-empty cluster ID for which the configuration to be fetched. This is optional parameter along with device_ip or device_id |
ids | Array of integers non-empty IDs of the cluster client members to be fetched |
OK
MCT cluster request has invalid input params.
Authorization information is missing or invalid.
MCT cluster with specified device IP/ID or Cluster ID or instance ID was not found.
Unexpected error.
Unexpected error
Get the MCT cluster client details with the specific parameters for the specified switch
device_ip | string IP address of the device for which the cluster members are being fetched for |
device_id | integer ID of the device for which the cluster member are being fetched for |
client_ids | Array of integers non-empty cluster client ID for which the members to be fetched |
cluster_id | integer ID of the cluster for which the clients to be fetched |
ids | Array of integers non-empty IDs of the cluster client members to be fetched |
OK
MCT client request has invalid input params.
Authorization information is missing or invalid.
MCT clients with specificed device IP/ID or Client ID or Cluster ID or instance ID was not found.
Unexpected error.
Unexpected error
Get only the LIFs details with the specific parameters for the specified switch
device_ip | string IP address of the device for which the lifs are being fetched for |
device_id | integer IP address of the device for which the lifs are being fetched for |
OK
Authorization information is missing or invalid.
A device with the specified IP was not found.
Unexpected error.
Unexpected error
Get only the EVPN Instance details along with Bridge Domain, VLAN mapping with the specific parameters for the specified switch
device_ip | string IP address of the device for which the evpn instance are being fetched for |
device_id | integer Device ID for which the evpn instance are being fetched for |
OK
Authorization information is missing or invalid.
A device with the specified IP was not found.
Unexpected error.
Unexpected error
Get only the EVPN Instance details along with Bridge Domain mapping with the specific parameters for the specified switch
device_ip | string IP address of the device for which the BD details are being fetched for |
device_id | integer IP address of the device for which the BD details are being fetched for |
bridge_domains | Array of integers non-empty Bridge domains that users want to specifically query. This will be in conjunction with the device_id or device_ip |
OK
Authorization information is missing or invalid.
A device with the specified IP was not found.
Unexpected error.
Unexpected error
Get only the Overlay Gateway details along with Bridge Domain to VNI mappinps and VLAN to VNI mapping with the specific parameters for the specified switch
device_ip | string IP address of the device for which the overlay gateway details are being fetched for |
device_id | integer Device ID for which the overlay gateway details are being fetched for |
OK
Authorization information is missing or invalid.
A device with the specified IP was not found.
Unexpected error.
Unexpected error
Get only the Tunnel details with the specific parameters for the specified switch
device_ip | string IP address of the device for which the tunnel details are being fetched for |
device_id | integer IP address of the device for which the tunnel details are being fetched for |
ids | Array of integers non-empty IDs of the tunnel details to be fetched |
tunnel_numbers | Array of integers non-empty Tunnel Numbers of the tunnel details to be fetched |
OK
Authorization information is missing or invalid.
A device with the specified IP was not found.
Unexpected error.
Unexpected error
Get only the VRF details with the specific parameters for the specified switch
device_ip | string IP address of the device for which the VRF details are being fetched for |
device_id | integer IP address of the device for which the VRF details are being fetched for |
ids | Array of integers non-empty IDs of the VRF details to be fetched |
vrfs | Array of strings non-empty VRF names of the VRF details to be fetched. This will be in conjunction with device_ip or device_id |
OK
VRF request has invalid input params.
Authorization information is missing or invalid.
A device with the specified IP was not found.
Unexpected error.
Unexpected error
Get only the VRRP details with the specific parameters for the specified switch
device_ip | string IP address of the device for which the VRF details are being fetched for |
device_id | integer IP address of the device for which the VRF details are being fetched for |
int_type | string Enum: "ethernet" "ve" Interface Type to fetch VRRP details for. This works in conjunction with device_id or device_ip and int_name |
int_name | string Interface Name to fetch VRRP details for. This works in conjunction with device_id or device_ip and int_type |
OK
Authorization information is missing or invalid.
A device with the specified IP was not found.
Unexpected error.
Unexpected error
Get the execution list of all the previous executions
limit required | integer Default: 100 Limit the number of executions that will be sent in the response. Default is 10 |
OK
Authorization information is missing or invalid.
Unexpected error.
Unexpected error
Returns a list of all key value pairs.
prefix | string Only return values which name starts with the provided prefix. |
decrypt | boolean Decrypt secrets and display plain text |
limit | integer Default: 100 Number of keys to get |
List of key value pairs
Unexpected error
Get a specific key vale pair based on key_name.
name required | string Key Name |
decrypt | boolean Decrypt secrets and display plain text. |
Key value pair requested.
Unexpected error
Create a new key value pair or update an existing one.
name required | string Key Name. |
Key Value pair content.
name required | string Key Name. |
value required | string Key's value. |
secret | boolean Encrypt value before saving the value. |
Key set/updated.
Unexpected error
{- "name": "string",
- "value": "string",
- "secret": true
}
Get all firmware hosts.
host_ips | Array of strings non-empty IPs of the firmware hosts to be fetched |
OK
No firmware hosts found.
Unexpected error.
Unexpected error
Get only specified firmware host details. The firmware host can be identified by IP Address
ip_address required | string IP Address of the firmware host |
OK
A firmware host with the specified IP was not found.
Unexpected error.
Unexpected error
Register firmware host with the inventory service
Register a new firmware host.
ip_address required | string |
protocol required | string Enum: "ftp" "tftp" "sftp" "scp" "http" |
username required | string |
password required | string |
OK
Authorization information is missing.
A firmware host with the specified IP already exists.
Invalid IP/Protocol/Username/Password for registering the firmware host.
Firmware host connection failed while registering the host.
Unexpected error.
Unexpected error
{- "ip_address": "string",
- "protocol": "ftp",
- "username": "string",
- "password": "string"
}
Delete the specified firmware host from the inventory.
ip_address required | string IP Addresses of the firmware host to be deleted. |
OK
A firmware host with the specified IP Address was not found.
Not able to delete the firmware host with specified IP Address.
Unexpected error.
Unexpected error
Update the specified firmware host details in the inventory.
ip_address required | string IP Address of the firmware host to be updated. |
Update firmware host if credentials changes provide new username and password
ip_address required | string |
protocol required | string Enum: "ftp" "tftp" "sftp" "scp" "http" |
username required | string |
password required | string |
OK
Authorization information is missing.
Couldnt connect to the firmware host.
Update firmware download host failed because of invalid IP address in the request.
Firmware host update failed for the specified IP address.
Unexpected error.
Unexpected error
{- "ip_address": "string",
- "protocol": "ftp",
- "username": "string",
- "password": "string"
}