1. INFINIDAT Support
  2. InfiniShell
  3. General and Special Commands
Session Control Commands

Follow

%clear 

ROLE: All Roles

DescriptionClear screen. 
Syntax%clear 
Example%clear
The screen is cleared and only the command prompt is displayed.


%count 

ROLE: All Roles

Description

Toggle count output.

This toggle changes the output of any query command to display the number of the queried entities (rather than a list of these entities). This command can be used in two ways:

  • Run %count and then any query command
    • Run %count again to toggle-off the count option
  • Run any query command with: --format=count
Syntax%count
ExampleToggling-on the count output
%count 
Count output enabled Use %count again to disable count output
ExampleToggling-off the count output
%count
Count output disabled Use %count again to enable count output
Example

Running a query command when the count toggle in on

  • In this example, there are 10 volumes on the system
vol.query
10
Example

Running a query command regardless of the state of the count toggle

  • In this example, there are 10 volumes on the system
vol.query --format=count
10


%csv 

ROLE: All Roles

Description

Toggle the output to CSV mode.

Enter %csv and then enter a query command. The output will be displayed in CSV format. Enter %csv again to resume to a tabular output format.

Syntax%csv
Example%csv
CSV output enabled

%debug 

ROLE: All Roles

Description

Toggle debug prints.

Enter %debug to toggle to debug mode. Enter a command. The command output will be preceded by debugging messages. Enter %debug again to exit from the Debug mode.

Syntax%debug
Example%debug
Debug: True

%json  

ROLE: All Roles

Description

Toggle JSON output

When toggled, the command output will be displayed in JSON format.

Syntax%json
Example%json
{ "command": "%json", "result": "JSON output enabled\n\nUse %json again to disable json output" }

%logstart  

ROLE: All Roles

Description

Start logger.

Enter %logstart to start logging the session you are currently in. Providing a file name is mandatory (unless already provided in the configuration file). You can provide values for other parameters (none of them is mandatory).

    • The mode parameter determines the way the log is saved into a file. Depend is append.

      • Append mode keeps logging to an existing log file.

      • Override mode overrides an existing log file.

    • The output parameter logs the output of each entered command.

    • The timestamp parameter adds a time stamp to each of the logged commands.

Syntax

%logstart [file=STR] [mode=LOGGINGMODE] [output=BOOL] [timestamps=BOOL] 

Argumentstimestamps A boolean: true, false, yes, no, on, off 
output A boolean: true, false, yes, no, on, off 
mode overwrite or append 
file Any sequence of characters 
Example%logstart file=/Users/user-name/tmp/log.txt mode=append output=yes timestamps=yes 

Logger activated 


%logstate 

ROLE: All Roles

Description

Display command logger state.

This command displays the state of the logging (either on or off).

Syntax%logstate
Example %logstate
Logging is on

%logstop 

ROLE: All Roles

Description

Stop command logger.

This command stops logging.

Syntax%logstop
Example%logstop
Logger deactivated

%raw 

ROLE: All Roles

Description

Toggle raw API output.

Enables displaying the JSON query of the commands output.

Syntax%raw
Example%raw
Command prompt.

%user 

ROLE: All Roles

Description

Displays the name of the active user.

Syntax%user
Example%user
Admin

%version 

ROLE: All Roles

Description

Displays the version of the InfiniShell client.

Syntax%version
Example%version
1.5.0.x
Print Friendly and PDF Download PDF
Was this article helpful?
0 out of 0 found this helpful

0 out of 0 found this helpful

Last edited: 2022-08-06 08:36:58 UTC

Comments