User Management
- Last Updated: October 14, 2024
- 1 minute read
- LoadMaster
- Multi-Tenant LoadMaster
- Documentation
Change the System Password
This command can be used to change the password of the default bal user.
Example Command
curl -k "https://<Username>:<Password>@<MTIPAddress>/mtaccess/usersetsyspassword?currpassword=<CurrentPassword>&password=<NewPassword>"Available Parameters
|
Parameter |
Parameter Type |
Parameter Description |
Mandatory |
|---|---|---|---|
|
currpassword |
String |
The current password for the default bal user. |
Yes |
|
password |
String |
The new password for the default bal user. |
Yes |
Example Output
<Response stat="200" code="ok"><Success>Password Changed</Success></Response>Add a New Local User
This command adds a new local user.
Example Command
curl -k "https://<Username>:<Password>@<MTIPAddress>/mtaccess/useraddlocal?user=<Username>&password=<Password>&radius=<0/1>"Available Parameters
|
Parameter |
Parameter Type |
Parameter Description |
Mandatory |
|---|---|---|---|
|
user |
String |
The username of the new user being created. |
Yes |
|
password |
String |
The password of the new user being created. |
Yes |
|
radius |
Boolean |
Specify whether or not RADIUS server authentication will be used when this user is logging on. The RADIUS server details must be configured in order to enable this option. 0 - Disabled 1 - Enabled |
Yes |
Example Output
<Response stat="200" code="ok"><Success>Command completed ok</Success></Response>List All Local Users
This command lists all local users and their permissions.
Example Command
curl -k "https://<Username>:<Password>@<MTIPAddress>/mtaccess/userlist"Example Output
<Response stat="200" code="ok"><Success><Data><User><Name>ExampleUser</Name><Perms>,backup,certs,cert3,certbackup</Perms></User></Data></Success></Response>Display Permissions for a Particular Local User
This command displays permissions for a particular local user.
Example Command
curl -k "https://<Username>:<Password>@<MTIPAddress>/mtaccess/usershow?user=<Username>"Available Parameters
|
Parameter |
Parameter Type |
Parameter Description |
Mandatory |
|---|---|---|---|
|
user |
String |
The username of the user to display the permissions for. |
Yes |
Example Output
<Response stat="200" code="ok"><Success><Data><User><Name>ExampleUser</Name><Perms>,backup,certs,cert3,certbackup</Perms></User></Data></Success></Response>Set Permissions for a Local User
This command can be used to set permissions for a specified local user.
Example Command
curl -k "https://<Username>:<Password>@<MTIPAddress>/mtaccess/usersetperms?user=<Username>&perms=<CommaSeparatedListOfPermissions>"Available Parameters
|
Parameter |
Parameter Type |
Parameter Description |
Mandatory |
|---|---|---|---|
|
user |
String |
The username of the user to set the permissions for. |
Yes |
|
perms |
String |
A comma-separated list of permissions. The valid values for this parameter are below:
|
Yes |
Example Output
<Response stat="200" code="ok"><Success>Command completed ok</Success></Response>Delete a Local User
This command deletes the specified local user.
Example Command
curl -k "https://<Username>:<Password>@<MTIPAddress>/mtaccess/userdellocal?user=<Username>"Available Parameters
|
Parameter |
Parameter Type |
Parameter Description |
Mandatory |
|---|---|---|---|
|
user |
String |
The username of the user to be deleted. |
Yes |
Example Output
<Response stat="200" code="ok"><Success>Command completed ok</Success></Response>Change the Password of a Local User
This command can be used to change the password of a local user.
Example Command
curl -k "https://<Username>:<Password>@<MTIPAddress>/mtaccess/userchangelocpass?user=<Username>&password=<NewPassword>&radius=<0/1>"Available Parameters
|
Parameter |
Parameter Type |
Parameter Description |
Mandatory |
|---|---|---|---|
|
user |
String |
The username of the user to change the password for. |
Yes |
|
password |
String |
The new password for the specified user. |
Yes |
|
radius |
Boolean |
Specify whether or not RADIUS server authentication will be used when this user is logging on. The RADIUS server details must be configured in order to enable this option. 0 - Disabled 1 - Enabled |
Yes |
Example Output
<Response stat="200" code="ok"><Success>Reset Password for ExampleUser</Success></Response>