Get method of the PS_DhcpServerv4OptionValue class

Returns the IPv4 option Values for one or more IPv4 options at the server, scope or reservation level.

Syntax

uint32 Get(
  [in]  string                  VendorClass,
  [in]  string                  ComputerName,
  [in]  string                  ScopeId,
  [in]  string                  ReservedIP,
  [in]  uint32                  OptionId[],
  [in]  string                  UserClass,
  [in]  boolean                 All,
  [in]  boolean                 Brief,
  [in]  string                  PolicyName,
  [out] DhcpServerv4OptionValue cmdletOutput[]
);

Parameters

VendorClass [in]

If specified, gets the option values for that vendor class

ComputerName [in]

DNS name or IP address of the target computer running the DHCP server service.

ScopeId [in]

The identifier of the scope (in IP address format) for which the option value(s) are requested.

ReservedIP [in]

IPv4 address of the reservation for which the option values are requested.

OptionId [in]

The numerical identifiers of the options being requested.

UserClass [in]

If specified, gets the option values for that user class

All [in]

When only All is specified, the above cmdlet will get all the option values (including vendor class, user class and policy specific) for a scope/server/reservation. When All is specified with a specific option id, option values for the specified option id for all vendor, user classes and policies will be returned. When Vendorclass and All is specified, all option values for the specified vendor class including those for any user class or policy would be returned. When Userclass and All is specified, all option values for the specified user class including any vendor specific options would be returned. When PolicyName and All is specified, all option values for the specified policy including any vendor specific options would be returned.

Brief [in]

If specified, the Name of the option is not returned in the option value object. This improves the execution speed of the cmdlet since the name of the option is not requested from the DHCP server. In case where the cmdlet is called repeatedly to fetch a large number of option values, using -Brief is recommended.

PolicyName [in]

The name of the policy for which the option value(s) are requested.

cmdletOutput [out]

An embedded instance of the DhcpServerv4OptionValue class.

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2012
Namespace	Root\Microsoft\Windows\DHCP
MOF	DhcpServerPsProvider.mof
DLL	DhcpServerPsProvider.dll

See also

PS_DhcpServerv4OptionValue