Get-DhcpServerv4OptionValue
Returns the IPv4 option values for IPv4 options at the server, scope, or reservation level.
Syntax
Get-DhcpServerv4OptionValue
[-VendorClass <String>]
[-ComputerName <String>]
[[-ScopeId] <IPAddress>]
[-ReservedIP <IPAddress>]
[[-OptionId] <UInt32[]>]
[-UserClass <String>]
[-All]
[-Brief]
[-PolicyName <String>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Description
The Get-DhcpServerv4OptionValue cmdlet returns the IPv4 option values for one or more IPv4 options at the server, scope, or reservation level. Use the VendorClass and UserClass parameters to get option values for a specific vendor class or for a specific user class. If you do not specify the OptionId parameter, this cmdlet returns the option values for all the options configured at the specified level either the server, the scope, or the reservation level.
If you specify only the ReservedIP parameter, the option values set at the rReservation level are returned. If you specify only the ScopeId parameter, the option values set at the scope level are returned. If you specify neither the ScopeId nor the ReservedIP parameter, option values set at the server level are returned.
If you specify neither the VendorClass nor UserClass parameter, this cmdlet gets the standard option values set.
The PolicyName and UserClass parameters cannot both be specified.
The PolicyName parameter cannot be specified if the ReservedIP parameter is specified.
The option values for policies only exist for DHCP server services that runs on Windows Server® 2012. For older versions, only user class based option values exist.
To get legacy user class options, you must specify the UserClass parameter.
Examples
Example 1: Get standard option values at the server level
PS C:\> Get-DhcpServerv4OptionValue -ComputerName "dhcpserver.contoso.com"This example gets all the standard DHCPv4 option values, or non-class specific, configured at the server level.
Example 2: Get standard option values for a scope
PS C:\> Get-DhcpServerv4OptionValue -ComputerName "dhcpserver.contoso.com" -ScopeId 10.10.10.0This example gets all the standard DHCPv4 option values, or non-class specific, configured for the specified scope.
Example 3: Get standard options values for a reservation
PS C:\> Get-DhcpServerv4OptionValue -ComputerName "dhcpserver.contoso.com" -ReservedIP 10.10.10.5This example gets all of the standard DHCPv4 option values, or non-class specific, configured for the specified reservation.
Example 4: Get verdor class specific option values for a vendor class
PS C:\> Get-DhcpServerv4OptionValue -ComputerName "dhcpserver.contoso.com" -ScopeId 10.10.10.0 -VendorClass MSUCClientThis example gets all of the vendor class specific DHCPv4 option values configured on the specified scope for the specified vendor class.
Example 5: Get an option value for a scope by using option ID
PS C:\> Get-DhcpServerv4OptionValue -ComputerName "dhcpserver.contoso.com" -ScopeId 10.10.10.0 -OptionId 23This example gets the DHCPv4 option value configured on the specified scope for the specified option ID.
Example 6: Get all option values for a scope
PS C:\> Get-DhcpServerv4OptionValue -ComputerName "dhcpserver.contoso.com" -ScopeId 10.10.10.0 -AllThis example gets all of the DHCPv4 option values, including standard as well as vendor class or user class specific, configured on the specified scope.
Example 7: Get standard option values for a scope in brief
PS C:\> Get-DhcpServerv4OptionValue -ComputerName "dhcpserver.contoso.com" -ScopeId 10.10.10.0 -BriefThis example gets all of the standard DHCPv4 option values configured on the specified scope. The object that is returned does not contain the name of the option. The Brief parameter increase the performance by removing the delay required to get the name of the option from the DHCP server service.
Example 8: Get user specific option values for a user class
PS C:\> Get-DhcpServerv4OptionValue -ComputerName "dhcpserver.contoso.com" -ScopeId 10.10.10.0 -UserClass "LabComputer"This example gets all of the user class specific DHCPv4 option values configured on the specified scope for the specified user class.
Example 9: Get standard option values for a policy
PS C:\> Get-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -Policy SmartPhonePolicyThis example gets all of the standard DHCPv4 option values configured on the specified scope for the specified policy.
Example 10: Get option values for a policy and vendor class
PS C:\> Get-DhcpServerv4OptionValue -ComputerName "dhcpserver.contoso.com" -ScopeId 10.10.10.0 -Policy "SmartPhonePolicy" -VendorClass "HTC Phone"This example gets all of the standard, or non-class specific, DHCPv4 option values configured on the specified scope for the specified policy and vendor class.
Parameters
-All
Gets the option values for a scope, server, or reservation. Option values can include vendor class, user class, and policy specific. If only this parameter is specified, this cmdlet gets all of the option values for a scope, server, or reservation. If the OptionId parameter and this parameter are specified, option values for the specified option identifier (ID) for all of the vendor classes, user classes and policies is returned. If the VendorClass parameter and this parameter are specified, all of the option values for the specified vendor class including those for any user class or policy is returned. If the UserClass parameter and this parameter are specified, all of the option values for the specified user class including any vendor specific options is returned. If the PolicyName parameter and this parameter are specified, all of the option values for the specified policy including any vendor specific options is returned.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-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 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 DHCP server service. For repeatedly fetching a large number of option values by using this cmdlet, we recommend use of the Brief parameter.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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[] |
| Aliases: | Session |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 Dynamic Host Configuration Protocol (DHCP) server service.
| Type: | String |
| Aliases: | Cn |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OptionId
Specifies the numeric IDs of the options requested.
| Type: | UInt32[] |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PolicyName
Specifies the name of the policy for which one or more option values are requested.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ReservedIP
Specifies the IPv4 address of the reservation for which the option values are requested.
| Type: | IPAddress |
| Aliases: | IPAddress |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ScopeId
Specifies the ID of the scope, in IP address format, for which one or more option values are requested.
| Type: | IPAddress |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| 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 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UserClass
Gets the option values for that user class.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VendorClass
Gets the option values for that vendor class.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Inputs
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.
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.
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.
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.CimInstanceroot/Microsoft/Windows/DHCP/DhcpServerv4OptionValue[]
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.