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
Create a new Fabric
name required | string |
description | string |
stage | integer <int32> Enum: 3 5 7 |
type | string Enum: "clos" "non-clos" |
{- "stage": 5,
- "type": "clos",
- "name": "BLR-FABRIC",
- "description": "Bengaluru DC IP Fabric"
}
Add new devices to the specified fabric
fabric-name | string Name of the fabric |
Array of objects (FabricDeviceAddRequest) |
{- "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 |
Array of objects (FabricDeviceRemoveRequest) |
{- "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 |
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 |
{- "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 |
{- "ip_address": [
- "10.24.39.204"
], - "name": [
- "BLR_FABRIC"
]
}
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 |