Page tree

Contents

The following table shows the available attributes with sample values:

AttributeSample values showing syntaxMandatoryDescription
HEADER-optionfiltersoptionfiltersYesThe header for option filters. 
data.items.apiVersion`ipamdhcp.bulk.infoblox.com/v1`YesThe API version used to process data. Specify the value exactly as shown in the sample. 
data.items.kind`OptionFilter`YesThe value for option code is `OptionCode`
data.items.mergeOptions.key`key`YesThe value is 'key' by default and no other value can be used.
data.items.mergeOptions.parentKind["ipamdhcp.bulk.infoblox.com/optionspace",
"ipamdhcp.bulk.infoblox.com/optioncode",
"ipamdhcp.bulk.infoblox.com/optiongroup"]
YesThis field tells BloxOne how to interpret the data while importing each entry. Specify the value exactly as shown in the sample. 
data.items.metadata.creationTimestampnullNoFor internal use.
data.items.metadata.name`PXE`YesSpecify the name of the option filter. 
data.items.metadata.namespace`default`YesThe namespace as required or leave it as 'default'.
data.items.metadata.resourceVersion`1636505527205531000`NoThis is an optional field. 
data.items.metadata.selfLink`/apis/ipamdhcp.bulk.infoblox.com/v1/namespaces/default/optionfilters/PXE`YesThis field tells BloxOne how to interpret the data while importing each entry. Specify the selfLink in the format `/apis/ipamdhcp.bulk.infoblox.com/v1/namespaces/default/optionfilters/PXE`
data.items.spec.key`PXE`YesSpecify the name of the option filter. 
data.items.spec.optionFilter.commentThis is a new option filter. NoSpecify a comment. 
data.items.spec.optionFilter.created_at.nanos560391000NoSpecify when the object must be created (in nanoseconds).
data.items.spec.optionFilter.created_at.seconds1567114171NoSpecify when the object must be created (in seconds).
data.items.spec.optionFilter.dhcp_options[{"option_code":"dhcp/option_code/dhcp4,tftp-server-name","option_value":"10.10.10.10","type":"option"},
{"option_code":"dhcp/option_code/dhcp4,boot-file-name","option_value":"pxe.0","type":"option"}]
No

The list of DHCP options for the option filter. May be either a specific option or a group of options. The following parameters are available:

  • group -  The resource identifier.
  • option_code - The resource identifier. 
  • option_value - The option value. 
  • type - The type of item. 
data.items.spec.optionFilter.id`dhcp/option_filter/16b094ea-caa4-11e9-9002-c2bd50b5a171`NoThis is a read-only field. The resource identifier. The value for this field is automatically populated by BloxOne. 
data.items.spec.optionFilter.name`PXE`Yes

The name of the option filter. Must contain 1 to 256 characters. Can include UTF-8.

data.items.spec.optionFilter.rules.match`all`Yes

Indicates if this list should match if any or all rules match (any or all).

data.items.spec.optionFilter.rules.rules[{"compare":"equals","option_code":"dhcp/option_code/dhcp4,vendor-class-identifier","option_value":"PXEclient"}]Yes

The list of child rules. 

  • compare - Indicates how to compare the option_value to the client option. This parameter is mandatory. Success by comparison:
    • equals: value and client option are the same,
    • not_equals: value and client option are not the same,
    • exists: client option exists,
    • not_exists: client option does not exist,
    • text_substring: value is the specified substring of the option,
    • not_text_substring: value is not the specified substring of the option.
    • hex_substring: value is the specified hexadecimal substring of the option,
    • not_hex_substring: value is not the specified hexadecimal substring of the option.
  • option_code - the resource identifier. This parameter is mandatory.
  • option_value - the value to match against.
  • substring_offset - The offset where the substring match starts. This is used only if comparing the option_value using any of the substring modes.
data.items.spec.optionFilter.tags.value`{"Location":"Santa Clara"}`NoSpecify the value for the tags in the format `{"Location":"Santa Clara"}`.
data.items.spec.optionFilter.updated_at.nanos205531000NoSpecify when the object must be updated (in nanoseconds).
data.items.spec.optionFilter.updated_at.seconds1636505527NoSpecify when the object must be updated (in seconds).
data.items.status{}NoFor internal use. This field can be left blank.

  • No labels

This page has no comments.