Cisco DCNM REST API Guide, Release 7.x

Auto Configuration

The auto configuration contains the following tables:

The following are the Authentication REST APIs:

Organization

Attributes	Type	Require
organizationName	String	Mandatory
description	String	Optional
orchestrationSource	String	Optional

Partition

Attributes	Type	Require
partitionName	String	Mandatory
partitionSegmentId	String	Mandatory
organizationName	String	Mandatory
description	String	Optional
serviceNodeIpAddress	String	Optional
dnsServer	String	Optional
secondaryDNSServer	String	Optional
vrfName	String	Optional
dciId	String	Optional

Network

Attributes	Type	Require
organizationName	String	Mandatory
networkRole	String	Mandatory
networkName	String	Mandatory
segmentId	String	Mandatory
vlanId	String	Mandatory
mobilityDomainId	String	Mandatory
profileName	String	Mandatory
partitionName	String	Mandatory
dvsId	String	Optional
staticIpStart	String	Optional
gateway	String	Optional
netmaskLength	String	Optional
gatewayIpv6Adddress	String	Optional
prefixLength	String	Optional
secondaryGateway	String	Optional
staticIpEnd	String	Optional
vSwitchControllerNetworkId	String	Optional
description	String	Optional
vSwitchControllerId	String	Optional
configArg	String	Optional
dhcpScope	subnet	Optional
	gateway	Optional
	ipRange	Optional
vrfName	String	Optional

Profile

Attributes	Type	Require
forwardingMode	String	Mandatory
profileName	String	Mandatory
configCommands	String	Mandatory
description	String	Optional
profileType	String	Mandatory
profileSubType	String	Mandatory

List Organizations

Resource Name

/auto-config/organizations

Description

Displays a list of Organizations.

https Method

GET

URL

https://dcnm-ip/rest/auto-config/organizations

https://dcnm-ip/rest/auto-config/organizations?detail=true

Parameter

Parameter	Type	Description

Return Value

Format: JSON

Type: Object

Attribute Name	Type	Description
Organizations	A	By default, a list of organization names is displayed. If “detail=true”, then a list of Organization objects is displayed.

Status Code

200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
405	Method Not Allowed
500	Internal Server Error

Create an Organization

Resource Name

/auto-config/organizations

Description

Enables you to create a new organization.

https Method

POST

URL

https://dcnm-ip/rest/auto-config/organizations

Parameter

Parameter	Type	Description
Organization	O	Organization object

Return Value

Format: JSON

Type: Object

Attribute Name	Type	Description
Organization-name	S	New organization name

Status Code

202	Accepted
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
405	Method Not Allowed
500	Internal Server Error

Get an Organization

Resource Name

/auto-config/organizations/organization-name

Description

Enables you to get an organization.

https Method

GET

URL

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

Parameter

Parameter	Type	Description

Return Value

Format: JSON

Type: Object

Attribute Name	Type	Description
Oganization	O	Organization object

Status Code

200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
405	Method Not Allowed
500	Internal Server Error

Update an Organization

Resource Name

/auto-config/organizations/organization-name

Description

Enables you to update an organization.

https Method

PUT

URL

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

Parameter

Parameter	Type	Description
Organization	O	Organization object

Return Value

Format: JSON

Type: Object

Attribute Name	Type	Description

Status Code

202	Accepted
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
405	Method Not Allowed
500	Internal Server Error

Delete an Organization

Resource Name

/auto-config/organizations/organization-name

Description

Enables you to delete a organization.

https Method

DELETE

URL

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

Parameter

Parameter	Type	Description

Return Value

Format: JSON

Type: Object

Attribute Name	Type	Description

Status Code

202	Accepted
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
405	Method Not Allowed
500	Internal Server Error

List Partitions

Resource Name

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

Description

Displays a list of partitions.

https Method

GET

URL

https://dcnm-ip/rest/auto-config/organizations/organization1/partitions

https://dcnm-ip/rest/auto-config/organizations/organization1/partitions?detail=true

Parameter

Parameter	Type	Description

Return Value

Format: JSON

Type: Object

Attribute Name	Type	Description
Partitions	A	By default, a list of partition names is displayed. If “detail=true”, then a list of partition objects is displayed.

Status Code

200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
405	Method Not Allowed
500	Internal Server Error

Create a Partition

Resource Name

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

Description

Enables you to create a new partition.

https Method

POST

URL

http://dcnm-ip/rest/auto-config/organizations/organization-name/partitions

Parameter

Parameter	Type	Description
Partition-object	O	Partition object

Return Value

Format: JSON

Type: Object

Attribute Name	Type	Description
partition-name	S	Partition name

Status Code

202	Accepted
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
405	Method Not Allowed
500	Internal Server Error

Get a Partition

Resource Name

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

Description

Enables you to get a partition.

https Method

GET

URL

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

Parameter

Parameter	Type	Description

Return Value

Format: JSON

Type: Object

Attribute Name	Type	Description
Partition	O	Partition object

Status Code

200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
405	Method Not Allowed
500	Internal Server Error

Update a Partition

Resource Name

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

Description

Update a partition.

https Method

PUT

URL

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

