Get-DhcpServerv4Class
Get-DhcpServerv4Class
Retrieves an IPv4 vendor or user class from the Dynamic Host Configuration Protocol (DHCP) server service.
Syntax
Parameter Set: Get1
Get-DhcpServerv4Class [[-Name] <String[]> ] [[-Type] <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed Description
The Get-DhcpServerv4Class cmdlet retrieves an IPv4 vendor or user class from the Dynamic Host Configuration Protocol (DHCP) server service.
If only the Type parameter is specified, then all classes of the specified class type are retrieved.
If neither the Name nor the Type parameter is specified, then all of the user and vendor classes are retrieved.
Parameters
-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 DHCP server service.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String[]>
Specifies the name of the vendor or user class being retrieved.
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 |
-Type<String>
Specifies the type of the class. The acceptable values for this parameter are: Vendor or User.
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/DhcpServerv4Class
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.CimInstanceroot/Microsoft/Windows/DHCP/DhcpServerv4Class[]
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 DHCPv4 class definitions, including vendor and user, which are present on the DHCP server service running on the computer named dhcpserver.contoso.com.
PS C:\> Get-DhcpServerv4Class -ComputerName dhcpserver.contoso.com
EXAMPLE 2
This example gets all of the DHCPv4 vendor class definitions which are present on the DHCP server service running on the computer named dhcpserver.contoso.com.
PS C:\> Get-DhcpServerv4Class -ComputerName dhcpserver.contoso.com -Type Vendor
EXAMPLE 3
This example gets the DHCPv4 vendor class definition for the specified vendor class named MSUCClient on the DHCP server service running on the computer named dhcpserver.contoso.com.
PS C:\> Get-DhcpServerv4Class -ComputerName dhcpserver.contoso.com -Name MSUCClient