Configuration the CLI behavior

The CLI itself can be customized to adapt its behavior to user preferences or specific use cases.

To modify the configuration, use the cliconfig command from the operational context. Example:

vsr> cliconfig
vsr config.xml /# display-password false
vsr config.xml /# save
Saving in config.xml
File exists. Overwrite? [y/N] y
vsr config.xml /# exit
vsr>

After your modifications, you can use:

  • save: write CLI configuration to the disk.

  • exit: exit cliconfig context.

Note

Exiting without saving will only alter the configuration for the current session.

General configuration

  • validate-after-edit: never, always, or smart. Default: smart.

    Validate staging configuration after each command. In smart mode, the CLI will only validate the configuration if no other command is pending in the input buffer.

  • display-password: Boolean, Default: true.

    Specify the default behavior for show config/state when displaying password/secret leaves.

  • idle-timeout: Integer, Default: 3600, unit: seconds.

    Specifies the maximum number of seconds that a CLI session may remain idle. The cli will be exited if it is idle for an interval longer than this number of seconds.

    If set to zero, then the cli will never drop a session because it is idle.

  • netconf: Container for Netconf-specific configuration

  • pager: Container for Pager configuration

Netconf specific configuration

  • background-get-config: Boolean, Default: true.

    Request NETCONF running configuration in background: it makes completions based on configuration visible from operational mode.

    It can be disabled to optimize performance when manipulating large configurations.

  • background-get-period: Integer, Default: 30.

    If not 0, request the NETCONF state and running configuration in background, waiting X seconds between each request. Depending on the complexity of the state and running configuration, X should be significantly lower than the idle time of NETCONF server (default 1 hour). This improves the reactivity of the CLI, at the price of bothering the NETCONF server.

  • connect-retry: Integer, Default: 60.

    Retry NETCONF connection during N seconds at CLI startup.

  • rpc-recv-timeout: Integer, Default: 120000.

    Timeout in milliseconds when receiving a NETCONF message.

    It can be increased when manipulating large configurations.

  • rpc-send-timeout: Integer, Default: 5000.

    Timeout in milliseconds when sending a NETCONF message.

    It can be increased when manipulating large configurations.

Pager configuration

  • enabled: Boolean, Default: true.

    Enable pager when the number of output lines exceeds the number of rows of the terminal.