Download OpenAPI specification:Download
This is the spec that defines the API provided by the application to register devices to a fabric, configure fabric parameters, validate all the devices in the fabric and configure switches for IP Fabric with/without overlay
Get only specified fabric details. The fabric can be identified by id or name
name required | string Name of the fabric to retrieve |
OK
Authorization information is missing or invalid.
A fabric with the specified name was not found.
Unexpected error.
Unexpected error
Create a new Fabric
name required | string |
description | string |
stage | integer <int32> Enum: 3 5 7 |
type | string Enum: "clos" "non-clos" |
OK
Authorization information is missing or invalid.
A fabric with the specified name already exists.
Unexpected error.
Unexpected error
{- "stage": 5,
- "type": "clos",
- "name": "BLR-FABRIC",
- "description": "Bengaluru DC IP Fabric"
}
Delete an existing fabric by fabric name
name required | string Name of the fabric to be deleted |
force | boolean Default: false Value true implies forced deletion of the fabric |
OK
Authorization information is missing or invalid.
A fabric with the specified name was not found.
Unexpected error.
Unexpected error
source-fabric required | string Fabric to be cloned from |
destination-fabric required | string Fabric to be cloned to |
OK
Authorization information is missing or invalid.
A fabric with the specified name already exists.
Unexpected error.
Unexpected error
Validate CLOS topology of an input fabric
fabric-name required | string Name of the fabric |
OK
Authorization information is missing or invalid.
A fabric with the specified name was not found.
Unexpected error.
Get Fabric Error For an input fabric
fabric-name required | string Name of the fabric |
OK
Authorization information is missing or invalid.
A fabric with the specified name was not found.
Unexpected error.
Configure IP Fabric underlay/overlay on all devices of a fabric
fabric-name required | string Name of the fabric |
force | boolean Default: false Force the fabric configure operation on all devices of the fabric |
OK
Authorization information is missing or invalid.
Unexpected error.
Unexpected error
file | string <binary> efa.db file-path. This file will get uploaded to the dcapp server. |
fabric_name required | string Name of the fabric that gets created after importing db file. |
OK
Authorization information is missing or invalid.
Import fabric validation error
Unexpected error.
Unexpected error
name required | string Name of the fabric to retrieve |
OK
Incorrect values specified for Fabric setting
Authorization information is missing or invalid.
A fabric with the specified name was not found.
A fabric settings already exist and cannot be updated.
Unexpected error.
Unexpected error
Update Fabric Settings.
name required | string |
keyval required | Array of objects (FabricParameter) |
OK
Incorrect values specified for Fabric setting
Authorization information is missing or invalid.
A fabric with the specified name was not found.
A fabric settings already exist and cannot be updated.
Unexpected error.
Unexpected error
{- "name": "name",
- "keyval": [
- {
- "value": "value",
- "key": "key"
}, - {
- "value": "value",
- "key": "key"
}
]
}
Get fabric physical topology for a specified fabric.
fabric-name required | string Name of the fabric |
OK
Authorization information is missing or invalid.
A device with the specified IP was not found.
Unexpected error
Unexpected error
Get fabric underlay topology for a specified fabric
fabric-name required | string Name of the fabric |
OK
Authorization information is missing or invalid
A device with the specified IP was not found
Unexpected error
Unexpected error
Get fabric overlay topology for a specified fabric
fabric-name required | string Name of the fabric |
OK
Authorization information is missing or invalid
A device with the specified IP was not found
Unexpected error
Unexpected error
Get All Devices in the specified fabric.
fabric-name required | string Fabric name |
OK
No Devices found for the specified fabric.
Specified Fabric not found.
Unexpected error.
Unexpected error
Add new devices to the specified fabric
fabric-name | string Name of the fabric |
items | Array of objects (FabricDeviceAddRequest) |
OK
Specified fabric doesnt exist
Unexpected error.
CLOS topology validation error
{- "fabric-name": "BLR-FABRIC",
- "items": [
- {
- "loopback-id": "22",
- "ip-address": "10.20.50.201",
- "role": "leaf",
- "pod": "ROOM1",
- "rack": "ROW1RACK1",
- "leaf-type": "multi-homed",
- "host-name": "BLR-FABRIC1-ROOM1-DH-TOR11",
- "asn": "61441",
- "vtep-loopback-id": "11"
}, - {
- "loopback-id": "22",
- "ip-address": "10.20.50.201",
- "role": "leaf",
- "pod": "ROOM1",
- "rack": "ROW1RACK1",
- "leaf-type": "multi-homed",
- "host-name": "BLR-FABRIC1-ROOM1-DH-TOR11",
- "asn": "61441",
- "vtep-loopback-id": "11"
}
]
}
Remove devices from the specific fabric
Details of the devices to be removed
fabric-name | string Name of the fabric |
items | Array of objects (FabricDeviceRemoveRequest) |
OK
Authorization information is missing or invalid.
A Device with the specified IP Address was not found.
Unexpected error.
Unexpected error
{- "items": [
- {
- "ip-address": "10.20.50.201",
- "fabric-name": "BLR-FABRIC",
- "persist": false,
- "no-device-cleanup": false
}, - {
- "ip-address": "10.20.50.201",
- "fabric-name": "BLR-FABRIC",
- "persist": false,
- "no-device-cleanup": false
}
]
}
name required | string Name of the fabric |
deviceip required | string Device IP |
reconcile | boolean Default: false Reconcile flag |
OK
Authorization information is missing or invalid.
EndpointGroup with name already exists
Unexpected error
Unexpected error
Clear configurations from a list of devices
One or More Devices where configs are to be cleared.
reference_fabric_name | string |
ip_address | Array of strings |
OK
Authorization information is missing or invalid.
Unexpected error.
Unexpected error
{- "ip_address": [
- "10.24.39.204",
- "10.24.39.207"
], - "reference_fabric_name": [
- "BLR_FABRIC"
]
}
Get configurations Reason for a devices
Get Configs Generate Reasons for One Devices
name | string |
ip_address | string |
OK
Authorization information is missing or invalid.
Unexpected error.
Unexpected error
{- "ip_address": [
- "10.24.39.204"
], - "name": [
- "BLR_FABRIC"
]
}
ReConfigure IP Fabric underlay/overlay on all devices of a fabric
fabric-name required | string Name of the fabric |
device required | string ip of the devices whose Device State is provisioned and App State is cfg in-sync for which config needs to be pushed |
OK
Authorization information is missing or invalid.
Unexpected error.
Unexpected error
Get the detailed output of the given execution ID
id required | string Detailed output of the given execution ID |
OK
Authorization information is missing or invalid.
Unexpected error.
Unexpected error
Get the list of all the previous executions
limit required | integer Default: 10 Limit the number of executions that will be sent in the response. Default is 10 |
status | string Default: "all" Filter the executions based on the status(failed/succeeded/all) |
OK
Authorization information is missing or invalid.
Unexpected error.
Unexpected error
This API will delete the execution older than specific number of days
days_older_by required | integer Default: 30 Deletes execution entries older than specified number of days |
OK
ACCEPTED
Authorization information is missing or invalid.
Unexpected error.
Unexpected error
Get the list of all the event Histories
execution_uuid | string Execution UUID for filtering |
device_ip | string Device IP for filtering |
OK
Authorization information is missing or invalid.
Unexpected error.
Unexpected error
Get the Configuration of Devices in a Fabric
fabricName required | string Name of the fabric to retrieve |
role required | string Default: "all" Enum: "spines" "leaves" "border leaf" "all" role of the devices for which config needs to be fetched |
ip required | string ip of the devices for which config needs to be fetched |
OK
Authorization information is missing or invalid.
Unexpected error.
Unexpected error