Get-DhcpServerv4OptionDefinition

Get-DhcpServerv4OptionDefinition

Gets the DHCPv4 option definition for the specified option 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 you do not specify the OptionId parameter, 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 you specify the All parameter, all of the option definitions including the vendor class specific option definitions are returned.

If you specify the All and OptionId parameters, all of the option definitions including the vendor class specific option definitions with the specified option ID are be returned.

If you specify the All and the VendorClass parameters, the All parameter is ignored.

Parameters

-All

Indicates that this cmdlet 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

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.


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

-ComputerName<String>

Specifies the DNS name, or IPv4 or IPv6 address, of the target computer that runs the Dynamic Host Configuration Protocol (DHCP) server service.


Aliases

Cn

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-OptionId<UInt32[]>

Specifies the numeric identifiers of the options for which the option definitions are requested. If you do not specify this parameter, all of the DHCPv4 option definitions are returned.


Aliases

none

Required?

false

Position?

2

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

Name

Required?

false

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

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

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 standard DHCPv4 option definitions

This example gets the standard, or non-vendor specific, DHCPv4 option definitions on the DHCP server service that runs on the computer named dhcpserver.contoso.com.


PS C:\> Get-DhcpServerv4OptionDefinition -ComputerName "dhcpserver.contoso.com"

Example 2: Get all DHCPv4 option definitions

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: Get DHCPv4 option definition for an option

This example gets the DHCPv4 option definition for the specified option.


PS C:\> Get-DhcpServerv4OptionDefinition -ComputerName "dhcpserver.contoso.com" -OptionId 23

Example 4: Get all DHCPv4 option definitions for a vendor class

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

Community Additions

ADD
Show: