Get-NetVirtualizationProviderAddress

Get-NetVirtualizationProviderAddress

Gets Provider Addresses.

Syntax

Parameter Set: ByName
Get-NetVirtualizationProviderAddress [-AddressState <AddressState[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-InterfaceIndex <UInt32[]> ] [-PrefixLength <Byte[]> ] [-ProviderAddress <String[]> ] [-ThrottleLimit <Int32> ] [-VlanID <UInt16[]> ] [ <CommonParameters>]

Detailed Description

The Get-NetVirtualizationProviderAddress cmdlet gets Provider Addresses configured in Network Virtualization. A Provider Address is an IPv4 or IPv6 address that Network Virtualization uses for multiple virtual Customer Addresses. For more information, see Network Virtualization technical details (https://technet.microsoft.com/library/jj134174.aspx) on TechNet.

You can specify which Provider Addresses to get by using address state, interface index, prefix length, IP address, or VLAN ID. You can use this cmdlet to get Provider Addresses for other cmdlets, such as the Set-NetVirtualizationProviderAddress cmdlet or the Remove-NetVirtualizationProviderAddress cmdlet.

Parameters

-AddressState<AddressState[]>

Specifies an array of states of Provider Addresses. The acceptable values for this parameter are:

-- Preferred. The address is unique.
-- Tentative. The address is not yet verified.
-- Duplicate. There is a duplicate address on the network.
-- Invalid. The address lifetime has expired.
-- Deprecated. The address cannot start new connections.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AsJob

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CimSession<CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Aliases

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InterfaceIndex<UInt32[]>

Specifies an array of indexes for network interfaces that have Network Virtualization enabled.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

true

-PrefixLength<Byte[]>

Specifies an array of lengths of IP prefixes.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ProviderAddress<String[]>

Specifies an array of IP addresses. You can use IPv4 and IPv6 addresses.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

true

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VlanID<UInt16[]>

Specifies an array of IDs for VLANs for Provider Addresses.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Get Provider Addresses for an interface

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

PS C:\> Get-NetVirtualizationProviderAddress -InterfaceIndex 13

Example 2: Get a specific Provider Address

This command gets the Provider Address that has the IP address 172.16.2.3.

PS C:\> Get-NetVirtualizationProviderAddress -ProviderAddress "172.16.2.3"

New-NetVirtualizationProviderAddress

Remove-NetVirtualizationProviderAddress

Set-NetVirtualizationProviderAddress