settings

Operations with the additional settings of the xicli program.

# xicli settings <subcommand> <args> [optional_args]

Subcommands for the settings command:

auth modify

Change client-server connection settings.

auth show

Show client-server connection settings.

cpu-ignore modify

Manage the CPU thread count control settings.

cpu-ignore show

Show the CPU thread count control settings.

eula modify

Manage the acceptance status of the EULA.

eula show

Show the acceptance status of the EULA.

faulty-count modify

Manage the threshold value of I/O errors for all drives.

faulty-count show

Show the threshold value of I/O errors.

log modify

Configure the type of system messages that will be added to the system log.

log show

Show the selected type of system messages for the system log.

mail modify

Manage email notification settings.

mail show

Show email notification settings.

pool modify

Manage delay timer (in seconds) for the drive replacement from the spare pools.

pool show

Show additional settings of the spare pools.

scanner modify

Manage RAIDs monitoring, the LED indication and drive SMART settings.

scanner show

Manage the LED indication and drive scan settings.

auth modify

Change client-server connection settings.

Attention:

When you change any parameter of the settings auth modify command, the xiraid.target service restarts.

# xicli settings auth modify <args>
Table 1. Arguments for the auth modify subcommand

At least one argument is required

--host

The host name or IP address that will be used for the connection.

After changing the host, you must re-generate and replace the certificate.

The default: localhost.

--port

The port that will be used for the connection.

The default: 6066.

auth show

Show client-server connection settings.

# xicli settings auth show
Table 2. Argument for the auth show subcommand

Optional argument

-f --format

Output format:

  • table;
  • json;
  • prettyjson – human-readable json.

The default: table.

cpu-ignore modify

Select the CPUs that will not be used for the xiraid module.

# xicli settings cpu-ignore modify <arg>
Table 3. Argument for the cpu-ignore modify subcommand

Required argument

--id

The list of CPU IDs (separated by a comma or a hyphen) that will not be used for xiraid.

The null value removes the restriction on using threads for xiraid.

cpu-ignore show

Show the list of CPUs that are not used for the xiraid module.

# xicli settings cpu-ignore show
Table 4. Argument for the cpu-ignore show subcommand

Optional argument

-f

--format

Output format:

  • table;
  • json;
  • prettyjson – human-readable json.

The default: table.

eula modify

Manage the acceptance status of the EULA.

# xicli settings eula modify
Table 5. Argument for the eula modify subcommand

Required argument

-s

--status

The status of the EULA acceptance.

Possible values: accepted, not_accepted.

eula show

Show the acceptance status of the EULA.

# xicli settings eula show
Table 6. Argument for the eula show subcommand

Optional argument

-f

--format

Output format:

  • table;
  • json;
  • prettyjson – human-readable json.

The default: table.

faulty-count modify

Manage the threshold value of I/O errors for all drives.

# xicli settings faulty-count modify <arg>
Table 7. Argument for the faulty-count modify subcommand

Required argument

-t

--threshold

The threshold value for all drives.

If you set a new fault threshold value, the current numbers of faults are reset for all the drives.

Possible values: integers from 1 to 1000.

The default: 3.

faulty-count show

Show the threshold value of I/O errors.

# xicli settings faulty-count show
Table 8. Argument for the faulty-count show subcommand

Optional argument

-f

--format

Output format:

  • table;
  • json;
  • prettyjson – human-readable json.

The default: table.

log modify

Configure the type of system messages that will be added to the system log.

# xicli settings log modify <arg>
Table 9. Argument for the log modify subcommand

Required argument

-l

--level

The type of system messages that will be added to the system log.

Possible values: error, warning, info, debug.

Each next type includes the previous one.

The default: debug.

log show

Show the selected type of system messages for the system log.

# xicli settings log show [optional_arg]
Table 10. Argument for the log show subcommand

Optional argument

-f

--format

Output format:

  • table;
  • json;
  • prettyjson – human-readable json.

The default: table.

mail modify

Manage email notification settings.

# xicli settings mail modify <args>
Table 11. Arguments for the mail modify subcommand

At least one argument is required

-pi

--polling_interval

The polling interval for xiRAID RAIDs and the drives in seconds.

Possible values: integers from 0 to 86400 (24 hours).

The default: 10.

-ppi

--progress_polling_interval

Polling interval for the progress of initialization and reconstruction, in minutes.

Possible values: integers from 0 to 1440 (24 hours).

The default: 10.

mail show

Show email notification settings.

# xicli settings mail show
Table 12. Argument for the mail show subcommand

Optional argument

-f --format

Output format:

  • table;
  • json;
  • prettyjson – human-readable json.

The default: table.

pool modify

Manage delay timer (in seconds) for the drive replacement from the spare pools.

# xicli settings pool modify <arg>
Table 13. Argument for the pool modify subcommand

Required argument

-rd

--replace_delay

Delay time (in seconds) for the drive replacement from the spare pools.

Only one delay time is used for all the spare pools.

Possible values: integers from 1 to 3600.

The default: 180.

pool show

Show delay time used for the drive replacement from the spare pools.

# xicli settings pool show
Table 14. Argument for the pool show subcommand

Optional argument

-f

--format

Output format:

  • table;
  • json;
  • prettyjson – human-readable json.

The default: table.

scanner modify

Manage RAIDs monitoring, the LED indication and drive SMART settings.

# xicli settings scanner modify <args>
Table 15. Arguments for the scanner modify subcommand

At least one argument is required

-pi

--polling_interval

The polling interval for xiRAID RAIDs and drives in seconds.

The parameter affects the auto-start delay for the RAID initialization, reconstruction, and restriping.

Possible values: integers from 1 to 3600 (1 hour).

The default: 1.

-spi

--smart_polling_interval

S.M.A.R.T. drive health polling interval, in seconds.

Possible values: integers from 60 to 86400 (24 hours).

The default: 86400.

-le

--led_enabled

Enable (1) or disable (0) the automatic LED indication of drives in the system.

The default: 1.

The argument doesn’t affect manual LED indication.

settings_scanner_show

Show the LED indication and drive scan settings.

# xicli settings scanner show
Table 16. Argument for the scanner show subcommand

Optional argument

-f --format

Output format:

  • table;
  • json;
  • prettyjson – human-readable json.

The default: table.