Skip to content

Commit 7ed952a

Browse files
Merge pull request MicrosoftDocs#3353 from zockan/netwnv_Get-NetVirtualizationProviderAddress
Formatted Get-NetVirtualizationProviderAddress
2 parents e063f93 + edd0196 commit 7ed952a

File tree

1 file changed

+66
-46
lines changed

1 file changed

+66
-46
lines changed

docset/winserver2022-ps/netwnv/Get-NetVirtualizationProviderAddress.md

Lines changed: 66 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -23,48 +23,50 @@ Get-NetVirtualizationProviderAddress [-ProviderAddress <String[]>] [-InterfaceIn
2323
```
2424

2525
## DESCRIPTION
26-
The **Get-NetVirtualizationProviderAddress** cmdlet gets Provider Addresses configured in Microsoft® Hyper-V® Server 2016 Network Virtualization.
27-
A Provider Address is an IPv4 or IPv6 address that Network Virtualization uses for multiple virtual Customer Addresses.
28-
For more information, see [Network Virtualization technical details](https://technet.microsoft.com/library/jj134174.aspx) on TechNet.
2926

30-
You can specify which Provider Addresses to get by using address state, interface index, prefix length, IP address, or VLAN ID.
31-
You can use this cmdlet to get Provider Addresses for other cmdlets, such as the Set-NetVirtualizationProviderAddress cmdlet or the Remove-NetVirtualizationProviderAddress cmdlet.
27+
The `Get-NetVirtualizationProviderAddress` cmdlet gets Provider Addresses configured in Microsoft®
28+
Hyper-V® Server 2016 Network Virtualization. A Provider Address is an IPv4 or IPv6 address that
29+
Network Virtualization uses for multiple virtual Customer Addresses. For more information, see
30+
[Network Virtualization technical details](https://technet.microsoft.com/library/jj134174.aspx) on
31+
TechNet.
32+
33+
You can specify which Provider Addresses to get by using address state, interface index, prefix
34+
length, IP address, or VLAN ID. You can use this cmdlet to get Provider Addresses for other cmdlets,
35+
such as the `Set-NetVirtualizationProviderAddress` cmdlet or the
36+
`Remove-NetVirtualizationProviderAddress` cmdlet.
3237

3338
## EXAMPLES
3439

3540
### Example 1: Get Provider Addresses for an interface
36-
```
37-
PS C:\> Get-NetVirtualizationProviderAddress -InterfaceIndex 13
41+
42+
```powershell
43+
Get-NetVirtualizationProviderAddress -InterfaceIndex 13
3844
```
3945

4046
This command gets the Provider Address for the interface with the specified index.
4147

4248
### Example 2: Get a specific Provider Address
43-
```
44-
PS C:\>Get-NetVirtualizationProviderAddress -ProviderAddress "172.16.2.3"
49+
50+
```powershell
51+
Get-NetVirtualizationProviderAddress -ProviderAddress '172.16.2.3'
4552
```
4653

47-
This command gets the Provider Address that has the IP address 172.16.2.3.
54+
This command gets the Provider Address that has the IP address `172.16.2.3`.
4855

4956
## PARAMETERS
5057

5158
### -AddressState
52-
Specifies an array of states of Provider Addresses.
53-
The acceptable values for this parameter are:
54-
55-
- Preferred.
56-
The address is unique.
57-
- Tentative.
58-
The address is not yet verified.
59-
- Duplicate.
60-
There is a duplicate address on the network.
61-
- Invalid.
62-
The address lifetime has expired.
63-
- Deprecated.
64-
The address cannot start new connections.
59+
60+
Specifies an array of states of Provider Addresses. The acceptable values for this parameter are:
61+
62+
- `Preferred` - The address is unique.
63+
- `Tentative` - The address is not yet verified.
64+
- `Duplicate` - There is a duplicate address on the network.
65+
- `Invalid` - The address lifetime has expired.
66+
- `Deprecated` - The address cannot start new connections.
6567

6668
```yaml
67-
Type: AddressState[]
69+
Type: AddressState []
6870
Parameter Sets: (All)
6971
Aliases:
7072
Accepted values: Invalid, Tentative, Duplicate, Deprecated, Preferred
@@ -77,10 +79,12 @@ Accept wildcard characters: False
7779
```
7880
7981
### -AsJob
80-
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
82+
83+
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to
84+
complete.
8185
8286
```yaml
83-
Type: SwitchParameter
87+
Type: System.Management.Automation.SwitchParameter
8488
Parameter Sets: (All)
8589
Aliases:
8690

@@ -92,12 +96,14 @@ Accept wildcard characters: False
9296
```
9397
9498
### -CimSession
95-
Runs the cmdlet in a remote session or on a remote computer.
96-
Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet.
97-
The default is the current session on the local computer.
99+
100+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
101+
object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967)
102+
or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
103+
current session on the local computer.
98104
99105
```yaml
100-
Type: CimSession[]
106+
Type: Microsoft.Management.Infrastructure.CimSession[]
101107
Parameter Sets: (All)
102108
Aliases: Session
103109

@@ -109,10 +115,12 @@ Accept wildcard characters: False
109115
```
110116
111117
### -InterfaceIndex
112-
Specifies an array of indexes for network interfaces that have Hyper-V Server 2016 Network Virtualization enabled.
118+
119+
Specifies an array of indexes for network interfaces that have Hyper-V Server 2016 Network
120+
Virtualization enabled.
113121
114122
```yaml
115-
Type: UInt32[]
123+
Type: System.UInt32[]
116124
Parameter Sets: (All)
117125
Aliases:
118126

@@ -124,10 +132,11 @@ Accept wildcard characters: False
124132
```
125133
126134
### -MACAddress
135+
127136
Specifies an array of media access control (MAC) addresses that corresponds to the Provider Address.
128137
129138
```yaml
130-
Type: String[]
139+
Type: System.String[]
131140
Parameter Sets: (All)
132141
Aliases:
133142

@@ -139,12 +148,14 @@ Accept wildcard characters: False
139148
```
140149
141150
### -ManagedByCluster
142-
Specifies an array of Boolean values that determines whether a highly available Provider Address configuration entry exists on a Hyper-V Network Virtualization gateway.
143-
If you use a Provider Address cluster resource, this value is $True; otherwise, the value is $False.
144-
This parameter is a read-only parameter, used by an administrator to diagnose problems.
151+
152+
Specifies an array of **Boolean** values that determines whether a highly available Provider Address
153+
configuration entry exists on a Hyper-V Network Virtualization gateway. If you use a Provider
154+
Address cluster resource, this value is `$true`. Otherwise, the value is `$false`. This parameter is
155+
a read-only parameter, used by an administrator to diagnose problems.
145156

146157
```yaml
147-
Type: Boolean[]
158+
Type: System.Boolean[]
148159
Parameter Sets: (All)
149160
Aliases:
150161
@@ -156,10 +167,11 @@ Accept wildcard characters: False
156167
```
157168

158169
### -PrefixLength
170+
159171
Specifies an array of lengths of IP prefixes.
160172

161173
```yaml
162-
Type: Byte[]
174+
Type: System.Byte[]
163175
Parameter Sets: (All)
164176
Aliases:
165177
@@ -171,11 +183,12 @@ Accept wildcard characters: False
171183
```
172184

173185
### -ProviderAddress
186+
174187
Specifies an array of IP addresses.
175188
You can use IPv4 and IPv6 addresses.
176189

177190
```yaml
178-
Type: String[]
191+
Type: System.String[]
179192
Parameter Sets: (All)
180193
Aliases:
181194
@@ -187,12 +200,15 @@ Accept wildcard characters: False
187200
```
188201

189202
### -ThrottleLimit
190-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
191-
If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer.
192-
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
203+
204+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
205+
this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an
206+
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
207+
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
208+
computer.
193209

194210
```yaml
195-
Type: Int32
211+
Type: System.Int32
196212
Parameter Sets: (All)
197213
Aliases:
198214
@@ -204,10 +220,11 @@ Accept wildcard characters: False
204220
```
205221

206222
### -VlanID
223+
207224
Specifies an array of IDs for VLANs for Provider Addresses.
208225

209226
```yaml
210-
Type: UInt16[]
227+
Type: System.UInt16[]
211228
Parameter Sets: (All)
212229
Aliases:
213230
@@ -219,7 +236,11 @@ Accept wildcard characters: False
219236
```
220237

221238
### CommonParameters
222-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
239+
240+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
241+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
242+
-WarningAction, and -WarningVariable. For more information, see
243+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
223244

224245
## INPUTS
225246

@@ -234,4 +255,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
234255
[Remove-NetVirtualizationProviderAddress](./Remove-NetVirtualizationProviderAddress.md)
235256

236257
[Set-NetVirtualizationProviderAddress](./Set-NetVirtualizationProviderAddress.md)
237-

0 commit comments

Comments
 (0)