Skip to content

Commit 01c254f

Browse files
author
Keyfactor
committed
Update generated docs
1 parent 626707f commit 01c254f

File tree

1 file changed

+71
-2
lines changed

1 file changed

+71
-2
lines changed

README.md

Lines changed: 71 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,22 @@ The a10vThunder Universal Orchestrator extension implements 2 Certificate Store
4242
TODO Global Store Type Section is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info
4343

4444

45-
TODO Overview is a required section
45+
#### 🔒 SSL Certificates
46+
47+
**Purpose:**
48+
Used for securing traffic that passes through the device (i.e., traffic handled by SLB/ADC features).
49+
50+
**Usage Context:**
51+
- SSL Offloading
52+
- SSL Intercept (Decryption/Encryption)
53+
- Reverse proxy configurations
54+
55+
**Configured In:**
56+
- **GUI:** `ADC → Ssl Management
57+
58+
59+
**Example:**
60+
If the A10 is acting as an SSL offloader for a backend web server, the **SSL Certificate** is used to terminate client HTTPS sessions.
4661
</details>
4762

4863
<details><summary>A10 Thunder Management Certificates (ThunderMgmt)</summary>
@@ -76,7 +91,61 @@ Before installing the a10vThunder Universal Orchestrator extension, we recommend
7691
TODO Global Store Type Section is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info
7792

7893

79-
TODO Requirements is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info
94+
#### Creating a User for API Access on A10 vThunder
95+
96+
This guide explains how to create a user on A10 vThunder for API (AXAPI) access with appropriate privileges.
97+
98+
##### Step-by-Step Instructions
99+
100+
1. **Enter configuration mode:**
101+
```bash
102+
configure terminal
103+
```
104+
105+
2. **Create the user and set a password:**
106+
```bash
107+
admin apiuser password yourStrongPassword
108+
```
109+
110+
Replace `apiuser` with the desired username, and `yourStrongPassword` with a secure password.
111+
112+
3. **Assign necessary privileges:**
113+
```bash
114+
privilege read
115+
privilege write
116+
privilege partition-enable-disable
117+
privilege partition-read
118+
privilege partition-write
119+
```
120+
121+
These privileges grant the user:
122+
- Global read and write access
123+
- Per-partition read and write access
124+
- Permission to enable or disable partitions
125+
126+
4. **(Optional) Enable external health monitor privilege (if needed):**
127+
```bash
128+
privilege hm
129+
```
130+
131+
5. **Exit user configuration:**
132+
```bash
133+
exit
134+
```
135+
136+
##### Notes
137+
138+
- This user will now be able to authenticate and perform actions via A10's AXAPI (v2/v3) interface.
139+
- Role-Based Access (RBA) and partition assignment can further fine-tune access control.
140+
141+
##### Example Login via AXAPI
142+
143+
Example using `curl` for AXAPI v3 login:
144+
```bash
145+
curl -X POST https://<vThunder-IP>/axapi/v3/auth \
146+
-d '{"credentials":{"username":"apiuser","password":"yourStrongPassword"}}' \
147+
-H "Content-Type: application/json"
148+
```
80149
</details>
81150

82151

0 commit comments

Comments
 (0)