Get-DhcpServerv4Policy

  • Reference
Module:
DhcpServer

Gets policies at the server level or the scope level.

Syntax

Get-DhcpServerv4Policy
   [-ComputerName <String>]
   [[-Name] <String[]>]
   [[-ScopeId] <IPAddress>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-DhcpServerv4Policy cmdlet gets one or more policies at the server level or the scope level.

If you specify the Name and ScopeId parameters, the policy from the specified scope is retrieved.

If you specify only the ScopeId parameter, all of the policies in the specified scope are retrieved.

If you specify only the Name parameter, that specific server level policy is retrieved.

If you specify neither the Name nor the ScopeId parameter, all of the server level policies are retrieved.

Examples

Example 1: Get properties for a policy by name

PS C:\> Get-DhcpServerv4Policy -ComputerName "dhcpserver.contoso.com" -Name "PrinterPolicy"

This example gets the policy properties for the policy named PrinterPolicy that is defined as a server level, or server-wide, policy.

Example 2: Get properties for a policy by name in a scope

PS C:\> Get-DhcpServerv4Policy -ComputerName "dhcpserver.contoso.com" -Name "HyperVPolicy" -ScopeId 10.10.10.0

This example gets the policy properties for the policy named HyperVPolicy that is defined inside the scope 10.10.10.0.

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 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

-Name

Specifies one or more names of the policies to return.

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ScopeId

Specifies the scope identifier, in IPv4 address format, from which the policies are retrieved. If you do not specify this parameter, the server level policies are retrieved.

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

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.

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

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.