Inventory Service (2.4.2)

Download OpenAPI specification:Download

Extreme Networks: support@extremenetworks.com URL: http://www.extremenetworks.com License: Apache license

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

replaceSwitch

Replace the switch as part of an RMA. This will replace the asset information of the new switch in the Inventory.

query Parameters

ip_address required	string IP Addresses of the device to be replaced.
config_backup_id	string UUID of config backup

Responses

Response samples

202
401
409
500
default

Content type

application/json


{"href": "href",
"uuid": "id"
}

Switch replace

rma

delet RMA ID.

query Parameters

key	string IP Addresses of the device or RMA uuid to deleted.

Responses

Response samples

200
409
500
default

Content type

application/json


{"result": 0,
"userKey": "1111-1111-1111",
"error": "uuid not found"
}

Switch replace History list

getRMAHistorys

Get Switch replace History list

query Parameters

device_ip

string

Ip of the entry for which RMA history is fetched

Responses

Response samples

200
404
500
default

Content type

application/json


{"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"
}
]
}

Switch Replace Details

getRMADetail

Get RMA Detail

query Parameters

rma_id

required

string

RMA Id of the entry for which detail is fetched

Responses

Response samples

200
404
500
default

Content type

application/json


{"dr_id": "1111-1111-1111",
"device-ip": "1.1.1.1",
"status": "Success",
"StartTime": "12:03:24,12/2/2020"
}

Compare

compareSwitch

Compare the Specified Switch configuration with whats in the Asset DB

query Parameters

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.

Responses

Response samples

200
404
500
default

Content type

application/json


{"compare-results": 
{"key": "Device Details Changed:true"
}
}

Switch Setting

getSwitchSetting

query Parameters

ip_address

required

string

IP Addresses of the device to be retrieved.

Responses

Response samples

Content type

application/json


{"device-ip": "10.20.30.40",
"device-settings": 
{"key": "devSettingType",
"value": 
{"result": 1,
"error-msg": "device not rechable"
}
}
}

updateSwitchSetting

Request Body schema: application/json

Update Switch Settings.

ip_address required	string
required	Array of objects (DeviceParameter)

Responses

Request samples

Payload

Content type

application/json


{"ip_address": "10.20.30.40",
"keyval": 
[
{"value": "value",
"key": "key"
},
{"value": "value",
"key": "key"
}
]
}

Response samples

Content type

application/json


{"device-ip": "10.20.30.40",
"device-settings": 
{"key": "devSettingType",
"value": 
{"result": 1,
"error-msg": "device not rechable"
}
}
}

Drift and reconcile

driftAndReconcile

Trigger drift and reconcile for fabric and tenant.

query Parameters

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

Responses

Response samples

202
409
500
default

Content type

application/json


{"href": "href",
"uuid": "id"
}

driftAndReconcile

delet drift and reconcile ID.

query Parameters

key	string IP Addresses of the device or drift and reconcile uuid to deleted.

Responses

Response samples

200
409
500
default

Content type

application/json


{"result": 0,
"userKey": "1111-1111-1111",
"error": "uuid not found"
}

switch health status

switchHealthStatus

current health status for the switch.

query Parameters

ip_address

required

string

IP Addresses of the device to be retrieved.

Responses

Response samples

200
409
500
default

Content type

application/json


{"switchHealth": "disabled",
"drUUID": "Id",
"href": "/v1/inventory/drift_reconcile/detail",
"heartBeatMissCounter": 2,
"heartBeatMissThreshold": 2,
"healthCheckInterval": "5m",
"maintenanceMode": "enabled"
}

Config Replay

StartConfigReplay

Config Replay to device.

query Parameters

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.

Responses

Response samples

202
409
500
default

Content type

application/json


{"href": "href",
"uuid": "id"
}

ConfigReplay

Delete Config Replay ID.

query Parameters

key	string IP Addresses of the device or config Replay uuid to deleted.

Responses

Response samples

200
409
500
default

Content type

application/json


{"result": 0,
"userKey": "1111-1111-1111",
"error": "uuid not found"
}

Config Backup

StartConfigBackup

