AX Series™ Advanced Traffic Manager aXAPI Reference

P e r f o r m a n c e
b y
D e s i g n
AX Series Advanced Traffic Manager
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
A10 Networks, Inc. 6/21/2010 - All Rights Reserved
Information in this document is subject to change without notice.

Trademarks:
A10 Networks, the A10 logo, ACOS, aFleX, aXAPI, IDaccess, IDsentrie, IP-to-ID,
SoftAX, Virtual Chassis, and VirtualN are trademarks or registered trademarks of
A10 Networks, Inc. All other trademarks are property of their respective owners.
Patents Protection:
A10 Networks products including all AX Series products are protected by one or
more of the following US patents and patents pending: 7716378, 7675854, 7647635,
7552126, 20090049537, 20080229418, 20080040789, 20070283429, 20070271598,
20070180101
A10 Networks Inc. software license and end users agreement
Software for all AX Series products contains trade secrets of A10 Networks and its
subsidiaries and Customer agrees to treat Software as confidential information.
Anyone who uses the Software does so only in compliance with the terms of this
Agreement. Customer shall not:
1) reverse engineer, reverse compile, reverse de-assemble or otherwise translate the
Software by any means
2) sublicense, rent or lease the Software.
Disclaimer
The information presented in this document describes the specific products noted
and does not imply nor grant a guarantee of any technical performance nor does it
provide cause for any eventual claims resulting from the use or misuse of the products described herein or errors and/or omissions. A10 Networks, Inc. reserves the
right to make technical and other changes to their products and documents at any
time and without prior notification.
No warranty is expressed or implied; including and not limited to warranties of noninfringement, regarding programs, circuitry, descriptions and illustrations herein.
Environmental Considerations
Some electronic components may possibly contain dangerous substances. For information on specific component types, please contact the manufacturer of that component. Always consult local authorities for regulations regarding proper disposal of
electronic components in your area.
Further Information
For additional information about A10 products, terms and conditions of delivery, and
pricing, contact your nearest A10 Networks, Inc. location which can be found by visiting www.a10networks.com.
AX Series - aXAPI Reference

About This Document
About This Document

This document describes the proprietary Management Information Base
(MIB) of the A10 Networks AX Series Advanced Traffic Manager.
Additional information is available for AX Series systems in the following
documents. These documents are included on the documentation CD
shipped with your AX Series system, and also are available on the A10 Networks support site:
AX Series Installation Guide
AX Series Configuration Guide
AX Series GUI Reference guide
AX Series CLI Reference Guide
AX Series aFleX Reference Guide
AX Series MIB Reference
System Description The AX Series

FIGURE 1
The AX Series Advanced Traffic Manager
The AX Series is the industrys best performing application acceleration

switch that helps organizations scale and maximize application availability
through the worlds most advanced application delivery platform. The
AX Series Advanced Core Operating System (ACOS) accelerates and
secures critical business applications, provides the highest performance and
reliability, and establishes a new industry-leading price/performance
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
AX Series - aXAPI Reference - Reference

About This Document
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
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

Contents
About This Document
System Description The AX Series .................................................................................................... 3

Audience.................................................................................................................................................. 4
Introduction
aXAPI Architecture ................................................................................................................................. 9

Request Format .................................................................................................................................... 10
Response Format ........................................................................................................................... 12
Example Session ............................................................................................................................ 13
Deleting Parameter Settings................................................................................................................ 15
Error Handling and Error Codes ......................................................................................................... 16
HTTP Status Codes ........................................................................................................................ 16
Error Codes and Messages ............................................................................................................ 17
Session Timeout ................................................................................................................................... 17
aXAPI Methods: Authentication and Session Close
19
authenticate ........................................................................................................................................... 19
session.close ......................................................................................................................................... 20
aXAPI Methods: SLB Real Server
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
aXAPI Methods: SLB Service Group
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
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

Contents
aXAPI Methods: SLB Virtual Server
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
aXAPI Methods: Interfaces
79
network.interface.fetchAllStatistics ........................................................................................................ 79
network.interface.fetchStatisticsByInterfaceNum .................................................................................. 82
aXAPI Methods: Network Address Translation
85
Dynamic IP NAT Configuration and Management..............................................................................85

Dynamic NAT Pool Methods .......................................................................................................... 85
nat.pool.getAll ........................................................................................................................................ 85
nat.pool.search ...................................................................................................................................... 86
nat.pool.fetchAllStatistics ....................................................................................................................... 88
nat.pool.fetchStatistics ........................................................................................................................... 89
nat.pool.create ....................................................................................................................................... 91
nat.pool.update ...................................................................................................................................... 92
nat.pool.delete ....................................................................................................................................... 93
nat.pool.deleteAll ................................................................................................................................... 94
nat.pool-group.getAll ............................................................................................................................. 94
nat.pool-group.search ............................................................................................................................ 96
nat.pool-group.create ............................................................................................................................ 97
nat.pool-group.update ........................................................................................................................... 98
nat.pool-group.delete ............................................................................................................................. 98
nat.pool-group.deleteAll ......................................................................................................................... 99
Static IP NAT Configuration and Management .................................................................................100

Static NAT Pool Methods ............................................................................................................. 100
nat.static-translation.getAll .................................................................................................................. 100
nat.static-translation.search ................................................................................................................. 101
nat.static-translation.fetchAllStatistics ................................................................................................. 102
nat.static-translation.fetchStatistics ..................................................................................................... 103
nat.static-translation.create ................................................................................................................. 104
nat.static-translation.update ................................................................................................................ 105
nat.static-translation.delete .................................................................................................................. 106
nat.static-translation.deleteAll .............................................................................................................. 107
nat.range.getAll ................................................................................................................................... 108
nat.range.search .................................................................................................................................. 109
6 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

Contents
nat.range.create ................................................................................................................................... 110
nat.range.update .................................................................................................................................. 111
nat.range.delete ................................................................................................................................... 112
nat.range.deleteAll ............................................................................................................................... 113
aXAPI Methods: Configuration Upload
115
system.config-file.upload ..................................................................................................................... 115
Error Messages
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

Contents
8 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

Introduction
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
b y
aXAPI Session Flow
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
9 of 124

Introduction
Admin Authentication
The aXAPI uses the same admin authentication resources as those configured for CLI and GUI access. For example, if the AX device is configured
to use RADIUS first to authenticate admins, RADIUS will be used first
when authenticating an admin for an aXAPI session.
Session ID
The first request from the third-party application sends the authentication
method along with a valid AX admin username and password.
If the username and password are valid, the AX device replies with a session ID. The third-party application must present the session ID with all
future requests during that session. The session ID is valid until the thirdparty application sends a session close request or the session times out.
Encoding
The aXAPI expects all data to be UTF-8 encoded, and it checks for valid
UTF-8 sequences. If an invalid sequence is found, the aXAPI assumes that
the data is ISO-8859-1 encoded and converts it to UTF-8. The aXAPI discards data that is sent in any other format.
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:
To use HTTP, you must disable HTTP-to-HTTPS redirection on the AX

device. In the CLI, use the no web-service auto-redir command at the
global configuration level of the CLI. In the GUI, select Config > System
> Settings. On the Web tab, de-select the Re-direct HTTP to HTTPS
checkbox. Click OK.
Request Header
The request header is a URL in the following format:
https://AX-ipaddr/services/rest/aXAPI-version/
The AX-ipaddr is the IP address of the AX device.
10 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

Introduction
The aXAPI-version specifies the API version to use:
V1 The aXAPI version supported in AX Release 2.0 and later.
V1.1 The aXAPI version supported in AX Release 2.4.2 and later.
All methods supported in V1 are also supported in V1.1. If a methods

