Skip to content

Latest commit

 

History

History
185 lines (141 loc) · 6.38 KB

Get-DhcpServerv6Reservation.md

File metadata and controls

185 lines (141 loc) · 6.38 KB
description external help file Module Name ms.date online version schema title
Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
PS_DhcpServerV6Reservation_v1.0.0.cdxml-help.xml
DhcpServer
12/20/2016
2.0.0
Get-DhcpServerv6Reservation

Get-DhcpServerv6Reservation

SYNOPSIS

Returns the reserved IPv6 addresses on the DHCP server service.

SYNTAX

Prefix (Default)

Get-DhcpServerv6Reservation [-ComputerName <String>] [-Prefix] <IPAddress> [-CimSession <CimSession[]>]
 [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]

IPAddress

Get-DhcpServerv6Reservation [-ComputerName <String>] -IPAddress <IPAddress[]> [-CimSession <CimSession[]>]
 [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]

DESCRIPTION

The Get-DhcpServerv6Reservation cmdlet returns the reserved IPv6 addresses and associated client information (DUID, IAID) from the Dynamic Host Configuration Protocol (DHCP) server service.

EXAMPLES

Example 1: Get information for all reserved IPv6 addresses in a scope

PS C:\> Get-DhcpServerv6Reservation -ComputerName "dhcpserver.contoso.com" -Prefix 2001:4898:7020:1020::

This example gets the information for all of the reserved IPv6 addresses in the specified DHCPv6 scope.

Example 2: Get information for a reserved IPv6 address

PS C:\> Get-DhcpServerv6Reservation -ComputerName "dhcpserver.contoso.com" -IPAddress 2001:4898:7020:1020::5

This example gets the information for a specified reserved IPv6 address on the DHCP server service that runs on the computer named dhcpserver.contoso.com.

Example 3: Get information for all reserved IPv6 addresses in all scopes

PS C:\> Get-DhcpServerv6Scope -ComputerName "dhcpserver.contoso.com" | Get-DhcpServerv6Reservation -ComputerName "dhcpserver.contoso.com"

This example gets all of the reserved IP addresses from all of the DHCPv6 scopes on the DHCP server service that runs on the computer named dhcpserver.contoso.com. The Get-DhcpServerv6Scope cmdlet returns all of the scope objects and pipes the objects into this cmdlet, which gets the reservations from each of the scopes passed through the pipeline.

PARAMETERS

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-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.

Type: CimSession[]
Parameter Sets: (All)
Aliases: Session

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ComputerName

Specifies the DNS name, or IPv4 or IPv6 address, of the target computer that runs the DHCP server service.

Type: String
Parameter Sets: (All)
Aliases: Cn, ReservationServer

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IPAddress

Specifies the IPv6 addresses for which the reservation information is requested.

Type: IPAddress[]
Parameter Sets: IPAddress
Aliases: ReservedIP

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Prefix

Specifies the IPv6 prefix of the DHCP server service from which the reservations are requested.

Type: IPAddress
Parameter Sets: Prefix
Aliases: ReservationScopeID

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ThrottleLimit

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.

Type: Int32
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Reservation

The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

OUTPUTS

Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Reservation[]

The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

NOTES

RELATED LINKS

Add-DhcpServerv6Reservation

Get-DhcpServerv6Scope

Remove-DhcpServerv6Reservation

Set-DhcpServerv6Reservation