Retrieves a DHCP vendor deployment option assigned for the object specified excluding the options inherited from the higher-level parent object.
Output / Response
Returns an APIDeploymentOption for the
DHCP vendor client deployment option. The APIDeploymentOption is
empty if the specified option does not exist. The property string
of the returned APIDeploymentOption contains at least contain the following
substring to represent vendor option definitions:
optionId=optionID|optionType=Integer(-128 to 127)|optionDescription=description multipleSignedInt8|optionAllowMultiple=boolean|server=serverID|server=serverID only appears if the DHCP vendor client deployment option is used for a specific server.
API call:
APIDeploymentOption getDHCPVendorDeploymentOption ( long
entityId, long optionId, long
serverId )
Parameter | Description |
---|---|
entityId | The object ID of the entity to which the DHCP vendor deployment option is assigned. This must be the ID of a configuration, IPv4 block, IPv4 network, IPv4 address, IPV4 DHCP rage, server, MAC address, or MAC Pool. |
optionId | The object ID of the DHCP vendor option definition. |
serverId | The specific server or server group to which this option is deployed for the specified entity. To return an option that has not been assigned to a server, set this value to 0 (zero). Omitting this parameter from the method call will result in an error. |