implementation is changed from one aXAPI version to the next, the implementation in the specified aXAPI version will be used. Differences are
noted in the description for the method. (There are no differences in method
implementation between V1 and V1.1.)
The rest of the URL must be exactly as shown. For security, the request
must use the HTTPS protocol.
Request Body
The body consists of a set of parameters and values.
Here is an example of an aXAPI request:
https://192.168.100.140/services/rest/V1.1/?
session_id=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
&method=slb.vip.create&name=xyz_company
&address=201.2.1.100
&status=1
&service-list=service1%03http_service_config1%02service2%03https_service_config2
&service1=type%0314%02port%0380%02service_group%03http_srv_grp
&http_service_config1=http_templ%03http_tmpl1
&service2=type%0315%02port%03443%02service_group%03https_srv_grp
&https_service_config2=client_ssl_templ%03clientSSLTemplate%02server_ssl_templ%03server
SSLTemplate
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
aXAPI Request Delimiters
&
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.
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

Introduction
TABLE 1
aXAPI Request Delimiters (Continued)
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
and an HTTP response code of 200.

Responses to requests for a single element, when the element does not
exist, return an error message and an HTTP response code of 404.

See Error Handling and Error Codes on page 16 for a description of
status codes and error messages.
12 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

Introduction
Normally, a method call returns the following:
<?xml version="1.0" encoding="utf-8" ?>
<response status="ok">
[xml-payload]
</response>
However, if an error occurs, the following is returned instead:

<response status="fail">
<error code="[error-code]" msg="[error-message]" />
</response>
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
The header sends the request to the aXAPI interface on an AX device at IP

address 192.168.100.140.
The body contains the following parameters:
method This parameter states the type of operation being requested
In this example, the request is for a session ID to use with each subsequent request in the session.
username This parameter is an AX admin username.

password This is the password that goes with the username.
Response:
<session_id>XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</session_id>
</response>
The response sends a session ID, shown in this example as

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.
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

Introduction
Virtual Server Create Request:
https://192.168.100.140/services/rest/V1/?session_id=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
&method=slb.vip.create&name=xyz_company&address=201.2.1.100&status=1&servicelist=service1%03http_service_config1%02service2%03https_service_config2&service1=type%0
314%02port%0380%02service_group%03http_srv_grp&http_service_config1=http_templ%03http_t
mpl1&service2=type%0315%02port%03443%02service_group%03https_srv_grp&https_service_conf
ig2=client_ssl_templ%03clientSSLTemplate%02server_ssl_templ%03serverSSLTemplate
The header sends the request to the aXAPI interface on an AX device at IP

address 192.168.100.140.
The body contains the following configuration parameters:
session_id This parameter specifies the session ID returned by the
aXAPI in response to the authentication request from the third-party

application. The session ID must be included in the request and must be
valid.
method This parameter states the type of operation being requested
In this example, the request is to create a virtual server (slb.vip.create).

A method is required in every request.
The following parameters are specific to the slb.vip.create method. All
the parameters that are supported for each method are described in this
guide. The descriptions below are specifically for this example.
name This parameter specifies the name of the virtual server.

address This parameter specifies the IP address of the virtual server.
status This parameter specifies the status (1 = enabled, 0 = dis-
abled).
service-list This parameter specifies the service ports to config-
ure on the server. Each service port is defined by servicen, where n

uniquely identifies the service within the request, and by a set of parameters specific to the service type. The services and the sets of servicetype parameters each appear later in the request as separate parameters.
In this example, the service-list contains the following:
service1and its set of service-type parameters for HTTP,
http_service_config1. The http_service_config portion specifies
the service type and 1 identifies the specific instance of the service type. Use the same number for the service and the set of service
type parameters to be set for the service.
service2and its set of service-type parameters for HTTPS,
https_service_config2.
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
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

Introduction
number, and service_group specifies the name of the service group
to which to bind the service port.
http_service_config1 This parameter defines settings for
service1s HTTP service port. In this example, http_templ specifies

an HTTP template for the service port.
service2 This parameter defines settings that are not specific to the
service type, for service2.
https_service_config2 This parameter defines settings for
service1s HTTPS service port. In this example, client_ssl_templ

specifies the name of a client-SSL template, and
server_ssl_templ specifies the name of a server-SSL template.
Response:
</response>
This response indicates that the request was executed, with no errors. The
virtual server has been added to the AX devices configuration.
Deleting Parameter Settings

The aXAPI provides methods for deleting SLB resources. For example, the
slb.vip.delete method can be used to delete a virtual server.
You also can use the aXAPI to delete individual parameter settings for a
resource. In this case, to delete the parameter setting, use the parameter in
the request, but do not enter anything for the value.
For example, to clear the connection resume setting for a service port, send
an update request such as the following:
https://192.168.100.140/services/rest/V1/?session_id=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXa&
method=slb.service-group.update&name=test3&type=2&lb_method=1&health_monitor=ping
&conn_limit=1000000&conn_resume=&member-list=member1%02member2%02member3&member1=
address%031.1.1.2%02port%031234%02weight%032&member2=address%031.1.1.3%02port%031234%02
priority%033&member3=address%031.1.1.4%02port%031234%02status%030
Instead of a number, there is no parameter value following

&conn_resume=. Parameters that have default values will be reset to their
defaults by the delete operation.
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

Introduction
Error Handling and Error Codes

The aXAPI response can indicate an error condition, for example:
The requested information does not exist.
The aXAPI request is invalid; for example, a method or other parameter
is misspelled or has an incorrect value.

An internal error occurs.
An error response includes a numeric error code and a human-readable message.

Note:
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.
HTTP Status Codes

In addition to an error code and message, the aXAPI returns an appropriate
HTTP status code, such as the following:
200 OK. This is the HTTP successful status code, and means the
aXAPI request and response were successfully executed.

It is still possible for an error code and error message to be returned in
the response, if a successfully executed request and response results in
an error.
403 Forbidden. Standard HTTP status code.
404 Not Found. Standard HTTP status code.
500 Internal Server Error. This status code is used if an internal error
occurs.
999 The admin username or password sent with an authentication
request is not correct.
16 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

Introduction
Error Codes and Messages

aXAPI requests that result in errors include both a code and a message. The
error codes are divided into the following:
1001 to 9999. Indicate errors such as syntax errors, expired session,
invalid username or password, unsupported response format, and so on.

10001 or above. Indicates an internal error.
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.
USING THE GUI

1. Log into the management GUI with a valid admin account that has at
least read-write privileges.
2. Select Config > System > Settings.
3. On the menu bar, select Web.
4. Click the arrow next to aXAPI to display the configuration field and
value for the Timeout.
5. To change the timeout, edit the number in the aXAPI Timeout field.
6. Click OK.
USING THE CLI

1. Log into the CLI with a valid admin account that has at least read-write
privileges.
2. Use the following command to display the current aXAPI timeout:
show web-service
3. To change the timeout, use the following command at the global configuration level of the CLI:
web-service axapi-timeout-policy idle minutes
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

Introduction
18 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

authenticate
aXAPI Methods: Authentication and Session Close

This chapter describes the aXAPI methods for starting and closing aXAPI
sessions.
authenticate
Description
Get an aXAPI session ID from the AX device.
Request
Table 2 describes the request parameters for this method.
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
The version in the request must be V1 or higher. (See Request Header

on page 10.)
Example
Here is an authentication request with username admin and password

a10:
https://10.10.10.5/services/rest/V1/?method=authenticate&username=admin&password=a10
Here is the response from the AX device:

<session_id>123456789</session_id>
</response>
In this example, the session ID is 123456789. Each subsequent aXAPI

request during the session must include this session ID. For example, the
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
following request uses this session ID in a request for a list of all the real
servers configured on the AX device.
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.server.getAll
session.close
Description
Close an aXAPI session.
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
The aXAPI closes the session.
Version

on page 10.)
Example
Here is a request to close the session that has session ID 123456789:
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=session.close

<session_id>123456789</session_id>
</response>
20 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

slb.server.getAll
aXAPI Methods: SLB Real Server

This chapter describes the SLB real server methods in the aXAPI.
slb.server.getAll
Description
Get configuration information for all real servers configured on the AX

device.
Request
TABLE 4
Request Parameters
Parameter
Name
session_id
Description
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 describes the response fields for this method.
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.
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

slb.server.getAll
TABLE 5
Response Fields (Continued)
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

on page 10.)
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

slb.server.getAll
Example
Here is the request:
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.server.getAll

