Edit

Share via

Get-DhcpServerv4Class

  • Reference
Module:
DhcpServer

Retrieves an IPv4 vendor or user class from the DHCP server service.

Syntax

Get-DhcpServerv4Class
   [[-Name] <String[]>]
   [[-Type] <String>]
   [-ComputerName <String>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-DhcpServerv4Class cmdlet retrieves an IPv4 vendor or user class from the Dynamic Host Configuration Protocol (DHCP) server service.

If you specify only the Type parameter, all classes of the specified class type are retrieved.

If you specify neither the Name nor the Type parameter, all of the user and vendor classes are retrieved.

Examples

Example 1: Get all class definitions

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

This example gets all of the DHCPv4 class definitions, including vendor and user, which are present on the DHCP server service that runs on the computer named dhcpserver.contoso.com.

Example 2: Get vendor class definitions

PS C:\> Get-DhcpServerv4Class -ComputerName "dhcpserver.contoso.com" -Type Vendor

This example gets all of the DHCPv4 vendor class definitions which are present on the DHCP server service that runs on the computer named dhcpserver.contoso.com.

Example 3: Get a specific vendor class definition

PS C:\> Get-DhcpServerv4Class -ComputerName "dhcpserver.contoso.com" -Name "MSUCClient"

This example gets the DHCPv4 vendor class definition for the specified vendor class named MSUCClient on the DHCP server service that runs on the computer named dhcpserver.contoso.com.

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
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 DHCP server service.

Type:String
Aliases:Cn
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the name of the vendor or user class that is retrieved.

Type:String[]
Position:1
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

-Type

Specifies the type of the class. The acceptable values for this parameter are: Vendor and User.

Type:String
Accepted values:Vendor, User
Position:2
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Inputs

CimInstance

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/DhcpServerv4Class[]

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.