Takes Profile Name as rest parameter and List of Profile Instances as payload. If Profile Instance with same name and same profile exist, those get updated otherwise new Profile Instance will be created.
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)
- 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 Credential |
HTTP Methods |
POST |
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/{profileName}/instance/Request Parameters
Attribute | Source | Description |
---|---|---|
profileName String |
path |
Required Name of the profile in which the profile instance to be updated |
Request Payload Parameters
Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Profile Instances. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Response Parameters
Attribute | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
List of Profile Instance Statuses. |
||||||||||
|
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 Request Payload
https://localhost/webacs/api/v1/op/pnp/profile/sample_profile_name/instance/
<?xml version="1.0" ?>
<profileInstanceList>
<profileInstances>
<profileInstance>
<bootstrap>
<parameters>
<parameter>
<name>String value</name>
<value>String value</value>
</parameter>
</parameters>
<templateName>String value</templateName>
</bootstrap>
<congifuration>
<componentTemplates>
<componentTemplate>
<parameters>
<parameter>
<name>String value</name>
<value>String value</value>
</parameter>
</parameters>
<templateName>String value</templateName>
</componentTemplate>
</componentTemplates>
<rawConfig>String value</rawConfig>
<templateName>String value</templateName>
</congifuration>
<deviceDetails>
<description>String value</description>
<pid>String value</pid>
<profileInstanceName>String value</profileInstanceName>
<serialNumber>String value</serialNumber>
</deviceDetails>
<imageProperties>
<imageLocation>String value</imageLocation>
<isActivateImageEnabled>true</isActivateImageEnabled>
<isContinueOnFailureEnabled>true</isContinueOnFailureEnabled>
<isEraseFlashEnabled>true</isEraseFlashEnabled>
</imageProperties>
<managementCredentials>
<cliCredentials>
<enablePassword>String value</enablePassword>
<password>String value</password>
<protocol>String value</protocol>
<timeOut>1</timeOut>
<userName>String value</userName>
</cliCredentials>
<ipAddressOrDNS>String value</ipAddressOrDNS>
<isConfigureManagementCredentialToDevice>true</isConfigureManagementCredentialToDevice>
<snmpCredentials>
<authPassword>String value</authPassword>
<authProtocol>String value</authProtocol>
<privacyPassword>String value</privacyPassword>
<privacyProtocol>String value</privacyProtocol>
<readCommunity>String value</readCommunity>
<retries>1</retries>
<timeOut>1</timeOut>
<userName>String value</userName>
<version>String value</version>
<writeCommunity>String value</writeCommunity>
</snmpCredentials>
</managementCredentials>
<postPnPConfiguration>
<parameters>
<parameter>
<name>String value</name>
<value>String value</value>
</parameter>
</parameters>
<templateName>String value</templateName>
</postPnPConfiguration>
<terminalServerDetails>
<terminalServerIP>String value</terminalServerIP>
<terminalServerPort>1</terminalServerPort>
</terminalServerDetails>
</profileInstance>
</profileInstances>
</profileInstanceList>
Sample JSON Request Payload
https://localhost/webacs/api/v1/op/pnp/profile/sample_profile_name/instance/.json
{
"profileInstanceList" : {
"profileInstances" : {
"profileInstance" : {
"bootstrap" : {
"parameters" : {
"parameter" : {
"name" : "String value",
"value" : "String value"
}
},
"templateName" : "String value"
},
"congifuration" : {
"componentTemplates" : {
"componentTemplate" : {
"parameters" : {
"parameter" : {
"name" : "String value",
"value" : "String value"
}
},
"templateName" : "String value"
}
},
"rawConfig" : "String value",
"templateName" : "String value"
},
"deviceDetails" : {
"description" : "String value",
"pid" : "String value",
"profileInstanceName" : "String value",
"serialNumber" : "String value"
},
"imageProperties" : {
"imageLocation" : "String value",
"isActivateImageEnabled" : true,
"isContinueOnFailureEnabled" : true,
"isEraseFlashEnabled" : true
},
"managementCredentials" : {
"cliCredentials" : {
"enablePassword" : "String value",
"password" : "String value",
"protocol" : "String value",
"timeOut" : 1,
"userName" : "String value"
},
"ipAddressOrDNS" : "String value",
"isConfigureManagementCredentialToDevice" : true,
"snmpCredentials" : {
"authPassword" : "String value",
"authProtocol" : "String value",
"privacyPassword" : "String value",
"privacyProtocol" : "String value",
"readCommunity" : "String value",
"retries" : 1,
"timeOut" : 1,
"userName" : "String value",
"version" : "String value",
"writeCommunity" : "String value"
}
},
"postPnPConfiguration" : {
"parameters" : {
"parameter" : {
"name" : "String value",
"value" : "String value"
}
},
"templateName" : "String value"
},
"terminalServerDetails" : {
"terminalServerIP" : "String value",
"terminalServerPort" : 1
}
}
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v1/op/pnp/profile/sample_profile_name/instance/
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/pnp/profile/sample_profile_name/instance/" rootUrl="https://localhost/webacs/api/v1/op">
<profileInstancesCreateOrUpdateStatus>
<profileInstanceStatuses>
<profileInstanceStatus>
<errors>
<error>String value</error>
</errors>
<profileInstanceName>String value</profileInstanceName>
<status>String value</status>
</profileInstanceStatus>
</profileInstanceStatuses>
</profileInstancesCreateOrUpdateStatus>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v1/op/pnp/profile/sample_profile_name/instance/.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/pnp\/profile\/sample_profile_name\/instance\/",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"profileInstancesCreateOrUpdateStatus" : {
"profileInstanceStatuses" : {
"profileInstanceStatus" : {
"errors" : {
"error" : "String value"
},
"profileInstanceName" : "String value",
"status" : "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 Credential |
HTTP Methods |
POST |
Resource URL
/webacs/api/v2/op/pnp/profile/{profileName}/instance/ UnmodifiedThis resource has not been modified since the previous API version.
Request Parameters
Attribute | Source | Description |
---|---|---|
profileName String |
path |
Required Name of the profile in which the profile instance to be updated |
Request Payload Parameters
Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Profile Instances. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Response Parameters
Attribute | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
List of Profile Instance Statuses. |
||||||||||
|
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 Request Payload
https://localhost/webacs/api/v2/op/pnp/profile/sample_profile_name/instance/
<?xml version="1.0" ?>
<profileInstanceList>
<profileInstances>
<profileInstance>
<bootstrap>
<parameters>
<parameter>
<name>String value</name>
<value>String value</value>
</parameter>
</parameters>
<templateName>String value</templateName>
</bootstrap>
<congifuration>
<componentTemplates>
<componentTemplate>
<parameters>
<parameter>
<name>String value</name>
<value>String value</value>
</parameter>
</parameters>
<templateName>String value</templateName>
</componentTemplate>
</componentTemplates>
<rawConfig>String value</rawConfig>
<templateName>String value</templateName>
</congifuration>
<deviceDetails>
<description>String value</description>
<pid>String value</pid>
<profileInstanceName>String value</profileInstanceName>
<serialNumber>String value</serialNumber>
</deviceDetails>
<imageProperties>
<imageLocation>String value</imageLocation>
<isActivateImageEnabled>true</isActivateImageEnabled>
<isContinueOnFailureEnabled>true</isContinueOnFailureEnabled>
<isEraseFlashEnabled>true</isEraseFlashEnabled>
</imageProperties>
<managementCredentials>
<cliCredentials>
<enablePassword>String value</enablePassword>
<password>String value</password>
<protocol>String value</protocol>
<timeOut>1</timeOut>
<userName>String value</userName>
</cliCredentials>
<ipAddressOrDNS>String value</ipAddressOrDNS>
<isConfigureManagementCredentialToDevice>true</isConfigureManagementCredentialToDevice>
<snmpCredentials>
<authPassword>String value</authPassword>
<authProtocol>String value</authProtocol>
<privacyPassword>String value</privacyPassword>
<privacyProtocol>String value</privacyProtocol>
<readCommunity>String value</readCommunity>
<retries>1</retries>
<timeOut>1</timeOut>
<userName>String value</userName>
<version>String value</version>
<writeCommunity>String value</writeCommunity>
</snmpCredentials>
</managementCredentials>
<postPnPConfiguration>
<parameters>
<parameter>
<name>String value</name>
<value>String value</value>
</parameter>
</parameters>
<templateName>String value</templateName>
</postPnPConfiguration>
<terminalServerDetails>
<terminalServerIP>String value</terminalServerIP>
<terminalServerPort>1</terminalServerPort>
</terminalServerDetails>
</profileInstance>
</profileInstances>
</profileInstanceList>
Sample JSON Request Payload
https://localhost/webacs/api/v2/op/pnp/profile/sample_profile_name/instance/.json
{
"profileInstanceList" : {
"profileInstances" : {
"profileInstance" : [ {
"bootstrap" : {
"parameters" : {
"parameter" : [ {
"name" : "String value",
"value" : "String value"
} ]
},
"templateName" : "String value"
},
"congifuration" : {
"componentTemplates" : {
"componentTemplate" : [ {
"parameters" : {
"parameter" : [ {
"name" : "String value",
"value" : "String value"
} ]
},
"templateName" : "String value"
} ]
},
"rawConfig" : "String value",
"templateName" : "String value"
},
"deviceDetails" : {
"description" : "String value",
"pid" : "String value",
"profileInstanceName" : "String value",
"serialNumber" : "String value"
},
"imageProperties" : {
"imageLocation" : "String value",
"isActivateImageEnabled" : true,
"isContinueOnFailureEnabled" : true,
"isEraseFlashEnabled" : true
},
"managementCredentials" : {
"cliCredentials" : {
"enablePassword" : "String value",
"password" : "String value",
"protocol" : "String value",
"timeOut" : 1,
"userName" : "String value"
},
"ipAddressOrDNS" : "String value",
"isConfigureManagementCredentialToDevice" : true,
"snmpCredentials" : {
"authPassword" : "String value",
"authProtocol" : "String value",
"privacyPassword" : "String value",
"privacyProtocol" : "String value",
"readCommunity" : "String value",
"retries" : 1,
"timeOut" : 1,
"userName" : "String value",
"version" : "String value",
"writeCommunity" : "String value"
}
},
"postPnPConfiguration" : {
"parameters" : {
"parameter" : [ {
"name" : "String value",
"value" : "String value"
} ]
},
"templateName" : "String value"
},
"terminalServerDetails" : {
"terminalServerIP" : "String value",
"terminalServerPort" : 1
}
} ]
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v2/op/pnp/profile/sample_profile_name/instance/
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/pnp/profile/sample_profile_name/instance/" rootUrl="https://localhost/webacs/api/v2/op">
<profileInstancesCreateOrUpdateStatus>
<profileInstanceStatuses>
<profileInstanceStatus>
<errors>
<error>String value</error>
</errors>
<profileInstanceName>String value</profileInstanceName>
<status>String value</status>
</profileInstanceStatus>
</profileInstanceStatuses>
</profileInstancesCreateOrUpdateStatus>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/pnp/profile/sample_profile_name/instance/.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/pnp/profile/sample_profile_name/instance/",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"profileInstancesCreateOrUpdateStatus" : [ {
"profileInstanceStatuses" : {
"profileInstanceStatus" : [ {
"errors" : {
"error" : [ "String value" ]
},
"profileInstanceName" : "String value",
"status" : "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 Credential |
HTTP Methods |
POST |
Resource URL
/webacs/api/v3/op/pnp/profile/{profileName}/instance/ UnmodifiedThis resource has not been modified since the previous API version.
Request Parameters
Attribute | Source | Description |
---|---|---|
profileName String |
path |
Required Name of the profile in which the profile instance to be updated |
Request Payload Parameters
Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Profile Instances. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Response Parameters
Attribute | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
List of Profile Instance Statuses. |
||||||||||
|
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 Request Payload
https://localhost/webacs/api/v3/op/pnp/profile/sample_profile_name/instance/
<?xml version="1.0" ?>
<profileInstanceList>
<profileInstances>
<profileInstance>
<bootstrap>
<parameters>
<parameter>
<name>String value</name>
<value>String value</value>
</parameter>
<parameter>
<name>Another string value</name>
<value>Another string value</value>
</parameter>
</parameters>
<templateName>String value</templateName>
</bootstrap>
<congifuration>
<componentTemplates>
<componentTemplate>
<parameters>
<parameter>
<name>String value</name>
<value>String value</value>
</parameter>
<parameter>
<name>Another string value</name>
<value>Another string value</value>
</parameter>
</parameters>
<templateName>String value</templateName>
</componentTemplate>
<componentTemplate>
<parameters>
<parameter>
<name>String value</name>
<value>String value</value>
</parameter>
<parameter>
<name>Another string value</name>
<value>Another string value</value>
</parameter>
</parameters>
<templateName>Another string value</templateName>
</componentTemplate>
</componentTemplates>
<rawConfig>String value</rawConfig>
<templateName>String value</templateName>
</congifuration>
<deviceDetails>
<description>String value</description>
<pid>String value</pid>
<profileInstanceName>String value</profileInstanceName>
<serialNumber>String value</serialNumber>
</deviceDetails>
<imageProperties>
<imageLocation>String value</imageLocation>
<isActivateImageEnabled>true</isActivateImageEnabled>
<isContinueOnFailureEnabled>true</isContinueOnFailureEnabled>
<isEraseFlashEnabled>true</isEraseFlashEnabled>
</imageProperties>
<managementCredentials>
<cliCredentials>
<enablePassword>String value</enablePassword>
<password>String value</password>
<protocol>String value</protocol>
<timeOut>1</timeOut>
<userName>String value</userName>
</cliCredentials>
<ipAddressOrDNS>String value</ipAddressOrDNS>
<isConfigureManagementCredentialToDevice>true</isConfigureManagementCredentialToDevice>
<snmpCredentials>
<authPassword>String value</authPassword>
<authProtocol>String value</authProtocol>
<privacyPassword>String value</privacyPassword>
<privacyProtocol>String value</privacyProtocol>
<readCommunity>String value</readCommunity>
<retries>1</retries>
<timeOut>1</timeOut>
<userName>String value</userName>
<version>String value</version>
<writeCommunity>String value</writeCommunity>
</snmpCredentials>
</managementCredentials>
<postPnPConfiguration>
<parameters>
<parameter>
<name>String value</name>
<value>String value</value>
</parameter>
<parameter>
<name>Another string value</name>
<value>Another string value</value>
</parameter>
</parameters>
<templateName>String value</templateName>
</postPnPConfiguration>
<terminalServerDetails>
<terminalServerIP>String value</terminalServerIP>
<terminalServerPort>1</terminalServerPort>
</terminalServerDetails>
</profileInstance>
<profileInstance>
<bootstrap>
<parameters>
<parameter>
<name>String value</name>
<value>String value</value>
</parameter>
<parameter>
<name>Another string value</name>
<value>Another string value</value>
</parameter>
</parameters>
<templateName>Another string value</templateName>
</bootstrap>
<congifuration>
<componentTemplates>
<componentTemplate>
<parameters>
<parameter>
<name>String value</name>
<value>String value</value>
</parameter>
<parameter>
<name>Another string value</name>
<value>Another string value</value>
</parameter>
</parameters>
<templateName>String value</templateName>
</componentTemplate>
<componentTemplate>
<parameters>
<parameter>
<name>String value</name>
<value>String value</value>
</parameter>
<parameter>
<name>Another string value</name>
<value>Another string value</value>
</parameter>
</parameters>
<templateName>Another string value</templateName>
</componentTemplate>
</componentTemplates>
<rawConfig>Another string value</rawConfig>
<templateName>Another string value</templateName>
</congifuration>
<deviceDetails>
<description>Another string value</description>
<pid>Another string value</pid>
<profileInstanceName>Another string value</profileInstanceName>
<serialNumber>Another string value</serialNumber>
</deviceDetails>
<imageProperties>
<imageLocation>Another string value</imageLocation>
<isActivateImageEnabled>false</isActivateImageEnabled>
<isContinueOnFailureEnabled>false</isContinueOnFailureEnabled>
<isEraseFlashEnabled>false</isEraseFlashEnabled>
</imageProperties>
<managementCredentials>
<cliCredentials>
<enablePassword>Another string value</enablePassword>
<password>Another string value</password>
<protocol>Another string value</protocol>
<timeOut>11</timeOut>
<userName>Another string value</userName>
</cliCredentials>
<ipAddressOrDNS>Another string value</ipAddressOrDNS>
<isConfigureManagementCredentialToDevice>false</isConfigureManagementCredentialToDevice>
<snmpCredentials>
<authPassword>Another string value</authPassword>
<authProtocol>Another string value</authProtocol>
<privacyPassword>Another string value</privacyPassword>
<privacyProtocol>Another string value</privacyProtocol>
<readCommunity>Another string value</readCommunity>
<retries>11</retries>
<timeOut>11</timeOut>
<userName>Another string value</userName>
<version>Another string value</version>
<writeCommunity>Another string value</writeCommunity>
</snmpCredentials>
</managementCredentials>
<postPnPConfiguration>
<parameters>
<parameter>
<name>String value</name>
<value>String value</value>
</parameter>
<parameter>
<name>Another string value</name>
<value>Another string value</value>
</parameter>
</parameters>
<templateName>Another string value</templateName>
</postPnPConfiguration>
<terminalServerDetails>
<terminalServerIP>Another string value</terminalServerIP>
<terminalServerPort>11</terminalServerPort>
</terminalServerDetails>
</profileInstance>
</profileInstances>
</profileInstanceList>
Sample JSON Request Payload
https://localhost/webacs/api/v3/op/pnp/profile/sample_profile_name/instance/.json
{
"profileInstanceList" : {
"profileInstances" : {
"profileInstance" : [ {
"bootstrap" : {
"parameters" : {
"parameter" : [ {
"name" : "String value",
"value" : "String value"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
},
"templateName" : "String value"
},
"congifuration" : {
"componentTemplates" : {
"componentTemplate" : [ {
"parameters" : {
"parameter" : [ {
"name" : "String value",
"value" : "String value"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
},
"templateName" : "String value"
}, {
"parameters" : {
"parameter" : [ {
"name" : "String value",
"value" : "String value"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
},
"templateName" : "Another string value"
} ]
},
"rawConfig" : "String value",
"templateName" : "String value"
},
"deviceDetails" : {
"description" : "String value",
"pid" : "String value",
"profileInstanceName" : "String value",
"serialNumber" : "String value"
},
"imageProperties" : {
"imageLocation" : "String value",
"isActivateImageEnabled" : true,
"isContinueOnFailureEnabled" : true,
"isEraseFlashEnabled" : true
},
"managementCredentials" : {
"cliCredentials" : {
"enablePassword" : "String value",
"password" : "String value",
"protocol" : "String value",
"timeOut" : 1,
"userName" : "String value"
},
"ipAddressOrDNS" : "String value",
"isConfigureManagementCredentialToDevice" : true,
"snmpCredentials" : {
"authPassword" : "String value",
"authProtocol" : "String value",
"privacyPassword" : "String value",
"privacyProtocol" : "String value",
"readCommunity" : "String value",
"retries" : 1,
"timeOut" : 1,
"userName" : "String value",
"version" : "String value",
"writeCommunity" : "String value"
}
},
"postPnPConfiguration" : {
"parameters" : {
"parameter" : [ {
"name" : "String value",
"value" : "String value"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
},
"templateName" : "String value"
},
"terminalServerDetails" : {
"terminalServerIP" : "String value",
"terminalServerPort" : 1
}
}, {
"bootstrap" : {
"parameters" : {
"parameter" : [ {
"name" : "String value",
"value" : "String value"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
},
"templateName" : "Another string value"
},
"congifuration" : {
"componentTemplates" : {
"componentTemplate" : [ {
"parameters" : {
"parameter" : [ {
"name" : "String value",
"value" : "String value"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
},
"templateName" : "String value"
}, {
"parameters" : {
"parameter" : [ {
"name" : "String value",
"value" : "String value"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
},
"templateName" : "Another string value"
} ]
},
"rawConfig" : "Another string value",
"templateName" : "Another string value"
},
"deviceDetails" : {
"description" : "Another string value",
"pid" : "Another string value",
"profileInstanceName" : "Another string value",
"serialNumber" : "Another string value"
},
"imageProperties" : {
"imageLocation" : "Another string value",
"isActivateImageEnabled" : false,
"isContinueOnFailureEnabled" : false,
"isEraseFlashEnabled" : false
},
"managementCredentials" : {
"cliCredentials" : {
"enablePassword" : "Another string value",
"password" : "Another string value",
"protocol" : "Another string value",
"timeOut" : 11,
"userName" : "Another string value"
},
"ipAddressOrDNS" : "Another string value",
"isConfigureManagementCredentialToDevice" : false,
"snmpCredentials" : {
"authPassword" : "Another string value",
"authProtocol" : "Another string value",
"privacyPassword" : "Another string value",
"privacyProtocol" : "Another string value",
"readCommunity" : "Another string value",
"retries" : 11,
"timeOut" : 11,
"userName" : "Another string value",
"version" : "Another string value",
"writeCommunity" : "Another string value"
}
},
"postPnPConfiguration" : {
"parameters" : {
"parameter" : [ {
"name" : "String value",
"value" : "String value"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
},
"templateName" : "Another string value"
},
"terminalServerDetails" : {
"terminalServerIP" : "Another string value",
"terminalServerPort" : 11
}
} ]
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v3/op/pnp/profile/sample_profile_name/instance/
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/pnp/profile/sample_profile_name/instance/" rootUrl="https://localhost/webacs/api/v3/op">
<profileInstancesCreateOrUpdateStatus>
<profileInstanceStatuses>
<profileInstanceStatus>
<errors>
<error>String value</error>
<error>Another string value</error>
</errors>
<profileInstanceName>String value</profileInstanceName>
<status>String value</status>
</profileInstanceStatus>
<profileInstanceStatus>
<errors>
<error>String value</error>
<error>Another string value</error>
</errors>
<profileInstanceName>Another string value</profileInstanceName>
<status>Another string value</status>
</profileInstanceStatus>
</profileInstanceStatuses>
</profileInstancesCreateOrUpdateStatus>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/pnp/profile/sample_profile_name/instance/.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/pnp/profile/sample_profile_name/instance/",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"profileInstancesCreateOrUpdateStatus" : [ {
"profileInstanceStatuses" : {
"profileInstanceStatus" : [ {
"errors" : {
"error" : [ "String value", "Another string value" ]
},
"profileInstanceName" : "String value",
"status" : "String value"
}, {
"errors" : {
"error" : [ "String value", "Another string value" ]
},
"profileInstanceName" : "Another string value",
"status" : "Another 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 Credential |
HTTP Methods |
POST |
Resource URL
/webacs/api/v4/op/pnp/profile/{profileName}/instance/ UnmodifiedThis resource has not been modified since the previous API version.
Request Parameters
Attribute | Source | Description |
---|---|---|
profileName String |
path |
Required Name of the profile in which the profile instance to be updated |
Request Payload Parameters
Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Profile Instances. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Response Parameters
Attribute | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
List of Profile Instance Statuses. |
||||||||||
|
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 Request Payload
https://localhost/webacs/api/v4/op/pnp/profile/sample_profile_name/instance/
<?xml version="1.0" ?>
<profileInstanceList>
<profileInstances>
<profileInstance>
<bootstrap>
<parameters>
<parameter>
<name>String value</name>
<value>String value</value>
</parameter>
<parameter>
<name>Another string value</name>
<value>Another string value</value>
</parameter>
</parameters>
<templateName>String value</templateName>
</bootstrap>
<congifuration>
<componentTemplates>
<componentTemplate>
<parameters>
<parameter>
<name>String value</name>
<value>String value</value>
</parameter>
<parameter>
<name>Another string value</name>
<value>Another string value</value>
</parameter>
</parameters>
<templateName>String value</templateName>
</componentTemplate>
<componentTemplate>
<parameters>
<parameter>
<name>String value</name>
<value>String value</value>
</parameter>
<parameter>
<name>Another string value</name>
<value>Another string value</value>
</parameter>
</parameters>
<templateName>Another string value</templateName>
</componentTemplate>
</componentTemplates>
<rawConfig>String value</rawConfig>
<templateName>String value</templateName>
</congifuration>
<deviceDetails>
<description>String value</description>
<pid>String value</pid>
<profileInstanceName>String value</profileInstanceName>
<serialNumber>String value</serialNumber>
</deviceDetails>
<imageProperties>
<imageLocation>String value</imageLocation>
<isActivateImageEnabled>true</isActivateImageEnabled>
<isContinueOnFailureEnabled>true</isContinueOnFailureEnabled>
<isEraseFlashEnabled>true</isEraseFlashEnabled>
</imageProperties>
<managementCredentials>
<cliCredentials>
<enablePassword>String value</enablePassword>
<password>String value</password>
<protocol>String value</protocol>
<timeOut>1</timeOut>
<userName>String value</userName>
</cliCredentials>
<ipAddressOrDNS>String value</ipAddressOrDNS>
<isConfigureManagementCredentialToDevice>true</isConfigureManagementCredentialToDevice>
<snmpCredentials>
<authPassword>String value</authPassword>
<authProtocol>String value</authProtocol>
<privacyPassword>String value</privacyPassword>
<privacyProtocol>String value</privacyProtocol>
<readCommunity>String value</readCommunity>
<retries>1</retries>
<timeOut>1</timeOut>
<userName>String value</userName>
<version>String value</version>
<writeCommunity>String value</writeCommunity>
</snmpCredentials>
</managementCredentials>
<postPnPConfiguration>
<parameters>
<parameter>
<name>String value</name>
<value>String value</value>
</parameter>
<parameter>
<name>Another string value</name>
<value>Another string value</value>
</parameter>
</parameters>
<templateName>String value</templateName>
</postPnPConfiguration>
<terminalServerDetails>
<terminalServerIP>String value</terminalServerIP>
<terminalServerPort>1</terminalServerPort>
</terminalServerDetails>
</profileInstance>
<profileInstance>
<bootstrap>
<parameters>
<parameter>
<name>String value</name>
<value>String value</value>
</parameter>
<parameter>
<name>Another string value</name>
<value>Another string value</value>
</parameter>
</parameters>
<templateName>Another string value</templateName>
</bootstrap>
<congifuration>
<componentTemplates>
<componentTemplate>
<parameters>
<parameter>
<name>String value</name>
<value>String value</value>
</parameter>
<parameter>
<name>Another string value</name>
<value>Another string value</value>
</parameter>
</parameters>
<templateName>String value</templateName>
</componentTemplate>
<componentTemplate>
<parameters>
<parameter>
<name>String value</name>
<value>String value</value>
</parameter>
<parameter>
<name>Another string value</name>
<value>Another string value</value>
</parameter>
</parameters>
<templateName>Another string value</templateName>
</componentTemplate>
</componentTemplates>
<rawConfig>Another string value</rawConfig>
<templateName>Another string value</templateName>
</congifuration>
<deviceDetails>
<description>Another string value</description>
<pid>Another string value</pid>
<profileInstanceName>Another string value</profileInstanceName>
<serialNumber>Another string value</serialNumber>
</deviceDetails>
<imageProperties>
<imageLocation>Another string value</imageLocation>
<isActivateImageEnabled>false</isActivateImageEnabled>
<isContinueOnFailureEnabled>false</isContinueOnFailureEnabled>
<isEraseFlashEnabled>false</isEraseFlashEnabled>
</imageProperties>
<managementCredentials>
<cliCredentials>
<enablePassword>Another string value</enablePassword>
<password>Another string value</password>
<protocol>Another string value</protocol>
<timeOut>11</timeOut>
<userName>Another string value</userName>
</cliCredentials>
<ipAddressOrDNS>Another string value</ipAddressOrDNS>
<isConfigureManagementCredentialToDevice>false</isConfigureManagementCredentialToDevice>
<snmpCredentials>
<authPassword>Another string value</authPassword>
<authProtocol>Another string value</authProtocol>
<privacyPassword>Another string value</privacyPassword>
<privacyProtocol>Another string value</privacyProtocol>
<readCommunity>Another string value</readCommunity>
<retries>11</retries>
<timeOut>11</timeOut>
<userName>Another string value</userName>
<version>Another string value</version>
<writeCommunity>Another string value</writeCommunity>
</snmpCredentials>
</managementCredentials>
<postPnPConfiguration>
<parameters>
<parameter>
<name>String value</name>
<value>String value</value>
</parameter>
<parameter>
<name>Another string value</name>
<value>Another string value</value>
</parameter>
</parameters>
<templateName>Another string value</templateName>
</postPnPConfiguration>
<terminalServerDetails>
<terminalServerIP>Another string value</terminalServerIP>
<terminalServerPort>11</terminalServerPort>
</terminalServerDetails>
</profileInstance>
</profileInstances>
</profileInstanceList>
Sample JSON Request Payload
https://localhost/webacs/api/v4/op/pnp/profile/sample_profile_name/instance/.json
{
"profileInstanceList" : {
"profileInstances" : {
"profileInstance" : [ {
"bootstrap" : {
"parameters" : {
"parameter" : [ {
"name" : "String value",
"value" : "String value"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
},
"templateName" : "String value"
},
"congifuration" : {
"componentTemplates" : {
"componentTemplate" : [ {
"parameters" : {
"parameter" : [ {
"name" : "String value",
"value" : "String value"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
},
"templateName" : "String value"
}, {
"parameters" : {
"parameter" : [ {
"name" : "String value",
"value" : "String value"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
},
"templateName" : "Another string value"
} ]
},
"rawConfig" : "String value",
"templateName" : "String value"
},
"deviceDetails" : {
"description" : "String value",
"pid" : "String value",
"profileInstanceName" : "String value",
"serialNumber" : "String value"
},
"imageProperties" : {
"imageLocation" : "String value",
"isActivateImageEnabled" : true,
"isContinueOnFailureEnabled" : true,
"isEraseFlashEnabled" : true
},
"managementCredentials" : {
"cliCredentials" : {
"enablePassword" : "String value",
"password" : "String value",
"protocol" : "String value",
"timeOut" : 1,
"userName" : "String value"
},
"ipAddressOrDNS" : "String value",
"isConfigureManagementCredentialToDevice" : true,
"snmpCredentials" : {
"authPassword" : "String value",
"authProtocol" : "String value",
"privacyPassword" : "String value",
"privacyProtocol" : "String value",
"readCommunity" : "String value",
"retries" : 1,
"timeOut" : 1,
"userName" : "String value",
"version" : "String value",
"writeCommunity" : "String value"
}
},
"postPnPConfiguration" : {
"parameters" : {
"parameter" : [ {
"name" : "String value",
"value" : "String value"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
},
"templateName" : "String value"
},
"terminalServerDetails" : {
"terminalServerIP" : "String value",
"terminalServerPort" : 1
}
}, {
"bootstrap" : {
"parameters" : {
"parameter" : [ {
"name" : "String value",
"value" : "String value"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
},
"templateName" : "Another string value"
},
"congifuration" : {
"componentTemplates" : {
"componentTemplate" : [ {
"parameters" : {
"parameter" : [ {
"name" : "String value",
"value" : "String value"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
},
"templateName" : "String value"
}, {
"parameters" : {
"parameter" : [ {
"name" : "String value",
"value" : "String value"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
},
"templateName" : "Another string value"
} ]
},
"rawConfig" : "Another string value",
"templateName" : "Another string value"
},
"deviceDetails" : {
"description" : "Another string value",
"pid" : "Another string value",
"profileInstanceName" : "Another string value",
"serialNumber" : "Another string value"
},
"imageProperties" : {
"imageLocation" : "Another string value",
"isActivateImageEnabled" : false,
"isContinueOnFailureEnabled" : false,
"isEraseFlashEnabled" : false
},
"managementCredentials" : {
"cliCredentials" : {
"enablePassword" : "Another string value",
"password" : "Another string value",
"protocol" : "Another string value",
"timeOut" : 11,
"userName" : "Another string value"
},
"ipAddressOrDNS" : "Another string value",
"isConfigureManagementCredentialToDevice" : false,
"snmpCredentials" : {
"authPassword" : "Another string value",
"authProtocol" : "Another string value",
"privacyPassword" : "Another string value",
"privacyProtocol" : "Another string value",
"readCommunity" : "Another string value",
"retries" : 11,
"timeOut" : 11,
"userName" : "Another string value",
"version" : "Another string value",
"writeCommunity" : "Another string value"
}
},
"postPnPConfiguration" : {
"parameters" : {
"parameter" : [ {
"name" : "String value",
"value" : "String value"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
},
"templateName" : "Another string value"
},
"terminalServerDetails" : {
"terminalServerIP" : "Another string value",
"terminalServerPort" : 11
}
} ]
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v4/op/pnp/profile/sample_profile_name/instance/
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/pnp/profile/sample_profile_name/instance/" rootUrl="https://localhost/webacs/api/v4/op">
<profileInstancesCreateOrUpdateStatus>
<profileInstanceStatuses>
<profileInstanceStatus>
<errors>
<error>String value</error>
<error>Another string value</error>
</errors>
<profileInstanceName>String value</profileInstanceName>
<status>String value</status>
</profileInstanceStatus>
<profileInstanceStatus>
<errors>
<error>String value</error>
<error>Another string value</error>
</errors>
<profileInstanceName>Another string value</profileInstanceName>
<status>Another string value</status>
</profileInstanceStatus>
</profileInstanceStatuses>
</profileInstancesCreateOrUpdateStatus>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v4/op/pnp/profile/sample_profile_name/instance/.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/pnp/profile/sample_profile_name/instance/",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v4/op",
"profileInstancesCreateOrUpdateStatus" : [ {
"profileInstanceStatuses" : {
"profileInstanceStatus" : [ {
"errors" : {
"error" : [ "String value", "Another string value" ]
},
"profileInstanceName" : "String value",
"status" : "String value"
}, {
"errors" : {
"error" : [ "String value", "Another string value" ]
},
"profileInstanceName" : "Another string value",
"status" : "Another string value"
} ]
}
} ]
}
}