<servers>
<server name="_s_10.0.0.5" address="10.0.0.5" status="1" health_method=""
weight="1" conn_limit="1000000" conn_resume="0">
<ports>
<port port_num="0" protocol="3" status="1" health_method=""
conn_limit="1000000" conn_resume="0" weight="1" />
</ports>
</server>
<ports>
</ports>
</server>
<server name="_s_3.0.1.132" address="3.0.1.132" status="4"
health_method="(default)" weight="1" conn_limit="1000000" conn_resume="0">
<ports>
</ports>
</server>
<ports>
</ports>
</server>
<ports>
</ports>
</server>
</servers>
</response>
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
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
slb.server.search
Real server name.
address
Note: Specify the name or the IP address.

Only one of them is required.
Server IP 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

on page 10.)
Example
The following request gets configuration information for real server

3.0.1.134:
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.server.search
&address=3.0.1.134

<ports>
<port port_num="80" protocol="2" status="4" health_method="(default)"
</ports>
</server>
</response>
24 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

slb.server.fetchAllStatistics
Description
Get statistics for all real servers and their service ports.
Request
TABLE 7
Request Parameters
Parameter
Name
session_id
Description
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.
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

TABLE 8
Response Fields (Continued)
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

on page 10.)
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=

<servers>
<server name="_s_10.0.0.5" address="10.0.0.5" status="1" cur_conns="2"
tot_conns="14" p_conns="0" req_pkts="6" resp_pkts="571" req_bytes="360"
resp_bytes="75998">
<ports>
<port port_num="0" status="1" cur_conns="0" tot_conns="0" p_conns="0"
req_pkts="0" resp_pkts="0" req_bytes="0" resp_bytes="0" />
</ports>
</server>
resp_bytes="10830">
<ports>
26 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

slb.server.fetchStatistics
</ports>
</server>
resp_bytes="0">
<ports>
</ports>
</server>
resp_bytes="0">
<ports>
</ports>
</server>
resp_bytes="0">
<ports>
</ports>
</server>
</servers>
</response>
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
Real server name.
address

Only one of them is required.
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

HTTP Action
GET or POST
Response
Version

on page 10.)
Example
The following request gets statistics for real server 10.0.0.5:
https://10.10.10.5/services/rest/V1/session_id=123456789&method=slb.server.fetchStatistics&address=10.0.0.5

<server name="_s_10.0.0.5" address="10.0.0.5" status="1" cur_conns="1" tot_conns="14"
p_conns="0" req_pkts="6" resp_pkts="573" req_bytes="360" resp_bytes="76078">
<ports>
</ports>
</server>
</response>
Example
The following request gets statistics for real server _s_10.0.0.5:
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.server.fetchStatistics&name=_s_10.0.0.5

<server name="_s_10.0.0.5" address="10.0.0.5" status="1" cur_conns="1" tot_conns="14"
p_conns="0" req_pkts="6" resp_pkts="573" req_bytes="360" resp_bytes="76078">
<ports>
req_pkts="0" resp_pkts="0" req_bytes="0" resp_bytes="0" /><port
port_num="0" status="1" cur_conns="1" tot_conns="14" p_conns="0"
</ports>
</server>
</response>
28 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

slb.server.create
slb.server.create
Description
Create a real server and services on the server.
Request
TABLE 10 Request Parameters

Parameter
Name
session_id
method
name
address
status
Description
slb.server.create
Real server name.
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
Administrative weight of the server.

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:
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)
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
(Optional)
port-list
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.
server can have before the AX device can
start sending new connections to the server.
Service ports to add to the server.
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

slb.server.create
TABLE 10 Request Parameters (Continued)
Parameter
Name
port<n>
(Optional)
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

on page 10.)
Example
The following request creates real server server1, 192.168.200.100, with

TCP ports 23 and 80:
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

</response>
30 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

slb.server.update
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
page 16.)
Version

on page 10.)
Example
The following request disables ports 23 and 80 on server server1:
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

</response>
slb.server.delete
Description
Delete a specific real server.
Request

Parameter
Name
session_id
Description
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

slb.server.deleteAll
Parameter
Name
method
name
address
Description
slb.server.delete
Real server name.
Data Type
String
String
String
Range
N/A
1-31
N/A
Default
N/A
N/A
N/A
You can identify the server by name or IP address.

HTTP Action
POST only
Response
page 16.)
Example
The following request deletes real server server2:
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.server.delete
&name=server2

</response>
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

</response>
Description
Delete all real servers from the AX device.
Request

Parameter
Name
session_id
32 of 124
Description
Data Type
String
Range
N/A
b y
Default
N/A
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

slb.server.deletePort
Parameter
Name
method
Description
Data Type
String
Range
N/A
Default
N/A
HTTP Action
POST only
Response
page 16.)
Version

on page 10.)
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.server.
deleteAll

</response>
Description
Delete specific service ports from a real server.
Request

Parameter
Name
session_id
method
name
address
port-list
port<n>
Description
Real server name.
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
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

slb.server.deleteAllPorts
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
page 16.)
Version

on page 10.)
Example
The following request deletes port 80 from server2:
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.server.
deletePort&name=server2&port-list=port1&port1=port_num%038080

</response>
Description
Delete all service ports from a real server.
Request

Parameter
Name
session_id
method
name
address
Description
Real server name.
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
page 16.)
Version

on page 10.)
34 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

Example
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

</response>
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
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

slb.service-group.getAll
aXAPI Methods: SLB Service Group

This chapter describes the SLB service group methods in the aXAPI.
Description
Get configuration information for all SLB service groups configured on the
AX device.
Request

Parameter
Name
session_id
method
Description
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response
TABLE 16 Response Fields

Response
Field
service-groups
service-group
name
type
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
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

TABLE 16 Response Fields (Continued)
Response
Field
Status
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
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
occurs:
below conn_resume.
connections the server can have before the AX device can start sending new connections to
the port.
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

on page 10.)
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.servicegroup.getAll
38 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

slb.service-group.getByName
<service-groups>
<service-group name="wildcard_tcp" type="2" lb_method="0" status="1"
health_method="">
<members>
<member address="10.0.1.5" port="0" conn_limit="1000000" conn_resume="0"
weight="1" priority="1" status="1" />
</members>
</service-group>
<service-group name="wildcard_udp" type="2" lb_method="0" status="1"
health_method="">
<members>
</members>
</service-group>
<service-group name="SG_HTTP" type="2" lb_method="0" status="3" health_method="">
<members>
</members>
</service-group>
</service-groups>
</response>
Description
Get configuration information for a specific SLB service group.
Request

Parameter
Name
session_id
method
name
Description
Service group name.
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

HTTP Action
GET or POST
Response

Response
Field
service-group
name
type
Description
Service group name.
Service group type:
2 TCP
lb_method
3 UDP
0 RoundRobin
2 LeastConnection
6 FastResponseTime
7 LeastRequest
Status
8 StrictRoundRobin
0 disabled
1 All up
2 Partial up
3 Functional up
4 Down
health_monitor
members
40 of 124
5 Unknown
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

Response
Field
member
Description
XML tag for a specific service group member. The configuration of each member is shown
address Server IP address
port Service port number
occurs:
below conn_resume.
connections the server can have before the AX device can start sending new connections to
the port.
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

on page 10.)
Example
Here is a request for information about service group empty:
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.service-group.getByNam&name=empty

<service-group name="empty" type="2" lb_method="0" status="5" health_method="">
<members>
</members>
</service-group>
</response>
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
Get statistics for all service groups and their members.
Request

Parameter
Name
session_id
method
Description
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response

Response
Field
service-groups
service-group
name
Status
Description
XML tag for the collection of service groups.
Service group name.
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.
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

Response
Field
member
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

on page 10.)
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.servicegroup.fetchAllStatistics
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

