@@ -4,120 +4,63 @@ TODO Overview is a required section
44
55## Requirements
66
7- ### 🔐 Setting Up API User and Access on A10 Thunder
87
9- This section explains how to configure an API user and enable API (AXAPI) access on an A10 Thunder device using the CLI.
8+ ### Creating a User for API Access on A10 vThunder
109
11- #### ✅ Prerequisites
10+ This guide explains how to create a user on A10 vThunder for API (AXAPI) access with appropriate privileges.
1211
13- - Admin credentials for the A10 Thunder device
14- - SSH access to the device
15- - Familiarity with A10 CLI commands
16-
17- ---
18-
19- #### 🧑💻 Step 1: Create an API User
20-
21- 1 . SSH into the A10 Thunder device:
22-
23- ``` bash
24- ssh admin@< DEVICE_IP>
25- ```
26-
27- 2 . Enter configuration mode:
12+ #### Step-by-Step Instructions
2813
14+ 1 . ** Enter configuration mode:**
2915 ``` bash
3016 configure terminal
3117 ```
3218
33- 3 . Create a user account for API access:
34-
19+ 2 . ** Create the user and set a password:**
3520 ``` bash
36- username < api_user > password < secure_password >
21+ admin apiuser password yourStrongPassword
3722 ```
3823
39- 4 . Assign admin privileges:
24+ Replace ` apiuser ` with the desired username, and ` yourStrongPassword ` with a secure password.
4025
26+ 3 . ** Assign necessary privileges:**
4127 ``` bash
42- username < api_user> privilege 15
28+ privilege read
29+ privilege write
30+ privilege partition-enable-disable
31+ privilege partition-read
32+ privilege partition-write
4333 ```
4434
45- 5 . (Optional) Assign a role if using Role-Based Access Control (RBAC):
35+ These privileges grant the user:
36+ - Global read and write access
37+ - Per-partition read and write access
38+ - Permission to enable or disable partitions
4639
40+ 4 . ** (Optional) Enable external health monitor privilege (if needed):**
4741 ``` bash
48- username < api_user > role < role_name >
42+ privilege hm
4943 ```
5044
51- 6 . Save the configuration:
52-
45+ 5 . ** Exit user configuration:**
5346 ``` bash
54- write memory
55- ```
56-
57- ---
58-
59- #### 🌐 Step 2: Enable and Verify API Access
60-
61- A10 Thunder supports AXAPI, a REST-based API. Follow these steps to confirm access:
62-
63- 1 . Ensure the management interface allows API traffic (if access-lists are used):
64-
65- ``` bash
66- ip access-list standard mgmt
67- permit < MGMT_SUBNET> < SUBNET_MASK>
6847 exit
69-
70- interface management
71- access-list mgmt
7248 ```
7349
74- 2 . (Optional) Bind SSL cert for secure access:
50+ #### Notes
7551
76- ``` bash
77- slb ssl-cert < CERT_NAME>
78- key < KEY_FILE>
79- certificate < CERT_FILE>
80- ```
81-
82- 3 . Authenticate using AXAPI v3 (example using ` curl ` ):
83-
84- ``` bash
85- curl -k -X POST https://< DEVICE_IP> /axapi/v3/auth \
86- -H " Content-Type: application/json" \
87- -d ' {"credentials": {"username": "<api_user>", "password": "<password>"}}'
88- ```
89-
90- A successful response will include an ` authresponse ` with an authorization token.
91-
92- ---
52+ - This user will now be able to authenticate and perform actions via A10's AXAPI (v2/v3) interface.
53+ - Role-Based Access (RBA) and partition assignment can further fine-tune access control.
9354
94- #### 🔁 Step 3: Use the API Token
95-
96- Use the returned token for authorized API calls:
55+ #### Example Login via AXAPI
9756
57+ Example using ` curl ` for AXAPI v3 login:
9858``` bash
99- curl -k -X GET https://< DEVICE_IP> /axapi/v3/system/resource-usage \
100- -H " Authorization: A10 <AUTH_TOKEN>"
59+ curl -X POST https://< vThunder-IP> /axapi/v3/auth \
60+ -d ' {"credentials":{"username":"apiuser","password":"yourStrongPassword"}}' \
61+ -H " Content-Type: application/json"
10162```
10263
103- ---
104-
105- #### 📌 Notes
106-
107- - You can also create users via the GUI:
108- ** System → Admin → Users**
109-
110- - Roles (for RBAC) can be managed under:
111- ** System → Admin → Role**
112-
113- - Always use HTTPS and avoid hardcoding credentials in scripts
114-
115- ---
116-
117- #### 📚 Resources
118-
119- - [ AXAPI Documentation] ( https://support.a10networks.com/ )
120- - [ A10 Thunder CLI Reference Guide] ( https://docs.a10networks.com/ )
12164
12265
12366## Post Installation
0 commit comments