Page tree

Contents

The following table shows the available attributes with sample values:

AttributesSample values showing syntaxMandatoryDescription
HEADER-subnetssubnetsYesThe header for subnets.
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`Subnet`YesThe value for subnet is `Subnet`.
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/addressblock",
"ipamdhcp.bulk.infoblox.com/optionspace",
"ipamdhcp.bulk.infoblox.com/optioncode",
"ipamdhcp.bulk.infoblox.com/optiongroup",
"ipamdhcp.bulk.infoblox.com/optionfilter",
"ipamdhcp.bulk.infoblox.com/hardwarefilter"]
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`infoblox-california,10.136.106.32,27`YesSpecify the name of the subnet in the format name of the subnet, IP address, CIDR
data.items.metadata.namespace`default`YesSpecify the value for namespace or leave it as 'default'.
data.items.metadata.resourceVersion`1633581604738128000`NoThis is an optional field. 
data.items.metadata.selfLink`/apis/ipamdhcp.bulk.infoblox.com/v1/namespaces/default/subnets/infoblox-california,10.136.106.32,27`YesThis field tells BloxOne how to interpret the data while importing each entry. Specify the selfLink as per the sample value. 
data.items.spec.key`infoblox-california,10.136.106.32,27`YesSpecify the name of the subnet in the format name of the subnet, IP address, CIDR
data.items.spec.subnet.address`10.136.106.32`YesSpecify the address of the subnet. 
data.items.spec.subnet.asm_config.asm_threshold90No

ASM shows the number of addresses forecast to be used forecast_period days in the future, if it is greater than asm_threshold percent * dhcp_total  then the subnet is flagged.

data.items.spec.subnet.asm_config.enableTRUENo

Indicates if Automated Scope Management is enabled.

data.items.spec.subnet.asm_config.enable_notificationTRUENoIndicates if ASM should send notifications to the user.
data.items.spec.subnet.asm_config.forecast_period14NoThe forecast period in days.
data.items.spec.subnet.asm_config.growth_factor20NoIndicates the growth in the number or percentage of IP addresses.
data.items.spec.subnet.asm_config.growth_type`percent`No

The type of factor to use: percent or count.

data.items.spec.subnet.asm_config.history30No

The minimum amount of history needed before ASM can run on this subnet.

data.items.spec.subnet.asm_config.min_total10No

The minimum size of range needed for ASM to run on this subnet.

data.items.spec.subnet.asm_config.min_unused10No

The minimum percentage of addresses that must be available outside of the DHCP ranges and fixed addresses when making a suggested change.

data.items.spec.subnet.asm_config.reenable_date"1970-01-02T00:00:00.000Z"NoThe date at which notifications will be re-enabled automatically.
data.items.spec.subnet.asm_scope_flag1NoThis is a read-only field. 1 to indicates that the subnet may run out of addresses. Minimum:1. Maximum:32.  The value for this field is automatically populated by BloxOne. 
data.items.spec.subnet.cidr27No

The CIDR of the subnet. This is required if address does not include CIDR.

data.items.spec.subnet.comment`VLAN 1 - Management`NoSpecify a comment. 
data.items.spec.subnet.created_at.nanos453778000NoSpecify when the object must be created (in nanoseconds).
data.items.spec.subnet.created_at.seconds1594202492NoSpecify when the object must be created (in seconds).
data.items.spec.subnet.ddns_client_update`client`No

Controls who does the DDNS updates.

Valid values are:

  • client: DHCP server updates DNS if requested by client.
  • server: DHCP server always updates DNS, overriding an update request from the client, unless the client requests no updates.
  • ignore: DHCP server always updates DNS, even if the client says not to.
  • over_client_update: Same as server. DHCP server always updates DNS, overriding an update request from the client, unless the client requests no updates.
  • over_no_update: DHCP server updates DNS even if the client requests that no updates be done. If the client requests to do the update, DHCP server allows it.
data.items.spec.subnet.ddns_domaininfoblox.comNoThe domain suffix for DDNS updates. Specify the FQDN. Defaults to empty. 
data.items.spec.subnet.ddns_generated_prefix`myhost`NoThe prefix used in the generation of an FQDN. When generating a name, DHCP server will construct the name in the format: [ddns-generated-prefix]-[address-text].[ddns-qualifying-suffix].
where address-text is simply the lease IP address converted to a hyphenated string. Defaults to "myhost".
data.items.spec.subnet.ddns_send_updatesTRUENoDetermines if DDNS updates are enabled at the subnet level.
Defaults to true.
data.items.spec.subnet.ddns_update_on_renewTRUENoInstructs the DHCP server to always update the DNS information when a lease is renewed even if its DNS information has not changed.
data.items.spec.subnet.ddns_use_conflict_resolutionTRUENo

