Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/aaa/tacacsPlusServer
Request Payload Parameters
authenticationType
AuthenticationTypeEnum
|
Required
Authentication method (can be PAP or CHAP)
|
localInterfaceIp
InetAddress
|
Required
IP address of the local interface
|
numberOfTries
int
|
Required
The number of attempts to access the server. Value should be in the range of 0 and 3
|
port
int
|
Required
IP port of the TACACS+ server. Value should be in the range of 1 and 65535
|
retransmitTimeout
int
|
Required
The delay between attempts in seconds. Value should be in the range of 2 and 15
|
secretKey
String
|
Required
Secret key (can be ASCII or HEX)
|
secretKeyType
SecretKeyTypeEnum
|
Required
Type of the secret key (ASCII or HEX)
|
serverHostName
String
|
FQDN of the TACACS+ server. Either serverIp or serverHostName is required.
|
serverIp
InetAddress
|
IP address of the TACACS+ server. Either serverIp or serverHostName is required.
|
Response Parameters
operationSucceeded
boolean
|
A flag of a successful operation
|
resultMessage
String
|
Description of the operation result
|
server
TACACSPlusServer
|
TACACS+ server data from the parameters
|
authenticationType
AuthenticationTypeEnum
|
Authentication method (can be PAP or CHAP)
|
localInterfaceIp
InetAddress
|
IP address of the local interface
|
numberOfTries
int
|
The number of attempts to access the server. Value should be in the range of 0 and 3
|
port
int
|
IP port of the TACACS+ server. Value should be in the range of 1 and 65535
|
retransmitTimeout
int
|
The delay between attempts in seconds. Value should be in the range of 2 and 15
|
secretKey
String
|
Secret key (can be ASCII or HEX)
|
secretKeyType
SecretKeyTypeEnum
|
Type of the secret key (ASCII or HEX)
|
serverHostName
String
|
FQDN of the TACACS+ server. Either serverIp or serverHostName is required.
|
serverIp
InetAddress
|
IP address of the TACACS+ server. Either serverIp or serverHostName is required.
|
|
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.20.127.108/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>
<serverHostName>String value</serverHostName>
<serverIp>
<address>192.168.115.243</address>
</serverIp>
</tacacsPlusServer>
Sample JSON Request Payload
https://172.20.127.108/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",
"serverHostName" : "String value",
"serverIp" : {
"address" : "192.168.115.243"
}
}
}
Sample XML Response Payload
https://172.20.127.108/webacs/api/v1/op/aaa/tacacsPlusServer
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/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>
<serverHostName>String value</serverHostName>
<serverIp>
<address>192.168.115.243</address>
</serverIp>
</server>
</serverResultItem>
</mgmtResponse>
Sample JSON Response Payload
https://172.20.127.108/webacs/api/v1/op/aaa/tacacsPlusServer.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/op\/aaa\/tacacsPlusServer",
"@rootUrl" : "https : \/\/172.20.127.108\/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",
"serverHostName" : "String value",
"serverIp" : {
"address" : "192.168.115.243"
}
}
}
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/aaa/tacacsPlusServer
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
authenticationType
AuthenticationTypeEnum
|
Required
Authentication method (can be PAP or CHAP)
|
localInterfaceIp
InetAddress
|
Required
IP address of the local interface
|
numberOfTries
int
|
Required
The number of attempts to access the server. Value should be in the range of 0 and 3
|
port
int
|
Required
IP port of the TACACS+ server. Value should be in the range of 1 and 65535
|
retransmitTimeout
int
|
Required
The delay between attempts in seconds. Value should be in the range of 2 and 15
|
secretKey
String
|
Required
Secret key (can be ASCII or HEX)
|
secretKeyType
SecretKeyTypeEnum
|
Required
Type of the secret key (ASCII or HEX)
|
serverHostName
String
|
FQDN of the TACACS+ server. Either serverIp or serverHostName is required.
|
serverIp
InetAddress
|
IP address of the TACACS+ server. Either serverIp or serverHostName is required.
|
Response Parameters
operationSucceeded
boolean
|
A flag of a successful operation
|
resultMessage
String
|
Description of the operation result
|
server
TACACSPlusServer
|
TACACS+ server data from the parameters
|
authenticationType
AuthenticationTypeEnum
|
Authentication method (can be PAP or CHAP)
|
localInterfaceIp
InetAddress
|
IP address of the local interface
|
numberOfTries
int
|
The number of attempts to access the server. Value should be in the range of 0 and 3
|
port
int
|
IP port of the TACACS+ server. Value should be in the range of 1 and 65535
|
retransmitTimeout
int
|
The delay between attempts in seconds. Value should be in the range of 2 and 15
|
secretKey
String
|
Secret key (can be ASCII or HEX)
|
secretKeyType
SecretKeyTypeEnum
|
Type of the secret key (ASCII or HEX)
|
serverHostName
String
|
FQDN of the TACACS+ server. Either serverIp or serverHostName is required.
|
serverIp
InetAddress
|
IP address of the TACACS+ server. Either serverIp or serverHostName is required.
|
|
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.20.127.108/webacs/api/v2/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>
<serverHostName>String value</serverHostName>
<serverIp>
<address>192.168.115.243</address>
</serverIp>
</tacacsPlusServer>
Sample JSON Request Payload
https://172.20.127.108/webacs/api/v2/op/aaa/tacacsPlusServer.json
{
"tacacsPlusServer" : {
"authenticationType" : "PAP",
"localInterfaceIp" : {
"address" : "192.168.115.243"
},
"numberOfTries" : 1,
"port" : 1,
"retransmitTimeout" : 1,
"secretKey" : "String value",
"secretKeyType" : "ASCII",
"serverHostName" : "String value",
"serverIp" : {
"address" : "192.168.115.243"
}
}
}
Sample XML Response Payload
https://172.20.127.108/webacs/api/v2/op/aaa/tacacsPlusServer
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v2/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>
<serverHostName>String value</serverHostName>
<serverIp>
<address>192.168.115.243</address>
</serverIp>
</server>
</serverResultItem>
</mgmtResponse>
Sample JSON Response Payload
https://172.20.127.108/webacs/api/v2/op/aaa/tacacsPlusServer.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://172.20.127.108/webacs/api/v2/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",
"serverHostName" : "String value",
"serverIp" : {
"address" : "192.168.115.243"
}
}
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/aaa/tacacsPlusServer
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
authenticationType
AuthenticationTypeEnum
|
Required
Authentication method (can be PAP or CHAP)
|
localInterfaceIp
InetAddress
|
Required
IP address of the local interface
|
numberOfTries
int
|
Required
The number of attempts to access the server. Value should be in the range of 0 and 3
|
port
int
|
Required
IP port of the TACACS+ server. Value should be in the range of 1 and 65535
|
retransmitTimeout
int
|
Required
The delay between attempts in seconds. Value should be in the range of 2 and 15
|
secretKey
String
|
Required
Secret key (can be ASCII or HEX)
|
secretKeyType
SecretKeyTypeEnum
|
Required
Type of the secret key (ASCII or HEX)
|
serverHostName
String
|
FQDN of the TACACS+ server. Either serverIp or serverHostName is required.
|
serverIp
InetAddress
|
IP address of the TACACS+ server. Either serverIp or serverHostName is required.
|
Response Parameters
operationSucceeded
boolean
|
A flag of a successful operation
|
resultMessage
String
|
Description of the operation result
|
server
TACACSPlusServer
|
TACACS+ server data from the parameters
|
authenticationType
AuthenticationTypeEnum
|
Authentication method (can be PAP or CHAP)
|
localInterfaceIp
InetAddress
|
IP address of the local interface
|
numberOfTries
int
|
The number of attempts to access the server. Value should be in the range of 0 and 3
|
port
int
|
IP port of the TACACS+ server. Value should be in the range of 1 and 65535
|
retransmitTimeout
int
|
The delay between attempts in seconds. Value should be in the range of 2 and 15
|
secretKey
String
|
Secret key (can be ASCII or HEX)
|
secretKeyType
SecretKeyTypeEnum
|
Type of the secret key (ASCII or HEX)
|
serverHostName
String
|
FQDN of the TACACS+ server. Either serverIp or serverHostName is required.
|
serverIp
InetAddress
|
IP address of the TACACS+ server. Either serverIp or serverHostName is required.
|
|
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.20.127.108/webacs/api/v3/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>
<serverHostName>String value</serverHostName>
<serverIp>
<address>192.168.115.243</address>
</serverIp>
</tacacsPlusServer>
Sample JSON Request Payload
https://172.20.127.108/webacs/api/v3/op/aaa/tacacsPlusServer.json
{
"tacacsPlusServer" : {
"authenticationType" : "PAP",
"localInterfaceIp" : {
"address" : "192.168.115.243"
},
"numberOfTries" : 1,
"port" : 1,
"retransmitTimeout" : 1,
"secretKey" : "String value",
"secretKeyType" : "ASCII",
"serverHostName" : "String value",
"serverIp" : {
"address" : "192.168.115.243"
}
}
}
Sample XML Response Payload
https://172.20.127.108/webacs/api/v3/op/aaa/tacacsPlusServer
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v3/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>
<serverHostName>String value</serverHostName>
<serverIp>
<address>192.168.115.243</address>
</serverIp>
</server>
</serverResultItem>
</mgmtResponse>
Sample JSON Response Payload
https://172.20.127.108/webacs/api/v3/op/aaa/tacacsPlusServer.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://172.20.127.108/webacs/api/v3/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",
"serverHostName" : "String value",
"serverIp" : {
"address" : "192.168.115.243"
}
}
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/aaa/tacacsPlusServer
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
authenticationType
AuthenticationTypeEnum
|
Required
Authentication method (can be PAP or CHAP)
|
localInterfaceIp
InetAddress
|
Required
IP address of the local interface
|
numberOfTries
int
|
Required
The number of attempts to access the server. Value should be in the range of 0 and 3
|
port
int
|
Required
IP port of the TACACS+ server. Value should be in the range of 1 and 65535
|
retransmitTimeout
int
|
Required
The delay between attempts in seconds. Value should be in the range of 2 and 15
|
secretKey
String
|
Required
Secret key (can be ASCII or HEX)
|
secretKeyType
SecretKeyTypeEnum
|
Required
Type of the secret key (ASCII or HEX)
|
serverHostName
String
|
FQDN of the TACACS+ server. Either serverIp or serverHostName is required.
|
serverIp
InetAddress
|
IP address of the TACACS+ server. Either serverIp or serverHostName is required.
|
Response Parameters
operationSucceeded
boolean
|
A flag of a successful operation
|
resultMessage
String
|
Description of the operation result
|
server
TACACSPlusServer
|
TACACS+ server data from the parameters
|
authenticationType
AuthenticationTypeEnum
|
Authentication method (can be PAP or CHAP)
|
localInterfaceIp
InetAddress
|
IP address of the local interface
|
numberOfTries
int
|
The number of attempts to access the server. Value should be in the range of 0 and 3
|
port
int
|
IP port of the TACACS+ server. Value should be in the range of 1 and 65535
|
retransmitTimeout
int
|
The delay between attempts in seconds. Value should be in the range of 2 and 15
|
secretKey
String
|
Secret key (can be ASCII or HEX)
|
secretKeyType
SecretKeyTypeEnum
|
Type of the secret key (ASCII or HEX)
|
serverHostName
String
|
FQDN of the TACACS+ server. Either serverIp or serverHostName is required.
|
serverIp
InetAddress
|
IP address of the TACACS+ server. Either serverIp or serverHostName is required.
|
|
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.20.127.108/webacs/api/v4/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>
<serverHostName>String value</serverHostName>
<serverIp>
<address>192.168.115.243</address>
</serverIp>
</tacacsPlusServer>
Sample JSON Request Payload
https://172.20.127.108/webacs/api/v4/op/aaa/tacacsPlusServer.json
{
"tacacsPlusServer" : {
"authenticationType" : "PAP",
"localInterfaceIp" : {
"address" : "192.168.115.243"
},
"numberOfTries" : 1,
"port" : 1,
"retransmitTimeout" : 1,
"secretKey" : "String value",
"secretKeyType" : "ASCII",
"serverHostName" : "String value",
"serverIp" : {
"address" : "192.168.115.243"
}
}
}
Sample XML Response Payload
https://172.20.127.108/webacs/api/v4/op/aaa/tacacsPlusServer
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v4/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>
<serverHostName>String value</serverHostName>
<serverIp>
<address>192.168.115.243</address>
</serverIp>
</server>
</serverResultItem>
</mgmtResponse>
Sample JSON Response Payload
https://172.20.127.108/webacs/api/v4/op/aaa/tacacsPlusServer.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://172.20.127.108/webacs/api/v4/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",
"serverHostName" : "String value",
"serverIp" : {
"address" : "192.168.115.243"
}
}
} ]
}
}