Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

PUT aaa/tacacsPlusServer

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Response Formats

xml

json

User Group

NBI Credential

HTTP Methods

PUT

Update an existing TACACS+ server. The serverIp attribute must match the existing server to be modified, and cannot be changed.

Since Product Version: 3.0

Resource URL

/webacs/api/v1/op/aaa/tacacsPlusServer

Request Payload Parameters

Type Attribute Name Description

AuthenticationTypeEnum

authenticationType

Authentication method (can be PAP or CHAP)

Allowed values:

  • PAP
  • CHAP

InetAddress

localInterfaceIp

IP address of the local interface

int

numberOfTries

The number of attempts to access the server. Value should be in the range of 0 and 3

int

port

IP port of the TACACS+ server. Value should be in the range of 1 and 65535

int

retransmitTimeout

The delay between attempts in seconds. Value should be in the range of 2 and 15

String

secretKey

Secret key (can be ASCII or HEX)

SecretKeyTypeEnum

secretKeyType

Type of the secret key (ASCII or HEX)

Allowed values:

  • ASCII
  • HEX

InetAddress

serverIp

IP address of the TACACS+ server

Response Parameters

Type Attribute Name Description

boolean

operationSucceeded

A flag of a successful operation

String

resultMessage

Description of the operation result

TACACSPlusServer

server

TACACS+ server data from the 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://172.25.123.114/webacs/api/v1/op/aaa/tacacsPlusServer

<?xml version="1.0" ?>
<tacacsPlusServer>
  <authenticationType>PAP</authenticationType>
  <localInterfaceIp>
    <address>192.168.115.243</address>
  </localInterfaceIp>
  <numberOfTries>1</numberOfTries>
  <port>1</port>
  <retransmitTimeout>1</retransmitTimeout>
  <secretKey>String value</secretKey>
  <secretKeyType>ASCII</secretKeyType>
  <serverIp>
    <address>192.168.115.243</address>
  </serverIp>
</tacacsPlusServer>

Sample JSON Request Payload

https://172.25.123.114/webacs/api/v1/op/aaa/tacacsPlusServer.json

{
  "tacacsPlusServer" : {
    "authenticationType" : "PAP",
    "localInterfaceIp" : {
      "address" : "192.168.115.243"
    },
    "numberOfTries" : 1,
    "port" : 1,
    "retransmitTimeout" : 1,
    "secretKey" : "String value",
    "secretKeyType" : "ASCII",
    "serverIp" : {
      "address" : "192.168.115.243"
    }
  }
}

Sample XML Response Payload

https://172.25.123.114/webacs/api/v1/op/aaa/tacacsPlusServer

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.25.123.114/webacs/api/v1/op/">
  <serverResultItem>
    <operationSucceeded>true</operationSucceeded>
    <resultMessage>String value</resultMessage>
    <server>
      <authenticationType>PAP</authenticationType>
      <localInterfaceIp>
        <address>192.168.115.243</address>
      </localInterfaceIp>
      <numberOfTries>1</numberOfTries>
      <port>1</port>
      <retransmitTimeout>1</retransmitTimeout>
      <secretKey>String value</secretKey>
      <secretKeyType>ASCII</secretKeyType>
      <serverIp>
        <address>192.168.115.243</address>
      </serverIp>
    </server>
  </serverResultItem>
</mgmtResponse>

Sample JSON Response Payload

https://172.25.123.114/webacs/api/v1/op/aaa/tacacsPlusServer.json

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/aaa\/tacacsPlusServer",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/",
    "serverResultItem" : {
      "operationSucceeded" : true,
      "resultMessage" : "String value",
      "server" : {
        "authenticationType" : "PAP",
        "localInterfaceIp" : {
          "address" : "192.168.115.243"
        },
        "numberOfTries" : 1,
        "port" : 1,
        "retransmitTimeout" : 1,
        "secretKey" : "String value",
        "secretKeyType" : "ASCII",
        "serverIp" : {
          "address" : "192.168.115.243"
        }
      }
    }
  }
}