Page tree

Contents

The following table shows the available attributes with sample values:

AttributeSample values showing syntaxMandatoryDescription
HEADER-rangesrangesYesThe header for range.
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`Range`YesThe value for range is `Range`.
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/ipspace",
"ipamdhcp.bulk.infoblox.com/subnet",
"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`GSpace,10.10.10.10,10.10.10.250`YesSpecify the name of the range. 
data.items.metadata.namespace`default`YesThe namespace as required or leave it as 'default'.
data.items.metadata.resourceVersion`1633581715025454000`NoThis is an optional field. 
data.items.metadata.selfLink`/apis/ipamdhcp.bulk.infoblox.com/v1/namespaces/default/ranges/GSpace,10.10.10.10,10.10.10.250`YesThis field tells BloxOne how to interpret the data while importing each entry. Specify the selfLink in the format 
data.items.spec.key`GSpace,10.10.10.10,10.10.10.250`Yes
data.items.spec.range.commentThis range of IP addresses belongs to the east coast. No
data.items.spec.range.created_at.nanos42957000NoSpecify when the object must be created (in nanoseconds).
data.items.spec.range.created_at.seconds1576080742NoSpecify when the object must be created (in nanoseconds).
data.items.spec.range.dhcp_host`dhcp/host/2f04e9fdf58a76ecf34bcd37a47d90c4`No

The resource identifier.

data.items.spec.range.dhcp_options
No

The list of DHCP options. May be either a specific option or a group of options.

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 (string).
  • option_code - The resource identifier (string). 
  • option_value - The option value (string). 
  • type - The type of item (string). 


data.items.spec.range.end`10.10.10.250`Yes

The end IP address of the range.

data.items.spec.range.exclusion_ranges[{"comment":"desc","end":"10.1.1.20","start":"10.1.1.14"}]No

The list of all exclusion ranges in the scope of the range.

data.items.spec.range.id`ipam/range/032c2176-1c31-11ea-921b-52b98015421d`NoThis is a read-only field. The resource identifier. The value for this field is automatically populated by BloxOne. 
data.items.spec.range.inheritance_sources.dhcp_options.action`inherit`NoSpecify `inherit` or `override` for DHCP options. 
data.items.spec.range.inheritance_sources.dhcp_options.value[{"action":"inherit","display_name":"Global DHCP Properties","source":"dhcp/global/b8bd24d4-3bc3-11e9-ad6a-02420a02d40c","value":{"option_code":"dhcp/option_code/dhcp4,merit-dump","option_value":"test","type":"option"}}]NoThe value for this field is automatically updated by BloxOne. 
data.items.spec.range.name`Test Range`No

The name of the range. May contain 1 to 256 characters. Can include UTF-8.

data.items.spec.range.parent`ipam/subnet/ada87352-1c30-11ea-921b-52b98015421d`NoThe parent for this range. The resource identifier. 
data.items.spec.range.protocol`ip4`NoThis is a read-only field. The type of protocol (ipv4 or ipv6). The value for this field is automatically populated by BloxOne. 
data.items.spec.range.space`ipam/ip_space/GSpace`Yes

The resource identifier.

data.items.spec.range.start`10.10.10.10`Yes

The start IP address of the range.

data.items.spec.range.tags.value`{"Location":"Santa Clara"}`NoSpecify the value for the tags in the format `{"Location":"Santa Clara"}`.
data.items.spec.range.threshold"{"enabled":true,"low":5,"high":40},"No

A Utilization Threshold object represents IP address utilization threshold settings. There are three attributes:

  • enabled -Indicates whether the utilization threshold for IP addresses is enabled or not (boolean).
  • high The high threshold value for the percentage of used IP addresses relative to the total IP addresses available in the scope of the object (integer). Thresholds are inclusive in the comparison test. The maximum value is 100.
  • low - The low threshold value for the percentage of used IP addresses relative to the total IP addresses available in the scope of the object (integer). Thresholds are inclusive in the comparison test. The maximum value is 100.
data.items.spec.range.updated_at.nanos25454000NoSpecify when the object must be created (in nanoseconds).
data.items.spec.range.updated_at.seconds1633581715NoSpecify when the object must be created (in seconds).
data.items.spec.range.utilization.abandoned1NoThis is a read-only field. The number of IP addresses in the scope of the object which are in the abandoned state (issued by a DHCP server and then declined by the client). The value for this field is automatically populated by BloxOne. 
data.items.spec.range.utilization.dynamic100NoThis is a read-only field. The number of IP addresses handed out by DHCP in the scope of the object. This includes all leased addresses, fixed addresses that are defined but not currently leased and abandoned leases. The value for this field is automatically populated by BloxOne. 
data.items.spec.range.utilization.free141NoThis is a read-only field. The number of IP addresses available in the scope of the object. The value for this field is automatically populated by BloxOne. 
data.items.spec.range.utilization.static20NoThis is a read-only field. The number of defined IP addresses such as reservations or DNS records. It can be computed as static = used - dynamic. The value for this field is automatically populated by BloxOne. 
data.items.spec.range.utilization.total241NoThis is a read-only field. The total number of IP addresses available in the scope of the object. The value for this field is automatically populated by BloxOne. 
data.items.spec.range.utilization.used100NoThis is a read-only field. The number of IP addresses used in the scope of the object. The value for this field is automatically populated by BloxOne. 
data.items.spec.range.utilization.utilization41NoThis is a read-only field. The percentage of used IP addresses relative to the total IP addresses available in the scope of the object. The value for this field is automatically populated by BloxOne. 
data.items.status{}NoFor internal use. This field can be left blank.

  • No labels

This page has no comments.