Config Backup from device.

query Parameters

ip_address

required

string

IP Addresses of the device to be retrieved.

Responses

Response samples

202
409
500
default

Content type

application/json


{"href": "href",
"uuid": "id"
}

ConfigBackup

Delete Config Backup ID.

query Parameters

key	string IP Addresses of the device or config backup uuid to deleted.

Responses

Response samples

200
409
500
default

Content type

application/json


{"result": 0,
"userKey": "1111-1111-1111",
"error": "uuid not found"
}

Switches

getSwitches

Get All switches in the specified fabric.

query Parameters

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

Responses

Response samples

200
404
422
500
default

Content type

application/json


{"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
}
]
}

updateSwitches

Update All switches in the specified fabric.

query Parameters

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.

Responses

Response samples

200
404
422
500
default

Content type

application/json


[
{"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"
}
}
]

deleteSwitches

Delete the specified devices from the inventory.

query Parameters

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.

Responses

Response samples

200
401
404
500
default

Content type

application/json


[
{"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"
}
}
]

manageSwitchesConfig

Manage the running-config on the specified devices.

Request Body schema: application/json

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.

Responses

Request samples

Payload

Content type

application/json


{"fabric_name": "fabric_name",
"device_ips": 
["10.24.39.204",
"10.24.39.207"
],
"persist_local": true
}

Response samples

Content type

application/json


{"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"
}
}
]
}

executeSwitchesCli

Execute CLI commands on the specified devices.

Request Body schema: application/json

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.

Responses

Request samples

Payload

Content type

application/json


{"fabric_name": "default",
"role": "Spine",
"device_ips": 
["10.24.39.204",
"10.24.39.207"
],
"config": false,
"commands": "show version"
}

Response samples

Content type

application/json


{"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

registerSwitches

Register switches with the inventory service

Request Body schema: application/json

Register a new Switch.

device_ips required	Array of strings
username required	string
password required	string
maintmode	boolean

Responses

Request samples

Payload

Content type

application/json


{"password": "password",
"device_ips": 
["device_ips",
"device_ips"
],
"username": "username",
"maintmode": true
}

Response samples

200
401
409
500
default

Content type

application/json


[
{"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"
}
}
]

FirmwareDownload

getFirmwareDownloadStatus

Get the status of the firmware download execution.

query Parameters

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.

Responses

Response samples

200
404
422
500
default

Content type

application/json


{"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"
}
]
}

executeFirmwareDownload

Execute firmware download on the prepared switches.

query Parameters

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

Responses

Response samples

Content type

application/json


{"execution_task": 
{"href": "href",
"id": "id"
}
}

commmitFirmwareDownload

Execute firmware download commit on the switches.

Request Body schema: application/json

IPs of the devices to be prepared for a firmware download.

device_ips	Array of strings
fabric	string

Responses

Request samples

Payload

Content type

application/json


{"fabric": "fabric",
"device_ips": 
["device_ips",
"device_ips"
]
}

Response samples

Content type

application/json


{"items": 
[
{"ip_address": "string",
"task_status": "string",
"task_error": "string"
}
]
}

restoreFirmwareDownload

Execute firmware download restore on the switches.

Request Body schema: application/json

IPs of the devices to be prepared for a firmware download.

device_ips	Array of strings
fabric	string

Responses

Request samples

Payload

Content type

application/json


{"fabric": "fabric",
"device_ips": 
["device_ips",
"device_ips"
]
}

Response samples

Content type

application/json


{"items": 
[
{"ip_address": "string",
"task_status": "string",
"task_error": "string"
}
]
}

getPreparedSwitches

Get the prepared devices ready for a firmware download operation.

query Parameters

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.

Responses

Response samples

200
404
422
500
default

Content type

application/json


{"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"
}
}
]
}

addPreparedSwitches

Prepare the devices for a firmware download operation.

Request Body schema: application/json

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

Responses

Request samples

Payload

Content type

application/json


{"fabric": "fabric",
"device_ips": 
["device_ips",
"device_ips"
],
"firmware_host": "firmware_host",
"firmware_directory": "firmware_directory"
}

