Download OpenAPI specification:Download
This is the spec that defines the API provided by the Inventory/Asset Service, which is used by multiple services to access network configuration/state data
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. |
config_backup_id | string UUID of config backup |
Accepted switch replace request
Authorization information is missing or invalid.
A switch with the specified IP doesnt exists.
Unexpected error
Unexpected error
{- "href": "href",
- "uuid": "id"
}
delet RMA ID.
key | string IP Addresses of the device or RMA uuid to deleted. |
drift and reconcile delete request
Invalid IP address.
Unexpected error.
Unexpected error
{- "result": 0,
- "userKey": "1111-1111-1111",
- "error": "uuid not found"
}
Get Switch replace History list
device_ip | string Ip of the entry for which RMA history is fetched |
OK
No RMA History found in the system
Unexpected error
Unexpected error
{- "items": [
- {
- "rma_id": "1111-1111-1111",
- "device_ip": "1.1.1.1",
- "status": "Success"
}, - {
- "rma_id": "1122-1122-1122",
- "device_ip": "1.1.2.1",
- "status": "Success"
}
]
}
Get RMA Detail
rma_id required | string RMA Id of the entry for which detail is fetched |
OK
Status of the device was not found.
Unexpected error.
Unexpected error
{- "dr_id": "1111-1111-1111",
- "device-ip": "1.1.1.1",
- "status": "Success",
- "StartTime": "12:03:24,12/2/2020"
}
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
{- "compare-results": {
- "key": "Device Details Changed:true"
}
}
Get the status of the TPVM upgrade execution.
ip_address | string IP Addresses of the device |
execution_id | string Execution ID. Get the tpvm upgrade execution status for device by execution ID. |
OK
No tpvm upgrade execution switch found for the specified ip address.
Unexpected error.
Unexpected error
{- "switch_data": {
- "role": "Spine",
- "global_ip_mtu": 0,
- "ipv6_anycast_gateway_mac": "0",
- "chassis_name": "BR-SLX-9250",
- "ip_address": "10.20.246.28",
- "ip_anycast_gateway_mac": "0",
- "is_virtual_device": true,
- "global_l2_mtu": 0,
- "fabric": {
- "fabric_name": "default",
- "fabric_id": 1
}, - "discovery_status": "Completed",
- "name": "sw0",
- "model": "3009",
- "id": 1,
- "state": "New",
- "global_ipv6_mtu": 0,
- "firmware": "20.3.2",
- "asn": 65000
}, - "start_time": "2000-01-23T04:42:16.000Z",
- "last_update_time": "2000-01-23T04:56:07.000Z",
- "update_state": "Completed",
- "id": 1,
- "target_tpvm_version": "4.2.1",
- "status": "TPVM Upgrade Completed",
- "detailed_status": "None"
}
Execute TPVM upgrade on the switch.
ip_address required | string IP Addresses of the device. |
firmware_host required | string IP address of a registered firmware host. |
tpvm_image required | string TPVM image path and filename located on the firmware host. |
trusted_peer_sudo_user | string TPVM trusted peer sudo user configuration to be reconfigured after the TPVM has been upgraded. Default sudo user is "extreme" if not specified along with the trusted peer password. |
trusted_peer_password | string TPVM trusted peer password configuration to be reconfigured after the TPVM has been upgraded. |
Accepted TPVM upgrade execution request.
No switch found for the specified ip address.
Precondition validation error.
Unexpected error.
Unexpected error
{- "href": "href",
- "uuid": "id"
}
ip_address required | string IP Addresses of the device to be retrieved. |
OK
Partial success
Incorrect values specified for Switch setting
Authorization information is missing or invalid.
A Switch with the specified IP was not found.
A Switch settings already exist and cannot be updated.
Unexpected error.
Unexpected error
{- "device-ip": "10.20.30.40",
- "device-settings": {
- "key": "devSettingType",
- "value": {
- "result": 1,
- "error-msg": "device not rechable"
}
}
}
Update Switch Settings.
ip_address required | string |
keyval required | Array of objects (DeviceParameter) |
OK
Partial success.
Incorrect values specified for Switch setting
Authorization information is missing or invalid.
A Switch with the specified IP was not found.
A switch settings already exist and cannot be updated.
Specified switch setting doesnt exist.
Unexpected error.
Unexpected error
{- "ip_address": "10.20.30.40",
- "keyval": [
- {
- "value": "value",
- "key": "key"
}, - {
- "value": "value",
- "key": "key"
}
]
}
{- "device-ip": "10.20.30.40",
- "device-settings": {
- "key": "devSettingType",
- "value": {
- "result": 1,
- "error-msg": "device not rechable"
}
}
}
Trigger drift and reconcile for inventory, fabric and tenant.
ip_address required | string IP Addresses of the device to be retrieved. |
reconcile required | boolean Default: false Value true implies efa drift with devices will be reconciled |
Accepted drift and reconcile execution request
Invalid IP address.
Unexpected error.
Unexpected error
{- "href": "href",
- "uuid": "id"
}
delet drift and reconcile ID.
key | string IP Addresses of the device or drift and reconcile uuid to deleted. |
drift and reconcile delete request
Invalid IP address.
Unexpected error.
Unexpected error
{- "result": 0,
- "userKey": "1111-1111-1111",
- "error": "uuid not found"
}
current health status for the switch.
ip_address required | string IP Addresses of the device to be retrieved. |
Accepted drift and reconcile execution request
Invalid IP address.
Unexpected error.
Unexpected error
{- "switchHealth": "disabled",
- "drUUID": "Id",
- "href": "/v1/inventory/drift_reconcile/detail",
- "heartBeatMissCounter": 2,
- "heartBeatMissThreshold": 2,
- "healthCheckInterval": "5m",
- "maintenanceMode": "enabled"
}
Config Replay to device.
ip_address required | string IP Addresses of the device to be replayed. |
cb_id | string ConfigBackup Id of the config to be applied |
ss_id | string Snapshot Id of the config to be applied |
startup_config | boolean Copy the config to startup config. |
no_reboot | boolean Don't reboot the device. |
Accepted config replay execution request
Invalid IP address.
Unexpected error.
Unexpected error
{- "href": "href",
- "uuid": "id"
}
Delete Config Replay ID.
key | string IP Addresses of the device or config Replay uuid to deleted. |
Config Replay delete request
Invalid IP address.
Unexpected error.
Unexpected error
{- "result": 0,
- "userKey": "1111-1111-1111",
- "error": "uuid not found"
}
Config Backup from device.
ip_address required | string IP Addresses of the device to be retrieved. |
Accepted config backup request
Invalid IP address.
Unexpected error.
Unexpected error
{- "href": "href",
- "uuid": "id"
}
Delete Config Backup ID.
key | string IP Addresses of the device or config backup uuid to deleted. |
Config Backup delete request
Invalid IP address.
Unexpected error.
Unexpected error
{- "result": 0,
- "userKey": "1111-1111-1111",
- "error": "uuid not found"
}
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
{- "items": [
- {
- "role": "Spine",
- "global_ip_mtu": 0,
- "ipv6_anycast_gateway_mac": "0",
- "chassis_name": "BR-SLX-9140",
- "ip_address": "10.24.39.224",
- "ip_anycast_gateway_mac": "0",
- "is_virtual_device": true,
- "global_l2_mtu": 0,
- "fabric": {
- "fabric_name": "default",
- "fabric_id": 1
}, - "discovery_status": "Completed",
- "name": "sw0",
- "model": "3000",
- "id": 1,
- "state": "New",
- "global_ipv6_mtu": 0,
- "firmware": "17.01.02",
- "asn": 65000
}, - {
- "role": "Spine",
- "global_ip_mtu": 0,
- "ipv6_anycast_gateway_mac": "0",
- "chassis_name": "BR-SLX-9140",
- "ip_address": "10.24.39.224",
- "ip_anycast_gateway_mac": "0",
- "is_virtual_device": true,
- "global_l2_mtu": 0,
- "fabric": {
- "fabric_name": "default",
- "fabric_id": 1
}, - "discovery_status": "Completed",
- "name": "sw0",
- "model": "3000",
- "id": 1,
- "state": "New",
- "global_ipv6_mtu": 0,
- "firmware": "17.01.02",
- "asn": 65000
}
]
}
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
[- {
- "is_virtual_device": true,
- "role": "Spine",
- "fabric": {
- "fabric_name": "default",
- "fabric_id": 1
}, - "name": "sw0",
- "model": "3000",
- "chassis_name": "BR-SLX-9140",
- "ip_address": "10.24.39.224",
- "id": 1,
- "state": "New",
- "firmware": "17.01.02",
- "asn": 65000,
- "status": {
- "result": "Failed",
- "reason": "Device is not registered"
}
}
]
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
[- {
- "is_virtual_device": true,
- "role": "Spine",
- "fabric": {
- "fabric_name": "default",
- "fabric_id": 1
}, - "name": "sw0",
- "model": "3000",
- "chassis_name": "BR-SLX-9140",
- "ip_address": "10.24.39.224",
- "id": 1,
- "state": "New",
- "firmware": "17.01.02",
- "asn": 65000,
- "status": {
- "result": "Failed",
- "reason": "Device is not registered"
}
}
]
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
{- "fabric_name": "fabric_name",
- "device_ips": [
- "10.24.39.204",
- "10.24.39.207"
], - "persist_local": true
}
{- "items": [
- {
- "fabric_name": "default",
- "name": "sw0",
- "ip_address": "10.24.39.224",
- "status": {
- "result": "Failed",
- "reason": "Device is not registered"
}
}, - {
- "fabric_name": "default",
- "name": "sw0",
- "ip_address": "10.24.39.224",
- "status": {
- "result": "Failed",
- "reason": "Device is not registered"
}
}
]
}
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
{- "fabric_name": "default",
- "role": "Spine",
- "device_ips": [
- "10.24.39.204",
- "10.24.39.207"
], - "config": false,
- "commands": "show version"
}
{- "items": [
- {
- "fabric_name": "default",
- "name": "sw0",
- "command_responses": [
- {
- "output": "output",
- "start_time": "2000-01-23T04:56:07.000Z",
- "end_time": "2000-01-23T04:56:07.000Z",
- "command": "show version",
- "status": {
- "result": "Failed",
- "reason": "Device is not registered"
}
}, - {
- "output": "output",
- "start_time": "2000-01-23T04:56:07.000Z",
- "end_time": "2000-01-23T04:56:07.000Z",
- "command": "show version",
- "status": {
- "result": "Failed",
- "reason": "Device is not registered"
}
}
], - "ip_address": "10.24.39.224"
}, - {
- "fabric_name": "default",
- "name": "sw0",
- "command_responses": [
- {
- "output": "output",
- "start_time": "2000-01-23T04:56:07.000Z",
- "end_time": "2000-01-23T04:56:07.000Z",
- "command": "show version",
- "status": {
- "result": "Failed",
- "reason": "Device is not registered"
}
}, - {
- "output": "output",
- "start_time": "2000-01-23T04:56:07.000Z",
- "end_time": "2000-01-23T04:56:07.000Z",
- "command": "show version",
- "status": {
- "result": "Failed",
- "reason": "Device is not registered"
}
}
], - "ip_address": "10.24.39.224"
}
]
}
Register switches with the inventory service
Register a new Switch.
device_ips required | Array of strings |
username required | string |
password required | string |
maintmode | boolean |
OK
Authorization information is missing or invalid.
A switch with the specified IP already exists.
Unexpected error.
Unexpected error
{- "password": "password",
- "device_ips": [
- "device_ips",
- "device_ips"
], - "username": "username",
- "maintmode": true
}
[- {
- "is_virtual_device": true,
- "name": "sw0",
- "model": "SLX9240",
- "chassis_name": "BR-SLX-9140",
- "ip_address": "10.24.39.224",
- "id": 1,
- "state": "Discovered",
- "firmware": "17.01.02",
- "asn": 65000,
- "status": {
- "result": "Failed",
- "reason": "Device is not registered"
}
}
]
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
{- "items": [
- {
- "switch_data": {
- "role": "Spine",
- "global_ip_mtu": 0,
- "ipv6_anycast_gateway_mac": "0",
- "chassis_name": "BR-SLX-9140",
- "ip_address": "10.24.39.224",
- "ip_anycast_gateway_mac": "0",
- "is_virtual_device": true,
- "global_l2_mtu": 0,
- "fabric": {
- "fabric_name": "default",
- "fabric_id": 1
}, - "discovery_status": "Completed",
- "name": "sw0",
- "model": "3000",
- "id": 1,
- "state": "New",
- "global_ipv6_mtu": 0,
- "firmware": "17.01.02",
- "asn": 65000
}, - "last_update_time": "2000-01-23T04:56:07.000Z",
- "update_state": "In-Progress",
- "id": 1,
- "target_firmware": "target_firmware",
- "status": "status"
}, - {
- "switch_data": {
- "role": "Spine",
- "global_ip_mtu": 0,
- "ipv6_anycast_gateway_mac": "0",
- "chassis_name": "BR-SLX-9140",
- "ip_address": "10.24.39.224",
- "ip_anycast_gateway_mac": "0",
- "is_virtual_device": true,
- "global_l2_mtu": 0,
- "fabric": {
- "fabric_name": "default",
- "fabric_id": 1
}, - "discovery_status": "Completed",
- "name": "sw0",
- "model": "3000",
- "id": 1,
- "state": "New",
- "global_ipv6_mtu": 0,
- "firmware": "17.01.02",
- "asn": 65000
}, - "last_update_time": "2000-01-23T04:56:07.000Z",
- "update_state": "In-Progress",
- "id": 1,
- "target_firmware": "target_firmware",
- "status": "status"
}
]
}
Execute firmware download on the prepared switches.
fabric_name required | string Fabric name. Execute the firmware download for prepared devices in the given fabric. |
group_execution | string Group Execution option in Firmware Download. |
no_auto_commit | boolean Configure auto commit for Firmware Downloaed. |
no_maint_mode | boolean Configure Maintainance mode in Firmware Download |
Accepted firmware download execution request
No prepared switches found for the specified fabric.
Specified Fabric not found.
Precondition validation error.
Unexpected error.
Unexpected error
{- "execution_task": {
- "href": "href",
- "uuid": "id"
}
}
Execute firmware download commit on the switches.
IPs of the devices to be prepared for a firmware download.
device_ips | Array of strings |
fabric | string |
Firmware download commit request succesful
No firmware downloded switches found for the specified fabric.
No prepared switches found for the specified fabric.
Specified Fabric not found.
Precondition validation error.
Unexpected error.
Unexpected error
{- "fabric": "fabric",
- "device_ips": [
- "device_ips",
- "device_ips"
]
}
{- "items": [
- {
- "ip_address": "string",
- "task_status": "string",
- "task_error": "string"
}
]
}
Execute firmware download restore on the switches.
IPs of the devices to be prepared for a firmware download.
device_ips | Array of strings |
fabric | string |
Accepted firmware download restore request
No firmware downloded switches found for the specified fabric.
Specified Fabric not found.
Precondition validation error.
Unexpected error.
Unexpected error
{- "fabric": "fabric",
- "device_ips": [
- "device_ips",
- "device_ips"
]
}
{- "execution_task": {
- "href": "href",
- "uuid": "id"
}, - "items": [
- {
- "ip_address": "string",
- "task_status": "string",
- "task_error": "string"
}
]
}
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
{- "items": [
- {
- "switch_data": {
- "role": "Spine",
- "global_ip_mtu": 0,
- "ipv6_anycast_gateway_mac": "0",
- "chassis_name": "BR-SLX-9140",
- "ip_address": "10.24.39.224",
- "ip_anycast_gateway_mac": "0",
- "is_virtual_device": true,
- "global_l2_mtu": 0,
- "fabric": {
- "fabric_name": "default",
- "fabric_id": 1
}, - "discovery_status": "Completed",
- "name": "sw0",
- "model": "3000",
- "id": 1,
- "state": "New",
- "global_ipv6_mtu": 0,
- "firmware": "17.01.02",
- "asn": 65000
}, - "last_update_time": "2000-01-23T04:56:07.000Z",
- "firmware_host": {
- "protocol": "scp",
- "id": 1,
- "ip_address": "10.24.39.224",
- "status": {
- "result": "Failed",
- "reason": "Device or host registration failed"
}
}, - "id": 1,
- "firmware_directory": "firmware_directory",
- "target_firmware": "target_firmware",
- "status": {
- "result": "Failed",
- "reason": "Device or host registration failed"
}
}, - {
- "switch_data": {
- "role": "Spine",
- "global_ip_mtu": 0,
- "ipv6_anycast_gateway_mac": "0",
- "chassis_name": "BR-SLX-9140",
- "ip_address": "10.24.39.224",
- "ip_anycast_gateway_mac": "0",
- "is_virtual_device": true,
- "global_l2_mtu": 0,
- "fabric": {
- "fabric_name": "default",
- "fabric_id": 1
}, - "discovery_status": "Completed",
- "name": "sw0",
- "model": "3000",
- "id": 1,
- "state": "New",
- "global_ipv6_mtu": 0,
- "firmware": "17.01.02",
- "asn": 65000
}, - "last_update_time": "2000-01-23T04:56:07.000Z",
- "firmware_host": {
- "protocol": "scp",
- "id": 1,
- "ip_address": "10.24.39.224",
- "status": {
- "result": "Failed",
- "reason": "Device or host registration failed"
}
}, - "id": 1,
- "firmware_directory": "firmware_directory",
- "target_firmware": "target_firmware",
- "status": {
- "result": "Failed",
- "reason": "Device or host registration failed"
}
}
]
}
Prepare the devices for a firmware download operation.
force | boolean Configure force option in prepare request to skip all validations |
IPs of the devices to be prepared for a firmware download.
device_ips | Array of strings |
group_name | integer |
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
{- "fabric": "fabric",
- "device_ips": [
- "device_ips",
- "device_ips"
], - "firmware_host": "firmware_host",
- "firmware_directory": "firmware_directory"
}
{- "items": [
- {
- "switch_data": {
- "role": "Spine",
- "global_ip_mtu": 0,
- "ipv6_anycast_gateway_mac": "0",
- "chassis_name": "BR-SLX-9140",
- "ip_address": "10.24.39.224",
- "ip_anycast_gateway_mac": "0",
- "is_virtual_device": true,
- "global_l2_mtu": 0,
- "fabric": {
- "fabric_name": "default",
- "fabric_id": 1
}, - "discovery_status": "Completed",
- "name": "sw0",
- "model": "3000",
- "id": 1,
- "state": "New",
- "global_ipv6_mtu": 0,
- "firmware": "17.01.02",
- "asn": 65000
}, - "last_update_time": "2000-01-23T04:56:07.000Z",
- "firmware_host": {
- "protocol": "scp",
- "id": 1,
- "ip_address": "10.24.39.224",
- "status": {
- "result": "Failed",
- "reason": "Device or host registration failed"
}
}, - "id": 1,
- "firmware_directory": "firmware_directory",
- "target_firmware": "target_firmware",
- "status": {
- "result": "Failed",
- "reason": "Device or host registration failed"
}
}, - {
- "switch_data": {
- "role": "Spine",
- "global_ip_mtu": 0,
- "ipv6_anycast_gateway_mac": "0",
- "chassis_name": "BR-SLX-9140",
- "ip_address": "10.24.39.224",
- "ip_anycast_gateway_mac": "0",
- "is_virtual_device": true,
- "global_l2_mtu": 0,
- "fabric": {
- "fabric_name": "default",
- "fabric_id": 1
}, - "discovery_status": "Completed",
- "name": "sw0",
- "model": "3000",
- "id": 1,
- "state": "New",
- "global_ipv6_mtu": 0,
- "firmware": "17.01.02",
- "asn": 65000
}, - "last_update_time": "2000-01-23T04:56:07.000Z",
- "firmware_host": {
- "protocol": "scp",
- "id": 1,
- "ip_address": "10.24.39.224",
- "status": {
- "result": "Failed",
- "reason": "Device or host registration failed"
}
}, - "id": 1,
- "firmware_directory": "firmware_directory",
- "target_firmware": "target_firmware",
- "status": {
- "result": "Failed",
- "reason": "Device or host registration failed"
}
}
]
}
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. |
group_name | integer Group name. Devices in this Group 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
{- "items": [
- {
- "switch_data": {
- "role": "Spine",
- "global_ip_mtu": 0,
- "ipv6_anycast_gateway_mac": "0",
- "chassis_name": "BR-SLX-9140",
- "ip_address": "10.24.39.224",
- "ip_anycast_gateway_mac": "0",
- "is_virtual_device": true,
- "global_l2_mtu": 0,
- "fabric": {
- "fabric_name": "default",
- "fabric_id": 1
}, - "discovery_status": "Completed",
- "name": "sw0",
- "model": "3000",
- "id": 1,
- "state": "New",
- "global_ipv6_mtu": 0,
- "firmware": "17.01.02",
- "asn": 65000
}, - "last_update_time": "2000-01-23T04:56:07.000Z",
- "firmware_host": {
- "protocol": "scp",
- "id": 1,
- "ip_address": "10.24.39.224",
- "status": {
- "result": "Failed",
- "reason": "Device or host registration failed"
}
}, - "id": 1,
- "firmware_directory": "firmware_directory",
- "target_firmware": "target_firmware",
- "status": {
- "result": "Failed",
- "reason": "Device or host registration failed"
}
}, - {
- "switch_data": {
- "role": "Spine",
- "global_ip_mtu": 0,
- "ipv6_anycast_gateway_mac": "0",
- "chassis_name": "BR-SLX-9140",
- "ip_address": "10.24.39.224",
- "ip_anycast_gateway_mac": "0",
- "is_virtual_device": true,
- "global_l2_mtu": 0,
- "fabric": {
- "fabric_name": "default",
- "fabric_id": 1
}, - "discovery_status": "Completed",
- "name": "sw0",
- "model": "3000",
- "id": 1,
- "state": "New",
- "global_ipv6_mtu": 0,
- "firmware": "17.01.02",
- "asn": 65000
}, - "last_update_time": "2000-01-23T04:56:07.000Z",
- "firmware_host": {
- "protocol": "scp",
- "id": 1,
- "ip_address": "10.24.39.224",
- "status": {
- "result": "Failed",
- "reason": "Device or host registration failed"
}
}, - "id": 1,
- "firmware_directory": "firmware_directory",
- "target_firmware": "target_firmware",
- "status": {
- "result": "Failed",
- "reason": "Device or host registration failed"
}
}
]
}
Populate Fabric service specific data in Inventory service
Fabric service data fabric_type, device_rack.
items | Array of objects (Fabric service specefic data) |
Fabric data updated successfully in Inventory
No Fabric data found to update in Inventory
Specified Fabric not found.
Precondition validation error.
Unexpected error.
Unexpected error
{- "items": [
- {
- "fabric_id": 0,
- "fabric_name": "string",
- "fabric_type": "string",
- "fabric_devices": [
- {
- "device_id": 0,
- "device_ip_address": "string",
- "device_rack": "string"
}
]
}
]
}
{- "reason": "string"
}
Capture the supportsave data from device(s) and return the file name in the response
SupportSave for devices
fabric | string Fabric name to take SS of rall devices in the fabric |
device-ips | string Device IP's of switches to collect support save from |
fabric-all | boolean true/false to take Support save of all devices |
OK
Authorization information is missing or invalid.
Unexpected error.
Unexpected error
{- "fabric": "default",
- "device-ips": "10.24.131.3,162.101.21.2,192.24.32.204",
- "fabric-all": true
}
{- "deviceSSResponse": [
- {
- "ip_address": "10.24.39.224"
}, - {
- "status": {
- "result": "Failed",
- "reason": "Device not present"
}
}
]
}
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 |
admin_state required | string Default: "All" Enum: "Up" "Down" "All" Interface's admin state. up, down, all values only for admin state |
rme | boolean Interface's RME. enabled or not |
oper_state required | string Default: "All" Enum: "Up" "Down" "All" Interface's oper state(Line protocol state). up, down, all values only for admin state |
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
{- "items": [
- {
- "interfaces": [
- {
- "items": [
- {
- "identifier": "identifier",
- "app_state": "cfg-refreshed",
- "role": "edge",
- "actual_line_speed": "40Gbps",
- "configured_speed": "40Gbps",
- "int_type": "ethernet",
- "native_vlan_enabled": true,
- "native_vlan": 2,
- "ip_address": [
- "ip_address",
- "ip_address"
], - "switchport_mode": "unknown",
- "donor_port_number": "1",
- "oper_status": "up",
- "mac": "0000:1111:2222",
- "mtu": 6,
- "ip_mtu": 1,
- "ip_pim_sparse": true,
- "donor_port_type": "loopback",
- "name": "0/1",
- "admin_status": "up",
- "id": 1
}, - {
- "identifier": "identifier",
- "role": "edge",
- "actual_line_speed": "40Gbps",
- "configured_speed": "40Gbps",
- "int_type": "ethernet",
- "native_vlan_enabled": true,
- "native_vlan": 2,
- "ip_address": [
- "ip_address",
- "ip_address"
], - "switchport_mode": "unknown",
- "donor_port_number": "1",
- "oper_status": "up",
- "mac": "0000:1111:2222",
- "mtu": 6,
- "ip_mtu": 1,
- "donor_port_type": "loopback",
- "name": "0/1",
- "admin_status": "up",
- "id": 1
}
]
}, - {
- "items": [
- {
- "identifier": "identifier",
- "app_state": "cfg-refreshed",
- "role": "edge",
- "actual_line_speed": "40Gbps",
- "configured_speed": "40Gbps",
- "int_type": "ethernet",
- "native_vlan_enabled": true,
- "native_vlan": 2,
- "ip_address": [
- "ip_address",
- "ip_address"
], - "switchport_mode": "unknown",
- "donor_port_number": "1",
- "oper_status": "up",
- "mac": "0000:1111:2222",
- "mtu": 6,
- "ip_mtu": 1,
- "donor_port_type": "loopback",
- "name": "0/1",
- "admin_status": "up",
- "id": 1
}, - {
- "identifier": "identifier",
- "role": "edge",
- "actual_line_speed": "40Gbps",
- "configured_speed": "40Gbps",
- "int_type": "ethernet",
- "native_vlan_enabled": true,
- "native_vlan": 2,
- "ip_address": [
- "ip_address",
- "ip_address"
], - "switchport_mode": "unknown",
- "donor_port_number": "1",
- "oper_status": "up",
- "mac": "0000:1111:2222",
- "mtu": 6,
- "ip_mtu": 1,
- "donor_port_type": "loopback",
- "name": "0/1",
- "admin_status": "up",
- "id": 1
}
]
}
], - "ip_address": "10.24.39.224"
}, - {
- "interfaces": [
- {
- "items": [
- {
- "identifier": "identifier",
- "app_state": "cfg-refreshed",
- "role": "edge",
- "actual_line_speed": "40Gbps",
- "configured_speed": "40Gbps",
- "int_type": "ethernet",
- "native_vlan_enabled": true,
- "native_vlan": 2,
- "ip_address": [
- "ip_address",
- "ip_address"
], - "switchport_mode": "unknown",
- "donor_port_number": "1",
- "oper_status": "up",
- "mac": "0000:1111:2222",
- "mtu": 6,
- "ip_mtu": 1,
- "donor_port_type": "loopback",
- "name": "0/1",
- "admin_status": "up",
- "id": 1
}, - {
- "identifier": "identifier",
- "role": "edge",
- "actual_line_speed": "40Gbps",
- "configured_speed": "40Gbps",
- "int_type": "ethernet",
- "native_vlan_enabled": true,
- "native_vlan": 2,
- "ip_address": [
- "ip_address",
- "ip_address"
], - "switchport_mode": "unknown",
- "donor_port_number": "1",
- "oper_status": "up",
- "mac": "0000:1111:2222",
- "mtu": 6,
- "ip_mtu": 1,
- "donor_port_type": "loopback",
- "name": "0/1",
- "admin_status": "up",
- "id": 1
}
]
}, - {
- "items": [
- {
- "identifier": "identifier",
- "app_state": "cfg-refreshed",
- "role": "edge",
- "actual_line_speed": "40Gbps",
- "configured_speed": "40Gbps",
- "int_type": "ethernet",
- "native_vlan_enabled": true,
- "native_vlan": 2,
- "ip_address": [
- "ip_address",
- "ip_address"
], - "switchport_mode": "unknown",
- "donor_port_number": "1",
- "oper_status": "up",
- "mac": "0000:1111:2222",
- "mtu": 6,
- "ip_mtu": 1,
- "donor_port_type": "loopback",
- "name": "0/1",
- "admin_status": "up",
- "id": 1
}, - {
- "identifier": "identifier",
- "role": "edge",
- "actual_line_speed": "40Gbps",
- "configured_speed": "40Gbps",
- "int_type": "ethernet",
- "native_vlan_enabled": true,
- "native_vlan": 2,
- "ip_address": [
- "ip_address",
- "ip_address"
], - "switchport_mode": "unknown",
- "donor_port_number": "1",
- "oper_status": "up",
- "mac": "0000:1111:2222",
- "mtu": 6,
- "ip_mtu": 1,
- "donor_port_type": "loopback",
- "name": "0/1",
- "admin_status": "up",
- "id": 1
}
]
}
], - "ip_address": "10.24.39.224"
}
]
}
Down/Up interfaces with the specific parameters for the specified switch
Register a new Switch.
ip_address required | Array of strings non-empty |
intfNames required | Array of strings non-empty |
adminState required | string Enum: "up" "down" |
intfType | string Default: "Eth" Enum: "Eth" "VE" "PO" |
OK
Authorization information is missing or invalid.
A device with the specified IP was not found.
Unexpected error.
Unexpected error
{- "intfType": "Eth",
- "adminState": "up",
- "ip_address": "ip_address",
- "intfNames": [
- "intfNames",
- "intfNames"
]
}
[- {
- "ip_address": "10.10.10.10",
- "interfaces": [
- {
- "intf_type": "ethernet",
- "name": "0/1",
- "admin_state": "up",
- "id": 1
}, - {
- "intf_type": "ethernet",
- "name": "0/1",
- "admin_state": "up",
- "id": 1
}
]
}
]
Create Breakout interfaces port with the specific parameters for the specified switch
Breakout break Port into multiple interfaces.
ip_address required | Array of strings non-empty |
intfNames required | Array of strings non-empty Interface Port Names |
intfType | string Default: "Eth" Enum: "Eth" "VE" "PO" |
mode required | string Enum: "4x10g" "4x25g" Port breakout mode |
OK
Authorization information is missing or invalid.
A device with the specified IP was not found.
Unexpected error.
Unexpected error
{- "mode": "4x10g",
- "intfType": "Eth",
- "ip_address": "ip_address",
- "intfNames": [
- "intfNames",
- "intfNames"
]
}
[- {
- "ip_address": "string",
- "error": "string",
- "interfaces": [
- {
- "id": 1,
- "intf_type": "ethernet",
- "name": "0/1",
- "app_state": "cfg-refreshed",
- "status": {
- "result": "Failed",
- "reason": "Invalid Interface name provided"
}
}
]
}
]
Remove Breakout of interfaces port with the specific parameters for the specified switch
Removes Breakout of interfaces of the Switch.
ip_address | Array of strings |
intfNames required | Array of strings Interface Port Names |
intfType | string Default: "Eth" Enum: "Eth" "VE" "PO" |
OK
Authorization information is missing or invalid.
A device with the specified IP was not found.
Unexpected error.
Unexpected error
{- "ip_address": [
- "string"
], - "intfNames": [
- "string"
], - "intfType": "Eth"
}
[- {
- "ip_address": "string",
- "error": "string",
- "interfaces": [
- {
- "id": 1,
- "device_ip": "10.10.10.10",
- "intf_type": "ethernet",
- "name": "0/1",
- "status": {
- "result": "Failed",
- "reason": "Invalid Interface name provided"
}
}
]
}
]
List Breakout interfaces port with the specific parameters for the specified switch
device_ips | Array of strings non-empty IP Addresses of the device(s) to List Breakout Ports. |
fabric_name | string List Breakout Ports of devices which are associated to the fabric name. |
OK
Authorization information is missing or invalid.
A device with the specified IP was not found.
Conflict.
Unexpected error.
Unexpected error
[- {
- "ip_address": "string",
- "error": "string",
- "interfaces": [
- {
- "id": 1,
- "intf_type": "ethernet",
- "name": "0/1",
- "app_state": "cfg-refreshed",
- "status": {
- "result": "Failed",
- "reason": "Invalid Interface name provided"
}
}
]
}
]
Change interfaces port speed with the specific parameters for the specified switch
Change Port speed of interfaces of the Switch.
ip_address required | Array of strings non-empty |
intfNames required | Array of strings non-empty Interface Port Names |
speed required | string Enum: "100Mbps" "1Gbps" "10Gbps" "25Gbps" "40Gbps" "100Gbps" "1GbpsAN" "AUTO" Port Speed |
intfType | string Default: "Eth" Enum: "Eth" "VE" "PO" Interface Type |
OK
Authorization information is missing or invalid.
A device with the specified IP was not found.
Unexpected error.
Unexpected error
{- "intfType": "Eth",
- "ip_address": "ip_address",
- "intfNames": [
- "intfNames",
- "intfNames"
], - "speed": "100Mbps"
}
[- {
- "interfaces": [
- {
- "intf_type": "ethernet",
- "name": "0/1",
- "id": 1,
- "speed": "up"
}, - {
- "intf_type": "ethernet",
- "name": "0/1",
- "id": 1,
- "speed": "up"
}
]
}
]
Set L2Mtu, IPv4Mtu and IPv6Mtu to interfaces with the specific parameters for the specified switch
Set L2Mtu, IPv4Mtu and IPv6Mtu to device interfaces.
ip_address required | Array of strings non-empty |
intfNames required | Array of strings non-empty Interface Port Names |
intfType | string Default: "Eth" Enum: "Eth" "VE" "PO" Interface Type |
mtu | integer L2 Mtu of interface |
ip_mtu | integer IPv4 Mtu of interface |
ipv6_mtu | integer IPv6 Mtu of interface |
OK
Authorization information is missing or invalid.
A device with the specified IP was not found.
Unexpected error.
Unexpected error
{- "ip_address": [
- "string"
], - "intfNames": [
- "string"
], - "intfType": "Eth",
- "mtu": 0,
- "ip_mtu": 0,
- "ipv6_mtu": 0
}
[- {
- "ip_address": "string",
- "error": "string",
- "interfaces": [
- {
- "id": 1,
- "intf_type": "ethernet",
- "name": "0/1",
- "mtu": 0,
- "ip_mtu": 0,
- "ipv6_mtu": 0,
- "status": {
- "result": "Failed",
- "reason": "Invalid Interface name provided"
}
}
]
}
]
Change interfaces port FEC with the specific parameters for the specified switch
Change Port FEC of interfaces of the Switch.
ip_address required | Array of strings non-empty |
intfNames required | Array of strings non-empty Interface Port Names |
mode required | string Enum: "fc-fec" "rs-fec" "auto" "disabled" Port FEC mode |
intfType | string Default: "Eth" Enum: "Eth" "VE" "PO" Interface Type |
OK
Authorization information is missing or invalid.
Unexpected error.
Unexpected error
{- "intfType": "Eth",
- "ip_address": "ip_address",
- "intfNames": [
- "intfNames",
- "intfNames"
], - "mode": "fc-fec"
}
[- {
- "interfaces": [
- {
- "intf_type": "ethernet",
- "name": "0/1",
- "id": 1,
- "mode": "fc-fec"
}, - {
- "intf_type": "ethernet",
- "name": "0/1",
- "id": 1,
- "mode": "disabled"
}
]
}
]
Remove Port FEC of interfaces port with the specific parameters for the specified switch
Removes Port FEC of interfaces of the Switch.
ip_address | Array of strings |
intfNames required | Array of strings Interface Port Names |
intfType | string Default: "Eth" Enum: "Eth" "VE" "PO" Interface Type |
OK
Authorization information is missing or invalid.
Unexpected error.
Unexpected error
{- "intfType": "Eth",
- "ip_address": "ip_address",
- "intfNames": [
- "intfNames",
- "intfNames"
]
}
[- {
- "interfaces": [
- {
- "name": "0/1",
- "id": 1,
- "intf_type": "ethernet"
}
]
}
]
Change interfaces port dampening with the specific parameters for the specified switch
Change Port Dampening of interfaces of the Switch.
ip_address required | Array of strings non-empty |
intfNames required | Array of strings non-empty Interface Port Names |
toggleThreshold | integer Port Dampening toggle threshold |
samplingTime | integer Port Dampening sampling time |
waitTime | integer Port Dampening wait time |
OK
Authorization information is missing or invalid.
Unexpected error.
Unexpected error
{- "ip_address": "ip_address",
- "intfNames": [
- "intfNames",
- "intfNames"
], - "toggleThreshold": 1,
- "samplingTime": 1,
- "waitTime": 1
}
[- {
- "interfaces": [
- {
- "name": "0/1",
- "id": 1,
- "toggle_threshold": 50,
- "sampling_time": 65565,
- "wait_time": 65565
}, - {
- "name": "0/1",
- "id": 1,
- "toggle_threshold": 50,
- "sampling_time": 65565,
- "wait_time": 65565
}
]
}
]
Remove Port Dampening of interfaces port with the specific parameters for the specified switch
Removes Port Dampening of interfaces of the Switch.
ip_address | Array of strings |
intfNames required | Array of strings Interface Port Names |
OK
Authorization information is missing or invalid.
Unexpected error.
Unexpected error
{- "ip_address": "ip_address",
- "intfNames": [
- "intfNames",
- "intfNames"
]
}
[- {
- "interfaces": [
- {
- "name": "0/1",
- "id": 1,
- "toggle_threshold": 50,
- "sampling_time": 65565,
- "wait_time": 65565
}, - {
- "intf_type": "ethernet",
- "name": "0/1",
- "id": 1,
- "toggle_threshold": 50,
- "sampling_time": 65565,
- "wait_time": 65565
}
]
}
]
Enable RME on interfaces with the specific parameters for the specified switch
Change RME status of interfaces of the Switch.
ip_address required | Array of strings non-empty |
intfNames required | string Interface Port Name |
EnableRME | boolean Port RME toggle threshold |
OK
Authorization information is missing or invalid.
Unexpected error.
Unexpected error
{- "ip_address": [
- "10.10.10.10",
- "20.20.20.20"
], - "intfNames": "0/31",
- "EnableRME": true
}
[- {
- "ip_address": "string",
- "error": "string",
- "interfaces": [
- {
- "name": "0/1",
- "id": 1,
- "EnableRME": true,
- "intfType": "eth"
}
]
}
]
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
{- "items": [
- {
- "ip_address": "10.24.39.224",
- "port_channels": [
- {
- "member_ports": [
- {
- "device_ip": "10.1.1.1",
- "interface_id": 2,
- "device_id": 1,
- "actor_port": 4,
- "interface_name": "0/7",
- "interface_type": "ethernet",
- "sync": 7
}, - {
- "device_ip": "10.1.1.1",
- "interface_id": 2,
- "device_id": 1,
- "actor_port": 4,
- "interface_name": "0/7",
- "interface_type": "ethernet",
- "sync": 7
}
], - "aggregator_id": 7,
- "aggregator_mode": "aggregator_mode",
- "partner_system_id": "partner_system_id",
- "admin_state": "up",
- "description": "description Port-channel po3",
- "speed": "40Gbps",
- "is_vlag": "true",
- "oper_state": "up",
- "aggregator_type": "aggregator_type",
- "actor_system_id": "actor_system_id",
- "partner_oper_priority": 3,
- "name": "po3",
- "system_priority": 9,
- "id": 1,
- "minimum_links": 2,
- "mtu": 9200
}, - {
- "member_ports": [
- {
- "device_ip": "10.1.1.1",
- "interface_id": 2,
- "device_id": 1,
- "actor_port": 4,
- "interface_name": "0/8",
- "interface_type": "ethernet",
- "sync": 7
}, - {
- "device_ip": "10.1.1.1",
- "interface_id": 2,
- "device_id": 1,
- "actor_port": 4,
- "interface_name": "0/7",
- "interface_type": "ethernet",
- "sync": 7
}
], - "aggregator_id": 7,
- "aggregator_mode": "aggregator_mode",
- "partner_system_id": "partner_system_id",
- "admin_state": "up",
- "description": "description Port-channel po6",
- "speed": "100Gbps",
- "is_vlag": "true",
- "oper_state": "up",
- "aggregator_type": "aggregator_type",
- "actor_system_id": "actor_system_id",
- "partner_oper_priority": 3,
- "name": "po6",
- "system_priority": 9,
- "id": 1,
- "minimum_links": 2,
- "mtu": 9200
}
]
}, - {
- "ip_address": "10.24.39.224",
- "port_channels": [
- {
- "member_ports": [
- {
- "device_ip": "10.1.1.1",
- "interface_id": 2,
- "device_id": 1,
- "actor_port": 4,
- "interface_name": "0/14",
- "interface_type": "ethernet",
- "sync": 7
}, - {
- "device_ip": "device_ip",
- "interface_id": 2,
- "device_id": 1,
- "actor_port": 4,
- "interface_name": "0/13",
- "interface_type": "ethernet",
- "sync": 7
}
], - "aggregator_id": 7,
- "aggregator_mode": "aggregator_mode",
- "partner_system_id": "partner_system_id",
- "admin_state": "up",
- "description": "description Port-channel po5",
- "speed": "40Gbps",
- "is_vlag": "true",
- "oper_state": "up",
- "aggregator_type": "aggregator_type",
- "actor_system_id": "actor_system_id",
- "partner_oper_priority": 3,
- "name": "po5",
- "system_priority": 9,
- "id": 1,
- "minimum_links": 2,
- "mtu": 9200
}, - {
- "member_ports": [
- {
- "device_ip": "10.1.1.1",
- "interface_id": 2,
- "device_id": 1,
- "actor_port": 4,
- "interface_name": "0/12",
- "interface_type": "ethernet",
- "sync": 7
}, - {
- "device_ip": "10.1.1.1",
- "interface_id": 2,
- "device_id": 1,
- "actor_port": 4,
- "interface_name": "0/11",
- "interface_type": "ethernet",
- "sync": 7
}
], - "aggregator_id": 7,
- "aggregator_mode": "aggregator_mode",
- "partner_system_id": "partner_system_id",
- "admin_state": "up",
- "description": "description Port-channel po4",
- "speed": "40Gbps",
- "is_vlag": "true",
- "oper_state": "up",
- "aggregator_type": "aggregator_type",
- "actor_system_id": "actor_system_id",
- "partner_oper_priority": 3,
- "name": "po4",
- "system_priority": 9,
- "id": 1,
- "minimum_links": 2,
- "mtu": 9200
}
]
}
]
}
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 |
device_ips | Array of strings non-empty Fetch the lldp data for single device IP in hhh.hhh.hhh.hhh format |
neighbor_type | string Default: "all" Enum: "all" "edge" "fabric" fetch all, edge or fabric lldp neighbors as a filter. |
OK
Get links request has invalid input params.
Authorization information is missing or invalid.
Unexpected error.
Unexpected error
[- {
- "remote_interface_unnumbered_ip": "10.10.10.20/31",
- "local_device_role": "Leaf",
- "device_id": 1,
- "remote_interface_name": "2333.3333.4444",
- "remote_interface_description": "Link to server",
- "local_device_name": "SLX",
- "local_interface_mac": "1234.abcd.4567",
- "local_device_ip": "10.2.2.2",
- "local_po_type": "standard",
- "remote_interface_unnumbered_mac": "0034.abcd.4568",
- "remote_system_name": "esxi-01",
- "local_interface_id": 10,
- "local_interface_type": "ethernet",
- "local_interface_name": "Ethernet 0/1",
- "local_po_number": 1,
- "remote_interface_mac": "0034.abcd.4567"
}
]
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
{- "items": [
- {
- "device_links": [
- {
- "items": [
- {
- "interface_2_mac": "0000.0000.0010",
- "device_2_role": "device_2_role",
- "interface_2_ip_address": "10.10.10.3",
- "interface_2_name": "0/1",
- "interface_1_ip_address": "10.10.10.2",
- "device_2_name": "device_2_name",
- "missing_time": "2000-01-23T04:56:07.000Z",
- "interface_1_id": 1,
- "interface_2_id": 65,
- "device_1_ip": "device_1_ip",
- "device_1_role": "device_1_role",
- "interface_1_mac": "0000.0000.0001",
- "device_1_name": "device_1_name",
- "device_2_ip": "device_2_ip",
- "interface_2_int_type": "ethernet",
- "device_1_id": 5,
- "device_2_id": 5,
- "is_missing": 2,
- "id": 1,
- "interface_1_name": "0/1",
- "interface_1_int_type": "ethernet"
}, - {
- "interface_2_mac": "0000.0000.0010",
- "device_2_role": "device_2_role",
- "interface_2_ip_address": "10.10.10.3",
- "interface_2_name": "0/1",
- "interface_1_ip_address": "10.10.10.2",
- "device_2_name": "device_2_name",
- "missing_time": "2000-01-23T04:56:07.000Z",
- "interface_1_id": 1,
- "interface_2_id": 65,
- "device_1_ip": "device_1_ip",
- "device_1_role": "device_1_role",
- "interface_1_mac": "0000.0000.0001",
- "device_1_name": "device_1_name",
- "device_2_ip": "device_2_ip",
- "interface_2_int_type": "ethernet",
- "device_1_id": 5,
- "device_2_id": 5,
- "is_missing": 2,
- "id": 1,
- "interface_1_name": "0/1",
- "interface_1_int_type": "ethernet"
}
]
}, - {
- "items": [
- {
- "interface_2_mac": "0000.0000.0010",
- "device_2_role": "device_2_role",
- "interface_2_ip_address": "10.10.10.3",
- "interface_2_name": "0/1",
- "interface_1_ip_address": "10.10.10.2",
- "device_2_name": "device_2_name",
- "missing_time": "2000-01-23T04:56:07.000Z",
- "interface_1_id": 1,
- "interface_2_id": 65,
- "device_1_ip": "device_1_ip",
- "device_1_role": "device_1_role",
- "interface_1_mac": "0000.0000.0001",
- "device_1_name": "device_1_name",
- "device_2_ip": "device_2_ip",
- "interface_2_int_type": "ethernet",
- "device_1_id": 5,
- "device_2_id": 5,
- "is_missing": 2,
- "id": 1,
- "interface_1_name": "0/1",
- "interface_1_int_type": "ethernet"
}, - {
- "interface_2_mac": "0000.0000.0010",
- "device_2_role": "device_2_role",
- "interface_2_ip_address": "10.10.10.3",
- "interface_2_name": "0/1",
- "interface_1_ip_address": "10.10.10.2",
- "device_2_name": "device_2_name",
- "missing_time": "2000-01-23T04:56:07.000Z",
- "interface_1_id": 1,
- "interface_2_id": 65,
- "device_1_ip": "device_1_ip",
- "device_1_role": "device_1_role",
- "interface_1_mac": "0000.0000.0001",
- "device_1_name": "device_1_name",
- "device_2_ip": "device_2_ip",
- "interface_2_int_type": "ethernet",
- "device_1_id": 5,
- "device_2_id": 5,
- "is_missing": 2,
- "id": 1,
- "interface_1_name": "0/1",
- "interface_1_int_type": "ethernet"
}
]
}
], - "ip_address": "10.24.39.224"
}, - {
- "device_links": [
- {
- "items": [
- {
- "interface_2_mac": "0000.0000.0010",
- "device_2_role": "device_2_role",
- "interface_2_ip_address": "10.10.10.3",
- "interface_2_name": "0/1",
- "interface_1_ip_address": "10.10.10.2",
- "device_2_name": "device_2_name",
- "missing_time": "2000-01-23T04:56:07.000Z",
- "interface_1_id": 1,
- "interface_2_id": 65,
- "device_1_ip": "device_1_ip",
- "device_1_role": "device_1_role",
- "interface_1_mac": "0000.0000.0001",
- "device_1_name": "device_1_name",
- "device_2_ip": "device_2_ip",
- "interface_2_int_type": "ethernet",
- "device_1_id": 5,
- "device_2_id": 5,
- "is_missing": 2,
- "id": 1,
- "interface_1_name": "0/1",
- "interface_1_int_type": "ethernet"
}, - {
- "interface_2_mac": "0000.0000.0010",
- "device_2_role": "device_2_role",
- "interface_2_ip_address": "10.10.10.3",
- "interface_2_name": "0/1",
- "interface_1_ip_address": "10.10.10.2",
- "device_2_name": "device_2_name",
- "missing_time": "2000-01-23T04:56:07.000Z",
- "interface_1_id": 1,
- "interface_2_id": 65,
- "device_1_ip": "device_1_ip",
- "device_1_role": "device_1_role",
- "interface_1_mac": "0000.0000.0001",
- "device_1_name": "device_1_name",
- "device_2_ip": "device_2_ip",
- "interface_2_int_type": "ethernet",
- "device_1_id": 5,
- "device_2_id": 5,
- "is_missing": 2,
- "id": 1,
- "interface_1_name": "0/1",
- "interface_1_int_type": "ethernet"
}
]
}, - {
- "items": [
- {
- "interface_2_mac": "0000.0000.0010",
- "device_2_role": "device_2_role",
- "interface_2_ip_address": "10.10.10.3",
- "interface_2_name": "0/1",
- "interface_1_ip_address": "10.10.10.2",
- "device_2_name": "device_2_name",
- "missing_time": "2000-01-23T04:56:07.000Z",
- "interface_1_id": 1,
- "interface_2_id": 65,
- "device_1_ip": "device_1_ip",
- "device_1_role": "device_1_role",
- "interface_1_mac": "0000.0000.0001",
- "device_1_name": "device_1_name",
- "device_2_ip": "device_2_ip",
- "interface_2_int_type": "ethernet",
- "device_1_id": 5,
- "device_2_id": 5,
- "is_missing": 2,
- "id": 1,
- "interface_1_name": "0/1",
- "interface_1_int_type": "ethernet"
}, - {
- "interface_2_mac": "0000.0000.0010",
- "device_2_role": "device_2_role",
- "interface_2_ip_address": "10.10.10.3",
- "interface_2_name": "0/1",
- "interface_1_ip_address": "10.10.10.2",
- "device_2_name": "device_2_name",
- "missing_time": "2000-01-23T04:56:07.000Z",
- "interface_1_id": 1,
- "interface_2_id": 65,
- "device_1_ip": "device_1_ip",
- "device_1_role": "device_1_role",
- "interface_1_mac": "0000.0000.0001",
- "device_1_name": "device_1_name",
- "device_2_ip": "device_2_ip",
- "interface_2_int_type": "ethernet",
- "device_1_id": 5,
- "device_2_id": 5,
- "is_missing": 2,
- "id": 1,
- "interface_1_name": "0/1",
- "interface_1_int_type": "ethernet"
}
]
}
], - "ip_address": "10.24.39.224"
}
]
}
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
{- "items": [
- {
- "vlans": [
- {
- "interfaces": [
- {
- "int_type": "ethernet",
- "name": "0/1",
- "id": 1
}, - {
- "int_type": "ethernet",
- "name": "0/1",
- "id": 1
}
], - "vlan": {
- "vlan_id": 1001,
- "name": "Marketing VLAN",
- "id": 1,
- "state": "active",
- "type": "Static vlan"
}
}, - {
- "interfaces": [
- {
- "int_type": "ethernet",
- "name": "0/1",
- "id": 1
}, - {
- "int_type": "ethernet",
- "name": "0/1",
- "id": 1
}
], - "vlan": {
- "vlan_id": 1001,
- "name": "Marketing VLAN",
- "id": 1,
- "state": "active",
- "type": "Static vlan"
}
}
], - "ip_address": "ip_address"
}, - {
- "vlans": [
- {
- "interfaces": [
- {
- "int_type": "ethernet",
- "name": "0/1",
- "id": 1
}, - {
- "int_type": "ethernet",
- "name": "0/1",
- "id": 1
}
], - "vlan": {
- "vlan_id": 1001,
- "name": "Marketing VLAN",
- "id": 1,
- "state": "active",
- "type": "Static vlan"
}
}, - {
- "interfaces": [
- {
- "int_type": "ethernet",
- "name": "0/1",
- "id": 1
}, - {
- "int_type": "ethernet",
- "name": "0/1",
- "id": 1
}
], - "vlan": {
- "vlan_id": 1001,
- "name": "Marketing VLAN",
- "id": 1,
- "state": "active",
- "type": "Static vlan"
}
}
], - "ip_address": "ip_address"
}
]
}
Get Mirror Sessions for the specified switches
device_ip | string IP address of the device for which the Mirror Sessions are being fetched for |
device_id | integer Device IDs for which the Mirror Sessions are being fetched for |
OK
Mirror Session request has invalid input params.
Authorization information is missing or invalid.
Mirror Sessions with specified device IP/ID was not found.
Unexpected error.
Unexpected error
{- "items": [
- {
- "ip_address": "10.24.39.224",
- "device_session_id": 1,
- "description": "description",
- "source_if_type": "eth | po | vlan | ve",
- "source_if_name": "0/1 | po1 | 100",
- "flow_based": true,
- "mirror_direction": "rx | tx | both",
- "Destination": {
- "destination-if-type": "span | rspan-vlan | erspan",
- "span": {
- "mgmt-ip": "10.25.25.100",
- "if-type": "eth | po",
- "if-name": "0/1"
}
}
}
]
}
Get Drift Reconcile History list
device_ip | string Ip of the entry for which Drift-Reconcile history is fetched |
OK
No Drift Reconcile History found in the system
Unexpected error
Unexpected error
{- "items": [
- {
- "DR_id": "1111-1111-1111",
- "device-ip": "1.1.1.1",
- "status": "Success"
}, - {
- "DR_id": "1122-1122-1122",
- "device-ip": "1.1.2.1",
- "status": "Success"
}
]
}
Get Drift Reconcile Detail
dr_id required | string DriftReconcile Id of the entry for which detail is fetched |
OK
Status of the device was not found.
Unexpected error.
Unexpected error
{- "dr_id": "1111-1111-1111",
- "device-ip": "1.1.1.1",
- "status": "Success",
- "Reason": "Manual",
- "StartTime": "12:03:24,12/2/2020"
}
Get Config Backup History list
device_ip | string Ip of the entry for which Config-Backup history is fetched |
OK
No Drift Reconcile History found in the system
Unexpected error
Unexpected error
{- "items": [
- {
- "CB_id": "1111-1111-1111",
- "device-ip": "1.1.1.1",
- "status": "Success",
- "last_sync_time": "12:03:24,12/2/2020"
}, - {
- "CB_id": "1122-1122-1122",
- "device-ip": "1.1.2.1",
- "status": "Success",
- "last_sync_time": "12:03:24,12/2/2020"
}
]
}
Get Config Backup Detail
cb_id required | string ConfigBackup Id of the entry for which detail is fetched |
show_config | boolean Show complete configuration text |
OK
Status of the device was not found.
Unexpected error.
Unexpected error
{- "cb_id": "1111-1111-1111",
- "device-ip": "1.1.1.1",
- "status": "Success",
- "Reason": "Manual",
- "StartTime": "12:03:24,12/2/2020"
}
Get Config Replay History list
device_ip | string Ip of the entry for which Config-Replay history is fetched |
OK
No Config Replay History found in the system
Unexpected error
Unexpected error
{- "items": [
- {
- "CR_id": "1111-1111-1111",
- "device-ip": "1.1.1.1",
- "status": "Success"
}, - {
- "CR_id": "1122-1122-1122",
- "device-ip": "1.1.2.1",
- "status": "Success"
}
]
}
Get Config Replay Detail
cr_id required | string ConfigReplay Id of the entry for which detail is fetched |
OK
Status of the device was not found.
Unexpected error.
Unexpected error
{- "cr_id": "1111-1111-1111",
- "device-ip": "1.1.1.1",
- "cb_id": "2222-3333-2233",
- "status": "Success",
- "Reason": "Manual",
- "StartTime": "12:03:24,12/2/2020"
}
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
{- "items": [
- {
- "interfaces": [
- {
- "items": [
- {
- "anycast_address": [
- "anycast_address",
- "anycast_address"
], - "ip_mtu": 0,
- "name": "interfacename",
- "ip_arp_aging_timeout": 6,
- "ipv6_nd_managed_config": true,
- "ipv6_nd_other_config": true,
- "admin_status": "admin_status",
- "id": 1,
- "oper_status": "oper_status"
}, - {
- "anycast_address": [
- "anycast_address",
- "anycast_address"
], - "ip_mtu": 0,
- "name": "name",
- "ip_arp_aging_timeout": 6,
- "ipv6_nd_managed_config": true,
- "ipv6_nd_other_config": true,
- "admin_status": "admin_status",
- "id": 1,
- "oper_status": "oper_status"
}
]
}, - {
- "items": [
- {
- "anycast_address": [
- "anycast_address",
- "anycast_address"
], - "ip_mtu": 0,
- "name": "name",
- "ip_arp_aging_timeout": 6,
- "admin_status": "admin_status",
- "id": 1,
- "oper_status": "oper_status"
}, - {
- "anycast_address": [
- "anycast_address",
- "anycast_address"
], - "ip_mtu": 0,
- "name": "name",
- "ip_arp_aging_timeout": 6,
- "ipv6_nd_managed_config": true,
- "ipv6_nd_other_config": true,
- "admin_status": "admin_status",
- "id": 1,
- "oper_status": "oper_status"
}
]
}
], - "ip_address": "10.24.39.224"
}, - {
- "interfaces": [
- {
- "items": [
- {
- "anycast_address": [
- "anycast_address",
- "anycast_address"
], - "ip_mtu": 0,
- "name": "name",
- "ip_arp_aging_timeout": 6,
- "ipv6_nd_managed_config": true,
- "ipv6_nd_other_config": true,
- "admin_status": "admin_status",
- "id": 1,
- "oper_status": "oper_status"
}, - {
- "anycast_address": [
- "anycast_address",
- "anycast_address"
], - "ip_mtu": 0,
- "name": "name",
- "ip_arp_aging_timeout": 6,
- "ipv6_nd_managed_config": true,
- "ipv6_nd_other_config": true,
- "admin_status": "admin_status",
- "id": 1,
- "oper_status": "oper_status"
}
]
}, - {
- "items": [
- {
- "anycast_address": [
- "anycast_address",
- "anycast_address"
], - "ip_mtu": 0,
- "name": "name",
- "ip_arp_aging_timeout": 6,
- "ipv6_nd_managed_config": true,
- "ipv6_nd_other_config": true,
- "admin_status": "admin_status",
- "id": 1,
- "oper_status": "oper_status"
}, - {
- "anycast_address": [
- "anycast_address",
- "anycast_address"
], - "ip_mtu": 0,
- "name": "name",
- "ip_arp_aging_timeout": 6,
- "ipv6_nd_managed_config": true,
- "ipv6_nd_other_config": true,
- "admin_status": "admin_status",
- "id": 1,
- "oper_status": "oper_status"
}
]
}
], - "ip_address": "10.24.39.224"
}
]
}
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
{- "af_ip": [
- {
- "maxpath_i_bgp": 1,
- "safi": "unicast",
- "af_ip_ngbr": [
- {
- "neighbor_afi": "neighbor_afi",
- "e_bgp_mhop": 0,
- "next_hop_self": true,
- "peer_group_name": "pod1_name",
- "is_activated": true,
- "neighbor_safi": "neighbor_safi",
- "remote_as": 65000,
- "password": "xxxxxx",
- "up_time": "up_time",
- "neighbor_address": "10.10.10.1",
- "id": 1,
- "enable_peer_as_check": true,
- "bfd_enable": true,
- "status": "ESTAB"
}, - {
- "neighbor_afi": "neighbor_afi",
- "e_bgp_mhop": 0,
- "next_hop_self": true,
- "peer_group_name": "pod1_name",
- "is_activated": true,
- "neighbor_safi": "neighbor_safi",
- "remote_as": 65000,
- "password": "xxxxxx",
- "up_time": "up_time",
- "neighbor_address": "10.10.10.1",
- "id": 1,
- "enable_peer_as_check": true,
- "bfd_enable": true,
- "status": "ESTAB"
}
], - "afi": "ipv4",
- "maxpath": 1,
- "id": 1,
- "vrf": "customer",
- "graceful_restart": true,
- "af_network": [
- {
- "af_id": 1,
- "route_map": "rm_policy",
- "backdoor": true,
- "network_address": "10.1.1.1/32",
- "weight": 200,
- "id": 1
}, - {
- "af_id": 1,
- "route_map": "rm_policy",
- "backdoor": true,
- "network_address": "10.1.1.1/32",
- "weight": 200,
- "id": 1
}
], - "maxpath_e_bgp": 1,
- "af_redistribute": [
- {
- "af_id": 1,
- "redistribute": "connected",
- "metric": 1000,
- "route_map": "rm_policy",
- "id": 1
}, - {
- "af_id": 1,
- "redistribute": "connected",
- "metric": 1000,
- "route_map": "rm_policy",
- "id": 1
}
]
}, - {
- "maxpath_i_bgp": 1,
- "safi": "unicast",
- "af_ip_ngbr": [
- {
- "neighbor_afi": "neighbor_afi",
- "e_bgp_mhop": 0,
- "next_hop_self": true,
- "peer_group_name": "pod1_name",
- "is_activated": true,
- "neighbor_safi": "neighbor_safi",
- "remote_as": 65000,
- "password": "xxxxxx",
- "up_time": "up_time",
- "neighbor_address": "10.10.10.1",
- "id": 1,
- "enable_peer_as_check": true,
- "bfd_enable": true,
- "status": "ESTAB"
}, - {
- "neighbor_afi": "neighbor_afi",
- "e_bgp_mhop": 0,
- "next_hop_self": true,
- "peer_group_name": "pod1_name",
- "is_activated": true,
- "neighbor_safi": "neighbor_safi",
- "remote_as": 65000,
- "password": "xxxxxx",
- "up_time": "up_time",
- "neighbor_address": "10.10.10.1",
- "id": 1,
- "enable_peer_as_check": true,
- "bfd_enable": true,
- "status": "ESTAB"
}
], - "afi": "ipv4",
- "maxpath": 1,
- "id": 1,
- "vrf": "customer",
- "graceful_restart": true,
- "af_network": [
- {
- "af_id": 1,
- "route_map": "rm_policy",
- "backdoor": true,
- "network_address": "10.1.1.1/32",
- "weight": 200,
- "id": 1
}, - {
- "af_id": 1,
- "route_map": "rm_policy",
- "backdoor": true,
- "network_address": "10.1.1.1/32",
- "weight": 200,
- "id": 1
}
], - "maxpath_e_bgp": 1,
- "af_redistribute": [
- {
- "af_id": 1,
- "redistribute": "connected",
- "metric": 1000,
- "route_map": "rm_policy",
- "id": 1
}, - {
- "af_id": 1,
- "redistribute": "connected",
- "metric": 1000,
- "route_map": "rm_policy",
- "id": 1
}
]
}
], - "peer_group": [
- {
- "password": "xxxxxx",
- "remote_asn": 65000,
- "name": "pod1_group",
- "description": "pod1",
- "gracefull_shut_timer": null,
- "id": 1,
- "bfd_enable": true
}, - {
- "password": "xxxxxx",
- "remote_asn": 65000,
- "name": "pod1_group",
- "description": "pod1",
- "gracefull_shut_timer": null,
- "id": 1,
- "bfd_enable": true
}
], - "router_bgp": {
- "capability_as4_enable": true,
- "bfd_rx": 300,
- "bfd_tx": 300,
- "bfd_multiplier": 5,
- "router_id": "10.10.10.1",
- "id": 1,
- "local_as": 100,
- "fast_ext_fallover": true
}, - "af_evpn": {
- "retain_rt_all": true,
- "af_evpn_ngbr": [
- {
- "encapsulation": "vxlan",
- "neighbor_afi": "neighbor_afi",
- "e_bgp_mhop": 6,
- "allow_as_in": 1,
- "peer_group_name": "pod1_name",
- "is_activated": true,
- "nexthop_unchanged": true,
- "neighbor_safi": "neighbor_safi",
- "remote_as": 65000,
- "up_time": "up_time",
- "neighbor_address": "10.10.10.1",
- "id": 1,
- "bfd_enable": true,
- "status": "ESTAB"
}, - {
- "encapsulation": "vxlan",
- "neighbor_afi": "neighbor_afi",
- "e_bgp_mhop": 6,
- "allow_as_in": 1,
- "peer_group_name": "pod1_name",
- "is_activated": true,
- "nexthop_unchanged": true,
- "neighbor_safi": "neighbor_safi",
- "remote_as": 65000,
- "up_time": "up_time",
- "neighbor_address": "10.10.10.1",
- "id": 1,
- "bfd_enable": true,
- "status": "ESTAB"
}
], - "id": 1,
- "graceful_restart": true
}
}
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
{- "items": [
- {
- "node_is_local": true,
- "principal_switch_mac": "10101:1111:1111",
- "node_status": "node_status",
- "node_internal_ip": "node_internal_ip",
- "node_mac": "node_mac",
- "firmware_version": "17s.1.02b",
- "serial_num": "serial_num",
- "node_switch_type": "SLX-9240",
- "node_public_ip": "node_public_ip",
- "id": 1,
- "node_condition": "node_condition",
- "node_is_principal": true,
- "node_id": 1
}, - {
- "node_is_local": true,
- "principal_switch_mac": "10101:1111:1111",
- "node_status": "node_status",
- "node_internal_ip": "node_internal_ip",
- "node_mac": "node_mac",
- "firmware_version": "17s.1.02b",
- "serial_num": "serial_num",
- "node_switch_type": "SLX-9240",
- "node_public_ip": "node_public_ip",
- "id": 1,
- "node_condition": "node_condition",
- "node_is_principal": true,
- "node_id": 1
}
]
}
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
[- {
- "peer_keepalive_dip": "10.1.1.1",
- "client_interface_shutdown_type": "all-clients",
- "cluster_control_ve": 4096,
- "mct_cluster_status": true,
- "source_ip": "20.20.20.1",
- "deploy": true,
- "peer_state": true,
- "cluster_id": 1,
- "member_bd_all": true,
- "source_if_name": "1",
- "vlans_added": [
- 1,
- 1
], - "df_load_balance": true,
- "bridge_domains_removed": [
- 6,
- 6
], - "id": 1,
- "client_interfaces_shutdown": true,
- "client_isolation_role": "primary",
- "peer_if_type": "Port-Channel",
- "peer_keepalive_interval": 5,
- "source_if_type": "loopback",
- "bridge_domains_added": [
- 0,
- 0
], - "cluster_control_vlan": 4096,
- "peer_keepalive_state": false,
- "peer_keepalive_if_name": "0/1",
- "client_isolation_strict": true,
- "peer_if_name": "6",
- "peer_keepalive_if_type": "ethernet",
- "member_vlan_all": true,
- "peer_ip": "20.20.20.2",
- "name": "mlag",
- "mct_client_pw": false,
- "vlans_removed": [
- 5,
- 5
]
}
]
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
[- {
- "interface_state": "Up",
- "cluster_id": 1,
- "name": "mlag",
- "interface_name": "3",
- "esi": "01:02:03",
- "id": 1,
- "interface_type": "Port-channel",
- "client_id": 1,
- "deploy": true
}
]
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
{- "items": [
- {
- "lif": {
- "vlan_id": 1,
- "vlan_tag": "tagged",
- "lif_name": "0/1.1",
- "id": 1
}, - "bridgedomain": {
- "name": "default",
- "description": "description",
- "id": 1,
- "state": "state",
- "router_interface": 101,
- "type": "p2p"
}, - "interface": {
- "int_type": "ethernet",
- "name": "0/1",
- "id": 1
}
}, - {
- "lif": {
- "vlan_id": 1,
- "vlan_tag": "tagged",
- "lif_name": "0/1.1",
- "id": 1
}, - "bridgedomain": {
- "name": "default",
- "description": "description",
- "id": 1,
- "state": "state",
- "router_interface": 101,
- "type": "p2p"
}, - "interface": {
- "int_type": "ethernet",
- "name": "0/1",
- "id": 1
}
}
]
}
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
{- "evpn": {
- "rd": "auto",
- "duplicate_mac_timer": 5,
- "name": "default",
- "duplicate_mac_timer_max_count": 5,
- "df_delay_timer": 5,
- "id": 1
}, - "vlans": [
- 6,
- 6
], - "route_target": [
- {
- "rt_value": "100:100",
- "ignore_as": true,
- "id": 1,
- "rt_type": "both"
}, - {
- "rt_value": "100:100",
- "ignore_as": true,
- "id": 1,
- "rt_type": "both"
}
], - "id": 1,
- "bridge_domains": [
- 0,
- 0
]
}
Get the Pseudowire Profile details with the specific parameters for the specified switch
device_ip | string IP address of the device for which the Pseudowire Profile details are being fetched for |
device_id | integer IP address of the device for which the Pseudowire Profile details are being fetched for |
pseudowire_profiles | Array of strings non-empty Pseudowire Profiles 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
[- {
- "name": "Tenant-profile",
- "id": 1,
- "vc-mode": "raw"
}
]
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
[- {
- "bd": {
- "name": "default",
- "description": "description",
- "id": 1,
- "state": "state",
- "router_interface": 101,
- "type": "p2p"
}, - "lifs": [
- {
- "vlan_id": 1,
- "vlan_tag": "tagged",
- "lif_name": "0/1.1",
- "id": 1,
- "interface": {
- "int_type": "ethernet",
- "name": "0/1",
- "id": 1
}
}, - {
- "vlan_id": 1,
- "vlan_tag": "tagged",
- "lif_name": "0/1.1",
- "id": 1,
- "interface": {
- "int_type": "ethernet",
- "name": "0/1",
- "id": 1
}
}
]
}
]
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
[- {
- "overlay_gateways": [
- {
- "overlaygateway": {
- "is_activated": true,
- "name": "default",
- "ip_ve_vrrp_group": 2,
- "id": 1,
- "vni_auto_map": false,
- "ip_interface_name": "300",
- "type": "layer2-extension",
- "ip_interface_type": "ve",
- "optimized_replication": true,
- "underlay_mdt_default_group": "239.1.1.1"
}, - "vlanvnimapping": [
- {
- "vni": 101,
- "vlan": 101,
- "id": 1
}, - {
- "vni": 101,
- "vlan": 101,
- "id": 1
}
], - "bdvnimapping": [
- {
- "vni": 101,
- "bridgedomain": 101,
- "id": 1
}, - {
- "vni": 101,
- "bridgedomain": 101,
- "id": 1
}
]
}, - {
- "overlaygateway": {
- "is_activated": true,
- "name": "default",
- "ip_ve_vrrp_group": 2,
- "id": 1,
- "vni_auto_map": false,
- "ip_interface_name": "300",
- "type": "layer2-extension",
- "ip_interface_type": "ve"
}, - "vlanvnimapping": [
- {
- "vni": 101,
- "vlan": 101,
- "id": 1
}, - {
- "vni": 101,
- "vlan": 101,
- "id": 1
}
], - "bdvnimapping": [
- {
- "vni": 101,
- "bridgedomain": 101,
- "id": 1
}, - {
- "vni": 101,
- "bridgedomain": 101,
- "id": 1
}
]
}
], - "ip_address": "ip_address"
}
]
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
{- "tunnels": [
- {
- "bgp_neighbor_mapping": {
- "id": 1,
- "bgp_neighbor": {
- "encapsulation": "vxlan",
- "neighbor_afi": "neighbor_afi",
- "e_bgp_mhop": 6,
- "allow_as_in": 1,
- "peer_group_name": "pod1_name",
- "is_activated": true,
- "nexthop_unchanged": true,
- "neighbor_safi": "neighbor_safi",
- "remote_as": 65000,
- "up_time": "up_time",
- "neighbor_address": "10.10.10.1",
- "id": 1,
- "bfd_enable": true,
- "status": "ESTAB"
}
}, - "l3_interface_mapping": {
- "l3_interface": {
- "int_type": "ethernet",
- "name": "0/1",
- "id": 1
}, - "id": 1
}, - "tunnel": {
- "mode": "mode",
- "tunnel_type": "unicast",
- "mac_learning_enabled": true,
- "dest_ip": "dest_ip",
- "tunnel_number": 1010,
- "admin_state": "Up",
- "id": 1,
- "vrf": "vrf",
- "oper_state": "Up",
- "source_ip": "source_ip"
}, - "l2_interface_mapping": {
- "l2_interface": [
- {
- "int_type": "ethernet",
- "name": "0/1",
- "id": 1
}, - {
- "int_type": "ethernet",
- "name": "0/1",
- "id": 1
}
], - "id": 1
}
}, - {
- "bgp_neighbor_mapping": {
- "id": 1,
- "bgp_neighbor": {
- "encapsulation": "vxlan",
- "neighbor_afi": "neighbor_afi",
- "e_bgp_mhop": 6,
- "allow_as_in": 1,
- "peer_group_name": "pod1_name",
- "is_activated": true,
- "nexthop_unchanged": true,
- "neighbor_safi": "neighbor_safi",
- "remote_as": 65000,
- "up_time": "up_time",
- "neighbor_address": "10.10.10.1",
- "id": 1,
- "bfd_enable": true,
- "status": "ESTAB"
}
}, - "l3_interface_mapping": {
- "l3_interface": {
- "int_type": "ethernet",
- "name": "0/1",
- "id": 1
}, - "id": 1
}, - "tunnel": {
- "mode": "mode",
- "tunnel_type": "unicast",
- "mac_learning_enabled": true,
- "dest_ip": "dest_ip",
- "tunnel_number": 1010,
- "admin_state": "Up",
- "id": 1,
- "vrf": "vrf",
- "oper_state": "Up",
- "source_ip": "source_ip"
}, - "l2_interface_mapping": {
- "l2_interface": [
- {
- "int_type": "ethernet",
- "name": "0/1",
- "id": 1
}, - {
- "int_type": "ethernet",
- "name": "0/1",
- "id": 1
}
], - "id": 1
}
}
], - "ip_address": "ip_address"
}
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
[- {
- "interfaces": [
- {
- "id": 1,
- "interface": {
- "int_type": "ethernet",
- "name": "0/1",
- "id": 1
}
}, - {
- "id": 1,
- "interface": {
- "int_type": "ethernet",
- "name": "0/1",
- "id": 1
}
}
], - "route_target": {
- "ipv4_afi": [
- {
- "evpn": true,
- "rt_value": "101:101",
- "id": 1,
- "rt_type": "both"
}, - {
- "evpn": true,
- "rt_value": "101:101",
- "id": 1,
- "rt_type": "both"
}
], - "ipv6_afi": [
- {
- "evpn": true,
- "rt_value": "101:101",
- "id": 1,
- "rt_type": "both"
}, - {
- "evpn": true,
- "rt_value": "101:101",
- "id": 1,
- "rt_type": "both"
}
]
}, - "static_route": [
- {
- "id": 1,
- "afi": "IPv4",
- "network": "20.0.0.0/24",
- "nexthop_ip": "16.0.0.2"
}, - {
- "id": 2,
- "afi": "IPv6",
- "network": "2001::/64",
- "nexthop_ip": "1001::2"
}
], - "vrf": {
- "evpn": "irb ve 100",
- "rd": "10.1.1.1:101",
- "router_ip": "10.2.2.2",
- "name": "vrf_red",
- "id": 1,
- "afi_type": "both"
}
}
]
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
[- {
- "vrrp_groups": [
- {
- "preempt_mode": true,
- "virtual_mac": "virtual_mac",
- "group_id": 101,
- "id": 1,
- "extended": false,
- "enabled": true,
- "virtual_ip": "2.2.2.2"
}, - {
- "preempt_mode": true,
- "virtual_mac": "virtual_mac",
- "group_id": 101,
- "id": 1,
- "extended": false,
- "enabled": true,
- "virtual_ip": "2.2.2.2"
}
], - "int_type": "ethernet",
- "name": "0/1"
}
]
Get only the Router Pim with the specific parameters for the specified switch
device_ip | string IP address of the device for which the Router PIM are being fetched for |
device_id | integer Device ID for which the Router PIM are being fetched for |
OK
Authorization information is missing or invalid.
A device with the specified IP was not found.
Unexpected error.
Unexpected error
{- "pim": [
- {
- "vrf": "RED",
- "enable_ssm": false,
- "range": "mdt-range"
}, - {
- "vrf": "BLUE",
- "enable_ssm": true
}
]
}
Get only the IP Prefix List with the specific parameters for the specified switch
device_ip | string IP address of the device for which the IP Prefix List is being fetched for |
device_id | integer Device ID for which the IP Prefix List is being fetched for |
prefixlist_name | string IP Prefix List name that is being fetched. This will be in conjunction with device_ip or device_id |
OK
Authorization information is missing or invalid.
A device with the specified IP was not found.
Unexpected error.
Unexpected error
{- "ipprefix-list": [
- {
- "name": "mdt-range",
- "seq": 5,
- "action": "permit",
- "afi": "ipv4",
- "ip_prefix": "239.0.0.0/8"
}, - {
- "name": "mdt-range-2",
- "seq": 10,
- "action": "permit",
- "afi": "ipv4",
- "ip_prefix": "0.0.0.0/0",
- "greater_than_ip_prefix_length": 31,
- "less_than_ip_prefix_length": 31
}
]
}
Get only the Route map with the specific parameters for the specified switch
device_ip | string IP address of the device for which the Route Map is being fetched for |
device_id | integer Device ID for which the Route Map is being fetched for |
routemap_name | string Route Map name that is being fetched. This will be in conjunction with device_ip or device_id |
OK
Authorization information is missing or invalid.
A device with the specified IP was not found.
Unexpected error.
Unexpected error
{- "items": [
- {
- "key-info": {
- "name": "routemap_1",
- "seq": 10,
- "action": "permit"
}, - "matches": {
- "match-ip-prefix-list": {
- "prefix-list-name": "prefixlist_v4"
}
}
}, - {
- "key-info": {
- "name": "routemap_2",
- "seq": 20,
- "action": "deny"
}, - "matches": {
- "match-ip-prefix-list": {
- "prefix-list-name": "prefixlist_v4"
}
}
}
]
}
Get the detailed output of the given execution ID
id required | string Detailed output of the given execution ID |
OK
Authorization information is missing or invalid.
Unexpected error.
Unexpected error
{- "start_time": "2000-01-23T04:56:07.000Z",
- "end_time": "2000-01-23T04:56:07.000Z",
- "id": "id",
- "logs": "logs",
- "URL": "/v1/inventory/switches",
- "status": "Failed, Succeeded"
}
Get the list of all the previous executions
limit required | integer Default: 10 Limit the number of executions that will be sent in the response. Default is 10 |
status | string Default: "all" Filter the executions based on the status(failed/succeeded/all) |
OK
Authorization information is missing or invalid.
Unexpected error.
Unexpected error
{- "items": [
- {
- "start_time": "2000-01-23T04:56:07.000Z",
- "end_time": "2000-01-23T04:56:07.000Z",
- "id": "id",
- "URL": "/v1/inventory/switches",
- "status": "Completed"
}, - {
- "start_time": "2000-01-22T04:56:07.000Z",
- "end_time": "2000-01-22T04:56:07.000Z",
- "id": "id",
- "URL": "/v1/inventory/switches",
- "status": "Failed"
}
]
}
Get the list of all CLIs in Running Config
OK
Authorization information is missing or invalid.
Unexpected error.
Unexpected error
{- "items": [
- "string"
]
}
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
{- "ref": "core.local"
}
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
{- "name": "name",
- "secret": true,
- "value": "value"
}
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": "name",
- "secret": true,
- "value": "value"
}
{- "name": "name",
- "secret": true,
- "value": "value"
}
Delete a Key.
name required | string Key Name. |
Key deleted.
Unexpected error
{- "message": "Device is already registered in inventory",
- "code": 101
}
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
{- "items": [
- {
- "protocol": "scp",
- "id": 1,
- "ip_address": "10.24.39.224",
- "status": {
- "result": "Failed",
- "reason": "Device or host registration failed"
}
}, - {
- "protocol": "scp",
- "id": 1,
- "ip_address": "10.24.39.224",
- "status": {
- "result": "Failed",
- "reason": "Device or host registration failed"
}
}
]
}
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
{- "protocol": "scp",
- "id": 1,
- "ip_address": "10.24.39.224",
- "status": {
- "result": "Failed",
- "reason": "Device or host registration failed"
}
}
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
{- "protocol": "ftp",
- "password": "password",
- "ip_address": "ip_address",
- "username": "username"
}
{- "protocol": "scp",
- "id": 1,
- "ip_address": "10.24.39.224",
- "status": {
- "result": "Failed",
- "reason": "Device or host registration failed"
}
}
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
{- "protocol": "scp",
- "id": 1,
- "ip_address": "10.24.39.224",
- "status": {
- "result": "Failed",
- "reason": "Device or host registration failed"
}
}
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
{- "protocol": "ftp",
- "password": "password",
- "ip_address": "ip_address",
- "username": "username"
}
{- "protocol": "scp",
- "id": 1,
- "ip_address": "10.24.39.224",
- "status": {
- "result": "Failed",
- "reason": "Device or host registration failed"
}
}
Get device discovery interval time for specific switch or switches in fabric
fabric_name | string Only devices which are associated to the fabric name specified as returned. |
device_ips | string Device IP's of switches to be fetched |
OK
Authorization information is missing or invalid.
A device with the specified IP was not found.
Unexpected error.
Unexpected error
{- "items": [
- {
- "role": "Spine",
- "chassis_name": "BR-SLX-9140",
- "ip_address": "10.24.39.224",
- "fabric": {
- "fabric_name": "default",
- "fabric_id": 1
}, - "discovery_status": "Completed",
- "name": "sw0",
- "model": "3000",
- "id": 1,
- "firmware": "17.01.02",
- "last_discovery_time": "2020-03-17T18:49:32.381Z",
- "discovery_reason": "User driven",
- "discovery_interval": "1 Hr 30 min"
}
]
}
Change device discovery interval time for specific switch or switches in fabric
Change Port speed of interfaces of the Switch.
ip_address | string IP address of the device |
fabric_name | string Name of the fabric |
min | integer Device discovery time in minutes |
hour | integer Device discovery time in minutes |
OK
Authorization information is missing or invalid.
A device with the specified IP was not found.
Unexpected error.
Unexpected error
{- "ip_address": "10.25.225.165",
- "fabric_name": "default",
- "min": 30,
- "hour": 2
}
{- "items": [
- {
- "role": "Spine",
- "chassis_name": "BR-SLX-9140",
- "ip_address": "10.24.39.224",
- "fabric": {
- "fabric_name": "default",
- "fabric_id": 1
}, - "discovery_status": "Completed",
- "name": "sw0",
- "model": "3000",
- "id": 1,
- "firmware": "17.01.02",
- "last_discovery_time": "2020-03-17T18:49:32.381Z",
- "discovery_reason": "User driven",
- "discovery_interval": "1 Hr 30 min"
}
]
}
Get devices lock statuses
OK
Authorization information is missing or invalid.
A device with the specified IP was not found.
Unexpected error.
Unexpected error
{- "items": [
- {
- "device_ip": "Spine",
- "locked": true
}
]
}
Force Unlock Current Locks.
device_ips | Array of strings non-empty IP Addresses of the device(s) to be forcefully remove locks. |
fabric_name | string Forcefully Update Fwdl status of devices which are associated to the fabric name. |
service_lock | boolean Default: false Value true implies service lock need to be removed |
OK
No switches found for the specified fabric.
Specified Fabric not found.
Unexpected error.
Unexpected error
[- {
- "is_virtual_device": true,
- "role": "Spine",
- "fabric": {
- "fabric_name": "default",
- "fabric_id": 1
}, - "name": "sw0",
- "model": "3000",
- "chassis_name": "BR-SLX-9140",
- "ip_address": "10.24.39.224",
- "id": 1,
- "state": "New",
- "firmware": "17.01.02",
- "asn": 65000,
- "status": {
- "result": "Failed",
- "reason": "Device is not registered"
}
}
]
Get the service Lock status from Inventory service.
OK
Approval From one of service is failed
{- "ServiceName": "string",
- "Status": "string",
- "Error": "string"
}
This API helps user to generate the config-drift between efa intended and device configuration. If reconcile flag is set then drifted configuration will be reconciled on the device.
ip_address required | string IP Addresses of the device for which config drift will be generated. |
reconcile required | boolean Default: false Value true implies efa drift with devices will be reconciled |
OK
Authorization information is missing or invalid.
A device with the specified IP was not found.
A drift and reconcile operation is already in progress for the device.
Unexpected error.
Unexpected error
{- "mgmt-ip": "10.10.10.10",
- "reconciliation-status": [
- {
- "config-type": "InterfaceConfig",
- "status": "Success",
- "error-list": [
- {
- "message": "Device is already registered in inventory",
- "code": 101
}
]
}
], - "config-drift": {
- "InterfaceConfig": [
- {
- "int_type": "ethernet",
- "name": "0/1",
- "app_state": "cfg-refreshed",
- "app_state_detail": [
- {
- "property_name": "Breakout Mode",
- "property_app_state": "cfg-refreshed"
}
]
}
], - "BreakoutInterface": [
- {
- "int_type": "ethernet",
- "name": "0/52:1",
- "app_state": "cfg-refreshed",
- "app_state_detail": [
- {
- "property_name": "Breakout Mode",
- "property_app_state": "cfg-refreshed"
}
]
}
], - "Timezone": [
- {
- "app_state": "cfg-refreshed"
}
], - "NtpDisable": { },
- "NtpServer": [
- {
- "server_ip": "192.168.10.21",
- "app_state": "cfg-refreshed",
- "app_state_detail": [
- {
- "property_name": "Breakout Mode",
- "property_app_state": "cfg-refreshed"
}
]
}
], - "NtpAuthKey": [
- {
- "server_ip": 7777,
- "app_state": "cfg-refreshed",
- "app_state_detail": [
- {
- "property_name": "Breakout Mode",
- "property_app_state": "cfg-refreshed"
}
]
}
], - "SnmpView": [
- {
- "name": "efav3View",
- "app_state": "cfg-refreshed",
- "app_state_detail": [
- {
- "property_name": "Breakout Mode",
- "property_app_state": "cfg-refreshed"
}
]
}
], - "SnmpGroup": [
- {
- "name": "efav3Group",
- "version": "v3",
- "app_state": "cfg-refreshed",
- "app_state_detail": [
- {
- "property_name": "Breakout Mode",
- "property_app_state": "cfg-refreshed"
}
]
}
], - "SnmpCommunity": [
- {
- "encrypted_name": "$9$bbdCaABI6wqpwQbkx3dMKg==",
- "app_state": "cfg-refreshed",
- "app_state_detail": [
- {
- "property_name": "Breakout Mode",
- "property_app_state": "cfg-refreshed"
}
]
}
], - "SnmpUser": [
- {
- "name": "efav3User",
- "app_state": "cfg-refreshed",
- "app_state_detail": [
- {
- "property_name": "Breakout Mode",
- "property_app_state": "cfg-refreshed"
}
]
}
], - "SnmpHost": [
- {
- "host_ip": "10.10.10.10",
- "version": "v3",
- "community_or_user": "efav3User",
- "app_state": "cfg-refreshed",
- "app_state_detail": [
- {
- "property_name": "Breakout Mode",
- "property_app_state": "cfg-refreshed"
}
]
}
], - "MMEnableOnReboot": { },
- "DeviceSetting": { }
}
}
Get FWDL In progress devices
OK
Authorization information is missing or invalid.
A device with the specified IP was not found.
Unexpected error.
Unexpected error
[- {
- "is_virtual_device": true,
- "role": "Spine",
- "fabric": {
- "fabric_name": "default",
- "fabric_id": 1
}, - "name": "sw0",
- "model": "3000",
- "chassis_name": "BR-SLX-9140",
- "ip_address": "10.24.39.224",
- "id": 1,
- "state": "New",
- "firmware": "17.01.02",
- "asn": 65000,
- "status": {
- "result": "Failed",
- "reason": "Device is not registered"
}
}
]
Force Removal from Fwdl status.
device_ips | Array of strings non-empty IP Addresses of the device(s) to be forcefully updated the fwdl status. |
fabric_name | string Forcefully Update Fwdl status of devices which are associated to the fabric name. |
OK
No switches found for the specified fabric.
Specified Fabric not found.
Unexpected error.
Unexpected error
[- {
- "is_virtual_device": true,
- "role": "Spine",
- "fabric": {
- "fabric_name": "default",
- "fabric_id": 1
}, - "name": "sw0",
- "model": "3000",
- "chassis_name": "BR-SLX-9140",
- "ip_address": "10.24.39.224",
- "id": 1,
- "state": "New",
- "firmware": "17.01.02",
- "asn": 65000,
- "status": {
- "result": "Failed",
- "reason": "Device is not registered"
}
}
]
Install certificates
Install certificates on switches
device_ips | Array of strings |
certificateType | string Enum: "https" "token" Type of certificate to be installed, either https or token |
OK
Authorization information is missing or invalid.
Unexpected error.
Unexpected error
{- "device_ips": [
- "device_ip",
- "device_ip"
], - "certificateType": "https"
}
[- {
- "device_ip": "10.x.x.x",
- "status": "Success"
}
]
Get Device State Change History list
device_ip | string Ip of the device for which DSC history is fetched |
OK
No DSC History found in the system
Unexpected error
Unexpected error
{- "items": [
- {
- "dsc_id": "1111-1111-1111",
- "device_ip": "1.1.1.1",
- "status": "Success"
}, - {
- "dsc_id": "1122-1122-1122",
- "device_ip": "1.1.2.1",
- "status": "Success"
}
]
}
Get Device Current State
device_ip | string Ip of the entry for which Device State is fetched |
OK
State of the device was not found.
Unexpected error.
Unexpected error
{- "device-ip": "1.1.1.1",
- "admin_state_action": "up",
- "oper_state": "up",
- "switch_health_status": "enable"
}
Get DSC Detail
dsc_id required | string DSC Id of the entry for which detail is fetched |
OK
Status of the device was not found.
Unexpected error.
Unexpected error
{- "dr_id": "1111-1111-1111",
- "device-ip": "1.1.1.1",
- "admin_state_action": "up",
- "status": "Success",
- "Fabric_status": "Success",
- "Tenant_status": "Success",
- "Policy_status": "Success",
- "maintenance_mode_enable_status": "Success",
- "StartTime": "12:03:24,12/2/2020"
}
Trigger device state update as up or down.
ip_address required | string IP Address of the device to be retrieved. |
state required | string State of the device to changed. |
Accepted device state update as up or down request
Invalid IP address.
Unexpected error.
Unexpected error
{- "href": "href",
- "uuid": "id"
}
delet DSC ID.
key | string IP Addresses of the device or DSC uuid to deleted. |
device state change delete request
Invalid IP address.
Unexpected error.
Unexpected error
{- "result": 0,
- "userKey": "1111-1111-1111",
- "error": "uuid not found"
}
Get NTP servers for a list of devices
device_ips | Array of strings non-empty IP addresses of the devices |
fabric_name | string Fabric name. Get the NTP servers for all the devices in the given fabric. |
OK
Authorization information is missing or invalid.
IP address of device specified is not registered.
Specified Fabric not found.
Unexpected error
Unexpected error
{- "items": [
- {
- "fabric_name": "default",
- "device_ip": "2.2.2.2",
- "items": [
- {
- "server_ip": "20.20.20.20",
- "key_id": 2,
- "encryption_type": "sha1",
- "encryption_key": "sha1key1",
- "encryption_level": 7,
- "is_trusted_key": true
}, - {
- "server_ip": "30.30.30.30",
- "key_id": 3,
- "encryption_type": "md5",
- "encryption_key": "md5key1",
- "encryption_level": 0,
- "is_trusted_key": false
}
]
}, - {
- "fabric_name": "default",
- "device_ip": "3.3.3.3",
- "items": [
- {
- "server_ip": "20.20.20.20",
- "key_id": 2,
- "encryption_type": "sha1",
- "encryption_key": "sha1key1",
- "encryption_level": 7,
- "is_trusted_key": true
}, - {
- "server_ip": "30.30.30.30",
- "key_id": 3,
- "encryption_type": "md5",
- "encryption_key": "md5key1",
- "encryption_level": 0,
- "is_trusted_key": false
}
]
}
]
}
Create NTP server
Create a NTP server
device_ips | Array of strings IP address of devices |
fabric_name | string Name of the fabric |
server | object (Server information) |
OK
Authorization information is missing or invalid.
IP address of device specified is not registered.
Specified Fabric not found.
Unexpected error.
Unexpected error
{- "fabric_name": "default",
- "device_ips": [
- "2.2.2.2",
- "3.3.3.3"
], - "server": {
- "server_ip": "20.20.20.20",
- "key_id": 2,
- "encryption_type": "sha1",
- "encryption_key": "sha1key1",
- "encryption_level": 7,
- "is_trusted_key": true
}
}
[- {
- "server": [
- {
- "server_ip": "20.20.20.20",
- "key_id": 2,
- "encryption_type": "sha1",
- "encryption_key": "sha1key1",
- "encryption_level": 7,
- "is_trusted_key": true,
- "app_state": "cfg-in-sync"
}
], - "ip_address": "2.2.2.2",
- "fabric_name": "default",
- "status": {
- "result": "Failed",
- "reason": "Device is not registered"
}
}
]
Delete NTP Server
server_ip required | string IP address of the NTP server |
device_ips | Array of strings non-empty IP addresses of the devices where NTP server needs to be deleted |
fabric_name | string Fabric name. Delete the NTP server for prepared devices in the given fabric. |
OK
Authorization information is missing or invalid.
IP address of device specified is not registered.
Specified Fabric not found.
Unexpected error.
Unexpected error
[- {
- "server": [
- {
- "server_ip": "20.20.20.20",
- "key_id": 2,
- "encryption_type": "sha1",
- "encryption_key": "sha1key1",
- "encryption_level": 7,
- "is_trusted_key": true,
- "app_state": "cfg-in-sync"
}
], - "ip_address": "2.2.2.2",
- "fabric_name": "default",
- "status": {
- "result": "Failed",
- "reason": "Device is not registered"
}
}
]
Get NTP disable for a list of devices
device_ips | Array of strings non-empty IP addresses of the devices |
fabric_name | string Fabric name. Get the NTP disable for all the devices in the given fabric. |
OK
Authorization information is missing or invalid.
IP address of device specified is not registered.
Specified Fabric not found.
Unexpected error
Unexpected error
{- "items": [
- {
- "fabric_name": "default",
- "device_ip": "2.2.2.2",
- "items": {
- "server": true,
- "app_state": "cfg-in-sync"
}
}, - {
- "fabric_name": "default",
- "device_ip": "3.3.3.3",
- "items": {
- "server": false,
- "app_state": "cfg-in-sync"
}
}
]
}
Ntp disable server on the switches.
IPs of the devices to disable ntp serve.
device_ips | Array of strings |
fabric_name | string Name of the fabric |
disable | object (Disable information) |
Ntp disable server request succesful
Authorization information is missing or invalid.
IP address of device specified is not registered.
Specified Fabric not found.
Unexpected error.
Unexpected error
{- "fabric_name": "default",
- "device_ips": "10.10.10.10 20.20.20.20",
- "disable": {
- "server": true
}
}
[- {
- "disable": {
- "server": true,
- "app_state": "cfg-in-sync"
}, - "ip_address": "2.2.2.2",
- "fabric_name": "default",
- "status": {
- "result": "Failed",
- "reason": "Device is not registered"
}
}
]
Get SNMP communities for a list of devices
device_ips | Array of strings non-empty IP addresses of the devices |
OK
Authorization information is missing or invalid.
IP address of device specified is not registered.
Unexpected error
Unexpected error
{- "items": [
- {
- "device_ip": "2.2.2.2",
- "items": [
- {
- "write_view": "view1",
- "group_name": "group1",
- "name": "community1",
- "notify_view": "view1",
- "read_view": "view1",
- "app_state": "cfg-in-sync"
}, - {
- "write_view": "view2",
- "group_name": "group2",
- "name": "community2",
- "notify_view": "view2",
- "read_view": "view2",
- "app_state": "cfg-in-sync"
}
]
}, - {
- "device_ip": "3.3.3.3",
- "items": [
- {
- "write_view": "view1",
- "group_name": "group1",
- "name": "community1",
- "notify_view": "view1",
- "read_view": "view1",
- "app_state": "cfg-in-sync"
}, - {
- "write_view": "view2",
- "group_name": "group2",
- "name": "community2",
- "notify_view": "view2",
- "read_view": "view2",
- "app_state": "cfg-in-sync"
}
]
}
]
}
Create SNMP community
Create a SNMP community
device_ips | Array of strings IP address of devices |
community | object (SNMP community and group information) |
OK
Authorization information is missing or invalid.
IP address of device specified is not registered.
SNMP community with the specified name already exists.
Unexpected error.
Unexpected error
{- "device_ips": [
- "2.2.2.2",
- "3.3.3.3"
], - "community": [
- {
- "name": "community1",
- "group_name": "group1",
- "enable_read_access": true,
- "enable_write_access": false,
- "enable_notify_access": false
}
]
}
[- {
- "community": {
- "write_view": "view1",
- "group_name": "group1",
- "name": "community1",
- "notify_view": "view1",
- "read_view": "view1",
- "app_state": "cfg-in-sync"
}, - "ip_address": "2.2.2.2",
- "status": {
- "result": "Success",
- "reason": ""
}
}
]
Delete SNMP community
name required | string Name of the SNMP community |
device_ips | Array of strings non-empty IP addresses of the devices where SNMP community needs to be deleted |
OK
Authorization information is missing or invalid.
IP address of device specified is not registered.
Unexpected error.
Unexpected error
[- {
- "community": {
- "write_view": "view1",
- "group_name": "group1",
- "name": "community1",
- "notify_view": "view1",
- "read_view": "view1",
- "app_state": "cfg-in-sync"
}, - "ip_address": "2.2.2.2",
- "status": {
- "result": "Success",
- "reason": ""
}
}
]
Get SNMP users for a list of devices
device_ips | Array of strings non-empty IP addresses of the devices |
OK
Authorization information is missing or invalid.
IP address of device specified is not registered
Unexpected error
Unexpected error
{- "items": [
- {
- "device_ip": "2.2.2.2",
- "items": [
- {
- "auth_protocol": "md5",
- "write_view": "view4",
- "group_name": "v3group",
- "name": "v3user",
- "auth_passphrase": "v3authpass",
- "notify_view": "view4",
- "priv_passphrase": "v3privpass",
- "priv_protocol": "aes128",
- "read_view": "view4",
- "app_state": "cfg-in-sync"
}, - {
- "auth_protocol": "md5",
- "write_view": "view2",
- "group_name": "group3",
- "name": "v3user1",
- "auth_passphrase": "v3authpass1",
- "notify_view": "view2",
- "priv_passphrase": "v3privpass1",
- "priv_protocol": "aes128",
- "read_view": "view2",
- "app_state": "cfg-in-sync"
}
]
}, - {
- "device_ip": "3.3.3.3",
- "items": [
- {
- "auth_protocol": "md5",
- "write_view": "view4",
- "group_name": "v3group",
- "name": "v3user",
- "auth_passphrase": "v3authpass",
- "notify_view": "view4",
- "priv_passphrase": "v3privpass",
- "priv_protocol": "aes128",
- "read_view": "view4",
- "app_state": "cfg-in-sync"
}, - {
- "auth_protocol": "md5",
- "write_view": "view2",
- "group_name": "group3",
- "name": "v3user1",
- "auth_passphrase": "v3authpass1",
- "notify_view": "view2",
- "priv_passphrase": "v3privpass1",
- "priv_protocol": "aes128",
- "read_view": "view2",
- "app_state": "cfg-in-sync"
}
]
}
]
}
Create SNMP user
Create a SNMP user
device_ips | Array of strings IP address of devices |
user | object (SNMP user and group information) |
OK
Authorization information is missing or invalid.
IP address of device specified is not registered.
Unexpected error.
Unexpected error
{- "device_ips": [
- "2.2.2.2",
- "3.3.3.3"
], - "user": {
- "name": "v3user",
- "group_name": "v3group",
- "enable_read_access": true,
- "enable_write_access": true,
- "enable_notify_access": true,
- "auth_protocol": "md5",
- "auth_passphrase": "v3authpass",
- "priv_protocol": "aes128",
- "priv_passphrase": "v3privpass"
}
}
[- {
- "user": {
- "auth_protocol": "md5",
- "write_view": "view4",
- "group_name": "v3group",
- "name": "v3user",
- "auth_passphrase": "v3authpass",
- "notify_view": "view4",
- "priv_passphrase": "v3privpass",
- "priv_protocol": "aes128",
- "read_view": "view4",
- "app_state": "cfg-in-sync"
}, - "device_ip": "2.2.2.2",
- "status": {
- "result": "Success",
- "reason": ""
}
}
]
Delete SNMP user
name required | string Name of the SNMP user |
device_ips | Array of strings non-empty IP addresses of the devices where SNMP user needs to be deleted |
OK
Authorization information is missing or invalid.
IP address of device specified is not registered.
Unexpected error.
Unexpected error
[- {
- "user": {
- "auth_protocol": "md5",
- "write_view": "view4",
- "group_name": "v3group",
- "name": "v3user",
- "auth_passphrase": "v3authpass",
- "notify_view": "view4",
- "priv_passphrase": "v3privpass",
- "priv_protocol": "aes128",
- "read_view": "view4",
- "app_state": "cfg-in-sync"
}, - "device_ip": "2.2.2.2",
- "status": {
- "result": "Success",
- "reason": ""
}
}
]
Get SNMP hosts for a list of devices
device_ips | Array of strings non-empty IP addresses of the devices |
OK
Authorization information is missing or invalid.
IP address of device specified is not registered.
Unexpected error
Unexpected error
{- "items": [
- {
- "device_ip": "2.2.2.2",
- "items": [
- {
- "host_ip": "40.40.40.40",
- "community": "",
- "user": "v3user",
- "version": "v3",
- "engineid": "01:02:03:04:05",
- "notify_type": "informs",
- "app_state": "cfg-in-sync"
}, - {
- "host-ip": "50.50.50.50",
- "community": "mycommunity1",
- "user": "",
- "version": "v2c",
- "engineid": "",
- "notify_type": "traps"
}
]
}, - {
- "device_ip": "3.3.3.3",
- "items": [
- {
- "host_ip": "40.40.40.40",
- "community": "",
- "user": "v3user",
- "version": "v3",
- "engineid": "01:02:03:04:05",
- "notify_type": "informs"
}, - {
- "host-ip": "50.50.50.50",
- "community": "mycommunity1",
- "user": "",
- "version": "v2c",
- "engineid": "",
- "notify_type": "traps"
}
]
}
]
}
Create SNMP host
Create a SNMP host
device_ips | Array of strings IP address of devices |
host | object (SNMP host information) |
OK
Authorization information is missing or invalid.
IP address of device specified is not registered.
Unexpected error.
Unexpected error
{- "device_ips": [
- "2.2.2.2",
- "3.3.3.3"
], - "host": {
- "host_ip": "40.40.40.40",
- "community": null,
- "user": "v3user",
- "version": "v3",
- "engineid": "01:02:03:04:05",
- "notify_type": "informs"
}
}
[- {
- "host": {
- "host_ip": "40.40.40.40",
- "community": "",
- "user": "v3user",
- "version": "v3",
- "engineid": "01:02:03:04:05",
- "notify_type": "informs",
- "udp_port": 162,
- "source_interface_type": "management",
- "source_interface_name": "chassis-ip",
- "severity_level": "None",
- "vrf_name": "mgmt-vrf",
- "app_state": "cfg-in-sync"
}, - "ip_address": "5.5.5.5",
- "status": {
- "result": "Failed",
- "reason": "Device is not registered"
}
}
]
Delete SNMP host
host_ip required | string IP address of of the SNMP host. Can be IPv4/IPv6/FQDN. |
community | string Snmp Community name associated with host |
user | string Snmp user name associated with host |
device_ips | Array of strings non-empty IP addresses of the devices where SNMP host needs to be deleted |
OK
Authorization information is missing or invalid.
IP address of device specified is not registered.
Unexpected error.
Unexpected error
[- {
- "host": {
- "host_ip": "40.40.40.40",
- "community": "",
- "user": "v3user",
- "version": "v3",
- "engineid": "01:02:03:04:05",
- "notify_type": "informs",
- "udp_port": 162,
- "source_interface_type": "management",
- "source_interface_name": "chassis-ip",
- "severity_level": "None",
- "vrf_name": "mgmt-vrf",
- "app_state": "cfg-in-sync"
}, - "ip_address": "5.5.5.5",
- "status": {
- "result": "Failed",
- "reason": "Device is not registered"
}
}
]
Get SNMP groups for a list of devices
device_ips | Array of strings non-empty IP addresses of the devices |
OK
Authorization information is missing or invalid.
IP address of device specified is not registered.
Unexpected error
Unexpected error
{- "items": [
- {
- "device_ip": "2.2.2.2",
- "items": [
- {
- "auth_type": "auth_with_no_privacy",
- "write_view": "view1",
- "name": "group2",
- "notify_view": "view1",
- "read_view": "view1",
- "version": "v3"
}, - {
- "auth_type": "auth_with_no_privacy",
- "write_view": "view2",
- "name": "group3",
- "notify_view": "view2",
- "read_view": "view2",
- "version": "v2c"
}
]
}, - {
- "device_ip": "3.3.3.3",
- "items": [
- {
- "auth_type": "auth_with_no_privacy",
- "write_view": "view1",
- "name": "group2",
- "notify_view": "view1",
- "read_view": "view1",
- "version": "v3"
}, - {
- "auth_type": "auth_with_no_privacy",
- "write_view": "view3",
- "name": "group4",
- "notify_view": "view3",
- "read_view": "view3",
- "version": "v2c"
}
]
}
]
}
Get SNMP views for a list of devices
device_ips | Array of strings non-empty IP addresses of the devices |
OK
Authorization information is missing or invalid.
IP address of device specified is not registered.
Unexpected error
Unexpected error
{- "items": [
- {
- "device_ip": "2.2.2.2",
- "items": [
- {
- "name": "view1",
- "mib_acess": "included",
- "oid": "1.3.6.1"
}, - {
- "name": "view2",
- "mib_acess": "excluded",
- "oid": "1.3.6.1.9"
}
]
}, - {
- "device_ip": "3.3.3.3",
- "items": [
- {
- "name": "view1",
- "mib_acess": "included",
- "oid": "1.3.6.1"
}, - {
- "name": "view2",
- "mib_acess": "excluded",
- "oid": "1.3.6.1.9"
}
]
}
]
}
Get the lock from other services for given process name and device ip if given.
process-name for which lock is required
process_name required | string |
ip_address | string |
OK
Approval From one of service is failed
Unexpected error
{- "process_name": "BackUp",
- "ip_address": null
}
[- {
- "ServiceName": "string",
- "Status": "string",
- "Error": "string"
}
]
unlock other services for given process name and device ip if given.
process-name for which unlock is required
process_name required | string |
ip_address | string |
OK
Any error happened in service
Unexpected error
{- "process_name": "BackUp",
- "ip_address": null
}
[- {
- "ServiceName": "string",
- "Status": "string",
- "Error": "string"
}
]
Get timezone for a list of devices
device_ips | Array of strings non-empty IP addresses of the devices |
OK
Authorization information is missing or invalid.
IP address of device specified is not registered.
Unexpected error
Unexpected error
{- "items": [
- {
- "device_ip": "2.2.2.2",
- "timezone": "America/Los_Angeles",
- "app_state": "cfg-in-sync"
}, - {
- "device_ip": "3.3.3.3",
- "timezone": "Africa/Algiers",
- "app_state": "cfg-refreshed"
}
]
}
Set Device timezone
Set timezone for device
device_ips | Array of strings IP address of devices |
timezone | string Device Timezone |
OK
Authorization information is missing or invalid.
IP address of device specified is not registered.
Unexpected error.
Unexpected error
{- "device_ips": [
- "2.2.2.2",
- "3.3.3.3"
], - "timezone": [
- "America/Los_Angeles"
]
}
[- {
- "timezone": {
- "device_ip": "2.2.2.2",
- "timezone": "America/Los_Angeles",
- "app_state": "cfg-in-sync"
}, - "status": {
- "result": "Success",
- "reason": ""
}
}
]
Unset Device Timezone
device_ips | Array of strings non-empty IP addresses of the devices where timezone needs to be unset |
OK
Authorization information is missing or invalid.
IP address of device specified is not registered.
Unexpected error.
Unexpected error
[- {
- "timezone": {
- "device_ip": "2.2.2.2",
- "timezone": "America/Los_Angeles",
- "app_state": "cfg-in-sync"
}, - "status": {
- "result": "Success",
- "reason": ""
}
}
]
Get supported timezones
OK
Authorization information is missing or invalid.
Unexpected error
Unexpected error
[- "string"
]
Get bindings such as prefix-list, route-map etc for BGP Peers/ Interfaces
device_ips required | Array of strings non-empty List of devices for which the bindings need to be fetched. Example 1.1.1.1,2.2.2.2 |
name_of_instance required | string Name of the instance that needs to be fetched |
type_of_instance required | string Enum: "route-map" "prefix-list" Type of instances such as prefix-list, route-map etc. |
OK
Mac Access Group request has invalid input params.
Authorization information is missing or invalid.
Mac Access Group with specified device IP/ID or Mac Access Group Name was not found.
Unexpected error.
Unexpected error
{- "Device": [
- {
- "device_ip": "1.1.1.1",
- "bindings": [
- {
- "binding_type": "ipv4-bgp-peer"
}, - {
- "binding_name": [
- "10.1.1.1",
- "10.2.2.2"
]
}, - {
- "binding_type": "ipv6-bgp-peer"
}, - {
- "binding_name": [
- "1::11",
- "2::22"
]
}
]
}, - {
- "device_ip": "2.2.2.2",
- "bindings": [
- {
- "binding_type": "ethernet"
}, - {
- "binding_name": [
- "0/1",
- "0/30"
]
}
]
}
]
}