Get-DhcpServerv4OptionDefinition
Get-DhcpServerv4OptionDefinition
Gets the DHCPv4 option definition for the specified option identifiers (IDs).
Syntax
Parameter Set: Get1
Get-DhcpServerv4OptionDefinition [[-OptionId] <UInt32[]> ] [[-VendorClass] <String> ] [-All] [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed Description
The Get-DhcpServerv4OptionDefinition cmdlet gets the DHCPv4 option definitions for the specified option identifiers (IDs).
If the OptionId parameter is not specified, then all of the option definitions, which are not vendor specific, are returned. The VendorClass parameter acts as a filter for option definitions for the specified vendor class only.
If the All parameter is specified, then all of the option definitions including the vendor class specific option definitions will be returned.
If the All and OptionId parameters are specified, then all of the option definitions including the vendor class specific option definitions with the specified option ID will be returned.
If the All and the VendorClass parameters are specified, then the All parameter is ignored.
Parameters
-All
Gets all of the option definitions on the DHCP server service including vendor specific option definitions.
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 |
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 Dynamic Host Configuration Protocol (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 identifiers of the options for which the option definitions are requested. If nothing is specified, then all of the DHCPv4 option definitions are returned.
Aliases |
none |
Required? |
false |
Position? |
1 |
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 |
-VendorClass<String>
Returns the option definitions only for the specified vendor class.
Aliases |
none |
Required? |
false |
Position? |
2 |
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/DhcpServerv4OptionValue
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/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.
Examples
EXAMPLE 1
This example gets the standard, or non-vendor specific, DHCPv4 option definitions on the DHCP server service running on the computer named dhcpserver.contoso.com.
PS C:\> Get-DhcpServerv4OptionDefinition -ComputerName dhcpserver.contoso.com
EXAMPLE 2
This example gets all of the DHCPv4 option definitions including vendor specific option definition present on the DHCP server service.
PS C:\> Get-DhcpServerv4OptionDefinition -ComputerName dhcpserver.contoso.com -All
EXAMPLE 3
This example gets the DHCPv4 option definition for the specified option.
PS C:\> Get-DhcpServerv4OptionDefinition -ComputerName dhcpserver.contoso.com -OptionId 23
EXAMPLE 4
This example gets all the DHCPv4 option definitions for the specified vendor class.
PS C:\> Get-DhcpServerv4OptionDefinition -ComputerName dhcpserver.contoso.com -VendorClass "Microsoft Windows Options"
Related topics
Add-DhcpServerv4OptionDefinition