Cisco DCNM REST API Guide, Release 7.x

DCI

The following are the DCI REST APIs:

• Get Unified Fabric DCI Settings
• Update Unified Fabric DCI Settings
• List DCI pairs
• Create DCI Pairs
• Get DCI Pairs with Node Id
• Update DCI Pairs for Special Type BL-DCI and BL
• Delete DCI Pairs for Special Type BL-DCI and BL
• Get DCI Pairs with Node ID and Peer ID
• Update DCI Pairs with Node ID and Peer ID
• Delete DCI Pairs with Node ID and Peer ID
• Create Partition with DCI Option
• Update Partition with DCI ID
• Update Partition to Disable DCI Extension
• Update Partition to Enable DCI Extension
• List All Extended Partitions
• List All Extended Partitions with a VRF
• List all Extended Partitions in an Organization
• Get Extended Partition

Get Unified Fabric DCI Settings

Resource Name

/settings/dci

Description

Get Unified Fabric DCI settings

https Method

GET

URL

https://dcnm-ip/rest/settings/dci

Parameter

Return Value

Format: JSON

Type: Object

Status Code

Update Unified Fabric DCI Settings

Resource Name

/settings/dci

Description

Update Unified Fabric DCI settings

https Method

PUT

URL

https://dcnm-ip/rest/settings/dci

Parameter

Return Value

Format: JSON

Type: Object

Status Code

List DCI pairs

Resource Name

/auto-config/dci/paired-devices

Description

List all the DCI pairs.

https Method

GET

URL

https://dcnm-ip/rest/auto-config/dci/paired-devices

Parameter

Return Value

Format: JSON

Type: Object

Status Code

Create DCI Pairs

Resource Name

/auto-config/dci/paired-devices

Description

Create DCI pairing.

https Method

POST

URL

https://dcnm-ip/rest/auto-config/dci/paired-devices

Parameter

Return Value

Format: JSON

Type: Object

Status Code

Get DCI Pairs with Node Id

Resource Name

/auto-config/dci/paired-devices/device/{node-id}

Description

Get the DCI pairings for a given node ID, or the type is "BL-DCI", or type is "BL" without peering.

<<sushs: do we need to expand BL?>>

https Method

GET

URL

https://dcnm-ip/rest/auto-config/dci/paired-devices/device/{node-id}

Parameter

Return Value

Format: JSON

Type: Object

Status Code

Update DCI Pairs for Special Type BL-DCI and BL

Resource Name

/auto-config/dci/paired-devices/device/{node-id}

Description

Update the DCI pairing for the type "BL-DCI" or "BL" without peering

<<sushs: same comment as above>>

https Method

PUT

URL

https://dcnm-ip/rest/auto-config/dci/paired-devices/device/{node-id}

Parameter

Return Value

Format: JSON

Type: Object

Status Code

Delete DCI Pairs for Special Type BL-DCI and BL

Resource Name

/auto-config/dci/paired-devices/device/{node-id}

Description

Delete the DCI pairing for the type "BL-DCI" or "BL" without peering

<<sushs: same comment as above>>

https Method

DELETE

URL

https://dcnm-ip/rest/auto-config/dci/paired-devices/device/{node-id}

Parameter

Return Value

Format: JSON

Type: Object

Status Code

Get DCI Pairs with Node ID and Peer ID

Resource Name

/auto-config/dci/paired-devices/device/{node-id}/peer/{peer-node-id}

Description

Get the DCI pairing for a given node-id and peer-id

https Method

GET

URL

https://dcnm-ip/rest/auto-config/dci/paired-devices/device/{node-id}/peer/{peer-node-id}

Parameter

Return Value

Format: JSON

Type: Object

Status Code

Update DCI Pairs with Node ID and Peer ID

Resource Name

/auto-config/dci/paired-devices/device/{node-id}/peer/{peer-node-id}

Description

Update the DCI pairing for a given node-id and peer-id.

https Method

PUT

URL

