Get the attributes of the given pnp profile
Since Product Version: 3.1
-
Jump To
- AAA/TACACS+ Servers Operations Service (4)
- AP Onboarding Profile Management Service (4)
- API Health Service (6)
- Access Point Operations (5)
- Alarms Management Service (5)
- Application Visibility and Control Service (1)
- CLI Template Configuration (12)
- Clients (7)
- Compliance Service (5)
- Configuration Archive Service (7)
- Credential Profile Management Service (5)
- Credentials Service (1)
- Device Details (9)
- Device Operations (9)
- Group Management Service (8)
- Group Summary Service (8)
- Guest User Management Service (8)
- Job Operations (6)
- MAC Filters Management Service (5)
- Manage and Monitor Info Service (5)
- Managed Servers Operations (6)
- Plug and Play (11)
- Rate Limits Management Service (2)
- Report Service (4)
- Site Map Service (3)
- Software Updates (2)
- Statistics (91)
- System Settings (26)
- Trap Receivers (4)
- User Defined Field Management (3)
- User Management Service (5)
- VNF Provisioning (16)
- Virtual Domains Management Service (10)
- Virtual Image Repository (8)
- WLAN Provisioning (16)
- Wireless Device Details (22)
- v1
- v2
- v3
- v4
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/pnp/profile/{pnpProfileFolder}/{profileName}Request Parameters
Attribute | Source | Description |
---|---|---|
pnpProfileFolder String |
path |
Required Profile Folder: Router/Switch/Wireless AP/Nexus POAP/Mobility Express WLC |
profileName String |
path |
Required Name of the profile for which details are got |
Response Parameters
Attribute | Description | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
APIC Em profile options |
|||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||
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 |
Credential Profile Name |
||||||||||||||||||||||||||||||||
description String |
Description of the pnp profile |
||||||||||||||||||||||||||||||||
deviceType String |
Device type |
||||||||||||||||||||||||||||||||
imageLocation String |
Location of the image |
||||||||||||||||||||||||||||||||
imageName String |
Image name |
||||||||||||||||||||||||||||||||
Nexus profile details |
|||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||
postPnPTemplateName String |
Post PNP Template name |
||||||||||||||||||||||||||||||||
profileName String |
Name of profile |
||||||||||||||||||||||||||||||||
profileType String |
Type of profile |
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? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
Resource URL
/webacs/api/v2/op/pnp/profile/{pnpProfileFolder}/{profileName} UnmodifiedThis resource has not been modified since the previous API version.
Request Parameters
Attribute | Source | Description |
---|---|---|
pnpProfileFolder String |
path |
Required Profile Folder: Router/Switch/Wireless AP/Nexus POAP/Mobility Express WLC |
profileName String |
path |
Required Name of the profile for which details are got |
Response Parameters
Attribute | Description | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
APIC Em profile options |
|||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||
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 |
Credential Profile Name |
||||||||||||||||||||||||||||||||
description String |
Description of the pnp profile |
||||||||||||||||||||||||||||||||
deviceType String |
Device type |
||||||||||||||||||||||||||||||||
imageLocation String |
Location of the image |
||||||||||||||||||||||||||||||||
imageName String |
Image name |
||||||||||||||||||||||||||||||||
Nexus profile details |
|||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||
postPnPTemplateName String |
Post PNP Template name |
||||||||||||||||||||||||||||||||
profileName String |
Name of profile |
||||||||||||||||||||||||||||||||
profileType String |
Type of profile |
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? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
Resource URL
/webacs/api/v3/op/pnp/profile/{pnpProfileFolder}/{profileName} UnmodifiedThis resource has not been modified since the previous API version.
Request Parameters
Attribute | Source | Description |
---|---|---|
pnpProfileFolder String |
path |
Required Profile Folder: Router/Switch/Wireless AP/Nexus POAP/Mobility Express WLC |
profileName String |
path |
Required Name of the profile for which details are got |
Response Parameters
Attribute | Description | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
APIC Em profile options |
|||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||
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 |
Credential Profile Name |
||||||||||||||||||||||||||||||||
description String |
Description of the pnp profile |
||||||||||||||||||||||||||||||||
deviceType String |
Device type |
||||||||||||||||||||||||||||||||
imageLocation String |
Location of the image |
||||||||||||||||||||||||||||||||
imageName String |
Image name |
||||||||||||||||||||||||||||||||
Nexus profile details |
|||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||
postPnPTemplateName String |
Post PNP Template name |
||||||||||||||||||||||||||||||||
profileName String |
Name of profile |
||||||||||||||||||||||||||||||||
profileType String |
Type of profile |
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"
} ]
}
}
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
Resource URL
/webacs/api/v4/op/pnp/profile/{pnpProfileFolder}/{profileName} UnmodifiedThis resource has not been modified since the previous API version.
Request Parameters
Attribute | Source | Description |
---|---|---|
pnpProfileFolder String |
path |
Required Profile Folder: Router/Switch/Wireless AP/Nexus POAP/Mobility Express WLC |
profileName String |
path |
Required Name of the profile for which details are got |
Response Parameters
Attribute | Description | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
APIC Em profile options |
|||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||
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 |
Credential Profile Name |
||||||||||||||||||||||||||||||||
description String |
Description of the pnp profile |
||||||||||||||||||||||||||||||||
deviceType String |
Device type |
||||||||||||||||||||||||||||||||
imageLocation String |
Location of the image |
||||||||||||||||||||||||||||||||
imageName String |
Image name |
||||||||||||||||||||||||||||||||
Nexus profile details |
|||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||
postPnPTemplateName String |
Post PNP Template name |
||||||||||||||||||||||||||||||||
profileName String |
Name of profile |
||||||||||||||||||||||||||||||||
profileType String |
Type of profile |
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/v4/op/pnp/profile/{pnpProfileFolder}/sample_profile_name
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/pnp/profile/{pnpProfileFolder}/sample_profile_name" rootUrl="https://localhost/webacs/api/v4/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/v4/op/pnp/profile/{pnpProfileFolder}/sample_profile_name.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/pnp/profile/{pnpProfileFolder}/sample_profile_name",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v4/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"
} ]
}
}