Skip to content

Commit ff80f8f

Browse files
author
Keyfactor
committed
Update generated docs
1 parent abdc8a3 commit ff80f8f

File tree

1 file changed

+28
-87
lines changed

1 file changed

+28
-87
lines changed

README.md

Lines changed: 28 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -70,121 +70,62 @@ The a10vThunder Universal Orchestrator extension If you have a support issue, pl
7070
Before installing the a10vThunder Universal Orchestrator extension, we recommend that you install [kfutil](https://github.com/Keyfactor/kfutil). Kfutil is a command-line tool that simplifies the process of creating store types, installing extensions, and instantiating certificate stores in Keyfactor Command.
7171

7272

73-
### 🔐 Setting Up API User and Access on A10 Thunder
73+
### Creating a User for API Access on A10 vThunder
7474

75-
This section explains how to configure an API user and enable API (AXAPI) access on an A10 Thunder device using the CLI.
75+
This guide explains how to create a user on A10 vThunder for API (AXAPI) access with appropriate privileges.
7676

77-
#### ✅ Prerequisites
78-
79-
- Admin credentials for the A10 Thunder device
80-
- SSH access to the device
81-
- Familiarity with A10 CLI commands
82-
83-
---
84-
85-
#### 🧑‍💻 Step 1: Create an API User
86-
87-
1. SSH into the A10 Thunder device:
88-
89-
```bash
90-
ssh admin@<DEVICE_IP>
91-
```
92-
93-
2. Enter configuration mode:
77+
#### Step-by-Step Instructions
9478

79+
1. **Enter configuration mode:**
9580
```bash
9681
configure terminal
9782
```
9883

99-
3. Create a user account for API access:
100-
101-
```bash
102-
username <api_user> password <secure_password>
103-
```
104-
105-
4. Assign admin privileges:
106-
84+
2. **Create the user and set a password:**
10785
```bash
108-
username <api_user> privilege 15
86+
admin apiuser password yourStrongPassword
10987
```
11088

111-
5. (Optional) Assign a role if using Role-Based Access Control (RBAC):
89+
Replace `apiuser` with the desired username, and `yourStrongPassword` with a secure password.
11290

91+
3. **Assign necessary privileges:**
11392
```bash
114-
username <api_user> role <role_name>
93+
privilege read
94+
privilege write
95+
privilege partition-enable-disable
96+
privilege partition-read
97+
privilege partition-write
11598
```
11699

117-
6. Save the configuration:
100+
These privileges grant the user:
101+
- Global read and write access
102+
- Per-partition read and write access
103+
- Permission to enable or disable partitions
118104

105+
4. **(Optional) Enable external health monitor privilege (if needed):**
119106
```bash
120-
write memory
107+
privilege hm
121108
```
122109

123-
---
124-
125-
#### 🌐 Step 2: Enable and Verify API Access
126-
127-
A10 Thunder supports AXAPI, a REST-based API. Follow these steps to confirm access:
128-
129-
1. Ensure the management interface allows API traffic (if access-lists are used):
130-
110+
5. **Exit user configuration:**
131111
```bash
132-
ip access-list standard mgmt
133-
permit <MGMT_SUBNET> <SUBNET_MASK>
134112
exit
135-
136-
interface management
137-
access-list mgmt
138113
```
139114

140-
2. (Optional) Bind SSL cert for secure access:
115+
#### Notes
141116

142-
```bash
143-
slb ssl-cert <CERT_NAME>
144-
key <KEY_FILE>
145-
certificate <CERT_FILE>
146-
```
147-
148-
3. Authenticate using AXAPI v3 (example using `curl`):
149-
150-
```bash
151-
curl -k -X POST https://<DEVICE_IP>/axapi/v3/auth \
152-
-H "Content-Type: application/json" \
153-
-d '{"credentials": {"username": "<api_user>", "password": "<password>"}}'
154-
```
155-
156-
A successful response will include an `authresponse` with an authorization token.
157-
158-
---
159-
160-
#### 🔁 Step 3: Use the API Token
117+
- This user will now be able to authenticate and perform actions via A10's AXAPI (v2/v3) interface.
118+
- Role-Based Access (RBA) and partition assignment can further fine-tune access control.
161119

162-
Use the returned token for authorized API calls:
120+
#### Example Login via AXAPI
163121

122+
Example using `curl` for AXAPI v3 login:
164123
```bash
165-
curl -k -X GET https://<DEVICE_IP>/axapi/v3/system/resource-usage \
166-
-H "Authorization: A10 <AUTH_TOKEN>"
124+
curl -X POST https://<vThunder-IP>/axapi/v3/auth \
125+
-d '{"credentials":{"username":"apiuser","password":"yourStrongPassword"}}' \
126+
-H "Content-Type: application/json"
167127
```
168128

169-
---
170-
171-
#### 📌 Notes
172-
173-
- You can also create users via the GUI:
174-
**System → Admin → Users**
175-
176-
- Roles (for RBAC) can be managed under:
177-
**System → Admin → Role**
178-
179-
- Always use HTTPS and avoid hardcoding credentials in scripts
180-
181-
---
182-
183-
#### 📚 Resources
184-
185-
- [AXAPI Documentation](https://support.a10networks.com/)
186-
- [A10 Thunder CLI Reference Guide](https://docs.a10networks.com/)
187-
188129
<details><summary>A10 Thunder Ssl Certificates (ThunderSsl)</summary>
189130

190131
### A10 Thunder Ssl Certificates Requirements

0 commit comments

Comments
 (0)