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 All fabric details configured in the application
object {"group_by":"fabric-type"} Responses grouped by fabric-type {"filter":[{"name":"fabric-name","value":"Fabric1"},{"name":"fabric-type',"value":"non-clos"}] Responses searched by fabric-name="Fabric1" and fabric-type="non-clos" {"fuzzy":"Fabric1"} Responses searched using fuzzy search "Fabric1" | |
object {"sort_by":"asc|desc"} Responses with id in ascending or descending order {"offset" : "lt:30"} Responses searched with id less than 30 {"page_size":20} Responses searched with limit of 20 entries |
{- "items": [
- {
- "fabric-name": "BLR-FABRIC",
- "number-of-super-spine-nodes": "2",
- "fabric-description": "Bengaluru Fabric",
- "fabric-stage": 5,
- "fanbric-type": "clos",
- "fanbric-status": "provisioned",
- "number-of-not-provisioned-nodes": "3",
- "number-of-provisioned-nodes": "9",
- "number-of-provisioned-failed-nodes": "9",
- "number-of-config-gen-error-nodes": "3",
- "number-of-config-ready-nodes": "3",
- "number-of-config-refreshed-nodes": "3",
- "number-of-config-in-sync-nodes": "3",
- "number-of-multi-homed-leaf-nodes": "10",
- "fabric-settings": {
- "key": "fabSettingType:fabSettingValue"
}, - "fabric-id": 1,
- "fabric-devices": "",
- "number-of-pods": "5",
- "number-of-racks": "4",
- "number-of-single-homed-leaf-nodes": "0",
- "number-of-spine-nodes": "4",
- "number-of-single-homed-border-leaf-nodes": "4",
- "number-of-multi-homed-border-leaf-nodes": "4"
}, - {
- "fabric-name": "BLR-FABRIC",
- "number-of-super-spine-nodes": "2",
- "fabric-description": "Bengaluru Fabric",
- "fabric-stage": 5,
- "fabric-type": "clos",
- "number-of-not-provisioned-nodes": "3",
- "number-of-provisioned-nodes": "9",
- "number-of-provisioned-failed-nodes": "9",
- "number-of-config-gen-error-nodes": "3",
- "number-of-config-ready-nodes": "3",
- "number-of-config-refreshed-nodes": "3",
- "number-of-config-in-sync-nodes": "3",
- "number-of-multi-homed-leaf-nodes": "10",
- "fabric-settings": {
- "key": "fabSettingType:fabSettingValue"
}, - "fabric-id": 1,
- "fabric-devices": "",
- "number-of-pods": "5",
- "number-of-racks": "4",
- "number-of-single-homed-leaf-nodes": "0",
- "number-of-spine-nodes": "4",
- "number-of-single-homed-border-leaf-nodes": "4",
- "number-of-multi-homed-border-leaf-nodes": "4"
}
]
}
Get only specified fabric details. The fabric can be identified by id or name
name required | string Name of the fabric to retrieve |
{- "fabric-name": "BLR-FABRIC",
- "number-of-super-spine-nodes": "2",
- "fabric-description": "Bengaluru Fabric",
- "fabric-stage": 5,
- "fabric-type": "clos",
- "fabric-status": "provisioned",
- "fabric-setting-updated": "BGP-LL,BGP-MD5",
- "number-of-not-provisioned-nodes": "3",
- "number-of-provisioned-nodes": "9",
- "number-of-provisioned-failed-nodes": "9",
- "number-of-config-gen-error-nodes": "3",
- "number-of-config-ready-nodes": "3",
- "number-of-config-refreshed-nodes": "3",
- "number-of-config-in-sync-nodes": "3",
- "number-of-multi-homed-leaf-nodes": "10",
- "fabric-settings": {
- "key": "fabSettingType:fabSettingValue"
}, - "fabric-id": 1,
- "fabric-devices": "",
- "number-of-pods": "5",
- "numer-of-racks": "4",
- "number-of-single-homed-leaf-nodes": "0",
- "number-of-spine-nodes": "4",
- "number-of-single-homed-border-leaf-nodes": "4",
- "number-of-multi-homed-border-leaf-nodes": "4"
}
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"
}
{- "fabric-name": "BLR-FABRIC",
- "number-of-super-spine-nodes": "2",
- "fabric-description": "Bengaluru Fabric",
- "fabric-stage": 5,
- "fabric-type": "clos",
- "fabric-status": "provisioned",
- "fabric-setting-updated": "BGP-LL,BGP-MD5",
- "number-of-not-provisioned-nodes": "3",
- "number-of-provisioned-nodes": "9",
- "number-of-provisioned-failed-nodes": "9",
- "number-of-config-gen-error-nodes": "3",
- "number-of-config-ready-nodes": "3",
- "number-of-config-refreshed-nodes": "3",
- "number-of-config-in-sync-nodes": "3",
- "number-of-multi-homed-leaf-nodes": "10",
- "fabric-settings": {
- "key": "fabSettingType:fabSettingValue"
}, - "fabric-id": 1,
- "fabric-devices": "",
- "number-of-pods": "5",
- "numer-of-racks": "4",
- "number-of-single-homed-leaf-nodes": "0",
- "number-of-spine-nodes": "4",
- "number-of-single-homed-border-leaf-nodes": "4",
- "number-of-multi-homed-border-leaf-nodes": "4"
}