grid : Grid object.

This object represents the Infoblox Grid.

Object Reference

References to grid are object references. The name part of a Grid object reference has the following components:

  • The name of the Infoblox Grid.

    Example: grid/ZG5zLm5ldHdvcmtfdmlldyQxMTk:Infoblox

Restrictions

The object does not support the following operations:

  • Create (insert)
  • Delete
  • Permissions
  • Global search (searches via the search object)
  • Scheduling
  • CSV export

In addition the object does not support the following operations when managed on Cloud Platform members:

  • Modify (update)

Fields

These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.

allow_recursive_deletion

allow_recursive_deletion

The property to allow recursive deletion. Determines the users who can choose to perform recursive deletion on networks or zones from the GUI only.

Type

String.

Valid values are:
  • ALL
  • NOBODY
  • SUPERUSERS

Create

The default value is ALL.

Search

The field is not available for search.

audit_log_format

audit_log_format

Determines the audit log format.

Type

String.

Valid values are:
  • BRIEF
  • DETAILED
  • WAPI_DETAILED

Create

The default value is DETAILED.

Search

The field is not available for search.

audit_to_syslog_enable

audit_to_syslog_enable

If set to True, audit log messages are also copied to the syslog.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

automated_traffic_capture_setting

automated_traffic_capture_setting

The grid 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.

csp_api_config

csp_api_config

The Grid csp api config settings.

Type

A/An Csp Api config struct.

Create

The default value is:

{ 'url': 'https://csp.infoblox.com'}

Search

The field is not available for search.

deny_mgm_snapshots

deny_mgm_snapshots

If set to True, the managed Grid will not send snapshots to the Multi-Grid Master.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

descendants_action

descendants_action

The default actions for extensbile attributes that exist on descendants.

Type

A/An Descendants struct.

Create

The default value is:

  { 'option_delete_ea': 'RETAIN',
'option_with_ea': 'RETAIN',
'option_without_ea': 'NOT_INHERIT'}

Search

The field is not available for search.

dns_resolver_setting

dns_resolver_setting

The DNS resolver setting.

Type

A/An DNS resolver Setting struct.

Create

The default value is:

{ 'resolvers': [], 'search_domains': []}

Search

The field is not available for search.

dscp

dscp

The DSCP value.

Valid values are integers between 0 and 63 inclusive.

Type

Unsigned integer.

Create

The default value is 0.

Search

The field is not available for search.

email_setting

email_setting

The e-mail settings for the Grid.

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.

enable_gui_api_for_lan_vip

enable_gui_api_for_lan_vip

If set to True, GUI and API access are enabled on the LAN/VIP port and MGMT port (if configured).

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

enable_lom

enable_lom

Determines if the LOM functionality is enabled or not.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

enable_member_redirect

enable_member_redirect

Determines redirections is enabled or not for members.

Type

Bool.

Create

The default value is True.

Search

The field is not available for search.

enable_recycle_bin

enable_recycle_bin

Determines if the Recycle Bin is enabled or not.

Type

Bool.

Create

The default value is True.

Search

The field is not available for search.

enable_rir_swip

enable_rir_swip

Determines if the RIR/SWIP support is enabled or not.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

external_syslog_backup_servers

external_syslog_backup_servers

The list of external backup syslog servers.

Type

A/An External syslog backup server struct array.

Create

The default value is:

empty

Search

The field is not available for search.

external_syslog_server_enable

external_syslog_server_enable

If set to True, external syslog servers are enabled.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

http_proxy_server_setting

http_proxy_server_setting

The Grid HTTP proxy server settings.

Type

A/An HTTP Proxy Server Setting struct.

Create

The default value is empty.

Search

The field is not available for search.

informational_banner_setting

informational_banner_setting

The Grid informational level banner settings.

Type

A/An Informational level banner setting struct.

Create

The default value is:

{ 'color': 'GREEN', 'enable': False}

Search

The field is not available for search.

is_grid_visualization_visible

is_grid_visualization_visible

If set to True, graphical visualization of the Grid is enabled.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

lockout_setting

lockout_setting

Security Setting for Account lockout.

Type

A/An Lockout Security Setting struct.

