Beruflich Dokumente
Kultur Dokumente
b y
D e s i g n
aXAPI Reference
Document No.: D-030-01-00-0010
Ver. 2.4.3 6/21/2010
Headquarters
A10 Networks, Inc.
2309 Bering Dr.
San Jose, CA 95131-1125 USA
Tel: +1-408-325-8668 (main)
Tel: +1-408-325-8676 (support)
Fax: +1-408-325-8666
www.a10networks.com
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
3 of 124
Audience
This document is for network architects for determining applicability and
planning implementation, and for system administrators for provisioning
and maintenance of A10 Networks AX Series devices.
4 of 124
P e r f o r m a n c e
b y
D e s i g n
Introduction
19
authenticate ........................................................................................................................................... 19
session.close ......................................................................................................................................... 20
21
slb.server.getAll ..................................................................................................................................... 21
slb.server.search .................................................................................................................................... 24
slb.server.fetchAllStatistics .................................................................................................................... 25
slb.server.fetchStatistics ........................................................................................................................ 27
slb.server.create .................................................................................................................................... 29
slb.server.update ................................................................................................................................... 31
slb.server.delete ..................................................................................................................................... 31
slb.server.deleteAll ................................................................................................................................. 32
slb.server.deletePort .............................................................................................................................. 33
slb.server.deleteAllPorts ........................................................................................................................ 34
37
slb.service-group.getAll .......................................................................................................................... 37
slb.service-group.getByName ................................................................................................................ 39
slb.service-group.fetchAllStatistics ........................................................................................................ 42
slb.service-group.fetchStatisticsByName ............................................................................................... 45
slb.service-group.create ......................................................................................................................... 47
slb.service-group.update ........................................................................................................................ 49
slb.service-group.delete ......................................................................................................................... 51
slb.service-group.deleteAll ..................................................................................................................... 51
slb.service-group.deleteMember ............................................................................................................ 52
slb.service-group.deleteAllMembers ...................................................................................................... 53
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
5 of 124
55
slb.vip.getAll .......................................................................................................................................... 55
slb.vip.search ......................................................................................................................................... 61
slb.vip.fetchAllStatistics ......................................................................................................................... 62
slb.vip.fetchStatistics ............................................................................................................................. 64
slb.vip.create ......................................................................................................................................... 65
slb.vip.update ........................................................................................................................................ 72
slb.vip.delete .......................................................................................................................................... 74
slb.vip.deleteAll ...................................................................................................................................... 75
slb.vip.deleteService .............................................................................................................................. 76
slb.vip.deleteAllServices ........................................................................................................................ 77
79
network.interface.fetchAllStatistics ........................................................................................................ 79
network.interface.fetchStatisticsByInterfaceNum .................................................................................. 82
85
6 of 124
P e r f o r m a n c e
b y
D e s i g n
115
Error Messages
P e r f o r m a n c e
119
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
7 of 124
8 of 124
P e r f o r m a n c e
b y
D e s i g n
Introduction
This document describes the AX Series XML Application Programming
Interface (aXAPI). The aXAPI enables you to use custom third-party applications to configure and monitor Server Load Balancing (SLB) parameters
on the AX device, and to monitor Ethernet interfaces.
aXAPI Architecture
The aXAPI is based on the Representational State Transfer (REST) architecture. The aXAPI uses the HTTPS transportation protocol with the
request/response model to exchange data over HTTPS.
Figure 1 shows a typical aXAPI session flow.
FIGURE 1
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
9 of 124
Request Format
A properly formatted request to the aXAPI is a URI string that consists of a
request header and a request body. The request can be sent as an HTTP or
HTTPS GET or POST action.
Note:
10 of 124
P e r f o r m a n c e
b y
D e s i g n
Request Delimiters
aXAPI requests use the delimiters described in Table 1. The delimiters are
shown in bold type in the example above.
TABLE 1
Delimiter
&
Description
Separates the header from the body.
Separates each parameter.
Note: For simplicity, each parameter is shown on a separate line in the example above. In a
properly formatted request, there are no blank spaces or line breaks. (See Syntax Rules on
page 12.)
Separates a parameter name and its group of values.
Note: The = delimiter is not equivalent to %02. The aXAPI interprets them differently.
Attempting to substitute one delimiter for the other will result in an error.
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
11 of 124
Delimiter
%03
Description
Separates a parameter value and its setting.
%02
Note: If your application does not use a web browser to send the request, you must use (char)3
instead of %03.
For parameters that have multiple values, separates each setting.
Note: If your application does not use a web browser to send the request, you must use (char)2
instead of %02.
Syntax Rules
The parameter values can not contain any special characters (#, $, & and so
on) or control characters (blank spaces, soft or hard line breaks, tabs, backspace, and so on).
Note:
Line breaks were added to the example above for readability. An actual
request can not use line breaks.
Parameters are not sequence-sensitive. They can appear in any order in the
request.
To delete a parameter or set it to its null (unconfigured) setting, include the
parameter name but do not enter anything after the = delimiter. (See Deleting Parameter Settings on page 15.)
Response Format
The aXAPI uses the REST response format.
All responses are encoded in UTF-8.
The time is expressed in Unix epoch time format.
List responses with zero elements include an empty container element
12 of 124
P e r f o r m a n c e
b y
D e s i g n
Example Session
The following requests and responses represent a simple aXAPI session.
The first request is an authentication request, to which the aXAPI replies
with a session ID. The next request configures a virtual server.
Authentication Request:
https://192.168.100.140/services/rest/V1/?method=authenticate&username=admin&password=a10
In this example, the request is for a session ID to use with each subsequent request in the session.
Response:
<?xml version="1.0" encoding="utf-8" ?>
<response status="ok">
<session_id>XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</session_id>
</response>
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
13 of 124
abled).
service1 This parameter defines settings that are not specific to the
service type, for service1. In this example, the type parameter specifies
the service type (14, which is HTTP), port specifies the protocol port
14 of 124
P e r f o r m a n c e
b y
D e s i g n
service2 This parameter defines settings that are not specific to the
Response:
<?xml version="1.0" encoding="utf-8" ?>
<response status="ok">
</response>
This response indicates that the request was executed, with no errors. The
virtual server has been added to the AX devices configuration.
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
15 of 124
A10 Networks recommends that applications use the error codes rather
than the error text to detect and handle errors, because the message text
may change over time.
occurs.
999 The admin username or password sent with an authentication
16 of 124
P e r f o r m a n c e
b y
D e s i g n
For a list of the error messages, see Error Messages on page 119.
Session Timeout
By default, an idle aXAPI session times out after 10 minutes. You can
change the timeout using the AX command-line interface (CLI) or graphical
user interface (GUI). The aXAPI timeout can be 0-60 minutes. If you specify 0, sessions never time out.
To display and configure the aXAPI session timeout, use either of the following methods.
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
17 of 124
18 of 124
P e r f o r m a n c e
b y
D e s i g n
authenticate
Description
Request
TABLE 2
Request Parameters
Parameter
Name
username
password
Description
Admin username for access to the AX device.
Password for the admin username.
Data Type
String
String
Range
N/A
N/A
Default
N/A
N/A
HTTP Action
GET or POST
Response
The AX device authenticates the session based on the username and password. If authentication is successful, the AX device response includes a session ID. Each subsequent request must include the session ID as part of the
request.
The session ID is valid until the session times out or the third-party application sends a session close request (see session.close on page 20).
Version
Example
https://10.10.10.5/services/rest/V1/?method=authenticate&username=admin&password=a10
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
19 of 124
session.close
Description
Request
TABLE 3
Request Parameters
Parameter
Name
session_id
Description
Session ID assigned by the AX device following successful authentication.
Data Type
String
Range
N/A
Default
N/A
HTTP Action
GET
Response
Version
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=session.close
20 of 124
P e r f o r m a n c e
b y
D e s i g n
slb.server.getAll
Description
Request
TABLE 4
Request Parameters
Parameter
Name
session_id
Description
Session ID assigned by the AX device following successful authentication.
slb.server.getAll
method
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response
TABLE 5
Response Fields
Response
Field
servers
server
name
address
health_monitor
status
Description
XML tag for the collection of the real servers.
XML tag for a specific real server.
Real server name.
Real server IP address.
Layer 3 health monitor used to check the health of the server.
Status of the real server:
0 Disabled
1 Up
4 Down
weight
5 Unknown
Administrative weight assigned to the server.
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
21 of 124
Response
Field
conn_limit
Description
Maximum number of connections allowed to the server. If the connection limit is exceeded, the
AX device stops sending new connections to the server. The AX device does not resume sending connections to the server until one of the following occurs:
If conn_resume is not set (the default), the AX device is allowed to start sending new connection requests to the server as soon as the number of connections on the server falls back
below conn_limit.
conn_resume
ports
If conn_resume is set (see below), the AX device is allowed to start sending new connection
requests to the server only after the number of connections on the server is at or below
conn_resume.
If conn_limit is exceeded, conn_resume specifies the maximum number of connections the
server can have before the AX device can start sending new connections to the server.
XML tag for a specific service port. The configuration of each port is shown using the following fields:
port_num Service port number
protocol Protocol type:
2 TCP
3 UDP
status Status of the service:
0 Disabled
1 Up
4 Down
5 Unknown
conn_limit Maximum number of connections allowed to the service port. If the connection
limit is exceeded, the AX device stops sending new connections to the service port. The AX
device does not resume sending connections to the service port until one of the following
occurs:
If conn_resume is not set (the default), the AX device is allowed to start sending new connection requests to the service port as soon as the number of connections on the port falls
back below conn_limit.
If conn_resume is set (see below), the AX device is allowed to start sending new connection requests to the service port only after the number of connections on the port is at or
below conn_resume.
conn_resume If conn_limit is exceeded, conn_resume specifies the maximum number of
connections the port can have before the AX device can start sending new connections to the
port.
weight Administrative weight assigned to the service.
health_monitor Health monitor used to check the health of the service.
Version
22 of 124
P e r f o r m a n c e
b y
D e s i g n
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.server.getAll
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
23 of 124
slb.server.search
Description
Get information about a specific real server. You can request information
based on server name or IP address. If you specify both, the aXAPI uses the
server name to look up the information.
Request
TABLE 6
Request Parameters
Parameter
Name
session_id
method
name
Description
Session ID assigned by the AX device following successful authentication.
slb.server.search
Real server name.
address
Data Type
String
Range
N/A
Default
N/A
String
String
N/A
1-31
N/A
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response
The response fields are the same as those listed in Table 5 on page 21.
Version
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.server.search
&address=3.0.1.134
24 of 124
P e r f o r m a n c e
b y
D e s i g n
slb.server.fetchAllStatistics
Description
Get statistics for all real servers and their service ports.
Request
TABLE 7
Request Parameters
Parameter
Name
session_id
Description
Session ID assigned by the AX device following successful authentication.
slb.server.fetchAllStatistics
method
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response
TABLE 8
Response
Field
servers
server
name
address
status
Response Fields
Description
XML tag for the collection of servers.
XML tag for a specific server.
Server name.
Server IP address.
Status of the server:
0 Disabled
1 Up
4 Down
cur_conns
tot_conns
p_conns
req_pkts
resp_pkts
req_bytes
resp_bytes
ports
5 Unknown
Number of current connections to the server.
Total number of connections to the server.
Total number of persistent connections to the server.
Total number of request packets received for services in the server.
Total number of response packets sent from the server.
Total number of request bytes received for the server.
Total number of response bytes sent from the server.
XML tag for the collection of service ports on the server.
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
25 of 124
Response
Field
port
Description
XML tag for a specific service port. Statistics for each port are shown using the following
fields:
port_num Service port number.
status Status of the port:
0 Disabled
1 Up
4 Down
5 Unknown
cur_conns Number of current connections to the port.
tot_conns Total number of connections to the port.
p_conns Total number of persistent connections to the port.
req_pkts Total number of request packets received for services on the port.
resp_pkts Total number of response packets sent from the port.
req_bytes Total number of request bytes received for the port.
resp_bytes Total number of response bytes sent from the port.
Version
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=
slb.server.fetchAllStatistics
26 of 124
P e r f o r m a n c e
b y
D e s i g n
slb.server.fetchStatistics
Description
Get statistics for a specific real server. You can request information based on
server name or IP address. If you specify both, the aXAPI uses the server
name to look up the information.
Request
TABLE 9
Parameter
Name
session_id
Request Parameters
method
name
Description
Session ID assigned by the AX device following successful authentication.
slb.server.fetchAllStatistics
Real server name.
address
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
Data Type
String
Range
N/A
Default
N/A
String
String
N/A
1-31
N/A
N/A
String
N/A
N/A
27 of 124
GET or POST
Response
The response fields are the same as those listed in Table 8 on page 25.
Version
Example
https://10.10.10.5/services/rest/V1/session_id=123456789&method=slb.server.fetchStatistics&address=10.0.0.5
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.server.fetchStatistics&name=_s_10.0.0.5
28 of 124
P e r f o r m a n c e
b y
D e s i g n
slb.server.create
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
slb.server.create
Real server name.
Real server IP address.
Status of the server:
(Optional)
0 Disabled
health_monitor
1 Enabled
Layer 3 health method to use to check the
health of the server.
(Optional)
weight
conn_limit
Data Type
String
Range
N/A
Default
N/A
String
String
String
Integer
N/A
1-31
N/A
0-1
N/A
N/A
N/A
1
String
N/A
(default)1
Integer
Integer
1-100
1-8000000
1
8000000
Integer
0-1000000
0 (unlimited)
conn_resume
(Optional)
port-list
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
29 of 124
Description
XML tag for a specific service port. The configuration of each service port uses the following fields:
port_num Service port number.
protocol Protocol type:
Data Type
Range
Default
Integer
Integer
0-65534
2-3
N/A
N/A
Integer
0-1
Integer
1-1000000
1000000
Integer
0-1000000
0 (unlimited)
Integer
String
1-100
N/A
1
(default)*
2 TCP
3 UDP
status (Optional) Status of the port:
0 Disabled
1 Enabled
conn_limit Maximum number of connections allowed to the port.
conn_resume (Optional) If conn_limit is
exceeded, conn_resume specifies the maximum number of connections the port can
have before the AX device can start sending new connections to the port.
weight Administrative weight of the port.
health_monitor Health method to use to
check the health of the port.
1. The default Layer 3 health method is Ping.
HTTP Action
GET or POST
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
Example
https://10.10.10.5/services/rest/V1/session_id=123456789&method=slb.server.create&name=server1&address=192.168.200.100&status=1&health_monitor=ping&portlist=port1%02port2&port1=port_num%0380%02protocol%032%02status%031%02conn_limit%0310000
00&port2=port_num%0323%02protocol%032%02status%031%02conn_limit%031000000
30 of 124
P e r f o r m a n c e
b y
D e s i g n
slb.server.update
Description
Update a real server. You can use this method to change real server parameters and to add, change, or delete service ports on the server.
Request
The method name is slb.server.update. The other parameters are the same as
those in Table 9 on page 27.
You can identify the real server by name or IP address. If you specify both,
the aXAPI accesses the server configuration based on the name. You can
identify service ports by port number and protocol type.
You cannot edit the virtual server name or IP address, or the port number or
protocol type of a port.
HTTP Action
GET or POST
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.server.update
&name=server1&port-list=port1%02port2& port1=port_num%0380%02protocol%032%02status%030
&port2=port_num%0323%02protocol%032%02status%020
slb.server.delete
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
Data Type
String
Range
N/A
Default
N/A
31 of 124
Description
slb.server.delete
Real server name.
Real server IP address.
Data Type
String
String
String
Range
N/A
1-31
N/A
Default
N/A
N/A
N/A
POST only
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.server.delete
&name=server2
Example
The following request deletes the real server that has IP address
192.168.200.101:
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.server.delete
&address=192.168.200.101
slb.server.deleteAll
Description
Request
32 of 124
Description
Session ID assigned by the AX device following successful authentication.
Data Type
String
Range
N/A
P e r f o r m a n c e
b y
Default
N/A
D e s i g n
Description
slb.server.deleteAll
Data Type
String
Range
N/A
Default
N/A
HTTP Action
POST only
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.server.
deleteAll
slb.server.deletePort
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
slb.server.deletePort
Real server name.
Real server IP address.
Real service ports to delete.
Service port list number and port number.
port_num
protocol:
Data Type
String
Range
N/A
Default
N/A
String
String
String
String
N/A
1-31
N/A
N/A
N/A
N/A
N/A
N/A
Integer
Integer
0-65534
2-3
N/A
N/A
2 TCP
3 UDP
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
33 of 124
POST only
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.server.
deletePort&name=server2&port-list=port1&port1=port_num%038080
slb.server.deleteAllPorts
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
slb.server.deleteAllPorts
Real server name.
Real server IP address.
Data Type
String
Range
N/A
Default
N/A
String
String
String
N/A
1-31
N/A
N/A
N/A
N/A
You can identify the server by name or IP address. If you specify both, the
aXAPI accesses the server configuration based on the name.
HTTP Action
POST only
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
34 of 124
P e r f o r m a n c e
b y
D e s i g n
The following request deletes all services from real server 192.168.200.101:
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.vip.
deleteAllPorts&address=192.168.200.101
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
35 of 124
36 of 124
P e r f o r m a n c e
b y
D e s i g n
slb.service-group.getAll
Description
Get configuration information for all SLB service groups configured on the
AX device.
Request
Description
Session ID assigned by the AX device following successful authentication.
slb.service-group.getAll
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response
Description
XML tag for the collection of the service groups.
XML tag for a specific service group.
Service group name.
Service group type:
2 TCP
lb_method
3 UDP
Load-balancing method:
0 RoundRobin
1 WeightedRoundRobin
2 LeastConnection
3 LeastConnectionOnServicePort
5 WeightedLeastConnectionOnServicePort
6 FastResponseTime
7 LeastRequest
8 StrictRoundRobin
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
37 of 124
Description
Status of the service group:
0 disabled
1 All up
2 Partial up
3 Functional up
4 Down
health_monitor
members
member
5 Unknown
Layer 3 health monitor used to check the health of the server.
XML tag for the service group members.
XML tag for a specific service group member. The configuration of each member is shown
using the following fields:
address Server IP address
port Service port number
conn_limit Maximum number of connections allowed to the service port. If the connection
limit is exceeded, the AX device stops sending new connections to the service port. The AX
device does not resume sending connections to the service port until one of the following
occurs:
If conn_resume is not set (the default), the AX device is allowed to start sending new connection requests to the service port as soon as the number of connections on the port falls
back below conn_limit.
If conn_resume is set (see below), the AX device is allowed to start sending new connection requests to the service port only after the number of connections on the port is at or
below conn_resume.
conn_resume If conn_limit is exceeded, conn_resume specifies the maximum number of
connections the server can have before the AX device can start sending new connections to
the port.
weight Administrative weight assigned to the service.
priority Preference for this server and port. The priority can be 1-16. During server selection, a server and port with a high priority are favored over a server and port with a low priority, and are therefore more often selected.
status Status of the server and port within this service group:
0 Disabled
1 Up
4 Down
5 Unknown
Version
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.servicegroup.getAll
38 of 124
P e r f o r m a n c e
b y
D e s i g n
slb.service-group.getByName
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
slb.service-group.getByName
Service group name.
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
Data Type
String
Range
N/A
Default
N/A
String
String
N/A
1-31
N/A
N/A
39 of 124
GET or POST
Response
Description
XML tag for a specific service group.
Service group name.
Service group type:
2 TCP
lb_method
3 UDP
Load-balancing method:
0 RoundRobin
1 WeightedRoundRobin
2 LeastConnection
3 LeastConnectionOnServicePort
5 WeightedLeastConnectionOnServicePort
6 FastResponseTime
7 LeastRequest
Status
8 StrictRoundRobin
Status of the service group:
0 disabled
1 All up
2 Partial up
3 Functional up
4 Down
health_monitor
members
40 of 124
5 Unknown
Layer 3 health monitor used to check the health of the server.
XML tag for the service group members.
P e r f o r m a n c e
b y
D e s i g n
Description
XML tag for a specific service group member. The configuration of each member is shown
using the following fields:
address Server IP address
port Service port number
conn_limit Maximum number of connections allowed to the service port. If the connection
limit is exceeded, the AX device stops sending new connections to the service port. The AX
device does not resume sending connections to the service port until one of the following
occurs:
If conn_resume is not set (the default), the AX device is allowed to start sending new connection requests to the service port as soon as the number of connections on the port falls
back below conn_limit.
If conn_resume is set (see below), the AX device is allowed to start sending new connection requests to the service port only after the number of connections on the port is at or
below conn_resume.
conn_resume If conn_limit is exceeded, conn_resume specifies the maximum number of
connections the server can have before the AX device can start sending new connections to
the port.
weight Administrative weight assigned to the service.
priority Preference for this server and port. The priority can be 1-16. During server selection, a server and port with a high priority are favored over a server and port with a low priority, and are therefore more often selected.
status Status of the server and port within this service group:
0 Disabled
1 Up
4 Down
5 Unknown
Version
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.service-group.getByNam&name=empty
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
41 of 124
slb.service-group.fetchAllStatistics
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
slb.service-group.fetchAllStatistics
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response
Description
XML tag for the collection of service groups.
XML tag for a specific service group.
Service group name.
Status of the service group:
0 disabled
1 All up
2 Partial up
3 Functional up
4 Down
cur_conns
tot_conns
p_conns
req_pkts
resp_pkts
req_bytes
resp_bytes
members
42 of 124
5 Unknown
Number of current connections to the service group.
Total number of connections to the service group.
Total number of persistent connections to the service group.
Total number of request packets received for services in the service group.
Total number of response packets sent from the service group.
Total number of request bytes received for the service group.
Total number of response bytes sent from the service group.
XML tag for the service group members.
P e r f o r m a n c e
b y
D e s i g n
Description
XML tag for a specific service group member. Statistics for each member are shown using the
following fields:
address Server IP address.
port Service port number.
status Status of the member:
0 Disabled
1 Up
4 Down
5 Unknown
cur_conns Number of current connections to the service group member.
tot_conns Total number of connections to the service group member.
p_conns Total number of persistent connections to the service group member.
req_pkts Total number of request packets received for services on the service group member.
resp_pkts Total number of response packets sent from the service group member.
req_bytes Total number of request bytes received for the service group member.
resp_bytes Total number of response bytes sent from the service group member.
Version
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.servicegroup.fetchAllStatistics
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
43 of 124
44 of 124
P e r f o r m a n c e
b y
D e s i g n
slb.service-group.fetchStatisticsByName
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
slb.service-group.fetchStatisticsByName
Service group name.
Data Type
String
Range
N/A
Default
N/A
String
String
N/A
1-31
N/A
N/A
HTTP Action
GET or POST
Response
Description
XML tag for a specific service group.
Service group name.
Status of the service group:
0 disabled
1 All up
2 Partial up
3 Functional up
4 Down
cur_conns
tot_conns
p_conns
req_pkts
resp_pkts
req_bytes
resp_bytes
members
5 Unknown
Number of current connections to the service group.
Total number of connections to the service group.
Total number of persistent connections to the service group.
Total number of request packets received for services in the service group.
Total number of response packets sent from the service group.
Total number of request bytes received for the service group.
Total number of response bytes sent from the service group.
XML tag for the service group members.
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
45 of 124
Description
XML tag for a specific service group member. Statistics for each member are shown using the
following fields:
address Server IP address.
port Service port number.
status Status of the member:
0 Disabled
1 Up
4 Down
5 Unknown
cur_conns Number of current connections to the service group member.
tot_conns Total number of connections to the service group member.
p_conns Total number of persistent connections to the service group member.
req_pkts Total number of request packets received for services on the service group member.
resp_pkts Total number of response packets sent from the service group member.
req_bytes Total number of request bytes received for the service group member.
resp_bytes Total number of response bytes sent from the service group member.
Version
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.servicegroup.fetchStatisticsByName&name=SG_HTTP
46 of 124
P e r f o r m a n c e
b y
D e s i g n
slb.service-group.create
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
slb.service-group.create
Service group name.
Service group protocol type:
Data Type
String
Range
N/A
Default
N/A
String
String
Integer
N/A
1-31
2-3
N/A
N/A
N/A
Integer
0, 1, 2, 3, 5,
6
String
N/A
(default)1
String
N/A
N/A
N/A
N/A
N/A
String
Integer
N/A
0-65534
N/A
N/A
2 TCP
lb_method
3 UDP
Load-balancing method:
(Optional)
0 RoundRobin
1 WeightedRoundRobin
2 LeastConnection
3 LeastConnectionOnServicePort
5 WeightedLeastConnectionOnServicePort
6 FastResponseTime
7 LeastRequest
health_monitor
(Optional)
member-list
(Optional)
8 StrictRoundRobin
Layer 3 health monitor to use to check the
health of the server.
Servers and service ports to add to the service
group.
Use ^B between each member. For example:
member1^Bmember2^B memberN
member<n>
(Optional)
address
port
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
47 of 124
Description
Maximum number of connections allowed to
the service port. If the connection limit is
exceeded, the AX device stops sending new
connections to the service port. The AX
device does not resume sending connections
to the service port until one of the following
occurs:
Data Type
Integer
Range
1-8000000
Default
8000000
Integer
0-1000000
0 (unlimited)
Integer
1-100
Integer
1-16
Integer
0-1
conn_resume
weight
priority
status
HTTP Action
POST only
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
48 of 124
P e r f o r m a n c e
b y
D e s i g n
Example
slb.service-group.update
Description
Update a service group. You can use this method to add, change, or delete
members in the service group.
Request
The name parameter is slb.service-group.update. The other request parameters are the same as those for the slb.service-group.create method. (See
Table 23 on page 47.)
HTTP Action
POST only
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
Example
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
49 of 124
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.servicegroup.update&name=http_srv_grp1&lb_method=2
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.servicegroup.update&name=http_srv_grp1& member-list=member1%02member2&member1=address%03
1.1.1.3%02port^C80%02status%030& member2=address%031.1.1.4%02port^C80%02status%030
50 of 124
P e r f o r m a n c e
b y
D e s i g n
slb.service-group.delete
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
slb.service-group.delete
Service group name.
Data Type
String
Range
N/A
Default
N/A
String
String
N/A
1-31
N/A
N/A
HTTP Action
POST only
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.servicegroup.delete&name=http_srv_grp1
slb.service-group.deleteAll
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
slb.service-group.deleteAll
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
51 of 124
POST only
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
Example
The following request deletes all service groups from the AX device:
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.servicegroup.deleteAll
slb.service-group.deleteMember
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
slb.service-group.deleteMember
Service group name.
Servers and service ports to delete from the
service group.
Data Type
String
Range
N/A
Default
N/A
String
String
String
N/A
1-31
N/A
N/A
N/A
N/A
String
N/A
N/A
52 of 124
P e r f o r m a n c e
b y
D e s i g n
Description
IP address of the server.
Service port number.
Data Type
String
Integer
Range
N/A
0-65534
Default
N/A
N/A
HTTP Action
POST only
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
Example
The following request deletes the following members from service group
http_srv_grp1:
1.1.1.2:80
1.1.1.3:80
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.servicegroup.deleteMember&name=http_srv_grp1&member-list=member1%02member2& member1=
address%031.1.1.2%02port%0380&member2=address%031.1.1.3%02port%0380
slb.service-group.deleteAllMembers
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
slb.service-group.deleteAllMembers
Service group name.
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
Data Type
String
Range
N/A
Default
N/A
String
String
N/A
1-31
N/A
N/A
53 of 124
POST only
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.servicegroup.deleteAllMembers&name=http_srv_grp1
54 of 124
P e r f o r m a n c e
b y
D e s i g n
slb.vip.getAll
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
slb.vip.getAll
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response
Description
XML tag for the collection of the virtual servers.
XML tag for a specific virtual server.
Virtual server name.
Virtual server IP address.
Status of the virtual server:
0 Disabled
1 All up
2 Partial up
3 Functional up
4 Down
ha_group
arp_disabled
5 Unknown
High Availability (HA) group the virtual server is in.
Indicates whether the AX device responds to ARP requests sent to the virtual server address:
0 Disabled (ARP is enabled)
1 Enabled (ARP is disabled)
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
55 of 124
Description
XML tag for the virtual services on the virtual server.
XML tag for a specific virtual service. The configuration of each virtual service is shown using
the following fields:
type Service type:
2 TCP
3 UDP
8 RTSP
9 FTP
10 MMS
11 SIP
12 Fast-HTTP
14 HTTP
15 HTTPS
16 SSL-Proxy
17 SMTP
port Service port number.
service_group Service group bound to this virtual service port.
status Status of the virtual service port:
0 Disabled
1 All up
3 Functional up
4 Down
5 Unknown
conn_limit Maximum number of connections allowed on the virtual service port. If the
connection limit is exceeded, the AX device stops sending new connections to the virtual
service port. The AX device does not resume sending connections to the virtual service port
until one of the following occurs:
If conn_resume is not set (the default), the AX device is allowed to start sending new connection requests to the virtual service port as soon as the number of connections on the
port falls back below conn_limit.
If conn_resume is set (see below), the AX device is allowed to start sending new connection requests to the virtual service port only after the number of connections on the port is
at or below conn_resume.
conn_resume If conn_limit is exceeded, conn_resume specifies the maximum number of
connections the virtual service port can have before the AX device can start sending new
connections to the port.
acl Access Control List (ACL) bound to the virtual service port.
(cont.)
56 of 124
P e r f o r m a n c e
b y
D e s i g n
Description
acl Access Control List (ACL) bound to the virtual service port.
(cont.)
http_service_co
nfig
The following fields provide information about the parameter settings for individual service
types. For each virtual service port, only the field for the ports service type is returned in the
reply.
XML tag for HTTP services. Service parameter settings are returned in the following fields:
http_templ HTTP template name.
conn_reuse_templ Connection-reuse template name.
tcp_proxy_templ TCP-Proxy template name.
cookie_p_templ Cookie-persistence template name.
https_service_co
nfig
fast_http_servic
e_config
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
57 of 124
Description
XML tag for TCP services. Service parameter settings are returned in the following fields:
ha_conn_mirror State of HA connection mirroring (session synchronization) on the service port:
0 Disabled
1 Enabled
dsr State of Direct Server Return (DSR):
0 Disabled (Destination NAT is enabled)
1 Enabled (Destination NAT is disabled)
syn_cookie State of the software-based SYN cookie feature:
0 Disabled
1 Enabled
nat_pool Source NAT pool name.
tcp_templ TCP template name.
udp_service_co
nfig
58 of 124
P e r f o r m a n c e
b y
D e s i g n
Description
XML tag for Real Time Streaming Protocol (RTSP) services. Service parameter settings are
returned in the following fields:
ha_conn_mirror State of HA connection mirroring (session synchronization) on the service port:
0 Disabled
1 Enabled
dsr State of Direct Server Return (DSR):
0 Disabled (Destination NAT is enabled)
1 Enabled (Destination NAT is disabled)
syn_cookie State of the software-based SYN cookie feature:
0 Disabled
1 Enabled
tcp_templ TCP template name.
rtsp_templ Multimedia (RTSP) template name.
ftp_service_conf
ig
mms_service_co
nfig
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
59 of 124
Description
XML tag for SSL-Proxy services. Service parameter settings are returned in the following
fields:
nat_pool Source NAT pool name.
client_ssl_templ Client-SSL template name.
tcp_proxy_templ TCP-Proxy template name.
smtp_service_co
nfig
sip_service_con
fig
Version
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.vip.getAll
60 of 124
P e r f o r m a n c e
b y
D e s i g n
slb.vip.search
Description
Get information about specific virtual server. You can request information
based on virtual server name or IP address. If you specify both, the aXAPI
looks up the information based on the name.
Request
Description
Session ID assigned by the AX device following successful authentication.
slb.vip.search
Virtual server name.
address
Data Type
String
Range
N/A
Default
N/A
String
String
N/A
1-31
N/A
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response
The response fields are the same as those listed in Table 29 on page 55.
Version
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.vip.search
&name=wildcard_vip_01
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
61 of 124
slb.vip.fetchAllStatistics
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
slb.vip.fetchAllStatistics
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response
62 of 124
Description
XML tag for the collection of the virtual servers.
XML tag for a specific virtual server.
Virtual server name.
Virtual server IP address.
P e r f o r m a n c e
b y
D e s i g n
Description
Status of the virtual server:
0 Disabled
1 All up
2 Partial up
3 Functional up
4 Down
cur_conns
tot_conns
p_conns
req_pkts
resp_pkts
req_bytes
resp_bytes
services
service
5 Unknown
Number of current connections to the virtual server.
Total number of connections to the virtual server.
Total number of persistent connections to the virtual server.
Total number of request packets received for services in the virtual server.
Total number of response packets sent from the virtual server.
Total number of request bytes received for the virtual server.
Total number of response bytes sent from the virtual server.
XML tag for virtual services.
XML tag for a specific virtual service. Statistics for each virtual service are shown using the
following fields:
port Virtual service port number.
status Status of the virtual service port:
0 Disabled
1 All up
3 Functional up
4 Down
5 Unknown
cur_conns Number of current connections to the virtual service port.
tot_conns Total number of connections to the virtual service port.
p_conns Total number of persistent connections to the virtual service port.
req_pkts Total number of request packets received for the virtual service port.
resp_pkts Total number of response packets sent from the virtual service port.
req_bytes Total number of request bytes received for the virtual service port.
resp_bytes Total number of response bytes sent from the virtual service port.
Version
Example
The following request gets statistics for all virtual servers configured on the
AX device:
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.vip.fetchAllStatistics
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
63 of 124
slb.vip.fetchStatistics
Description
Get statistics for a specific virtual server. You can request information based
on virtual server name or IP address. If you specify both, the aXAPI looks
up the information based on the name.
Request
Description
Session ID assigned by the AX device following successful authentication.
slb.vip.fetchAllStatistics
Virtual server name.
address
Data Type
String
Range
N/A
Default
N/A
String
String
N/A
1-31
N/A
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response
The response fields are the same as those listed in Table 32 on page 62.
64 of 124
P e r f o r m a n c e
b y
D e s i g n
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.vip.fetchStatistics&address=3.0.6.140
slb.vip.create
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
slb.vip.create
Virtual server name.
Virtual server IP address.
Status of the virtual server:
(Optional)
0 Disabled
ha_group
1 Enabled
High Availability (HA) group the virtual
server is in.
(Optional)
arp_disabled
(Optional)
Data Type
String
Range
N/A
Default
N/A
String
String
String
Integer
N/A
1-31
N/A
0-1
N/A
N/A
N/A
1
Integer
1-64
N/A
Integer
0-1
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
65 of 124
Description
Virtual service ports to add.
Data Type
String
Range
N/A
Default
N/A
N/A
N/A
N/A
Integer
2, 3, 8, 9, 10,
11, 12, 14,
15, 16, 17
N/A
Integer
String
0-65534
N/A
N/A
N/A
Integer
0-1
service<n>
(Optional)
66 of 124
P e r f o r m a n c e
b y
D e s i g n
Description
conn_limit Maximum number of connections allowed on the virtual service port. If
the connection limit is exceeded, the AX
device stops sending new connections to
the virtual service port. The AX device
does not resume sending connections to
the virtual service port until one of the following occurs:
Data Type
Integer
Range
1-8000000
Default
8000000
Integer
0-1000000
0 (unlimited)
Integer
1-199
N/A
String
N/A
N/A
String
N/A
N/A
String
N/A
N/A
String
String
String
N/A
N/A
N/A
N/A
N/A
N/A
String
N/A
N/A
String
N/A
N/A
String
N/A
N/A
http_service_co
nfig<n>:
(Optional)
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
67 of 124
fast_http_servic
e_config<n>:
(Optional)
68 of 124
Description
XML tag for HTTPS services. Service
parameters are set using the following fields:
nat_pool Source NAT pool name.
http_templ HTTP template name.
client_ssl_templ Client-SSL template
name.
server_ssl_templ Server-SSL template
name.
conn_reuse_templ Connection-reuse
template name.
cookie_p_templ Cookie-persistence template name.
source_ip_p_templ Source-IP persistence template name.
XML tag for Fast-HTTP services. Service
parameters are set using the following fields:
nat_pool Source NAT pool name.
http_templ HTTP template name.
tcp_templ TCP template name.
conn_reuse_templ Connection-reuse
template name.
cookie_p_templ Cookie-persistence template name.
source_ip_p_templ Source-IP persistence template name.
Data Type
String
Range
N/A
Default
N/A
String
String
String
N/A
N/A
N/A
N/A
N/A
N/A
String
N/A
N/A
String
N/A
N/A
String
N/A
N/A
String
N/A
N/A
String
N/A
N/A
String
String
String
String
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
String
N/A
N/A
String
N/A
N/A
P e r f o r m a n c e
b y
D e s i g n
Description
XML tag for TCP services. Service parameters are set using the following fields:
ha_conn_mirror State of HA connection
mirroring (session synchronization) on the
service port:
Data Type
String
Range
N/A
Default
N/A
Integer
0-1
Integer
0-1
Integer
0-1
String
String
String
N/A
N/A
N/A
N/A
N/A
N/A
String
N/A
N/A
Integer
0-1
Integer
0-1
String
String
String
N/A
N/A
N/A
N/A
N/A
N/A
0 Disabled
1 Enabled
dsr State of Direct Server Return (DSR):
0 Disabled (Destination NAT is
enabled)
1 Enabled (Destination NAT is disabled)
syn_cookie State of the software-based
SYN cookie feature:
0 Disabled
udp_service_co
nfig<n>:
(Optional)
1 Enabled
nat_pool Source NAT pool name.
tcp_templ TCP template name.
source_ip_p_templ Source-IP persistence template name.
XML tag for UDP services. Service parameters are set using the following fields:
ha_conn_mirror State of HA connection
mirroring (session synchronization) on the
service port:
0 Disabled
1 Enabled
dsr State of Direct Server Return (DSR):
0 Disabled (Destination NAT is
enabled)
1 Enabled (Destination NAT is disabled)
nat_pool Source NAT pool name.
udp_templ UDP template name.
source_ip_p_templ Source-IP persistence template name.
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
69 of 124
Description
XML tag for Real Time Streaming Protocol
(RTSP) services. Service parameters are set
using the following fields:
ha_conn_mirror State of HA connection
mirroring (session synchronization) on the
service port:
Data Type
String
Range
N/A
Default
N/A
Integer
0-1
Integer
0-1
Integer
0-1
String
String
N/A
N/A
N/A
N/A
String
N/A
N/A
String
N/A
N/A
Integer
0-1
Integer
0-1
Integer
0-1
String
String
String
N/A
N/A
N/A
N/A
N/A
N/A
0 Disabled
1 Enabled
dsr State of Direct Server Return (DSR):
0 Disabled (Destination NAT is
enabled)
1 Enabled (Destination NAT is disabled)
syn_cookie State of the software-based
SYN cookie feature:
0 Disabled
ftp_service_conf
ig<n>:
(Optional)
1 Enabled
tcp_templ TCP template name.
rtsp_templ Multimedia (RTSP) template
name.
source_ip_p_templ Source-IP persistence template name.
XML tag for FTP services. Service parameters are set using the following fields:
ha_conn_mirror State of HA connection
mirroring (session synchronization) on the
service port:
0 Disabled
1 Enabled
dsr State of Direct Server Return (DSR):
0 Disabled (Destination NAT is
enabled)
1 Enabled (Destination NAT is disabled)
syn_cookie State of the software-based
SYN cookie feature:
0 Disabled
1 Enabled
nat_pool Source NAT pool name.
tcp_templ TCP template name.
source_ip_p_templ Source-IP persistence template name.
70 of 124
P e r f o r m a n c e
b y
D e s i g n
Description
XML tag for Microsoft Media Server (MMS)
services. Service parameters are set using the
following fields:
syn_cookie State of the software-based
SYN cookie feature:
Data Type
String
Range
N/A
Default
N/A
Integer
0-1
String
String
N/A
N/A
N/A
N/A
String
N/A
N/A
String
String
N/A
N/A
N/A
N/A
String
N/A
N/A
String
N/A
N/A
String
N/A
N/A
String
String
N/A
N/A
N/A
N/A
String
N/A
N/A
String
String
N/A
N/A
N/A
N/A
String
N/A
N/A
String
String
N/A
N/A
N/A
N/A
0 Disabled
ssl_proxy_servi
ce_config<n>:
(Optional)
smtp_service_co
nfig<n>:
(Optional)
sip_service_con
fig<n>:
(Optional)
1 Enabled
tcp_templ TCP template name.
source_ip_p_templ Source-IP persistence template name.
XML tag for SSL-Proxy services. Service
parameters are set using the following fields:
nat_pool Source NAT pool name.
client_ssl_templ Client-SSL template
name.
tcp_proxy_templ TCP-Proxy template
name.
source_ip_p_templ Source-IP persistence template name.
XML tag for Simple Mail Transfer Protocol
(SMTP) services. Service parameters are set
using the following fields:
nat_pool Source NAT pool name.
client_ssl_templ Client-SSL template
name.
tcp_proxy_templ TCP-Proxy template
name.
smtp_templ SMTP template name.
source_ip_p_templ Source-IP persistence template name.
XML tag for Session Initiation Protocol (SIP)
services. Service parameters are set using the
following fields:
sip_templ SIP template name.
source_ip_p_templ Source-IP persistence template name.
HTTP Action
POST only
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
71 of 124
slb.vip.update
Description
Request
Update a virtual server. You can use this method to change virtual server
parameters and to add, change, or delete virtual services on the server.
The method name is slb.vip.update. The other parameters are the same as those in
Table 34 on page 65.
You can identify the virtual server by name or IP address. If you specify
both, the aXAPI accesses the virtual server configuration based on the
name.
You cannot edit the virtual server name or IP address.
HTTP Action
POST only
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
72 of 124
P e r f o r m a n c e
b y
D e s i g n
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.vip.update
&address=192.168.1.100&ha_group=2
Example
The following request disables virtual service ports 80 and 443 on virtual
server 192.168.1.101 for maintenance.
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.vip.update&
address=192.168.1.101&service-list=service1%02service2&service1=port%03443%02status
%030&service2=port%0380%02status%030
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
73 of 124
slb.vip.delete
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
slb.vip.delete
Virtual server name.
Virtual server IP address.
Data Type
String
Range
N/A
Default
N/A
String
String
String
N/A
1-31
N/A
N/A
N/A
N/A
You can identify the virtual server by name or IP address. If you specify
both, the aXAPI accesses the virtual server configuration based on the
name.
HTTP Action
POST only
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.vip.delete
&name=http_vip1
Example
The following request deletes the virtual server with IPv6 address a:a::b:c.
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.vip.delete
&address=a%3aa%3a%3a%3ab%3ac service2=port%0380%02status%030
Note:
74 of 124
P e r f o r m a n c e
b y
D e s i g n
slb.vip.deleteAll
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
slb.vip.deleteAll
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
POST only
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.vip.deleteAll
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
75 of 124
slb.vip.deleteService
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
slb.vip.deleteService
Virtual server name.
Virtual server IP address.
Virtual service ports to delete.
Service list number and virtual service port
number.
Data Type
String
Range
N/A
Default
N/A
String
String
String
String
Integer
N/A
1-31
N/A
N/A
0-65534
N/A
N/A
N/A
N/A
N/A
You can identify the virtual server by name or IP address. If you specify
both, the aXAPI accesses the virtual server configuration based on the
name.
HTTP Action
POST only
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
Example
The following request deletes services 1 and 2, service ports 80 and 443,
from virtual server http_vip1:
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=
slb.vip.deleteService&name=http_vip1&service-list=service1%02service2&service1=
port%0380&service2=port%03443
76 of 124
P e r f o r m a n c e
b y
D e s i g n
slb.vip.deleteAllServices
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
slb.vip.deleteAllServices
Virtual server name.
Virtual server IP address.
Data Type
String
Range
N/A
Default
N/A
String
String
String
N/A
1-31
N/A
N/A
N/A
N/A
You can identify the virtual server by name or IP address. If you specify
both, the aXAPI accesses the virtual server configuration based on the
name.
HTTP Action
POST only
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
Example
The following request deletes all services from virtual server http_vip1:
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.vip.deleteAll
Services&name=http_vip1
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
77 of 124
78 of 124
P e r f o r m a n c e
b y
D e s i g n
network.interface.fetchAllStatistics
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
network.interface.fetchAllStatistics
Response
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
Description
XML tag for the collection of physical interfaces.
XML tag for a specific interface. Information about each interface is shown using the following fields:
int_num Interface number
description Interface description. If a name has been assigned to the interface by an administrator, this is the interface name.
mtu Maximum Transmission unit (MTU), which specifies the largest packet size, in bytes,
that can be sent or received on the interface.
speed Estimate of the interfaces current bandwidth, in bits per second.
mac_addr MAC address of the interface.
pri_ip_addr Primary IP address configured on the interface.
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
79 of 124
Description
admin_status Administrative status of the interface:
0 Disabled
1 Enabled
oper_status Operational status of the interface:
0 Disabled
interface
1 Enabled
Interface fields, continued:
in_bytes Total number of bytes received on the interface.
in_unicast_pkts Number of unicast packets received on the interface.
in_nonunicast_pkts Number of multicast or broadcast packets received on the interface.
in_discards Number of inbound packets that were dropped.
in_errors Number of inbound packets that had errors.
out_bytes Total number of bytes transmitted out the interface.
out_uncast_pkts Number of unicast packets transmitted out the interface.
out_nonunicast_pktd Number of multicast or broadcast packets transmitted out the interface.
out_discards Number of outbound packets dropped by the interface.
out_errors Number of outbound packets that had errors.
Version
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=network.interface.
fetchAllStatistics
80 of 124
P e r f o r m a n c e
b y
D e s i g n
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
81 of 124
network.interface.fetchStatisticsByInterfaceNum
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
network.interface.fetchStatisticsByInterfaceNum
Interface number
Response
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
Integer
Depends on
how many
interfaces
the AX
model has
N/A
Description
XML tag for a specific interface. Information about each interface is shown using the following fields:
int_num Interface number
description Interface description. If a name has been assigned to the interface by an administrator, this is the interface name.
mtu Maximum Transmission unit (MTU), which specifies the largest packet size, in bytes,
that can be sent or received on the interface.
speed Estimate of the interfaces current bandwidth, in bits per second.
mac_addr MAC address of the interface.
pri_ip_addr Primary IP address configured on the interface.
admin_status Administrative status of the interface:
0 Disabled
1 Enabled
oper_status Operational status of the interface:
0 Disabled
1 Enabled
82 of 124
P e r f o r m a n c e
b y
D e s i g n
Description
in_bytes Total number of bytes received on the interface.
(cont.)
Version
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=fetchStatisticsByInterfaceNum&int_num=2
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
83 of 124
84 of 124
P e r f o r m a n c e
b y
D e s i g n
nat.pool.getAll
Description
Get configuration information for all dynamic NAT pools configured on the
AX device.
Request
Description
Session ID assigned by the AX device following successful authentication.
nat.pool.getAll
HTTP Action
P e r f o r m a n c e
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
GET or POST
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
85 of 124
Description
XML tag for the collection of dynamic NAT pools.
XML tag for a specific dynamic NAT pool.
Beginning (lowest) address in the pool.
Ending (highest) address in the pool.
Network mask for the beginning and ending IP addresses.
Default gateway to use to reach other subnets.
ha_group
Note: This option is applicable when the AX device is deployed in transparent mode (Layer 2
mode).
HA group ID to use for session backup.
Version
The version in the request must be V1.1 or higher. (See Request Header
on page 10.)
Example
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.pool.getAll
nat.pool.search
Description
Get information about a specific IP NAT pool. You can request information
based on the pool name or the beginning IP address in the pool.
Request
86 of 124
P e r f o r m a n c e
b y
D e s i g n
Description
Session ID assigned by the AX device following successful authentication.
nat.pool.search
Name or beginning IP address of the pool.
Data Type
String
Range
N/A
Default
N/A
String
String
N/A
N/A
N/A
N/A
or
start_ip_addr
HTTP Action
GET or POST
Response
The response fields are the same as those listed in Table 44 on page 86.
Version
The version in the request must be V1.1 or higher. (See Request Header
on page 10.)
Example
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.pool.search&name=pool1
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
87 of 124
nat.pool.fetchAllStatistics
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
nat.pool.fetchAllStatistics
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response
Description
XML tag for the collection of NAT pools.
XML tag for a specific NAT pool.
Name of the NAT pool.
Beginning (lowest) address in the pool.
Ending (highest) address in the pool.
XML tag for the collection of Access Control Lists (ACLs) for the NAT pool.
XML tag for a specific ACL. Each ACL is described by the following fields:
acl_id ACL name or number.
port_usage
total_used
total_freed
total_failed
Version
The version in the request must be V1.1 or higher. (See Request Header
on page 10.)
Example
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.pool.fetchAllStatistics
88 of 124
P e r f o r m a n c e
b y
D e s i g n
nat.pool.fetchStatistics
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
nat.pool.fetchStatistics
Name or beginning IP address of the pool.
Data Type
String
Range
N/A
Default
N/A
String
String
N/A
N/A
N/A
N/A
or
start_ip_addr
HTTP Action
GET or POST
Response
The response fields are the same as those listed in Table 47 on page 88.
Version
The version in the request must be V1.1 or higher. (See Request Header
on page 10.)
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
89 of 124
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.pool.fetchStatistics&name=pool1
Example
The following request gets statistics for the pool that has starting IP address
10.10.10.1:
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.pool.fetchStatistics&
start_ip_addr=10.10.10.1
90 of 124
P e r f o r m a n c e
b y
D e s i g n
nat.pool.create
Description
Request
ha_group
Description
Session ID assigned by the AX device following successful authentication.
nat.pool.create
Name of the NAT pool.
Beginning (lowest) address in the pool.
Ending (highest) address in the pool.
Network mask for the beginning and ending
IP addresses.
Default gateway to use to reach other subnets.
Note: This option is applicable when the AX
device is deployed in transparent mode
(Layer 2 mode).
HA group ID to use for session backup.
Data Type
String
Range
N/A
Default
N/A
String
String
String
String
String
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
String
N/A
N/A
Integer
1-31
N/A
HTTP Action
GET or POST
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
The version in the request must be V1.1 or higher. (See Request Header
on page 10.)
Example
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.pool.create&name=pool1&start_ip_addr=1.1.1.1&
end_ip_addr=1.1.2.1&netmask=255.255.255.0&gateway=3.3.3.3&ha_group=1
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
91 of 124
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.pool.create&name=pool3&
start_ip_addr=3001::1&end_ip_addr=3001::3&netmask=64&gateway=3001::10&ha_group=2
nat.pool.update
Description
Request
The method name is nat.pool.update. The other parameters are the same as
those in Table 49 on page 91.
HTTP Action
GET or POST
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
The version in the request must be V1.1 or higher. (See Request Header
on page 10.)
Example
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body:
session_id=123456789&method=nat.pool.update&name&=pool1&start_ip_addr=1.1.1.1&
end_ip_addr=1.1.1.10&ha_group=5
92 of 124
P e r f o r m a n c e
b y
D e s i g n
nat.pool.delete
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
nat.pool.delete
Name or beginning IP address of the pool.
Data Type
String
Range
N/A
Default
N/A
String
String
N/A
N/A
N/A
N/A
or
start_ip_addr
HTTP Action
GET or POST
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
The version in the request must be V1.1 or higher. (See Request Header
on page 10.)
Example
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.pool.delete&name=pool1
Example
The following request deletes the NAT pool that has beginning IP address
1.1.1.1:
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.pool.delete&start_ip_addr=1.1.1.1
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
93 of 124
nat.pool.deleteAll
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
nat.pool.deleteAll
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
The version in the request must be V1.1 or higher. (See Request Header
on page 10.)
Example
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.pool.deleteAll
nat.pool-group.getAll
Description
Get configuration information for all dynamic NAT pool groups configured
on the AX device.
Request
94 of 124
P e r f o r m a n c e
b y
D e s i g n
Description
Session ID assigned by the AX device following successful authentication.
nat.pool-group.getAll
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response
Description
XML tag for the collection of dynamic NAT pool groups.
XML tag for a specific dynamic NAT pool group.
Name of the pool group.
XML tag for the collection of individual pools (members) in the pool group.
XML tag for a specific dynamic NAT pool (member).
Version
The version in the request must be V1.1 or higher. (See Request Header
on page 10.)
Example
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.pool-group.getAll
P e r f o r m a n c e
b y
?>
/>
/>
/>
/>
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
95 of 124
nat.pool-group.search
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
nat.pool-group.search
Name of the pool group.
Data Type
String
Range
N/A
Default
N/A
String
String
N/A
N/A
N/A
N/A
HTTP Action
GET or POST
Response
The response fields are the same as those listed in Table 53 on page 95.
Version
The version in the request must be V1.1 or higher. (See Request Header
on page 10.)
Example
The following request gets configuration information for NAT pool group
pgrp1:
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.pool-group.search&name=pgrp1
96 of 124
?>
/>
/>
/>
P e r f o r m a n c e
b y
D e s i g n
nat.pool-group.create
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
nat.pool.create
Name of the pool group.
Names of the dynamic IP NAT pools to add
to the pool group.
XML tag for a specific NAT pool group. The
configuration of each NAT pool group uses
the following field:
Data Type
String
Range
N/A
Default
N/A
String
String
String
N/A
N/A
N/A
N/A
N/A
N/A
String
N/A
N/A
Name
The Name parameter specifies the name of a
dynamic NAT pool to add to the group. You
can add up to 25 pools to the group.
HTTP Action
GET or POST
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
The version in the request must be V1.1 or higher. (See Request Header
on page 10.)
Example
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.pool-group.create&name=pgrp1&
member-list=member1%02member2%02member3&member1=name%03pool1&member2=name%03pool2&
member3=name%03pool3
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
97 of 124
nat.pool-group.update
Description
Request
HTTP Action
GET or POST
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
The version in the request must be V1.1 or higher. (See Request Header
on page 10.)
Example
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.pool-group.update&name=pgrp1&
member-list=member1%02member2%02member3&member1=name%03pool1&member2=name%03pool2&
member3=name%03pool3&member4=name%03pool4
nat.pool-group.delete
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
nat.pool-group.delete
Name of the pool group.
Data Type
String
Range
N/A
Default
N/A
String
String
N/A
N/A
N/A
N/A
HTTP Action
GET or POST
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
98 of 124
P e r f o r m a n c e
b y
D e s i g n
The version in the request must be V1.1 or higher. (See Request Header
on page 10.)
Example
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.pool-group.delete&name=pgrp1
nat.pool-group.deleteAll
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
nat.pool-group.deleteAll
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
The version in the request must be V1.1 or higher. (See Request Header
on page 10.)
Example
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.pool-group.deleteAll
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
99 of 124
nat.static-translation.getAll
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
nat.static-translation.getAll
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response
Description
XML tag for the collection of static NAT pools.
XML tag for a specific static NAT pool.
Inside address to be translated into a global address.
Global address to use for the inside address.
HA group ID to use for session backup.
Version
The version in the request must be V1.1 or higher. (See Request Header
on page 10.)
Example
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.static-translation.getAll
100 of 124
P e r f o r m a n c e
b y
D e s i g n
nat.static-translation.search
Description
Get information about a specific static IP NAT translation. You can request
information based on source IP address or global IP address.
Request
Description
Session ID assigned by the AX device following successful authentication.
nat.static-translation.search
Inside address (source address) or global
address.
Data Type
String
Range
N/A
Default
N/A
String
String
N/A
N/A
N/A
N/A
global_ip_addr
HTTP Action
GET or POST
Response
The response fields are the same as those listed in Table 59 on page 100.
Version
The version in the request must be V1.1 or higher. (See Request Header
on page 10.)
Example
The following request gets configuration information for a static NAT translation with source IP address 1.1.1.1:
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.static-translation.search&source_ip_addr=1.1.1.1
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
101 of 124
nat.static-translation.fetchAllStatistics
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
nat.static-translation.fetchAllStatistics
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response
Description
XML tag for the collection of static NAT translations.
XML tag for a specific static NAT translation.
Source IP address in the static NAT translation.
Number of sessions currently being NATted for the source IP address.
Total number of sessions that have been NATted for the source IP address.
Number of NATted sessions have been terminated, thus freeing up a port for another session.
Version
The version in the request must be V1.1 or higher. (See Request Header
on page 10.)
Example
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.static-translation.fetchAllStatistics
102 of 124
P e r f o r m a n c e
b y
D e s i g n
nat.static-translation.fetchStatistics
Description
Get statistics for a specific static IP NAT translation. You can request information based on a source IP address or global IP address.
Request
Description
Session ID assigned by the AX device following successful authentication.
nat.static-translation.fetchStatistics
Source (inside) IP address or global address.
Data Type
String
Range
N/A
Default
N/A
String
String
N/A
1-31
N/A
N/A
or
global_ip_addr
HTTP Action
GET or POST
Response
The response fields are the same as those listed in Table 62 on page 102.
Version
The version in the request must be V1.1 or higher. (See Request Header
on page 10.)
Example
The following request gets statistics for the static IP NAT translation with
inside address 1.1.1.1:
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.static-translation.fetchStatistics&
source_ip_addr=1.1.1.1
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
103 of 124
nat.static-translation.create
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
nat.static-translation.create
Inside address to be translated into a global
address.
Global address to use for the inside address.
HA group ID to use for session backup.
Data Type
String
Range
N/A
Default
N/A
String
String
N/A
N/A
N/A
N/A
String
String
N/A
1-31
N/A
N/A
(Optional)
HTTP Action
GET or POST
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
The version in the request must be V1.1 or higher. (See Request Header
on page 10.)
Example
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.static-translation.create&
source_ip_addr=1.1.1.1&global_ip_addr=2.2.2.1&ha_group=1
104 of 124
P e r f o r m a n c e
b y
D e s i g n
nat.static-translation.update
Description
Request
HTTP Action
GET or POST
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
The version in the request must be V1.1 or higher. (See Request Header
on page 10.)
Example
The following request updates the static NAT translation for source IP
address 1.1.1.1, to map to global address 2.2.2.5, and to use HA group 5:
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.static-translation.update&
source_ip_addr=1.1.1.1&global_ip_addr=2.2.2.5&ha_group=5
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
105 of 124
nat.static-translation.delete
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
nat.static-translation.delete
Source (inside) IP address or global address.
Data Type
String
Range
N/A
Default
N/A
String
String
N/A
N/A
N/A
N/A
or
global_ip_addr
HTTP Action
GET or POST
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
The version in the request must be V1.1 or higher. (See Request Header
on page 10.)
Example
The following request deletes the static IP NAT translation for inside
address 1.1.1.1:
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.static-translation.delete&source_ip_addr=1.1.1.1
106 of 124
P e r f o r m a n c e
b y
D e s i g n
nat.static-translation.deleteAll
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
nat.static-translation.deleteAll
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
The version in the request must be V1.1 or higher. (See Request Header
on page 10.)
Example
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.static-translation.deleteAll
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
107 of 124
nat.range.getAll
Description
Get configuration information for all static IP NAT range lists configured on
the AX device.
Request
Description
Session ID assigned by the AX device following successful authentication.
nat.range.getAll
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response
Description
XML tag for the collection of the NAT ranges.
XML tag for a specific NAT range.
Name of the range list.
Beginning (lowest) IP address in the range of source addresses.
Network mask of the source address.
Beginning (lowest) IP address in the range of NAT addresses.
Network mask of the global address.
Number of addresses to be translated. The range contains a contiguous block of the number of
addresses you specify.
HA group ID to use for session backup.
Version
The version in the request must be V1.1 or higher. (See Request Header
on page 10.)
Example
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.range.getAll
108 of 124
P e r f o r m a n c e
b y
D e s i g n
nat.range.search
Description
Get information about a specific static IP NAT range list. You can request
information based on the range list name, or by a local IP address or global
IP address in the range list.
Request
Description
Session ID assigned by the AX device following successful authentication.
nat.range.search
Name, local IP address, or global IP address
of the range list.
Data Type
String
Range
N/A
Default
N/A
String
String
N/A
N/A
N/A
N/A
local_ip_addr
or
global_ip_addr
HTTP Action
GET or POST
Response
The response fields are the same as those listed in Table 68 on page 108.
Version
The version in the request must be V1.1 or higher. (See Request Header
on page 10.)
Example
The following request gets configuration information for static NAT range
range1:
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.range.search&name=range1
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
109 of 124
nat.range.create
Description
Request
ha-group
Description
Session ID assigned by the AX device following successful authentication.
nat.range.create
Name of the range list.
Beginning (lowest) IP address in the range
of source addresses.
Network mask of the source address.
Beginning (lowest) IP address in the range
of NAT addresses.
Network mask of the global address.
Number of addresses to be translated. The
range contains a contiguous block of the
number of addresses you specify.
HA group ID to use for session backup.
Data Type
String
Range
N/A
Default
N/A
String
String
String
N/A
N/A
N/A
N/A
N/A
N/A
String
String
N/A
N/A
N/A
N/A
String
Integer
N/A
1-200000
N/A
1
Integer
1-31
N/A
(Optional)
HTTP Action
GET or POST
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
The version in the request must be V1.1 or higher. (See Request Header
on page 10.)
110 of 124
P e r f o r m a n c e
b y
D e s i g n
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.range.create&name=range1&
local_ip_addr=1.1.1.1&local_ip_mask=255.255.255.0&global_ip_addr=2.2.2.1&
global_ip_mask=255.255.255.0&count=2&ha_group=1
nat.range.update
Description
Request
The method name is nat.range.update. The other parameters are the same as
those in Table 70 on page 110.
HTTP Action
GET or POST
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
The version in the request must be V1.1 or higher. (See Request Header
on page 10.)
Example
The following request updates the configuration of static IP NAT range list
range1:
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body:
session_id=123456789&method=nat.range.update&name=range1&local_ip_addr=1.1.1.1&
local_ip_mask=255.255.255.0&global_ip_addr=2.2.2.1&global_ip_mask=255.255.255.0&
count=2&ha_group=1
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
111 of 124
nat.range.delete
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
nat.range.delete
Name, local IP address, or global IP address
of the range list.
Data Type
String
Range
N/A
Default
N/A
String
String
N/A
N/A
N/A
N/A
local_ip_addr
or
global_ip_addr
HTTP Action
GET or POST
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
The version in the request must be V1.1 or higher. (See Request Header
on page 10.)
Example
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.range.delete&name=range1
112 of 124
P e r f o r m a n c e
b y
D e s i g n
nat.range.deleteAll
Description
Request
Description
Session ID assigned by the AX device following successful authentication.
nat.range.deleteAll
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response
General XML status response. (See Error Handling and Error Codes on
page 16.)
Version
The version in the request must be V1.1 or higher. (See Request Header
on page 10.)
Example
URL: https://10.10.10.5/services/rest/V1.1/
HTTP Action: GET or Post
HTTP Body: session_id=123456789&method=nat.range.deleteAll
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
113 of 124
114 of 124
P e r f o r m a n c e
b y
D e s i g n
system.config-file.upload
Description
Upload configuration files and system files from the AX device to remote
servers.
Table 73 describes the request parameters for this method.
Description
Session ID assigned by the AX device following successful authentication
system.config-file.upload
Type of file(s) to upload:
Data Type
String
Range
N/A
Default
N/A
String
String
N/A
1-256
characters
N/A
N/A
String
N/A
N/A
protocol
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
115 of 124
Description
Hostname or IP address of the remote server.
Data Type
String
save-filename
String
destinationfolder
String
port
username
password
file-format
Range
1-255
characters
1-63
characters
1-191
characters
Default
N/A
Integer
1-65535
21
String
1-255
characters
N/A
String
1-255
characters
N/A
N/A
String
N/A
/
(in ASCII,
%2F)
text
The AX device does not accept any additional aXAPI requests while the
file transfer is in progress.
Note:
HTTP Action
GET
Version
Example
http://10.10.10.5/services/rest/V1/?session_id=********************&
method=system.config-file.upload&file-type=startup-config&
protocol=FTP&port=21&host=192.168.3.214&save-filename=my_config&file-format=text&
username=anonymous
116 of 124
P e r f o r m a n c e
b y
D e s i g n
http://AX_Address/services/rest/V1/?session_id=********************&
method=system.config-file.upload&file-type=running-config&
protocol=TFTP&host=192.168.3.214&save-filename=my_config&file-format=text
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
117 of 124
118 of 124
P e r f o r m a n c e
b y
D e s i g n
Error Messages
Table 74 lists the error messages that can be returned by the aXAPI.
Note:
TABLE 74
Message
Number
1001
A10 Networks recommends that applications use the error codes rather
than the error text to detect and handle errors, because the message text
may change over time.
1002
1003
1004
1005
1006
WS_RESULT_CODE_MEM
1007
1008
1009
1010
1011
1012
1013
WS_RESULT_CODE_AUTH_FAIL
1014
1015
1016
WS_RESULT_CODE_SRVGRP_MTD
1017
WS_RESULT_CODE_SRVGRP_PORT
1018
WS_RESULT_CODE_SRVGRP_CONNLIMIT
1019
WS_RESULT_CODE_SRVGRP_CONNRESUME
1020
WS_RESULT_CODE_SRVGRP_WEIGHT
1021
WS_RESULT_CODE_SRVGRP_PRI
1022
WS_RESULT_CODE_SRVGRP_STATUS
WS_RESULT_CODE_INPARAM
WS_RESULT_CODE_INVER
WS_RESULT_CODE_NOT_WRITABLE
WS_RESULT_CODE_NOT_PRIVILEGE
WS_RESULT_CODE_AUTH_MATCH
WS_RESULT_CODE_AUTH_SID
WS_RESULT_CODE_SESS_CLOSE
WS_RESULT_CODE_SRVGRP_NAMETAG
WS_RESULT_CODE_SRVGRP_NAME
WS_RESULT_CODE_SRVGRP_TYPE
WS_RESULT_CODE_SRVGRP_IP
WS_RESULT_CODE_SRVGRP_IPTYPE
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
Message Text
The web service only accepts the
HTTPS protocol.
Memory fault
Invalid parameters
Invalid version parameter
Access denied: no write privilege
Access denied: no privilege for this
method
Authentication failed
Invalid web service method name
Invalid session ID
Failed to close aXAPI session
Missing name parameter tag
Can not find the service group name
Invalid service group type. Must be 2
or 3.
Invalid load-balancing method
Invalid server IP address
Only one type of service group IP
address is supported (IPv4 or IPv6)
Invalid service group port number.
Valid range is 0-65535.
Invalid service group conn_limit. Valid
range is 1-1000000.
Invalid service group conn_resume.
Valid range is 0-1000000.
Invalid service group weight. Valid
range is 1-100.
Invalid service group priority. Valid
range is 1-16.
Invalid service group status. Must be 0
or 1.
119 of 124
TABLE 74
1023
1024
WS_RESULT_CODE_SRVGRP_MATCHMEM
1025
1026
1027
1028
1029
1030
WS_RESULT_CODE_VIRTUAL_DUP
1031
WS_RESULT_CODE_VIRTUAL_HA
1032
WS_RESULT_CODE_VIRTUAL_ARP
1033
WS_RESULT_CODE_VIRTUAL_TYPE
1034
WS_RESULT_CODE_VIRTUAL_PORT
1035
WS_RESULT_CODE_VIRTUAL_SRVGRP
1036
WS_RESULT_CODE_VIRTUAL_VPORT
1037
WS_RESULT_CODE_VIRTUAL_CONNLIMIT
1038
WS_RESULT_CODE_VIRTUAL_ACL
1039
WS_RESULT_CODE_VIRTUAL_VPORT_HA
1040
WS_RESULT_CODE_VIRTUAL_DSR
1041
WS_RESULT_CODE_VIRTUAL_SYN
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
WS_RESULT_CODE_VIRTUAL_INMATCH
WS_RESULT_CODE_SRVGRP_MEMLIST
WS_RESULT_CODE_VIRTUAL_NAMETAG
WS_RESULT_CODE_VIRTUAL_NAME
WS_RESULT_CODE_VIRTUAL_IPTAG
WS_RESULT_CODE_VIRTUAL_IP
WS_RESULT_CODE_VIRTUAL_STATUS
WS_RESULT_CODE_VIRTUAL_VPORTINMATCH
WS_RESULT_CODE_VIRTUAL_AFLEX
WS_RESULT_CODE_SRVNODE_DUP
WS_RESULT_CODE_SRVNODE_NAMETAG
WS_RESULT_CODE_SRVNODE_NAME
WS_RESULT_CODE_SRVNODE_IPTAG
WS_RESULT_CODE_SRVNODE_IP
WS_RESULT_CODE_SRVNODE_STATUS
WS_RESULT_CODE_SRVNODE_CONNLIMIT
120 of 124
P e r f o r m a n c e
b y
D e s i g n
1052
WS_RESULT_CODE_SRVNODE_CONNRESUME
1053
WS_RESULT_CODE_SRVNODE_LIMIT_LT_RESUME
1054
WS_RESULT_CODE_SRVNODE_WEIGHT
1055
WS_RESULT_CODE_SRVNODE_PORT
1056
WS_RESULT_CODE_SRVNODE_TYPE
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
WS_RESULT_CODE_SRVNODE_PORT_LIST
1067
1068
1069
1070
1071
1072
1073
WS_RESULT_CODE_CONFIG_HOSTTAG
1074
1075
1076
1077
WS_RESULT_CODE_EXIST_HEALTH_MONITOR
1078
1079
WS_RESULT_CODE_EXIST_HTTP_TEMPL
1080
1081
WS_RESULT_CODE_EXIST_TCPPROXY_TEMPL
1082
WS_RESULT_CODE_EXIST_PERSISSRCIP_TEMPL
1083
1084
WS_RESULT_CODE_EXIST_CLISSL_TEMPL
WS_RESULT_CODE_SRVNODE_INMATCH
WS_RESULT_CODE_SRVNODE_MATCHPORT
WS_RESULT_CODE_IF_PORT
WS_RESULT_CODE_IF_INMATCH
WS_RESULT_CODE_CONFIG_FILETYPETAG
WS_RESULT_CODE_CONFIG_FILETYPE
WS_RESULT_CODE_CONFIG_FILENAME_NOEXIST
WS_RESULT_CODE_CONFIG_PROTOCOLTAG
WS_RESULT_CODE_CONFIG_PROTOCOL
WS_RESULT_CODE_CONFIG_HOST
WS_RESULT_CODE_CONFIG_SAVEFILETAG
WS_RESULT_CODE_CONFIG_SAVEFILE
WS_RESULT_CODE_CONFIG_FILEFMT
WS_RESULT_CODE_CONFIG_PORTTAG
WS_RESULT_CODE_CONFIG_PORT
WS_RESULT_CODE_EXIST_SERVICEGROUP
WS_RESULT_CODE_EXIST_AFLEX
WS_RESULT_CODE_SYS_BUSY
WS_RESULT_CODE_EXIST_CONNREUSE_TEMPL
WS_RESULT_CODE_EXIST_PERSISCOOKIE_TEMPL
WS_RESULT_CODE_EXIST_SRVSSL_TEMPL
P e r f o r m a n c e
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
121 of 124
TABLE 74
1085
1086
1087
1088
1089
1090
WS_RESULT_CODE_EXIST_TCP_TEMPL
WS_RESULT_CODE_EXIST_UDP_TEMPL
WS_RESULT_CODE_EXIST_RTSP_TEMPL
WS_RESULT_CODE_EXIST_SMTP_TEMPL
WS_RESULT_CODE_EXIST_SIP_TEMPL
WS_RESULT_CODE_EXIST_PBSLB_POLICY
122 of 124
P e r f o r m a n c e
b y
D e s i g n
P e r f o r m a n c e
124
b y
D e s i g n
P e r f o r m a n c e
b y
Corporate Headquarters
A10 Networks, Inc.
2309 Bering Dr.
San Jose, CA 95131-1125 USA
Tel: +1-408-325-8668 (main)
Tel: +1-408-325-8676 (support - worldwide)
Tel: +1-888-822-7210 (support - toll-free in USA)
Fax: +1-408-325-8666
www.a10networks.com
124
D e s i g n