Response samples

Content type

application/json


{"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"
}
}
]
}

removePreparedSwitches

Un-prepare the devices from a firmware download operation.

query Parameters

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.

Responses

Response samples

200
401
500
default

Content type

application/json


{"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"
}
}
]
}

Interfaces

getInterfaces

Get only the interfaces with the specific parameters for the specified switch

query Parameters

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

Responses

Response samples

200
401
404
500
default

Content type

application/json


{"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

Down/Up interfaces with the specific parameters for the specified switch

Request Body schema: application/json

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"

Responses

Request samples

Payload

Content type

application/json


{"intfType": "Eth",
"adminState": "up",
"ip_address": "ip_address",
"intfNames": 
["intfNames",
"intfNames"
]
}

Response samples

200
401
404
500
default

Content type

application/json


[
{"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 Interface Port

Create Brakout interfaces port with the specific parameters for the specified switch

Request Body schema: application/json

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

Responses

Request samples

Payload

Content type

application/json


{"mode": "1x10g",
"intfType": "Eth",
"ip_address": "ip_address",
"intfNames": 
["intfNames",
"intfNames"
]
}

Response samples

200
401
404
500
default

Content type

application/json


[
{"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 Interface Port

Remove Breakout of interfaces port with the specific parameters for the specified switch

Request Body schema: application/json

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"

Responses

Request samples

Payload

Content type

application/json


{"fabric_name": "string",
"ip_address": 
["string"
],
"intfNames": 
["string"
],
"intfType": "Eth"
}

Response samples

200
401
404
500
default

Content type

application/json


[
{"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 Interface Port

List Brakout interfaces port with the specific parameters for the specified switch

query Parameters

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.

Responses

Response samples

Content type

application/json


[
{"ip_address": "string",
"error": "string",
"interfaces": 
[
{"id": 1,
"intf_type": "ethernet",
"name": "0/1",
"status": 
{"result": "Failed",
"reason": "Invalid Interface name provided"
}
}
]
}
]

Change Interface Port Speed

Change interfaces port speed with the specific parameters for the specified switch

Request Body schema: application/json

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

Responses

Request samples

Payload

Content type

application/json


{"intfType": "Eth",
"ip_address": "ip_address",
"intfNames": 
["intfNames",
"intfNames"
],
"speed": "100Mbps"
}

Response samples

200
401
404
500
default

Content type

application/json


[
{"interfaces": 
[
{"intf_type": "ethernet",
"name": "0/1",
"id": 1,
"speed": "up"
},
{"intf_type": "ethernet",
"name": "0/1",
"id": 1,
"speed": "up"
}
]
}
]

Set Mtu to Interface

Set L2Mtu, IPv4Mtu and IPv6Mtu to interfaces with the specific parameters for the specified switch

Request Body schema: application/json

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

Responses

Request samples

Payload

Content type

application/json


{"fabric_name": "string",
"ip_address": 
["string"
],
"intfNames": 
["string"
],
"intfType": "Eth",
"mtu": 0,
"ip_mtu": 0,
"ipv6_mtu": 0
}

Response samples

200
401
404
500
default

Content type

application/json


[
{"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"
}
}
]
}
]

Port Channels

getPortChannels

Get only the POs with the specific parameters for the specified switches

query Parameters

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

Responses

Response samples

200
401
404
500
default

Content type

application/json


{"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
}
]
}
]
}

LLDP data

getLldpData

Get LLDP data for a given input param

query Parameters

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

Responses

Response samples

Content type

application/json


[
{"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"
}
]

Device Links

getLinks

Get only the links for the specified switches

query Parameters

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

Responses

Response samples

Content type

application/json


{"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"
}
]
}

VLANS

getVLANs

Get VLANS for the specified switches

query Parameters

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

Responses

Response samples

Content type

application/json


{"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"
}
]
}

Drift Reconcile History list

getDriftReconcileHistorys

Get Drift Reconcile History list

query Parameters

device_ip

string

Ip of the entry for which Drift-Reconcile history is fetched

Responses

Response samples

200
404
500
default

