List users

tcmgr user list – show list of all user accounts configured on the system

`SYNOPSIS`

tcmgr user list [--type {customer|support|all}] [--filter ATTRIBUTE-NAME=ATTRIBUTE-VALUE]

`DESCRIPTION`

Shows a list of all user accounts configured on the system. By default, the users shown are used and managed by the customer. These include all users with management access of admin, viewer, or none.

The –-type flag can be used to view user accounts managed by IBM support. These include all users with management access of support, temp_enhanced, and temp_service. A user with management access set to support is used by IBM support to create temporary user accounts with management access of temp_enhanced or temp_service. These temporary users can log into the system to assist with service actions including log gathering, code load, password reset, troubleshooting, or executing fix procedures. These temporary users are automatically deleted after 24 hours and always have programmatic access set to no.

`OPTIONS`

-t, --type

What type of user accounts to display. A setting of customer displays users with management access set to admin, viewer, or none. This is the default behavior if no other options are selected. A setting of support displays users with management access set to support, temp_enhanced, or temp_service. A setting of all displays all user accounts.

-h, --help

Display this help and exit.

`PARAMETERS`

-

`EXAMPLES`

This example shows the customer managed user accounts configured in the IBM IBM Deep Archive system.

$ tcmgr user list
Date/Time: April 11, 2024, 09:36:51 AM +09:00; IBM TapeCloud Version: 1.0.0.0-00001
Name      State        Management access Programmatic access Account expires Password expires
===================================================================================================================
admin     connected    admin             no                  -               2025-04-08T17:14:34+09:00 
new_admin disconnected admin             yes                 -               2025-04-09T17:14:34+09:00

This example shows the IBM support managed user accounts with one temporary user created.

$ tcmgr user list --type support
Date/Time: April 28, 2023, 3:44:18 PM -07:00; IBM TapeCloud Version: 1.0.0.0
Name               State         Management access  Programmatic access  Account expires             Password expires
=====================================================================================================================
Enhanced           disconnected  support            no                   -                           -
Service            disconnected  support            no                   -                           -
samth1234@ibm.com  connected     temp-enhanced      no                   2025-04-08T17:14:34+09:00   -

`ATTRIBUTES`

The description of the attributes for tcmgr user list command are as follows:

Table 1. The description of each attribute of the `tcmgr user list` command
Attribute	Description
Name	The unique name of the user account in the system.
State	The TapeCloud Manager access connection state of the user.
Management access	For customer-managed user accounts, this attribute is one of `admin` that can access all CLI commands, `viewer` that can only view system information, or `none` that allows no login over the management interface. For IBM support managed user accounts, this attribute is one of support that can create temporary user accounts with management access set to one of temp_enhanced or temp_service.
Programmatic access	This attribute is yes if the user account has programmatic access to the S3 interface. Otherwise, no.
Account expires	The date and time this user account expires. This attribute is only valid for users with management access of temp_enhanced or temp_service and is set to 24 hours past when the account was created. For all other users, this attribute is -.
Password expires	The date and time the password for this user account expires. This attribute is only valid for users with management access of admin or viewer and is set to 365 days past when the password was last updated. If the expiration date passed, then expired is shown. For all other users, this attribute is -.

The definition of the user state information is as follows:

Table 2. Definition of the user state information
Drive state	Explanation
connected	The user is connected through SSH to the system. This state does not include programmatic access. (OK/GREEN)
disconnected	The user is not connected through SSH to the system. This state does not include programmatic access. (DISABLED/GRAY)
unknown	One or more TapeCloud nodes are inaccessible, and the user connection status could not be determined. (DISABLED/GRAY)