<service-groups>
<service-group name="wildcard_tcp" status="1" cur_conns="0" tot_conns="45"
p_conns="0" req_pkts="10" resp_pkts="1073" req_bytes="600"
resp_bytes="275408">
<members>
<member address="10.0.1.5" port="0" status="1" cur_conns="0" tot_conns="22"
resp_bytes="107653" />
</members>
</service-group>
<service-group name="wildcard_udp" status="1" cur_conns="0" tot_conns="45"
resp_bytes="275408">
<members>
</members>
</service-group>
<service-group name="SG_HTTP" status="3" cur_conns="0" tot_conns="0" p_conns="0"
req_pkts="0" resp_pkts="0" req_bytes="0" resp_bytes="0">
<members>
p_conns="0" req_pkts="0" resp_pkts="0" req_bytes="0" resp_bytes="0" />
</members>
</service-group>
<service-group name="empty" status="5" cur_conns="0" tot_conns="0" p_conns="0"
<members>
</members>
</service-group>
</service-groups>
</response>
44 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

slb.service-group.fetchStatisticsByName
Description
Get statistics for a specific service group.
Request

Parameter
Name
session_id
method
name
Description
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

Response
Field
service-group
name
Status
Description
Service group name.
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.
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

Response
Field
member
Description
XML tag for a specific service group member. Statistics for each member are shown using the
following fields:
address Server IP address.
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

on page 10.)
Example
Here is a request for statistics for service group http_srv_grp1:
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.servicegroup.fetchStatisticsByName&name=SG_HTTP

<service-group name="SG_HTTP" status="3" cur_conns="0" tot_conns="0" p_conns="0"
<members>
</members>
</service-group>
</response>
46 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

slb.service-group.create
Description
Create a new service group and add members to it.
Request

Parameter
Name
session_id
method
name
type
Description
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
(Optional)
0 RoundRobin
2 LeastConnection
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)
^B: ASCII Code 0x02, URL-encode %02

Parameters for an individual member.
The following rows describe the member
parameters.
Use ^B between options and use ^C to separate values for an option.
address
port
^C: ASCII Code 0x03, URL-encode %03

IP address of the server.
Service port number.
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

Parameter
Name
conn_limit
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
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.
conn_resume
weight
priority
status
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.
port can have before the AX device can start
sending new connections to the port.
Administrative weight assigned to the service.
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 of the server and port within this service group:
0 Disabled
1 Enabled
1. The default Layer 3 health method is Ping.
HTTP Action
POST only
Response
page 16.)
48 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

slb.service-group.update
Version

on page 10.)
Example
Here is a request to create service group http_srv_grp that uses the

WeightedRoundRobin load-balancing method, with the following members:
Member1 1.1.1.2 at port 80, connection limit 1,000,000, no connec-
tion resume, weight 2, and priority 1

tion resume, weight 1, and priority 3

tion resume, weight 1, priority 1, with disabled status

https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.service-group.create&name=http_srv_grp1& type=2&lb_method=1&health_monitor=ping&memberlist=member1%02member2%02member3&member1=address%031.1.1.2%02port%0380%02weight%032&
member2=address%031.1.1.3%02port%0380%02priority%033& member3=address%031.1.1.4%02port
%0300%02status%030

</response>
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
page 16.)
Version

on page 10.)
Example
The following request updates service group http_srv_grp1 as follows:

Changes the load-balancing method to WeightedRoundRobin
Changes the weight of member 1.1.1.2:80 to 1
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

Changes the status of member 1.1.1.4:80 to enabled
Adds a new member, 1.1.1.100:80, with all default settings
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.servicegroup.update&name=http_srv_grp1&lb_method=6&member-list=member1%02member2%02member3&
member1=address%031.1.1.2%02port%0380%02weight%031& member2=address%031.1.1.4%02port
%0380%02status%030& member3=address%031.1.1.100%02port%0380

</response>
Example
The following request changes the load-balancing method of service group

http_srv_grp1 to LeastConnection:
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.servicegroup.update&name=http_srv_grp1&lb_method=2

</response>
Example
The following request disables two members in service group

http_srv_grp1 for maintenance:
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

</response>
50 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

slb.service-group.delete
Description
Delete a service group.
Request

Parameter
Name
session_id
method
name
Description
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
page 16.)
Version

on page 10.)
Example
The following request deletes service group http_srv_grp1:
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.servicegroup.delete&name=http_srv_grp1

</response>
slb.service-group.deleteAll
Description
Delete all service groups from the AX device.
Request

Parameter
Name
session_id
method
Description
slb.service-group.deleteAll
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

slb.service-group.deleteMember
HTTP Action
POST only
Response
page 16.)
Version

on page 10.)
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

</response>
Description
Delete specific members from a service group.
Request

Parameter
Name
session_id
method
name
member-list
Description
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
Use ^B between each member. For example:

member1^Bmember2^B memberN
member<n>

Address and service port of the member to
delete.
The following rows describe the member
parameters.
52 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

slb.service-group.deleteAllMembers
Parameter
Name
address
port
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
page 16.)
Version

on page 10.)
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

</response>
Description
Delete all members from a specific service group.
Request

Parameter
Name
session_id
method
name
Description
Service group name.
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

HTTP Action
POST only
Response
page 16.)
Version

on page 10.)
Example
The following request deletes all members from service group

http_srv_grp1:
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.servicegroup.deleteAllMembers&name=http_srv_grp1

</response>
54 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

slb.vip.getAll
aXAPI Methods: SLB Virtual Server

This chapter describes the SLB virtual server methods in the aXAPI.
slb.vip.getAll
Description
Get configuration information for all virtual servers configured on the AX

device.
Request

Parameter
Name
session_id
method
Description
slb.vip.getAll
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response

Response
Field
virtual-servers
virtual-server
name
address
status
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)
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

slb.vip.getAll
Response
Field
services
service
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
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.
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
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

slb.vip.getAll
Response
Field
service
Description
acl Access Control List (ACL) bound to the virtual service port.
(cont.)
aflex aFleX policy bound to the virtual service port.

pbslb Policy-based SLB (PBSLB) configuration on the virtual service port.
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
source_ip_p_templ Source-IP persistence template name.

XML tag for HTTPS services. Service parameter settings are returned in the following fields:
nat_pool Source NAT pool name.
client_ssl_templ Client-SSL template name.
server_ssl_templ Server-SSL template name.
fast_http_servic
e_config

XML tag for Fast-HTTP services. Service parameter settings are returned in the following
fields:
tcp_templ TCP template name.
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

slb.vip.getAll
Response
Field
tcp_service_con
fig
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
udp_service_co
nfig

XML tag for UDP services. Service parameter settings are returned in the following fields:
0 Disabled
1 Enabled
udp_templ UDP template name.
58 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

slb.vip.getAll
Response
Field
rtsp_service_co
nfig
Description
XML tag for Real Time Streaming Protocol (RTSP) services. Service parameter settings are
returned in the following fields:
0 Disabled
1 Enabled
0 Disabled
1 Enabled
rtsp_templ Multimedia (RTSP) template name.
ftp_service_conf
ig

XML tag for FTP services. Service parameter settings are returned in the following fields:
0 Disabled
1 Enabled
0 Disabled
1 Enabled
mms_service_co
nfig

XML tag for Microsoft Media Server (MMS) services. Service parameter settings are returned
in the following fields:
0 Disabled
1 Enabled
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

slb.vip.getAll
Response
Field
ssl_proxy_servi
ce_config
Description
XML tag for SSL-Proxy services. Service parameter settings are returned in the following
fields:
smtp_service_co
nfig

XML tag for Simple Mail Transfer Protocol (SMTP) services. Service parameter settings are
returned in the following fields:
smtp_templ SMTP template name.
sip_service_con
fig

XML tag for Session Initiation Protocol (SIP) services. Service parameter settings are returned
in the following fields:
sip_templ SIP template name.
Version

on page 10.)
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.vip.getAll

<virtual-servers>
<virtual-server name="wildcard_vip_01" address="::" status="1" ha_group="0"
arp_disabled="0">
<services>
<service type="5" port="0" status="1" service_group="wildcard_tcp"
conn_limit="1000000"> <http_service_config />
</service>
<service type="3" port="0" status="1" service_group="wildcard_udp"
conn_limit="1000000">
<udp_service_config ha_conn_mirror="0" dsr="1" />
</service>
conn_limit="1000000">
<tcp_service_config ha_conn_mirror="0" dsr="1" syn_cookie="0" />
</service>
</services>
</virtual-server>
60 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