When true, DHCP server will apply conflict resolution, as described in RFC 4703, when attempting to fulfill the update request.

When false, DHCP server will simply attempt to update the DNS entries per the request, regardless of whether or not they conflict with existing entries owned by other DHCP4 clients.

Defaults to true.

data.items.spec.subnet.dhcp_config.allow_unknownTRUENo

Disable to allow leases only for known clients, those for which a fixed address is configured.

data.items.spec.subnet.dhcp_config.filtersdata.items.spec.subnet.dhcp_config.filtersNoThe resource identifier. 
data.items.spec.subnet.dhcp_config.ignore_list[{"type":"hardware","value":"aa:aa:aa:aa:aa:aa"}]No

The list of clients to ignore requests from.

data.items.spec.subnet.dhcp_config.lease_time3600NoThe lease duration in seconds.
data.items.spec.subnet.dhcp_host`dhcp/host/dhcp_host`No

The resource identifier.

data.items.spec.subnet.dhcp_utilization.dhcp_free250NoThis is a read-only field. The total free IP addresses in the DHCP ranges in the scope of this object. It can be computed as dhcp_total - dhcp_used. The value for this field is automatically populated by BloxOne. 
data.items.spec.subnet.dhcp_utilization.dhcp_total

125

NoThis is a read-only field. The total IP addresses available in the DHCP ranges in the scope of this object. The value for this field is automatically populated by BloxOne. 
data.items.spec.subnet.dhcp_utilization.dhcp_used125NoThis is a read-only field. The total IP addresses marked as used in the DHCP ranges in the scope of this object. The value for this field is automatically populated by BloxOne. 
data.items.spec.subnet.dhcp_utilization.dhcp_utilization50NoThis is a read-only field. The percentage of used IP addresses relative to the total IP addresses available in the DHCP ranges in the scope of this object. Maximum value: 100. The value for this field is automatically populated by BloxOne. 
data.items.spec.subnet.hostname_rewrite_char"_"No

The character to replace non-matching characters with, when hostname rewrite is enabled.

Any single ASCII character.

Defaults to "_".

data.items.spec.subnet.hostname_rewrite_enabledFALSENo

Indicates if client supplied hostnames will be rewritten prior to DDNS update by replacing every character that does not match hostname_rewrite_regex by hostname_rewrite_char.

Defaults to false.

data.items.spec.subnet.hostname_rewrite_regex"[^a-zA-Z0-9_.]"No

The regex bracket expression to match valid characters.

Must begin with "[" and end with "]" and be a compilable POSIX regex.

Defaults to "[^a-zA-Z0-9_.]".

data.items.spec.subnet.dhcp_options[{"option_code":"dhcp/option_code/dhcp4,routers","option_value":"10.136.106.60","type":"option"}]No

The list of DHCP options for the subnet. 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.subnet.dhcp_utilization{}No

The DHCPUtilization object represents DHCP utilization statistics for an object.

  • dhcp_free - The total free IP addresses in the DHCP ranges in the scope of this object. It can be computed as dhcp_total - dhcp_used. This is a read-only field. The value for this field is automatically populated by BloxOne. 
  • dhcp_total - The total IP addresses available in the DHCP ranges in the scope of this object. This is a read-only field. The value for this field is automatically populated by BloxOne. 
  • dhcp_used - The total IP addresses marked as used in the DHCP ranges in the scope of this object. This is a read-only field. The value for this field is automatically populated by BloxOne. 
  • dhcp_utilization - The percentage of used IP addresses relative to the total IP addresses available in the DHCP ranges in the scope of this object. This is a read-only field. The value for this field is automatically populated by BloxOne. 
