Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

PUT credentialProfilesManagement/credentialProfiles

Updates an existing credential profile. Profile name is used to identify the credential profile to be edited. After updating the profile, you can synchronize devices using the POST op/devices/syncDevices resource.

Since Product Version: 3.2

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

PUT

Resource URL

/webacs/api/v2/op/credentialProfilesManagement/credentialProfiles

Unmodified

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

Request Payload Parameters

Attribute Description

cliParameters Arrow image CliParametersDTO

The CLI parameters.

description String

The description of the credential profile.

httpParameters Arrow image HttpParametersDTO

The http/https parameters.

profileName String

The name of the credential profile. This field is mandatory.

snmpParameters Arrow image SnmpParametersDTO

The SNMP parameters.

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/credentialProfilesManagement/credentialProfiles

<?xml version="1.0" ?>
<credentialProfilesDTO>
  <cliParameters>
    <cliEnablePassword>String value</cliEnablePassword>
    <cliPassword>String value</cliPassword>
    <cliPort>15</cliPort>
    <cliProtocol>TELNET</cliProtocol>
    <cliTimeout>15</cliTimeout>
    <cliUsername>String value</cliUsername>
  </cliParameters>
  <description>String value</description>
  <httpParameters>
    <httpMonitorPassword>String value</httpMonitorPassword>
    <httpMonitorUsername>String value</httpMonitorUsername>
    <httpPassword>String value</httpPassword>
    <httpPort>15</httpPort>
    <httpProtocol>HTTP</httpProtocol>
    <httpUsername>String value</httpUsername>
  </httpParameters>
  <profileName>String value</profileName>
  <snmpParameters>
    <readCommunity>String value</readCommunity>
    <snmpPort>15</snmpPort>
    <snmpRetries>15</snmpRetries>
    <snmpTimeout>15</snmpTimeout>
    <snmpV3AuthPassword>String value</snmpV3AuthPassword>
    <snmpV3AuthType>NONE</snmpV3AuthType>
    <snmpV3PrivacyPassword>String value</snmpV3PrivacyPassword>
    <snmpV3PrivacyType>NONE</snmpV3PrivacyType>
    <snmpV3Username>String value</snmpV3Username>
    <snmpVersion>V1</snmpVersion>
    <writeCommunity>String value</writeCommunity>
  </snmpParameters>
</credentialProfilesDTO>

Sample JSON Request Payload

https://localhost/webacs/api/v2/op/credentialProfilesManagement/credentialProfiles.json

{
  "credentialProfilesDTO" : {
    "cliParameters" : {
      "cliEnablePassword" : "String value",
      "cliPassword" : "String value",
      "cliPort" : 15,
      "cliProtocol" : "TELNET",
      "cliTimeout" : 15,
      "cliUsername" : "String value"
    },
    "description" : "String value",
    "httpParameters" : {
      "httpMonitorPassword" : "String value",
      "httpMonitorUsername" : "String value",
      "httpPassword" : "String value",
      "httpPort" : 15,
      "httpProtocol" : "HTTP",
      "httpUsername" : "String value"
    },
    "profileName" : "String value",
    "snmpParameters" : {
      "readCommunity" : "String value",
      "snmpPort" : 15,
      "snmpRetries" : 15,
      "snmpTimeout" : 15,
      "snmpV3AuthPassword" : "String value",
      "snmpV3AuthType" : "NONE",
      "snmpV3PrivacyPassword" : "String value",
      "snmpV3PrivacyType" : "NONE",
      "snmpV3Username" : "String value",
      "snmpVersion" : "V1",
      "writeCommunity" : "String value"
    }
  }
}