Set-PSUSetting

Sets a PSU setting.

SYNOPSIS

Sets a PSU setting.

SYNTAX

Set-PSUSetting [-LogLevel <String>] [-MicrosoftLogLevel <String>] [-LoggingFilePath <String>]
 [-DefaultEnvironment <String>] [-GroomDays <Int32>] [-ConcurrentJobLimit <Int32>] [-Telemetry] [-HideApi]
 [-HideHomePage] [-HideAutomation] [-HideDashboard] [-DisableCodeFirst] [-SecurityEnvironment <String>]
 [-ApiEnvironment <String>] [-DefaultPage <String>] [-RateLimitClientAllowList <String[]>]
 [-RateLimitIpAddressAllowList <String[]>] [-RateLimitEndpointAllowList <String[]>] [-DisableUpdateCheck]
 [-ScriptBaseFolder <String>] [-AdminConsoleLogo <String>] [-AdminConsoleTitle <String>]
 [-GroomInterval <Int32>] [-NotificationLevel <NotificationLevel>] [-ProxyUri <String>]
 [-ProxyCredential <Variable>] [-JobHandshakeTimeout <Int32>] [-HideRunAs] [-FallbackLanguageId <String>]
 [-Splatting] [-FavIcon <String>] [-ExperimentalFeatures <ExperimentalFeatures>] [-DisabledFeatures <Features>]
 [-LimitIdentities] [-DontLoadProfile] [-EnhancedAppTokenSecurity] [-DefaultDashboardTheme <String>]
 [-UseLogoSize] [-DarkTheme] [-HideEnvironment] [-HideRunOn] [-DisableFormatOnSave]
 [-ContentSecurityPolicy <String>] [-LogGroomDays <Int32>] [-Branding <OldBranding>] [-PreformattedJobOutput]
 [-ModuleDiscoveryFrequency <String>] [-DebuggerEnvironment <String>] [-FileEncoding <String>]
 [-MaxJobMemory <Int32>] [-JobRunId] [-ApiBaseFolder <String>] [-CheckForModuleUpdates] [-HideRunLater]
 [-AnonymousApiDocumentation] [-MaximumTokenLifetime <Int32>] [-PortalDisabled] [-PortalRole <String[]>]
 [-DefaultTokenLifetime <Int32>] [-ApiSecurityModel <ApiSecurityModel>] [-DefaultRunOn <String>]
 [-SessionTimeout <Int32>] [-DisableFirstRun] [-DebugPreference <ActionPreference>]
 [-VerbosePreference <ActionPreference>] [-InformationPreference <ActionPreference>]
 [-WarningPreference <ActionPreference>] [-ErrorPreference <ActionPreference>]
 [-ProgressPreference <ActionPreference>] [-DisableDatabaseVault] [-PasswordExpirationDays <Int32>]
 [-PasswordLength <Int32>] [-DisableDevolutionsAccountLogin] [-ComputerName <String>] [-AppToken <String>]
 [-Credential <PSCredential>] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]
 [<CommonParameters>]

DESCRIPTION

Sets a PSU setting.

EXAMPLES

Example 1

PS C:\> $Settings = Get-UASetting
PS C:\> $Settings.LogLevel = 'Debug'
PS C:\> Set-UASetting -Setting $Settings

Sets the log level to 'Debug'

PARAMETERS

-AdminConsoleLogo

The admin console logo URL.

Type: String
Parameter Sets: (All)
Aliases:

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

-AdminConsoleTitle

The admin console title.

Type: String
Parameter Sets: (All)
Aliases:

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

-ApiEnvironment

The environment to run API endpoints within.

Type: String
Parameter Sets: (All)
Aliases:

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

-AppToken

An app token to access the PSU API.

Type: String
Parameter Sets: (All)
Aliases:

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

-ComputerName

The HTTP address of the PSU REST API server.

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

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

-ConcurrentJobLimit

The maximum number of jobs to run at once.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-DefaultEnvironment

The default environment to use throughout the product. Can be overridden for individual entities.

Type: String
Parameter Sets: (All)
Aliases:

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

-DefaultPage

Sets the default page for the admin console.

Type: String
Parameter Sets: (All)
Aliases:

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

-DisableUpdateCheck

Disables the update check for PowerShell Universal.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-GroomDays

The number of days to retain jobs for.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-HideApi

Hides the API node from the admin console.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-HideAutomation

Hides the automation node from the admin console.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-HideDashboard

Hides the dashboard node from the admin console.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-HideHomePage

Hides the PowerShell Universal home page.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Integrated

Executes the command internally rather than using the Management API. Only works when running script from within PowerShell Universal.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-LogLevel

The log level for PowerShell Universal. Valid values are Debug, Information, Warning and Error.

Type: String
Parameter Sets: (All)
Aliases:

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

-LoggingFilePath

The file path to the log.

Type: String
Parameter Sets: (All)
Aliases:

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

-MicrosoftLogLevel

The internal logging for Microsoft components, like the web server. Valid values are Debug, Information, Warning and Error.

Type: String
Parameter Sets: (All)
Aliases:

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

-RateLimitClientAllowList

A list of client names to bypass rate limiting.

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

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

-RateLimitEndpointAllowList

A list of endpoints to bypass rate limiting.

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

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

-RateLimitIpAddressAllowList

A list of IP addresses to bypass rate limiting.

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

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

-ScriptBaseFolder

The base folder to store scripts within the repository.

