PowerScaleOneFS CLI Command Reference

Syntax

isi auth file modify <provider-name>
  [--name <string>]
  [--password-file <path>]
  [--group-file <path>]
  [--authentication {yes | no}]
  [--create-home-directory {yes | no}]
  [--enabled {yes | no}]
  [--enumerate-groups {yes | no}]
  [--enumerate-users {yes | no}]
  [--findable-groups <string>]
  [--clear-findable-groups]
  [--add-findable-groups <string>]
  [--remove-findable-groups <string>]
  [--findable-users <string>]
  [--clear-findable-users]
  [--add-findable-users <string>]
  [--remove-findable-users <string>]
  [--group-domain <string>]
  [--home-directory-template <path>]
  [--listable-groups <string>]
  [--clear-listable-groups]
  [--add-listable-groups <string>]
  [--remove-listable-groups <string>]
  [--listable-users <string>]
  [--clear-listable-users]
  [--add-listable-users <string>]
  [--remove-listable-users <string>]
  [--login-shell <path>]
  [--modifiable-groups <string>]
  [--clear-modifiable-groups]
  [--add-modifiable-groups <string>]
  [--remove-modifiable-groups <string>]
  [--modifiable-users <string>]
  [--clear-modifiable-users]
  [--add-modifiable-users <string>]
  [--remove-modifiable-users <string>]
  [--netgroup-file <path>]
  [--password-hash-type {NTHash | SHA256 | SHA512}
  [--normalize-groups {yes | no}]
  [--normalize-users {yes | no}]
  [--ntlm-support {all | v2only | none}]
  [--provider-domain <string>]
  [--restrict-findable {yes | no}]
  [--restrict-listable {yes | no}]
  [--restrict-modifiable {yes | no}]
  [--unfindable-groups <string>]
  [--clear-unfindable-groups]
  [--add-unfindable-groups <string>]
  [--remove-unfindable-groups <string>]
  [--unfindable-users <string>]
  [--clear-unfindable-users]
  [--add-unfindable-users <string>]
  [--remove-unfindable-users <string>]
  [--unlistable-groups <string>]
  [--clear-unlistable-groups]
  [--add-unlistable-groups <string>]
  [--remove-unlistable-groups <string>]
  [--unlistable-users <string>]
  [--clear-unlistable-users]
  [--add-unlistable-users <string>]
  [--remove-unlistable-users <string>]
  [--unmodifiable-groups <string>]
  [--clear-unmodifiable-groups]
  [--add-unmodifiable-groups <string>]
  [--remove-unmodifiable-groups <string>]
  [--unmodifiable-users <string>]
  [--clear-unmodifiable-users]
  [--add-unmodifiable-users <string>]
  [--remove-unmodifiable-users <string>]
  [--user-domain <string>]
  [--delete-password-hashes]
  [--verbose]

Options

<provider-name>

Specifies the name of the file provider to modify. This setting cannot be modified.

--name <string>

Specifies an new name for the authentication provider.

--password-file <path>

Specifies the path to a passwd.db replacement file.

--group-file <path>

Specifies the path to a group replacement file.

--authentication {yes | no}

Enables or disables the use of the provider for authentication as well as identity. The default value is yes.

--cache-entry-expiry <duration>

Specifies the length of time after which the cache entry will expire, in the format <integer>[{Y | M | W | D | H | m | s}]. To turn off cache expiration, set this value to off.

--create-home-directory {yes | no}

Specifies whether to create a home directory the first time a user logs in, if a home directory does not already exist for the user.

--enabled {yes | no}

Enables or disables the provider.

--enumerate-groups {yes | no}

Specifies whether to allow the provider to enumerate groups.

--enumerate-users {yes | no}

Specifies whether to allow the provider to enumerate users.

--findable-groups <string>

Specifies a group that can be found in this provider if --restrict-findable is enabled. Repeat this option to specify multiple list items. If populated, any groups that are not included in this list cannot be resolved. This option overwrites any existing entries in the findable groups list; to add or remove groups without affecting current entries, use --add-findable-groups or --remove-findable-groups.

--clear-findable-groups

Removes all entries from the list of findable groups.

--add-findable-groups <string>

Adds an entry to the list of findable groups that is checked if --restrict-findable is enabled. Repeat this option to specify multiple list items.

--remove-findable-groups <string>

Removes an entry from the list of findable groups that is checked if --restrict-findable is enabled. Repeat this option to specify multiple list items.

--findable-users <string>

Specifies a user that can be found in the provider if --restrict-findable is enabled. Repeat this option to specify multiple list items. If populated, any users that are not included in this list cannot be resolved. This option overwrites any existing entries in the findable users list; to add or remove users without affecting current entries, use --add-findable-users or --remove-findable-users.

--clear-findable-users

Removes all entries from the list of findable users.

--add-findable-users <string>

Adds an entry to the list of findable users that is checked if --restrict-findable is enabled. Repeat this option to specify multiple list items.

--remove-findable-users <string>

Removes an entry from the list of findable users that is checked if --restrict-findable is enabled. Repeat this option to specify multiple list items.

--group-domain <string>

Specifies the domain that the provider will use to qualify groups. The default group domain is FILE_GROUPS.

--group-file <path>

Specifies the path to a group replacement file.

--home-directory-template <path>

Specifies the path to use as a template for naming home directories. The path must begin with /ifs and can include special character sequences that are dynamically replaced with strings at home directory creation time that represent specific variables. For example, %U, %D, and %Z are replaced with the user name, provider domain name, and zone name, respectively. For more information, see the Home directories section.

--listable-groups <string>

Specifies a group that can be viewed in this provider if --restrict-listable is enabled. Repeat this option to specify multiple list items. If populated, any groups that are not included in this list cannot be viewed. This option overwrites any existing entries in the listable groups list; to add or remove groups without affecting current entries, use --add-listable-groups or --remove-listable-groups.

--clear-listable-groups

Removes all entries from the list of viewable groups.

--add-listable-groups <string>

Adds an entry to the list of viewable groups that is checked if --restrict-listable is enabled. Repeat this option to specify multiple list items.

--remove-listable-groups <string>

Removes an entry from the list of viewable groups that is checked if --restrict-listable is enabled. Repeat this option to specify multiple list items.

--listable-users <string>

Specifies a user that can be viewed in this provider if --restrict-listable is enabled. Repeat this option to specify multiple list items. If populated, any users that are not included in this list cannot be viewed. This option overwrites any existing entries in the listable users list; to add or remove users without affecting current entries, use --add-listable-users or --remove-listable-users.

--clear-listable-users

Removes all entries from the list of viewable users.

--add-listable-users <string>

Adds an entry to the list of viewable users that is checked if --restrict-listable is enabled. Repeat this option to specify multiple list items.

--remove-listable-users <string>

Removes an entry from the list of viewable users that is checked if --restrict-listable is enabled. Repeat this option to specify multiple list items.

--login-shell <path>

Specifies the path to the user's login shell. This setting applies only to users who access the file system through SSH.

--modifiable-groups <string>

Specifies a group that can be modified if --restrict-modifiable is enabled. Repeat this option to specify multiple list items. If populated, any groups that are not included in this list cannot be modified. This option overwrites any existing entries in the modifiable groups list; to add or remove groups without affecting current entries, use --add-modifiable-groups or --remove-modifiable-groups.

--clear-modifiable-groups

Removes all entries from the list of modifiable groups.

--add-modifiable-groups <string>

Adds an entry to the list of modifiable groups that is checked if --restrict-modifiable is enabled. Repeat this option to specify multiple list items.

--remove-modifiable-groups <string>

Removes an entry from the list of modifiable groups that is checked if --restrict-modifiable is enabled. Repeat this option to specify multiple list items.

--modifiable-users <string>

Specifies a user that can be modified if --restrict-modifiable is enabled. Repeat this option to specify multiple list items. If populated, any users that are not included in this list cannot be modified. This option overwrites any existing entries in the modifiable users list; to add or remove users without affecting current entries, use --add-modifiable-users or --remove-modifiable-users.

--clear-modifiable-users

Removes all entries from the list of modifiable users.

--add-modifiable-users <string>

Adds an entry to the list of modifiable users that is checked if --restrict-modifiable is enabled. Repeat this option to specify multiple list items.

--remove-modifiable-users <string>

Removes an entry from the list of modifiable users that is checked if --restrict-modifiable is enabled. Repeat this option to specify multiple list items.

--netgroup-file <path>

Specifies the path to a netgroup replacement file.

--password-hash-type {NThash | SHA256 | SHA512}

Specifies which password hash algorithm to use.

--normalize-groups {yes | no}

Normalizes group names to lowercase before lookup.

--normalize-users {yes | no}

Normalizes user names to lowercase before lookup.

--ntlm-support {all | v2only | none}

For users with NTLM-compatible credentials, specifies which NTLM versions to support. Valid values are all, v2only, and none. NTLMv2 provides additional security over NTLM and is recommended.

--password-file <path>

Specifies the path to a passwd.db replacement file.

--provider-domain <string>

Specifies the domain that this provider will use to qualify user and group names.

--restrict-findable {yes | no}

Specifies whether to check this provider for filtered lists of findable and unfindable users and groups.

--restrict-listable {yes | no}

Specifies whether to check this provider for filtered lists of viewable and unviewable users and groups.

--restrict-modifiable {yes | no}

Specifies whether to check this provider for filtered lists of modifiable and unmodifiable users and groups.

--unfindable-groups <string>

If --restrict-findable is enabled and the findable groups list is empty, specifies a group that cannot be resolved by this provider. Repeat this option to specify multiple list items. This option overwrites any existing entries in the unfindable groups list; to add or remove groups without affecting current entries, use --add-unfindable-groups or --remove-unfindable-groups.

--clear-unfindable-groups

Removes all entries from the list of unfindable groups.

--add-unfindable-groups <string>

Adds an entry to the list of unfindable groups that is checked if --restrict-findable is enabled. Repeat this option to specify multiple list items.

--remove-unfindable-groups <string>

Removes an entry from the list of unfindable groups that is checked if --restrict-findable is enabled. Repeat this option to specify multiple list items.

--unfindable-users <string>

If --restrict-findable is enabled and the findable users list is empty, specifies a user that cannot be resolved by this provider. Repeat this option to specify multiple list items. This option overwrites any existing entries in the unfindable users list; to add or remove users without affecting current entries, use --add-unfindable-users or --remove-unfindable-users.

--clear-unfindable-users

Removes all entries from the list of unfindable groups.

--add-unfindable-users <string>

Adds an entry to the list of unfindable users that is checked if --restrict-findable is enabled. Repeat this option to specify multiple list items.

--remove-unfindable-users <string>

Removes an entry from the list of unfindable users that is checked if --restrict-findable is enabled. Repeat this option to specify multiple list items.

--unlistable-groups <string>

If --restrict-listable is enabled and the viewable groups list is empty, specifies a group that cannot be listed by this provider. Repeat this option to specify multiple list items. This option overwrites any existing entries in the unlistable groups list; to add or remove groups without affecting current entries, use --add-unlistable-groups or --remove-unlistable-groups.

--clear-unlistable-groups

Removes all entries from the list of unviewable groups.

--add-unlistable-groups <string>

Adds an entry to the list of unviewable groups that is checked if --restrict-listable is enabled. Repeat this option to specify multiple list items.

--remove-unlistable-groups <string>

Removes an entry from the list of unviewable groups that is checked if --restrict-listable is enabled. Repeat this option to specify multiple list items.

--unlistable-users <string>

If --restrict-listable is enabled and the viewable users list is empty, specifies a user that cannot be listed by this provider. Repeat this option to specify multiple list items. This option overwrites any existing entries in the unlistable users list; to add or remove users without affecting current entries, use --add-unlistable-users or --remove-unlistable-users.

--clear-unlistable-users

Removes all entries from the list of unviewable users.

--add-unlistable-users <string>

Adds an entry to the list of unviewable users that is checked if --restrict-listable is enabled. Repeat this option to specify multiple list items.

--remove-unlistable-users <string>

Removes an entry from the list of unviewable users that is checked if --restrict-listable is enabled. Repeat this option to specify multiple list items.

--unmodifiable-groups <string>

If --restrict-modifiable is enabled and the modifiable groups list is empty, specifies a group that cannot be modified. Repeat this option to specify multiple list items. This option overwrites any existing entries in this provider’s unmodifiable groups list; to add or remove groups without affecting current entries, use --add-unmodifiable-groups or --remove-unmodifiable-groups.

--clear-unmodifiable-groups

Removes all entries from the list of unmodifiable groups.

--add-unmodifiable-groups <string>

Adds an entry to the list of unmodifiable groups that is checked if --restrict-modifiable is enabled. Repeat this option to specify multiple list items.

--remove-unmodifiable-groups <string>

Removes an entry from the list of unmodifiable groups that is checked if --restrict-modifiable is enabled. Repeat this option to specify multiple list items.

--unmodifiable-users <string>

If --restrict-modifiable is enabled and the modifiable users list is empty, specifies a user that cannot be modified. Repeat this option to specify multiple list items. This option overwrites any existing entries in this provider’s unmodifiable users list; to add or remove users without affecting current entries, use --add-unmodifiable-users or --remove-unmodifiable-users.

--clear-unmodifiable-users

Removes all entries from the list of unmodifiable users.

--add-unmodifiable-users <string>

Adds an entry to the list of unmodifiable users that is checked if --restrict-modifiable is enabled. Repeat this option to specify multiple list items.

--remove-unmodifiable-users <string>

Removes an entry from the list of unmodifiable users that is checked if --restrict-modifiable is enabled. Repeat this option to specify multiple list items.

--user-domain <string>

Specifies the domain that this provider will use to qualify users. The default user domain is FILE_USERS.

--delete-password-hashes

Deletes all password hashes that do not match the Password Hash Type and will force a password change at next login.

{--verbose | -v}

Displays detailed information.