data.items.spec.subnet.id`ipam/subnet/0021dad7-c102-11ea-b5c8-3670d2b79356`NoThis is a read-only field. The resource identifier. The value for this field is automatically populated by BloxOne. 
data.items.spec.subnet.inheritance_sources.asm_config.asm_enable_block.action`override`NoSpecify `inherit` or `override` for ASM enable block.
data.items.spec.subnet.inheritance_sources.asm_config.asm_enable_block.value{}NoThe value for this field is automatically updated by BloxOne. 
data.items.spec.subnet.inheritance_sources.asm_config.asm_growth_block.action`override`NoSpecify `inherit` or `override` for ASM growth block.
data.items.spec.subnet.inheritance_sources.asm_config.asm_growth_block.value{}NoThe value for this field is automatically updated by BloxOne. 
data.items.spec.subnet.inheritance_sources.asm_config.asm_threshold.action`override`NoSpecify `inherit` or `override` for ASM threshold. 
data.items.spec.subnet.inheritance_sources.asm_config.forecast_period.action`override`NoSpecify `inherit` or `override` for forecast period.
data.items.spec.subnet.inheritance_sources.asm_config.history.action`override`NoSpecify `inherit` or `override` for history.
data.items.spec.subnet.inheritance_sources.asm_config.min_total.action`override`NoSpecify `inherit` or `override` for minimum total.
data.items.spec.subnet.inheritance_sources.asm_config.min_unused.action`override`NoSpecify `inherit` or `override` for minimum unused. 
data.items.spec.subnet.inheritance_sources.ddns_client_update.action`inherit`NoSpecify `inherit` or `override` for DDNS client update. 
data.items.spec.subnet.inheritance_sources.ddns_enabled.action`inherit`NoSpecify `inherit` or `override` for DDNS enabled. 
data.items.spec.subnet.inheritance_sources.ddns_hostname_block.action`inherit`NoSpecify `inherit` or `override` for DDNS hostname blocked.
data.items.spec.subnet.inheritance_sources.ddns_hostname_block.value{}NoThe value for this field is automatically updated by BloxOne. 
data.items.spec.subnet.inheritance_sources.ddns_update_block.action`override`NoSpecify `inherit` or `override` for DDNS update block. 
data.items.spec.subnet.inheritance_sources.ddns_update_block.value{}NoThe value for this field is automatically updated by BloxOne. 
data.items.spec.subnet.inheritance_sources.ddns_update_on_renew.action`inherit`NoSpecify `inherit` or `override` for DDNS update on renew. 
data.items.spec.subnet.inheritance_sources.ddns_use_conflict_resolution.action`inherit`NoSpecify `inherit` or `override` for use conflict resolution. 
data.items.spec.subnet.inheritance_sources.dhcp_config.allow_unknown.action`override`NoSpecify `inherit` or `override` for allow unknown. 
data.items.spec.subnet.inheritance_sources.dhcp_config.filters.action`inherit`NoSpecify `inherit` or `override` for DHCP filters. 
data.items.spec.subnet.inheritance_sources.dhcp_config.ignore_list.action`inherit`NoSpecify `inherit` or `override` for ignore list. 
data.items.spec.subnet.inheritance_sources.dhcp_config.lease_time.action`override`NoSpecify `inherit` or `override` for lease time. 
data.items.spec.subnet.inheritance_sources.dhcp_options.action`block`NoSpecify `inherit` or `override` for DHCP options. 
data.items.spec.subnet.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.subnet.inheritance_sources.header_option_filename.action`inherit`NoSpecify `inherit` or `override` for header option filename. 
data.items.spec.subnet.inheritance_sources.header_option_server_address.action`inherit`NoSpecify `inherit` or `override` for header option server address.
data.items.spec.subnet.inheritance_sources.header_option_server_name.action`inherit`NoSpecify `inherit` or `override` for header option server name. 
data.items.spec.subnet.inheritance_sources.hostname_rewrite_block.action`inherit`NoSpecify `inherit` or `override` for hostname rewrite. 
data.items.spec.subnet.inheritance_sources.hostname_rewrite_block.value{}NoThe value for this field is automatically updated by BloxOne. 
data.items.spec.subnet.nameinfoblox_subnetNo

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

data.items.spec.subnet.parent

 "ipam/ip_space/infoblox_ipspace"

NoThe resource identifier.
data.items.spec.subnet.protocol`ip4`NoThis is a read-only field. The type of protocol of the subnet (ipv4 or ipv6). The value for this field is automatically populated by BloxOne. 
data.items.spec.subnet.space`ipam/ip_space/infoblox-california`NoThe resource identifier.
data.items.spec.subnet.tags.value`{"Location":"Santa Clara"}`No

Specify the value for the tags in the format `{"Location":"Santa Clara"}`.

data.items.spec.subnet.threshold"{"enabled":true,"low":5,"high":40},"No

A UtilizationThreshold object represents IP address utilization threshold settings.

  • 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. Thresholds are inclusive in the comparison test.
  • 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. Thresholds are inclusive in the comparison test.
data.items.spec.subnet.updated_at.nanos738128000NoSpecify when the object must be created (in nanoseconds).
data.items.spec.subnet.updated_at.seconds1633581604NoSpecify when the object must be created (in seconds).
data.items.spec.subnet.utilization.abandoned5NoThis 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.subnet.utilization.dynamic50NoThis 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.subnet.utilization.free30NoThis 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.subnet.utilization.static2NoThis 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.subnet.utilization.total32NoThis 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.subnet.utilization.used2NoThis 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.subnet.utilization.utilization6NoThis 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.