Type: String
Parameter Sets: (All)
Aliases:

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

-SecurityEnvironment

The environment used to run authentication and authorization scripts.

Type: String
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: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-GroomInterval

How frequently in seconds to run the groom job.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-NotificationLevel

The lowest notification level to generate. For example, if NotificationLevel is set to Warning, only Warning and Error notifications will be shown.

Type: NotificationLevel
Parameter Sets: (All)
Aliases:

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

-FallbackLanguageId

The fallback language ID when a string isn't found in the target language.

Type: String
Parameter Sets: (All)
Aliases:

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

-HideRunAs

Hide run as support throughout the admin console.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-JobHandshakeTimeout

The number of seconds to wait for a job to communicate that it has started running.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-ProxyCredential

Proxy server credentials.

Type: Variable
Parameter Sets: (All)
Aliases:

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

-ProxyUri

Proxy server URI.

Type: String
Parameter Sets: (All)
Aliases:

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

-Splatting

Whether splatting is enabled for all configuration files.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-DisabledFeatures

Features to disable within PowerShell Universal.

Type: Features
Parameter Sets: (All)
Aliases:

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

-DontLoadProfile

Prevents loading use profiles for Run As environments.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-EnhancedAppTokenSecurity

Enables enhanced token security for the platform.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ExperimentalFeatures

Experimental features to enable.

Type: ExperimentalFeatures
Parameter Sets: (All)
Aliases:

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

-FavIcon

The FavIcon to display in the admin console and dashboards.

Type: String
Parameter Sets: (All)
Aliases:

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

-LimitIdentities

Prevents identities that are not defined from logging into PowerShell Universal.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Telemetry

Not used. Telemetry is no longer collected.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-DefaultDashboardTheme

The default dashboard theme to use when none is specified. By default, this value is AntDesign.

Type: String
Parameter Sets: (All)
Aliases:

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

-UseLogoSize

Does not adjust the size of the logo used in the admin console.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ContentSecurityPolicy

The content security policy to set. This can be useful when hosting PowerShell Universal in an iframe.

Type: String
Parameter Sets: (All)
Aliases:

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

-DarkTheme

Whether the dark theme should be used throughout the admin console.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-DisableFormatOnSave

Disables formatting on save for PowerShell scripts.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-HideEnvironment

Hides the environment drop down when running scripts.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-HideRunOn

Hides the Run On drop down when running scripts.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Branding

The branding to use for the admin console and dashboards.

Type: OldBranding
Parameter Sets: (All)
Aliases:

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

-DebuggerEnvironment

The environment to use when debugging scripts.

Type: String
Parameter Sets: (All)
Aliases:

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

-FileEncoding

The file encoding to use when reading and writing files.

Type: String
Parameter Sets: (All)
Aliases:

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

-LogGroomDays

The number of days to retain log files for.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-ModuleDiscoveryFrequency

The frequency to check for new modules.

Type: String
Parameter Sets: (All)
Aliases:

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

-PreformattedJobOutput

Whether job output should be preformatted.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-MaxJobMemory

The maximum amount of memory a job can use in MB.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-AnonymousApiDocumentation

Allows anonymous access to generated API documentation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ApiBaseFolder

Specifies the base folder used for API resources.

Type: String
Parameter Sets: (All)
Aliases:

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

-CheckForModuleUpdates

Enables checks for updated modules when the resource runs.

Type: SwitchParameter
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

-HideRunLater

Excludes jobs scheduled to run later when set to $true.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-JobRunId

Specifies the job run Id.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-MaximumTokenLifetime

Specifies the maximum lifetime, in minutes, for issued tokens.

Type: Int32
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

-DefaultTokenLifetime

The default token lifetime in minutes.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-PortalDisabled

Whether the portal is disabled.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-PortalRole

The roles required to access the portal.

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

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

-ApiSecurityModel

The API security model to use for cmdlets run within PowerShell Universal.

Type: ApiSecurityModel
Parameter Sets: (All)
Aliases:

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

-DefaultRunOn

The default run on computer or computer group.

Type: String
Parameter Sets: (All)
Aliases:

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

-DisableFirstRun

Disables the first run wizard even if an admin user is not defined.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-SessionTimeout

The number of minutes to wait before a session is considered inactive.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-DebugPreference

The global debug preference. Can be overriden locally.

Type: ActionPreference
Parameter Sets: (All)
Aliases:

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

-ErrorPreference

The global debug preference. Can be overriden locally.

Type: ActionPreference
Parameter Sets: (All)
Aliases:

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

-InformationPreference

The global information preference. Can be overriden locally.

Type: ActionPreference
Parameter Sets: (All)
Aliases:

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

-ProgressPreference

The global progress preference. Can be overriden locally.

Type: ActionPreference
Parameter Sets: (All)
Aliases:

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

-VerbosePreference

The global verbose preference. Can be overriden locally.

Type: ActionPreference
Parameter Sets: (All)
Aliases:

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

-WarningPreference

The global warning preference. Can be overriden locally.

Type: ActionPreference
Parameter Sets: (All)
Aliases:

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

-DisableCodeFirst

Disables the code first auto-reload feature.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: DisableAutoReload

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

-DisableDatabaseVault

Disables the database vault.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-PasswordExpirationDays

The number of days before a local account's password expires.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-PasswordLength

The required minimum length for a local account's password.

Type: Int32
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

-DisableDevolutionsAccountLogin

Disables Devolutions Account as a login option.

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.