Environment Commands

Description

Use these commands to set the Gaia Clish environment for a user for a particular session, or permanently.

Syntax

To show the client environment:

show clienv

all

config-lock

debug

echo-cmd

on-failure

output

prompt

rows

syntax-check

To configure the client environment:

set clienv

config-lock {on | off}

debug {0-6}

echo-cmd {on | off}

on-failure {continue | stop}

output {pretty | structured | xml}

prompt <Prompt String>

rows <Row Number>

syntax-check {on | off}

To save the client environment configuration permanently:

save clienv

Parameters

Parameter	Description
`config-lock {on \| off}`	Default value of the Clish `config-lock` parameter. If set to `on`, Gaia Clish will lock the configuration when invoked, otherwise continue without a configuration lock. When the configuration is locked by Clish, no configuration changes are possible in Gaia Portal, until the lock is released.
`debug {0-6}`	Debug level. Predefined levels are: `0` - (Default) Do not debug, display error messages only `5` - Show `confd` daemon requests and responses `6` - Show handler invocation parameters and results
`echo-cmd {on \| off}`	If set to `on`, echoes all commands before executing them, when the command execution is done through the `load configuration` command. The default is `off`.
`on-failure {continue \| stop}`	Action performed on failure: `continue` - Show error messages, but continue running commands from a file or a script `stop` - (Default) Stop running commands from a file or a script
`output {pretty \| structured \| xml}`	Command line output format. The default is `pretty`.
`prompt <`Prompt String`>`	Command prompt string. A valid prompt string can consist of any printable characters and a combination of these variables: `%H` - Replaced with the Command number `%I` - Replaced with the User ID `%M` - Replaced with the Hostname `%P` - Replaced with the Product ID `%U` - Replaced with the Username To set the prompt back to the default, use the keyword `default`.
`rows <`Row Number`>`	Number of rows to show in your terminal window. If the window size is changed, the number of rows will also change, unless the value is set to 0 (zero).
`syntax-check {on \| off}`	Put the shell into syntax‑check mode. Commands you enter are checked syntactically and are not executed, but values are validated. The default is `off`.