UXTerm
Version: latest
Configuration
UXTerm allows itself to be pre-configured and customized in various ways via the configuration file located at
$MGT_HOME/conf/uxterm.properties:
Output Style
| property | description | example value |
|---|---|---|
|
decides the maximum output line width of the UXTerm console. Lines longer than this number of characters will be wrapped around automatically by UXTerm, regardless of whether line wrapping is handled by the underlying virtual terminal. |
|
Named Servers
The UXTerm configuration file allows you to define a set of named servers or aliases so as to avoid explicitly
entering connection details (server URL and authentication information) during every UXTerm invocation.
If you frequently interact with a certain server (management API endpoint) server-name (the name being your preference),
you can specify the connection URL, username and password for the server in the configuration as in the following table,
and simply use the alias server-name:
-
for the
connectcommand, e.g.con server-name -
for the
--serveroption in command mode, e.g.uxterm.sh -C pl -S server-name
|
base URL of the management API server endpoint |
|
|
username for authenticating to above endpoint |
|
|
password for authenticating to above endpoint |
|
Multiple triplets of the above configurations can be specified in the configuration file, each group for a different server that you interact with.
Default Server
Furthermore, UXTerm allows you to define connection information under a default server name, which will be utilized
when you do not explicitly provide any server reference (a URL or an alias). The corresponding properties can be
configured by including a property triplet with <server-name> set to default:
ultra.mgt.url.default=http://localhost:8085
ultra.mgt.username.default=admin
ultra.mgt.password.default=passwordCommand-specific Configurations
Some UXTerm commands also provide configurable properties for simplified invocation.
Database Client
These are applicable for the db-connect command, and can be loaded into the SQL shell
provided by the command using the !properties subcommand:
sqlline> !properties conf/uxterm/uxterm.properties
The properties can also be maintained in a separate properties file if desired, as they are not part of the core configuration.
|
JDBC URL of the default database to connect to |
|
|
fully qualified name of the JDBC driver class for connecting to above database |
|
|
username for accessing the database |
|
|
password for accessing the database |
|
Troubleshoot Reporting
These are applicable for the troubleshoot reporting commands, primarily to the feature that enables portions of retrieved information (e.g. passwords inside configuration and log files) to be encrypted, and to the ability to define collections (bundles) of tasks that can be run in a single invocation.
|
name of the key factory to be used in the credential masking facility |
|
|
name of the cipher to be used in the above facility |
|
|
task bundles made available for quick access |
|
|
task bundle definitions (one for each of the bundles listed above) |
|
In this topic
In this topic