Create

The default value is:

  { 'enable_sequential_failed_login_attempts_lockout': False,
'failed_lockout_duration': 5,
'never_unlock_user': False,
'sequential_attempts': 5}

Search

The field is not available for search.

lom_users

lom_users

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.

mgm_strict_delegate_mode

mgm_strict_delegate_mode

Determines if strict delegate mode for the Grid managed by the Master Grid is enabled or not.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

ms_setting

ms_setting

The settings for all Microsoft servers in the Grid.

Type

A/An Microsoft server settings structure struct.

Create

The default value is:

  { 'ad_user_default_timeout': 7200,
'default_ip_site_link': 'DEFAULTIPSITELINK',
'enable_ad_user_sync': False,
'enable_dhcp_monitoring': True,
'enable_dns_monitoring': True,
'enable_dns_reports_sync': True,
'enable_invalid_mac': True,
'enable_network_users': False,
'ldap_timeout': 10,
'log_destination': 'MSLOG',
'max_connection': 5,
'rpc_timeout': 10}

Search

The field is not available for search.

name

name

The grid name.

Type

String.

Create

The default value is Infoblox.

Search

The field is available for search via

  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

nat_groups

nat_groups

The list of all Network Address Translation (NAT) groups configured on the Grid.

Type

String array.

Create

The default value is All the NAT groups configured on the Grid.

Search

The field is not available for search.

ntp_setting

ntp_setting

The Grid Network Time Protocol (NTP) settings.

Type

A/An The Grid Network Time Protocol (NTP) settings structure struct.

Create

The default value is:

  { 'enable_ntp': False,
'ntp_acl': { 'ac_list': [], 'acl_type': 'NONE', 'service': 'TIME'},
'ntp_keys': [],
'ntp_kod': False,
'ntp_servers': []}

Search

The field is not available for search.

objects_changes_tracking_setting

objects_changes_tracking_setting

Determines the object changes tracking settings.

Type

A/An Objects changes tracking setting struct.

Create

The default value is undefined.

Search

The field is not available for search.

password_setting

password_setting

The Grid password settings.

Type

A/An Password settings struct.

Create

The default value is:

  { 'chars_to_change': 0,
'expire_days': 30,
'expire_enable': False,
'force_reset_enable': False,
'history_enable': False,
'min_password_age': 0,
'num_lower_char': 0,
'num_numeric_char': 0,
'num_passwords_saved': 5,
'num_symbol_char': 0,
'num_upper_char': 0,
'password_min_length': 4,
'reminder_days': 15}

Search

The field is not available for search.

restart_banner_setting

restart_banner_setting

The setting for the Restart Banner.

Type

A/An Restart Banner Setting struct.

Create

The default value is:

{ 'enable_double_confirmation': False, 'enabled': True}

Search

The field is not available for search.

restart_status

restart_status

The restart status for the Grid.

Type

String.

This field supports nested return fields as described here.

Search

The field is not available for search.

Notes

The restart_status cannot be updated.

restart_status cannot be written.

rpz_hit_rate_interval

rpz_hit_rate_interval

The time interval (in seconds) that determines how often the appliance calculates the RPZ hit rate.

Type

Unsigned integer.

Create

The default value is 10.

Search

The field is not available for search.

rpz_hit_rate_max_query

rpz_hit_rate_max_query

The maximum number of incoming queries between the RPZ hit rate checks.

Type

Unsigned integer.

Create

The default value is 100000.

Search

The field is not available for search.

rpz_hit_rate_min_query

rpz_hit_rate_min_query

The minimum number of incoming queries between the RPZ hit rate checks.

Type

Unsigned integer.

Create

The default value is 1000.

Search

The field is not available for search.

scheduled_backup

scheduled_backup

The scheduled backup configuration.

Type

A/An Scheduled backup settings struct.

Create

The default value is:

  { 'backup_frequency': 'WEEKLY',
'backup_type': 'LOCAL',
'discovery_data': True,
'download_keys': False,
'enable': True,
'hour_of_day': 3,
'keep_local_copy': False,
'key_type': 'id_rsa',
'minutes_past_hour': 0,
'nios_data': True,
'operation': 'NONE',
'restore_type': 'FTP',
'splunk_app_data': True,
'status': 'IDLE',
'upload_keys': False,
'use_keys': False,
'weekday': 'SATURDAY'}

