New-PSULoginPage
SYNOPSIS
Configuration settings for the login page in PowerShell Universal.
SYNTAX
New-PSULoginPage [-Image <String>] [-Title <String>] [-PrimaryColor <String>] [-SecondaryColor <String>]
[-PrimaryFontColor <String>] [-SecondaryFontColor <String>] [-HeaderColor <String>]
[-HeaderFontColor <String>] [-Copyright <String>] [-Links <LoginPageLink[]>] [-CssStylesheet <String[]>]
[-ComputerName <String>] [-AppToken <String>] [-UseDefaultCredentials] [<CommonParameters>]
DESCRIPTION
Configuration settings for the login page in PowerShell Universal. The login page is displayed when using forms authentication. You can configure colors, text and images for the login page.
Login page configurations are stored in .universal/loginPage.ps1
You can also use this cmdlet to update the login page through the REST API.
EXAMPLES
Example 1
$LoginPage = @{
PrimaryColor = '#5c2751'
Title = 'DBATools Web Portal'
Copyright = 'DBATools 2020'
HeaderFontColor = 'white'
HeaderColor = '#4bc0d9'
SecondaryColor = '#6457a6'
SecondaryFontColor = 'white'
Image = 'http://localhost:5000/images/dbatools.png'
}
New-PSULoginPage @LoginPage
Creates a custom login page with colors, images and text.
PARAMETERS
-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: System.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: System.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 at the bottom of the page.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CssStylesheet
One or more URLs to stylesheets to apply to the login page.
Type: System.String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-HeaderColor
The background color of the header.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-HeaderFontColor
The font color of the header.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Image
An image to display within the login page. You can use published folders to host images.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PrimaryColor
The primary background color.
Type: System.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.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SecondaryColor
The secondary background color.
Type: System.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.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Title
The tile to display in the header.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Links
Links to display on the login page. Use New-PSULoginPageLink.
Type: PowerShellUniversal.LoginPageLink[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-UseDefaultCredentials
Use default credentials when connecting to the management API
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.