Adds an entitlement to a user group.
maas $PROFILE user-group add-entitlement [--help] [-d] [-k] id [data ...]
Positional arguments
| Argument | Effect |
|---|---|
| id | The ID of the resource (e.g., 1, abc123) |
Command-line options
| Option | Effect |
|---|---|
| –help, -h | Show this help message and exit. |
| -d, --debug | Display more information about API responses. |
| -k, --insecure | Disable SSL certificate check. |
Keywords
Keyword “resource_type”
Optional String. The resource type
(‘maas’ or ‘pool’).
Keyword “resource_id”
Optional Int. The resource ID. Must
be 0 for ‘maas’ type.
Keyword “entitlement”
Optional String. The entitlement name.
Note: This command accepts JSON.
Adds a user to a user group.
maas $PROFILE user-group add-member [--help] [-d] [-k] id [data ...]
Positional arguments
| Argument | Effect |
|---|---|
| id | The ID of the resource (e.g., 1, abc123) |
Command-line options
| Option | Effect |
|---|---|
| –help, -h | Show this help message and exit. |
| -d, --debug | Display more information about API responses. |
| -k, --insecure | Disable SSL certificate check. |
Keywords
Keyword “username”
Optional String. The username to add.
Note: This command accepts JSON.
Deletes a user group.
maas $PROFILE user-group delete [--help] [-d] [-k] id
Positional arguments
| Argument | Effect |
|---|---|
| id | The ID of the resource (e.g., 1, abc123) |
Command-line options
| Option | Effect |
|---|---|
| –help, -h | Show this help message and exit. |
| -d, --debug | Display more information about API responses. |
| -k, --insecure | Disable SSL certificate check. |
Lists entitlements of a user group.
maas $PROFILE user-group list-entitlements [--help] [-d] [-k] id
Positional arguments
| Argument | Effect |
|---|---|
| id | The ID of the resource (e.g., 1, abc123) |
Command-line options
| Option | Effect |
|---|---|
| –help, -h | Show this help message and exit. |
| -d, --debug | Display more information about API responses. |
| -k, --insecure | Disable SSL certificate check. |
Lists members of a user group.
maas $PROFILE user-group list-members [--help] [-d] [-k] id
Positional arguments
| Argument | Effect |
|---|---|
| id | The ID of the resource (e.g., 1, abc123) |
Command-line options
| Option | Effect |
|---|---|
| –help, -h | Show this help message and exit. |
| -d, --debug | Display more information about API responses. |
| -k, --insecure | Disable SSL certificate check. |
Returns a user group.
maas $PROFILE user-group read [--help] [-d] [-k] id
Positional arguments
| Argument | Effect |
|---|---|
| id | The ID of the resource (e.g., 1, abc123) |
Command-line options
| Option | Effect |
|---|---|
| –help, -h | Show this help message and exit. |
| -d, --debug | Display more information about API responses. |
| -k, --insecure | Disable SSL certificate check. |
Removes an entitlement from a user group.
maas $PROFILE user-group remove-entitlement [--help] [-d] [-k] id [data ...]
Positional arguments
| Argument | Effect |
|---|---|
| id | The ID of the resource (e.g., 1, abc123) |
Command-line options
| Option | Effect |
|---|---|
| –help, -h | Show this help message and exit. |
| -d, --debug | Display more information about API responses. |
| -k, --insecure | Disable SSL certificate check. |
Keywords
Keyword “resource_type”
Optional String. The resource type
(‘maas’ or ‘pool’).
Keyword “resource_id”
Optional Int. The resource ID.
Keyword “entitlement”
Optional String. The entitlement name.
Note: This command accepts JSON.
Removes a user from a user group.
maas $PROFILE user-group remove-member [--help] [-d] [-k] id [data ...]
Positional arguments
| Argument | Effect |
|---|---|
| id | The ID of the resource (e.g., 1, abc123) |
Command-line options
| Option | Effect |
|---|---|
| –help, -h | Show this help message and exit. |
| -d, --debug | Display more information about API responses. |
| -k, --insecure | Disable SSL certificate check. |
Keywords
Keyword “username”
Optional String. The username to remove.
Note: This command accepts JSON.
Updates a user group.
maas $PROFILE user-group update [--help] [-d] [-k] id [data ...]
Positional arguments
| Argument | Effect |
|---|---|
| id | The ID of the resource (e.g., 1, abc123) |
Command-line options
| Option | Effect |
|---|---|
| –help, -h | Show this help message and exit. |
| -d, --debug | Display more information about API responses. |
| -k, --insecure | Disable SSL certificate check. |
Keywords
Keyword “name”
Optional String. The group name.
Keyword “description”
Optional String. The group description.
Note: This command accepts JSON.
Creates a new user group.
maas $PROFILE user-groups create [--help] [-d] [-k] [data ...]
Command-line options
| Option | Effect |
|---|---|
| –help, -h | Show this help message and exit. |
| -d, --debug | Display more information about API responses. |
| -k, --insecure | Disable SSL certificate check. |
Keywords
Keyword “name”
Optional String. The group name.
Keyword “description”
Optional String. The group description.
Note: This command accepts JSON.
Lists all user groups.
maas $PROFILE user-groups read [--help] [-d] [-k]
Command-line options
| Option | Effect |
|---|---|
| –help, -h | Show this help message and exit. |
| -d, --debug | Display more information about API responses. |
| -k, --insecure | Disable SSL certificate check. |