Skip to content

hubcli group list

Lists all groups.

The command has the following format:

hubcli group list [flags]

flags
One or more optional flags that provide additional control over execution of the command.

The following flags are available:

-c string or --connection string
Specifies the name of the connection to use. If you do not specify this option, then the default connection is used. If there is no default connection, then you must specify a connection. The first connection created for the Altair SLC Hub instance is set by default as the default Altair SLC Hub instance, but a different default connection can be set using the hubcli connection use command.
--debug
Enables debug logging.
-h or --help
Returns help information for this command.
--json
Returns the list of group properties in JSON format.
-l int or --limit int
Lists only the number of groups specified by int. By default 100 are listed. Counting begins from the first listed group.
--local
Lists only local groups; that is, those groups created using Altair SLC Hub and not imported from LDAP.
-o int or --offset int
Skips the number of groups specified by int at the beginning of the returned list. For example, if there are 200 groups and int is set to 100, then the first 100 groups are skipped and only the remaining groups are listed.

Examples

Running hubcli group list returns all groups:

 ID                                    NAME
 ad5a5c72-404d-4662-a1d5-580f94002fc5  HubUsers
 d6b0783a-9ad3-4f31-aa48-bbf550430b92  BatchJobUsers
 80a4e813-2397-47df-8d3d-47ed03db3f46  DataAccessConsumers
 e41351a3-424d-4a66-b121-89072a65bfb0  LinkSessionUsers
 d5239a3b-827e-47d7-b9a9-b968371ecbc6  PipelineUsers

Running hubcli group list --json returns the same list in JSON format:

{"data":[{"_id":"ad5a5c72-404d-4662-a1d5-580f94002fc5","name":"HubUsers"},{"_id":"d6b0783a-9ad3-4f31-aa48-bbf550430b92","name":"BatchJobUsers"},{"_id":"80a4e813-2397-47df-8d3d-47ed03db3f46","name":"DataAccessConsumers"},{"_id":"e41351a3-424d-4a66-b121-89072a65bfb0","name":"LinkSessionUsers"},{"_id":"d5239a3b-827e-47d7-b9a9-b968371ecbc6","name":"PipelineUsers"}],"totalCount":5}

Note: ls is an alias of list.