slb.vip.search
<virtual-server name="VS01" address="3.0.6.140" status="3" ha_group="1"
arp_disabled="0">
<services>
<service type="14" port="80" status="3" service_group="SG_HTTP"
conn_limit="1000000"><http_service_config nat_pool="30" />
</service>
</services>
</virtual-server>
</virtual-servers>
</response>
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

Parameter
Name
session_id
method
name
Description
slb.vip.search
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
Version

on page 10.)
Example
The following request gets information about a virtual server, by sending

the virtual servers name in the request:
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.vip.search
&name=wildcard_vip_01
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
<virtual-server name="wildcard_vip_01" address="::" status="1" ha_group="0"
arp_disabled="0">
<services>
conn_limit="1000000"> <http_service_config />
</service>
<service type="3" port="0" status="1" service_group="wildcard_udp"
conn_limit="1000000"> <udp_service_config ha_conn_mirror="0" dsr="1" />
</service>
conn_limit="1000000"><tcp_service_config ha_conn_mirror="0" dsr="1"
syn_cookie="0" />
</service>
</services>
</virtual-server>
</response>
Description
Get statistics for all virtual servers.
Request

Parameter
Name
session_id
method
Description
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response

Response
Field
virtual-servers
virtual-server
name
address
62 of 124
Description
XML tag for the collection of the virtual servers.
XML tag for a specific virtual server.
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

Response
Field
status
Description
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.
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

on page 10.)
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
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
<virtual-servers>
<virtual-server name="wildcard_vip_01" address="::" status="1" cur_conns="4"
tot_conns="55" p_conns="0" req_pkts="10" resp_pkts="942"
req_bytes="600" resp_bytes="212543">
<services>
<service port="0" status="1" cur_conns="0" tot_conns="0" p_conns="0"
</services>
</virtual-server>
<virtual-server name="VS01" address="3.0.6.140" status="3" cur_conns="0"
resp_bytes="0">
<services>
</services>
</virtual-server>
</virtual-servers>
</response>
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

Parameter
Name
session_id
method
name
Description
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
64 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

slb.vip.create
Version

on page 10.)
Example
The following request gets statistics for virtual server 3.0.6.140:
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.vip.fetchStatistics&address=3.0.6.140

<virtual-server name="VS01" address="3.0.6.140" status="3" cur_conns="0"
resp_bytes="0">
<services>
</services>
</virtual-server>
</response>
slb.vip.create
Description
Create a virtual server and virtual services on the server.
Request

Parameter
Name
session_id
method
name
address
status
Description
slb.vip.create
(Optional)
0 Disabled
ha_group
1 Enabled
High Availability (HA) group the virtual
server is in.
(Optional)
arp_disabled
(Optional)
Indicates whether the AX device responds to

ARP requests sent to the virtual server
address:
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
0 Disabled (ARP is enabled)

1 Enabled (ARP is disabled)
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

slb.vip.create
Parameter
Name
service-list
(Optional)
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
The following rows describe the virtual service port parameters.

service<n>
(Optional)

XML tag for a specific virtual service. The
configuration of each virtual service uses 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
service_group Service group bound to
this virtual service port.
0 Disabled
1 Enabled
(cont.)
66 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

slb.vip.create
Parameter
Name
service<n>
(Optional)
(cont.)
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
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.
http_service_co
nfig<n>:
(Optional)
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.
aflex aFleX policy bound to the virtual
service port.
pbslb Policy-based SLB (PBSLB) configuration on the virtual service port.
The following parameters configure settings

for individual service types.
XML tag for HTTP services. Service parameters are set using the following fields:
conn_reuse_templ Connection-reuse
template name.
tcp_proxy_templ TCP-Proxy template
name.
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

slb.vip.create
Parameter
Name
https_service_co
nfig<n>:
(Optional)
fast_http_servic
e_config<n>:
(Optional)
68 of 124
Description
XML tag for HTTPS services. Service
parameters are set using the following fields:
client_ssl_templ Client-SSL template
name.
server_ssl_templ Server-SSL template
name.
template name.
XML tag for Fast-HTTP services. Service
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
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

slb.vip.create
Parameter
Name
tcp_service_con
fig<n>:
(Optional)
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
0 Disabled (Destination NAT is
enabled)
syn_cookie State of the software-based
SYN cookie feature:
0 Disabled
udp_service_co
nfig<n>:
(Optional)
1 Enabled
XML tag for UDP services. Service parameters are set using the following fields:
service port:
0 Disabled
1 Enabled
enabled)
udp_templ UDP template name.
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

slb.vip.create
Parameter
Name
rtsp_service_co
nfig<n>:
(Optional)
Description
XML tag for Real Time Streaming Protocol
(RTSP) services. Service parameters are set
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
enabled)
SYN cookie feature:
0 Disabled
ftp_service_conf
ig<n>:
(Optional)
1 Enabled
rtsp_templ Multimedia (RTSP) template
name.
XML tag for FTP services. Service parameters are set using the following fields:
service port:
0 Disabled
1 Enabled
enabled)
SYN cookie feature:
0 Disabled
1 Enabled
70 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

slb.vip.create
Parameter
Name
mms_service_co
nfig<n>:
(Optional)
Description
XML tag for Microsoft Media Server (MMS)
services. Service parameters are set using the
following fields:
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
XML tag for SSL-Proxy services. Service
name.
name.
XML tag for Simple Mail Transfer Protocol
(SMTP) services. Service parameters are set
name.
name.
smtp_templ SMTP template name.
XML tag for Session Initiation Protocol (SIP)
services. Service parameters are set using the
following fields:
sip_templ SIP template name.
HTTP Action
POST only
Response
page 16.)
Version

on page 10.)
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
Example
The following request creates virtual server xyz_company, 201.2.1.100

with the following virtual services:
HTTP virtual service at port 80, using service group http_srv_grp,
with source NAT pool my_nat_pool

HTTPS virtual service at port 443, using service group https_srv_grp,
with client SSL template clientSSLTemplate and server-SSL template

serverSSLTemplate
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.vip.create&name=xyz_company&addres=201.2.1.100&status=1&service-list=service1%03http_service_
config1%02service2%03https_service_config2&service1=type%0314%02port%0380%02service_gro
up%03http_srv_grp&http_service_config1=nat_pool%03my_nat_pool&service2=type%0315%02port
%03443%02service_group%03https_srv_grp&https_service_config2=client_ssl_templ%03clientS
SLTemplate%02server_ssl_templ%03serverSSLTemplate

</response>
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
page 16.)
Version

on page 10.)
72 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

slb.vip.update
Example
The following request updates virtual server xyz_company as follows:

The HTTP virtual service at port 80 is updated to use HTTP template
httpTemplate and connection reuse template connectionReuse1.

The HTTPS virtual service at port 443 is disabled.
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.vip.update
&name=xyz_company&service-list=servic1%03http_service_config1%02service2&service1=
port%0380& http_service_config1=http_templ%03httpTemplate%02conn_reuse_temp%03
connectionReuse1& service2=port%03443%02status%030

</response>
Example
The following request updates virtual server 192.168.1.100 to use HA group

2:
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.vip.update
&address=192.168.1.100&ha_group=2

</response>
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

</response>
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
slb.vip.delete
Description
Delete a specific virtual server.
Request

Parameter
Name
session_id
method
name
address
Description
slb.vip.delete
Data Type
String
Range
N/A
Default
N/A
String
String
String
N/A
1-31
N/A
N/A
N/A
N/A
name.
HTTP Action
POST only
Response
page 16.)
Version

on page 10.)
Example
The following request deletes virtual server http_vip1:
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.vip.delete
&name=http_vip1

</response>
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
The string a%3aa%3a%3a%3ab%3ac is the URL encoding of

a:a::b:c.
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

slb.vip.deleteAll
</response>
slb.vip.deleteAll
Description
Delete all virtual servers from the AX device.
Request

