Linux Virtual Delivery Agent

Custom backgrounds and banner messages on session logon screens

June 20, 2024

Contributed by:

B C

Add a custom background or banner message to session logon screens

Tip:

To use the feature on SUSE 15.5, install imlib2 from http://download.opensuse.org/distribution/leap/15.3/repo/oss/.

You can use the following commands to add a custom background or banner message to session logon screens. To add both a background and a banner message to session logon screens, you can embed the banner message into the background image. After you open a session, the banner message page is displayed first and then the authentication dialog appears.

To set the title of a custom banner message, run:

/opt/Citrix/VDA/bin/ctxreg create -k "HKLM\System\CurrentControlSet\Control\Citrix" -t "REG_SZ" -v "LogonDisplayStringTitle" -d "<Banner message title>" --force
<!--NeedCopy-->

The maximum length of a banner message title is 64 bytes.

To set the body text of a custom banner message, run:

/opt/Citrix/VDA/bin/ctxreg create -k "HKLM\System\CurrentControlSet\Control\Citrix" -t "REG_SZ" -v "LogonDisplayString" -d "Body of custom banner message\nBody of custom banner message\nBody of custom banner message\n" --force
<!--NeedCopy-->

The maximum length of a banner message body is 1,024 bytes.

Tip:

The \n element creates a line break. In this example, the banner message screen looks like this:

To ensure that your custom banner message displays as expected, you might need to use escape characters. For example, use &amp\; to represent & in HTML and put a backslash (\) before the character ! to escape it in Bash commands.

To add a custom background to session logon screens, run:

/opt/Citrix/VDA/bin/ctxreg create -k "HKLM\System\CurrentControlSet\Control\Citrix" -t "REG_SZ" -v "BackgroundImagePath" -d "<path to the background image>" --force
<!--NeedCopy-->

To see the custom background, session users must have access to the background image path.

For example:

Add a custom background to the session logon screen

Example session logon screens

The following are example session logon screens in different scenarios:

Session logon in single sign-on (SSO) scenarios:

The logon process is displayed.
Session logon in typical non-SSO scenarios:
- A password or PIN code is required in non-SSO scenarios.
- Users can toggle the visibility of passwords and PIN codes, making it easy for users to find out incorrect inputs.
Session logon in non-SSO scenarios when users log on to VDA sessions with credentials different from the credentials used to log on to Citrix Workspace app:

User name and password used for session logon:

Smart card used for session logon:

For the combinations of user authentication methods that are supported in non-SSO scenarios, see Non-SSO authentication.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Custom backgrounds and banner messages on session logon screens

June 20, 2024

Contributed by:

B C

June 20, 2024

Contributed by:

B C

Custom backgrounds and banner messages on session logon screens

Add a custom background or banner message to session logon screens

Example session logon screens

In this article