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
Update the specified device details in the inventory.
ip_address required | string IP Address of the device to be updated. |
Update switch if credentials changes provide new username and password
ip_address required | string |
username required | string |
password required | string |
maintmode | boolean |
{- "password": "password",
- "ip_address": "ip_address",
- "username": "username",
- "maintmode": true
}
Register switch with the inventory service
Register a new Switch.
ip_address required | string |
username required | string |
password required | string |
maintmode | boolean |
{- "password": "password",
- "ip_address": "ip_address",
- "username": "username",
- "maintmode": true
}
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
}
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"
}
]
}
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. |
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 |
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. |
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
}
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"
}
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. |
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"
}
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. |
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 |
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"
]
}
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"
]
}
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"
}
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"
}
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
}
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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"
}
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"
}
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"
}
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
}
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
}
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 |
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"
}