Parameter
Name
session_id
method
Description
slb.vip.deleteAll
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
POST only
Response
page 16.)
Version

on page 10.)
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=slb.vip.deleteAll

</response>
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
Delete a specific service from a virtual server.
Request

Parameter
Name
session_id
method
name
address
service-list
service<n>
Description
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
name.
HTTP Action
POST only
Response
page 16.)
Version

on page 10.)
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

</response>
76 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

slb.vip.deleteAllServices
Description
Delete all virtual service ports from a virtual server.
Request

Parameter
Name
session_id
method
name
address
Description
Data Type
String
Range
N/A
Default
N/A
String
String
String
N/A
1-31
N/A
N/A
N/A
N/A
name.
HTTP Action
POST only
Response
page 16.)
Version

on page 10.)
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

</response>
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
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

network.interface.fetchAllStatistics
aXAPI Methods: Interfaces

This chapter describes the interface methods in the aXAPI.
Description
Get statistics for all physical Ethernet interfaces.
Request

Parameter
Name
session_id
method
Description
Response
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A

Response
Field
interfaces
interface
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.
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

Response
Field
interface
(cont.)
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

on page 10.)
Example
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=network.interface.
fetchAllStatistics

<interfaces>
<interface int_num="1" description="ethernet 1" mtu="1500" speed="1000000"
mac_address="0090.0b0c.a5dc" pri_ip_add="192.168.12.130/255.255.255.0"
admin_status="1" oper_status="1"
in_bytes="313122" in_unicast_pkts="231" in_nonunicast_pkts="12"
in_discards="0" in_errors="0"
in_discards="0" in_errors="0" />
mac_address="0090.0b0c.a5dd" pri_ip_add="a:a:b:c::a/64"
80 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

mac_address="0090.0b0c.a5de" pri_ip_add="0"
mac_address="0090.0b0c.a5df" pri_ip_add="0"
mac_address="0090.0b0c.a5e0" pri_ip_add="0"
</interfaces>
</response>
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
Get statistics for a specific physical Ethernet interface.
Request

Parameter
Name
session_id
method
ilnt_num
Description
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

Response
Field
interface
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
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

Response
Field
interface
Description
in_bytes Total number of bytes received on the interface.
(cont.)
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

on page 10.)
Example
Here is a request for statistics for Ethernet interface 2:
https://10.10.10.5/services/rest/V1/?session_id=123456789&method=fetchStatisticsByInterfaceNum&int_num=2

mac_address="0090.0b0c.a5dd" pri_ip_add="a:a:b:c::a/64"
</response>
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
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

nat.pool.getAll
aXAPI Methods: Network Address Translation

This chapter describes aXAPI methods for configuring and managing the
following IP source NAT resources:
Resources for dynamic IP source NAT:
IP address pool
Pool group
Resources for static IP source NAT:
IP address mapping (single one-to-one mapping of internal source
address to global address)

Range list (mapping of a range of internal addresses to a range of
global addresses)
Dynamic IP NAT Configuration and Management

Dynamic NAT Pool Methods
You can use the following aXAPI methods to configure and manage IP
address pools for dynamic NAT.
nat.pool.getAll
Description
Get configuration information for all dynamic NAT pools configured on the
AX device.
Request

Parameter
Name
session_id
method
Description
nat.pool.getAll
HTTP Action
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

nat.pool.search
Response

Response
Field
pools
pool
start_ip_addr
end_ip_addr
netmask
gateway
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

<pools>
<pool name=pool1 start_ip_addr="1.1.1.1" end_ip_addr="1.1.1.5"
netmask=255.255.255.0 gateway=3.3.3.3 ha_group="1" />
<pool name=pool3 start_ip_addr="3001::1" end_ip_addr="3001::3"
netmask=64 gateway=3001::10 ha_group="2" />
<pool name=pool4 start_ip_addr="4001::1" end_ip_addr="4001::5"
netmask=64 gateway=4001::10 ha_group="2" />
</pools>
</response>
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
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

nat.pool.search
Parameter
Name
session_id
method
name
Description
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
Version
on page 10.)
Example
The following request gets configuration information for NAT pool

pool1:
HTTP Body: session_id=123456789&method=nat.pool.search&name=pool1

<pools>
</pools>
</response>
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
Get statistics for all IP NAT pools.
Request

Parameter
Name
session_id
method
Description
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response

Response
Field
pools
pool
name
start_ip_addr
end_ip_addr
acls
acl
Description
XML tag for the collection of NAT pools.
XML tag for a specific NAT pool.
Name of the NAT 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
acl_hits Number if times traffic has matched the ACL.

Number of sessions currently being NATted for pool clients.
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.
Total number of times allocation of an address from the pool to a client failed.
Version
on page 10.)
Example
HTTP Body: session_id=123456789&method=nat.pool.fetchAllStatistics
88 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

nat.pool.fetchStatistics
Example

<pools>
<pool name=pool1 start_ip_addr="10.10.10.1" end_ip_addr=10.10.10.11
total_acl_hits=15535 port_usage="5" total_used="10378" total_freed=10373
total_failed=203>
<acls>
<acl acl_id=1 acl_hits=38792 />
</acls>
</pool>
<pool name=pool2 start_ip_addr="3001::3001" end_ip_addr= 3001::3002
port_usage="6" total_used="10568" total_freed=10562 total_failed=235>
<acls>
<
/acls>
</pool>
</pools>
</response>
Description
Get statistics for a specific IP NAT pool.
Request

Parameter
Name
session_id
method
name
Description
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
Version
on page 10.)
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

Example
The following request gets statistics for pool pool1:
HTTP Body: session_id=123456789&method=nat.pool.fetchStatistics&name=pool1

<pools>
total_failed=203>
<acls>
</acls>
</pool>
</pools>
</response>
Example
The following request gets statistics for the pool that has starting IP address
10.10.10.1:
HTTP Body: session_id=123456789&method=nat.pool.fetchStatistics&
start_ip_addr=10.10.10.1

<pools>
total_failed=203>
<acls>
</acls>
</pool>
</pools>
</response>
90 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

nat.pool.create
nat.pool.create
Description
Create an IP NAT pool.
Request

Parameter
Name
session_id
method
name
start_ip_addr
end_ip_addr
netmask
gateway
ha_group
Description
nat.pool.create
Name of the NAT 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).
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
page 16.)
Version
on page 10.)
Example
The following request creates IP NAT pool pool1:
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

<response status="ok>
</response>
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

nat.pool.update
Example
The following request creates IP NAT pool pool3:
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

</response>
nat.pool.update
Description
Update a NAT pool.
Request
The method name is nat.pool.update. The other parameters are the same as
HTTP Action
GET or POST
Response
page 16.)
Version
on page 10.)
Example
The following request updates NAT pool pool1:
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

</response>
92 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

nat.pool.delete
nat.pool.delete
Description
Delete a specific IP NAT pool.
Request

Parameter
Name
session_id
method
name
Description
nat.pool.delete
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
page 16.)
Version
on page 10.)
Example
The following request deletes NAT pool pool1:
HTTP Body: session_id=123456789&method=nat.pool.delete&name=pool1

</response>
Example
The following request deletes the NAT pool that has beginning IP address
1.1.1.1:
HTTP Body: session_id=123456789&method=nat.pool.delete&start_ip_addr=1.1.1.1

</response>
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
nat.pool.deleteAll
Description
Delete all dynamic IP NAT pools from the AX device.
Request

Parameter
Name
session_id
method
Description
nat.pool.deleteAll
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response
page 16.)
Version
on page 10.)
Example
HTTP Body: session_id=123456789&method=nat.pool.deleteAll

</response>
Dynamic NAT Pool Group Methods

You can use the following aXAPI methods to configure and manage pool
groups for dynamic NAT.
nat.pool-group.getAll
Description
Get configuration information for all dynamic NAT pool groups configured
on the AX device.
Request
94 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

Parameter
Name
session_id
method
Description
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response

Response
Field
pool-groups
pool-group
name
members
member
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
on page 10.)
Example
HTTP Body: session_id=123456789&method=nat.pool-group.getAll