Content type

application/json


{"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"
}
]
}

Drift Reconcile Details

getDriftReconcileDetail

Get Drift Reconcile Detail

query Parameters

dr_id

required

string

DriftReconcile Id of the entry for which detail is fetched

Responses

Response samples

200
404
500
default

Content type

application/json


{"dr_id": "1111-1111-1111",
"device-ip": "1.1.1.1",
"status": "Success",
"Reason": "Manual",
"StartTime": "12:03:24,12/2/2020"
}

Config Backup History list

getConfigBackupHistorys

Get Config Backup History list

query Parameters

device_ip

string

Ip of the entry for which Config-Backup history is fetched

Responses

Response samples

200
404
500
default

Content type

application/json


{"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"
}
]
}

Config Backup Details

getConfigBackupDetail

Get Config Backup Detail

query Parameters

cb_id required	string ConfigBackup Id of the entry for which detail is fetched
show_config	boolean Show complete configuration text

Responses

Response samples

200
404
500
default

Content type

application/json


{"cb_id": "1111-1111-1111",
"device-ip": "1.1.1.1",
"status": "Success",
"Reason": "Manual",
"StartTime": "12:03:24,12/2/2020"
}

Config Replay History list

getConfigReplayHistorys

Get Config Replay History list

query Parameters

device_ip

string

Ip of the entry for which Config-Replay history is fetched

Responses

Response samples

200
404
500
default

Content type

application/json


{"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"
}
]
}

Config Replay Details

getConfigReplayDetail

Get Config Replay Detail

query Parameters

cr_id

required

string

ConfigReplay Id of the entry for which detail is fetched

Responses

Response samples

200
404
500
default

Content type

application/json


{"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"
}

VE Interface

getVEs

Get only the VEs with the specific parameters for the specified switches

query Parameters

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

Responses

Response samples

200
401
404
500
default

Content type

application/json


{"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"
}
]
}

Router BGP

getRouterBgp

Get only the Router BGP with the specific parameters for the specified switch

query Parameters

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

Responses

Response samples

200
401
404
500
default

Content type

application/json


{"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
}
}

MCT

getMCTManagementCluster

Get only the MCT cluster node details with the specific parameters for the specified switch

query Parameters

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

Responses

Response samples

Content type

application/json


{"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
}
]
}

getMCTClusterConfiguration

Get the MCT cluster configuration with the specific parameters for the specified switch

query Parameters

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

Responses

Response samples

Content type

application/json


[
{"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
]
}
]

getMCTClusterClients

Get the MCT cluster client details with the specific parameters for the specified switch

query Parameters

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

Responses

Response samples

Content type

application/json


[
{"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
}
]

LIF

getLIF

Get only the LIFs details with the specific parameters for the specified switch

query Parameters

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

Responses

Response samples

200
401
404
500
default

Content type

application/json


{"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
}
}
]
}

EVPN

getEVPNInstance

Get only the EVPN Instance details along with Bridge Domain, VLAN mapping with the specific parameters for the specified switch

query Parameters

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

Responses

Response samples

200
401
404
500
default

Content type

application/json


{"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
]
}

Pseudowire Profile

getPseudowireProfile

Get the Pseudowire Profile details with the specific parameters for the specified switch

query Parameters

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

Responses

Response samples

200
401
404
500
default

Content type

application/json


[
{"name": "Tenant-profile",
"id": 1,
"vc-mode": "raw"
}
]

Bridge Domain

getBridgeDomain

Get only the EVPN Instance details along with Bridge Domain mapping with the specific parameters for the specified switch

query Parameters

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

Responses

Response samples

200
401
404
500
default

Content type

application/json


[
{"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
}
}
]
}
]

Overlay Gateway

getOverlayGateway

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

query Parameters

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

Responses

Response samples

200
401
404
500
default

Content type

application/json


[
{"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"
}
]

Tunnels

getTunnel

Get only the Tunnel details with the specific parameters for the specified switch

query Parameters

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

Responses

Response samples

200
401
404
500
default

Content type

application/json


{"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"
}

VRF

getVRF

