Skip to main content

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 | tree|--table | table|--csv | csv|--json)json|--xml|--yaml [--noOutputRedirection | noOutputRedirection|--outputRedirectionPath=<text>]

Options:

Options and arguments Description
--treeetree 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 jsonJavascript 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

  1. Inusing the option argument <text> of --outputRedirectionPath=<text>outputRedirectionPath option, the specified path to your chosen filename must exist. The system does not create a new folderdirectories for you.you, 2but Ifit youwill specifycreate athe specified filename thatif it does not exist,exist. theOutput systemis creates a file and names it with your chosen filename.
  2. If you redirectappended to aexisting preexistingfiles, file,not the output appends to the end of the preexisting file.
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 namenamed 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 binary units (megabyte, gigabyte, terabyte, petabyte...)
--decimalUnits Use decimal units (mebibyte, gibibyte, tebibyte, pebibyte...)

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 (MFP)MFA). Use the settings authentication command to enable or disable authentication.

Usage:

settings authentication --enable_MFAenableMultifactorAuthentication | --disable_MFA [--force]
disableMultifactorAuthentication

Options:

Options and arguments Description
--enable_MFAenableMultifactorAuthentication Enable MFA. Each CLI login requires a token. You can find the token in your preconfigured email box.
--diable_MFAdisableMultifactorAuthentication Disable multi-factor authentication (MFA).
--forceExecute command without prompting for approval.

Examples:

  1. To enable multi-factor authentication, run

    settings authentication --enable_MFA
enableMultifactorAuthentication

  2. To disable multi-factor authentication, run

    settings --disable_MFA

  3. To enable multi-factor authentication without prompting for approval

    settings --enable_MFA --force
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 T (between 0 and 60), and a change value P in percent. The time frame consists of a list of daily capacity usage values for the last T days. Denote the minimum and maximum of the time-frame capacity list with m and M respectively. Let D be the capacity usage of the current day (D may vary). If D > MP/100 or D < mP/100, then the system detects abnormal capacity usage. The system sends an email notification when abnormal capacity usage is detected. You can disable anomaly by setting either the change value or the time-frame value to zero.

Notes:

  1. 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=<Dnum> --change=<Pnum>

Options:

Options and arguments Description
--timeframe_days=<Dnum> Set days for time frame. Replace <Dnum> with a numeric value (1-60).
--change=<Pnum> Set the capacity change value. Replace <PnaumPnum> 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
Back to top