forked from jdhitsolutions/PSScriptTools
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathGet-WindowsVersionString.yml
More file actions
128 lines (105 loc) · 5.53 KB
/
Copy pathGet-WindowsVersionString.yml
File metadata and controls
128 lines (105 loc) · 5.53 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
examples:
- name: EXAMPLE 1
preCode: ''
code: >-
PS C:\> Get-WindowsVersionString -Computername win10 -credential company\artd
WIN10 Windows 10 Enterprise Evaluation Version EnterpriseEval (OS Build 15063.1418
postCode: Get a string version of Windows version information from a remote computer and use an alternate credential.
- name: EXAMPLE 2
preCode: ''
code: >-
PS C:\> Get-WindowsVersionString
BOVINE320 Windows 10 Pro Version Professional (OS Build 17763.253)
postCode: Get version information for the local host.
inputs:
- type: System.String
description: ''
links:
- href: https://github.com/jdhitsolutions/PSScriptTools/blob/master/docs/Get-WindowsVersionString.md
text: 'Online Version:'
- href: ''
text: Get-WindowsVersion
- href: ''
text: Winver.exe
module:
name: PSScriptTools
name: Get-WindowsVersionString
notes: 'Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/'
optionalParameters:
- name: Computername
aliases: []
defaultValue: $env:COMPUTERNAME
description: >-
Specifies the computers on which the command runs. The default is the local computer.
When you use the ComputerName parameter, Windows PowerShell creates a temporary connection that is used only to run the specified command and is then closed. If you need a persistent connection, use the Session parameter.
Type the NETBIOS name, IP address, or fully qualified domain name of one or more computers in a comma-separated list. To specify the local computer, type the computer name, localhost, or a dot (.).
To use an IP address in the value of ComputerName , the command must include the Credential parameter. Also, the computer must be configured for HTTPS transport or the IP address of the remote computer must be included in the WinRM TrustedHosts list on the local computer. For instructions for adding a computer name to the TrustedHosts list, see "How to Add a Computer to the Trusted Host List" in about_Remote_Troubleshooting.
On Windows Vista and later versions of the Windows operating system, to include the local computer in the value of ComputerName , you must open Windows PowerShell by using the Run as administrator option.
parameterValueGroup: []
pipelineInput: True (ByPropertyName, ByValue)
position: 1
type: String[]
- name: Credential
aliases: []
defaultValue: None
description: >-
Specifies a user account that has permission to perform this action. The default is the current user.
Type a user name, such as User01 or Domain01\User01. Or, enter a PSCredential object, such as one generated by the Get-Credential cmdlet. If you type a user name, this cmdlet prompts you for a password.
parameterValueGroup: []
pipelineInput: False
position: Named
type: PSCredential
- name: UseSSL
aliases: []
defaultValue: False
description: >-
Indicates that this cmdlet uses the Secure Sockets Layer (SSL) protocol to establish a connection to the remote computer. By default, SSL is not used.
WS-Management encrypts all Windows PowerShell content transmitted over the network. The UseSSL parameter is an additional protection that sends the data across an HTTPS, instead of HTTP.
If you use this parameter, but SSL is not available on the port that is used for the command, the command fails.
parameterValueGroup: []
pipelineInput: False
position: Named
type: SwitchParameter
- name: ThrottleLimit
aliases: []
defaultValue: 0
description: >-
Specifies the maximum number of concurrent connections that can be established to run this command. If you omit this parameter or enter a value of 0, the default value, 32, is used.
The throttle limit applies only to the current command, not to the session or to the computer.
parameterValueGroup: []
pipelineInput: False
position: Named
type: Int32
- name: Authentication
aliases: []
defaultValue: Default
description: >-
Specifies the mechanism that is used to authenticate the user's credentials. The acceptable values for this parameter are:
- Default
- Basic
- Credssp
- Digest
- Kerberos
- Negotiate
- NegotiateWithImplicitCredential
The default value is Default.
CredSSP authentication is available only in Windows Vista, Windows Server 2008, and later versions of the Windows operating system.
For information about the values of this parameter, see the description of the AuthenticationMechanismEnumeration (http://go.microsoft.com/fwlink/?LinkID=144382) in theMicrosoft Developer Network (MSDN) library.
CAUTION: Credential Security Support Provider (CredSSP) authentication, in which the user's credentials are passed to a remote computer to be authenticated, is designed for commands that require authentication on more than one resource, such as accessing a remote network share. This mechanism increases the security risk of the remote operation. If the remote computer is compromised, the credentials that are passed to it can be used to control the network session.
parameterValueGroup: []
pipelineInput: False
position: Named
type: String
outputs:
- type: System.String
description: ''
requiredParameters: []
remarks: This is a PowerShell version of the winver.exe utility.T his command uses PowerShell remoting to query the registry on a remote machine to retrieve Windows version information. The parameters are the same as in Invoke-Command. The command writes a string of version information.
summary: Get Windows version information
syntaxes:
- parameters:
- Computername
- Credential
- UseSSL
- ThrottleLimit
- Authentication