The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
The auto configuration contains the following tables:
The following are the auto-configuration REST APIs:
|
|
|
---|---|---|
|
|
|
---|---|---|
|
|
|
---|---|---|
|
|
|
---|---|---|
|
|
|
|
---|---|---|---|
|
|
|
---|---|---|
|
|
|
---|---|---|
The following table details the API Response code, status and, the HTTPS methods.
|
|
|
---|---|---|
2021 |
||
1.Status Code 202 is returned only if the operation is Un-committed. Status code 200 is returned otherwise. |
|
|
|
---|---|---|
|
|
|
---|---|---|
By default, a list of organization names is displayed. If “detail=true”, then a list of Organization objects is displayed. |
|
|
|
---|---|---|
|
|
|
---|---|---|
https://dcnm-ip/rest/auto-config/organizations/organization-name
|
|
|
---|---|---|
|
|
|
---|---|---|
https://dcnm-ip/rest/auto-config/organizations/organization-name
|
|
|
---|---|---|
|
|
|
---|---|---|
https://dcnm-ip/rest/auto-config/organizations/organization-name
|
|
|
---|---|---|
|
|
|
---|---|---|
https://dcnm-ip/rest/auto-config/organizations/organization1/partitions
https://dcnm-ip/rest/auto-config/organizations/organization1/partitions?detail=true
|
|
|
---|---|---|
|
|
|
---|---|---|
By default, a list of partition names is displayed. If “detail=true”, then a list of partition objects is displayed. |
https://dcnm-ip/rest/auto-config/organizations/organization-name/partitions
|
|
|
---|---|---|
|
|
|
---|---|---|
/auto-config/organizations/organization-name/partitions/partition-name
https://dcnm-ip/rest/auto-config/organizations/organization-name/partitions/partition-name
|
|
|
---|---|---|
|
|
|
---|---|---|
/auto-config/organizations/organization-name/partitions/partition-name
https://dcnm-ip/rest/auto-config/organizations/organization-name/partitions/partition-name
|
|
|
---|---|---|
|
|
|
---|---|---|
/auto-config/organizations/organization-name/partitions/partition-name
https://dcnm-ip/rest/auto-config/organizations/organization-name/partitions/partition-name
|
|
|
---|---|---|
|
|
|
---|---|---|
/auto-config/organizations/organization-name/partitions/partition-name/networks
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
|
|
|
---|---|---|
/auto-config/organizations/organization-name/partitions/partition-name/networks
https://dcnm-ip/rest/auto-config/organizations/organization-name/partitions/partition-name/networks
|
|
|
---|---|---|
|
|
|
---|---|---|
Segment ID for l2 segments or VLAN ID and Mobility Domain ID for VLAN Mobility Domain is displayed. |
/auto-config/organizations/organization-name/partitions/partition-name/networks/{network-id}
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
|
|
|
---|---|---|
|
|
|
---|---|---|
/auto-config/organizations/organization-name/partitions/partition-name/networks/{network-id}
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
|
|
|
---|---|---|
|
|
|
---|---|---|
/auto-config/organizations/organization-name/partitions/partition-name/networks/{network-id}
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
|
|
|
---|---|---|
|
|
|
---|---|---|
|
|
|
---|---|---|
|
|
|
---|---|---|
|
|
|
---|---|---|
|
|
|
---|---|---|
By default, a list of profile Names, profile Types and profile SubTypes are displayed. If "detail=true", a list of profile objects is displayed. |
|
|
|
---|---|---|
|
|
|
---|---|---|
/rest/auto-config/profiles/{profile-name}
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://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
|
|
|
---|---|---|
|
|
|
---|---|---|
/rest/auto-config/profiles/{profile-name}
If profile Type has not been provided then update a default FPVLAN profile.
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
|
|
|
---|---|---|
|
|
|
---|---|---|
/rest/auto-config/profiles/{profile-name}
If profile Type has not been provided then delete a default FPVLAN profile.
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
|
|
|
---|---|---|
|
|
|
---|---|---|