Search

The field is not available for search.

secret

secret

The shared secret of the Grid. This is a write-only attribute.

Type

String.

Create

The default value is undefined.

Search

The field is not available for search.

Notes

secret is not readable.

security_banner_setting

security_banner_setting

The Grid security banner settings.

Type

A/An Security banner settings struct.

Create

The default value is:

{ 'color': 'GREEN', 'enable': False, 'level': 'UNCLASSIFIED'}

Search

The field is not available for search.

security_setting

security_setting

The Grid security settings.

Type

A/An Security settings struct.

Create

The default value is:

  { 'admin_access_items': [],
'audit_log_rolling_enable': True,
'disable_concurrent_login': False,
'http_redirect_enable': False,
'lcd_input_enable': True,
'login_banner_enable': True,
'login_banner_text': 'Disconnect NOW if you have not been expressly authorized to use this system.',
'remote_console_access_enable': False,
'security_access_enable': False,
'security_access_remote_console_enable': True,
'session_timeout': 600,
'ssh_perm_enable': True,
'support_access_enable': False}

Search

The field is not available for search.

service_status

service_status

Determines overall service status of the Grid.

Type

String.

Valid values are:
  • FAILED
  • INACTIVE
  • OFFLINE
  • UNKNOWN
  • WARNING
  • WORKING

Search

The field is not available for search.

Notes

The service_status cannot be updated.

service_status cannot be written.

snmp_setting

snmp_setting

The Grid SNMP settings.

Type

A/An SNMP setting struct.

Create

The default value is:

  { 'queries_enable': False,
'snmpv3_queries_enable': False,
'snmpv3_traps_enable': False,
'syscontact': [],
'sysdescr': [],
'syslocation': [],
'sysname': [],
'trap_receivers': [],
'traps_enable': False}

Search

The field is not available for search.

syslog_facility

syslog_facility

If ‘audit_to_syslog_enable’ is set to True, the facility that determines the processes and daemons from which the log messages are generated.

Type

String.

Valid values are:
  • DAEMON
  • LOCAL0
  • LOCAL1
  • LOCAL2
  • LOCAL3
  • LOCAL4
  • LOCAL5
  • LOCAL6
  • LOCAL7

Create

The default value is DAEMON.

Search

The field is not available for search.

syslog_servers

syslog_servers

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.

syslog_size

syslog_size

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.

threshold_traps

threshold_traps

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.

time_zone

time_zone

The time zone of the Grid. 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.

token_usage_delay

token_usage_delay

The delayed usage (in minutes) of a permission token.

Type

Unsigned integer.

Create

The default value is 10.

Search

The field is not available for search.

traffic_capture_auth_dns_setting

traffic_capture_auth_dns_setting

Grid level settings for enabling authoritative DNS latency thresholds for automated traffic capture.

Type

A/An Grid level settings for traffic capture 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.

traffic_capture_chr_setting

traffic_capture_chr_setting

Grid 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.

traffic_capture_qps_setting

traffic_capture_qps_setting

Grid 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.

traffic_capture_rec_dns_setting

traffic_capture_rec_dns_setting

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.

traffic_capture_rec_queries_setting

traffic_capture_rec_queries_setting

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.

trap_notifications

trap_notifications

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.

updates_download_member_config

updates_download_member_config

The list of member configuration structures, which provides information and settings for configuring the member that is responsible for downloading updates.

Type

A/An Updates Download Member Configuration struct array.

Create

The default value is:

[{ 'interface': 'ANY', 'is_online': True, 'member': None}]

Search

The field is not available for search.

vpn_port

vpn_port

The VPN port.

Type

Unsigned integer.

Create

The default value is 1194.

Search

The field is not available for search.

Function Calls

control_ip_address

Use this function to control selected IP addresses.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

addresses ( String array. ). This parameter is mandatory. The IP addresses list.

exclude ( Bool. ) This flag controls whether selected IP addresses should be excluded.

network_view ( String. ) The name of the network view in which this IP addresses resides.

