This object represents the Infoblox Grid Member.
References to member are object references. The name part of a member object reference has the following components:
- The member host name.
Example: member/ZG5zLm5ldHdvcmtfdmlldyQxMTk:member.com
These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.
The basic version of the object contains the field(s): config_addr_type, host_name, platform, service_type_configuration.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| host_name | |
| ipv6_setting | See the field description for more information |
| vip_setting | See the field description for more information |
The active server of a Grid member.
Type
String.
Search
The field is not available for search.
Notes
The active_position cannot be updated.
active_position cannot be written.
The additional IP list of a Grid member. This list contains additional interface information that can be used at the member level.
Note that interface structure(s) with interface type set to ‘MGMT’ are not supported.
Type
A/An IPv6/IPv4 interfaces settings struct array.
Create
The default value is:
empty
Search
The field is not available for search.
Member level settings for automated traffic capture.
Type
A/An Automated Traffic Capture struct.
Create
The default value is:
{ 'destination': 'NONE',
'include_support_bundle': False,
'keep_local_copy': False,
'traffic_capture_enable': False}
Search
The field is not available for search.
Notes
automated_traffic_capture_setting is associated with the field use_automated_traffic_capture (see use flag).
The BGP configuration for anycast for a Grid member.
Type
A/An BGP (Border Gateway Protocol) Autonomous System (AS) struct array.
Create
The default value is:
empty
Search
The field is not available for search.
A descriptive comment of the Grid member.
Type
String.
Create
The default value is empty.
Search
The field is available for search via
Address configuration type.
Type
String.
Create
The default value is IPV4.
Search
The field is available for search via
Notes
The config_addr_type is part of the base object.
CSP portal on-prem host access key
Type
String array.
Create
The default value is empty.
Search
The field is not available for search.
csp setting at member level
Type
A/An CSP Member setting struct.
Create
The default value is:
{ }
Search
The field is not available for search.
DNS resolver setting for member.
Type
A/An DNS resolver Setting struct.
Create
The default value is See the dns resolver setting struct for default values.
Search
The field is not available for search.
Notes
dns_resolver_setting is associated with the field use_dns_resolver_setting (see use flag).
The DSCP (Differentiated Services Code Point) value.
Type
Unsigned integer.
Create
The default value is 0.
Search
The field is not available for search.
Notes
The email setting for member.
Type
A/An The email settings for the Grid member struct.
Create
The default value is:
{ 'enabled': False,
'port_number': 25,
'relay_enabled': False,
'smtps': False,
'use_authentication': False}
Search
The field is not available for search.
Notes
email_setting is associated with the field use_email_setting (see use flag).
If set to True, the member has two physical nodes (HA pair).
Type
Bool.
Create
The default value is False.
Search
The field is available for search via
Determines if the LOM functionality is enabled or not.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
Notes
enable_lom is associated with the field use_enable_lom (see use flag).
Determines if the member will redirect GUI connections to the Grid Master or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
enable_member_redirect is associated with the field use_enable_member_redirect (see use flag).
If set to True and the member object is a Grid Master Candidate, then read-only API access is enabled.
Type
Bool.
Create
The default value is False.
Search
The field is available for search via
Extensible attributes associated with the object.
For valid values for extensible attributes, see the following information.
Type
Extensible attributes.
This field allows +/- to be specified as part of the field name when updating the object, see the following information.
Create
The default value is empty.
Search
For how to search extensible attributes, see the following information.
The list of external syslog backup servers.
Type
A/An External syslog backup server struct array.
Create
The default value is:
empty
Search
The field is not available for search.
Notes
external_syslog_backup_servers is associated with the field use_external_syslog_backup_servers (see use flag).
Determines if external syslog servers should be enabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
external_syslog_server_enable is associated with the field use_syslog_proxy_setting (see use flag).
The host name of the Grid member.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required on creation.
Search
The field is available for search via
Notes
The host_name is part of the base object.
IPV6 setting for member.
Type
A/An IPv6 Settings struct.
Create
At least one of vip_setting and ipv6_setting is required.
Search
The field is not available for search.
List of IPv6 static routes.
Type
A/An IPv6 Network Settings struct array.
Create
The default value is:
empty
Search
The field is not available for search.
Determines if a Grid member supports DSCP (Differentiated Services Code Point).
Type
Bool.
Search
The field is not available for search.
Notes
The is_dscp_capable cannot be updated.
is_dscp_capable cannot be written.
If this is set to “true”, the LAN2 port is enabled as an independent port or as a port for failover purposes.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Settings for the Grid member LAN2 port if ‘lan2_enabled’ is set to “true”.
Type
A/An LAN2 Port Setting struct.
Create
The default value is undefined.
Search
The field is not available for search.
Determines if the Liquid Crystal Display (LCD) input buttons on the front panel of the appliance are enabled or not.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
Notes
lcd_input is associated with the field use_lcd_input (see use flag).
The Network configurations for LOM.
Type
A/An The LOM network configuration structure struct array. The array supports a maximum of 2 element(s).
Create
The default value is:
[{ 'is_lom_capable': False}, { 'is_lom_capable': False}]
Search
The field is not available for search.
The list of LOM users.
Type
A/An The Lights Out Management (LOM) user struct array.
Create
The default value is:
empty
Search
The field is not available for search.
Determines if a Grid member is a Grid Master Candidate or not. This flag enables the Grid member to assume the role of the Grid Master as a disaster recovery measure.
Type
Bool.
Create
The default value is False.
Search
The field is available for search via
Configure communication type for various services.
Type
A/An Member Service Communication struct array.
Create
The default value is undefined.
Search
The field is not available for search.
Settings for the member MGMT port.
Type
A/An MGMT Port Setting struct.
Create
The default value is undefined.
Search
The field is not available for search.
Extensible attributes Topology database build time.
Type
Timestamp.
Search
The field is not available for search.
Notes
The mmdb_ea_build_time cannot be updated.
mmdb_ea_build_time cannot be written.
GeoIP Topology database build time.
Type
Timestamp.
Search
The field is not available for search.
Notes
The mmdb_geoip_build_time cannot be updated.
mmdb_geoip_build_time cannot be written.
NAT settings for the member.
Type
A/An NAT Settings struct.
Create
The default value is undefined.
Search
The field is not available for search.
The node information list with detailed status report on the operations of the Grid Member.
Type
A/An Node Info struct array.
Create
The default value is:
[{ }]
Search
The field is not available for search.
The member Network Time Protocol (NTP) settings.
Type
A/An The member Network Time Protocol (NTP) settings structure struct.
Create
The default value is:
{ 'enable_external_ntp_servers': False,
'enable_ntp': False,
'exclude_grid_master_ntp_server': False,
'local_ntp_stratum:': 15,
'ntp_acl': { 'ac_list': [], 'acl_type': 'NONE', 'service': 'TIME'},
'ntp_keys': [],
'ntp_kod': False,
'ntp_servers': [],
'use_default_stratum:': True,
'use_local_ntp_stratum': False,
'use_ntp_acl': False,
'use_ntp_keys': False,
'use_ntp_kod': False,
'use_ntp_servers': False}
Search
The field is not available for search.
The OSPF area configuration (for anycast) list for a Grid member.
Type
A/An OSPF Settings struct array.
Create
The default value is:
empty
Search
The field is not available for search.
The ARP protocol setting on the passive node of an HA pair. If you do not specify a value, the default value is “false”. You can only set this value to “true” if the member is an HA pair.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Hardware Platform.
Type
String.
Create
The default value is INFOBLOX.
Search
The field is available for search via
Notes
The platform is part of the base object.
Pre-provisioning information.
Type
A/An Pre-provisioning Settings struct.
Create
The default value is empty.
Search
The field is not available for search.
Set this flag to “true” to prevent the deletion of the member if any delegated object remains attached to it.
Type
Bool.
Create
The default value is False.
Search
The field is available for search via
If set to True, superuser admins can access the Infoblox CLI from a remote location using an SSH (Secure Shell) v2 client.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
remote_console_access_enable is associated with the field use_remote_console_access_enable (see use flag).
Virutal router identifier. Provide this ID if “ha_enabled” is set to “true”. This is a unique VRID number (from 1 to 255) for the local subnet.
Type
Unsigned integer.
Create
The default value is undefined.
Search
The field is available for search via
The service status list of a grid member.
Type
A/An Member Service Status struct array.
Search
The field is not available for search.
Notes
The service_status cannot be updated.
service_status cannot be written.
Configure all services to the given type.
Type
String.
Create
The default value is ALL_V4.
Search
The field is available for search via
Notes
The service_type_configuration is part of the base object.
The Grid Member SNMP settings.
Type
A/An SNMP setting struct.
Create
The default value is See the SNMP settings struct for default values.
Search
The field is not available for search.
Notes
snmp_setting is associated with the field use_snmp_setting (see use flag).
List of static routes.
Type
A/An Network settings struct array.
Create
The default value is:
empty
Search
The field is not available for search.
Determines if support access for the Grid member should be enabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
support_access_enable is associated with the field use_support_access_enable (see use flag).
The information string for support access.
Type
String.
Search
The field is not available for search.
Notes
The support_access_info cannot be updated.
support_access_info cannot be written.
The Grid Member syslog proxy settings.
Type
A/An Syslog proxy settings struct.
Create
The default value is See the syslog proxy settings struct for default values.
Search
The field is not available for search.
Notes
syslog_proxy_setting is associated with the field use_syslog_proxy_setting (see use flag).
The list of external syslog servers.
Type
A/An Syslog server struct array.
Create
The default value is:
empty
Search
The field is not available for search.
Notes
syslog_servers is associated with the field use_syslog_proxy_setting (see use flag).
The maximum size for the syslog file expressed in megabytes.
Type
Unsigned integer.
Create
The default value is 300.
Search
The field is not available for search.
Notes
syslog_size is associated with the field use_syslog_proxy_setting (see use flag).
Determines the list of threshold traps. The user can only change the values for each trap or remove traps.
Type
A/An The Grid SNMP threshold trap structure struct array.
Create
The default value is All threshold traps.
Search
The field is not available for search.
Notes
threshold_traps is associated with the field use_threshold_traps (see use flag).
The time zone of the Grid member. The UTC string that represents the time zone, such as “(UTC - 5:00) Eastern Time (US and Canada)”.
Type
String.
Create
The default value is (UTC) Coordinated Universal Time.
Search
The field is not available for search.
Notes
time_zone is associated with the field use_time_zone (see use flag).
Grid level settings for enabling authoritative DNS latency thresholds for automated traffic capture.
Type
A/An Member level settings for traffic based on authoritative DNS struct.
Create
The default value is:
{ 'auth_dns_latency_listen_on_source': 'VIP_V4',
'auth_dns_latency_trigger_enable': False}
Search
The field is not available for search.
Notes
traffic_capture_auth_dns_setting is associated with the field use_traffic_capture_auth_dns (see use flag).
Member level settings for enabling DNS cache hit ratio threshold for automated traffic capture.
Type
A/An Grid level Traffic capture chr setting struct.
Create
The default value is:
{ 'chr_trigger_enable': False}
Search
The field is not available for search.
Notes
traffic_capture_chr_setting is associated with the field use_traffic_capture_chr (see use flag).
Member level settings for enabling DNS query per second threshold for automated traffic capture.
Type
A/An Grid level traffic capture QPS setting struct.
Create
The default value is:
{ 'qps_trigger_enable': False}
Search
The field is not available for search.
Notes
traffic_capture_qps_setting is associated with the field use_traffic_capture_qps (see use flag).
Grid level settings for enabling recursive DNS latency thresholds for automated traffic capture.
Type
A/An Grid level settings for traffic capture based on recursive struct.
Create
The default value is:
{ 'kpi_monitored_domains': [],
'rec_dns_latency_listen_on_source': 'VIP_V4',
'rec_dns_latency_trigger_enable': False}
Search
The field is not available for search.
Notes
traffic_capture_rec_dns_setting is associated with the field use_traffic_capture_rec_dns (see use flag).
Grid level settings for enabling count for concurrent outgoing recursive queries for automated traffic capture.
Type
A/An Grid level settings for traffic capture based on recursive struct.
Create
The default value is:
{ 'recursive_clients_count_trigger_enable': False}
Search
The field is not available for search.
Notes
traffic_capture_rec_queries_setting is associated with the field use_traffic_capture_rec_queries (see use flag).
Determines configuration of the trap notifications.
Type
A/An The Grid SNMP trap notification structure struct array.
Create
The default value is All trap notifications.
Search
The field is not available for search.
Notes
trap_notifications is associated with the field use_trap_notifications (see use flag).
The name of the upgrade group to which this Grid member belongs.
Type
String.
Create
The default value is Default.
Search
The field is not available for search.
This flag is the use flag for enabling automated traffic capture based on DNS cache ratio thresholds.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: dns_resolver_setting
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: dscp
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: email_setting
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: enable_lom
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: enable_member_redirect
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: external_syslog_backup_servers
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: lcd_input
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: remote_console_access_enable
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: snmp_setting
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: support_access_enable
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: external_syslog_server_enable , syslog_servers, syslog_proxy_setting, syslog_size
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: threshold_traps
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: time_zone
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
This flag is the use flag for enabling automated traffic capture based on authorative DNS latency.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
This flag is the use flag for automated traffic capture settings at member level.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
This flag is the use flag for enabling automated traffic capture based on DNS querie per second thresholds.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
This flag is the use flag for enabling automated traffic capture based on recursive DNS latency.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
This flag is the use flag for enabling automated traffic capture based on outgoing recursive queries.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: trap_notifications
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Specify “true” to use VRRPv4 or “false” to use VRRPv6.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
The network settings for the Grid member.
Type
A/An Network settings struct.
Create
At least one of vip_setting and ipv6_setting is required.
Search
The field is not available for search.
Starts/Stops a traffic capture session on the specified member node.
This function does not support multiple object matches when called as part of an atomic insertion operation.
Input fields
action ( String. Valid values are: “START”, “STOP” ). This parameter is mandatory. The traffic capture action.
interface ( String. Valid values are: “ALL”, “HA”, “LAN1”, “LAN2”, “MGMT” ). This parameter is mandatory. The interface on which the traffic is captured.
seconds_to_run ( Unsigned integer. ) The number of seconds for which the traffic capture is going to run. The default value is “30”.
Output fields
None
Gets traffic capture status on the specified member node.
This function does not support multiple object matches when called as part of an atomic insertion operation.
Input fields
None
Output fields
file_exists ( Bool. ) Determines if the capture file for the member exist or not.
file_size ( Unsigned integer. ) The size of the traffic capture file for the member.
status ( String. Valid values are: “STOPPED”, “RUNNING”, “UNKNOWN” ) The status of the capture operation for the member.
Creates tokens for all available physical nodes on the member (virtual_node) and returns an array of records for pnode_token (physical_oid, token, and token_exp_date).
This function does not support multiple object matches when called as part of an atomic insertion operation.
Input fields
None
Output fields
pnode_tokens ( A/An Pysical Node Token struct array. ) An array of tokens. One token for each physical node of the Grid member.
Performs requested admin operation on the specified member node.
This function does not support multiple object matches when called as part of an atomic insertion operation.
Input fields
operation ( String. Valid values are: “FORCE_FAILOVER” ). This parameter is mandatory. The operation to be performed on the member.
Output fields
None
Returns tokens for all available physical nodes on the member (virtual_node).
This function does not support multiple object matches when called as part of an atomic insertion operation.
Input fields
None
Output fields
pnode_tokens ( A/An Pysical Node Token struct array. ) An array of tokens. One token for each physical node of the Grid member.
Use this function to request the Member service status. This function will refresh the restartservicestatus object.
This function does not support multiple object matches when called as part of an atomic insertion operation.
Input fields
service_option ( String. Valid values are: “ALL”, “DHCP”, “DNS” ) This field indicates the services for which you want to request status. The default value is “ALL”.
Output fields
None
This function controls the Member services.
This function does not support multiple object matches when called as part of an atomic insertion operation.
Input fields
restart_option ( String. Valid values are: “FORCE_RESTART”, “RESTART_IF_NEEDED” ). This parameter is mandatory. This field controls whether services are restarted unconditionally or when needed.
service_option ( String. Valid values are: “ALL”, “DHCP”, “DNS” ). This parameter is mandatory. This field indicates the services that the appliance restarts.
Output fields
None
These fields are used only for searching. They are not actual members of the object and therefore the server does not return these fields with this name unless they are nested return fields.
The member’s IPv4 Address.
Type
String.
Search
The field is available for search via
Notes
ipv4_address is a search-only field.
The member’s IPv6 Address.
Type
String.
Search
The field is available for search via
Notes
ipv6_address is a search-only field.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| active_position | String | N | Y | N | N/A |
| additional_ip_list | [struct] | N | N | N | N/A |
| automated_traffic_capture_setting | struct | N | N | N | N/A |
| bgp_as | [struct] | N | N | N | N/A |
| comment | String | N | N | N | : = ~ |
| config_addr_type | String | N | N | Y | = |
| csp_access_key | [String] | N | N | N | N/A |
| csp_member_setting | struct | N | N | N | N/A |
| dns_resolver_setting | struct | N | N | N | N/A |
| dscp | Unsigned int | N | N | N | N/A |
| email_setting | struct | N | N | N | N/A |
| enable_ha | Bool | N | N | N | = |
| enable_lom | Bool | N | N | N | N/A |
| enable_member_redirect | Bool | N | N | N | N/A |
| enable_ro_api_access | Bool | N | N | N | = |
| extattrs | Extattr | N | N | N | ext |
| external_syslog_backup_servers | [struct] | N | N | N | N/A |
| external_syslog_server_enable | Bool | N | N | N | N/A |
| host_name | String | Y | N | Y | : = ~ |
| ipv6_setting | struct | Y* | N | N | N/A |
| ipv6_static_routes | [struct] | N | N | N | N/A |
| is_dscp_capable | Bool | N | Y | N | N/A |
| lan2_enabled | Bool | N | N | N | N/A |
| lan2_port_setting | struct | N | N | N | N/A |
| lcd_input | Bool | N | N | N | N/A |
| lom_network_config | [struct] | N | N | N | N/A |
| lom_users | [struct] | N | N | N | N/A |
| master_candidate | Bool | N | N | N | = |
| member_service_communication | [struct] | N | N | N | N/A |
| mgmt_port_setting | struct | N | N | N | N/A |
| mmdb_ea_build_time | Timestamp | N | Y | N | N/A |
| mmdb_geoip_build_time | Timestamp | N | Y | N | N/A |
| nat_setting | struct | N | N | N | N/A |
| node_info | [struct] | N | N | N | N/A |
| ntp_setting | struct | N | N | N | N/A |
| ospf_list | [struct] | N | N | N | N/A |
| passive_ha_arp_enabled | Bool | N | N | N | N/A |
| platform | String | N | N | Y | = |
| pre_provisioning | struct | N | N | N | N/A |
| preserve_if_owns_delegation | Bool | N | N | N | = |
| remote_console_access_enable | Bool | N | N | N | N/A |
| router_id | Unsigned int | N | N | N | = |
| service_status | [struct] | N | Y | N | N/A |
| service_type_configuration | String | N | N | Y | = |
| snmp_setting | struct | N | N | N | N/A |
| static_routes | [struct] | N | N | N | N/A |
| support_access_enable | Bool | N | N | N | N/A |
| support_access_info | String | N | Y | N | N/A |
| syslog_proxy_setting | struct | N | N | N | N/A |
| syslog_servers | [struct] | N | N | N | N/A |
| syslog_size | Unsigned int | N | N | N | N/A |
| threshold_traps | [struct] | N | N | N | N/A |
| time_zone | String | N | N | N | N/A |
| traffic_capture_auth_dns_setting | struct | N | N | N | N/A |
| traffic_capture_chr_setting | struct | N | N | N | N/A |
| traffic_capture_qps_setting | struct | N | N | N | N/A |
| traffic_capture_rec_dns_setting | struct | N | N | N | N/A |
| traffic_capture_rec_queries_setting | struct | N | N | N | N/A |
| trap_notifications | [struct] | N | N | N | N/A |
| upgrade_group | String | N | N | N | N/A |
| use_automated_traffic_capture | Bool | N | N | N | N/A |
| use_dns_resolver_setting | Bool | N | N | N | N/A |
| use_dscp | Bool | N | N | N | N/A |
| use_email_setting | Bool | N | N | N | N/A |
| use_enable_lom | Bool | N | N | N | N/A |
| use_enable_member_redirect | Bool | N | N | N | N/A |
| use_external_syslog_backup_servers | Bool | N | N | N | N/A |
| use_lcd_input | Bool | N | N | N | N/A |
| use_remote_console_access_enable | Bool | N | N | N | N/A |
| use_snmp_setting | Bool | N | N | N | N/A |
| use_support_access_enable | Bool | N | N | N | N/A |
| use_syslog_proxy_setting | Bool | N | N | N | N/A |
| use_threshold_traps | Bool | N | N | N | N/A |
| use_time_zone | Bool | N | N | N | N/A |
| use_traffic_capture_auth_dns | Bool | N | N | N | N/A |
| use_traffic_capture_chr | Bool | N | N | N | N/A |
| use_traffic_capture_qps | Bool | N | N | N | N/A |
| use_traffic_capture_rec_dns | Bool | N | N | N | N/A |
| use_traffic_capture_rec_queries | Bool | N | N | N | N/A |
| use_trap_notifications | Bool | N | N | N | N/A |
| use_v4_vrrp | Bool | N | N | N | N/A |
| vip_setting | struct | Y* | N | N | N/A |
| vpn_mtu | Unsigned int | N | N | N | N/A |
* Required in some cases, see detailed field description above.
| Field | Type | Search |
|---|---|---|
| ipv4_address | String | = |
| ipv6_address | String | = |
mastergrid : Master Grid object.