<?xml version="1.0" encoding="utf-8"
<pool-groups>
<pool-group name=pgrp1>
<members>
<member name=pool1
<member name=pool2
<member name=pool3
</members>
</pool-group>
<members>
<member name=pool4
</members>
</pool-group>
</pool-groups>
</response>
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
Get information about a specific pool group.
Request

Parameter
Name
session_id
method
name
Description
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
Version
on page 10.)
Example
The following request gets configuration information for NAT pool group
pgrp1:
HTTP Body: session_id=123456789&method=nat.pool-group.search&name=pgrp1

<?xml version="1.0" encoding="utf-8"
<pool-groups>
<members>
<member name=pool1
<member name=pool2
<member name=pool3
</members>
</pool-group>
</pool-groups>
</response>
96 of 124
?>
/>
/>
/>
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

nat.pool-group.create
nat.pool-group.create
Description
Create an IP NAT pool group.
Request

Parameter
Name
session_id
method
name
member-list
member<n>
Description
nat.pool.create
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
page 16.)
Version
on page 10.)
Example
The following request creates pool group pgrp1:
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

</response>
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
nat.pool-group.update
Description
Update a NAT pool group.
Request
The method name is nat.pool-group.update. The other parameters are the

same as those in Table 55 on page 97.
HTTP Action
GET or POST
Response
page 16.)
Version
on page 10.)
Example
The following request updates pool group pgrp1:
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

</response>
nat.pool-group.delete
Description
Delete a specific IP NAT pool group.
Request

Parameter
Name
session_id
method
name
Description
nat.pool-group.delete
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
page 16.)
98 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

nat.pool-group.deleteAll
Version
on page 10.)
Example
The following request deletes pool group pgrp1:
HTTP Body: session_id=123456789&method=nat.pool-group.delete&name=pgrp1

</response>
Description
Delete all IP NAT pool groups from the AX device.
Request

Parameter
Name
session_id
method
Description
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response
page 16.)
Version
on page 10.)
Example
HTTP Body: session_id=123456789&method=nat.pool-group.deleteAll

</response>
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
Static IP NAT Configuration and Management

Static NAT Pool Methods
You can use the following aXAPI methods to configure and manage static
NAT translations.
Description
Get configuration information for all static IP NAT translations configured

on the AX device.
Request

Parameter
Name
session_id
method
Description
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response

Response
Field
static-pools
static-pool
source_ip_addr
global_ip_add
ha_group
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.
Version
on page 10.)
Example
HTTP Body: session_id=123456789&method=nat.static-translation.getAll
100 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

nat.static-translation.search
<static-pools>
<static-pool source_ip_addr="1.1.1.1" global_ip_addr="10.10.10.1" ha_group="1" />
</static-pools>
</response>
Description
Get information about a specific static IP NAT translation. You can request
information based on source IP address or global IP address.
Request

Parameter
Name
session_id
method
source_ip_addr
or
Description
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
Version
on page 10.)
Example
The following request gets configuration information for a static NAT translation with source IP address 1.1.1.1:
HTTP Body: session_id=123456789&method=nat.static-translation.search&source_ip_addr=1.1.1.1
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
<static-pools>
</static-pools>
</response>
Description
Get statistics for all static IP NAT translations.
Request

Parameter
Name
session_id
method
Description
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response

Response
Field
static-pools
static-pool
source_ip_addr
port_usage
total_used
total_freed
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
on page 10.)
Example
HTTP Body: session_id=123456789&method=nat.static-translation.fetchAllStatistics
102 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

nat.static-translation.fetchStatistics
Example

<static-pools>
<static-pool source_ip_addr="1.1.1.1" port_usage="5" total_used="10378"
total_freed=10373 />
<static-pool source_ip_addr="1.1.1.3" port_usage="0"
total_used="2378" total_freed=2378 />
</static-pools>
</response>
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

Parameter
Name
session_id
method
source_ip_addr
Description
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
Version
on page 10.)
Example
The following request gets statistics for the static IP NAT translation with
inside address 1.1.1.1:
HTTP Body: session_id=123456789&method=nat.static-translation.fetchStatistics&
source_ip_addr=1.1.1.1
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
<static-pools>
</static-pools>
</response>
Description
Create a static IP NAT translation.
Request

Parameter
Name
session_id
method
source_ip_addr
global_ip_add
ha_group
Description
Inside address to be translated into a global
address.
Global address to use for the inside address.
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
page 16.)
Version
on page 10.)
Example
The following request creates a static IP NAT translation that translates

source IP address 1.1.1.1 into 2.2.2.1 and uses HA group 1:
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
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

nat.static-translation.update
</response>
nat.static-translation.update
Description
Update a static IP NAT translation.
Request
The method name is nat.static-translation.update. The other parameters are

the same as those in Table 63 on page 103.
You can identify the translation by source IP address or global IP address.
HTTP Action
GET or POST
Response
page 16.)
Version
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:
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

</response>
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
Delete a specific static IP NAT translation.
Request

Parameter
Name
session_id
method
source_ip_addr
Description
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
page 16.)
Version
on page 10.)
Example
The following request deletes the static IP NAT translation for inside
address 1.1.1.1:
HTTP Body: session_id=123456789&method=nat.static-translation.delete&source_ip_addr=1.1.1.1

</response>
106 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

nat.static-translation.deleteAll
Description
Delete all static IP NAT translations from the AX device.
Request

Parameter
Name
session_id
method
Description
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response
page 16.)
Version
on page 10.)
Example
HTTP Body: session_id=123456789&method=nat.static-translation.deleteAll

</response>
Source NAT Range List Methods

You can use the following aXAPI methods to configure and manage static
NAT range lists.
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
nat.range.getAll
Description
Get configuration information for all static IP NAT range lists configured on
the AX device.
Request

Parameter
Name
session_id
method
Description
nat.range.getAll
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response

Response
Field
nat-ranges
nat-range
name
local_ip_addr
local_ip_mask
global_ip_addr
global_ip_mask
count
ha_group
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.
Version
on page 10.)
Example
HTTP Body: session_id=123456789&method=nat.range.getAll
108 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

nat.range.search
<nat-ranges>
<nat-range 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 name="range2" local_ip_addr="5.5.5.1" local_ip_mask=255.255.255.0
global_ip_addr=10.10.10.1 global_ip_mask=255.255.255.0 count=1
ha_group=2 />
</nat-ranges>
</response>
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

Parameter
Name
session_id
method
name
or
Description
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
Version
on page 10.)
Example
The following request gets configuration information for static NAT range
range1:
HTTP Body: session_id=123456789&method=nat.range.search&name=range1
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
<nat-ranges>
<nat-range 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-ranges>
</response>
nat.range.create
Description
Create a static IP NAT range list.
Request

Parameter
Name
session_id
method
name
local_ip_addr
local_ip_netmask
global_ip_addr
global_ip_netmask
count
ha-group
Description
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.
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
page 16.)
Version
on page 10.)
110 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

nat.range.update
Example
The following request creates static IP NAT range list range1:
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

</response>
nat.range.update
Description
Update a static IP NAT range list.
Request
The method name is nat.range.update. The other parameters are the same as
HTTP Action
GET or POST
Response
page 16.)
Version
on page 10.)
Example
The following request updates the configuration of static IP NAT range list
range1:
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

</response>
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
nat.range.delete
Description
Delete a specific static IP NAT range list.
Request

Parameter
Name
session_id
method
name
or
Description
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
page 16.)
Version
on page 10.)
Example
The following request deletes static IP NAT range list range1:
HTTP Body: session_id=123456789&method=nat.range.delete&name=range1

</response>
112 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

nat.range.deleteAll
nat.range.deleteAll
Description
Delete all static IP NAT range lists from the AX device.
Request

Parameter
Name
session_id
method
Description
nat.range.deleteAll
Data Type
String
Range
N/A
Default
N/A
String
N/A
N/A
HTTP Action
GET or POST
Response
page 16.)
Version
on page 10.)
Example
HTTP Body: session_id=123456789&method=nat.range.deleteAll