Parameter

Parameter	Type	Description
Partition	O	Partition object

Return Value

Format: JSON

Type: Object

Attribute Name	Type	Description

Status Code

202	Accepted
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
405	Method Not Allowed
500	Internal Server Error

Delete a Partition

Resource Name

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

Description

Delete a partition.

https Method

DELETE

URL

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

Parameter

Parameter	Type	Description

Return Value

Format: JSON

Type: Object

Attribute Name	Type	Description

Status Code

202	Accepted
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
405	Method Not Allowed
500	Internal Server Error

List Networks

Resource Name

/auto-config/organizations/organization-name/partitions/partition-name/networks

Description

List of networks.

https Method

GET

URL

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

https://dcnm-ip/rest/auto-config/organizations/organization-name/partitions/partition-name/networks?detail=true

Parameter

Parameter	Type	Description

Return Value

Format: JSON

Type: Object

Attribute Name	Type	Description
Networks	A	By default, a list of segment IDs for l2 segments, a list of VLAN IDs, and Mobility Domain IDs for the VLAN Mobility Domain is displayed. If “detail=true”, then list of network objects is displayed

Status Code

200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
405	Method Not Allowed
500	Internal Server Error

Create a Network

Resource Name

/auto-config/organizations/organization-name/partitions/partition-name/networks

Description

Create a new network.

https Method

POST

URL

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

Parameter

Parameter	Type	Description
Network	O	Network object

Return Value

Format: JSON

Type: Object

Attribute Name	Type	Description
SegmentID or VLANID + MobilityDomainID	S	Segment ID for l2 segments or VLAN ID and Mobility Domain ID for VLAN Mobility Domain is displayed.

Status Code

200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
405	Method Not Allowed
500	Internal Server Error

Get a Network

Resource Name

/auto-config/organizations/organization-name/partitions/partition-name/networks/{network-id}

Description

Get a network.

https Method

GET

URL

https://dcnm-ip/rest/auto-config/organizations/organization-name/partitions/partition-name/networks/segment/20010

https://dcnm-ip/rest/auto-config/organizations/organization-name/partitions/partition-name/networks/vlan/10/mobility-domain/mydomain

Parameter

Parameter	Type	Description

Return Value

Format: JSON

Type: Object

Attribute Name	Type	Description
Network	O	Network object

Status Code

200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
405	Method Not Allowed
500	Internal Server Error

Update a Network

Resource Name

/auto-config/organizations/organization-name/partitions/partition-name/networks/{network-id}

Description

Update a network.

https Method

PUT

URL

https://dcnm-ip/rest/auto-config/organizations/organization-name/partitions/partition-name/networks/segment/20010

https://dcnm-ip/rest/auto-config/organizations/organization-name/partitions/partition-name/networks/vlan/10/mobility-domain/mydomain

Parameter

Parameter	Type	Description
Network	O	Network object

Return Value

Format: JSON

Type: Object

Attribute Name	Type	Description

Status Code

202	Accepted
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
405	Method Not Allowed
500	Internal Server Error

Delete a Network

Resource Name

/auto-config/organizations/organization-name/partitions/partition-name/networks/{network-id}

Description

Delete a network.

https Method

DELETE

URL

https://dcnm-ip/rest/auto-config/organizations/organization-name/partitions/partition-name/networks/segment/20010

https://dcnm-ip/rest/auto-config/organizations/organization-name/partitions/partition-name/networks/vlan/10/mobility-domain/mydomain

Parameter

Parameter	Type	Description

Return Value

Format: JSON

Type: Object

Attribute Name	Type	Description

Status Code

202	Accepted
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
405	Method Not Allowed
500	Internal Server Error

Get Auto Config Settings

Resource Name

/auto-config/settings

Description

Get auto config settings.

https Method

GET

URL

https://dcnm-ip/rest/auto-config/settings

Parameter

Parameter	Type	Description

Return Value

Format: JSON

Type: Object

Attribute Name

Type

Description

Auto-config-settings

The following auto config settings objects are displayed: ldapServer, ldapUserName, ldapPassWord, segmentIdRange, partitionIdRange, useLocalDhcp,

dhcpPrimarySubnet, enableAmqpNotification, amqpServer, amqpPort, amqpVirtualHost, amqpUserName, amqpPassWord, amqpExchangeName,

xmppServer, xmppUserName, xmppPassWord, xmppGroup, xmppResponseTimeout, xmppSearch, vrfName

The following attributes are applicable for HA set-up:

ldapPeerServer, ldapPeerUserName, ldapPeerPassWord.

Status Code

200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
405	Method Not Allowed
500	Internal Server Error

Update Auto Config Settings

Resource Name

/auto-config/settings

Description

Update auto config settings.

https Method

PUT

URL

https://dcnm-ip/rest/auto-config/settings

Parameter

Type

Description

Auto-config-settings

The following auto config settings object are displayed: ldapServer, ldapUserName, ldapPassWord, segmentIdRange, partitionIdRange, useLocalDhcp,

dhcpPrimarySubnet, enableAmqpNotification, amqpServer, amqpPort, amqpVirtualHost, amqpUserName, amqpPassWord, amqpExchangeName,

