Get-DhcpServerv6OptionValue
Get-DhcpServerv6OptionValue
Returns the IPv6 option values for one or more IPv6 options either for a specific reserved IP, scope or, server level.
Syntax
Parameter Set: Get0
Get-DhcpServerv6OptionValue [[-OptionId] <UInt32[]> ] [[-Prefix] <IPAddress> ] [-All] [-AsJob] [-Brief] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-ReservedIP <IPAddress> ] [-ThrottleLimit <Int32> ] [-UserClass <String> ] [-VendorClass <String> ] [ <CommonParameters>]
Detailed Description
The Get-DhcpServerv6OptionValue cmdlet returns the IPv6 option values for one or more IPv6 options either for a specific reserved IP, scope, or server level. The option identifier (ID) can be a standard option or for a specified vendor class. If the OptionId parameter is not specified, then all option values at the requested level, such as reservation, scope, server, are returned.
If the ReservedIP parameter is specified, then the option values set at the reservation level are returned. If the Prefix parameter is specified, then the option values set at the specified scope level are returned. If neither the Prefix nor the ReservedIP parameter is specified, then the option values set at the server level are returned. The Prefix and ReservedIP parameters cannot both be specified.
If neither the VendorClass nor the UserClass parameter is specified, then this cmdlet returns the standard option values.
Parameters
-All
Gets the option values for a scope, server, or reservation. Option values can include vendor class and user class specific.
If only this parameter is specified, then this cmdlet will get all of the option values for the specified scope, reservation, or server.
If the OptionId parameter and this parameter are specified, then option values for the specified option ID for all of the vendor classes and user classes will be returned.
If the VendorClass parameter and this parameter are specified, then all of the option values for the specified vendor class including those for any user class would be returned.
If the UserClass parameter and this parameter are specified, then all of the option values for the specified user class including any vendor specific options would be returned.
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 |
-Brief
Specifies that the name of the option is not returned in the option value object. This parameter improves the performance of this cmdlet by not requesting the name of the option from the Dynamic Host Configuration Protocol (DHCP) server service. For repeatedly fetching a large number of option values with this cmdlet, use of this parameter is recommended.
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 |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ComputerName<String>
Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-OptionId<UInt32[]>
Specifies the numerical identifier of the options for which one or more values are being requested. If this parameter is not specified, then all option values configured are returned.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Prefix<IPAddress>
Specifies the IPv6 subnet prefix of the scope for which the option values are being requested.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ReservedIP<IPAddress>
Specifies the reserved IPv6 address for which the option values are being requested.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-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 |
-UserClass<String>
Specifies that the option values for the specified user class are returned.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-VendorClass<String>
Specifies that the option values for the specified vendor class are returned.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
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.
Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4OptionDefinition
The
Microsoft.Management.Infrastructure.CimInstanceobject 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.Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Policy
The
Microsoft.Management.Infrastructure.CimInstanceobject 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.Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Reservation
The
Microsoft.Management.Infrastructure.CimInstanceobject 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.Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope
The
Microsoft.Management.Infrastructure.CimInstanceobject 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
The output type is the type of the objects that the cmdlet emits.
Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6OptionValue[]
The
Microsoft.Management.Infrastructure.CimInstanceobject 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.
Examples
EXAMPLE 1
This example gets all of the standard DHCPv6 option values, non-class specific, configured at the server level.
PS C:\> Get-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com
EXAMPLE 2
This example gets all of the standard DHCPv6 option values, non-class specific, configured for the specified scope.
PS C:\> Get-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020::
EXAMPLE 3
This example gets all of the standard DHCPv6 option values, non-class specific, configured for the specified reservation.
PS C:\> Get-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -ReservedIP 2001:4898:7020:1020::5
EXAMPLE 4
This example gets all of the vendor class specific DHCPv6 option values configured on the specified scope for the specified vendor class.
PS C:\> Get-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -VendorClass MSUCClient
EXAMPLE 5
This example gets the DHCPv6 option value configured on the specified scope for the specified option identifier.
PS C:\> Get-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -OptionId 23
EXAMPLE 6
This example gets all of the DHCPv6 option values configured on the specified scope. The DHCPv6 option values that are returned include the standard as well as vendor class or user class specific options.
PS C:\> Get-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -All
EXAMPLE 7
This example gets all of the standard DHCPv6 option values configured on the specified scope. The object that is returned does not contain the name of the option. The Brief parameter improves the performance of this cmdlet by not requesting the name of the option from the DHCP server service.
PS C:\> Get-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -Brief
EXAMPLE 8
This example gets all of the user class specific DHCPv6 option values configured on the specified scope for the specified user class.
PS C:\> Get-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -UserClass LabComputer