Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

POST pnp/profile/{profileName}/instance/

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 Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Credential

HTTP Methods

POST

DevNet Discussions

Resource URL

/webacs/api/v4/op/pnp/profile/{profileName}/instance/

Unmodified

This resource has not been modified since the previous API version.

Request Parameters

Attribute Source Description

profileName String

path

RequiredName of the profile in which the profile instance to be updated

Request Payload Parameters

Attribute Description

profileInstances ProfileInstance[]

Profile Instances.

Response Parameters

Attribute Description

profileInstanceStatuses ProfileInstanceStatus[]

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"
        } ]
      }
    } ]
  }
}