POST /v1/addDHCPMatchClass - BlueCat Address Manager - 9.3.0

Address Manager API Guide

Locale
English (United States)
Product name
BlueCat Address Manager
Version
9.3.0

Description

Adds DHCP match classes to Address Manager.

Parameters

Name Description
configurationId

Location: query

Type: integer (int64)

The object ID of the configuration to which you are adding the DHCP match class.
matchCriteria

Location: query

Type: string

A string defining the match criteria. The value must be one of the constants listed in DHCP match class criteria.
name

Location: query

Type: string

The name of the DHCP match class.
properties

Location: query

Type: string

A string containing the following properties and values:
  • description —a description of the match class.
  • matchOffset —the Match Offset value for the MatchClass. It refers to the point where the match should begin.
  • matchLength —the Match Length value for the Matchclass. It refers to the number of characters to match.
  • customMatchRawString —a raw string that maps directly to a data or boolean expression for DHCP_CLASS_CUSTOM_MATCH and DHCP_CLASS_CUSTOM_MATCH_IF constants. Use the syntax and grammar supported by the ISC’s DHCP daemon. End the string with a semicolon (;). If you omit the semicolon, one is automatically added when the condition is deployed.
    Note:
    • matchOffset and matchLength only apply to the following five constants:
      • DHCP_CLASS_HARDWARE
      • DHCP_CLASS_CLIENT_ID
      • DHCP_CLASS_VENDOR_ID
      • DHCP_CLASS_AGENT_CIRCUIT_ID
      • DHCP_CLASS_AGENT_REMOTE_ID
    • You must specify matchOffset and matchLength together.

Responses

Code Description
201

Type: integer (int64)

Returns the object ID of the new DHCP match class added.