ipspaces
Mandatory parameters are denoted by an * (asterisk).
header | type | description | required | encoding | sample | object_headers |
|
---|---|---|---|---|---|---|---|
HEADER-ipamdhcp-v2-ipspace* | string | The primary identifier of the header stating the type of object. | TRUE | string |
|
|
|
key* | string | The primary identifier of an individual object. For IP Space, the name is used as the key. | TRUE | string |
|
|
|
name* | string | The name of the IP space. May contain 1 to 256 characters. | TRUE | string |
|
|
|
comment | string | The description of the IP space. May contain 0 to 1024 characters. | FALSE | string |
|
|
|
dhcp_options | string | The list of IPv4 DHCP options for the IP space. May be either a specific option or a group of options. | FALSE | expanddhcp |
|
|
|
dhcp_options_v6 | string | The list of IPv6 DHCP options for the IP space. May be either a specific option or a group of options. | FALSE | expanddhcp |
|
|
|
lease_time_v6 | integer | The duration (in seconds) of a lease for IPV6 clients. | TRUE | string |
|
|
|
filters_v6 | array | The IPv6 filters assigned to a scope. A client will receive the union of all options, from all filters it matches. | TRUE | stringarray |
|
|
|
allow_unknown | boolean | Disable this to allow leases only for known IPv4 clients: those for which a fixed address is configured. | TRUE | string |
|
|
|
filters | array | The IPv4 filters assigned to a scope. A client will receive the union of all options, from all filters it matches. | TRUE | stringarray |
|
|
|
lease_time | integer | The duration (in seconds) of a lease for IPv4 clients. | TRUE | string |
|
|
|
ignore_client_uid | boolean | Enable this option to ignore the client UID when issuing a DHCP lease. Use this option to prevent the assignment of two IP addresses for a client that does not have a UID during one phase of the PXE boot but acquires a UID for the other phase. | TRUE | string |
|
|
|
ignore_list | array | The clients from which requests are to be ignored. | TRUE | nios |
| ignore_item_type | ignore_item_value |
allow_unknown_v6 | boolean | Disable this to allow leases only for known IPV6 clients: those for which a fixed address is configured. | TRUE | string |
|
|
|
asm_enable | boolean | Indicates whether Automated Scope Management is enabled. | FALSE | string |
|
|
|
asm_enable_notification | boolean | Indicates whether Automated Scope Management is to send notifications to the user. | FALSE | string |
|
|
|
asm_reenable_date | string | The date on which notifications will be re-enabled automatically. | FALSE | string | 1970-01-01T00:00:00Z |
|
|
asm_min_total | integer | An explanation about the purpose of this instance. | FALSE | string |
|
|
|
asm_threshold | integer | Automated Scope Management shows the number of addresses forecast to be used forecast_period days in the future. If the number is greater than asm_threshold percent * dhcp_total (see dhcp_utilization), then the subnet is flagged. | FALSE | string |
|
|
|
asm_forecast_period | integer | The forecast period, in days. | FALSE | string |
|
|
|
asm_growth_factor | integer | Indicates the growth in the number or percentage of IP addresses. | FALSE | string |
|
|
|
asm_growth_type | string | The type of the factor to be used: a percentage or a count. | FALSE | string | percent |
|
|
asm_history | integer | The minimum amount of history needed before Automated Scope Management can run on this subnet. | FALSE | string |
|
|
|
asm_min_unused | integer | The minimum percentage of addresses that must be available outside the DHCP ranges and fixed when a suggested change is being made. | FALSE | string |
|
|
|
tags | string | The tags for the IP space, in JSON format. | FALSE | expandtags |
|
|
|
vendor_specific_option_option_space | string | The reference to the option space that will be encapsulated into the vendor-specific option (code = 43). | FALSE | string |
|
|
|
allow_unknown_action | string | The configuration of inheritance for the allow_unknown field of a DHCPConfig object. | FALSE | string | inherit |
|
|
filters_action | string | The configuration of inheritance for the filters field of a DHCPConfig object. | FALSE | string | inherit |
|
|
lease_time_action | string | The configuration of inheritance for the lease_time field of a DHCPConfig object. | FALSE | string | inherit |
|
|
ignore_client_uid_action | string | The configuration of inheritance for the ignore_client_uid field of a DHCPConfig object. | FALSE | string | inherit |
|
|
ignore_list_action | string | The configuration of inheritance for the ignore_list field of a DHCPConfig object. | FALSE | string | inherit |
|
|
allow_unknown_v6_action | string | The configuration of inheritance for the allow_unknown_v6 field of a DHCPConfig object. | FALSE | string | inherit |
|
|
lease_time_v6_action | string | The configuration of inheritance for the lease_time_v6 field of a DHCPConfig object. | FALSE | string | inherit |
|
|
filters_v6_action | string | The configuration of inheritance for the filters_v6 field of a DHCPConfig object. | FALSE | string | inherit |
|
|
dhcp_options_v4_value | array | The configuration of inheritance for a field of type OptionItem. | FALSE | nios |
| dhcp_options_value_action |
|
dhcp_options_v4_action | string | The configuration of inheritance.
The default value is "inherit". | FALSE | string | inherit |
|
|
dhcp_options_v6_action | string | The configuration of inheritance.
The default value is "inherit". | FALSE | string | inherit |
|
|
dhcp_options_v6_value | array | The configuration of inheritance for a field of type OptionItem. | FALSE | nios |
| dhcp_options_value_action |
|
asm_enable_block_action | string | The configuration of inheritance for the asm_enable_block field. | FALSE | string | inherit |
|
|
asm_min_total_action | string | The configuration of inheritance for the asm_min_total field. | FALSE | string | inherit |
|
|
asm_threshold_action | string | The configuration of inheritance for the asm_threshold field. | FALSE | string | inherit |
|
|
asm_forecast_period_action | string | The configuration of inheritance for the asm_forecast_period field. | FALSE | string | inherit |
|
|
asm_growth_block_action | string | The configuration of inheritance for the asm_growth_block field. | FALSE | string | inherit |
|
|
asm_history_action | string | The configuration of inheritance for the asm_history field. | FALSE | string | inherit |
|
|
asm_min_unused_action | string | The configuration of inheritance for the asm_min_unused_action field. | FALSE | string | inherit |
|
|
vendor_specific_option_option_space_action | string | The reference to the option space that will be encapsulated into the vendor-specific option (code = 43). | FALSE | string | inherit |
|
|
ddns_enabled_action | string | The configuration of inheritance for the ddns_enabled field. The only action allowed is 'inherit'. | FALSE | string | inherit |
|
|
header_option_server_address_action | string | The configuration of inheritance for the header_option_server_address field. | FALSE | string | inherit |
|
|
header_option_server_name_action | string | The configuration of inheritance for the header_option_server_name field. | FALSE | string | inherit |
|
|
header_option_filename_action | string | The configuration of inheritance for the header_option_filename field. | FALSE | string | inherit |
|
|
ddns_update_block_action | string | The configuration of inheritance for the ddns_send_updates and ddns_domain fields of an IPSpace object. | FALSE | string | inherit |
|
|
ddns_client_update_action | string | The configuration of inheritance for the ddns_client_update field of an IPSpace object. | FALSE | string | inherit |
|
|
hostname_rewrite_block_action | string | The configuration of inheritance for the hostname_rewrite_enabled, hostname_rewrite_regex, and hostname_rewrite_char fields of an IPSpace object. | FALSE | string | inherit |
|
|
ddns_hostname_block_action | string | The configuration of inheritance for the ddns_generate_name and ddns_generated_prefix fields of an IPSpace object. | FALSE | string | inherit |
|
|
ddns_update_on_renew_action | string | The configuration of inheritance for the ddns_update_on_renew field of an IPSpace object. | FALSE | string | inherit |
|
|
ddns_use_conflict_resolution_action | string | The configuration of inheritance for the ddns_use_conflict_resolution field of an IPSpace object. | FALSE | string | inherit |
|
|
ddns_conflict_resolution_mode_action | string | The configuration of inheritance for the ddns_conflict_resolution_mode field of an IPSpace object. | FALSE | string | inherit |
|
|
ddns_domain | string | The domain suffix for DDNS updates. The FQDN may be empty. | FALSE | string |
|
|
|
header_option_server_address | string | The configuration for the header_option_server_address field. | FALSE | string |
|
|
|
header_option_server_name | string | The configuration for the header_option_server_name field. | FALSE | string |
|
|
|
header_option_filename | string | The configuration for the header_option_filename field. | FALSE | string |
|
|
|
ddns_send_updates | boolean | Determines whether DDNS updates are enabled at the level of an IP space. | FALSE | string |
|
|
|
ddns_generated_prefix | string | The prefix used to generate an FQDN. | FALSE | string | myhost |
|
|
ddns_generate_name | boolean | Indicates whether DDNS is to generate a hostname when one is not supplied by the client. | FALSE | string |
|
|
|
ddns_update_on_renew | boolean | Instructs the DHCP server to always update the DNS information when a lease is renewed, even if its DNS information has not changed.. | FALSE | string |
|
|
|
ddns_use_conflict_resolution | boolean | When the value is "true", the DHCP server will apply conflict resolution when attempting to fulfill the update request, as described in RFC 4703. Defaults to "true". | FALSE | string |
|
|
|
ddns_client_update | string | Controls who make the DDNS updates.
Defaults to “client”. | FALSE | string | client |
|
|
hostname_rewrite_enabled | boolean | Indicates whether client-supplied hostnames will be rewritten prior to a DDNS update, by replacing every character that does not match hostname_rewrite_regex with hostname_rewrite_char. | FALSE | string |
|
|
|
hostname_rewrite_regex | string | The regex bracket expression for matching valid characters. | FALSE | string | [^a-zA-Z0-9_.] |
|
|
hostname_rewrite_char | string | The character to replace non-matching characters with when hostname rewrite is enabled. | FALSE | string | - |
|
|
ddns_conflict_resolution_mode | string | The mode used for resolving conflicts during DDNS updates.
Defaults to check_with_dhcid. | FALSE | string | check_with_dhcid |
|
|
access_view | string | Contains the name of the access view that the object belongs to. If you have used compartment_id, modify the field name to access_view before importing data into the Infoblox Portal. | FALSE | string | marketing |
|
|