Output fields

None

empty_recycle_bin

Empty the recycle bin.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

None

Output fields

None

generate_tsig_key

This function is used to generate TSIG key.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

tsig_key_algorithm ( String. Valid values are: “HMAC-MD5”, “HMAC-SHA256” ) The TSIG key algorithm. The default value is “HMAC-MD5”.

tsig_key_size ( String. Valid values are: “128”, “256”, “512” ) The TSIG key size. The default value is “128”.

Output fields

tsig_key ( String. ) The TSIG key generated.

get_all_template_vendor_id

Use this function to get all unique vendor identifiers for the outbound templates.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

outbound_type ( String. Valid values are: “REST”, “DXL”, “SYSLOG” ) The outbound type of the templates. The default value is “REST”.

Output fields

vendor_identifiers ( String array. ) The vendor identifiers.

get_grid_revert_status

This function is used to retrieve the revert status of the Infoblox Grid.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

None

Output fields

revert_allowed ( Bool. ) Determines whether a revert is allowed.

revert_version ( String. ) The revert version.

get_rpz_threat_details

Requests RPZ threat details through the ThreatStop RESTful API.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

rpz_rule_name ( String. ). This parameter is mandatory. The RPZ rule name.

Output fields

active ( Bool. ) The rule status whether it is active or not.

danger_level ( Unsigned integer. ) The value of a danger level.

description ( String. ) The description.

first_identified ( Timestamp. ) The timestamp when the threat was first identified.

known ( Bool. ) The rule status whether it is known or not.

last_seen ( Timestamp. ) The timestamp when the threat was first identified.

name ( String. ) The threat name.

public_description ( String. ) The public description about the threat.

short_description ( String. ) The short description about the threat.

get_template_schema_versions

Get all schema versions for the RESTful API templates.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

schema_type ( String. Valid values are: “REST_EVENT”, “REST_ENDPOINT” ). This parameter is mandatory. The type of RESTful API template schema to be exported.

Output fields

versions ( String array. ) The RESTful API template versions sorted in ascending order.

join

Join an Infoblox appliance to an existing grid.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

grid_name ( String. ). This parameter is mandatory. The name of the grid.

master ( String. ). This parameter is mandatory. The virtual IP address of the grid master.

shared_secret ( String. ). This parameter is mandatory. The shared secret string of the grid.

Output fields

None

join_mgm

This function allows a Grid to join the Multi-Grid Master.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

file_token ( String. ). This parameter is mandatory. The token returned by the uploadinit function call in object fileop.

grid_name ( String. ) The name of the managed Grid cluster.

join_token ( String. ). This parameter is mandatory. Join token associated with the file.

sgm_address ( String. ). This parameter is mandatory. FQDN or IP of the SGM.

sgm_port ( Unsigned integer. ) Port of the OpenVPN service.

use_mgmt_port ( Bool. ) Whether to use management port or not.

Output fields

None

leave_mgm

This function allows a Grid to leave the Multi-Grid Master.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

None

Output fields

None

member_upgrade

Use this function to upgrade a single member that was reverted during the staged upgrade process or to revert a single member if it does not behave properly after an upgrade.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

action ( String. Valid values are: “UPGRADE”, “REVERT” ) The action to execute. The default value is “UPGRADE”.

member ( String. ). This parameter is mandatory. The FQDN of the member to be upgraded.

Output fields

None

node_registration

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

hardware_id ( String. ). This parameter is mandatory. Hardware ID.

hardware_model ( String. ). This parameter is mandatory. Hardware Model

hardware_type ( String. ). This parameter is mandatory. Hardware Type

licenses ( String array. ). This parameter is mandatory. List Of Licenses

token ( String. ). This parameter is mandatory. Identifier of the Physical Node that is used to Join to the Grid.

Output fields

gm_ip_join ( String. ) Grid Master IP address that must be used for joining

grid_name ( String. ) Grid Name

grid_secret ( String. ) Grid Secret

hardware_id ( String. ) Hardware ID.

licenses ( String array. ) List Of Licenses

use_mgmt_port_to_join ( Bool. ) Set to True if member must use its MGMT port while joining the Grid.The default value is “False”.