Get only the VRF details with the specific parameters for the specified switch

query Parameters

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

Responses

Response samples

Content type

application/json


[
{"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"
}
}
]

VRRP

getVRRP

Get only the VRRP details with the specific parameters for the specified switch

query Parameters

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

Responses

Response samples

200
401
404
500
default

Content type

application/json


[
{"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"
}
]

Router PIM

getRouterPim

Get only the Router Pim with the specific parameters for the specified switch

query Parameters

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

Responses

Response samples

200
401
404
500
default

Content type

application/json


{"pim": 
[
{"vrf": "RED",
"enable_ssm": false,
"range": "mdt-range"
},
{"vrf": "BLUE",
"enable_ssm": true
}
]
}

IP Prefix-List

getIPPrefixList

Get only the IP Prefix List with the specific parameters for the specified switch

query Parameters

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

Responses

Response samples

200
401
404
500
default

Content type

application/json


{"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
}
]
}

Trouble Shooting

getExecutionDetail

Get the detailed output of the given execution ID

query Parameters

id

required

string

Detailed output of the given execution ID

Responses

Response samples

200
401
500
default

Content type

application/json


{"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"
}

getExecutionList

Get the list of all the previous executions

query Parameters

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)

Responses

Response samples

200
401
500
default

Content type

application/json


{"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"
}
]
}

GetRunningConfig

Get the list of all CLIs in Running Config

Responses

Response samples

200
401
500
default

Content type

application/json


{"items": 
["string"
]
}

Key Value

getKeyValueList

Returns a list of all key value pairs.

query Parameters

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

Responses

Response samples

200
default

Content type

application/json


{"ref": "core.local"
}

getValueForKey

Get a specific key vale pair based on key_name.

path Parameters

name

required

string

Key Name

query Parameters

decrypt

boolean

Decrypt secrets and display plain text.

Responses

Response samples

200
default

Content type

application/json


{"name": "name",
"secret": true,
"value": "value"
}

updateValueForKey

Create a new key value pair or update an existing one.

path Parameters

name

required

string

Key Name.

Request Body schema: application/json

Key Value pair content.

name required	string Key Name.
value required	string Key's value.
secret	boolean Encrypt value before saving the value.

Responses

Request samples

Payload

Content type

application/json


{"name": "name",
"secret": true,
"value": "value"
}

Response samples

200
default

Content type

application/json


{"name": "name",
"secret": true,
"value": "value"
}

deleteKey

Delete a Key.

path Parameters

name

required

string

Key Name.

Responses

Response samples

default

Content type

application/json


{"message": "Device is already registered in inventory",
"code": 101
}

FirmwareHosts

getFirmwareHosts

Get all firmware hosts.

query Parameters

host_ips

Array of strings non-empty

IPs of the firmware hosts to be fetched

Responses

Response samples

200
404
500
default

Content type

application/json


{"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"
}
}
]
}

FirmwareHost

getFirmwareHost

Get only specified firmware host details. The firmware host can be identified by IP Address

query Parameters

ip_address

required

string

IP Address of the firmware host

Responses

Response samples

200
404
500
default

Content type

application/json


{"protocol": "scp",
"id": 1,
"ip_address": "10.24.39.224",
"status": 
{"result": "Failed",
"reason": "Device or host registration failed"
}
}

registerFirmwareHost

Register firmware host with the inventory service

Request Body schema: application/json

Register a new firmware host.

ip_address required	string
protocol required	string Enum: "ftp" "tftp" "sftp" "scp" "http"
username required	string
password required	string

Responses

Request samples

Payload

Content type

application/json


{"protocol": "ftp",
"password": "password",
"ip_address": "ip_address",
"username": "username"
}

Response samples

Content type

application/json


{"protocol": "scp",
"id": 1,
"ip_address": "10.24.39.224",
"status": 
{"result": "Failed",
"reason": "Device or host registration failed"
}
}

deleteFirmwareHost

Delete the specified firmware host from the inventory.

query Parameters

ip_address

required

string

IP Addresses of the firmware host to be deleted.

Responses

Response samples

200
404
422
500
default

