Edit

Share via

Set-TimeZone

Module:
Microsoft.PowerShell.Management Module

Sets the system time zone to a specified time zone.

Syntax

Name (Default) 

Set-TimeZone
    [-Name] <String>
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Id 

Set-TimeZone
    -Id <String>
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InputObject 

Set-TimeZone
    [-InputObject] <TimeZoneInfo>
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

This cmdlet is only available on the Windows platform.

The Set-TimeZone cmdlet sets the system time zone to a specified time zone.

Examples

Example 1: Set the time zone by Id

This example sets the time zone on the local computer to UTC.

Set-TimeZone -Id "UTC"

Id                         : UTC
HasIanaId                  : True
DisplayName                : (UTC) Coordinated Universal Time
StandardName               : Coordinated Universal Time
DaylightName               : Coordinated Universal Time
BaseUtcOffset              : 00:00:00
SupportsDaylightSavingTime : False

Example 2: Set the time zone by name

This example sets the time zone on the local computer to UTC.

Set-TimeZone -Name 'Coordinated Universal Time' -PassThru

As we saw in the previous example, the Id and the Name of the Time Zone do not always match. The Name parameter must match the StandardName or DaylightName properties of the TimeZoneInfo object.

Note

The time zone names can vary based on the Culture settings in Windows. This example shows the values for a system set to en-US.

Example 3 - List all available time zones

A full list of Time Zone IDs can be obtained by running the following command:

Get-TimeZone -ListAvailable

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

Specifies the ID of the time zone that this cmdlet sets.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Id
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-InputObject

Specifies a TimeZoneInfo object to use as input.

Parameter properties

Type:TimeZoneInfo
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

InputObject
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies the name of the time zone that this cmdlet sets. A full list of Time Zone names can be obtained by running the following command: Get-TimeZone -ListAvailable.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Name
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

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

Inputs

String

TimeZoneInfo

Outputs

None

By default, this cmdlet returns no output.

TimeZoneInfo

When you use the PassThru parameter, this cmdlet returns a TimeZoneInfo object.

Notes

PowerShell includes the following aliases for Set-TimeZone:

  • Windows:
    • stz

This cmdlet is only available on Windows platforms.