Set-PSUBranding

Sets branding for PowerShell Universal.

SYNOPSIS

Sets branding for PowerShell Universal.

SYNTAX

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

DESCRIPTION

Updates portal, login page, and admin console branding settings for PowerShell Universal.

EXAMPLES

Example 1

PS C:\> Set-PSUBranding -LoginPageImage 'C:\logo.png' -AppBarLogo 'C:\logo.png' -AdminConsoleTitle 'My Admin Console'

Sets the branding for PowerShell Universal. The login page image and app bar logo are set to the specified image files. The admin console title is set to "My Admin Console".

PARAMETERS

-AdminConsoleTitle

The title of the admin console.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AppBarLogo

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AppNotRunningDescription

The text to display when the app is not running.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-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.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-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.

Type: String
Parameter Sets: (All)
Aliases: Uri

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Copyright

The copyright text to display in the footer.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Credential

Credentials to login to the PowerShell Universal Management API.

Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CssStylesheet

The URL of the CSS stylesheet to use for branding.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CssStylesheetIntegrity

The integrity attribute for the CSS stylesheet.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Favicon

The URL of the favicon to use for branding.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-HeaderColor

The header background color.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-HeaderFontColor

The header font color.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Integrated

Whether the cmdlet should use the integrated PowerShell Universal Management API.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LoggedOut

The text to display when the user is logged out.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LoggedOutDescription

The text to display when the user is logged out.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LoginPageDescription

The description to display on the login page.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LoginPageImage

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

Type: String
Parameter Sets: (All)
Aliases: Image

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LoginPageLinks

The links to display on the login page.

Type: LoginPageLink[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LoginPageText

The text to display on the login page.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LoginPageTitle

The title to display on the login page.

Type: String
Parameter Sets: (All)
Aliases: Title

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NotAuthorizedDescription

The description to display when the user is not authorized.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NotAuthorizedTitle

The title to display when the user is not authorized.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PageNotFoundDescription

The description to display when the page is not found.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PageNotFoundTitle

The title to display when the page is not found.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PrimaryColor

The primary color to use for branding.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PrimaryFontColor

The primary font color to use for branding.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SecondaryColor

The secondary color to use for branding.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SecondaryFontColor

The secondary font color to use for branding.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TrustCertificate

Whether the cmdlet should ignore certificate issues.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UseDefaultCredentials

Whether the cmdlet should use the default credentials.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DarkAppBarLogo

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LoginPageTheme

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

Type: ThemePreference
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PortalTitle

The title of the portal.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LoginPageCssStylesheet

A style sheet for the login page.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LoginPageLayout

The login page layout. Defaults to vertical.

Type: LoginPageLayout
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LoginPageBackgroundColor

The background color of the login page.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LoginPageFontColor

The font color of the login page.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LoginPageLogoSize

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Cookies

Reuses and persists authentication cookies for the current PowerShell session.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -Verbose, -WarningAction, -WarningVariable, and -ProgressAction. For more information, see about_CommonParameters.