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
Resource URL
/webacs/api/v1/op/pnp/profile/{profileName}/instance/Request Parameters
Type | Attribute Name | Source | Description |
---|---|---|---|
String |
profileName required |
path |
Name of the profile in which the profile instance to be updated |
Request Payload Parameters
Type | Attribute Name | Description |
---|---|---|
profileInstances |
Profile Instances. |
Response Parameters
Type | Attribute Name | Description |
---|---|---|
profileInstanceStatuses |
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://172.25.123.114/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://172.25.123.114/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://172.25.123.114/webacs/api/v1/op/pnp/profile/sample_profile_name/instance/
<?xml version="1.0" ?> <mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v1/op/pnp/profile/sample_profile_name/instance/" rootUrl="https://172.25.123.114/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://172.25.123.114/webacs/api/v1/op/pnp/profile/sample_profile_name/instance/.json
{ "mgmtResponse" : { "@responseType" : "operation", "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/pnp\/profile\/sample_profile_name\/instance\/", "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/", "profileInstancesCreateOrUpdateStatus" : { "profileInstanceStatuses" : { "profileInstanceStatus" : { "errors" : { "error" : "String value" }, "profileInstanceName" : "String value", "status" : "String value" } } } } }