set-environment-warning-configuration
Allows customization of a warning bar for clear identification of the server environment in the Admin Console.
Synopsis
asadmin [asadmin-options] set-environment-warning-configuration [--help]
[--enabled={true|false}]
[--message=message]
[--backgroundcolour=backgroundcolour]
[--textcolour=textcolour]Description
The set-environment-warning-configuration subcommand sets the environment warning properties and can enable/disable the warning.
Options
- asadmin-options
-
Options for the
asadminutility. For information about these options, see theasadminhelp page. --help-?-
Displays the help text for the subcommand.
- --enabled
-
Activates or deactivates the Environment Warning feature, enabling or disabling the display of the warning bar in the Admin Console based on the chosen setting.
- --message
-
Specifies the custom text message to be displayed within the Environment Warning bar, allowing for tailored alerts or reminders specific to the current server environment.
- --backgroundcolour
-
Sets the background color of the Environment Warning bar, providing a visual means to distinguish between different environments by color-coding the warning bar.
- --textcolour
-
Determines the color of the text within the Environment Warning bar, ensuring readability and contrast against the background color, enhancing the visibility of the warning message.
Examples
Example 1
asadmin> set-environment-warning-configuration --enabled=true --message="Caution, this is on production" --textcolour="#00ff00" --backgroundcolour="#ff00ff"
Command set-environment-warning-configuration executed successfully.