</response>
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

nat.range.deleteAll
114 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

system.config-file.upload
aXAPI Methods: Configuration Upload

This chapter describes the aXAPI method for uploading a configuration file
from the AX device to a remote server.
Description
Upload configuration files and system files from the AX device to remote
servers.

Parameter
Name
session_id
method
file-type
Description
Session ID assigned by the AX device following successful authentication
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
system Uploads the startup-config file,

aFleX files, and SSL certificates and keys.
startup-config (or startup%2Dconfig)
Uploads the startup-config file.
running-config (or running%2Dconfig)
Uploads the running-config.
profile-name Uploads a configuration
profile.
Note: If you enter any string other than system, startup-config, or running-config,
the aXAPI assumes that the string is a configuration profile.
protocol
Note: If the profile name contains a dash or

other special characters, you must use the
ASCII equivalent. For example, for a dash,
use %2D.
File transfer protocol to use:
FTP File Transfer Protocol
TFTP Trivial File Transfer Protocol
RCP Unix Remote Copy Protocol
SCP Secure Copy Protocol
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

Parameter
Name
host
Description
Hostname or IP address of the remote server.
Data Type
String
save-filename
Name to which to save the file.
String
destinationfolder
Filename and directory path on the remote

server. Specify the directory path relative to
the home directory for the file transfer protocol.
For FTP sessions, the protocol port number
for the control session.
String
port
username
password
file-format
Note: This parameter is applicable only for

FTP, and is required only if the server does
not use the default FTP port number.
Username required for access to the remote
server.
Note: The username and password are
required if the protocol is FTP, RCP, or SCP.
Password required for access to the remote
server.
Format in which to save the file:
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
text Simple text file

tgz Gnu-zipped .tar file
Note: If the file-type is system, the file-format must be tgz.
Note:
The AX device does not accept any additional aXAPI requests while the
file transfer is in progress.
Note:
The URL strings sent to the AX device must be in URL encoding.
HTTP Action
GET
Version

on page 10.)
Example
The following request uses anonymous FTP to upload the startup-config:
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
Here is the response:

<?xml version="1.0" encoding="utf-8" ?><response status="ok">upload startup-config to
192.168.3.214:/www by FTP protocol.</response>
116 of 124
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

Example
The following request uses TFTP to upload the running-config:
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
Here is the response:

<?xml version="1.0" encoding="utf-8" ?><response status="ok">upload running-config to
192.168.3.214:/www by TFTP protocol.</response>
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
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

Error Messages
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.
aXAPI Error Messages

Message Code
WS_RESULT_CODE_HTTPS
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
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.
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

Error Messages
aXAPI Error Messages (Continued)
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
Can not find the service group member

Invalid service group member list
parameter
The virtual server already exists
Can not find the virtual server name
Missing address parameter tag
Invalid virtual server IP address
Invalid virtual server status. Must be 0
or 1.
Invalid virtual server HA group. Must
be 1 or 2.
Invalid virtual server ARP status. Must
be 0 or 1.
Invalid virtual server port type. Must
be 2, 3, 8, 9, 10, 11, 12, 14, 15, 16 or
17.
Invalid virtual server port. Valid range
is 0-65534.
Invalid virtual server port service
group parameter
Invalid virtual server service list
parameter
Invalid virtual server port conn_limit.
Invalid virtual server port ACL number. Valid range is 1-199.
Invalid
virtual
server
port
ha_conn_mirror state. Must be 0 or 1.
Invalid virtual server port DSR state.
Must be 0 or 1.
Invalid virtual server port syn_cookie
state. Must be 0 or 1.
Can not find the virtual server
Can not find the virtual server port
aFleX syntax or compiler error
The server already exists
Can not find the server name
Missing address parameter tag
Invalid server IP address
Invalid server status. Must be 0 or 1.
Invalid server connection limit. Valid
range is 1-1000000.
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

Error Messages
TABLE 74
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
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
Invalid server connection resume

value. Valid range is 0-1000000.
Connection resume value cannot be
larger than connection limit value
Invalid server weight. Valid range is 1100.
Invalid server port number. Valid range
is 0-65534.
Invalid server port protocol. Must be 2
or 3.
Invalid server port list parameter
Can not find the server
Can not find the server port
Can not find the port parameter
Can not find the interface
Missing file-type parameter tag
Can not find the file-type
Can not find the filename in AX
Missing protocol parameter tag
Invalid protocol. Must be ftp, tftp, rcp
or scp.
Missing host parameter tag
Can not find the host
Missing save-filename parameter tag
Can not find the save-filename
Invalid file-format. Must be text or tgz.
Missing port parameter tag
Invalid port number. Valid range is 165534.
Health Monitor does not exist
Service group does not exist
aFleX does not exist
aXAPI is still processing a previous
request. Please try again later.
Http template does not exist
Connection reuse template does not
exist
TCP proxy template does not exist
Persistent cookie template does not
exist
Persistent source IP template does not
exist
Client SSL template does not exist
Server SSL template does not exist
121 of 124

Error Messages
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
TCP template does not exist

UDP template does not exist
RTSP template does not exist
SMTP template does not exist
SIP template does not exist
PBSLB policy template does not exist
b y
D e s i g n
Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010
124
b y
D e s i g n
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

AX Series™ Advanced Traffic Manager aXAPI Reference

Transféré par

Informations du document

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

AX Series™ Advanced Traffic Manager aXAPI Reference

Transféré par

Droits d'auteur :

Formats disponibles

P e r f o r m a n c e

AX Series Advanced Traffic Manager

A10 Networks, Inc. 6/21/2010 - All Rights Reserved

Information in this document is subject to change without notice.

AX Series - aXAPI Reference

About This Document

System Description The AX Series

The AX Series Advanced Traffic Manager

The AX Series is the industrys best performing application acceleration

AX Series - aXAPI Reference - Reference

Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

AX Series - aXAPI Reference

About This Document

System Description The AX Series .................................................................................................... 3

aXAPI Architecture ................................................................................................................................. 9

aXAPI Methods: Authentication and Session Close

aXAPI Methods: SLB Real Server

aXAPI Methods: SLB Service Group

AX Series - aXAPI Reference - Reference

aXAPI Methods: SLB Virtual Server

aXAPI Methods: Interfaces

aXAPI Methods: Network Address Translation

Dynamic IP NAT Configuration and Management..............................................................................85

Static IP NAT Configuration and Management .................................................................................100

Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

AX Series - aXAPI Reference

aXAPI Methods: Configuration Upload

system.config-file.upload ..................................................................................................................... 115

AX Series - aXAPI Reference - Reference

Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

AX Series - aXAPI Reference

aXAPI Session Flow

AX Series - aXAPI Reference - Reference

To use HTTP, you must disable HTTP-to-HTTPS redirection on the AX

Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

AX Series - aXAPI Reference

All methods supported in V1 are also supported in V1.1. If a methods

aXAPI Request Delimiters

AX Series - aXAPI Reference - Reference

aXAPI Request Delimiters (Continued)

and an HTTP response code of 200.

exist, return an error message and an HTTP response code of 404.

status codes and error messages.

Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

AX Series - aXAPI Reference

However, if an error occurs, the following is returned instead:

The header sends the request to the aXAPI interface on an AX device at IP

username This parameter is an AX admin username.

The response sends a session ID, shown in this example as

AX Series - aXAPI Reference - Reference

The header sends the request to the aXAPI interface on an AX device at IP

aXAPI in response to the authentication request from the third-party

method This parameter states the type of operation being requested

In this example, the request is to create a virtual server (slb.vip.create).

name This parameter specifies the name of the virtual server.

service-list This parameter specifies the service ports to config-

ure on the server. Each service port is defined by servicen, where n

Document No.: D-030-01-00-0010 - Ver. 2.4.3 6/21/2010

AX Series - aXAPI Reference

service1s HTTP service port. In this example, http_templ specifies

service type, for service2.

https_service_config2 This parameter defines settings for

service1s HTTPS service port. In this example, client_ssl_templ

Deleting Parameter Settings