Auto Configuration
The auto configuration contains the following tables:
The following are the auto-configuration REST APIs:
Organization
|
|
|
organizationName |
String |
Mandatory |
description |
String |
Optional |
orchestrationSource |
String |
Optional |
Partition
|
|
|
partitionName |
String |
Mandatory |
partitionSegmentId |
String |
Mandatory |
organizationName |
String |
Mandatory |
vrfProfileName |
String |
Mandatory |
description |
String |
Optional |
serviceNodeIpAddress |
String |
Optional |
dnsServer |
String |
Optional |
secondaryDNSServer |
String |
Optional |
vrfName |
String |
Optional |
dciId |
String |
Optional |
configArg |
String |
Optional |
Network
|
|
|
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 |
gatewayIpv6Address |
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
|
|
|
forwardingMode |
String |
Mandatory |
profileName |
String |
Mandatory |
configCommands |
String |
Mandatory |
description |
String |
Optional |
profileType |
String |
Mandatory |
profileSubType |
String |
Mandatory |
Mandatory Field Class table
ConfigDeliveryTask
|
|
|
|
description |
String |
Mandatory |
|
timeout |
Number |
Mandatory |
|
scheduledTimeStr |
String |
Mandatory |
Format: dd/MM/yyyy HH:mm:ss |
configDeliveryTaskRollbackSetting |
String |
Mandatory |
Possible values:
- Rollback on Device and Stop Delivery on Other Devices
- Rollback on Device and Continue Delivery on Other Devices
- Rollback on All Devices
- Stop Delivery on Error
- Stop Delivery on All Devices on Error
- Continue on Error
|
configDeliveryTaskDeliveryOrderSetting |
String |
Optional |
Possible values:
|
configTemplateRef |
ConfigTemplate |
Mandatory |
|
configDeliveryTaskDeviceDetailsCol |
ConfigDeliveryTaskDeviceDetails[] |
Mandatory |
|
isCopyRunToStartTask |
Boolean |
Optional |
|
username |
String |
Mandatory |
|
password |
String |
Mandatory |
|
ConfigTemplate
|
|
|
name |
String |
Mandatory |
instanceClassId |
Number |
Optional |
ConfigDeliveryTaskDeviceDetails
|
|
|
ipAddress |
String |
Mandatory |
paramValues |
Array |
Mandatory |
Status
The following table details the API Response code, status and, the HTTPS methods.
|
|
API's HTTPS Method or HTTPS Method
|
200 |
OK |
GET OK POST PUT DELETE |
202 |
Accepted |
POST PUT DELETE |
400 |
Bad Request |
GET POST PUT DELETE |
401 |
Unauthorized |
GET POST PUT DELETE |
403 |
Forbidden |
GET POST PUT DELETE |
404 |
Not Found |
GET POST PUT DELETE |
405 |
Method Not Allowed |
GET POST PUT DELETE |
500 |
Internal Server Error |
GET POST PUT DELETE |
Resource Name
/auto-config/organizations
Description
Displays a list of Organizations.
Return Value
Format: JSON
Type: Object
|
|
|
Organizations |
A |
By default, a list of organization names is displayed. If “detail=true”, then a list of Organization objects is displayed. |
Resource Name
/auto-config/organizations
Description
Enables you to create a new organization.
URL
https://dcnm-ip/rest/auto-config/organizations
Parameter
|
|
|
Organization |
O |
Organization object |
Return Value
Format: JSON
Type: Object
|
|
|
Organization-name |
S |
New organization name |
Resource Name
/auto-config/organizations/organization-name
Description
Enables you to get an organization.
URL
https://dcnm-ip/rest/auto-config/organizations/organization-name
Return Value
Format: JSON
Type: Object
|
|
|
Oganization |
O |
Organization object |
Resource Name
/auto-config/organizations/organization-name
Description
Enables you to update an organization.
URL
https://dcnm-ip/rest/auto-config/organizations/organization-name
Parameter
|
|
|
Organization |
O |
Organization object |
Return Value
Format: JSON
Type: Object
Resource Name
/auto-config/organizations/organization-name
Description
Enables you to delete a organization.
URL
https://dcnm-ip/rest/auto-config/organizations/organization-name
Return Value
Format: JSON
Type: Object
Resource Name
/auto-config/organizations/organization-name/partitions
Description
Displays a list of partitions.
URL
https://dcnm-ip/rest/auto-config/organizations/organization1/partitions
https://dcnm-ip/rest/auto-config/organizations/organization1/partitions?detail=true
Return Value
Format: JSON
Type: Object
|
|
|
Partitions |
A |
By default, a list of partition names is displayed. If “detail=true”, then a list of partition objects is displayed. |
Resource Name
/auto-config/organizations/organization-name/partitions
Description
Enables you to create a new partition.
URL
https://dcnm-ip/rest/auto-config/organizations/organization-name/partitions
Parameter
|
|
|
Partition-object |
O |
Partition object |
Return Value
Format: JSON
Type: Object
|
|
|
partition-name |
S |
Partition name |
Resource Name
/auto-config/organizations/organization-name/partitions/partition-name
Description
Enables you to get a partition.
URL
https://dcnm-ip/rest/auto-config/organizations/organization-name/partitions/partition-name
Return Value
Format: JSON
Type: Object
|
|
|
Partition |
O |
Partition object |
Resource Name
/auto-config/organizations/organization-name/partitions/partition-name
Description
Update a partition.
URL
https://dcnm-ip/rest/auto-config/organizations/organization-name/partitions/partition-name
Parameter
|
|
|
Partition |
O |
Partition object |
Return Value
Format: JSON
Type: Object
Resource Name
/auto-config/organizations/organization-name/partitions/partition-name
Description
Delete a partition.
URL
https://dcnm-ip/rest/auto-config/organizations/organization-name/partitions/partition-name
Return Value
Format: JSON
Type: Object
Resource Name
/auto-config/organizations/organization-name/partitions/partition-name/networks
Description
List of networks.
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
Return Value
Format: JSON
Type: Object
|
|
|
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 |
Resource Name
/auto-config/organizations/organization-name/partitions/partition-name/networks
Description
Create a new network.
URL
https://dcnm-ip/rest/auto-config/organizations/organization-name/partitions/partition-name/networks
Return Value
Format: JSON
Type: Object
|
|
|
SegmentID or VLANID + MobilityDomainID |
S |
Segment ID for l2 segments or VLAN ID and Mobility Domain ID for VLAN Mobility Domain is displayed. |
Resource Name
/auto-config/organizations/organization-name/partitions/partition-name/networks/{network-id}
Description
Get a network.
Return Value
Format: JSON
Type: Object
Resource Name
/auto-config/organizations/organization-name/partitions/partition-name/networks/{network-id}
Description
Update a network.
Return Value
Format: JSON
Type: Object
Resource Name
/auto-config/organizations/organization-name/partitions/partition-name/networks/{network-id}
Description
Delete a network.
Return Value
Format: JSON
Type: Object
Resource Name
/auto-config/settings
Description
Get auto config settings.
URL
https://dcnm-ip/rest/auto-config/settings
Return Value
Format: JSON
Type: Object
|
|
|
Auto-config-settings |
O |
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. |
Update Auto Config Settings
Resource Name
/auto-config/settings
Description
Update auto config settings.
URL
https://dcnm-ip/rest/auto-config/settings
Parameter
|
|
|
Auto-config-settings |
O |
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
List Auto Configuration Profiles
Resource Name
/rest/auto-config/profiles
Description
List of profiles
URL
https://dcnm-ip/rest/auto-config/profiles
Return Value
Format: JSON
Type: Object
|
|
|
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. |
Create a Auto Configuration profile
Resource Name
/rest/auto-config/profiles/
Description
Create a new profile.
URL
https://dcnm-ip/rest/auto-config/profiles/
Return Value
Format: JSON
Type: Object
|
|
|
ProfileName |
S |
Profile name |
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.
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
Return Value
Format: JSON
Type: Object
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.
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
Return Value
Format: JSON
Type: Object
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.
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
Return Value
Format: JSON
Type: Object