publish_changes

Publish configuration changes to all Grid members or to a particular one.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

member ( String. ) The member for which the changes are published.

member_order ( String. Valid values are: “SIMULTANEOUSLY”, “SEQUENTIALLY” ) Determines whether changes are published on all members without delay (‘SIMULTANEOUSLY’) or with delay (‘SEQUENTIALLY’). The default value is “SIMULTANEOUSLY”.

sequential_delay ( Unsigned integer. ) The delay between publishing configuration changes on members in seconds. The default value is “0”.

services ( String. Valid values are: “ALL”, “ATP” ) The service name to which configuration changes should be sent. The default value is “ALL”.

Output fields

None

query_fqdn_on_member

Invokes dig command on a member for a specific FQDN.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

fqdn ( String. ). This parameter is mandatory. The FQDN to query.

member ( String. ) The host name of the member. Default is the host name of the Grid Master. The default value is “None”.

name_server ( String. ) The Name Server to query, either a name or IPv4/6 address. The default value is “”.

record_type ( String. Valid values are: “ANY”, “A”, “AAAA”, “CNAME”, “DNAME”, “MX”, “NAPTR”, “NS”, “PTR”, “SRV”, “TXT”, “AXFR” ) The resource record type. The default value is “ANY”.

recursive_query ( Bool. ) Determines if this query is recursive or not. The default value is “True”.

Output fields

dig_started ( Timestamp. ) The timestamp when the dig started.

result ( String. Valid values are: “NOERROR”, “FORMERR”, “SERVFAIL”, “NXDOMAIN”, “NOTIMP”, “REFUSED”, “INTERNAL_ERROR” ) The dig request return code.

result_text ( String. ) The dig result text, multi-lined text.

source_address ( String. ) The source IP address of the query.

requestrestartservicestatus

Use this function to request the Grid 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

restartservices

This function controls the Grid services.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

groups ( String array. ) The list of the Service Restart Groups to restart.

member_order ( String. Valid values are: “SEQUENTIALLY”, “SIMULTANEOUSLY” ) The order in which Grid members are being restarted. If this field is set to ‘SEQUENTIALLY’, sequential_delay must also be provided. This field is deprecated. Use field ‘mode’ instead.

members ( String array. ) The list of the Grid Members to restart.

mode ( String. Valid values are: “GROUPED”, “SEQUENTIAL”, “SIMULTANEOUS” ) The restart method in case of grid restart. The default value is “None”.

restart_option ( String. Valid values are: “FORCE_RESTART”, “RESTART_IF_NEEDED” ) This field controls whether services are restarted unconditionally or when needed. The default value is “RESTART_IF_NEEDED”.

sequential_delay ( Unsigned integer. ) The delayed time, in seconds, between Grid member restarts. This field is deprecated. Use ‘restart_setting’ of the grid:dns or grid:dhcpproperties instead.

service_option ( String. Valid values are: “ALL”, “DHCP”, “DNS” ) This field indicates the services that the appliance restarts. This field is deprecated. Use field ‘services’ instead.

services ( String. Valid values are: “ALL”, “DNS”, “DHCP”, “DHCPV4”, “DHCPV6” ) The list of services the restart applicable to. The default value is “ALL”.

user_name ( String. ) Name of the user requesting the restart. The default value is “None”.

Output fields

None

skip_member_upgrade

This function allows the specified member to skip the upgrade process.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

member ( String. ). This parameter is mandatory. The FQDN of the member that will skip the upgrade process.

Output fields

None

start_discovery

Use this function to start the discovery on selected objects.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

objects ( String array. ). This parameter is mandatory. The list of refs to the relevant IPAM objects (Network, Network Container, IP Address, Fixed Address, Host Record, Range).

Output fields

None

test_csp_api_connectivity

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

password ( String. ) The password for the CspApiConfig.

username ( String. ) The user name for the CspApiConfig.

Output fields

error_message ( String. ) The error message when the test connectivity failed.

overall_status ( String. Valid values are: “FAILED”, “SUCCESS” ) The overall status for the connectivity test.

test_syslog_backup_server_connection

