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 |
{- "href": "href",
- "uuid": "id"
}
Get Switch replace History list
device_ip | string Ip of the entry for which RMA history is fetched |
{- "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"
}
]
}
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. |
{- "compare-results": {
- "key": "Device Details Changed:true"
}
}
ip_address required | string IP Addresses of the device to be retrieved. |
{- "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 |
required | Array of objects (DeviceParameter) |
{- "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 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 |
{- "href": "href",
- "uuid": "id"
}
current health status for the switch.
ip_address required | string IP Addresses of the device to be retrieved. |
{- "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. |
{- "href": "href",
- "uuid": "id"
}
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 |
{- "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. |
[- {
- "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. |
[- {
- "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. |
{- "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. |
{- "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 |
{- "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. |
{- "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. |
no_auto_commit | boolean Configure auto commit for Firmware Downloaed. |
no_maint_mode | boolean Configure Maintainance mode in Firmware Download |
{- "execution_task": {
- "href": "href",
- "id": "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 |
{- "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 |
{- "fabric": "fabric",
- "device_ips": [
- "device_ips",
- "device_ips"
]
}
{- "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. |
{- "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.
IPs of the devices to be prepared for a firmware download.
device_ips | Array of strings |
fabric | string |
firmware_host required | string |
firmware_directory required | string |
{- "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. |
{- "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"
}
}
]
}
Get only the interfaces with the specific parameters for the specified switch
device_ips | Array of strings non-empty IP address of the device for which the interfaces are being fetched for |
device_ids | Array of integers non-empty IP address of the device for which the interfaces are being fetched for |
type required | string Default: "All" Enum: "All" "Physical" "Loopback" "VE" "PO" Interface types. All, Ethernet interfaces, Loopback interfaces only, VE interfaces only or Port channels only |
fabric_intf_role | string Enum: "fabric" "edge" Fabric interface role , it can be either fabric or edge, Fabric means it will returns interfaces connected to other fabric devices otherwise it is edge ports. This parameter must be given in conjunction with device_ips or device_ids |
{- "items": [
- {
- "interfaces": [
- {
- "items": [
- {
- "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": "None",
- "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": "None",
- "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",
- "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": "None",
- "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": "None",
- "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",
- "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": "None",
- "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": "None",
- "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",
- "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": "None",
- "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": "None",
- "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.
fabric_name | string |
ip_address | Array of strings |
intfNames required | Array of strings |
adminState required | string Enum: "up" "down" |
intfType | string Default: "Eth" Enum: "Eth" "VE" "PO" |
{- "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 Brakout interfaces port with the specific parameters for the specified switch
Breakout break Port into multiple interfaces.
fabric_name | string |
ip_address | Array of strings |
intfNames required | Array of strings Interface Port Names |
intfType | string Default: "Eth" Enum: "Eth" "VE" "PO" |
mode required | string Enum: "1x10g" "1x25g" "1x40g" "1x100g" "2x40g" "2x50g" "4x10g" "4x25g" Port breakout mode |
{- "mode": "1x10g",
- "intfType": "Eth",
- "ip_address": "ip_address",
- "intfNames": [
- "intfNames",
- "intfNames"
]
}
[- {
- "ip_address": "string",
- "error": "string",
- "interfaces": [
- {
- "id": 1,
- "intf_type": "ethernet",
- "name": "0/1",
- "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.
fabric_name | string |
ip_address | Array of strings |
intfNames required | Array of strings Interface Port Names |
intfType | string Default: "Eth" Enum: "Eth" "VE" "PO" |
{- "fabric_name": "string",
- "ip_address": [
- "string"
], - "intfNames": [
- "string"
], - "intfType": "Eth"
}
[- {
- "ip_address": "string",
- "error": "string",
- "interfaces": [
- {
- "id": 1,
- "fabric_name": "default",
- "device_ip": "10.10.10.10",
- "intf_type": "ethernet",
- "name": "0/1",
- "status": {
- "result": "Failed",
- "reason": "Invalid Interface name provided"
}
}
]
}
]
List Brakout 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. |
[- {
- "ip_address": "string",
- "error": "string",
- "interfaces": [
- {
- "id": 1,
- "intf_type": "ethernet",
- "name": "0/1",
- "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.
fabric_name | string |
ip_address | Array of strings |
intfNames required | Array of strings 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 |
{- "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.
fabric_name | string |
ip_address | Array of strings |
intfNames required | Array of strings 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 |
{- "fabric_name": "string",
- "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"
}
}
]
}
]
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 |
{- "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
}, - {
- "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
}
]
}, - {
- "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
}, - {
- "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
}
]
}
]
}
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 device ips in hhh.hhh.hhh.hhh format |
[- {
- "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 |
{- "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 |
{- "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 Drift Reconcile History list
device_ip | string Ip of the entry for which Drift-Reconcile history is fetched |
{- "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 |
{- "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 |
{- "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 |
{- "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 |
{- "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 |
{- "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 |
{- "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 |
{- "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,
- "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,
- "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,
- "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,
- "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 |
{- "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 |
[- {
- "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 |
[- {
- "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 |
{- "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 |
{- "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 |
[- {
- "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 |
[- {
- "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 |
[- {
- "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 |
{- "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 |
[- {
- "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 |
[- {
- "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 |
{- "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 |
{- "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 the detailed output of the given execution ID
id required | string Detailed output of the given execution ID |
{- "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) |
{- "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"
}
]
}
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 |
{- "ref": "core.local"
}
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. |
{- "name": "name",
- "secret": true,
- "value": "value"
}
{- "name": "name",
- "secret": true,
- "value": "value"
}
Get all firmware hosts.
host_ips | Array of strings non-empty IPs of the firmware hosts to be fetched |
{- "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 |
{- "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 |
{- "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. |
{- "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 |
{- "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"
}
}
Change global MTU with the specific parameters for the specified switch
Change Port speed of interfaces of the Switch.
fabric_name | string |
ip_address | Array of strings |
mtu | integer Global L2 MTU |
ip_mtu | integer Global ipv4 MTU |
ipv6_mtu | integer Global ipv6 MTU |
{- "fabric_name": "string",
- "ip_address": [
- "string"
], - "mtu": 0,
- "ip_mtu": 0,
- "ipv6_mtu": 0
}
[- {
- "id": 0,
- "ip_address": "string",
- "mtu": 9100,
- "ip_mtu": 9100,
- "ipv6_mtu": 9100,
- "status": {
- "result": "Failed",
- "reason": "Invalid Interface name provided"
}
}
]
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 |
{- "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 |
{- "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"
}
]
}
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 |
{- "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 |
{- "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 DSC Detail
dsc_id required | string DSC Id of the entry for which detail is fetched |
{- "dr_id": "1111-1111-1111",
- "device-ip": "1.1.1.1",
- "admin_state_action": "up",
- "status": "Success",
- "Fabric_status": "Success",
- "Tenant_status": "Success",
- "maintenance_mode_enable_status": "Success",
- "StartTime": "12:03:24,12/2/2020"
}