set group

Purpose

Creates and manage user groups. set group performs the following actions:

Adds a group. A maximum of 32 groups can be defined.
Removes groups.
Changes group configuration attributes.
Displays group configuration attributes.

To apply a common set of user settings to more than one user, you may want to create a group with the required settings, and then associate that group with multiple users. If a user is a member of one or more groups, the user's effective permissions are the maximum of the permissions of the user and all of the groups to which the user belongs.

Required permissions

For Digi products with two or more users, to use this command, permissions must be set to one of the following:

For a user to display the group settings for the line on which they are logged in: set permissions s-group=r-self.
For a user to display the group settings for any line: set permissions s‑group=read.
For a user to display and set the group settings for the line on which they are logged in: set permissions s-group=rw-self.
For a user to display the group settings for any line, and “set group” settings for the line on which the user is logged in: set permissions s‑group=w-self-r.
For a user to display and set the group settings on any line: set permissions s-group=rw.

See set permissions for details on setting user permissions for commands.

Default permissions

When you create a new group, it has no permissions.

Syntax

Add a group

set group add id=number newname=string

Remove a group

set group remove {id=range|name=string}

Change group configuration attributes

set group {id=range|name=string} [newname=string]
[commandline={on|off}] [defaultaccess={none|commandline|menu}]

Display group configuration attributes

set group {id=range|name=string}

Display group configuration attributes for all groups

set group

Options

add

Add a group. New groups are created with no permissions. Up to 32 groups can be defined.

remove

Remove groups.

id=range

Specifies the ID or range of IDs of the groups to be acted on.

name=string

Specifies the name of the group to be acted on.

newname=string

Specifies a new group name.

commandline={on|off}

Specifies whether the users in the group are allowed to access the command line of the device.

on

Users can access the command line interface.

off

Users can not access the command line interface.

The default is on.

defaultaccess={none|commandline}

Specifies the default access method and interface that users in the group will be given upon logging into the device. Note that the specified interface must be enabled for the group and have a valid menu if specified.

none

The group has no default access to the device and the users are not allowed to access either the command line interface or the custom menu interface without explicitly specifying the access method.

commandline

The users will be displayed and given access to the command line interface assuming the group has command line access rights enabled.

The default is commandline.

Examples

Add a new group

#> set group add newname=gurus id=4

Remove group 7

#> set group remove id=7

Set a new group name

#> set group id=4 newname=gurus

Set a group with command line access rights

#> set group id=4 commandline=on defaultaccess=commandline