Content type

application/json


{"protocol": "scp",
"id": 1,
"ip_address": "10.24.39.224",
"status": 
{"result": "Failed",
"reason": "Device or host registration failed"
}
}

updateFirmwareHost

Update the specified firmware host details in the inventory.

path Parameters

ip_address

required

string

IP Address of the firmware host to be updated.

Request Body schema: application/json

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

Responses

Request samples

Payload

Content type

application/json


{"protocol": "ftp",
"password": "password",
"ip_address": "ip_address",
"username": "username"
}

Response samples

Content type

application/json


{"protocol": "scp",
"id": 1,
"ip_address": "10.24.39.224",
"status": 
{"result": "Failed",
"reason": "Device or host registration failed"
}
}

MTU

Change Global MTU for the specified

Change global MTU with the specific parameters for the specified switch

Request Body schema: application/json

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

Responses

Request samples

Payload

Content type

application/json


{"fabric_name": "string",
"ip_address": 
["string"
],
"mtu": 0,
"ip_mtu": 0,
"ipv6_mtu": 0
}

Response samples

200
401
404
500
default

Content type

application/json


[
{"id": 0,
"ip_address": "string",
"mtu": 9100,
"ip_mtu": 9100,
"ipv6_mtu": 9100,
"status": 
{"result": "Failed",
"reason": "Invalid Interface name provided"
}
}
]

DeviceDetails

Get device discovery interval time & device details

Get device discovery interval time for specific switch or switches in fabric

query Parameters

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

Responses

Response samples

200
401
404
500
default

Content type

application/json


{"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

Change device discovery interval time for specific switch or switches in fabric

Request Body schema: application/json

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

Responses

Request samples

Payload

Content type

application/json


{"ip_address": "10.25.225.165",
"fabric_name": "default",
"min": 30,
"hour": 2
}

Response samples

200
401
404
500
default

Content type

application/json


{"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"
}
]
}

DevicesLockStatus

Get devices lock statuses

Responses

Response samples

200
401
404
500
default

Content type

application/json


{"items": 
[
{"device_ip": "Spine",
"locked": true
}
]
}

Certificates

Install Certificates

Install certificates

Request Body schema: application/json

Install certificates on switches

device_ips	Array of strings
certificateType	string Enum: "https" "token" Type of certificate to be installed, either https or token

Responses

Request samples

Payload

Content type

application/json


{"device_ips": 
["device_ip",
"device_ip"
],
"certificateType": "https"
}

Response samples

200
401
500
default

Content type

application/json


[
{"device_ip": "10.x.x.x",
"status": "Success"
}
]

Device State Change History list

GetDSCHistorys

Get Device State Change History list

query Parameters

device_ip

string

Ip of the device for which DSC history is fetched

Responses

Response samples

200
404
500
default

Content type

application/json


{"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"
}
]
}

Device State Change Details

getDeviceState

Get Device Current State

query Parameters

device_ip

string

Ip of the entry for which Device State is fetched

Responses

Response samples

200
404
500
default

Content type

application/json


{"device-ip": "1.1.1.1",
"admin_state_action": "up",
"oper_state": "up",
"switch_health_status": "enable"
}

getDSCDetail

Get DSC Detail

query Parameters

dsc_id

required

string

DSC Id of the entry for which detail is fetched

Responses

Response samples

200
404
500
default

Content type

application/json


{"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"
}

Device state

deviceState

Trigger device state update as up or down.

query Parameters

ip_address required	string IP Address of the device to be retrieved.
state required	string State of the device to changed.

Responses

Response samples

202
409
500
default

Content type

application/json


{"href": "href",
"uuid": "id"
}

Device State

deleteDscDetails

delet DSC ID.

query Parameters

key	string IP Addresses of the device or DSC uuid to deleted.

Responses

Response samples

200
409
500
default

Content type

application/json


{"result": 0,
"userKey": "1111-1111-1111",
"error": "uuid not found"
}

Health

getHealth

Get the health of the Inventory service.

Responses

Response samples

200

Content type

application/json


{"Service": "string",
"MessageBus": "string"
}