Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET pnp/profile/{profileName}/instance/

Takes PnP Profile Name as rest parameter. It returns the set of all Profile Instances of the passed PnP Profile.

Since Product Version: 3.1

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Credential

HTTP Methods

GET

DevNet Discussions

Resource URL

/webacs/api/v3/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

RequiredThe profile name of the profile to be read

Response Parameters

Attribute Description

profileInstances ProfileInstance[]

Profile Instances.

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/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">
  <profileInstanceList>
    <profileInstances>
      <profileInstance>
        <bootstrap>
          <parameters>
            <parameter>
              <name>String value</name>
              <value>String value</value>
            </parameter>
            <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>
                <parameter>
                  <name>String value</name>
                  <value>String value</value>
                </parameter>
              </parameters>
              <templateName>String value</templateName>
            </componentTemplate>
            <componentTemplate>
              <parameters>
                <parameter>
                  <name>String value</name>
                  <value>String value</value>
                </parameter>
                <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>
            <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>
      <profileInstance>
        <bootstrap>
          <parameters>
            <parameter>
              <name>String value</name>
              <value>String value</value>
            </parameter>
            <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>
                <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>
            <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>
</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",
    "profileInstanceList" : [ {
      "profileInstances" : {
        "profileInstance" : [ {
          "bootstrap" : {
            "parameters" : {
              "parameter" : [ {
                "name" : "String value",
                "value" : "String value"
              }, {
                "name" : "String value",
                "value" : "String value"
              } ]
            },
            "templateName" : "String value"
          },
          "congifuration" : {
            "componentTemplates" : {
              "componentTemplate" : [ {
                "parameters" : {
                  "parameter" : [ {
                    "name" : "String value",
                    "value" : "String value"
                  }, {
                    "name" : "String value",
                    "value" : "String value"
                  } ]
                },
                "templateName" : "String value"
              }, {
                "parameters" : {
                  "parameter" : [ {
                    "name" : "String value",
                    "value" : "String value"
                  }, {
                    "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"
              }, {
                "name" : "String value",
                "value" : "String value"
              } ]
            },
            "templateName" : "String value"
          },
          "terminalServerDetails" : {
            "terminalServerIP" : "String value",
            "terminalServerPort" : 1
          }
        }, {
          "bootstrap" : {
            "parameters" : {
              "parameter" : [ {
                "name" : "String value",
                "value" : "String value"
              }, {
                "name" : "String value",
                "value" : "String value"
              } ]
            },
            "templateName" : "String value"
          },
          "congifuration" : {
            "componentTemplates" : {
              "componentTemplate" : [ {
                "parameters" : {
                  "parameter" : [ {
                    "name" : "String value",
                    "value" : "String value"
                  }, {
                    "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"
              }, {
                "name" : "String value",
                "value" : "String value"
              } ]
            },
            "templateName" : "String value"
          },
          "terminalServerDetails" : {
            "terminalServerIP" : "String value",
            "terminalServerPort" : 1
          }
        } ]
      }
    } ]
  }
}