| Home Prev |  cOS Stream 4.00.03 CLI Reference Guide
|
Next |
|---|
Show copyright/build information.
Description
Show copyright/build information.Usage
aboutShow copyright/build information.
Manage aliases.
Description
Aliases are user-defined mappings between a keyword and CLI commands, primarily intended to create shortcuts for commonly used commands that require many options. To execute an alias, prefix it with ":". Pressing tab or enter will replace the alias keyword with the corresponding mapped command.Usage
aliasShow active alias mappings.
alias -add=<String> -cmd=<String> [-description=<String>]Add alias mapping.
alias -set=<String> [-cmd=<String>] [-description=<String>]Set/update active alias mapping.
alias -remove=<String>Remove active alias mapping.
alias -showShow active alias mappings.
alias -import <filename_import>Import the active alias mappings from file.
alias -export <filename_export>Export the active alias mappings to a file.
alias -saveSave the current alias mappings to persistent storage.
Options
Show configuration log.
Description
Displays warning and error messages related to configuration of the system. By default, shows log entries from the latest reconfigure sequence.Usage
cfglogShow log.
cfglog -allShow log.
cfglog -clearClear log.
Options
Set the command view(s).
Description
Set the command views that are used when filtering out the set of commands and options that is available in the CLI.Besides the ordinary set of commands within the 'default' view, there are two other views named 'advanced' and 'debug'. The 'advanced' view covers commands that display extensive and detailed information about the system's runtime values. The commands within the 'advanced' view do not have any impact on the system's behavior and network traffic. The commands covered by the 'debug' view can affect system behavior and network traffic and should be used with some care. These commands are mainly intended for system/network tests and debugging.
Usage
cmdview [{DEFAULT | ADVANCED | DEBUG | SERVICE | ALL}]
Options
Print text.
Description
Print text to console.Usage
echo [<String>]...
Options
Filter the output based on a regular expression.
Description
The grep command is a text-search utility that searches output for specified patterns, printing lines where these patterns occur. It allows for advanced searches, including inverting the search and counting matching lines. Integrate other commands with grep using a pipe (|) for enhanced text processing and data analysis.Usage
grep <Expr> [-v] [-i] [-k] [-A=<num>] [-B=<num>] [-C=<num>]
Options
Show help for CLI commands.
Description
The command help system contains information about commands and configuration object types.The fastest way to get help is to simply type help followed by the topic that you want help with. A topic can be a command name (e.g. set).
When you don't know the name of what you are looking for you can use tab-completion to display a list of matching topics.
Usage
helpList commands alphabetically.
help <Topic>Display help about selected topic from any category.
Options
Show help for configuration objects.
Description
The config help system contains information about configuration object types.The fastest way to get help is to simply type helpconfig followed by the topic that you want help with. A topic can be the name of a configuration object type (e.g. User).
When you don't know the name of what you are looking for you can use tab-completion to display a list of matching topics.
Usage
helpconfig <Topic>
Options
Show command history.
Description
List recently typed commands that have been stored in the command history.Usage
history
Show management status and enable local configuration.
Description
Show management status, and regain local configuration control if the centralized management system has it.If the centralized management system has taken control of the system, any single user may not do configuration changes to the system. In order to regain local configuration control to single users this command is used. Once local configuration is enabled, centralized management control can only be enabled by the centralized management system.
Usage
localconfiguration [-enable]
Options
![[Note]](images/note.png) |
Note |
|---|---|
| Requires Administrator privileges. |
Initiates shutdown/restart of the system.
Description
Shuts the system down to restart it (or to power it off).Usage
shutdownNormal shutdown/restart of the system.
shutdown -handoverShutdown/restart that makes an HA handover to the peer first, if the node is the active node, before shutting down.
shutdown -ignore-haShutdown/restart that shuts down even if this system is the active HA node of a cluster, without explicit handover and even if the peer is OFFLINE.
shutdown -noninteractive [-handover] [-ignore-ha]Normal shutdown/restart but with a behaviour more suitable for automation.
shutdown -processrestart [-handover] [-ignore-ha] [-noninteractive]Only restart the system's processes instead of a full restart of the POD/system. (NOTE: Usage not available when running non-containerized)
shutdown -force -ignore-ha [-noninteractive]Shutdown using an alternative shutdown procedure skipping most of the normal shutdown activities. This should only be used if normal shutdown of the system malfunctions.
shutdown -poweroff [-handover] [-ignore-ha]Power down the system. (NOTE: Usage not available when running as a container)
Options
|
Note |
|---|---|
| Requires Administrator privileges. |