https://dcnm-ip/rest/auto-config/dci/paired-devices/device/{node-id}/peer/{peer-node-id}

Parameter

Return Value

Format: JSON

Type: Object

Status Code

Delete DCI Pairs with Node ID and Peer ID

Resource Name

/auto-config/dci/paired-devices/device/{node-id}/peer/{peer-node-id}

Description

Delete the DCI pairing for a given node ID and peer ID

https Method

DELETE

URL

https://dcnm-ip/rest/auto-config/dci/paired-devices/device/{node-id}/peer/{peer-node-id}

Parameter

Return Value

Format: JSON

Type: Object

Status Code

Create Partition with DCI Option

Resource Name

/auto-config/organizations/{organization-name}/partitions

Description

Create the partition with DCI ID and enable DCI extension.

https Method

POST

URL

https://dcnm-ip/rest/auto-config/organizations/{organization-name}/partitions

Parameter

Return Value

Format: JSON

Type: Object

Status Code

Update Partition with DCI ID

Resource Name

/auto-config/organizations/{organization-name}/partitions/{partition-name}

Description

Update the partition with DCI ID.

https Method

PUT

URL

https://dcnm-ip/rest/auto-config/organizations/{organization-name}/partitions/{partition-name}

Parameter

Return Value

Format: JSON

Type: Object

Status Code

Update Partition to Disable DCI Extension

Resource Name

/auto-config/organizations/{organization-name}/partitions/{partition-name}

Description

Update the partition to disable DCI extension.

https Method

PUT

URL

https://dcnm-ip/rest/auto-config/organizations/{organization-name}/partitions/{partition-name}

Parameter

Return Value

Format: JSON

Type: Object

Status Code

Update Partition to Enable DCI Extension

Resource Name

/auto-config/organizations/{organization-name}/partitions/{partition-name}

Description

Update the partition to enable DCI extension.

https Method

PUT

URL

https://dcnm-ip/rest/auto-config/organizations/{organization-name}/partitions/{partition-name}

Parameter

Return Value

Format: JSON

Type: Object

Status Code

List All Extended Partitions

Resource Name

/auto-config/dci/extended-partitions

Description

List all the extended partitions.

https Method

GET

URL

https://dcnm-ip/rest/auto-config/dci/extended-partitions

https://dcnm-ip/rest/auto-config/dci/extended-partitions?detail=true

Parameter

Return Value

Format: JSON

Type: Object

Status Code

List All Extended Partitions with a VRF

Resource Name

/auto-config/dci/extended-partitions/vrfs/{vrf-name}

Description

List all the extended partitions with a VRF.

https Method

GET

URL

https://dcnm-ip/rest/auto-config/dci/extended-partitions/vrfs/{vrf-name}

https://dcnm-ip/rest/auto-config/dci/extended-partitions/vrfs/{vrf-name}?detail=true

Parameter

Return Value

Format: JSON

Type: Object

Status Code

List all Extended Partitions in an Organization

Resource Name

/auto-config/dci/extended-partitions/organizations/{organization-name}

Description

List all the extended partitions in a organization.

https Method

GET

URL

https://dcnm-ip/rest/auto-config/dci/extended-partitions/organizations/{organization-name}

https://dcnm-ip/rest/auto-config/dci/extended-partitions/organizations/{organization-name}?detail=true

Parameter

Return Value

Format: JSON

Type: Object

Status Code

Get Extended Partition

Resource Name

/auto-config/dci/extended-partitions/organizations/{organization-name}/partitions/{partition-name}

Description

Get extended partition

https Method

GET

URL

https://dcnm-ip/rest/auto-config/dci/extended-partitions/organizations/{organization-name}/partitions/{partition-name}

https://dcnm-ip/rest/auto-config/dci/extended-partitions/organizations/{organization-name}/partitions/{partition-name}?detail=true

Parameter

Return Value

Format: JSON

Type: Object

Status Code

<<sushs: Do we need to add the Sample Flow as mentioned in the SFS? I havent seen any instances earlier.>>