Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v1/op/pnp/profile/{pnpProfileFolder}/{profileName}
Request Parameters
pnpProfileFolder
String
|
path
|
RequiredProfile Folder: Router/Switch/Wireless AP/Nexus POAP
|
profileName
String
|
path
|
RequiredName of the profile for which details are got
|
Response Parameters
apicEmProfileOptions
PnPApicDetails
|
|
accessPointDTO
PnpAccessPoint
|
Applicable only for Wireless AP profiles in APIC mode; All the fields in here are mandatory for wireless AP profiles
|
apGroup
String
|
Mandatory for Wireless AP profiles
|
apMode
String
|
Mandatory for Wireless AP profiles
|
primaryWlcIP
String
|
Primary WLC IP; Mandatory for Wireless AP profiles
|
primaryWlcName
String
|
Primary WLC Name; Mandatory for Wireless AP profiles
|
secondaryWlcIP
String
|
Secondary WLC IP; Mandatory for Wireless AP profiles
|
secondaryWlcName
String
|
Secondary WLC Name; Mandatory for Wireless AP profiles
|
tertiaryWlcIP
String
|
Tertiary WLC IP; Mandatory for Wireless AP profiles
|
tertiaryWlcName
String
|
Tertiary WLC Name; Mandatory for Wireless AP profiles
|
|
isPkienable
boolean
|
If the Enable PKI is false, the device will not be provisioned with PKI certificates; Applicable only for APIC profiles
|
isSudiReq
boolean
|
If the Enable PKI is false, the device will not be provisioned with SUDI certificates; Applicable for APIC mode
|
isTSenabe
boolean
|
This is an option for terminal server; If the TS enable is true, PI will use the Device Terminal Server IP and Port to provision itself; Applicable for APIC mode
|
|
author
String
|
Name of the user who created the profile
|
bootStrapTemplateName
String
|
Bootstrap template name of the profile
|
configurationTemplateName
String
|
Configuration template name
|
credentialProfileName
String
|
|
description
String
|
Description of the pnp profile
|
deviceType
String
|
|
imageLocation
String
|
|
imageName
String
|
|
nexusProfileDetails
PnPNexusDetails
|
|
kickstartImage
String
|
Both system and kick start images should have the same image version; Profile can be created with system/kickstart image or only with Configuration Template or with all the three.
|
nexusImageLocation
String
|
Location of the nexus image location(optional)
|
systemImage
String
|
Both system and kick start images should have the same image version; Profile can be created with system/kickstart image or only with Configuration Template or with all the three.
|
|
postPnPTemplateName
String
|
|
profileName
String
|
|
profileType
String
|
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v1/op/pnp/profile/{pnpProfileFolder}/sample_profile_name
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/pnp/profile/{pnpProfileFolder}/sample_profile_name" rootUrl="https://localhost/webacs/api/v1/op">
<pnPProfileDetails>
<apicEmProfileOptions>
<accessPointDTO>
<apGroup>String value</apGroup>
<apMode>String value</apMode>
<primaryWlcIP>String value</primaryWlcIP>
<primaryWlcName>String value</primaryWlcName>
<secondaryWlcIP>String value</secondaryWlcIP>
<secondaryWlcName>String value</secondaryWlcName>
<tertiaryWlcIP>String value</tertiaryWlcIP>
<tertiaryWlcName>String value</tertiaryWlcName>
</accessPointDTO>
<isPkienable>true</isPkienable>
<isSudiReq>true</isSudiReq>
<isTSenabe>true</isTSenabe>
</apicEmProfileOptions>
<author>String value</author>
<bootStrapTemplateName>String value</bootStrapTemplateName>
<configurationTemplateName>String value</configurationTemplateName>
<credentialProfileName>String value</credentialProfileName>
<description>String value</description>
<deviceType>String value</deviceType>
<imageLocation>String value</imageLocation>
<imageName>String value</imageName>
<nexusProfileDetails>
<kickstartImage>String value</kickstartImage>
<nexusImageLocation>String value</nexusImageLocation>
<systemImage>String value</systemImage>
</nexusProfileDetails>
<postPnPTemplateName>String value</postPnPTemplateName>
<profileName>String value</profileName>
<profileType>String value</profileType>
</pnPProfileDetails>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v1/op/pnp/profile/{pnpProfileFolder}/sample_profile_name.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/pnp\/profile\/{
pnpProfileFolder
}\/sample_profile_name",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"pnPProfileDetails" : {
"apicEmProfileOptions" : {
"accessPointDTO" : {
"apGroup" : "String value",
"apMode" : "String value",
"primaryWlcIP" : "String value",
"primaryWlcName" : "String value",
"secondaryWlcIP" : "String value",
"secondaryWlcName" : "String value",
"tertiaryWlcIP" : "String value",
"tertiaryWlcName" : "String value"
},
"isPkienable" : true,
"isSudiReq" : true,
"isTSenabe" : true
},
"author" : "String value",
"bootStrapTemplateName" : "String value",
"configurationTemplateName" : "String value",
"credentialProfileName" : "String value",
"description" : "String value",
"deviceType" : "String value",
"imageLocation" : "String value",
"imageName" : "String value",
"nexusProfileDetails" : {
"kickstartImage" : "String value",
"nexusImageLocation" : "String value",
"systemImage" : "String value"
},
"postPnPTemplateName" : "String value",
"profileName" : "String value",
"profileType" : "String value"
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v2/op/pnp/profile/{pnpProfileFolder}/{profileName}
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
pnpProfileFolder
String
|
path
|
RequiredProfile Folder: Router/Switch/Wireless AP/Nexus POAP
|
profileName
String
|
path
|
RequiredName of the profile for which details are got
|
Response Parameters
apicEmProfileOptions
PnPApicDetails
|
|
accessPointDTO
PnpAccessPoint
|
Applicable only for Wireless AP profiles in APIC mode; All the fields in here are mandatory for wireless AP profiles
|
apGroup
String
|
Mandatory for Wireless AP profiles
|
apMode
String
|
Mandatory for Wireless AP profiles
|
primaryWlcIP
String
|
Primary WLC IP; Mandatory for Wireless AP profiles
|
primaryWlcName
String
|
Primary WLC Name; Mandatory for Wireless AP profiles
|
secondaryWlcIP
String
|
Secondary WLC IP; Mandatory for Wireless AP profiles
|
secondaryWlcName
String
|
Secondary WLC Name; Mandatory for Wireless AP profiles
|
tertiaryWlcIP
String
|
Tertiary WLC IP; Mandatory for Wireless AP profiles
|
tertiaryWlcName
String
|
Tertiary WLC Name; Mandatory for Wireless AP profiles
|
|
isPkienable
boolean
|
If the Enable PKI is false, the device will not be provisioned with PKI certificates; Applicable only for APIC profiles
|
isSudiReq
boolean
|
If the Enable PKI is false, the device will not be provisioned with SUDI certificates; Applicable for APIC mode
|
isTSenabe
boolean
|
This is an option for terminal server; If the TS enable is true, PI will use the Device Terminal Server IP and Port to provision itself; Applicable for APIC mode
|
|
author
String
|
Name of the user who created the profile
|
bootStrapTemplateName
String
|
Bootstrap template name of the profile
|
configurationTemplateName
String
|
Configuration template name
|
credentialProfileName
String
|
|
description
String
|
Description of the pnp profile
|
deviceType
String
|
|
imageLocation
String
|
|
imageName
String
|
|
nexusProfileDetails
PnPNexusDetails
|
|
kickstartImage
String
|
Both system and kick start images should have the same image version; Profile can be created with system/kickstart image or only with Configuration Template or with all the three.
|
nexusImageLocation
String
|
Location of the nexus image location(optional)
|
systemImage
String
|
Both system and kick start images should have the same image version; Profile can be created with system/kickstart image or only with Configuration Template or with all the three.
|
|
postPnPTemplateName
String
|
|
profileName
String
|
|
profileType
String
|
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v2/op/pnp/profile/{pnpProfileFolder}/sample_profile_name
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/pnp/profile/{pnpProfileFolder}/sample_profile_name" rootUrl="https://localhost/webacs/api/v2/op">
<pnPProfileDetails>
<apicEmProfileOptions>
<accessPointDTO>
<apGroup>String value</apGroup>
<apMode>String value</apMode>
<primaryWlcIP>String value</primaryWlcIP>
<primaryWlcName>String value</primaryWlcName>
<secondaryWlcIP>String value</secondaryWlcIP>
<secondaryWlcName>String value</secondaryWlcName>
<tertiaryWlcIP>String value</tertiaryWlcIP>
<tertiaryWlcName>String value</tertiaryWlcName>
</accessPointDTO>
<isPkienable>true</isPkienable>
<isSudiReq>true</isSudiReq>
<isTSenabe>true</isTSenabe>
</apicEmProfileOptions>
<author>String value</author>
<bootStrapTemplateName>String value</bootStrapTemplateName>
<configurationTemplateName>String value</configurationTemplateName>
<credentialProfileName>String value</credentialProfileName>
<description>String value</description>
<deviceType>String value</deviceType>
<imageLocation>String value</imageLocation>
<imageName>String value</imageName>
<nexusProfileDetails>
<kickstartImage>String value</kickstartImage>
<nexusImageLocation>String value</nexusImageLocation>
<systemImage>String value</systemImage>
</nexusProfileDetails>
<postPnPTemplateName>String value</postPnPTemplateName>
<profileName>String value</profileName>
<profileType>String value</profileType>
</pnPProfileDetails>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/pnp/profile/{pnpProfileFolder}/sample_profile_name.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/pnp/profile/{pnpProfileFolder}/sample_profile_name",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"pnPProfileDetails" : [ {
"apicEmProfileOptions" : {
"accessPointDTO" : {
"apGroup" : "String value",
"apMode" : "String value",
"primaryWlcIP" : "String value",
"primaryWlcName" : "String value",
"secondaryWlcIP" : "String value",
"secondaryWlcName" : "String value",
"tertiaryWlcIP" : "String value",
"tertiaryWlcName" : "String value"
},
"isPkienable" : true,
"isSudiReq" : true,
"isTSenabe" : true
},
"author" : "String value",
"bootStrapTemplateName" : "String value",
"configurationTemplateName" : "String value",
"credentialProfileName" : "String value",
"description" : "String value",
"deviceType" : "String value",
"imageLocation" : "String value",
"imageName" : "String value",
"nexusProfileDetails" : {
"kickstartImage" : "String value",
"nexusImageLocation" : "String value",
"systemImage" : "String value"
},
"postPnPTemplateName" : "String value",
"profileName" : "String value",
"profileType" : "String value"
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v3/op/pnp/profile/{pnpProfileFolder}/{profileName}
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
pnpProfileFolder
String
|
path
|
RequiredProfile Folder: Router/Switch/Wireless AP/Nexus POAP
|
profileName
String
|
path
|
RequiredName of the profile for which details are got
|
Response Parameters
apicEmProfileOptions
PnPApicDetails
|
|
accessPointDTO
PnpAccessPoint
|
Applicable only for Wireless AP profiles in APIC mode; All the fields in here are mandatory for wireless AP profiles
|
apGroup
String
|
Mandatory for Wireless AP profiles
|
apMode
String
|
Mandatory for Wireless AP profiles
|
primaryWlcIP
String
|
Primary WLC IP; Mandatory for Wireless AP profiles
|
primaryWlcName
String
|
Primary WLC Name; Mandatory for Wireless AP profiles
|
secondaryWlcIP
String
|
Secondary WLC IP; Mandatory for Wireless AP profiles
|
secondaryWlcName
String
|
Secondary WLC Name; Mandatory for Wireless AP profiles
|
tertiaryWlcIP
String
|
Tertiary WLC IP; Mandatory for Wireless AP profiles
|
tertiaryWlcName
String
|
Tertiary WLC Name; Mandatory for Wireless AP profiles
|
|
isPkienable
boolean
|
If the Enable PKI is false, the device will not be provisioned with PKI certificates; Applicable only for APIC profiles
|
isSudiReq
boolean
|
If the Enable PKI is false, the device will not be provisioned with SUDI certificates; Applicable for APIC mode
|
isTSenabe
boolean
|
This is an option for terminal server; If the TS enable is true, PI will use the Device Terminal Server IP and Port to provision itself; Applicable for APIC mode
|
|
author
String
|
Name of the user who created the profile
|
bootStrapTemplateName
String
|
Bootstrap template name of the profile
|
configurationTemplateName
String
|
Configuration template name
|
credentialProfileName
String
|
|
description
String
|
Description of the pnp profile
|
deviceType
String
|
|
imageLocation
String
|
|
imageName
String
|
|
nexusProfileDetails
PnPNexusDetails
|
|
kickstartImage
String
|
Both system and kick start images should have the same image version; Profile can be created with system/kickstart image or only with Configuration Template or with all the three.
|
nexusImageLocation
String
|
Location of the nexus image location(optional)
|
systemImage
String
|
Both system and kick start images should have the same image version; Profile can be created with system/kickstart image or only with Configuration Template or with all the three.
|
|
postPnPTemplateName
String
|
|
profileName
String
|
|
profileType
String
|
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v3/op/pnp/profile/{pnpProfileFolder}/sample_profile_name
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/pnp/profile/{pnpProfileFolder}/sample_profile_name" rootUrl="https://localhost/webacs/api/v3/op">
<pnPProfileDetails>
<apicEmProfileOptions>
<accessPointDTO>
<apGroup>String value</apGroup>
<apMode>String value</apMode>
<primaryWlcIP>String value</primaryWlcIP>
<primaryWlcName>String value</primaryWlcName>
<secondaryWlcIP>String value</secondaryWlcIP>
<secondaryWlcName>String value</secondaryWlcName>
<tertiaryWlcIP>String value</tertiaryWlcIP>
<tertiaryWlcName>String value</tertiaryWlcName>
</accessPointDTO>
<isPkienable>true</isPkienable>
<isSudiReq>true</isSudiReq>
<isTSenabe>true</isTSenabe>
</apicEmProfileOptions>
<author>String value</author>
<bootStrapTemplateName>String value</bootStrapTemplateName>
<configurationTemplateName>String value</configurationTemplateName>
<credentialProfileName>String value</credentialProfileName>
<description>String value</description>
<deviceType>String value</deviceType>
<imageLocation>String value</imageLocation>
<imageName>String value</imageName>
<nexusProfileDetails>
<kickstartImage>String value</kickstartImage>
<nexusImageLocation>String value</nexusImageLocation>
<systemImage>String value</systemImage>
</nexusProfileDetails>
<postPnPTemplateName>String value</postPnPTemplateName>
<profileName>String value</profileName>
<profileType>String value</profileType>
</pnPProfileDetails>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/pnp/profile/{pnpProfileFolder}/sample_profile_name.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/pnp/profile/{pnpProfileFolder}/sample_profile_name",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"pnPProfileDetails" : [ {
"apicEmProfileOptions" : {
"accessPointDTO" : {
"apGroup" : "String value",
"apMode" : "String value",
"primaryWlcIP" : "String value",
"primaryWlcName" : "String value",
"secondaryWlcIP" : "String value",
"secondaryWlcName" : "String value",
"tertiaryWlcIP" : "String value",
"tertiaryWlcName" : "String value"
},
"isPkienable" : true,
"isSudiReq" : true,
"isTSenabe" : true
},
"author" : "String value",
"bootStrapTemplateName" : "String value",
"configurationTemplateName" : "String value",
"credentialProfileName" : "String value",
"description" : "String value",
"deviceType" : "String value",
"imageLocation" : "String value",
"imageName" : "String value",
"nexusProfileDetails" : {
"kickstartImage" : "String value",
"nexusImageLocation" : "String value",
"systemImage" : "String value"
},
"postPnPTemplateName" : "String value",
"profileName" : "String value",
"profileType" : "String value"
} ]
}
}