Get-Time Cmdlet
Parameters Output Objects Config Settings
The Get-Time component provides the current (GMT) time from an Internet Time Server.
Syntax
Get-Time [parameters]
Remarks
This cmdlet implements a standard Time Protocol client as specified in RFC 868.
The cmdlet obtains the system time of the Time Server provided in the Server parameter. If the Set switch is set, the cmdlet synchronizes your system time with that of the Time Server.
The cmdlets support pipeline input for some of their parameters. Prebuilding an object and piping it to the cmdlet is very useful, but should be used with caution to prevent security conflicts. Steps have been taken to decrease the risk of a possibly accidental pipe to the cmdlet, for instance, the Credential parameter cannot be piped to the cmdlet and must be specified manually.
# Find the time
get-time -server timeserver
# Synchronize
get-time -server timeserver -set
Parameter List
The following is the full list of the parameters of the cmdlet with short descriptions. Click on the links for further details.
| LogFile | The location of a file to which debug information is written. |
| Config | Specifies one or more configuration settings. |
| LocalIP | The IP address of the local interface to use. |
| LogFile | The location of a file to which debug information is written. |
| Port | The TCP port in the remote host to which to connect. |
| Protocol | The protocol used by the component. |
| Server | The server from which the time is to be requested. |
| Set | A flag that indicates whether or not the local time should be set. |
| Timeout | The maximum time allowed for the operation. |
Output Objects
The following is the full list of the output objects returned by the cmdlet with short descriptions. Click on the links for further details.
Config Settings
The following is a list of config settings for the cmdlet with short descriptions. Click on the links for further details.
| CaptureIPPacketInfo | Used to capture the packet information. |
| DelayHostResolution | Whether the hostname is resolved when RemoteHost is set. |
| DestinationAddress | Used to get the destination address from the packet information. |
| DontFragment | Used to set the Don't Fragment flag of outgoing packets. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The port in the local host where the component binds. |
| MaxPacketSize | The maximum length of the packets that can be received. |
| QOSDSCPValue | Used to specify an arbitrary QOS/DSCP setting (optional). |
| QOSTrafficType | Used to specify QOS/DSCP settings (optional). |
| ShareLocalPort | If set to True, allows more than one instance of the component to be active on the same local port. |
| UseConnection | Determines whether to use a connected socket. |
| UseIPv6 | Whether or not to use IPv6. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| MaskSensitive | Whether sensitive data is masked in log messages. |
| UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |
LogFile Parameter (Get-Time Cmdlet)
The location of a file to which debug information is written.
Syntax
Get-Time -LogFile string
Remarks
When specified, the cmdlet will log debug information to the file. If the file exists, the information will be appended.Default Value
null
Config Property (Get-Time Cmdlet)
Specifies one or more configuration settings.
Syntax
Get-Time -Config string[]
Remarks
The Config parameter takes one or more name-value pairs that represent the name of the configuration setting and value, i.e.: -config "Name=Value"
Default Value
null
LocalIP Property (Get-Time Cmdlet)
The IP address of the local interface to use.
Syntax
Get-Time -LocalIP string
Remarks
This parameter is useful when the cmdlet is running on a machine that has more than one network interface (each with its own IP address and network access privileges).
Default Value
""
Parameter Alias
LocalAddress
LogFile Property (Get-Time Cmdlet)
The location of a file to which debug information is written.
Syntax
Get-Time -LogFile string
Remarks
When specified, the cmdlet will log debug information to the file. If the file exists, the information will be appended.
Default Value
""
Port Property (Get-Time Cmdlet)
The TCP port in the remote host to which to connect.
Syntax
Get-Time -Port int
Remarks
Port specifies a service port on the remote host to which to connect.
A valid port number (a value between 1 and 65535) is required for the connection to take place.
Default Value
37
Protocol Property (Get-Time Cmdlet)
The protocol used by the component.
Syntax
Get-Time -Protocol string
Remarks
Use this property to specify which protocol the cmdlet will use to connect to the server. By default, the Protocol is TimeProtocol (0). The SNTP protocol may be selected by setting this property to SNTP (1).
Default Value
0
Server Property (Get-Time Cmdlet)
The server from which the time is to be requested.
Syntax
Get-Time -Server string
Remarks
Server should be set to a valid internet address of a time server (default is "128.118.25.3", or "clock.psu.edu"). The server will reply with its current time (GMT).
Time requests are sent to port Port (default 37) on the Server.
Default Value
""
Parameter Position
0
Parameter Alias
TimeServer
Set Property (Get-Time Cmdlet)
A flag that indicates whether or not the local time should be set.
Syntax
Get-Time -Set SwitchParameter
Remarks
If Set is True, the system's time will be updated to the time returned from the Time Server.
Default Value
false
Timeout Property (Get-Time Cmdlet)
The maximum time allowed for the operation.
Syntax
Get-Time -Timeout int
Remarks
After the specified interval in seconds, the cmdlet will throw a Timeout error if the operation is not completed.
Default Value
10
Config Settings (Get-Time Cmdlet)
The cmdlet accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the cmdlet, access to these internal properties is provided through the Config method.UDP Config Settings
| CaptureIPPacketInfo:
Used to capture the packet information.If this is set to true, the component will capture the IP packet information.
The default value for this setting is False. Note: This setting is only available in Windows. |
|
| DelayHostResolution:
Whether the hostname is resolved when RemoteHost is set.This setting specifies whether a hostname is resolved immediately when RemoteHost is set. If true the cmdlet will resolve the hostname and the IP address will be present in the RemoteHost property.
If false, the hostname is not resolved until needed by the component when a method to connect or send data is called. If desired, ResolveRemoteHost may called to manually resolve the value in RemoteHost at any time.
The default value is false for the default library and true for the Async library. The default value is false. |
|
| DestinationAddress:
Used to get the destination address from the packet information.If CaptureIPPacketInfo is set to true, then this will be populated with the packet's destination address when a packet is received.
This information will be accessible in the DataIn event.
Note: This setting is only available in Windows. |
|
| DontFragment: Used to set the Don't Fragment flag of outgoing packets.When set to True, packets sent by the cmdlet will have the Don't Fragment flag set. The default value is False. | |
| LocalHost:
The name of the local host through which connections are initiated or accepted.
The LocalHost setting contains the name of the local host
as obtained by the gethostname() system call, or if the
user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the cmdlet initiate connections (or accept in the case of server cmdlets) only through that interface. If the cmdlet is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface). |
|
| LocalPort:
The port in the local host where the cmdlet binds.
This must be set before a connection is
attempted. It instructs the cmdlet to bind to a specific
port (or communication endpoint) in the local machine.
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established. LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems. |
|
| MaxPacketSize: The maximum length of the packets that can be received.This setting specifies the maximum size of the datagrams that the cmdlet will accept without truncation. | |
| QOSDSCPValue:
Used to specify an arbitrary QOS/DSCP setting (optional).UseConnection must be True to use this setting. This option allows you to specify an arbitrary DSCP value
between 0 and 63. The default is 0. When set to the default value the component will not set a DSCP value.
Note: This setting uses the qWAVE API is only available on Windows 7, Windows Server 2008 R2, and later. |
|
| QOSTrafficType:
Used to specify QOS/DSCP settings (optional).UseConnection must be True to use this setting.
You may specify either the text or integer values: BestEffort (0), Background (1), ExcellentEffort (2), AudioVideo (3), Voice (4), and Control (5).
Note: This setting uses the qWAVE API which is only available on Windows Vista and Windows Server 2008 or above. Note: QOSTrafficType must be set before setting Active to true. |
|
| ShareLocalPort:
If set to True, allows more than one instance of the cmdlet to be active on the same local port.This option must be set before the cmdlet is activated through
the Active property or it will have no effect.
The default value for this setting is False. |
|
| UseConnection:
Determines whether to use a connected socket.UseConnection specifies whether the cmdlet
should use a connected socket or not. The connection is
defined as an association in between the local address/port
and the remote address/port. As such, this
is not a connection in the traditional TCP sense. What it
means is only that the cmdlet will send and receive data
only to and from the specified destination.
The default value for this setting is False. |
|
| UseIPv6: Whether or not to use IPv6.By default, the component expects an IPv4 address for local and remote host properties, and will create an IPv4 socket. To use IPv6 instead, set this to True. |
Socket Config Settings
| AbsoluteTimeout:
Determines whether timeouts are inactivity timeouts or absolute timeouts.If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds
will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.
Note: This option is not valid for UDP ports. |
|
| FirewallData: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes). | |
| InBufferSize:
The size in bytes of the incoming queue of the socket.
This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be receiving. Increasing the value of the
InBufferSize setting can provide significant improvements in
performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the cmdlet is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small. |
|
| OutBufferSize:
The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be sending. Increasing the value of the
OutBufferSize setting can provide significant improvements in
performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the cmdlet is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small. |
Base Config Settings
| BuildInfo: Information about the product's build.When queried, this setting will return a string containing information about the product's build. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CodePage:
The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LicenseInfo:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a cmdlet is using. It will return the following information:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MaskSensitive:
Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is false.
This setting only works on these cmdlets: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UseInternalSecurityAPI:
Tells the cmdlet whether or not to use the system security libraries or an internal implementation.
When set to false, the cmdlet will use the system security libraries by default to perform cryptographic functions where applicable.
In this case, calls to unmanaged code will be made. In certain environments this is not desirable.
To use a completely managed security implementation set this setting to true.
Setting this setting to true tells the cmdlet to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default. If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries. Note: This setting is static. The value set is applicable to all cmdlets used in the application. When this value is set the product's system DLL is no longer required as a reference, as all unmanaged code is stored in that file. |