| external help file | Module Name | online version | schema |
|---|---|---|---|
PSScriptTools-help.xml |
PSScriptTools |
2.0.0 |
Display time settings for a collection of locations.
Get-MyTimeInfo [[-Locations] <OrderedDictionary>] [-HomeTimeZone <String>]
[-DateTime <DateTime>] [-AsTable] [-AsList] [<CommonParameters>]This command is designed to present a console-based version of a world clock. You provide a hashtable of locations and their respective time zones and the command will write a custom object to the pipeline. Be aware that TimeZone names may vary depending on the .NET Framework version. You may need to enumerate using a command like [System.TimeZoneInfo]::GetSystemTimeZones().ID or the Get-TZList command.
A Note on Formatting:
Normally, a PowerShell command should write an object to the pipeline and then you could use Format-Table or Format-List as you wanted. Those commands will continue to work. However, given the way this command writes to the pipeline, that is with dynamically generated properties, it is difficult to create the usual format ps1xml file. To provide some nicer formatting this command has optional parameters to help your format the output. Note that even though it may look like a table, the output object will be a string.
This command was added in v2.3.0.
P{S C:\>Get-MyTimeInfo
Now : 3/4/2020 1:28:43 PM
Home : 3/4/2020 1:28:43 PM
UTC : 3/4/2020 6:28:43 PM
Singapore : 3/5/2020 2:28:43 AM
Seattle : 3/4/2020 10:28:43 AM
Stockholm : 3/4/2020 7:28:43 PM
IsDaylightSavings : FalseThe default output is a custom object with each timezone as a property.
Get-MyTimeInfo -AsTable
Now: 03/04/2020 13:28:11
UTC: 03/04/2020 18:28:11
Home Singapore Seattle Stockholm IsDaylightSavings
---- --------- ------- --------- -----------------
3/4/2020 1:28:11 PM 3/5/2020 2:28:11 AM 3/4/2020 10:28:11 AM 3/4/2020 7:28:11 PM FalseDisplay current time information as a table. The output is a string.
PS C:\> Get-MyTimeInfo -AsList
Now: 03/04/2020 13:27:03
UTC: 03/04/2020 18:27:03
Home : 3/4/2020 1:27:03 PM
Singapore : 3/5/2020 2:27:03 AM
Seattle : 3/4/2020 10:27:03 AM
Stockholm : 3/4/2020 7:27:03 PM
IsDaylightSavings : FalseGet current time info formatted as a list.
PS C:\> $loc = [ordered]@{"Hong Kong"="China Standard Time";Honolulu="Hawaiian Standard Time";Mumbai = "India Standard Time"}
PS C:\> Get-MyTimeInfo -Locations $loc -ft
Now: 03/04/2020 13:26:23
UTC: 03/04/2020 18:26:23
Home Hong Kong Honolulu Mumbai IsDaylightSavings
---- --------- -------- ------ -----------------
3/4/2020 1:26:23 PM 3/5/2020 2:26:23 AM 3/4/2020 8:26:23 AM 3/4/2020 11:56:23 PM FalseUsing a custom location hashtable, get time zone information formatted as a table. This example is using the -ft alias for the AsTable parameter. Even though this is formatted as a table the actual output is a string.
PS C:\> Get-MyTimeInfo -Locations ([ordered]@{Seattle="Pacific Standard time";"New Zealand" = "New Zealand Standard Time"}) -HomeTimeZone "central standard time" | Select Now,Home,Seattle,'New Zealand'
Now Home Seattle New Zealand
--- ---- ------- -----------
3/4/2020 1:18:36 PM 3/4/2020 12:18:36 PM 3/4/2020 10:18:36 AM 3/5/2020 7:18:36 AMThis is a handy command when traveling and your laptop is using a locally derived time and you want to see the time in other locations. It is recommended that you set a PSDefaultParameter value for the HomeTimeZone parameter in your PowerShell profile.
Use an ordered hashtable of location names and timezones. You can find timezones with the Get-TimeZone cmdlet or through the .NET Framework with an expression like
[System.TimeZoneinfo]::GetSystemTimeZones()The hashtable key should be the location or city name and the value should be the time zone ID. Be careful as it appears time zone IDs are case-sensitive.
The default value is:
[ordered]@{
Singapore = "Singapore Standard Time";
Seattle = "Pacific Standard Time";
Stockholm = "Central Europe Standard Time";
}You might want to define a default value in $PSDefaultParameterValues with your own defaults.
It is recommended you limit this hashtable to no more than 5 locations, especially if you want to format the results as a table.
Type: OrderedDictionary
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: see note
Accept pipeline input: False
Accept wildcard characters: FalseSpecify the timezone ID of your home location. You might want to set this as a PSDefaultParameterValue
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: Eastern Standard Time
Accept pipeline input: False
Accept wildcard characters: FalseSpecify the datetime value to use. The default is now.
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: $(Get-Date)
Accept pipeline input: False
Accept wildcard characters: FalseDisplay the results as a formatted table. This parameter has an alias of ft.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: ft
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseDisplay the results as a formatted list. This parameter has an alias of fl.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: fl
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/