Settings

The settings command can help you to increase security, detect abnormal storage capacity allocation, and adjust the output display according to your preferences.

CLI output preferences

To modify the display output format, use the settings output command. You may choose between tree, table, CSV, or JSON display format. You can also direct the output to a file. In any case, whether you opt to redirect or not, command output always appears on the S1-CLI screen.

Usage:

settings output --tree|--table|--csv|--json|--xml|--yaml [--noOutputRedirection|--outputRedirectionPath=<text>]

Options:

Options and arguments	Description
--tree	Display the output in a tree format.
--table	Display the output in a table format.
--csv	Display the output in a comma-separated value (CSV) format.
--json	Display the output in a Javascript Object Notation (JSON) format.
--xml	Display the output in an Extensible Markup Language (XML) format.
--yaml	Display the output in a YAML Ain't Markup Language (YAML) format.
--outputRedirectionPath=<text>	Redirect CLI output to a file, replace <text> with a filename and a path.
--noOutputRedirection	Cancel file output redirection.

Notice:

When using the --outputRedirectionPath option, the specified path must exist. The system does not create new directories for you, but it will create the specified filename if it does not exist. Output is appended to existing files, not overwritten.

Examples:

1. To display the output in a table format, run

   settings output --table

2. To display the output in a table-type format and to redirect the output to a file named myCMDoutput.txt (on a preexisting path /home/marketing/data), run

   settings output --table --outputRedirectionPath /home/marketing/data/myCMDoutput.txt

Storage capacity units

To choose between decimal or binary display for storage capacity, use the settings capacity_units.

Usage:

settings capacity_units [--binaryUnits | --decimalUnits]

Options:

Options and arguments	Description
--binaryUnits	Use decimal units (mebibyte, gibibyte, tebibyte, pebibyte...)
--decimalUnits	Use binary units (megabyte, gigabyte, terabyte, petabyte...)

Examples:

1. To set the storage capacity unit to display in binary units, run

   settings capacity_units --binaryUnits

2. To set the storage capacity unit to display in decimal units, run

   settings capacity_units --decimalUnits

Setting multi-factor authentication

To increase security level set multi-factor authentication (MFA). Use the settings authentication command to enable or disable authentication for the logged in user. You cannot change the MFA settings for other users.

Usage:

settings authentication --enableMultifactorAuthentication | --disableMultifactorAuthentication

Options:

Options and arguments	Description
--enableMultifactorAuthentication	Enable MFA. Each CLI login requires a token that is sent to the user email address.
--disableMultifactorAuthentication	Disable multi-factor authentication (MFA).

Examples:

1. To enable multi-factor authentication, run

   settings authentication --enableMultifactorAuthentication

2. To disable multi-factor authentication, run

   settings authentication --disableMultifactorAuthentication

Abnormal capacity usage notification

To set parameters for detecting abnormal capacity usage, use the settings anomaly_detection edit command. You must specify a time frame (between 0 and 60 days), and a percentage change value. The time frame specifies the number of previous days to consider. If the system capacity usage goes above or below the specified percentage of the maximum or minimum (respectively) daily capacity from the previous time period, the system sends an email notification.

You can disable anomaly_detection by setting either the change value or the time-frame value to zero.

Usage:

settings anomaly_detection edit --timeframe_days=<num_days> --change=<percentage>

Options:

Options and arguments	Description
--timeframe_days=<num_days>	Specifies the number of previous days to consider. Replace <num_days> with a numeric value between 1 and 60.
--change=<percentage>	Specifies the change percentage to consider anomalous. Replace <percentage> with a numeric percent value.

Examples:

1. To set a time frame of 50 days and a change value of 400 percent, run

   settings anomaly_detection edit --timeframe_days 50 --change 400

   • If daily capacity usage is four times bigger than the maximum daily capacity usage of the last 50 days, the system sends a notification email.
   • Similarly, if the daily usage is four-time smaller than the minimum daily capacity usage of the last 50 days, the system sends a notification email.

2. To disable anomaly detection, run

   settings anomaly_detection edit --timeframe_days 0 --change 400

Displaying abnormal capacity usage

To display settings for anomaly detection, use the settings anomaly_detection show command.

Usage:

settings anomaly_detection show

Options:

No options for this command.

Examples:

1. To display anomaly detection settings run

   settings anomaly_detection show