This function can be used to test the connection to the external backup syslog server.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

member ( String. ) The member for testing the connection.

syslog_backup_server ( A/An External syslog backup server struct. ). This parameter is mandatory. The syslog backup server for testing the connection.

Output fields

result ( String. Valid values are: “CANNOT_CONNECT”, “TEST_OK” ) The result of connection testing to the syslog server.

test_syslog_connection

Use this function to test a connection to the syslog server.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

syslog_server ( A/An Syslog server struct. ). This parameter is mandatory. The syslog server for testing the connection.

Output fields

result ( String. Valid values are: “CANNOT_CONNECT”, “TEST_OK”, “CERTIFICATE_IS_NOT_VALID” ) The result of connection testing to the syslog server.

upgrade

This function provides control over the Grid upgrade. The upgrade process normally is as follows: 1) Upload the upgrade file using the set_upgrade_file function call in object fileop 2) call this function with ‘action’ set to ‘UPLOAD’, this will prepare the uploaded file for deployment 3) call this function with ‘action’ set to ‘DISTRIBUTION_START’ which will start the Grid distribution process. 4) call this function with ‘action’ set to ‘UPGRADE’ which will restart the appliances with the new NIOS version.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

action ( String. Valid values are: “UPGRADE_PAUSE”, “UPGRADE_RESUME”, “DISTRIBUTION_PAUSE”, “DISTRIBUTION_RESUME”, “DISTRIBUTION_START”, “DISTRIBUTION_STOP”, “DOWNGRADE”, “REVERT”, “UPGRADE”, “UPGRADE_TEST_START”, “UPGRADE_TEST_STOP”, “UPLOAD” ). This parameter is mandatory. Upgrade action.

Output fields

None

upgrade_group_now

This function is used to run the immediate upgrade of the specified group.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

upgrade_group ( String. ). This parameter is mandatory. The upgrade group name to start the upgrade.

Output fields

None

upload_keytab

This function is used to upload the keytab file to the server that is not assigning the keys.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

token ( String. ). This parameter is mandatory. The token returned by the uploadinit function call.

Output fields

keys ( A/An kerberoskey object array. ) The list of GSS-TSIG keys uploaded to the appliance.

Fields List

Field Type Req R/O Base Search
allow_recursive_deletion String N N N N/A
audit_log_format String N N N N/A
audit_to_syslog_enable Bool N N N N/A
automated_traffic_capture_setting struct N N N N/A
consent_banner_setting struct N N N N/A
csp_api_config struct N N N N/A
deny_mgm_snapshots Bool N N N N/A
descendants_action 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_gui_api_for_lan_vip Bool N N N N/A
enable_lom Bool N N N N/A
enable_member_redirect Bool N N N N/A
enable_recycle_bin Bool N N N N/A
enable_rir_swip Bool N N N N/A
external_syslog_backup_servers [struct] N N N N/A
external_syslog_server_enable Bool N N N N/A
http_proxy_server_setting struct N N N N/A
informational_banner_setting struct N N N N/A
is_grid_visualization_visible Bool N N N N/A
lockout_setting struct N N N N/A
lom_users [struct] N N N N/A
mgm_strict_delegate_mode Bool N N N N/A
ms_setting struct N N N N/A
name String N N N = ~
nat_groups [String] N N N N/A
ntp_setting struct N N N N/A
objects_changes_tracking_setting struct N N N N/A
password_setting struct N N N N/A
restart_banner_setting struct N N N N/A
restart_status String N Y N N/A
rpz_hit_rate_interval Unsigned int N N N N/A
rpz_hit_rate_max_query Unsigned int N N N N/A
rpz_hit_rate_min_query Unsigned int N N N N/A
scheduled_backup struct N N N N/A
secret String N N N N/A
security_banner_setting struct N N N N/A
security_setting struct N N N N/A
service_status String N Y N N/A
snmp_setting struct N N N N/A
syslog_facility String 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
token_usage_delay Unsigned int 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
updates_download_member_config [struct] N N N N/A
vpn_port Unsigned int N N N N/A

Table Of Contents

Previous topic

ftpuser : FTP user object.

Next topic

grid:cloudapi : Grid Cloud API object.