|
2 | 2 |
|
3 | 3 | TODO Overview is a required section |
4 | 4 |
|
5 | | -## Requirements |
6 | | - |
7 | | - |
8 | | -### Creating a User for API Access on A10 vThunder |
9 | | - |
10 | | -This guide explains how to create a user on A10 vThunder for API (AXAPI) access with appropriate privileges. |
11 | | - |
12 | | -#### Step-by-Step Instructions |
13 | | - |
14 | | -1. **Enter configuration mode:** |
15 | | - ```bash |
16 | | - configure terminal |
17 | | - ``` |
18 | | - |
19 | | -2. **Create the user and set a password:** |
20 | | - ```bash |
21 | | - admin apiuser password yourStrongPassword |
22 | | - ``` |
23 | | - |
24 | | - Replace `apiuser` with the desired username, and `yourStrongPassword` with a secure password. |
25 | | - |
26 | | -3. **Assign necessary privileges:** |
27 | | - ```bash |
28 | | - privilege read |
29 | | - privilege write |
30 | | - privilege partition-enable-disable |
31 | | - privilege partition-read |
32 | | - privilege partition-write |
33 | | - ``` |
34 | | - |
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 |
39 | | - |
40 | | -4. **(Optional) Enable external health monitor privilege (if needed):** |
41 | | - ```bash |
42 | | - privilege hm |
43 | | - ``` |
44 | | - |
45 | | -5. **Exit user configuration:** |
46 | | - ```bash |
47 | | - exit |
48 | | - ``` |
49 | | - |
50 | | -#### Notes |
51 | | - |
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. |
54 | | - |
55 | | -#### Example Login via AXAPI |
56 | | - |
57 | | -Example using `curl` for AXAPI v3 login: |
58 | | -```bash |
59 | | -curl -X POST https://<vThunder-IP>/axapi/v3/auth \ |
60 | | - -d '{"credentials":{"username":"apiuser","password":"yourStrongPassword"}}' \ |
61 | | - -H "Content-Type: application/json" |
62 | | -``` |
63 | | - |
64 | | - |
65 | | - |
66 | | -## Post Installation |
67 | | - |
68 | | -TODO Post Installation 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 |
69 | | - |
70 | | -## Discovery |
71 | | - |
72 | | -TODO Discovery 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 |
73 | | - |
0 commit comments