xmppServer, xmppUserName, xmppPassWord, xmppGroup, xmppResponseTimeout, xmppSearch, vrfName

The following attributes are applicable for HA set-up:

ldapPeerServer, ldapPeerUserName, ldapPeerPassWord.

Return Value

Format: JSON

Type: Object

Attribute Name	Type	Description

Status Code

202	Accepted
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
405	Method Not Allowed
500	Internal Server Error

List Auto Configuration Profiles

Resource Name

/rest/auto-config/profiles

Description

List of profiles

https Method

GET

URL

https://dcnm-ip/rest/auto-config/profiles

Parameter

Parameter	Type	Description

Return Value

Format: JSON

Type: Object

Attribute Name	Type	Description
profiles	A	By default, a list of profile Names, profile Types and profile SubTypes are displayed. If "detail=true", a list of profile objects is displayed.

Status Code

200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
405	Method Not Allowed
500	Internal Server Error

Create a Auto Configuration profile

Resource Name

/rest/auto-config/profiles/

Description

Create a new profile.

https Method

POST

URL

https://dcnm-ip/rest/auto-config/profiles/

Parameter

Parameter	Type	Description
profile	O	Profile object

Return Value

Format: JSON

Type: Object

Attribute Name	Type	Description
ProfileName	S	Profile name

Status Code

200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
405	Method Not Allowed
500	Internal Server Error

Get a Auto Configuration profile

Resource Name

/rest/auto-config/profiles/{profile-name}

/rest/auto-config/profiles/{profile-name}/type/IPVLAN

/rest/auto-config/profiles/{profile-name}/type/FPBD

Description

If profile Type has not been provided then response will return default FPVLAN profile.

If profile Type is IPVLAN then response will return IPVLAN profile.

If profile Type is FPBD then response will return FPBD profile.

https Method

GET

URL

https://dcnm-ip/rest/auto-config/profiles/{profile-name}

https://dcnm-ip/rest/auto-config/profiles/{profile-name}/type/IPVLAN

https://dcnm-ip/rest/auto-config/profiles/{profile-name}/type/FPBD

Parameter

Parameter	Type	Description

Return Value

Format: JSON

Type: Object

Attribute Name	Type	Description
profile	O	Profile object

Status Code

200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
405	Method Not Allowed
500	Internal Server Error

Update a Auto Configuration profile

Resource Name

/rest/auto-config/profiles/{profile-name}

/rest/auto-config/profiles/{profile-name}/type/IPVLAN

/rest/auto-config/profiles/{profile-name}/type/FPBD

Description

If profile Type has not been provided then update a default FPVLAN profile.

If profile Type is IPVLAN then update an IPVLAN profile.

If profile Type is FPBD then update a FPBD profile.

https Method

PUT

URL

https://dcnm-ip/rest/auto-config/profiles/{profile-name}

https://dcnm-ip/rest/auto-config/profiles/{profile-name}/type/IPVLAN

https://dcnm-ip/rest/auto-config/profiles/{profile-name}/type/FPBD

Parameter

Parameter	Type	Description
profile	O	Profile object

Return Value

Format: JSON

Type: Object

Attribute Name	Type	Description

Status Code

200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
405	Method Not Allowed
500	Internal Server Error

Delete a Auto Configuration profile

Resource Name

/rest/auto-config/profiles/{profile-name}

/rest/auto-config/profiles/{profile-name}/type/IPVLAN

/rest/auto-config/profiles/{profile-name}/type/FPBD

Description

If profile Type has not been provided then delete a default FPVLAN profile.

If profile Type is IPVLAN then delete an IPVLAN profile.

If profile Type is FPBD then delete a FPBD profile.

https Method

DELETE

URL

https://dcnm-ip/rest/auto-config/profiles/{profile-name}

https://dcnm-ip/rest/auto-config/profiles/{profile-name}/type/IPVLAN

https://dcnm-ip/rest/auto-config/profiles/{profile-name}/type/FPBD

Parameter

Parameter	Type	Description

Return Value

Format: JSON

Type: Object

Attribute Name	Type	Description

Status Code

200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
405	Method Not Allowed
500	Internal Server Error

Bias-Free Language

Results

Chapter: Auto Configuration

Auto Configuration

Organization

Partition

Network

Profile

List Organizations

Resource Name

Description

https Method

URL

Parameter

Return Value

Status Code

Create an Organization

Resource Name

Description

https Method

URL

Parameter

Return Value

Status Code

Get an Organization

Resource Name

Description

https Method

URL

Parameter

Return Value

Status Code

Update an Organization

Resource Name

Description

https Method

URL

Parameter

Return Value

Status Code

Delete an Organization

Resource Name

Description

https Method

URL

Parameter

Return Value

Status Code

List Partitions

Resource Name

Description

https Method

URL

Parameter

Return Value

Status Code

Create a Partition

Resource Name

Description

https Method

URL

Parameter

Return Value

Status Code

Get a Partition

Resource Name

Description

https Method

URL

Parameter

Return Value

Status Code

Update a Partition

Resource Name

Description

https Method

URL

Parameter

Return Value