For the complete documentation index, see llms.txt. This page is also available as Markdown.

New-PSUBranding

Sets branding for PowerShell Universal.

Synopsis

Sets branding for PowerShell Universal.

Syntax

New-PSUBranding [-AdminConsoleTitle <String>] [-AppBarLogo <String>] [-AppNotRunningDescription <String>] [-AppToken <String>] [-ComputerName <String>] [-Copyright <String>] [-Credential <PSCredential>] [-CssStylesheet <String[]>] [-CssStylesheetIntegrity <String[]>] [-Favicon <String>] [-HeaderColor <String>] [-HeaderFontColor <String>] [-Integrated] [-LoggedOut <String>] [-LoggedOutDescription <String>] [-LoginPageDescription <String>] [-LoginPageImage <String>] [-LoginPageLinks <LoginPageLink[]>] [-LoginPageText <String>] [-LoginPageTitle <String>] [-NotAuthorizedDescription <String>] [-NotAuthorizedTitle <String>] [-PageNotFoundDescription <String>] [-PageNotFoundTitle <String>] [-PrimaryColor <String>] [-PrimaryFontColor <String>] [-SecondaryColor <String>] [-SecondaryFontColor <String>] [-TrustCertificate] [-UseDefaultCredentials] [-DarkAppBarLogo <String>] [-LoginPageTheme <ThemePreference>] [-PortalTitle <String>] [-LoginPageCssStylesheet <String>] [-LoginPageLayout <LoginPageLayout>] [-LoginPageBackgroundColor <String>] [-LoginPageFontColor <String>] [-LoginPageLogoSize <String>] [<CommonParameters>]

Description

{{ Fill in the Description }}

Parameters

-AdminConsoleTitle

The title of the admin console.

Required?                    false
Position?                    named
Default value                None
Accept pipeline input?       False
Aliases                      none
Accept wildcard characters?  false

The URL of the logo to use in the app bar.

-AppNotRunningDescription

The text to display when the app is not running.

-AppToken

The AppToken that is used for calling the PowerShell Universal Management API. You can also call Connect-PSUServer before calling this cmdlet to set the AppToken for the entire session.

-ComputerName

Specifies the computer name or URL that should be called when accessing the PowerShell Universal Management API. You can also use Connect-PSUServer before calling this cmdlet to set the computer name for the entire session.

The copyright text to display in the footer.

-Credential

Credentials to login to the PowerShell Universal Management API.

-CssStylesheet <String[]>

The URL of the CSS stylesheet to use for branding.

-CssStylesheetIntegrity <String[]>

The integrity attribute for the CSS stylesheet.

-Favicon

The URL of the favicon to use for branding.

-HeaderColor

The header background color.

-HeaderFontColor

The header font color.

-LoggedOut

The text to display when the user is logged out.

-LoggedOutDescription

The text to display when the user is logged out.

-LoginPageDescription

The description to display on the login page.

-LoginPageImage

The URL of the image to use on the login page.

The links to display on the login page.

-LoginPageText

The text to display on the login page.

-LoginPageTitle

The title to display on the login page.

-NotAuthorizedDescription

The description to display when the user is not authorized.

-NotAuthorizedTitle

The title to display when the user is not authorized.

-PageNotFoundDescription

The description to display when the page is not found.

-PageNotFoundTitle

The title to display when the page is not found.

-PrimaryColor

The primary color to use for branding.

-PrimaryFontColor

The primary font color to use for branding.

-SecondaryColor

The secondary color to use for branding.

-SecondaryFontColor

The secondary font color to use for branding.

The URL of the dark logo to use in the app bar. This will be used when the dark theme is enabled.

-LoginPageTheme

The theme preference for the login page. This can be set to Light, Dark, or Auto. The default is Auto.

-PortalTitle

The title of the portal.

-LoginPageCssStylesheet

A style sheet for the login page.

-LoginPageLayout

The login page layout. Defaults to vertical.

-LoginPageBackgroundColor

The background color of the login page.

-LoginPageFontColor

The font color of the login page.

-LoginPageLogoSize

The size of of the login page logo. Pixels, percentages and any valid CSS width is allowed.

Inputs

None

Outputs

System.Object

Notes

-------------------------- Example 1 --------------------------

Last updated

Was this helpful?