ad_auth_server : Active Directory Authentication Server.

Represents an AD authentication server (i.e., domain controller) that is used to authenticate administrators.

auth_port

auth_port

The authentication port.

Type

Unsigned integer.

Create

The default value is undefined.

comment

comment

The descriptive comment for the AD authentication server.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

disabled

disabled

Determines if the AD authorization server is disabled.

Type

Bool.

Create

The default value is False.

encryption

encryption

The type of encryption to use.

Type

String.

Valid values are:
  • NONE
  • SSL

Create

The default value is NONE.

fqdn_or_ip

fqdn_or_ip

The FQDN (Fully Qualified Domain Name) or IP address of the server.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

mgmt_port

mgmt_port

Determine if the MGMT port is enabled for the AD authentication server.

Type

Bool.

Create

The default value is False.

Notes

mgmt_port is associated with the field use_mgmt_port (see use flag).

use_mgmt_port

use_mgmt_port

Use flag for: mgmt_port

Type

Bool.

Create

The default value is False.

addressac : Address ac.

This struct represents an access control rule for an address.

address

address

The address this rule applies to or “Any”.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

permission

permission

The permission to use for this address.

Type

String.

Valid values are:
  • ALLOW
  • DENY

Create

The default value is ALLOW.

admingroup:lockoutsetting : lockout_setting

This is a new struct to specify security policy settings.

enable_sequential_failed_login_attempts_lockout

enable_sequential_failed_login_attempts_lockout

Enable/disable sequential failed login attempts lockout for local users

Type

Bool.

Create

The default value is False.

failed_lockout_duration

failed_lockout_duration

Time period the account remains locked after sequential failed login attempt lockout.

Type

Unsigned integer.

Create

The default value is 60.

never_unlock_user

never_unlock_user

Never unlock option is also provided and if set then user account is locked forever and only super user can unlock this account

Type

Bool.

Create

The default value is False.

sequential_attempts

sequential_attempts

The number of failed login attempts

Type

Unsigned integer.

Create

The default value is 5.

admingroup:passwordsetting : Password settings.

This structure contains password settings related to each admin groups.

expire_days

expire_days

The days that password must expire

Type

Unsigned integer.

Create

The default value is 30.

expire_enable

expire_enable

Whether password expiry enabled or not.

Type

Bool.

Create

The default value is False.

reminder_days

reminder_days

Days to show up reminder prior to expiration

Type

Unsigned integer.

Create

The default value is 15.

admingroup:samlsetting : SAML settings.

This structure contains SAML settings related to each admin group.

auto_create_user

auto_create_user

Whether or not auto create user.

Type

Bool.

Create

The default value is False.

persist_auto_created_user

persist_auto_created_user

Whether or not persist auto created user after logout.

Type

Bool.

Create

The default value is False.

adsites : Microsoft Server AD Sites.

This structure contains information about the Microsoft Server Active Directory Sites.

last_sync_detail

last_sync_detail

The detailed status of the last synchronization attempt.

Type

String.

Notes

The last_sync_detail cannot be updated.

last_sync_detail cannot be written.

last_sync_status

last_sync_status

Status of the last synchronization attempt

Type

String.

Valid values are:
  • MS_SYNC_ERROR
  • MS_SYNC_OK
  • MS_SYNC_WARNING

Notes

The last_sync_status cannot be updated.

last_sync_status cannot be written.

last_sync_ts

last_sync_ts

Timestamp of the last synchronization attempt

Type

Timestamp.

Notes

The last_sync_ts cannot be updated.

last_sync_ts cannot be written.

ldap_auth_port

ldap_auth_port

TCP port for LDAP connections for this

Type

Unsigned integer.

Create

The default value is undefined.

ldap_encryption

ldap_encryption

Encryption for LDAP connections for this MS Server

Type

String.

Valid values are:
  • NONE
  • SSL

Create

The default value is undefined.

ldap_timeout

ldap_timeout

Timeout in seconds for LDAP connections for this MS Server

Type

Unsigned integer.

Create

The default value is undefined.

Notes

ldap_timeout is associated with the field use_ldap_timeout (see use flag).

login_name

login_name

Microsoft Server login name, with optional

Type

String.

Create

The default value is undefined.

Notes

login_name is associated with the field use_login (see use flag).

login_password

login_password

Microsoft Server login password.

Type

String.

Create

The default value is undefined.

Notes

login_password is associated with the field use_login (see use flag).

login_password is not readable.

managed

managed

Controls whether the Sites of this MS Server are to be synchronized by the assigned managing member or not

Type

Bool.

Create

The default value is False.

read_only

read_only

Enable/disable read-only synchronization of Sites for this Active Directory domain

Type

Bool.

Create

The default value is False.

supports_ipv6

supports_ipv6

Flag indicating if the server supports IPv6

Type

Bool.

Notes

The supports_ipv6 cannot be updated.

supports_ipv6 cannot be written.

synchronization_min_delay

synchronization_min_delay

Minimum number of minutes between two synchronizations

Type

Unsigned integer.

Create

The default value is undefined.

Notes

synchronization_min_delay is associated with the field use_synchronization_min_delay (see use flag).

use_ldap_timeout

use_ldap_timeout

Flag to override cluster LDAP timeoutMS Server

Type

Bool.

Create

The default value is False.

use_login

use_login

Flag to override login name and password from the MS Server

Type

Bool.

Create

The default value is False.

use_synchronization_min_delay

use_synchronization_min_delay

Flag to override synchronization interval from the MS Server

Type

Bool.

Create

The default value is False.

awsrte53recordinfo : ‘Aws Rte53 Record Info.

Additional information for Route53 resource record.

alias_target_dns_name

alias_target_dns_name

DNS name of the alias target.

Type

String.

Notes

The alias_target_dns_name cannot be updated.

alias_target_dns_name cannot be written.

alias_target_evaluate_target_health

alias_target_evaluate_target_health

Indicates if Amazon Route 53 evaluates the health of the alias target.

Type

Bool.

Notes

The alias_target_evaluate_target_health cannot be updated.

alias_target_evaluate_target_health cannot be written.

alias_target_hosted_zone_id

alias_target_hosted_zone_id

Hosted zone ID of the alias target.

Type

String.

Notes

The alias_target_hosted_zone_id cannot be updated.

alias_target_hosted_zone_id cannot be written.

failover

failover

Indicates whether this is the primary or secondary resource record for Amazon Route 53 failover routing.

Type

String.

Valid values are:
  • PRIMARY
  • SECONDARY

Notes

The failover cannot be updated.

failover cannot be written.

geolocation_continent_code

geolocation_continent_code

Continent code for Amazon Route 53 geolocation routing.

Type

String.

Notes

The geolocation_continent_code cannot be updated.

geolocation_continent_code cannot be written.

geolocation_country_code

geolocation_country_code

Country code for Amazon Route 53 geolocation routing.

Type

String.

Notes

The geolocation_country_code cannot be updated.

geolocation_country_code cannot be written.

geolocation_subdivision_code

geolocation_subdivision_code

Subdivision code for Amazon Route 53 geolocation routing.

Type

String.

Notes

The geolocation_subdivision_code cannot be updated.

geolocation_subdivision_code cannot be written.

health_check_id

health_check_id

ID of the health check that Amazon Route 53 performs for this resource record.

Type

String.

Notes

The health_check_id cannot be updated.

health_check_id cannot be written.

region

region

Amazon EC2 region where this resource record resides for latency routing.

Type

String.

Notes

The region cannot be updated.

region cannot be written.

set_identifier

set_identifier

An identifier that differentiates records with the same DNS name and type for weighted, latency, geolocation, and failover routing.

Type

String.

Notes

The set_identifier cannot be updated.

set_identifier cannot be written.

type

type

Type of Amazon Route 53 resource record.

Type

String.

Valid values are:
  • A
  • AAAA
  • CNAME
  • MX
  • NS
  • PTR
  • SOA
  • SPF
  • SRV
  • TXT

Notes

The type cannot be updated.

type cannot be written.

weight

weight

Value that determines the portion of traffic for this record in weighted routing. The range is from 0 to 255.

Type

Unsigned integer.

Notes

The weight cannot be updated.

weight cannot be written.

awsrte53task : AWS Route53 task.

This struct represents a single AWS Route53 sync task with various zone filters to retrieve DNS zone data from AWS Route53 service using specified AWS user credentials.

aws_user

aws_user

Reference to associated AWS user whose credentials are to be used for this task.

Type

String.

This field supports nested return fields as described here.

Create

The network view required if network_view_mapping_policy is set to DIRECT

credentials_type

credentials_type

Credentials type used for connecting to the cloud management platform.

Type

String.

Valid values are:
  • DIRECT
  • INDIRECT

Create

The default value is DIRECT.

disabled

disabled

Indicates if the task is enabled or disabled.

Type

Bool.

Create

The default value is False.

filter

filter

Filter for this task.

Type

String.

Create

The field is required on creation.

last_run

last_run

The timestamp when the task was started last.

Type

Timestamp.

Notes

The last_run cannot be updated.

last_run cannot be written.

name

name

The name of this task.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

schedule_interval

schedule_interval

Periodic interval for this task.

Type

Unsigned integer.

Create

The default value is 60.

schedule_units

schedule_units

Units for the schedule interval.

Type

String.

Valid values are:
  • DAYS
  • HOURS
  • MINS

Create

The default value is MINS.

state

state

Indicate the sync status of this task.

Type

String.

Valid values are:
  • CANCELED
  • COMPLETED
  • FAILED
  • IDLE
  • PARTIALLY_COMPLETED
  • READY
  • RUNNING

Notes

The state cannot be updated.

state cannot be written.

state_msg

state_msg

State message for the task.

Type

String.

Notes

The state_msg cannot be updated.

state_msg cannot be written.

status_timestamp

status_timestamp

The timestamp when the last state was logged.

Type

Timestamp.

Notes

The status_timestamp cannot be updated.

status_timestamp cannot be written.

sync_private_zones

sync_private_zones

Indicates whether private zones are synchronized.

Type

Bool.

Create

The default value is True.

sync_public_zones

sync_public_zones

Indicates whether public zones are synchronized.

Type

Bool.

Create

The default value is True.

zone_count

zone_count

The number of zones synchronized by this task.

Type

Unsigned integer.

Notes

The zone_count cannot be updated.

zone_count cannot be written.

awsrte53zoneinfo : ‘Aws Rte53 Zone Info.

Additional information for Route53 zone.

associated_vpcs

associated_vpcs

List of AWS VPC strings that are associated with this zone.

Type

String array.

Notes

The associated_vpcs cannot be updated.

associated_vpcs cannot be written.

caller_reference

caller_reference

User specified caller reference when zone was created.

Type

String.

Notes

The caller_reference cannot be updated.

caller_reference cannot be written.

delegation_set_id

delegation_set_id

ID of delegation set associated with this zone.

Type

String.

Notes

The delegation_set_id cannot be updated.

delegation_set_id cannot be written.

hosted_zone_id

hosted_zone_id

AWS route 53 assigned ID for this zone.

Type

String.

Notes

The hosted_zone_id cannot be updated.

hosted_zone_id cannot be written.

name_servers

name_servers

List of AWS name servers that are authoritative for this domain name.

Type

String array.

Notes

The name_servers cannot be updated.

name_servers cannot be written.

record_set_count

record_set_count

Number of resource record sets in the hosted zone.

Type

Unsigned integer.

Notes

The record_set_count cannot be updated.

record_set_count cannot be written.

type

type

Indicates whether private or public zone.

Type

String.

Valid values are:
  • PRIVATE
  • PUBLIC

Notes

The type cannot be updated.

type cannot be written.

bgpas : BGP (Border Gateway Protocol) Autonomous System (AS)

Represents a BGP Autonomous System configured at the grid member level.

as

as

The number of this autonomous system.

Type

Unsigned integer.

Create

The field is required on creation.

holddown

holddown

The AS holddown timer (in seconds). The valid value is from 3 to 65535.

Type

Unsigned integer.

Create

The default value is 16.

keepalive

keepalive

The AS keepalive timer (in seconds). The valid value is from 1 to 21845.

Type

Unsigned integer.

Create

The default value is 4.

neighbors

neighbors

The BGP neighbors for this AS.

Type

A/An BGP (Border Gateway Protocol) Neighbor struct array.

Create

The default value is:

empty

bgpneighbor : BGP (Border Gateway Protocol) Neighbor.

Represents the BGP neighbor that is configured in an autonomous system (AS). BGP neighbors are configured at the Grid member level.

authentication_mode

authentication_mode

The BGP authentication mode.

Type

String.

Valid values are:
  • MD5
  • NONE

Create

The field is required on creation.

bfd_template

bfd_template

The BFD template name.

Type

String.

Create

The default value is empty.

bgp_neighbor_pass

bgp_neighbor_pass

The password for a BGP neighbor. This is required only if authentication_mode is set to “MD5”. When the password is entered, the value is preserved even if authentication_mode is changed to “NONE”. This is a write-only attribute.

Type

String.

Create

A password is required when BGP authentication is enabled

Notes

bgp_neighbor_pass is not readable.

comment

comment

User comments for this BGP neighbor.

Type

String.

Create

The default value is empty.

enable_bfd

enable_bfd

Determines if BFD is enabled or not.

Type

Bool.

Create

The default value is False.

interface

interface

The interface that sends BGP advertisement information.

Type

String.

Valid values are:
  • LAN_HA

Create

The field is required on creation.

multihop

multihop

Determines if the multi-hop support is enabled or not.

Type

Bool.

Create

The default value is False.

multihop_ttl

multihop_ttl

The Time To Live (TTL) value for multi-hop. Valid values are between 1 and 255.

Type

Unsigned integer.

Create

The default value is 255.

neighbor_ip

neighbor_ip

The IP address of the BGP neighbor.

Type

String.

Create

The field is required on creation.

remote_as

remote_as

The remote AS number of the BGP neighbor.

Type

Unsigned integer.

Create

The field is required on creation.

capacityreport:objectcount : Type count struct.

The structure contains pair of the object type name and number of it’s instances created for particular Grid member. This structure is retrieved as part of capacity report object.

count

count

Number of object type instances created.

Type

Unsigned integer.

Notes

The count cannot be updated.

count cannot be written.

type_name

type_name

Object type name.

Type

String.

Notes

The type_name cannot be updated.

type_name cannot be written.

captiveportal:file : Captive portal file.

This structure is used to represent files uploaded to the captive portal.

name

name

The name of the uploaded file.

Type

String.

Create

The default value is undefined.

type

type

The type of the uploaded file.

Type

String.

Valid values are:
  • AUP
  • IMG_FOOTER
  • IMG_HEADER
  • IMG_LOGO

Create

The default value is undefined.

changedobject : Changed object information.

This struct contains information about changes to be made to the specified object.

action

action

This is a description of the action that is applied to this object.

Type

String.

Valid values are:
  • Add
  • Configure Grid
  • Convert IPv4 Lease
  • Convert IPv6 Lease
  • Delete
  • Lock/Unlock Zone
  • Modify
  • Network Discovery
  • Reset Grid
  • Restart Services
  • Restart Services
  • Upgrade Grid

Notes

The action cannot be updated.

action cannot be written.

name

name

The object name.

Type

String.

Notes

The name cannot be updated.

name cannot be written.

object_type

object_type

The object type. This is undefined if the object is not yet supported.

Type

String.

Notes

The object_type cannot be updated.

object_type cannot be written.

properties

properties

A list of properties that are being changed.

Type

String array.

Notes

The properties cannot be updated.

properties cannot be written.

type

type

A value of the object type, this may contain objects that are not yet available in WAPI.

Type

String.

Notes

The type cannot be updated.

type cannot be written.

ciscoise:eaassociation : Cisco ISE extensible attribute association struct.

The structure contains the Cisco ISE attributes allowed for subscription and the NIOS extensible attribute definition name the Cisco ISE attribute is mapped on.

mapped_ea

mapped_ea

The name of the extensible attribute definition object the Cisco ISE attribute that is enabled for subscription is mapped on.

Type

String.

Create

The field is required on creation.

name

name

The Cisco ISE attribute name that is enabled for publishsing from a Cisco ISE endpoint.

Type

String.

Valid values are:
  • ACCOUNT_SESSION_ID
  • AUDIT_SESSION_ID
  • EPS_STATUS
  • IP_ADDRESS
  • MAC
  • NAS_IP_ADDRESS
  • NAS_PORT_ID
  • POSTURE_STATUS
  • POSTURE_TIMESTAMP

Create

The field is required on creation.

ciscoise:publishsetting : Cisco ISE publish settings struct.

This strcture contains list of NIOS extensible attributes that are allowed for publishing to Cisco ISE endpoint.

enabled_attributes

enabled_attributes

The list of NIOS extensible attributes enalbed for publishsing to Cisco ISE endpoint.

Type

Enum values array.

Valid values are:
  • CLIENT_ID
  • FINGERPRINT
  • HOSTNAME
  • INFOBLOX_MEMBER
  • IPADDRESS
  • LEASE_END_TIME
  • LEASE_START_TIME
  • LEASE_STATE
  • MAC_OR_DUID
  • NETBIOS_NAME

Create

The field is required on creation.

ciscoise:subscribesetting : Cisco ISE subscribe settings struct.

This structure contains settings for subscription of the Cisco ISE attributes and mapping of them to a NIOS extensible attributes.

enabled_attributes

enabled_attributes

The list of Cisco ISE attributes allowed for subscription.

Type

Enum values array.

Valid values are:
  • DOMAINNAME
  • ENDPOINT_PROFILE
  • SECURITY_GROUP
  • SESSION_STATE
  • SSID
  • USERNAME
  • VLAN

Create

The field is required on creation.

mapped_ea_attributes

mapped_ea_attributes

The list of NIOS extensible attributes to Cisco ISE attributes mappings.

Type

A/An Cisco ISE extensible attribute association struct struct array.

Create

The default value is:

empty

clientsubnetdomain : The client subnet domain structure.

The client subnet domain structure represents the zone domain name that is allowed or forbidden for the EDNS client subnet (ECS) recursion.

domain

domain

The FQDN that represents the ECS zone domain name.

Type

String.

Create

The field is required on creation.

permission

permission

The ECS domain name permission.

Type

String.

Valid values are:
  • ALLOW
  • DENY

Create

The default value is ALLOW.

dhcpddns : Ddns Zone Primary.

The object is used to configure Multi-Grid Master preferences for updates from DHCP to Multi-Grid Master zones.

dns_ext_primary

dns_ext_primary

The IP address of the External server. Valid when zone_match is “EXTERNAL” or “ANY_EXTERNAL”.

Type

String.

Create

Field dns_ext_primary is required if zone_match is “EXTERNAL” or “ANY_EXTERNAL”.

dns_ext_zone

dns_ext_zone

The name of external zone in FQDN format.

Type

String.

Create

Field dns_ext_zone is required if zone_match is “EXTERNAL”.

dns_grid_primary

dns_grid_primary

The name of a Grid member.

Type

String.

Create

Field dns_grid_primary is required if zone_match is “GRID” or “ANY_GRID”.

dns_grid_zone

dns_grid_zone

The ref of a DNS zone.

Type

String.

Create

Field dns_grid_zone is required if zone_match is “GRID”.

zone_match

zone_match

Indicate matching type.

Type

String.

Valid values are:
  • ANY_EXTERNAL
  • ANY_GRID
  • EXTERNAL
  • GRID

Create

The field is required on creation.

dhcpmember : Grid member serving DHCP.

This struct contains the name and address of the Grid Member serving DHCP.

ipv4addr

ipv4addr

The IPv4 Address of the Grid Member.

Type

String.

Create

The default value is undefined.

ipv6addr

ipv6addr

The IPv6 Address of the Grid Member.

Type

String.

Create

The default value is undefined.

name

name

The Grid member name

Type

String.

Create

The default value is undefined.

dhcpoption : DHCP option.

An option sets the value of a DHCP option that has been defined in an option space. DHCP options describe network configuration settings and various services available on the network. These options occur as variable-length fields at the end of DHCP messages.

When defining a DHCP option, at least a ‘name’ or a ‘num’ is required.

name

name

Name of the DHCP option.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is undefined.

num

num

The code of the DHCP option.

Type

Unsigned integer.

Create

The default value is undefined.

use_option

use_option

Only applies to special options that are displayed separately from other options and have a use flag.

These options are:

  • routers
  • router-templates
  • domain-name-servers
  • domain-name
  • broadcast-address
  • broadcast-address-offset
  • dhcp-lease-time
  • dhcp6.name-servers

Type

Bool.

Create

The default value is True.

value

value

Value of the DHCP option

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

vendor_class

vendor_class

The name of the space this DHCP option is associated to.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is DHCP.

dhcpserver : Microsoft Server DHCP Properties struct for MsServer Object

This structure contains MS server DHCP properties

enable_invalid_mac

enable_invalid_mac

Enable Invalid Mac Address

Type

Bool.

Create

The default value is undefined.

Notes

enable_invalid_mac is associated with the field use_enable_invalid_mac (see use flag).

enable_monitoring

enable_monitoring

Flag indicating if the DNS service is monitored and controlled

Type

Bool.

Create

The default value is undefined.

Notes

enable_monitoring is associated with the field use_enable_monitoring (see use flag).

login_name

login_name

Microsoft Server login name

Type

String.

Create

The default value is empty.

Notes

login_name is associated with the field use_login (see use flag).

login_password

login_password

Microsoft Server login password

Type

String.

Create

The default value is undefined.

Notes

login_password is associated with the field use_login (see use flag).

login_password is not readable.

managed

managed

flag indicating if the DNS service is managed

Type

Bool.

Create

The default value is undefined.

next_sync_control

next_sync_control

Defines what control to apply on the DNS server

Type

String.

Valid values are:
  • NONE
  • START
  • STOP

Create

The default value is undefined.

status

status

Status of the Microsoft DNS Service

Type

String.

Valid values are:
  • OFFLINE
  • UNKNOWN

Notes

The status cannot be updated.

status cannot be written.

status_last_updated

status_last_updated

Timestamp of the last update

Type

Timestamp.

Notes

The status_last_updated cannot be updated.

status_last_updated cannot be written.

supports_failover

supports_failover

Flag indicating if the DHCP supports Failover

Type

Bool.

Notes

The supports_failover cannot be updated.

supports_failover cannot be written.

synchronization_min_delay

synchronization_min_delay

Minimum number of minutes between two synchronizations

Type

Unsigned integer.

Create

The default value is 18.

Notes

synchronization_min_delay is associated with the field use_synchronization_min_delay (see use flag).

use_enable_invalid_mac

use_enable_invalid_mac

Override setting for Enable Invalid Mac Address

Type

Bool.

Create

The default value is False.

use_enable_monitoring

use_enable_monitoring

Override enable monitoring inherited from grid level

Type

Bool.

Create

The default value is False.

use_login

use_login

Flag to override login name and password from the MS Server

Type

Bool.

Create

The default value is undefined.

use_synchronization_min_delay

use_synchronization_min_delay

Flag to override synchronization interval from the MS Server

Type

Bool.

Create

The default value is False.

discovery:advancedpollsetting : The advanced polling settings structure.

The structure provides information about the advanced polling settings.

arp_aggregate_limit

arp_aggregate_limit

The ARP aggregate limit.

Type

Unsigned integer.

Create

The default value is undefined.

arp_cache_refresh_interval

arp_cache_refresh_interval

The refresh interval in seconds for ARP cache.

Type

Unsigned integer.

Create

The default value is undefined.

dhcp_router_as_seed

dhcp_router_as_seed

Determines if DHCP router is used as seed for discovery.

Type

Bool.

Create

The default value is undefined.

disable_discovery_outside_ipam

disable_discovery_outside_ipam

Determines if discovery of networks that are not in IPAM is disabled.

Type

Bool.

Create

The default value is undefined.

enable_purge_expired_endhost_data

enable_purge_expired_endhost_data

Determines if purge of expired end host data is enabled.

Type

Bool.

Create

The default value is undefined.

ping_retries

ping_retries

The number of ping retries.

Type

Unsigned integer.

Create

The default value is undefined.

ping_sweep_interval

ping_sweep_interval

The hourly wait interval between ping sweeps for individual discovery ranges.

Type

Unsigned integer.

Create

The default value is undefined.

ping_timeout

ping_timeout

The ping timeout in seconds.

Type

Unsigned integer.

Create

The default value is undefined.

polling_authenticate_snmpv2c_or_later_only

polling_authenticate_snmpv2c_or_later_only

Determines if polling and authenticating using SNMPv2c or later is enabled.

Type

Bool.

Create

The default value is undefined.

purge_expired_device_data

purge_expired_device_data

The number of days a device remains in database after it is no longer found in network.

Type

Unsigned integer.

Create

The default value is undefined.

purge_expired_endhost_data

purge_expired_endhost_data

The number of days a end host remains in database after it is no longer found in network.

Type

Unsigned integer.

Create

The default value is undefined.

route_limit

route_limit

Route limit.

Type

Unsigned integer.

Create

The default value is undefined.

syslog_ipam_events

syslog_ipam_events

Determines if syslogging of IPAM sync events is enabled.

Type

Bool.

Create

The default value is undefined.

syslog_network_events

syslog_network_events

Determines if syslogging of Network sync events is enabled.

Type

Bool.

Create

The default value is undefined.

tcp_scan_technique

tcp_scan_technique

The TCP scan method.

Type

String.

Valid values are:
  • CONNECT
  • SYN

Create

The default value is undefined.

discovery:advisorsetting : Advisor Settings structure.

This structure provides settings for Advisor application

address

address

Host name or ip address of the Advisor server

Type

String.

Create

The default value is undefined.

auth_token

auth_token

Advisor AUTH token

Type

String.

Create

The default value is undefined.

auth_type

auth_type

Authentication type used for Advisor server

Type

String.

Valid values are:
  • CREDS
  • TOKEN

Create

The field is required on creation.

enable_proxy

enable_proxy

Use proxy server if true.

Type

Bool.

Create

The default value is False.

execution_hour

execution_hour

Application execution hour.

Type

Unsigned integer.

Create

The default value is 3.

execution_interval

execution_interval

Application execution interval in seconds. Must be greater than or equal to 86400 seconds (1 day).

Type

Unsigned integer.

Create

The field is required on creation.

last_exec_details

last_exec_details

Details of the last execution attempt of Advisor. Describes the error or warning with a string

Type

String.

Notes

The last_exec_details cannot be updated.

last_exec_details cannot be written.

last_exec_status

last_exec_status

Result of the last execution attempt of Advisor

Type

String.

Valid values are:
  • ERROR
  • OK
  • WARNING

Notes

The last_exec_status cannot be updated.

last_exec_status cannot be written.

last_exec_time

last_exec_time

Timestamp of the Advisor last execution attempt’

Type

Timestamp.

Notes

The last_exec_time cannot be updated.

last_exec_time cannot be written.

last_run_now_details

last_run_now_details

Details of the last Run Now attempt of Advisor. Describes the error or warning with a string

Type

String.

Notes

The last_run_now_details cannot be updated.

last_run_now_details cannot be written.

last_run_now_status

last_run_now_status

Result of the last Run Now attempt of Advisor

Type

String.

Valid values are:
  • ERROR
  • OK
  • WARNING

Notes

The last_run_now_status cannot be updated.

last_run_now_status cannot be written.

last_run_now_time

last_run_now_time

Timestamp of the Advisor last Run Now attempt’

Type

Timestamp.

Notes

The last_run_now_time cannot be updated.

last_run_now_time cannot be written.

min_severity

min_severity

Advisor minimal severity

Type

String.

Create

The field is required on creation.

network_interface_type

network_interface_type

The type of the network interface on consolidator member.

Type

String.

Valid values are:
  • LAN1
  • LAN2
  • MGMT
  • VLAN

Create

The default value is undefined.

network_interface_virtual_ip

network_interface_virtual_ip

The interface for Advisor application on consolidator member.

Type

String.

Create

This field must be specified when network_interface_type is set to “VLAN”

password

password

Password for Advisor server

Type

String.

Create

The default value is undefined.

port

port

Port number the Advisor server listens on

Type

Unsigned integer.

Create

The default value is undefined.

proxy_address

proxy_address

Host name or ip address of the proxy server.

Type

String.

Create

The default value is undefined.

proxy_password

proxy_password

Proxy password.

Type

String.

Create

The default value is undefined.

proxy_port

proxy_port

Port number the proxy listens on.

Type

Unsigned integer.

Create

The default value is undefined.

proxy_username

proxy_username

Proxy username.

Type

String.

Create

The default value is undefined.

use_proxy_username_passwd

use_proxy_username_passwd

Is proxy authorization required?

Type

Bool.

Create

The default value is False.

username

username

Username for Advisor server

Type

String.

Create

The default value is undefined.

discovery:autoconversionsetting : This struct contains settings for automatic conversion

of discovered data to managed objects.

comment

comment

The comment.

Type

String.

Create

The default value is undefined.

condition

condition

The string that contains condition of use the auto conversion settings.

Type

String.

Create

The default value is undefined.

format

format

Template string used to generate host names.

Type

String.

Create

The field is required on creation.

network_view

network_view

The network view name which contains discovered data for convert.

Type

String.

Create

The field is required on creation.

type

type

The object type used to define the converted object.

Type

String.

Valid values are:
  • A_AND_PTR_RECORD
  • FIXED_ADDRESS
  • HOST_RECORD

Create

The field is required on creation.

discovery:basicpollsettings : Basic Poll Settings.

This struct contains information about the discovery basic poll settings.

auto_arp_refresh_before_switch_port_polling

auto_arp_refresh_before_switch_port_polling

Determines whether auto ARP refresh before switch port polling is enabled or not.

Type

Bool.

Create

The field is required on creation.

cli_collection

cli_collection

Determines whether CLI collection is enabled or not.

Type

Bool.

Create

The field is required on creation.

complete_ping_sweep

complete_ping_sweep

Determines whether complete ping sweep is enabled or not.

Type

Bool.

Create

The field is required on creation.

device_profile

device_profile

Determines whether device profile is enabled or not.

Type

Bool.

Create

The field is required on creation.

netbios_scanning

netbios_scanning

Determines whether netbios scanning is enabled or not.

Type

Bool.

Create

The field is required on creation.

port_scanning

port_scanning

Determines whether port scanning is enabled or not.

Type

Bool.

Create

The field is required on creation.

smart_subnet_ping_sweep

smart_subnet_ping_sweep

Determines whether smart subnet ping sweep is enabled or not.

Type

Bool.

Create

The field is required on creation.

snmp_collection

snmp_collection

Determines whether SNMP collection is enabled or not.

Type

Bool.

Create

The field is required on creation.

switch_port_data_collection_polling

switch_port_data_collection_polling

A switch port data collection polling mode.

Type

String.

Valid values are:
  • DISABLED
  • PERIODIC
  • SCHEDULED

Create

The field is required on creation.

switch_port_data_collection_polling_interval

switch_port_data_collection_polling_interval

Indicates the interval for switch port data collection polling.

Type

Unsigned integer.

Create

The default value is empty.

switch_port_data_collection_polling_schedule

switch_port_data_collection_polling_schedule

A Schedule Setting struct that determines switch port data collection polling schedule.

Type

A/An Schedule Setting struct.

Create

The default value is undefined.

discovery:ciscoapicconfiguration : The cisco apic configuration structure.

The structure provides information about Cisco APIC configuration.

address

address

The Cisco APIC IP address or FQDN.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

ca_certificate

ca_certificate

The CA certificate.

Type

String.

This field supports nested return fields as described here.

Create

You must specify the ca_certificate when the protocol is set to ‘HTTPS’.

comment

comment

Additional information about the Cisco APIC configuration.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is undefined.

network_view

network_view

The network view associated with Cisco APIC.

Type

String.

Create

The field is required on creation.

password

password

The Cisco APIC login password.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

Notes

password is not readable.

protocol

protocol

The connection protocol. Valid values are ‘HTTP’ and ‘HTTPS’.

Type

String.

Valid values are:
  • HTTP
  • HTTPS

Create

The field is required on creation.

username

username

The Cisco APIC login name.

Type

String.

Create

The field is required on creation.

discovery:clicredential : CLI credential.

CLI credentials for devices discovered by Network Automation.

comment

comment

The commment for the credential.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

credential_type

credential_type

The type of the credential.

Type

String.

Valid values are:
  • ENABLE_SSH
  • ENABLE_TELNET
  • SSH
  • TELNET

Create

The field is required on creation.

id

id

The Credentials ID.

Type

Unsigned integer.

Notes

The id cannot be updated.

id cannot be written.

password

password

The CLI password.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required only when user is undefined or credential_type set to ENABLE_SSH or ENABLE_TELNET.

Notes

password is not readable.

user

user

The CLI user name.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required only when password is undefined.

discovery:conversion_attributes : Discovery Data Conversion attributes.

Specify these attributes in the Discovery Data Conversion function call to override default values of the target objects.

comment

comment

Set the comment string that will be defined for each target object.

You can use this attribute for all conversion types.

Type

String.

Create

The default value is undefined.

Notes

The comment cannot be updated.

comment is not readable.

configure_for_dhcp

configure_for_dhcp

Set this to true to enable the DHCP configuration for the host address.

You can specify this attribute only for the host record conversion type.

Type

Bool.

Create

The default value is undefined.

Notes

The configure_for_dhcp cannot be updated.

configure_for_dhcp is not readable.

configure_for_dns

configure_for_dns

Set this to true to enable the DNS configuration for the host record.

You can specify this attribute only for the host record conversion type.

Type

Bool.

Create

The default value is undefined.

Notes

The configure_for_dns cannot be updated.

configure_for_dns is not readable.

disable

disable

Set this to true if the target object should be disabled, or to false if it should be enabled.

You can specify this attribute for all conversion types.

Type

Bool.

Create

The default value is False.

Notes

The disable cannot be updated.

disable is not readable.

zone

zone

Set the name of the zone used to insert the target resource records. Example: “zone.com”.

When this attribute is omitted during the conversion to resource record objects, the appliance searches for a zone that can accommodate the target resource records, starting from the bottom of the domain name hierarchy.

The conversion fails if the appliance cannot find the zone that can fit the target resource records or if there are multiple zones that have the same name within different DNS views.

This attribute can be specified for conversion only for the following resource record conversion types: A, AAAA, PTR, and Host.

Type

String.

Create

The default value is undefined.

Notes

The zone cannot be updated.

zone is not readable.

discovery:device:portstatistics : Port statistics.

This struct contains information about port statistics.

admin_down_oper_down_count

admin_down_oper_down_count

The total number of interfaces which have administrative state ‘DOWN’ and operating state ‘DOWN’.

Type

Unsigned integer.

Notes

The admin_down_oper_down_count cannot be updated.

admin_down_oper_down_count cannot be written.

admin_up_oper_down_count

admin_up_oper_down_count

The total number of interfaces which have administrative state ‘UP’ and oper state ‘DOWN’.

Type

Unsigned integer.

Notes

The admin_up_oper_down_count cannot be updated.

admin_up_oper_down_count cannot be written.

admin_up_oper_up_count

admin_up_oper_up_count

The total number of interfaces which have both administrative and operating states as ‘UP’.

Type

Unsigned integer.

Notes

The admin_up_oper_up_count cannot be updated.

admin_up_oper_up_count cannot be written.

interfaces_count

interfaces_count

The total number of available interfaces on this device.

Type

Unsigned integer.

Notes

The interfaces_count cannot be updated.

interfaces_count cannot be written.

discovery:devicedatacollectionstatus : Device Data Collection Status struct.

These parameters are related to the result of the Get Device Support Info call.

data_source

data_source

The source from which device support information is collected.

Type

String.

Notes

The data_source cannot be updated.

data_source cannot be written.

end_time

end_time

Time when the most recent collection from the data sources was completed.

Type

Timestamp.

Notes

The end_time cannot be updated.

end_time cannot be written.

discovery:devicesupportinfo : Device Support Info struct.

These parameters are related to the result of the Get Device Support Info call.

available

available

Shows whether the function is available for the device or not.

Type

String.

Notes

The available cannot be updated.

available cannot be written.

function

function

The function of the device.

Type

String.

Notes

The function cannot be updated.

function cannot be written.

supported

supported

Shows whether the function is supported by the device or not.

Type

String.

Notes

The supported cannot be updated.

supported cannot be written.

value

value

The value is an indicator of Discovery member knowing that a given device supports the given type of data collection (SNMP, for example).

Type

String.

Notes

The value cannot be updated.

value cannot be written.

discovery:discoverydataconversionresult : Discovery Data Conversion result.

These parameters are related to the result of the Discovery Data Conversion call.

address

address

The original IPv4 or IPv6 objects referring to the unmanaged Discovery Data.

Type

String.

This field supports nested return fields as described here.

Notes

The address cannot be updated.

address cannot be written.

message

message

The status message. This can contain either the reason for the object conversion failure or a success string.

Type

String.

Notes

The message cannot be updated.

message cannot be written.

object

object

The converted object. This field is empty if the conversion fails.

Type

String.

This field supports nested return fields as described here.

Notes

The object cannot be updated.

object cannot be written.

status

status

The status of the unmanaged Discovery Data conversion.

Type

String.

Valid values are:
  • FAILURE
  • SUCCESS

Notes

The status cannot be updated.

status cannot be written.

discovery:ifaddrinfo : IfAddr information.

IfAddr information on devices discovered by Network Automation.

address

address

The IPv4 Address or IPv6 Address of the device.

Type

String.

Notes

The address cannot be updated.

address cannot be written.

address_object

address_object

The ref to IPv4/Ipv6 Address.

Type

String.

This field supports nested return fields as described here.

Notes

The address_object cannot be updated.

address_object cannot be written.

network

network

The network to which this device belongs, in IPv4 Address/CIDR format.

Type

String.

Notes

The network cannot be updated.

network cannot be written.

discovery:jobprocessdetails : Discovery Job Process Details.

This struct contains details about a discovery job process.

end_line

end_line

The end line of the returned stream.

Type

Unsigned integer.

Notes

The end_line cannot be updated.

end_line cannot be written.

status

status

The indicator of session status.

Type

String.

Valid values are:
  • COMPLETED
  • FAILED
  • INPROGRESS

Notes

The status cannot be updated.

status cannot be written.

stream

stream

The job process log stream.

Type

String.

Values with leading or trailing white space are not valid for this field.

Notes

The stream cannot be updated.

stream cannot be written.

discovery:networkdeprovisioninfo : Network Deprovision Info.

This struct contains information about interface and network for de-provisioning.

interface

interface

A reference to a WAPI Interface object of a given device on which the network is to be de-provisioned.

Type

String.

This field supports nested return fields as described here.

Create

The field is required on creation.

Notes

The interface cannot be updated.

interface is not readable.

network

network

The network address, in IPv4 Address/CIDR or IPv6 Address/CIDR format.

Type

String.

The field also supports automatic selection of the next available network with selected CIDR in the specified network or network container. You can specify the network or network container in the following ways:

Using a network or network container WAPI reference:

  • func:nextavailablenetwork:<reference>,<CIDR>

Using a network lookup (if the view is not specified, the default view will be used):

  • func:nextavailablenetwork:<network>[,<network view>],<CIDR>

Scheduled and approval operations are not supported when using the automatic network selection.

If you specify a network view for automatic network selection, you should also add a network_view field in the object to be inserted with the same network view because the network view for automatic network selection is not used for the actual object insertion.

NOTE: Automatic selection is supported only for JSON and XML requests.

Examples:

  • func:nextavailablenetwork:network/ZG54dfgsrDFEFfsfsLzA:10.0.0.0/8/default,16
  • func:nextavailablenetwork:10.0.0.0/8,16
  • func:nextavailablenetwork:10.0.0.0/8,external,16

Create

The field is required on creation.

Notes

The network cannot be updated.

network is not readable.

network_view

network_view

The name of the network view in which this network resides.

Type

String.

Create

The field is required on creation.

Notes

The network_view cannot be updated.

network_view is not readable.

discovery:networkinfo : Network info.

This struct contains information about network.

network

network

The ref to the network to which the management IP address belongs.

Type

String.

This field supports nested return fields as described here.

Notes

The network cannot be updated.

network cannot be written.

network_str

network_str

The Network address in format address/cidr.

Type

String.

Notes

The network_str cannot be updated.

network_str cannot be written.

discovery:port : The discovery port structure.

The structure provides information about discovery port.

comment

comment

The comment for this discovery port.

Type

String.

Create

The default value is undefined.

port

port

The discovery port number.

Type

Unsigned integer.

Create

The field is required on creation.

type

type

The discovery port type.

Type

String.

Valid values are:
  • TCP
  • UDP

Create

The field is required on creation.

discovery:port:config:adminstatus : Port Config Admin Status.

This struct contains information about admin status.

details

details

The associated port control task details.

Type

A/An Port Control Task Details struct.

Notes

The details cannot be updated.

details cannot be written.

status

status

The configured admin status value.

Type

String.

Valid values are:
  • DOWN
  • UP

Notes

The status cannot be updated.

status cannot be written.

discovery:port:config:description : Port Config Descrition.

This struct contains information about config description.

description

description

The configured description value.

Type

String.

Notes

The description cannot be updated.

description cannot be written.

details

details

The associated port control task details.

Type

A/An Port Control Task Details struct.

Notes

The details cannot be updated.

details cannot be written.

discovery:port:config:vlaninfo : Port Config VLAN info.

This struct contains information about VLAN info.

data_vlan_info

data_vlan_info

The configured data VLAN ID and the name of the interface.

Type

A/An VLAN information struct.

Notes

The data_vlan_info cannot be updated.

data_vlan_info cannot be written.

details

details

The associated port control task details.

Type

A/An Port Control Task Details struct.

Notes

The details cannot be updated.

details cannot be written.

voice_vlan_info

voice_vlan_info

The configured voice VLAN id and name of interface.

Type

A/An VLAN information struct.

Notes

The voice_vlan_info cannot be updated.

voice_vlan_info cannot be written.

discovery:port:control:info : Port Control info.

This struct contains information about Port Control.

admin_status

admin_status

The administrative state of the interface.

Type

String.

Valid values are:
  • DOWN
  • UP

Create

The default value is undefined.

Notes

The admin_status cannot be updated.

admin_status is not readable.

data_vlan_info

data_vlan_info

The Configured data VLAN id and name of interface.

Type

A/An VLAN information struct.

Create

The default value is undefined.

Notes

The data_vlan_info cannot be updated.

data_vlan_info is not readable.

description

description

The description of the interface.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is undefined.

Notes

The description cannot be updated.

description is not readable.

device

device

A reference to a WAPI Device object on which port is configured.

Type

String.

This field supports nested return fields as described here.

Create

The default value is undefined.

Notes

The device cannot be updated.

device is not readable.

interface

interface

A reference to a WAPI Interface object of given device.

Type

String.

This field supports nested return fields as described here.

Create

The field is required on creation.

Notes

The interface cannot be updated.

interface is not readable.

parent

parent

A reference to the RESTful API Interface, Member, Host, IPv4 Fixed Address, or IPv6 Fixed Address parent object on which the port is configured.

Type

String.

This field supports nested return fields as described here.

Create

The default value is undefined.

Notes

The parent cannot be updated.

parent is not readable.

voice_vlan_info

voice_vlan_info

The configured voice VLAN ID and the name of the interface.

Type

A/An VLAN information struct.

Create

The default value is undefined.

Notes

The voice_vlan_info cannot be updated.

voice_vlan_info is not readable.

discovery:port:control:taskdetails : Port Control Task Details.

This struct contains information about task details.

id

id

The ID of the associated port control task.

Type

Unsigned integer.

Notes

The id cannot be updated.

id cannot be written.

is_synchronized

is_synchronized

True if this port control task is completed and matched with current discovered value.

Type

Bool.

Notes

The is_synchronized cannot be updated.

is_synchronized cannot be written.

status

status

The task status of the associated port control task.

Type

String.

Valid values are:
  • COMPLETED
  • NONE
  • PENDING
  • RUNNING

Notes

The status cannot be updated.

status cannot be written.

discovery:scaninterface : The discovery scan interface structure.

The structure provides information about the discovery scan interface.

network_view

network_view

The name of the network view associated with the network discovery probing member.

Type

String.

Create

The field is required on creation.

scan_virtual_ip

scan_virtual_ip

The virtual ip for discovery scan interface on network discovery probing member.

Type

String.

Create

You must specify scan_virtual_ip when type is set to “VLAN”

type

type

The probing interface associated with the network discovery probing member.

Type

String.

Valid values are:
  • LAN1
  • LAN2
  • MGMT
  • VLAN

Create

The field is required on creation.

discovery:seedrouter : The seed router structure.

The structure provides information about the seed router.

address

address

Address of the seed router.

Type

String.

Create

The field is required on creation.

comment

comment

Description of the seed router.

Type

String.

Create

The default value is empty.

network_view

network_view

The network view name.

Type

String.

Create

The default value is empty.

discovery:snmp3credential : SNMP v3 Credential.

This struct contains SNMPv3 credential data.

authentication_password

authentication_password

Authentication password for the SNMPv3 user.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

Notes

authentication_password is not readable.

authentication_protocol

authentication_protocol

Authentication protocol for the SNMPv3 user.

Type

String.

Valid values are:
  • MD5
  • NONE
  • SHA

Create

The field is required on creation.

comment

comment

Comments for the SNMPv3 user.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

privacy_password

privacy_password

Privacy password for the SNMPv3 user.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

Notes

privacy_password is not readable.

privacy_protocol

privacy_protocol

Privacy protocol for the SNMPv3 user.

Type

String.

Valid values are:
  • 3DES
  • AES
  • DES
  • NONE

Create

The field is required on creation.

user

user

The SNMPv3 user name.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

discovery:snmpcredential : SNMP Credential.

This struct contains SNMPv1 and SNMPv2 credential data.

comment

comment

Comments for the SNMPv1 and SNMPv2 users.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

community_string

community_string

The public community string.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

discovery:statusinfo : Status information.

Status information on devices discovered by Network Automation.

message

message

The detailed message.

Type

String.

Notes

The message cannot be updated.

message cannot be written.

status

status

The overall status of the device.

Type

String.

Valid values are:
  • ERROR
  • OK
  • RUNNING

Notes

The status cannot be updated.

status cannot be written.

timestamp

timestamp

The timestamp when the status was generated.

Type

Timestamp.

Notes

The timestamp cannot be updated.

timestamp cannot be written.

discovery:vlaninfo : VLAN information.

VLAN information on devices discovered by Network Automation.

id

id

The Vlan ID.

Type

Unsigned integer.

Create

The default value is undefined.

name

name

The Vlan name.

Type

String.

Create

The default value is undefined.

discovery:vrfmappingrule : This struct contains VRF Mapping Rule.

VRF mapping rule is a regular expression that is defining what VRFs will be used to populate the specified Network View.

comment

comment

The comment.

Type

String.

Create

The default value is undefined.

criteria

criteria

Extended POSIX regular expression matching the VRF name. The regular expression string should contain the leading caret anchor ^ and the trailing dollar anchor $ symbols.

Type

String.

Create

The field is required on creation.

network_view

network_view

The name of the network view associated with the VRF mapping rule.

Type

String.

Create

The field is required on creation.

discoverydata : Discovered data.

This struct contains data gathered during a network discovery.

ap_ip_address

ap_ip_address

Discovered IP address of Wireless Access Point.

Type

String.

Notes

The ap_ip_address cannot be updated.

ap_ip_address cannot be written.

ap_name

ap_name

Discovered name of Wireless Access Point.

Type

String.

Notes

The ap_name cannot be updated.

ap_name cannot be written.

ap_ssid

ap_ssid

Service set identifier (SSID) associated with Wireless Access Point.

Type

String.

Notes

The ap_ssid cannot be updated.

ap_ssid cannot be written.

bgp_as

bgp_as

The BGP autonomous system number.

Type

Unsigned integer.

Notes

The bgp_as cannot be updated.

bgp_as cannot be written.

bridge_domain

bridge_domain

Discovered bridge domain.

Type

String.

Notes

The bridge_domain cannot be updated.

bridge_domain cannot be written.

cisco_ise_endpoint_profile

cisco_ise_endpoint_profile

The Endpoint Profile created in Cisco ISE.

Type

String.

Notes

The cisco_ise_endpoint_profile cannot be updated.

cisco_ise_endpoint_profile cannot be written.

cisco_ise_security_group

cisco_ise_security_group

The Cisco ISE security group name.

Type

String.

Notes

The cisco_ise_security_group cannot be updated.

cisco_ise_security_group cannot be written.

cisco_ise_session_state

cisco_ise_session_state

The Cisco ISE connection session state.

Type

String.

Valid values are:
  • AUTHENTICATED
  • AUTHENTICATING
  • DISCONNECTED
  • POSTURED
  • STARTED

Notes

The cisco_ise_session_state cannot be updated.

cisco_ise_session_state cannot be written.

cisco_ise_ssid

cisco_ise_ssid

The Cisco ISE SSID.

Type

String.

Notes

The cisco_ise_ssid cannot be updated.

cisco_ise_ssid cannot be written.

cmp_type

cmp_type
If the IP is coming from a Cloud environment, the Cloud Management
Platform type.

Type

String.

Notes

The cmp_type cannot be updated.

cmp_type cannot be written.

device_contact

device_contact

Contact information from device on which the IP address was discovered.

Type

String.

Notes

The device_contact cannot be updated.

device_contact cannot be written.

device_location

device_location

Location of device on which the IP address was discovered.

Type

String.

Notes

The device_location cannot be updated.

device_location cannot be written.

device_model

device_model

The model name of the end device in the vendor terminology.

Type

String.

Notes

The device_model cannot be updated.

device_model cannot be written.

device_port_name

device_port_name

The system name of the interface associated with the discovered IP address.

Type

String.

Notes

The device_port_name cannot be updated.

device_port_name cannot be written.

device_port_type

device_port_type

The hardware type of the interface associated with the discovered IP address.

Type

String.

Notes

The device_port_type cannot be updated.

device_port_type cannot be written.

device_type

device_type

The type of end host in vendor terminology.

Type

String.

Notes

The device_type cannot be updated.

device_type cannot be written.

device_vendor

device_vendor

The vendor name of the end host.

Type

String.

Notes

The device_vendor cannot be updated.

device_vendor cannot be written.

discovered_name

discovered_name

The name of the network device associated with the discovered IP address.

Type

String.

Notes

The discovered_name cannot be updated.

discovered_name cannot be written.

discoverer

discoverer

Specifies whether the IP address was discovered by a NetMRI or NIOS discovery process.

Type

String.

Notes

The discoverer cannot be updated.

discoverer cannot be written.

duid

duid

For IPv6 address only. The DHCP unique identifier of the discovered host. This is an optional field, and data might not be included.

Type

String.

Notes

The duid cannot be updated.

duid cannot be written.

endpoint_groups

endpoint_groups

A comma-separated list of the discovered endpoint groups.

Type

String.

Notes

The endpoint_groups cannot be updated.

endpoint_groups cannot be written.

first_discovered

first_discovered

The date and time the IP address was first discovered in Epoch seconds format.

Type

Timestamp.

Notes

The first_discovered cannot be updated.

first_discovered cannot be written.

iprg_no

iprg_no

The port redundant group number.

Type

Unsigned integer.

Notes

The iprg_no cannot be updated.

iprg_no cannot be written.

iprg_state

iprg_state

The status for the IP address within port redundant group.

Type

String.

Valid values are:
  • ACTIVE
  • NEGOTIATION
  • STANDBY
  • VIP

Notes

The iprg_state cannot be updated.

iprg_state cannot be written.

iprg_type

iprg_type

The port redundant group type.

Type

String.

Valid values are:
  • HSRP
  • VRRP

Notes

The iprg_type cannot be updated.

iprg_type cannot be written.

last_discovered

last_discovered

The date and time the IP address was last discovered in Epoch seconds format.

Type

Timestamp.

Notes

The last_discovered cannot be updated.

last_discovered cannot be written.

mac_address

mac_address

The discovered MAC address for the host. This is the unique identifier of a network device. The discovery acquires the MAC address for hosts that are located on the same network as the Grid member that is running the discovery. This can also be the MAC address of a virtual entity on a specified vSphere server.

Type

String.

Notes

The mac_address cannot be updated.

mac_address cannot be written.

mgmt_ip_address

mgmt_ip_address

The management IP address of the end host that has more than one IP.

Type

String.

Notes

The mgmt_ip_address cannot be updated.

mgmt_ip_address cannot be written.

netbios_name

netbios_name

The name returned in the NetBIOS reply or the name you manually register for the discovered host.

Type

String.

Notes

The netbios_name cannot be updated.

netbios_name cannot be written.

network_component_contact

network_component_contact

Contact information from the network component on which the IP address was discovered.

Type

String.

Notes

The network_component_contact cannot be updated.

network_component_contact cannot be written.

network_component_description

network_component_description

A textual description of the switch that is connected to the end device.

Type

String.

Notes

The network_component_description cannot be updated.

network_component_description cannot be written.

network_component_ip

network_component_ip

The IPv4 Address or IPv6 Address of the switch that is connected to the end device.

Type

String.

Notes

The network_component_ip cannot be updated.

network_component_ip cannot be written.

network_component_location

network_component_location

Location of the network component on which the IP address was discovered.

Type

String.

Notes

The network_component_location cannot be updated.

network_component_location cannot be written.

network_component_model

network_component_model

Model name of the switch port connected to the end host in vendor terminology.

Type

String.

Notes

The network_component_model cannot be updated.

network_component_model cannot be written.

network_component_name

network_component_name

If a reverse lookup was successful for the IP address associated with this switch, the host name is displayed in this field.

Type

String.

Notes

The network_component_name cannot be updated.

network_component_name cannot be written.

network_component_port_description

network_component_port_description

A textual description of the switch port that is connected to the end device.

Type

String.

Notes

The network_component_port_description cannot be updated.

network_component_port_description cannot be written.

network_component_port_name

network_component_port_name

The name of the switch port connected to the end device.

Type

String.

Notes

The network_component_port_name cannot be updated.

network_component_port_name cannot be written.

network_component_port_number

network_component_port_number

The number of the switch port connected to the end device.

Type

String.

Notes

The network_component_port_number cannot be updated.

network_component_port_number cannot be written.

network_component_type

network_component_type

Identifies the switch that is connected to the end device.

Type

String.

Notes

The network_component_type cannot be updated.

network_component_type cannot be written.

network_component_vendor

network_component_vendor

The vendor name of the switch port connected to the end host.

Type

String.

Notes

The network_component_vendor cannot be updated.

network_component_vendor cannot be written.

open_ports

open_ports

The list of opened ports on the IP address, represented as: “TCP: 21,22,23 UDP: 137,139”. Limited to max total 1000 ports.

Type

String.

Notes

The open_ports cannot be updated.

open_ports cannot be written.

os

os

The operating system of the detected host or virtual entity. The OS can be one of the following:

  • Microsoft for all discovered hosts that have a non-null value in the MAC addresses using the NetBIOS discovery method.
  • A value that a TCP discovery returns.
  • The OS of a virtual entity on a vSphere server.

Type

String.

Notes

The os cannot be updated.

os cannot be written.

port_duplex

port_duplex

The negotiated or operational duplex setting of the switch port connected to the end device.

Type

String.

Notes

The port_duplex cannot be updated.

port_duplex cannot be written.

port_speed

port_speed

The interface speed, in Mbps, of the switch port.

Type

String.

Notes

The port_speed cannot be updated.

port_speed cannot be written.

port_status

port_status

The operational status of the switch port. Indicates whether the port is up or down.

Type

String.

Notes

The port_status cannot be updated.

port_status cannot be written.

port_type

port_type

The type of switch port.

Type

String.

Notes

The port_type cannot be updated.

port_type cannot be written.

port_vlan_description

port_vlan_description

The description of the VLAN of the switch port that is connected to the end device.

Type

String.

Notes

The port_vlan_description cannot be updated.

port_vlan_description cannot be written.

port_vlan_name

port_vlan_name

The name of the VLAN of the switch port.

Type

String.

Notes

The port_vlan_name cannot be updated.

port_vlan_name cannot be written.

port_vlan_number

port_vlan_number

The ID of the VLAN of the switch port.

Type

String.

Notes

The port_vlan_number cannot be updated.

port_vlan_number cannot be written.

task_name

task_name

The name of the discovery task.

Type

String.

Notes

The task_name cannot be updated.

task_name cannot be written.

tenant

tenant

Discovered tenant.

Type

String.

Notes

The tenant cannot be updated.

tenant cannot be written.

v_adapter

v_adapter

The name of the physical network adapter through which the virtual entity is connected to the appliance.

Type

String.

Notes

The v_adapter cannot be updated.

v_adapter cannot be written.

v_cluster

v_cluster

The name of the VMware cluster to which the virtual entity belongs.

Type

String.

Notes

The v_cluster cannot be updated.

v_cluster cannot be written.

v_datacenter

v_datacenter

The name of the vSphere datacenter or container to which the virtual entity belongs.

Type

String.

Notes

The v_datacenter cannot be updated.

v_datacenter cannot be written.

v_entity_name

v_entity_name

The name of the virtual entity.

Type

String.

Notes

The v_entity_name cannot be updated.

v_entity_name cannot be written.

v_entity_type

v_entity_type

The virtual entity type. This can be blank or one of the following: Virtual Machine, Virtual Host, or Virtual Center. Virtual Center represents a VMware vCenter server.

Type

String.

Notes

The v_entity_type cannot be updated.

v_entity_type cannot be written.

v_host

v_host

The name of the VMware server on which the virtual entity was discovered.

Type

String.

Notes

The v_host cannot be updated.

v_host cannot be written.

v_switch

v_switch

The name of the switch to which the virtual entity is connected.

Type

String.

Notes

The v_switch cannot be updated.

v_switch cannot be written.

vlan_port_group

vlan_port_group

Port group which the virtual machine belongs to.

Type

String.

Notes

The vlan_port_group cannot be updated.

vlan_port_group cannot be written.

vmhost_ip_address

vmhost_ip_address
IP address of the physical node on which the virtual machine is
hosted.

Type

String.

Notes

The vmhost_ip_address cannot be updated.

vmhost_ip_address cannot be written.

vmhost_mac_address

vmhost_mac_address
MAC address of the physical node on which the virtual machine is
hosted.

Type

String.

Notes

The vmhost_mac_address cannot be updated.

vmhost_mac_address cannot be written.

vmhost_name

vmhost_name
Name of the physical node on which the virtual machine is
hosted.

Type

String.

Notes

The vmhost_name cannot be updated.

vmhost_name cannot be written.

vmhost_nic_names

vmhost_nic_names
List of all physical port names used by the virtual switch on the
physical node on which the virtual machine is hosted. Represented as: “eth1,eth2,eth3”.

Type

String.

Notes

The vmhost_nic_names cannot be updated.

vmhost_nic_names cannot be written.

vmhost_subnet_cidr

vmhost_subnet_cidr
CIDR subnet of the physical node on which the virtual machine
is hosted.

Type

Unsigned integer.

Notes

The vmhost_subnet_cidr cannot be updated.

vmhost_subnet_cidr cannot be written.

vmi_id

vmi_id

ID of the virtual machine.

Type

String.

Notes

The vmi_id cannot be updated.

vmi_id cannot be written.

vmi_ip_type

vmi_ip_type

Discovered IP address type.

Type

String.

Notes

The vmi_ip_type cannot be updated.

vmi_ip_type cannot be written.

vmi_is_public_address

vmi_is_public_address

Indicates whether the IP address is a public address.

Type

Bool.

Notes

The vmi_is_public_address cannot be updated.

vmi_is_public_address cannot be written.

vmi_name

vmi_name

Name of the virtual machine.

Type

String.

Notes

The vmi_name cannot be updated.

vmi_name cannot be written.

vmi_private_address

vmi_private_address

Private IP address of the virtual machine.

Type

String.

Notes

The vmi_private_address cannot be updated.

vmi_private_address cannot be written.

vmi_tenant_id

vmi_tenant_id

ID of the tenant which virtual machine belongs to.

Type

String.

Notes

The vmi_tenant_id cannot be updated.

vmi_tenant_id cannot be written.

vport_conf_mode

vport_conf_mode
Configured mode of the network adapter on the virtual switch
where the virtual machine connected to.

Type

String.

Valid values are:
  • Full-duplex
  • Half-duplex
  • Unknown

Notes

The vport_conf_mode cannot be updated.

vport_conf_mode cannot be written.

vport_conf_speed

vport_conf_speed
Configured speed of the network adapter on the virtual switch
where the virtual machine connected to. Unit is kb.

Type

String.

Notes

The vport_conf_speed cannot be updated.

vport_conf_speed cannot be written.

vport_mac_address

vport_mac_address
MAC address of the network adapter on the virtual switch where the
virtual machine connected to.

Type

String.

Notes

The vport_mac_address cannot be updated.

vport_mac_address cannot be written.

vport_mode

vport_mode
Actual mode of the network adapter on the virtual switch where
the virtual machine connected to.

Type

String.

Valid values are:
  • Full-duplex
  • Half-duplex
  • Unknown

Notes

The vport_mode cannot be updated.

vport_mode cannot be written.

vport_name

vport_name
Name of the network adapter on the virtual switch connected with
the virtual machine.

Type

String.

Notes

The vport_name cannot be updated.

vport_name cannot be written.

vport_speed

vport_speed
Actual speed of the network adapter on the virtual switch where
the virtual machine connected to. Unit is kb.

Type

String.

Notes

The vport_speed cannot be updated.

vport_speed cannot be written.

vrf_description

vrf_description

Description of the VRF.

Type

String.

Notes

The vrf_description cannot be updated.

vrf_description cannot be written.

vrf_name

vrf_name

The name of the VRF.

Type

String.

Notes

The vrf_name cannot be updated.

vrf_name cannot be written.

vrf_rd

vrf_rd

Route distinguisher of the VRF.

Type

String.

Notes

The vrf_rd cannot be updated.

vrf_rd cannot be written.

vswitch_available_ports_count

vswitch_available_ports_count
Numer of available ports reported by the virtual switch on
which the virtual machine/vport connected to.

Type

Unsigned integer.

Notes

The vswitch_available_ports_count cannot be updated.

vswitch_available_ports_count cannot be written.

vswitch_id

vswitch_id

ID of the virtual switch.

Type

String.

Notes

The vswitch_id cannot be updated.

vswitch_id cannot be written.

vswitch_ipv6_enabled

vswitch_ipv6_enabled

Indicates the virtual switch has IPV6 enabled.

Type

Bool.

Notes

The vswitch_ipv6_enabled cannot be updated.

vswitch_ipv6_enabled cannot be written.

vswitch_name

vswitch_name

Name of the virtual switch.

Type

String.

Notes

The vswitch_name cannot be updated.

vswitch_name cannot be written.

vswitch_segment_id

vswitch_segment_id
ID of the network segment on which the current virtual
machine/vport connected to.

Type

String.

Notes

The vswitch_segment_id cannot be updated.

vswitch_segment_id cannot be written.

vswitch_segment_name

vswitch_segment_name
Name of the network segment on which the current virtual
machine/vport connected to.

Type

String.

Notes

The vswitch_segment_name cannot be updated.

vswitch_segment_name cannot be written.

vswitch_segment_port_group

vswitch_segment_port_group
Port group of the network segment on which the current virtual
machine/vport connected to.

Type

String.

Notes

The vswitch_segment_port_group cannot be updated.

vswitch_segment_port_group cannot be written.

vswitch_segment_type

vswitch_segment_type
Type of the network segment on which the current virtual
machine/vport connected to.

Type

String.

Notes

The vswitch_segment_type cannot be updated.

vswitch_segment_type cannot be written.

vswitch_tep_dhcp_server

vswitch_tep_dhcp_server
DHCP server of the virtual tunnel endpoint (VTEP) in the virtual
switch.

Type

String.

Notes

The vswitch_tep_dhcp_server cannot be updated.

vswitch_tep_dhcp_server cannot be written.

vswitch_tep_ip

vswitch_tep_ip
IP address of the virtual tunnel endpoint (VTEP) in the virtual
switch.

Type

String.

Notes

The vswitch_tep_ip cannot be updated.

vswitch_tep_ip cannot be written.

vswitch_tep_multicast

vswitch_tep_multicast
Muticast address of the virtual tunnel endpoint (VTEP) in the
virtual swtich.

Type

String.

Notes

The vswitch_tep_multicast cannot be updated.

vswitch_tep_multicast cannot be written.

vswitch_tep_port_group

vswitch_tep_port_group
Port group of the virtual tunnel endpoint (VTEP) in the virtual
switch.

Type

String.

Notes

The vswitch_tep_port_group cannot be updated.

vswitch_tep_port_group cannot be written.

vswitch_tep_type

vswitch_tep_type

Type of virtual tunnel endpoint (VTEP) in the virtual switch.

Type

String.

Notes

The vswitch_tep_type cannot be updated.

vswitch_tep_type cannot be written.

vswitch_tep_vlan

vswitch_tep_vlan
VLAN of the virtual tunnel endpoint (VTEP) in the virtual
switch.

Type

String.

Notes

The vswitch_tep_vlan cannot be updated.

vswitch_tep_vlan cannot be written.

vswitch_type

vswitch_type

Type of the virtual switch: standard or distributed.

Type

String.

Valid values are:
  • Distributed
  • Standard
  • Unknown

Notes

The vswitch_type cannot be updated.

vswitch_type cannot be written.

discoverytaskport : The network discovery TCP port.

This structure represents the TCP port that network discovery jobs use to find IP addresses.

comment

comment

The TCP port descriptive comment.

Type

String.

Create

The default value is empty.

number

number

The TCP port number.

Type

Unsigned integer.

Create

The field is required on creation.

discoverytaskvserver : VMWare discovery server.

Contains information about the vSphere servers on which the VM discovery is performed.

connection_protocol

connection_protocol

The connection protocol of a vSphere server.

Type

String.

Valid values are:
  • HTTP
  • HTTPS

Create

The default value is HTTPS.

disable

disable

The disable flag of a vSphere server.

Type

Bool.

Create

The default value is False.

fqdn_or_ip

fqdn_or_ip

The FQDN (Fully Qualified Domain Name) or IP address of the vShpere server.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

password

password

The user password on the vSphere server.

Type

String.

Create

The field is required on creation.

Notes

password is not readable.

port

port

The connection port that the vSphere server uses.

Type

Unsigned integer.

Create

The default value is 443.

username

username

The user name on the vSphere server.

Type

String.

Create

The field is required on creation.

dnsseckey : DNSSEC Key.

The DNSSEC key object.

algorithm

algorithm

The public-key encryption algorithm.

Type

String.

Valid values are:
  • 1
  • 10
  • 3
  • 5
  • 6
  • 7
  • 8

Notes

The algorithm cannot be updated.

algorithm cannot be written.

next_event_date

next_event_date

The next event date for the key, the rollover date for an active key or the removal date for an already rolled one.

Type

Timestamp.

Notes

The next_event_date cannot be updated.

next_event_date cannot be written.

public_key

public_key

The Base-64 encoding of the public key.

Type

String.

Values with leading or trailing white space are not valid for this field.

Notes

The public_key cannot be updated.

public_key cannot be written.

status

status

The status of the key for the zone.

Type

String.

Valid values are:
  • ACTIVE
  • IMPORTED
  • PUBLISHED
  • ROLLED

Notes

The status cannot be updated.

status cannot be written.

tag

tag

The tag of the key for the zone.

Type

Unsigned integer.

Create

The field is required on creation.

type

type

The key type.

Type

String.

Valid values are:
  • KSK
  • ZSK

Notes

The type cannot be updated.

type cannot be written.

dnsseckeyalgorithm : DNSSEC Key Algorithm.

The DNSSEC key algorithm structure is used for configuring algorithms for Key-signing and Zone-signing keys.

algorithm

algorithm

The signing key algorithm.

Type

String.

Valid values are:
  • DSA
  • RSAMD5
  • RSASHA1
  • RSASHA256
  • RSASHA512

Create

The field is required on creation.

size

size

The signing key size, in bits.

Type

Unsigned integer.

Create

The field is required on creation.

dnsseckeyparams : DNSSEC Key parameters.

DNSSEC key parameters.

Note:

Fields ksk_algorithm, ksk_size, zsk_algorithm, zsk_size are deprecated. Use fields ksk_algorithms and zsk_algorithms instead.

The appliance returns deprecated fields with values of the first element in ksk_algorithms and zsk_algorithms lists respectively.

If these deprecated fields are passed, the appliance maps them to the first element of the ksk_algorithms and zsk_algorithms lists respectively. In case if a list already contains more than one element, the appliance returns an error.

enable_ksk_auto_rollover

enable_ksk_auto_rollover

If set to True, automatic rollovers for the signing key is enabled.

Type

Bool.

Create

The default value is False.

ksk_algorithm

ksk_algorithm

Key Signing Key algorithm. Deprecated.

Type

String.

Valid values are:
  • 1
  • 10
  • 3
  • 5
  • 6
  • 7
  • 8

Create

The default value is 8.

ksk_algorithms

ksk_algorithms

A list of Key Signing Key Algorithms.

Type

A/An DNSSEC Key Algorithm struct array.

Create

The default value is:

[{ 'algorithm': 'RSASHA256', 'size': 2048}]

ksk_email_notification_enabled

ksk_email_notification_enabled

Enable email notifications for KSK related events.

Type

Bool.

Create

The default value is False.

ksk_rollover

ksk_rollover

Key Signing Key rollover interval, in seconds.

Type

Unsigned integer.

Create

The default value is 31536000.

ksk_rollover_notification_config

ksk_rollover_notification_config

This field controls events for which users will be notified.

Type

String.

Valid values are:
  • ALL
  • NONE
  • REQUIRE_MANUAL_INTERVENTION

Create

The default value is REQUIRE_MANUAL_INTERVENTION.

ksk_size

ksk_size

Key Signing Key size, in bits. Deprecated.

Type

Unsigned integer.

Create

The default value is 2048.

ksk_snmp_notification_enabled

ksk_snmp_notification_enabled

Enable SNMP notifications for KSK related events.

Type

Bool.

Create

The default value is True.

next_secure_type

next_secure_type

NSEC (next secure) types.

Type

String.

Valid values are:
  • NSEC
  • NSEC3

Create

The default value is NSEC3.

nsec3_iterations

nsec3_iterations

The number of iterations used for hashing NSEC3.

Type

Unsigned integer.

Create

The default value is 10.

nsec3_salt_max_length

nsec3_salt_max_length

The maximum length for NSEC3 salts.

Type

Unsigned integer.

Create

The default value is 15.

nsec3_salt_min_length

nsec3_salt_min_length

The minimum length for NSEC3 salts.

Type

Unsigned integer.

Create

The default value is 1.

signature_expiration

signature_expiration

Signature expiration time, in seconds.

Type

Unsigned integer.

Create

The default value is 345600.

zsk_algorithm

zsk_algorithm

Zone Signing Key algorithm. Deprecated.

Type

String.

Valid values are:
  • 1
  • 10
  • 3
  • 5
  • 6
  • 7
  • 8

Create

The default value is 8.

zsk_algorithms

zsk_algorithms

A list of Zone Signing Key Algorithms.

Type

A/An DNSSEC Key Algorithm struct array.

Create

The default value is:

[{ 'algorithm': 'RSASHA256', 'size': 1024}]

zsk_rollover

zsk_rollover

Zone Signing Key rollover interval, in seconds.

Type

Unsigned integer.

Create

The default value is 2592000.

zsk_rollover_mechanism

zsk_rollover_mechanism

Zone Signing Key rollover mechanism.

Type

String.

Valid values are:
  • DOUBLE_SIGN
  • PRE_PUBLISH

Create

The default value is PRE_PUBLISH.

zsk_size

zsk_size

Zone Signing Key size, in bits. Deprecated.

Type

Unsigned integer.

Create

The default value is 1024.

dnssectrustedkey : DNSSEC Trusted Key.

This is the the DNSKEY record that holds the KSK as a trust anchor for each zone for which the Grid member returns validated data.

algorithm

algorithm

The DNSSEC algorithm used to generate the key.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

dnssec_must_be_secure

dnssec_must_be_secure

Responses must be DNSSEC secure for this hierarchy/domain.

Type

Bool.

Create

The default value is False.

fqdn

fqdn

The FQDN of the domain for which the member validates responses to recursive queries.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

key

key

The DNSSEC key.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

secure_entry_point

secure_entry_point

The secure entry point flag, if set it means this is a KSK configuration.

Type

Bool.

Create

The default value is True.

dnsserver : Microsoft server DNS.

This structure contains DNS properties of microsoft server

address

address

MS Server ip address

Type

String.

Notes

The address cannot be updated.

address cannot be written.

enable_dns_reports_sync

enable_dns_reports_sync

Enable or Disable MS DNS data for reports from this MS Server

Type

Bool.

Create

The default value is undefined.

Notes

enable_dns_reports_sync is associated with the field use_enable_dns_reports_sync (see use flag).

enable_monitoring

enable_monitoring

Flag indicating if the DNS service is monitored and controlled

Type

Bool.

Create

The default value is undefined.

Notes

enable_monitoring is associated with the field use_enable_monitoring (see use flag).

forwarders

forwarders

Ordered list of IP addresses to forward queries to

Type

String.

Notes

The forwarders cannot be updated.

forwarders cannot be written.

last_sync_detail

last_sync_detail

Detailled status of the last synchronization attempt

Type

String.

Notes

The last_sync_detail cannot be updated.

last_sync_detail cannot be written.

last_sync_status

last_sync_status

Status of the last synchronization attempt

Type

String.

Valid values are:
  • MS_SYNC_ERROR
  • MS_SYNC_OK
  • MS_SYNC_WARNING

Notes

The last_sync_status cannot be updated.

last_sync_status cannot be written.

last_sync_ts

last_sync_ts

Timestamp of the last synchronization attempt

Type

Timestamp.

Notes

The last_sync_ts cannot be updated.

last_sync_ts cannot be written.

login_name

login_name

Microsoft Server login name

Type

String.

Create

The default value is empty.

Notes

login_name is associated with the field use_login (see use flag).

login_password

login_password

Microsoft Server login password

Type

String.

Create

The default value is undefined.

Notes

login_password is associated with the field use_login (see use flag).

login_password is not readable.

managed

managed

flag indicating if the DNS service is managed

Type

Bool.

Create

The default value is undefined.

next_sync_control

next_sync_control

Defines what control to apply on the DNS server

Type

String.

Valid values are:
  • NONE
  • START
  • STOP

Create

The default value is undefined.

status

status

Status of the Microsoft DNS Service

Type

String.

Valid values are:
  • OFFLINE
  • UNKNOWN

Notes

The status cannot be updated.

status cannot be written.

status_detail

status_detail

Detailed status of the DNS status

Type

String.

Notes

The status_detail cannot be updated.

status_detail cannot be written.

status_last_updated

status_last_updated

Timestamp of the last update

Type

Timestamp.

Notes

The status_last_updated cannot be updated.

status_last_updated cannot be written.

supports_active_directory

supports_active_directory

Flag indicating if the server supports AD integrated zones

Type

Bool.

Notes

The supports_active_directory cannot be updated.

supports_active_directory cannot be written.

supports_dnssec

supports_dnssec

Flag indicating if the server supports

Type

Bool.

Notes

The supports_dnssec cannot be updated.

supports_dnssec cannot be written.

supports_ipv6

supports_ipv6

Flag indicating if the server supports IPv6

Type

Bool.

Notes

The supports_ipv6 cannot be updated.

supports_ipv6 cannot be written.

supports_ipv6_reverse

supports_ipv6_reverse

Flag indicating if the server supports reverse IPv6 zones

Type

Bool.

Notes

The supports_ipv6_reverse cannot be updated.

supports_ipv6_reverse cannot be written.

supports_rr_dname

supports_rr_dname

Flag indicating if the server supports DNAME records

Type

Bool.

Notes

The supports_rr_dname cannot be updated.

supports_rr_dname cannot be written.

supports_rr_naptr

supports_rr_naptr

Flag indicating if the server supports NAPTR records

Type

Bool.

Notes

The supports_rr_naptr cannot be updated.

supports_rr_naptr cannot be written.

synchronization_min_delay

synchronization_min_delay

Minimum number of minutes between two synchronizations

Type

Unsigned integer.

Create

The default value is 12.

Notes

synchronization_min_delay is associated with the field use_synchronization_min_delay (see use flag).

use_enable_dns_reports_sync

use_enable_dns_reports_sync

Override enable reports data inherited from grid level

Type

Bool.

Create

The default value is False.

use_enable_monitoring

use_enable_monitoring

Override enable monitoring inherited from grid level

Type

Bool.

Create

The default value is False.

use_login

use_login

Flag to override login name and password from the MS Server

Type

Bool.

Create

The default value is undefined.

use_synchronization_min_delay

use_synchronization_min_delay

Flag to override synchronization interval from the MS Server

Type

Bool.

Create

The default value is False.

dtc:health : Health information.

The DTC Health structure contains health information of the DTC objects.

availability

availability

The availability color status.

Type

String.

Valid values are:
  • BLUE
  • GRAY
  • GREEN
  • NONE
  • RED
  • YELLOW

Create

The default value is NONE.

description

description

The textual description of the object’s status.

Type

String.

Create

The default value is Empty string.

enabled_state

enabled_state

The enabled state of the object.

Type

String.

Valid values are:
  • DISABLED
  • DISABLED_BY_PARENT
  • ENABLED
  • NONE

Create

The default value is NONE.

dtc:monitor:snmp:oid : DTC SNMP Monitor OID.

SNMP is a stateless request-response protocol for monitoring and managing devices on the network. The SNMP agent (software running on the monitored server) exposes management data in the form of variables. Each variable is associated with a unique ID called OID.

comment

comment

The comment for a DTC SNMP Health Monitor OID object.

Type

String.

Create

The default value is empty.

condition

condition

The condition of the validation result for an SNMP health check. The following conditions can be applied to the health check results:

‘ANY’ accepts any response;

‘EXACT’ accepts result equal to ‘first’;

‘LEQ’ accepts result which is less than ‘first’;

‘GEQ’ accepts result which is greater than ‘first’;

‘RANGE’ accepts result value of which is between ‘first’ and ‘last’.

Type

String.

Valid values are:
  • ANY
  • EXACT
  • GEQ
  • LEQ
  • RANGE

Create

The default value is ANY.

first

first

The condition’s first term to match against the SNMP health check result.

Type

String.

Create

The default value is empty.

last

last

The condition’s second term to match against the SNMP health check result with ‘RANGE’ condition.

Type

String.

Create

The default value is empty.

oid

oid

The SNMP OID value for DTC SNMP Monitor health checks.

Type

String.

Create

The field is required on creation.

type

type

The value of the condition type for DTC SNMP Monitor health check results.

Type

String.

Valid values are:
  • INTEGER
  • STRING

Create

The default value is STRING.

dtc:pool:consolidated_monitor_health : Consolidated monitor health structure.

availability

availability

Servers assigned to a pool with monitor defined are healthy if ANY or ALL members report healthy status.

Type

String.

Valid values are:
  • ALL
  • ANY

Create

The field is required on creation.

members

members

Members whose monitor statuses are shared across other members in a pool.

Type

String array.

Create

The default value is empty.

monitor

monitor

Monitor whose statuses are shared across other members in a pool.

Type

String.

This field supports nested return fields as described here.

Create

The field is required on creation.

dtc:query:result : Query records.

The structure contains result of a query call.

rdata

rdata

DNS record data. Address for A or AAAA and name for CNAME.

Type

String.

Notes

The rdata cannot be updated.

rdata cannot be written.

ttl

ttl

The Time To Live (TTL) value for which the zone is valid or being cached. The 32-bit unsigned integer represents the duration in seconds. Zero indicates that the zone should not be cached.

Type

Unsigned integer.

Notes

The ttl cannot be updated.

ttl cannot be written.

type

type

DNS type of a record.

Type

String.

Valid values are:
  • A
  • AAAA
  • CNAME
  • NAPTR
  • SRV

Notes

The type cannot be updated.

type cannot be written.

use_ttl

use_ttl

Determines whether the zone TTL is overridden or not.

Type

Bool.

Notes

The use_ttl cannot be updated.

use_ttl cannot be written.

dtc:server:monitor : DTC Server Monitor.

This structure used to link DTC server with specific DTC Monitor.

host

host

IP address or FQDN of the server used for monitoring.

Type

String.

Create

The default value is empty.

monitor

monitor

The monitor related to server.

Type

String.

This field supports nested return fields as described here.

Create

The default value is empty.

dtc:topology:rule:source : DTC topology rule source.

The structure contains information about DTC topology rule source.

source_op

source_op

The operation used to match the value.

Type

String.

Valid values are:
  • IS
  • IS_NOT

Create

The default value is undefined.

source_type

source_type

The source type.

Type

String.

Valid values are:
  • CITY
  • CONTINENT
  • COUNTRY
  • EA0
  • EA1
  • EA2
  • EA3
  • SUBDIVISION
  • SUBNET

Create

The field is required on creation.

source_value

source_value

The source value.

Type

String.

Create

The field is required on creation.

dxl:endpoint:broker : The Data Exchange Layer endpoint broker structure.

DXL brokers are installed on managed systems for routing messages between connected clients. The broker networks track active consumers and dynamically adjust the message routing as needed. When a client requests a service or when an update is broadcasted, the brokers relay these messages.

The DXL endpoint broker structure is used to configure DXL broker settings for a particular DXL endpoint.

address

address

The IPv4 Address or IPv6 Address for the DXL endpoint broker.

Type

String.

Create

The default value is empty.

host_name

host_name

The FQDN for the DXL endpoint broker.

Type

String.

Create

The field is required on creation.

port

port

The communication port for the DXL endpoint broker.

Type

Unsigned integer.

Create

The default value is 8883.

unique_id

unique_id

The unique identifier for the DXL endpoint.

Type

String.

Create

The default value is empty.

eaexpressionop : Extensible attribute expression operand.

The extensible attribute expression operand structure is used to build an extensible attribute expression lists. The allowed values for the expression operand structure depend on the object they appear to be a part of.

op

op

The operation name.

Type

String.

Valid values are:
  • AND
  • ENDLIST
  • EQ
  • EXISTS
  • GE
  • GT
  • LE
  • LT
  • MATCH_CIDR
  • MATCH_IP
  • MATCH_RANGE
  • NOT_EQ
  • NOT_EXISTS
  • OR

Create

The field is required on creation.

op1

op1

The name of the Extensible Attribute Definition object which is used as the first operand value.

Type

String.

Create

The default value is undefined.

op1_type

op1_type

The first operand type.

Type

String.

Valid values are:
  • FIELD
  • LIST
  • STRING

Create

The default value is undefined.

op2

op2

The second operand value.

Type

String.

Create

The default value is undefined.

op2_type

op2_type

The second operand type.

Type

String.

Valid values are:
  • FIELD
  • LIST
  • STRING

Create

The default value is undefined.

exclusionrange : Exclusion range.

These are ranges of IP addresses that the appliance does not use to assign to clients. You can use these exclusion addresses as static IP addresses. They contain the start and end addresses of the exclusion range, and optionally, information about this exclusion range.

comment

comment

Comment for the exclusion range; maximum 256 characters.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

end_address

end_address

The IPv4 Address ending address of the exclusion range.

Type

String.

Create

The field is required on creation.

start_address

start_address

The IPv4 Address starting address of the exclusion range.

Type

String.

Create

The field is required on creation.

exclusionrangetemplate : Exclusion range template.

The DHCP exclusion range template describes the range of IP addresses that can be excluded in an address range template. If static IP addresses are assigned to certain hosts in the middle of an address range, those addresses can be excluded from the address range so the DHCP server does not assign those IP addresses to the clients.

comment

comment

A descriptive comment of a DHCP exclusion range template.

Type

String.

Create

The default value is empty.

number_of_addresses

number_of_addresses

The number of addresses in the DHCP exclusion range template.

Type

Unsigned integer.

Create

The field is required on creation.

offset

offset

The address offset of the DHCP exclusion range template.

Type

Unsigned integer.

Create

The field is required on creation.

expressionop : Expression operand.

The expression operand structure is used to build expression lists. The allowed values for the expression operand structure depend on the object they appear to be a part of.

op

op

The operation name.

Type

String.

Valid values are:
  • AND
  • ENDLIST
  • EQ
  • EXISTS
  • GE
  • GT
  • LE
  • LT
  • MATCH_CIDR
  • MATCH_IP
  • MATCH_RANGE
  • NOT_EQ
  • NOT_EXISTS
  • OR

Create

The field is required on creation.

op1

op1

The first operand value.

Type

String.

Create

The default value is undefined.

op1_type

op1_type

The first operand type.

Type

String.

Valid values are:
  • FIELD
  • LIST
  • STRING

Create

The default value is undefined.

op2

op2

The second operand value.

Type

String.

Create

The default value is undefined.

op2_type

op2_type

The second operand type.

Type

String.

Valid values are:
  • FIELD
  • LIST
  • STRING

Create

The default value is undefined.

extensibleattributedef:descendants : Descendants.

The structure describes what to do with descendant’s extensible attribute, if the value is different from the parent’s.

There are three possible cases, for each of them there is a specific option in the structure.

option_delete_ea

option_delete_ea

This option describes which action must be taken if the extensible attribute exists for the descendant, but is absent for the parent object:

  • RETAIN: retain the extensible attribute value for the descendant object.
  • REMOVE: remove this extensible attribute from the descendant object.

Type

String.

Valid values are:
  • REMOVE
  • RETAIN

Create

The default value is undefined.

option_with_ea

option_with_ea

This option describes which action must be taken if the extensible attribute exists for both the parent and descendant objects:

  • INHERIT: inherit the extensible attribute from the parent object.
  • RETAIN: retain the value of an extensible attribute that was set for the child object.
  • CONVERT: the value of the extensible attribute must be copied from the parent object.

Type

String.

Valid values are:
  • CONVERT
  • INHERIT
  • RETAIN

Create

The default value is undefined.

option_without_ea

option_without_ea

This option describes which action must be taken if the extensible attribute exists for the parent, but is absent from the descendant object:

  • INHERIT: inherit the extensible attribute from the parent object.
  • NOT_INHERIT: do nothing.

Type

String.

Valid values are:
  • INHERIT
  • NOT_INHERIT

Create

The default value is undefined.

extensibleattributedef:listvalues : List of values.

The structure contains the list of extensible attribute values.

value

value

Enum value

Type

String.

Create

The default value is undefined.

extserver : External Server.

This struct represents an external DNS server.

address

address

The IPv4 Address or IPv6 Address of the server.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

Notes

The address is part of the base object.

name

name

A resolvable domain name for the external DNS server.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

Notes

The name is part of the base object.

shared_with_ms_parent_delegation

shared_with_ms_parent_delegation

This flag represents whether the name server is shared with the parent Microsoft primary zone’s delegation server.

Type

Bool.

Notes

The shared_with_ms_parent_delegation cannot be updated.

shared_with_ms_parent_delegation cannot be written.

stealth

stealth

Set this flag to hide the NS record for the primary name server from DNS queries.

Type

Bool.

Create

The default value is False.

tsig_key

tsig_key

A generated TSIG key.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

tsig_key_alg

tsig_key_alg

The TSIG key algorithm.

Type

String.

Valid values are:
  • HMAC-MD5
  • HMAC-SHA256

Create

The default value is HMAC-MD5.

tsig_key_name

tsig_key_name

The TSIG key name.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

Notes

tsig_key_name is associated with the field use_tsig_key_name (see use flag).

use_tsig_key_name

use_tsig_key_name

Use flag for: tsig_key_name

Type

Bool.

Create

The default value is False.

extsyslogbackupserver : External syslog backup server.

This structure contains information about the external server for backing up the rotated syslog files.

address

address

The IPv4 or IPv6 address of the backup syslog server.

Type

String.

Create

The field is required on creation.

directory_path

directory_path

The directory path for the replication of the rotated syslog files.

Type

String.

Create

The default value is undefined.

enable

enable

If set to True, the syslog backup server is enabled.

Type

Bool.

Create

The default value is True.

password

password

The password of the backup syslog server.

Type

String.

Create

The default value is undefined.

Notes

password is not readable.

port

port

The port used to connect to the backup syslog server.

Type

Unsigned integer.

Create

The default value is 22.

protocol

protocol

The transport protocol used to connect to the backup syslog server.

Type

String.

Valid values are:
  • FTP
  • SCP

Create

The default value is SCP.

username

username

The username of the backup syslog server.

Type

String.

Create

The default value is undefined.

filetransfersetting : File Transfer Setting.

This struct provides information and configuration for captured DNS traffic transfer to a remote server.

directory

directory

The directory to save the captured DNS queries and responses.

Type

String.

Create

The default value is empty.

host

host

The host name of the destination server for DNS capture transfer.

Type

String.

Create

The default value is empty.

password

password

The password to access the destination server directory.

Type

String.

Create

The default value is undefined.

Notes

password is not readable.

port

port

Transfer scp port.

Type

Unsigned integer.

Create

The default value is 22.

type

type

The transfer protocol for the captured DNS queries and responses.

Type

String.

Valid values are:
  • FTP
  • NONE
  • SCP

Create

The default value is FTP.

username

username

The username to access the destination server directory.

Type

String.

Create

The default value is empty.

filterrule : Filter rule.

This structure references defined DHCP filters.

filter

filter

The name of the DHCP filter.

Type

String.

Create

The field is required on creation.

permission

permission

The permission to be applied.

Type

String.

Valid values are:
  • Allow
  • Deny

Create

The field is required on creation.

fireeye:alertmap : FireEye Alert Map.

The FireEye Alert Map used to configure FireEye alerts to Response Policy Zone rules.

alert_type

alert_type

The type of Fireeye Alert.

Type

String.

Valid values are:
  • DOMAIN_MATCH
  • INFECTION_MATCH
  • MALWARE_CALLBACK
  • MALWARE_OBJECT
  • WEB_INFECTION

Create

The field is required on creation.

lifetime

lifetime

The expiration Lifetime of alert type. The 32-bit unsigned integer represents the amount of seconds this alert type will live for. 0 means the alert will never expire.

Type

Unsigned integer.

Create

The field is required on creation.

rpz_rule

rpz_rule

The RPZ rule for the alert.

Type

String.

Valid values are:
  • NODATA
  • NONE
  • NXDOMAIN
  • PASSTHRU
  • SUBSTITUTE

Create

The field is required on creation.

fireeye:rulemapping : Fireeye Rule Mapping.

The FireEye Rule Mapping used to configure rule mapping for FireEye devices and Response Policy Zones.

apt_override

apt_override

The override setting for APT alerts.

Type

String.

Valid values are:
  • NODATA
  • NOOVERRIDE
  • NXDOMAIN
  • PASSTHRU
  • SUBSTITUTE

Create

The default value is undefined.

fireeye_alert_mapping

fireeye_alert_mapping

The FireEye alert mapping.

Type

A/An FireEye Alert Map struct array.

Create

The default value is undefined.

substituted_domain_name

substituted_domain_name

The domain name to be substituted, this is applicable only when apt_override is set to “SUBSTITUTE”.

Type

String.

Create

The default value is undefined.

forwardingmemberserver : Forwarding Member Server.

This struct contains per-Grid-member forwarding configuration.

forward_to

forward_to

The information for the remote name server to which you want the Infoblox appliance to forward queries for a specified domain name.

Type

A/An External Server struct array.

Create

The default value is:

empty

Notes

forward_to is associated with the field use_override_forwarders (see use flag).

forwarders_only

forwarders_only

Determines if the appliance sends queries to forwarders only, and not to other internal or Internet root servers.

Type

Bool.

Create

The default value is False.

name

name

The name of this Grid member in FQDN format.

Type

String.

Create

The field is required on creation.

use_override_forwarders

use_override_forwarders

Use flag for: forward_to

Type

Bool.

Create

The default value is False.

grid:attackdetect : DNS attack detection settings.

This structure provides information about DNS attack detection settings.

enable

enable

Determines if DNS attack detection is enabled or not.

Type

Bool.

Create

The default value is True.

high

high

The high threshold value (in percentage) for starting DNS attack detection.

Type

Unsigned integer.

Create

The default value is empty.

interval_max

interval_max

The maximum number of events that have occurred before processing DNS attack detection.

Type

Unsigned integer.

Create

The default value is undefined.

interval_min

interval_min

The minimum number of events that have occurred before processing DNS attack detection.

Type

Unsigned integer.

Create

The default value is empty.

interval_time

interval_time

The time interval between detection processing.

Type

Unsigned integer.

Create

The default value is empty.

low

low

The low threshold value (in percentage) for starting DNS attack detection.

Type

Unsigned integer.

Create

The default value is empty.

grid:attackmitigation : DNS Attack Mitigation object.

The DNS Attack Mitigation structure provides information about mitigation configuration for DNS attacks.

detect_chr

detect_chr

Configuration for detecting changes for the Cache Hit Ratio (CHR) of recursive queries.

Type

A/An DNS attack detection settings struct.

Create

The default value is:

  { 'enable': True,
'high': 80,
'interval_max': 100000,
'interval_min': 1000,
'interval_time': 10,
'low': 70}

detect_chr_grace

detect_chr_grace

The cache utilization (in percentage) when Cache Hit Ratio (CHR) starts.

Type

Unsigned integer.

Create

The default value is 75.

detect_nxdomain_responses

detect_nxdomain_responses

Configuration for detecting NXDOMAIN responses from up-stream servers to all incoming recursive responses.

Type

A/An DNS attack detection settings struct.

Create

The default value is:

  { 'enable': True,
'high': 80,
'interval_max': 100000,
'interval_min': 1000,
'interval_time': 10,
'low': 70}

detect_udp_drop

detect_udp_drop

Configuration for detecting the UDP packet drop rate.

Type

A/An DNS attack detection settings struct.

Create

The default value is:

  { 'enable': True,
'high': 30,
'interval_min': 1000,
'interval_time': 10,
'low': 20}

interval

interval

The minimum time interval (in seconds) between changes in attack status.

Type

Unsigned integer.

Create

The default value is 10.

mitigate_nxdomain_lru

mitigate_nxdomain_lru

Enable or disable the mitigation of possible NXDOMAIN attacks by splitting the Lease Recently Used (LRU) list into NX (non-existent) RRsets and all other RRsets, and by removing the least recently used items from the LRU list for NX RRsets before removing items for other RRsets.

Type

Bool.

Create

The default value is False.

grid:autoblackhole : DNS Auto Blackhole settings.

The DNS Auto Blackhole provides information about DNS auto blackhole configuration.

enable_fetches_per_server

enable_fetches_per_server

Enables or disables the configuration of the maximum number of concurrent recursive queries the appliance sends to each upstream DNS server.

Type

Bool.

Create

The default value is False.

enable_fetches_per_zone

enable_fetches_per_zone

Enables or disables the configuration of the maximum number of concurrent recursive queries the appliance sends to each DNS zone.

Type

Bool.

Create

The default value is False.

enable_holddown

enable_holddown

Enables or disables the holddown configuration when the appliance stops sending queries to non-responsive servers.

Type

Bool.

Create

The default value is False.

fetches_per_server

fetches_per_server

The maximum number of concurrent recursive queries the appliance sends to a single upstream name server before blocking additional queries to that server.

Type

Unsigned integer.

Create

The default value is 500.

fetches_per_zone

fetches_per_zone

The maximum number of concurrent recursive queries that a server sends for its domains.

Type

Unsigned integer.

Create

The default value is 200.

fps_freq

fps_freq

Determines how often (in number of recursive responses) the appliance recalculates the average timeout ratio for each DNS server.

Type

Unsigned integer.

Create

The default value is 200.

holddown

holddown

The holddown duration for non-responsive servers.

Type

Unsigned integer.

Create

The default value is 60.

holddown_threshold

holddown_threshold

The number of consecutive timeouts before holding down a non-responsive server.

Type

Unsigned integer.

Create

The default value is 5.

holddown_timeout

holddown_timeout

The minimum time (in seconds) that needs to be passed before a timeout occurs. Note that only these timeouts are counted towards the number of consecutive timeouts.

Type

Unsigned integer.

Create

The default value is 1000.

grid:cloudapi:gateway:config : Gateway config.

Structure containing all the information related to Gateway configuration.

enable_proxy_service

enable_proxy_service

Enable Gateway Service.

Type

Bool.

Create

The default value is undefined.

endpoint_mapping

endpoint_mapping

List of Gateway FQDN to AWS Endpoint Mapping.

Type

A/An Endpoint mapping struct array.

Create

The default value is undefined.

port

port

Gateway port

Type

Unsigned integer.

Create

The default value is undefined.

grid:cloudapi:gateway:endpointmapping : Endpoint mapping.

Structure defining an entry in the mapping table of Gateway to AWS endpoint.

endpoint_fqdn

endpoint_fqdn

Endpoint FQDN.

Type

String.

Create

The default value is undefined.

gateway_fqdn

gateway_fqdn

Gateway FQDN.

Type

String.

Create

The default value is undefined.

grid:cloudapi:info : Cloud Information.

The structure aggregates all information related to Cloud objects.

authority_type

authority_type

Type of authority over the object.

Type

String.

Valid values are:
  • CP
  • GM
  • NONE

Notes

The authority_type cannot be updated.

authority_type cannot be written.

delegated_member

delegated_member

The Cloud Platform Appliance to which authority of the object is delegated.

Type

A/An Grid member serving DHCP struct.

Create

The default value is undefined.

Notes

The delegated_member is part of the base object.

delegated_root

delegated_root

Indicates the root of the delegation if delegated_scope is SUBTREE or RECLAIMING. This is not set otherwise.

Type

String.

Notes

The delegated_root cannot be updated.

delegated_root cannot be written.

delegated_scope

delegated_scope

Indicates the scope of delegation for the object. This can be one of the following: NONE (outside any delegation), ROOT (the delegation point), SUBTREE (within the scope of a delegation), RECLAIMING (within the scope of a delegation being reclaimed, either as the delegation point or in the subtree).

Type

String.

Valid values are:
  • NONE
  • RECLAIMING
  • ROOT
  • SUBTREE

Notes

The delegated_scope is part of the base object.

The delegated_scope cannot be updated.

delegated_scope cannot be written.

mgmt_platform

mgmt_platform

Indicates the specified cloud management platform.

Type

String.

Notes

The mgmt_platform cannot be updated.

mgmt_platform cannot be written.

owned_by_adaptor

owned_by_adaptor

Determines whether the object was created by the cloud adapter or not.

Type

Bool.

Notes

The owned_by_adaptor cannot be updated.

owned_by_adaptor cannot be written.

tenant

tenant

Reference to the tenant object associated with the object, if any.

Type

String.

This field supports nested return fields as described here.

Notes

The tenant cannot be updated.

tenant cannot be written.

usage

usage

Indicates the cloud origin of the object.

Type

String.

Valid values are:
  • ADAPTER
  • DELEGATED
  • NONE
  • USED_BY

Notes

The usage is part of the base object.

The usage cannot be updated.

usage cannot be written.

grid:cloudapi:user : Cloud user.

This object represents Cloud grid user.

is_remote

is_remote

Determines whether this is a remote admin user.

Type

Bool.

Create

The default value is undefined.

Notes

The is_remote is part of the base object.

local_admin

local_admin

Local administrator who can perform cloud API requests on the Cloud Platform Appliance.

Type

String.

This field supports nested return fields as described here.

Create

The default value is undefined.

Notes

The local_admin is part of the base object.

remote_admin

remote_admin

Username that matches a remote administrator who can perform cloud API requests on the Cloud Platform Appliance.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is undefined.

grid:cspapiconfig : Csp Api config.

This structure contains a csp api config.

password

password

The password for the CspApiConfig.

Type

String.

Create

The default value is empty.

Notes

The password cannot be updated.

password is not readable.

url

url

The url for the CspApiConfig.

Type

String.

Notes

The url cannot be updated.

url cannot be written.

username

username

The user name for the CspApiConfig.

Type

String.

Create

The default value is empty.

Notes

The username cannot be updated.

grid:dns:fixedrrsetorderfqdn : Fixed RRset order FQDN.

A fixed RRset order FQDN contains information about the fixed RRset configuration items.

fqdn

fqdn

The FQDN of the fixed RRset configuration item.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

record_type

record_type

The record type for the specified FQDN in the fixed RRset configuration.

Type

String.

Valid values are:
  • A
  • AAAA
  • BOTH

Create

The default value is A.

grid:informationalbannersetting : Informational level banner setting.

This structure contains configuration for informational banner. The informational banner can be published for multiple uses, such as to indicate whether the Infoblox Grid is in production or a lab system. The banner can also be used for issuing messages of the day. The informational level banner appears on the header of the Grid Manager screen.

color

color

The color for the informational level banner.

Type

String.

Valid values are:
  • BLACK
  • BLUE
  • BROWN
  • CYAN
  • GREEN
  • MAGENTA
  • ORANGE
  • PURPLE
  • RED
  • YELLOW

Create

The default value is GREEN.

enable

enable

Determines whether the display of the informational level banner is enabled.

Type

Bool.

Create

The default value is True.

message

message

The message included in the informational level banner.

Type

String.

Create

The default value is empty.

grid:licensesubpool : Licese sub-pool settings.

expiry_date

expiry_date

License expiration date.

Type

Timestamp.

Notes

The expiry_date cannot be updated.

expiry_date cannot be written.

installed

installed

The total number of dynamic licenses allowed for this license subpool.

Type

Unsigned integer.

Notes

The installed cannot be updated.

installed cannot be written.

key

key

The license string for the license subpool.

Type

String.

Notes

The key cannot be updated.

key cannot be written.

grid:lockoutsetting : Lockout Security Setting

Structure specify security lockout setting.

enable_sequential_failed_login_attempts_lockout

enable_sequential_failed_login_attempts_lockout

Enable/disable sequential failed login attempts lockout for local users

Type

Bool.

Create

The default value is False.

failed_lockout_duration

failed_lockout_duration

Time period the account remains locked after sequential failed login attempt lockout.

Type

Unsigned integer.

Create

The default value is 5.

never_unlock_user

never_unlock_user

Never unlock option is also provided and if set then user account is locked forever and only super user can unlock this account

Type

Bool.

Create

The default value is False.

sequential_attempts

sequential_attempts

The number of failed login attempts

Type

Unsigned integer.

Create

The default value is 5.

grid:loggingcategories : Grid logging setting information.

The logging categories. It is possible to specify several BIND logging message categories to be captured by syslog.

log_client

log_client

Determines whether the client requests are captured or not.

Type

Bool.

Create

The default value is undefined.

log_config

log_config

Determines whether the configuration file parsing is captured or not.

Type

Bool.

Create

The default value is undefined.

log_database

log_database

Determines whether the BIND’s internal database processes are captured or not.

Type

Bool.

Create

The default value is undefined.

log_dnssec

log_dnssec

Determines whether the DNSSEC-signed responses are captured or not.

Type

Bool.

Create

The default value is undefined.

log_dtc_gslb

log_dtc_gslb

Determines whether the DTC GSLB activity is captured or not.

Type

Bool.

Create

The default value is undefined.

log_dtc_health

log_dtc_health

Determines whether the DTC health monitoring information is captured or not.

Type

Bool.

Create

The default value is undefined.

log_general

log_general

Determines whether the BIND messages that are not specifically classified are captured or not.

Type

Bool.

Create

The default value is undefined.

log_lame_servers

log_lame_servers

Determines whether the bad delegation instances are captured or not.

Type

Bool.

Create

The default value is undefined.

log_network

log_network

Determines whether the network operation messages are captured or not.

Type

Bool.

Create

The default value is undefined.

log_notify

log_notify

Determines whether the asynchronous zone change notification messages are captured or not.

Type

Bool.

Create

The default value is undefined.

log_queries

log_queries

Determines whether the query messages are captured or not.

Type

Bool.

Create

The default value is undefined.

log_query_rewrite

log_query_rewrite

Determines whether the query rewrite messages are captured or not.

Type

Bool.

Create

The default value is undefined.

log_rate_limit

log_rate_limit

Determines whether the rate limit messages are captured or not.

Type

Bool.

Create

The default value is undefined.

log_resolver

log_resolver

Determines whether the DNS resolution instances, including recursive queries from resolvers are captured or not.

Type

Bool.

Create

The default value is undefined.

log_responses

log_responses

Determines whether the response messages are captured or not.

Type

Bool.

Create

The default value is undefined.

log_rpz

log_rpz

Determines whether the Response Policy Zone messages are captured or not.

Type

Bool.

Create

The default value is undefined.

log_security

log_security

Determines whether the approved and denied requests are captured or not.

Type

Bool.

Create

The default value is undefined.

log_update

log_update

Determines whether the dynamic update instances are captured or not.

Type

Bool.

Create

The default value is undefined.

log_update_security

log_update_security

Determines whether the security update messages are captured or not.

Type

Bool.

Create

The default value is undefined.

log_xfer_in

log_xfer_in

Determines whether the zone transfer messages from the remote name servers to the appliance are captured or not.

Type

Bool.

Create

The default value is undefined.

log_xfer_out

log_xfer_out

Determines whether the zone transfer messages from the Infoblox appliance to remote name servers are captured or not.

Type

Bool.

Create

The default value is undefined.

grid:ntp : The Grid Network Time Protocol (NTP) settings structure.

The Grid NTP settings structure is used to control the NTP synchronization of the date and time for all Infoblox appliances.

enable_ntp

enable_ntp

Determines whether NTP is enabled on the Grid.

Type

Bool.

Create

The default value is False.

ntp_acl

ntp_acl

The NTP access control settings.

Type

A/An The Network Time Protocol (NTP) access control setting struct.

Create

The default value is:

{ 'ac_list': [], 'acl_type': 'NONE', 'service': 'TIME'}

ntp_keys

ntp_keys

The list of NTP authentication keys used to authenticate NTP clients.

Type

A/An The Network Time Protocol (NTP) authentication key structure struct array.

Create

The default value is:

empty

ntp_kod

ntp_kod

Determines whether the Kiss-o’-Death packets are enabled.

Type

Bool.

Create

The default value is False.

ntp_servers

ntp_servers

The list of NTP servers configured on a Grid.

Type

A/An The Network Time Protocol (NTP) server structure struct array.

Create

The default value is:

empty

grid:responseratelimiting : DNS Response Rate Limiting.

The DNS Response Rate Limiting structure provides information about DNS response rate limiting configuration.

enable_rrl

enable_rrl

Determines if the response rate limiting is enabled or not.

Type

Bool.

Create

The default value is False.

log_only

log_only

Determines if logging for response rate limiting without dropping any requests is enabled or not.

Type

Bool.

Create

The default value is False.

responses_per_second

responses_per_second

The number of responses per client per second.

Type

Unsigned integer.

Create

The default value is 100.

slip

slip

The response rate limiting slip. Note that if slip is not equal to 0 every n-th rate-limited UDP request is sent a truncated response instead of being dropped.

Type

Unsigned integer.

Create

The default value is 2.

window

window

The time interval in seconds over which responses are tracked.

Type

Unsigned integer.

Create

The default value is 15.

grid:restartbannersetting : Restart Banner Setting.

This structure contains information about the Restart Banner.

enable_double_confirmation

enable_double_confirmation

If set to True, the user is required to input name before restarting the services.

Type

Bool.

Create

The default value is False.

enabled

enabled

If set to True, the restart banner is enabled.

Type

Bool.

Create

The default value is True.

grid:servicerestart : Restart Setting.

The restart setting at the Grid level.

delay

delay

The time duration to delay a restart for a restart group.

Type

Unsigned integer.

Create

The default value is 10.

restart_offline

restart_offline

Determines whether the Grid should try to restart offline member.

Type

Bool.

Create

The default value is True.

timeout

timeout

The duration of timeout for a restart group. The value “-1” means infinite.

Type

Integer.

Create

The default value is 60.

grid:servicerestart:group:schedule : Restart Group Schedule.

This struct contains information about Restart Group scheduling settings.

force

force

Determines if the Restart Group should have a force restart.

Type

Bool.

Create

The default value is False.

mode

mode

The restart method for a Grid restart.

Type

String.

Valid values are:
  • GROUPED
  • SEQUENTIAL
  • SIMULTANEOUS

Create

The default value is empty.

schedule

schedule

The Schedule Setting struct that determines the schedule for the restart.

Type

A/An Schedule Setting struct.

Create

The field is required on creation.

services

services

The list of applicable services for the restart.

Type

Enum values array.

Valid values are:
  • ALL
  • DHCP
  • DHCPV4
  • DHCPV6
  • DNS

Create

The default value is ALL.

gridmember_soamname : Per-master SOA MNAME Information.

This struct contains the SOA MNAME and the primary server for this zone.

dns_mname

dns_mname

Master’s SOA MNAME in punycode format.

Type

String.

Notes

The dns_mname cannot be updated.

dns_mname cannot be written.

grid_primary

grid_primary

The grid primary server for the zone. Only one of “grid_primary” or “ms_server_primary” should be set when modifying or creating the object.

Type

String.

Create

The default value is undefined.

Notes

The grid_primary is part of the base object.

mname

mname

Master’s SOA MNAME. This value can be in unicode format.

Type

String.

Create

The default value is undefined.

Notes

The mname is part of the base object.

ms_server_primary

ms_server_primary

The primary MS server for the zone. Only one of “grid_primary” or “ms_server_primary” should be set when modifying or creating the object.

Type

String.

Create

The default value is undefined.

Notes

The ms_server_primary is part of the base object.

gridmember_soaserial : Per-master SOA Serial Information.

This struct contains the SOA serial number and the primary server for this zone.

grid_primary

grid_primary

The grid primary server for the zone. Only one of “grid_primary” or “ms_server_primary” will be set when the object is retrieved from the server.

Type

String.

Notes

The grid_primary cannot be updated.

grid_primary cannot be written.

ms_server_primary

ms_server_primary

The primary MS server for the zone. Only one of “grid_primary” or “ms_server_primary” will be set when the object is retrieved from the server.

Type

String.

Notes

The ms_server_primary cannot be updated.

ms_server_primary cannot be written.

serial

serial

The SOA serial number.

Type

Unsigned integer.

Notes

The serial cannot be updated.

serial cannot be written.

hotfix : Upgrade process hotfix.

The structure provides information about the status of upgrade process hotfixes.

status_text

status_text

The status text of the hotfix.

Type

String.

Create

The default value is undefined.

unique_id

unique_id

Unique ID of the hotfix.

Type

String.

Create

The default value is undefined.

hsm:safenet : SafeNet Hardware Security Module.

The Harware Security Module (HSM) SafeNet structure represents the HSM SafeNet device configuration.

disable

disable

Determines whether the HSM SafeNet device is disabled.

Type

Bool.

Create

The default value is False.

is_fips_compliant

is_fips_compliant

Determines whether the HSM SafeNet device is FIPS compliant.

Type

Bool.

Notes

The is_fips_compliant cannot be updated.

is_fips_compliant cannot be written.

name

name

The HSM SafeNet device IPv4 Address or FQDN.

Type

String.

Create

The field is required on creation.

partition_capacity

partition_capacity

The HSM SafeNet device partition capacity percentage used.

Type

Unsigned integer.

Notes

The partition_capacity cannot be updated.

partition_capacity cannot be written.

partition_id

partition_id

Partition ID that is displayed after the appliance has successfully connected to the HSM SafeNet device.

Type

String.

Notes

The partition_id cannot be updated.

partition_id cannot be written.

partition_serial_number

partition_serial_number

The HSM SafeNet device partition serial number (PSN).

Type

String.

Create

The field is required on creation.

server_cert

server_cert

The token returned by the uploadinit function call in object fileop for a SafeNet HSM device certificate.

Type

String.

Create

The default value is undefined.

Notes

server_cert is not readable.

status

status

The HSM SafeNet device status.

Type

String.

Valid values are:
  • DOWN
  • UP

Notes

The status cannot be updated.

status cannot be written.

hsm:thales : Thales Hardware Security Module.

The Thales Hardware Security Module (HSM) structure represents the Thales HSM device configuration.

disable

disable

Determines whether the Thales HSM device is disabled.

Type

Bool.

Create

The default value is False.

keyhash

keyhash

The Thales HSM device public key digest.

Type

String.

Create

The default value is empty.

remote_esn

remote_esn

The Thales HSM device electronic serial number.

Type

String.

Notes

The remote_esn cannot be updated.

remote_esn cannot be written.

remote_ip

remote_ip

The IPv4 Address of the Thales HSM device.

Type

String.

Create

The field is required on creation.

remote_port

remote_port

The Thales HSM device destination port.

Type

Unsigned integer.

Create

The default value is 9004.

status

status

The Thales HSM device status.

Type

String.

Valid values are:
  • DOWN
  • UP

Notes

The status cannot be updated.

status cannot be written.

interface : IPv6/IPv4 interfaces settings.

The interface settings represent additional interface information that can be used for a Grid member. A single IP address may be added to each member by using these settings.

anycast

anycast

Determines if anycast for the Interface object is enabled or not.

Type

Bool.

Create

The default value is False.

comment

comment

A descriptive comment of this structure.

Type

String.

Create

The default value is empty.

enable_bgp

enable_bgp

Determines if the BGP advertisement setting is enabled for this interface or not.

Type

Bool.

Create

The default value is False.

enable_ospf

enable_ospf

Determines if the OSPF advertisement setting is enabled for this interface or not.

Type

Bool.

Create

The default value is False.

interface

interface

The interface type for the Interface object.

Type

String.

Valid values are:
  • LAN2
  • LAN_HA
  • LOOPBACK
  • MGMT

Create

The default value is LOOPBACK.

ipv4_network_setting

ipv4_network_setting

The IPv4 network settings of the Grid Member.

Type

A/An Network settings struct.

Create

You must create the IPv4 settings field if the IPv6 settings are missing.

ipv6_network_setting

ipv6_network_setting

The IPv6 network settings of the Grid Member.

Type

A/An IPv6 Settings struct.

Create

You must create the IPv6 settings field if the IPv4 settings are missing.

ipv6networksetting : IPv6 Network Settings.

Used for ipv6 static routes object.

address

address

IPv6 address.

Type

String.

Create

The default value is undefined.

cidr

cidr

IPv6 CIDR

Type

Unsigned integer.

Create

The default value is undefined.

gateway

gateway

Gateway address.

Type

String.

Create

The default value is undefined.

ipv6setting : IPv6 Settings.

The structure contains IPv6 settings for a member.

auto_router_config_enabled

auto_router_config_enabled

Determines if automatic router configuration should be enabled.

Type

Bool.

Create

The default value is undefined.

cidr_prefix

cidr_prefix

IPv6 cidr prefix

Type

Unsigned integer.

Create

The default value is undefined.

dscp

dscp

The DSCP (Differentiated Services Code Point) value determines relative priorities for the type of services on your network. The appliance implements QoS (Quality of Service) rules based on this configuration. Valid values are from 0 to 63.

Type

Unsigned integer.

Create

The default value is 0.

Notes

dscp is associated with the field use_dscp (see use flag).

enabled

enabled

Determines if IPv6 networking should be enabled.

Type

Bool.

Create

The default value is undefined.

gateway

gateway

Gateway address.

Type

String.

Create

The default value is undefined.

primary

primary

Determines if the current address is the primary VLAN address or not.

Type

Bool.

Create

The default value is True.

use_dscp

use_dscp

Use flag for: dscp

Type

Bool.

Create

The default value is False.

virtual_ip

virtual_ip

IPv6 address.

Type

String.

Create

The default value is undefined.

vlan_id

vlan_id

The identifier for the VLAN. Valid values are from 1 to 4096.

Type

Unsigned integer.

Create

The default value is empty.

lan2portsetting : LAN2 Port Setting.

Settings used to configure IP parameters for the LAN2 port.

enabled

enabled

If this field is set to True, then it has its own IP settings. Otherwise, port redundancy mechanism is used, in which the LAN1 and LAN2 ports share the same IP settings for failover purposes.

Type

Bool.

Create

The default value is False.

network_setting

network_setting

If the ‘enable’ field is set to True, this defines IPv4 network settings for LAN2.

Type

A/An Network settings struct.

Create

The default value is:

{ }

nic_failover_enable_primary

nic_failover_enable_primary

Prefer LAN1 when available.

Type

Bool.

Create

The default value is False.

nic_failover_enabled

nic_failover_enabled

Determines if NIC failover is enabled or not.

Type

Bool.

Create

The default value is False.

v6_network_setting

v6_network_setting

If the ‘enable’ field is set to True, this defines IPv6 network settings for the LAN2 port.

Type

A/An IPv6 Settings struct.

Create

The default value is:

{ }

virtual_router_id

virtual_router_id

If the ‘enabled’ field is set to True, this defines the virtual router ID for the LAN2 port.

Type

Unsigned integer.

Create

The default value is undefined.

lanhaportsetting : LAN/HA Port Settings.

This structure contains LAN/HA port settings for the HA node.

ha_ip_address

ha_ip_address

HA IP address.

Type

String.

Create

The default value is undefined.

ha_port_setting

ha_port_setting

Physical port settings for the HA interface.

Type

A/An Physical Port Settings struct.

Create

The default value is undefined.

lan_port_setting

lan_port_setting

Physical port settings for the LAN interface.

Type

A/An Physical Port Settings struct.

Create

The default value is undefined.

mgmt_ipv6addr

mgmt_ipv6addr

Public IPv6 address for the LAN1 interface.

Type

String.

Create

The default value is undefined.

mgmt_lan

mgmt_lan

Public IPv4 address for the LAN1 interface.

Type

String.

Create

The default value is undefined.

Notes

The mgmt_lan is part of the base object.

ldap_eamapping : The LDAP extensible attribute mapping.

This structure is used to map LDAP fields to NIOS extensible attributes.

mapped_ea

mapped_ea

The name of the extensible attribute definition object to which the LDAP attribute is mapped.

Type

String.

Create

The field is required on creation.

name

name

The LDAP attribute name.

Type

String.

Create

The field is required on creation.

ldap_server : The LDAP server structure.

This structure is used for LDAP authentication configuration.

address

address

The IP address or FQDN of the LDAP server.

Type

String.

Create

The field is required on creation.

authentication_type

authentication_type

The authentication type for the LDAP server.

Type

String.

Valid values are:
  • ANONYMOUS
  • AUTHENTICATED

Create

The default value is ANONYMOUS.

base_dn

base_dn

The base DN for the LDAP server.

Type

String.

Create

The field is required on creation.

bind_password

bind_password

The user password for authentication.

Type

String.

Create

You must specify bind_password when authentication type is set to “AUTHENTICATED”.

Notes

bind_password is not readable.

bind_user_dn

bind_user_dn

The user DN for authentication.

Type

String.

Create

You must specify bind_user_dn when authentication type is set to “AUTHENTICATED”.

comment

comment

The LDAP descriptive comment.

Type

String.

Create

The default value is undefined.

disable

disable

Determines if the LDAP server is disabled.

Type

Bool.

Create

The default value is False.

encryption

encryption

The LDAP server encryption type.

Type

String.

Valid values are:
  • NONE
  • SSL

Create

The default value is SSL.

port

port

The LDAP server port.

Type

Unsigned integer.

Create

The field is required on creation.

use_mgmt_port

use_mgmt_port

Determines if the connection via the MGMT interface is allowed.

Type

Bool.

Create

The default value is False.

version

version

The LDAP server version.

Type

String.

Valid values are:
  • V2
  • V3

Create

The default value is V3.

logicfilterrule : Logic Filter rule.

This structure references defined DHCP filters.

filter

filter

The filter name.

Type

String.

Create

The field is required on creation.

type

type

The filter type. Valid values are:

  • MAC
  • NAC
  • Option

Type

String.

Create

The field is required on creation.

lomnetworkconfig : The LOM network configuration structure.

Infoblox LOM is an implementation of the remote management and monitoring of Infoblox appliances that are LOM ready. The LOM network configuration structure is used to configure IPMI interface for the remote access.

address

address

The IPv4 Address of the Grid member.

Type

String.

Create

The default value is empty.

gateway

gateway

The default gateway for the Grid member.

Type

String.

Create

The default value is empty.

is_lom_capable

is_lom_capable

Determines if the physical node supports LOM or not.

Type

Bool.

Notes

The is_lom_capable cannot be updated.

is_lom_capable cannot be written.

subnet_mask

subnet_mask

The subnet mask for the Grid member.

Type

String.

Create

The default value is empty.

lomuser : The Lights Out Management (LOM) user.

Infoblox LOM is an implementation of the remote management and monitoring of Infoblox appliances that are LOM ready. The LOM user structure is used to configure LOM credentials as well as roles that specify allowed actions for the user.

comment

comment

The descriptive comment for the LOM user.

Type

String.

Create

The default value is empty.

disable

disable

Determines whether the LOM user is disabled.

Type

Bool.

Create

The default value is False.

name

name

The LOM user name.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

password

password

The LOM user password.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

Notes

The password cannot be updated.

password is not readable.

role

role

The LOM user role which specifies the list of actions that are allowed for the user.

Type

String.

Valid values are:
  • OPERATOR
  • USER

Create

The default value is USER.

member:dnsgluerecordaddr : ‘Member DNS glue record address.

This structure holds information about interface which address the appliance uses to generate the glue record for each view.

attach_empty_recursive_view

attach_empty_recursive_view

Determines if empty view with recursion enabled will be written into the conf file.

Type

Bool.

Create

The default value is False.

glue_address_choice

glue_address_choice

The address choice for auto-created glue records for this view.

Type

String.

Valid values are:
  • INTERFACE
  • NAT
  • OTHER

Create

The default value is INTERFACE.

glue_record_address

glue_record_address

The address the appliance uses to generate the glue record.

Type

String.

Create

The default value is undefined.

view

view

The name of the DNS View in which the record resides. Example: “external”.

Type

String.

Create

The field is required on creation.

member:dnsip : Member DNS additional IP structure.

The DNS IP structure is used to configure additional DNS-enabled interfaces for Grid member.

ip_address

ip_address

The additional IP address of the member.

Type

String.

Create

The field is required on creation.

ipsd

ipsd

IP Space Discriminator for this IP address.

Type

String.

Create

The default value is undefined.

member:ntp : The member Network Time Protocol (NTP) settings structure.

The member NTP settings structure is used to control the NTP synchronization of the date and time of the particular Infoblox appliance.

enable_external_ntp_servers

enable_external_ntp_servers

Determines whether the use of the external NTP servers is enabled for the member.

Type

Bool.

Create

The default value is False.

enable_ntp

enable_ntp

Determines whether the NTP service is enabled on the member.

Type

Bool.

Create

The default value is False.

exclude_grid_master_ntp_server

exclude_grid_master_ntp_server

Determines whether the Grid Master is excluded as an NTP server.

Type

Bool.

Create

The default value is False.

ntp_acl

ntp_acl

The NTP access control settings.

Type

A/An The Network Time Protocol (NTP) access control setting struct.

Create

The default value is:

{ 'ac_list': [], 'acl_type': 'NONE', 'service': 'TIME'}

Notes

ntp_acl is associated with the field use_ntp_acl (see use flag).

ntp_keys

ntp_keys

The list of NTP authentication keys used to authenticate NTP clients.

Type

A/An The Network Time Protocol (NTP) authentication key structure struct array.

Create

The default value is:

empty

Notes

ntp_keys is associated with the field use_ntp_keys (see use flag).

ntp_kod

ntp_kod

Determines whether the Kiss-o’-Death packets are enabled or disabled.

Type

Bool.

Create

The default value is False.

Notes

ntp_kod is associated with the field use_ntp_kod (see use flag).

ntp_servers

ntp_servers

The list of NTP servers configured on a member.

Type

A/An The Network Time Protocol (NTP) server structure struct array.

Create

The default value is:

empty

Notes

ntp_servers is associated with the field use_ntp_servers (see use flag).

use_ntp_acl

use_ntp_acl

Use flag for: ntp_acl

Type

Bool.

Create

The default value is False.

use_ntp_keys

use_ntp_keys

Use flag for: ntp_keys

Type

Bool.

Create

The default value is False.

use_ntp_kod

use_ntp_kod

Use flag for: ntp_kod

Type

Bool.

Create

The default value is False.

use_ntp_servers

use_ntp_servers

Use flag for: ntp_servers

Type

Bool.

Create

The default value is False.

member:pnodetoken : Pysical Node Token.

This structure contains information required for a physical node to join the Grid using a one-time token.

physical_oid

physical_oid

OID of the physical node.

Type

String.

Notes

The physical_oid cannot be updated.

physical_oid cannot be written.

token

token

Identifier that should be used by the physical node to join the Grid.

Type

String.

Notes

The token cannot be updated.

token cannot be written.

token_exp_date

token_exp_date

Time when the token expires.

Type

Timestamp.

Notes

The token_exp_date cannot be updated.

token_exp_date cannot be written.

memberserver : Member Server.

This struct represents a Grid member.

enable_preferred_primaries

enable_preferred_primaries

This flag represents whether the preferred_primaries field values of this member are used.

Type

Bool.

Create

The default value is False.

grid_replicate

grid_replicate

The flag represents DNS zone transfers if set to True, and ID Grid Replication if set to False.

This flag is ignored if the struct is specified as part of a stub zone or if it is set as grid_member in an authoritative zone.

Type

Bool.

Create

The default value is False.

lead

lead

This flag controls whether the Grid lead secondary server performs zone transfers to non lead secondaries.

This flag is ignored if the struct is specified as grid_member in an authoritative zone.

Type

Bool.

Create

The default value is False.

name

name

The grid member name.

Type

String.

Create

The field is required on creation.

preferred_primaries

preferred_primaries

The primary preference list with Grid member names andor External Server structs for this member.

Type

A/An External Server struct array.

Create

The default value is:

False

stealth

stealth

This flag governs whether the specified Grid member is in stealth mode or not. If set to True, the member is in stealth mode.

This flag is ignored if the struct is specified as part of a stub zone.

Type

Bool.

Create

The default value is False.

memberservicecommunication : Member Service Communication.

The structure contains service type communication options for a Grid member.

option

option

The option for communication type.

Type

String.

Valid values are:
  • FORCE
  • PREFER

Notes

The option is part of the base object.

The option cannot be updated.

option cannot be written.

service

service

The service for a Grid member.

Type

String.

Valid values are:
  • AD
  • GRID
  • GRID_BACKUP
  • MAIL
  • NTP
  • OCSP
  • REPORTING
  • REPORTING_BACKUP

Create

The default value is undefined.

type

type

Communication type.

Type

String.

Valid values are:
  • IPV4
  • IPV6

Create

The default value is undefined.

memberservicestatus : Member Service Status.

This structure contains a service status of the Grid Member.

description

description

The description of the current service status.

Type

String.

Notes

The description cannot be updated.

description cannot be written.

service

service

The service identifier.

Type

String.

Valid values are:
  • ANALYTICS
  • ATP
  • BLOXTOOLS
  • CAPTIVE_PORTAL
  • CLOUD_API
  • DHCP
  • DISCOVERY
  • DNS
  • DNS_CACHE_ACCELERATION
  • FTP
  • HSM
  • HTTP_FILE_DIST
  • IMC
  • NTP
  • REPORTING
  • TAXII
  • TFTP

Notes

The service cannot be updated.

service cannot be written.

status

status

The service status.

Type

String.

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

Notes

The status cannot be updated.

status cannot be written.

mgmtportsetting : MGMT Port Setting.

The structure that defines whether the MGMT port settings must be used.

enabled

enabled

Determines if MGMT port settings should be enabled.

Type

Bool.

Create

The default value is False.

security_access_enabled

security_access_enabled

Determines if security access on the MGMT port is enabled or not.

Type

Bool.

Create

The default value is False.

vpn_enabled

vpn_enabled

Determines if VPN on the MGMT port is enabled or not.

Type

Bool.

Create

The default value is False.

monitoreddomains : Monitored domains.

This structure contains list of domains monitored by Recursive DNS latency trigger.

domain_name

domain_name

Domain name (FQDN to Query).

Type

String.

Create

The default value is empty.

record_type

record_type

Record type(record to query).

Type

String.

Create

The default value is empty.

msdhcpoption : Microsoft DHCP Options.

An option sets the value of a DHCP option that has been defined in an option space. DHCP options describe network configuration settings and various services available on the network. These options occur as variable-length fields at the end of DHCP messages.

When defining a DHCP option, at least a ‘name’ or a ‘num’ is required.

name

name

The name of the DHCP option.

Type

String.

Create

The default value is empty.

num

num

The code of the DHCP option.

Type

Unsigned integer.

Create

The field is required on creation.

type

type
The DHCP option type. Valid values are:
  • “16-bit signed integer”
  • “16-bit unsigned integer”
  • “32-bit signed integer”
  • “32-bit unsigned integer”
  • “64-bit unsigned integer”
  • “8-bit signed integer”
  • “8-bit unsigned integer (1,2,4,8)”
  • “8-bit unsigned integer”
  • “array of 16-bit integer”
  • “array of 16-bit unsigned integer”
  • “array of 32-bit integer”
  • “array of 32-bit unsigned integer”
  • “array of 64-bit unsigned integer”
  • “array of 8-bit integer”
  • “array of 8-bit unsigned integer”
  • “array of ip-address pair”
  • “array of ip-address”
  • “array of string”
  • “binary”
  • “boolean array of ip-address”
  • “boolean”
  • “boolean-text”
  • “domain-list”
  • “domain-name”
  • “encapsulated”
  • “ip-address”
  • “string”
  • “text”

Type

String.

Notes

The type cannot be updated.

type cannot be written.

user_class

user_class

The name of the user class with which this DHCP option is associated.

Type

String.

Create

The default value is Default User Class.

value

value

Value of the DHCP option.

Type

String.

Create

The field is required on creation.

vendor_class

vendor_class

The name of the vendor class with which this DHCP option is associated.

Type

String.

Create

The default value is DHCP Standard Options.

msdhcpserver : MS DHCP server.

This struct contains the name and address of the Microsoft(r) DHCP server.

ipv4addr

ipv4addr

The IPv4 Address or FQDN of the Microsoft server.

Type

String.

Create

The field is required on creation.

msdnsserver : Msserver Server.

This struct represents a Microsoft DNS server.

address

address

The address of the server.

Type

String.

Create

The field is required on creation.

Notes

The address is part of the base object.

is_master

is_master

This flag indicates if this server is a synchronization master.

Type

Bool.

Create

The default value is False.

ns_ip

ns_ip

This address is used when generating the NS record in the zone, which can be different in case of multihomed hosts.

Type

String.

Create

The field is required on creation.

Notes

The ns_ip is part of the base object.

ns_name

ns_name

This name is used when generating the NS record in the zone, which can be different in case of multihomed hosts.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

Notes

The ns_name is part of the base object.

shared_with_ms_parent_delegation

shared_with_ms_parent_delegation

This flag represents whether the name server is shared with the parent Microsoft primary zone’s delegation server.

Type

Bool.

Notes

The shared_with_ms_parent_delegation cannot be updated.

shared_with_ms_parent_delegation cannot be written.

stealth

stealth

Set this flag to hide the NS record for the primary name server from DNS queries.

Type

Bool.

Create

The default value is False.

msserver:aduser : Microsoft Server AD user.

This structure contains information about the Microsoft Server Active Directory user synchronization.

enable_user_sync

enable_user_sync

Determines whether the Active Directory user synchronization is enabled or not.

Type

Bool.

Create

The default value is False.

Notes

enable_user_sync is associated with the field use_enable_user_sync (see use flag).

last_success_sync_time

last_success_sync_time

Timestamp of the last successful synchronization attempt.

Type

Timestamp.

Notes

The last_success_sync_time cannot be updated.

last_success_sync_time cannot be written.

last_sync_detail

last_sync_detail

The detailed status of the last synchronization attempt.

Type

String.

Notes

The last_sync_detail cannot be updated.

last_sync_detail cannot be written.

last_sync_status

last_sync_status

The status of the last synchronization attempt.

Type

String.

Notes

The last_sync_status cannot be updated.

last_sync_status cannot be written.

last_sync_time

last_sync_time

Timestamp of the last synchronization attempt.

Type

Timestamp.

Notes

The last_sync_time cannot be updated.

last_sync_time cannot be written.

login_name

login_name

The login name of the Microsoft Server.

Type

String.

Create

The default value is undefined.

Notes

login_name is associated with the field use_login (see use flag).

login_password

login_password

The login password of the DHCP Microsoft Server.

Type

String.

Create

The default value is undefined.

Notes

login_password is associated with the field use_login (see use flag).

login_password is not readable.

synchronization_interval

synchronization_interval

The minimum number of minutes between two synchronizations.

Type

Unsigned integer.

Create

The default value is 2.

Notes

synchronization_interval is associated with the field use_synchronization_interval (see use flag).

use_enable_ad_user_sync

use_enable_ad_user_sync

Flag to override AD User sync from grid level

Type

Bool.

Create

The default value is False.

use_enable_user_sync

use_enable_user_sync

Use flag for: enable_user_sync

Type

Bool.

Create

The default value is False.

use_login

use_login

Flag to override login name and password from MS server

Type

Bool.

Create

The default value is False.

use_synchronization_interval

use_synchronization_interval

Use flag for: synchronization_interval

Type

Bool.

Create

The default value is False.

use_synchronization_min_delay

use_synchronization_min_delay

Flag to override synchronization interval from the MS Server

Type

Bool.

Create

The default value is False.

msserver:aduser:data : Active Directory User Data.

This struct contains information about the Active Directory users.

active_users_count

active_users_count

The number of active users.

Type

Unsigned integer.

Notes

The active_users_count cannot be updated.

active_users_count cannot be written.

msserver:dcnsrecordcreation : An Infoblox Active Directory Domain Controller object.

The Active Directory Domain Controller object represents the Active Directory domain controller that is allowed to create NS records for authoritative zones.

address

address

The IPv4 address of the domain controller that is allowed to create NS records.

Type

String.

Create

The field is required on creation.

comment

comment

Optional user comment.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

natsetting : NAT Settings.

The structure contains NAT settings for a member.

enabled

enabled

Determines if NAT should be enabled.

Type

Bool.

Create

The default value is undefined.

external_virtual_ip

external_virtual_ip

External IP address for NAT.

Type

String.

Create

The default value is undefined.

group

group

The NAT group.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

networkview:assocmember : Network View Associated Members structure.

The Network View Associated Members structure provides information about members associated with a particular Network View.

failovers

failovers

The list of failover objects associated with each member.

Type

String array.

Notes

The failovers cannot be updated.

failovers cannot be written.

member

member

The member object associated with a network view.

Type

String.

Notes

The member cannot be updated.

member cannot be written.

nodeinfo : Node Info.

This structure contains a detailed status report about Grid member operations.

ha_status

ha_status

Status about the node of an HA pair.

Type

String.

Valid values are:
  • ACTIVE
  • NOT_CONFIGURED
  • PASSIVE

Notes

The ha_status cannot be updated.

ha_status cannot be written.

hwid

hwid

Hardware ID.

Type

String.

Notes

The hwid cannot be updated.

hwid cannot be written.

hwmodel

hwmodel

Hardware model.

Type

String.

Notes

The hwmodel cannot be updated.

hwmodel cannot be written.

hwplatform

hwplatform

The platform on which NIOS is running on.

Type

String.

Valid values are:
  • AWS
  • AZURE
  • GCP
  • HYPERV
  • KVM
  • PHYSICAL
  • UNKNOWN
  • VMWARE
  • XEN

Notes

The hwplatform cannot be updated.

hwplatform cannot be written.

hwtype

hwtype

Hardware type.

Type

String.

Notes

The hwtype cannot be updated.

hwtype cannot be written.

lan2_physical_setting

lan2_physical_setting

Physical port settings for the LAN2 interface.

Type

A/An Physical Port Settings struct.

Create

The default value is undefined.

lan_ha_port_setting

lan_ha_port_setting

LAN/HA port settings for the node.

Type

A/An LAN/HA Port Settings struct.

Create

The default value is undefined.

mgmt_network_setting

mgmt_network_setting

Network settings for the MGMT port of the node.

Type

A/An Network settings struct.

Create

The default value is undefined.

mgmt_physical_setting

mgmt_physical_setting

Physical port settings for the MGMT interface.

Type

A/An Physical Port Settings struct.

Create

The default value is undefined.

nat_external_ip

nat_external_ip

The NAT external IP address for the node.

Type

String.

Create

The default value is empty.

physical_oid

physical_oid

The OID of the physical node.

Type

String.

Notes

The physical_oid cannot be updated.

physical_oid cannot be written.

service_status

service_status

The service status list of the Grid Member.

Type

A/An Node Service Status struct array.

Notes

The service_status cannot be updated.

service_status cannot be written.

v6_mgmt_network_setting

v6_mgmt_network_setting

The network settings for the IPv6 MGMT port of the node.

Type

A/An IPv6 Settings struct.

Create

The default value is undefined.

notification:rest:templateinstance : Notification REST template instance.

This structure holds information about a notification REST template instance.

parameters

parameters

The notification REST template parameters.

Type

A/An Notification REST template parameter struct array.

Create

The default value is undefined.

template

template

The name of the REST API template parameter.

Type

String.

Create

The field is required on creation.

notification:rest:templateparameter : Notification REST template parameter.

This structure holds information about a notification REST template parameter.

default_value

default_value

The default value of the REST API template parameter.

Type

String.

Notes

The default_value cannot be updated.

default_value cannot be written.

name

name

The name of the REST API template parameter.

Type

String.

Create

The field is required on creation.

syntax

syntax

The syntax of the REST API template parameter.

Type

String.

Valid values are:
  • BOOL
  • INT
  • STR

Create

The field is required on creation.

value

value

The value of the REST API template parameter.

Type

String.

Create

The default value is undefined.

notification:ruleexpressionop : Notification rule expression operand.

The notification rule expression operand is used to build rule expression lists for specific notification rules to take a specific action accordingly to the notification rule configuration if the rule expression evaluates to True.

op

op

Rule expression type.

Type

String.

Valid values are:
  • AND
  • CONTAINED_IN
  • ENDLIST
  • EQ
  • EXISTS
  • GE
  • GT
  • LE
  • LT
  • MATCH_CIDR
  • MATCH_RANGE
  • NOT_EQ
  • NOT_EXISTS
  • NREGEX
  • OR
  • REGEX

Create

The field is required on creation.

op1

op1

Rule expression first operand value.

Type

String.

Valid values are:
  • ADDRESS_TYPE
  • ATC_HIT_CLASS
  • ATC_HIT_PROPERTY
  • ATC_HIT_TYPE
  • AUTO_CREATED_RECORDS
  • DB_CHANGE_USER_NAME
  • DHCP_FINGERPRINT
  • DHCP_IP_ADDRESS
  • DHCP_LEASE_STATE
  • DISABLE
  • DISCOVERER
  • DNS_RPZ_ACTION_POLICY
  • DNS_RPZ_NAME
  • DNS_RPZ_RULE_NAME
  • DNS_RPZ_TYPE
  • DNS_VIEW
  • DUID
  • DXL_TOPIC
  • HOST
  • IPV4_ADDRESS
  • IPV6_ADDRESS
  • IPV6_PREFIX
  • IPV6_PREFIX_BITS
  • IP_ADDRESS
  • IS_IPV4
  • MAC
  • MEMBER_IP
  • MEMBER_NAME
  • NAME
  • NETWORK
  • NETWORK_VIEW
  • OPERATION_TYPE
  • QUERY_FQDN
  • RECORD_NAME
  • RECORD_TYPE
  • SECURITY_ADP_HITS_COUNT
  • SECURITY_ADP_RULE_ACTION
  • SECURITY_ADP_RULE_CATEGORY
  • SECURITY_ADP_RULE_MESSAGE
  • SECURITY_ADP_RULE_SEVERITY
  • SECURITY_ADP_SID
  • SERVER_ASSOC_TYPE_IPV4
  • SERVER_ASSOC_TYPE_IPV6
  • SOURCE_IP
  • THREAT_ORIGIN
  • UNMANAGED
  • ZONE_NAME
  • ZONE_TYPE

Create

The default value is undefined.

op1_type

op1_type

Rule expression first operand type.

Type

String.

Valid values are:
  • FIELD
  • LIST
  • STRING

Create

The default value is undefined.

op2

op2

Rule expression second operand.

Type

String.

Create

The default value is undefined.

op2_type

op2_type

Rule expression second operand type.

Type

String.

Valid values are:
  • FIELD
  • LIST
  • STRING

Create

The default value is undefined.

ntpac : The Network Time Protocol (NTP) access control item structure.

The NTP access control item specifies clients that have permissions to access the NTP service.

address_ac

address_ac

The client address/network with access control.

Type

A/An Address ac struct.

Create

The field is required on creation.

service

service

The type of service with access control.

Type

String.

Valid values are:
  • TIME
  • TIME_AND_NTPQ

Create

The default value is TIME.

ntpaccess : The Network Time Protocol (NTP) access control setting.

The NTP access control setting specifies either a named ACL or the list of clients that have permissions to access the NTP service.

ac_list

ac_list

The list of NTP access control items.

Type

A/An The Network Time Protocol (NTP) access control item structure struct array.

Create

The default value is:

empty

acl_type

acl_type

The NTP access control list type.

Type

String.

Valid values are:
  • LIST
  • NAMED_ACL
  • NONE

Create

The default value is NONE.

named_acl

named_acl

The NTP access named ACL.

Type

String.

Create

The default value is empty.

service

service

The type of service with access control for the assigned named ACL.

Type

String.

Valid values are:
  • TIME
  • TIME_AND_NTPQ

Create

The default value is TIME.

ntpkey : The Network Time Protocol (NTP) authentication key structure.

The NTP authentication key is used by NTP servers to authenticate clients.

number

number

The NTP authentication key identifier.

Type

Unsigned integer.

Create

The field is required on creation.

string

string

The NTP authentication key string.

Type

String.

Create

The field is required on creation.

type

type

The NTP authentication key type.

Type

String.

Valid values are:
  • DES_ASCII
  • DES_HEX
  • DES_NTP
  • MD5_ASCII

Create

The field is required on creation.

ntpserver : The Network Time Protocol (NTP) server structure.

The NTP server structure is used to synchronize the date and time for the Infoblox appliance.

address

address

The NTP server IP address or FQDN.

Type

String.

Create

The field is required on creation.

burst

burst

Determines whether the BURST operation mode is enabled. In BURST operating mode, when the external server is reachable and a valid source of synchronization is available, NTP sends a burst of 8 packets with a 2 second interval between packets.

Type

Bool.

Create

The default value is True.

enable_authentication

enable_authentication

Determines whether the NTP authentication is enabled.

Type

Bool.

Create

The default value is False.

iburst

iburst

Determines whether the IBURST operation mode is enabled. In IBURST operating mode, when the external server is unreachable, NTP server sends a burst of 8 packets with a 2 second interval between packets.

Type

Bool.

Create

The default value is True.

ntp_key_number

ntp_key_number

The NTP authentication key number.

Type

Unsigned integer.

Create

The default value is empty.

preferred

preferred

Determines whether the NTP server is a preferred one or not.

Type

Bool.

Create

The default value is False.

nxdomainrule : Rule of Ruleset.

Represents a rule that is used to match a domain name.

action

action

The action to perform when a domain name matches the pattern defined in this Ruleset.

Type

String.

Valid values are:
  • MODIFY
  • PASS
  • REDIRECT

Create

The default value is PASS.

pattern

pattern

The pattern that is used to match the domain name.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

objectschangestrackingsetting : Objects changes tracking setting.

The objects changes tracking setting structure is used to enable or disable the object changes tracking feature and to display the objects changes state.

enable

enable

Determines whether the objects changes tracking feature is enabled or not.

Type

Bool.

Create

The default value is False.

enable_completion

enable_completion

Determines the percentage of completion for objects changes tracking.

Type

Unsigned integer.

Notes

The enable_completion cannot be updated.

enable_completion cannot be written.

max_objs_to_track

max_objs_to_track

Maximum number of deleted objects retained for tracking. You can enter a value from 2000 - 20000.

Type

Unsigned integer.

Create

The default value is 4000.

max_time_to_track

max_time_to_track

Maximum time period in seconds to track the deleted objects changes. You can enter a value from 7200 - 604800 seconds.

Type

Unsigned integer.

Create

The default value is 14400.

state

state

Determines the objects changes tracking enable state.

Type

String.

Valid values are:
  • DISABLED
  • ENABLED
  • ENABLING
  • ENABLING_ERROR

Notes

The state cannot be updated.

state cannot be written.

ocsp_responder : OCSP Responder.

This struct provides configuration for OCSP Responder.

certificate

certificate

The reference to the OCSP responder certificate.

Type

String.

This field supports nested return fields as described here.

Notes

The certificate cannot be updated.

certificate cannot be written.

certificate_token

certificate_token

The token returned by the uploadinit function call in object fileop.

Type

String.

Create

The default value is undefined.

Notes

certificate_token is not readable.

comment

comment

The descriptive comment for the OCSP authentication responder.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is undefined.

disabled

disabled

Determines if this OCSP authentication responder is disabled.

Type

Bool.

Create

The default value is undefined.

fqdn_or_ip

fqdn_or_ip

The FQDN (Fully Qualified Domain Name) or IP address of the server.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

port

port

The port used for connecting.

Type

Unsigned integer.

Create

The default value is undefined.

option60matchrule : Option 60 Match Rule.

An Option 60 Match Rule structure allows specifying match rules for Option 60 globally.

is_substring

is_substring

Determines if the match value is a substring.

Type

Bool.

Create

The default value is False.

match_value

match_value

The match value for this DHCP Option 60 match rule.

Type

String.

Create

The field is required on creation.

option_space

option_space

The option space for this DHCP Option 60 match rule.

Type

String.

Create

The field is required on creation.

substring_length

substring_length

The length of match value for this DHCP Option 60 match rule.

Type

Unsigned integer.

Create

The default value is empty.

substring_offset

substring_offset

The offset of match value for this DHCP Option 60 match rule.

Type

Unsigned integer.

Create

The default value is 0.

ospf : OSPF Settings.

Settings are used to configure OSPF parameters for the member.

area_id

area_id

The area ID value of the OSPF settings.

Type

String.

Create

The field is required on creation.

area_type

area_type

The OSPF area type.

Type

String.

Valid values are:
  • NSSA
  • STANDARD
  • STUB

Create

The default value is STANDARD.

authentication_key

authentication_key

The authentication password to use for OSPF. The authentication key is valid only when authentication type is “SIMPLE” or “MESSAGE_DIGEST”.

Type

String.

Create

An authentication key is required unless the authentication type is set to “NONE”.

Notes

The authentication_key cannot be updated.

authentication_key is not readable.

authentication_type

authentication_type

The authentication type used for the OSPF advertisement.

Type

String.

Valid values are:
  • MESSAGE_DIGEST
  • NONE
  • SIMPLE

Create

The field is required on creation.

auto_calc_cost_enabled

auto_calc_cost_enabled

Determines if auto calculate cost is enabled or not.

Type

Bool.

Create

The field is required on creation.

bfd_template

bfd_template

Determines BFD template name.

Type

String.

Create

The default value is empty.

comment

comment

A descriptive comment of the OSPF configuration.

Type

String.

Create

The default value is Empty string.

cost

cost

The cost metric associated with the OSPF advertisement.

Type

Unsigned integer.

Create

A cost is required if auto_calc_cost_enabled is set to “false”.

dead_interval

dead_interval

The dead interval value of OSPF (in seconds). The dead interval describes the time to wait before declaring the device is unavailable and down.

Type

Unsigned integer.

Create

The default value is 40.

enable_bfd

enable_bfd

Determines if the BFD is enabled or not.

Type

Bool.

Create

The default value is False.

hello_interval

hello_interval

The hello interval value of OSPF. The hello interval specifies how often to send OSPF hello advertisement, in seconds.

Type

Unsigned integer.

Create

The default value is 10.

interface

interface

The interface that sends out OSPF advertisement information.

Type

String.

Valid values are:
  • IP
  • LAN_HA

Create

The field is required on creation.

is_ipv4

is_ipv4

The OSPF protocol version. Specify “true” if the IPv4 version of OSPF is used, or “false” if the IPv6 version of OSPF is used.

Type

Bool.

Create

The field is required on creation.

key_id

key_id

The hash key identifier to use for “MESSAGE_DIGEST” authentication. The hash key identifier is valid only when authentication type is “MESSAGE_DIGEST”.

Type

Unsigned integer.

Create

The default value is 1.

retransmit_interval

retransmit_interval

The retransmit interval time of OSPF (in seconds). The retransmit interval describes the time to wait before retransmitting OSPF advertisement.

Type

Unsigned integer.

Create

The default value is 5.

transmit_delay

transmit_delay

The transmit delay value of OSPF (in seconds). The transmit delay describes the time to wait before sending an advertisement.

Type

Unsigned integer.

Create

The default value is 1.

outbound:cloudclient:event : Outbound cloudclient event type

enabled

enabled

Determines if the event type is enabled or not.

Type

Bool.

Create

The default value is False.

Notes

The enabled cannot be updated.

event_type

event_type

The event type enum rpz and analytics.

Type

String.

Valid values are:
  • ANALYTIC
  • RPZ

Create

The field is required on creation.

Notes

The event_type cannot be updated.

parentalcontrol:abs : Parental control additional blocking server(ABS).

The parental control settings for additional blocking server.

blocking_policy

blocking_policy

The blocking policy for the addional blocking server.

Type

String.

Create

The field is required on creation.

ip_address

ip_address

The IP address of addional blocking server.

Type

String.

Create

The field is required on creation.

parentalcontrol:msp : Parental control managed service provider (MSP) service.

The parental control settings for MSP.

ip_address

ip_address

The IPv4 Address of MSP.

Type

String.

Create

The field is required on creation.

parentalcontrol:nasgateway : NAS gateway mobile security settings.

The parental control network accounting server (NAS) gateway object provides configuration for transmission of authentication protocol accounting information to the NIOS accounting collector.

comment

comment

The human readable comment for NAS gateway.

Type

String.

Create

The default value is undefined.

ip_address

ip_address

The IPv4 Address of NAS gateway.

Type

String.

Create

The field is required on creation.

message_rate

message_rate

The message rate per server.

Type

Unsigned integer.

Notes

The message_rate cannot be updated.

message_rate cannot be written.

name

name

The name of NAS gateway.

Type

String.

Create

The field is required on creation.

send_ack

send_ack

Determines whether an acknowledge needs to be sent.

Type

Bool.

Create

The default value is undefined.

shared_secret

shared_secret

The protocol MD5 phrase.

Type

String.

Create

The field is required on creation.

Notes

shared_secret is not readable.

parentalcontrol:sitemember : Site member parental control settings.

The parental control site member structure associates particular Grid member with it’s role in process of collecting and consuming the authentication information and the parental control site the feature is deployed on.

name

name

The Grid member name.

Type

String.

Create

The field is required on creation.

type

type

The type of member.

Type

String.

Valid values are:
  • BOTH
  • CLIENT
  • COLLECTOR
  • NONE

Notes

The type cannot be updated.

type cannot be written.

parentalcontrol:spm : Parental control policy management service (SPM).

The parental control settings for SPM.

ip_address

ip_address

The IPv4 Address of SPM.

Type

String.

Create

The field is required on creation.

physicalportsetting : Physical Port Settings.

This structure contains settings for an appliance physical port.

auto_port_setting_enabled

auto_port_setting_enabled

Enable or disalbe the auto port setting.

Type

Bool.

Create

The default value is undefined.

duplex

duplex

The port duplex; if speed is 1000, duplex must be FULL.

Type

String.

Valid values are:
  • FULL
  • HALF

Create

The default value is undefined.

speed

speed

The port speed; if speed is 1000, duplex is FULL.

Type

String.

Valid values are:
  • 10
  • 100
  • 1000

Create

The default value is undefined.

preprovision : Pre-provisioning Settings.

The structure contains pre-provisioning settings.

hardware_info

hardware_info

An array of structures that describe the hardware being pre-provisioned.

Type

A/An Pre-provisioning Hardware Settings struct array.

Create

The field is required on creation.

licenses

licenses

An array of license types the pre-provisioned member should have in order to join the Grid, or the licenses that must be allocated to the member when it joins the Grid using the token-based authentication.

Type

Enum values array.

Valid values are:
  • cloud_api
  • dhcp
  • dns
  • dtc
  • enterprise
  • fireeye
  • ms_management
  • nios
  • rpz
  • sw_tp
  • tp_sub
  • vnios

Create

The field is required on creation.

preprovisionhardware : Pre-provisioning Hardware Settings.

The structure contains hardware information for a pre-provisioned member.

hwmodel

hwmodel

Hardware model - for IB-4010 are Rev1, Rev2; for IB-4030 are Rev1, Rev2; for PT-4000 is Rev2; for IB-VNIOS are IB-VM-100, IB-VM-810, IB-VM-820, IB-VM-RSP, IB-VM-1410, IB-VM-1420, IB-VM-2210, IB-VM-2220, IB-VM-4010, CP-V800, CP-V1400, CP-V2200. Note that you cannot specify hwmodel for following hardware types: IB-FLEX, IB-V2215, IB-V1425, IB-V4025, IB-V4015, IB-V1415, IB-V815, IB-V825, IB-V2225, CP-V805, CP-V1405, CP-V2205.

Type

String.

Valid values are:
  • CP-V1400
  • CP-V2200
  • CP-V800
  • IB-VM-100
  • IB-VM-1410
  • IB-VM-1420
  • IB-VM-2210
  • IB-VM-2220
  • IB-VM-4010
  • IB-VM-810
  • IB-VM-820
  • IB-VM-RSP
  • Rev1
  • Rev2

Create

The default value is undefined.

hwtype

hwtype

Hardware type.

Type

String.

Valid values are:
  • CP-V1405
  • CP-V2205
  • CP-V805
  • IB-100
  • IB-1410
  • IB-1415
  • IB-1420
  • IB-1425
  • IB-2210
  • IB-2215
  • IB-2220
  • IB-2225
  • IB-4010
  • IB-4015
  • IB-4020
  • IB-4025
  • IB-4030
  • IB-4030-10GE
  • IB-810
  • IB-815
  • IB-820
  • IB-825
  • IB-FLEX
  • IB-RSP2
  • IB-V1415
  • IB-V1425
  • IB-V2215
  • IB-V2225
  • IB-V4015
  • IB-V4025
  • IB-V815
  • IB-V825
  • IB-VNIOS
  • PT-1400
  • PT-1405
  • PT-2200
  • PT-2205
  • PT-4000
  • PT-4000-10GE

Create

The field is required on creation.

properties:blackoutsetting : Blackout Setting.

This struct contains information about blackout settings.

blackout_duration

blackout_duration

The blackout duration in seconds; minimum value is 1 minute.

Type

Unsigned integer.

Create

The default value is empty.

blackout_schedule

blackout_schedule

A Schedule Setting struct that determines blackout schedule.

Type

A/An Schedule Setting struct.

Create

The default value is undefined.

enable_blackout

enable_blackout

Determines whether a blackout is enabled or not.

Type

Bool.

Create

The field is required on creation.

queriesuser : Queries user.

This structure contains information about the SNMPv3 queries user.

comment

comment

A descriptive comment for this queries user.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

user

user

The SNMPv3 user.

Type

String.

Create

The default value is empty.

radius:server : The RADIUS authentication server structure.

This structure is used for RADIUS authentication configuration.

acct_port

acct_port

The accounting port.

Type

Unsigned integer.

Create

The default value is The default value is 1813 if use_accounting is set to False.

address

address

The FQDN or the IP address of the RADIUS server that is used for authentication.

Type

String.

Create

The field is required on creation.

auth_port

auth_port

The authorization port.

Type

Unsigned integer.

Create

The default value is The default value is 1812 if use_accounting is set to True.

auth_type

auth_type

The authentication protocol.

Type

String.

Valid values are:
  • CHAP
  • PAP

Create

The default value is PAP.

comment

comment

The RADIUS descriptive comment.

Type

String.

Create

The default value is undefined.

disable

disable

Determines whether the RADIUS server is disabled.

Type

Bool.

Create

The default value is False.

shared_secret

shared_secret

The shared secret that the NIOS appliance and the RADIUS server use to encrypt and decrypt their messages.

Type

String.

Create

The field is required on creation.

Notes

shared_secret is not readable.

use_accounting

use_accounting

Determines whether RADIUS accounting is enabled.

Type

Bool.

Create

The default value is True.

use_mgmt_port

use_mgmt_port

Determines whether connection via the management interface is allowed.

Type

Bool.

Create

The default value is False.

rdatasubfield : Unknown Record Rdata subfield value.

field_type

field_type

Type of field. “B”: unsigned 8-bit integer, “S”: unsigned 16-bit integer, “I”: unsigned 32-bit integer. “H”: BASE64, “6”: an IPv6 address, “4”: an IPv4 address, “N”: a domain name, “T”: text string, “X”: opaque binary data

Type

String.

Create

The field is required on creation.

field_value

field_value

String representation of subfield value.

Type

String.

Create

The field is required on creation.

include_length

include_length

The ‘size of ‘length’ sub-sub field to be included in RDATA.

Type

String.

Valid values are:
  • 16_BIT
  • 8_BIT
  • NONE

Create

The field is required on creation.

remoteddnszone : Remote DDNS Zone structure.

The Remote DDNS Zone structure provides information about the remote DDNS zone associated with a particular object.

fqdn

fqdn

The FQDN of the remote server.

Type

String.

Create

The field is required on creation.

gss_tsig_dns_principal

gss_tsig_dns_principal

The principal name in which GSS-TSIG for dynamic updates is enabled.

Type

String.

Create

The default value is empty.

gss_tsig_domain

gss_tsig_domain

The domain in which GSS-TSIG for dynamic updates is enabled.

Type

String.

Create

The default value is empty.

key_type

key_type

The key type to be used.

Type

String.

Valid values are:
  • GSS-TSIG
  • NONE
  • TSIG

Create

The default value is NONE.

server_address

server_address

The remote server IP address.

Type

String.

Create

The field is required on creation.

tsig_key

tsig_key

The TSIG key value.

Type

String.

Create

The default value is empty.

tsig_key_alg

tsig_key_alg

The TSIG key alorithm name.

Type

String.

Valid values are:
  • HMAC-MD5
  • HMAC-SHA256

Create

The default value is empty.

tsig_key_name

tsig_key_name

The name of the TSIG key. The key name entered here must match the TSIG key name on the external name server.

Type

String.

Create

The default value is empty.

saml:idp : The SAML Identity Provider structure.

This structure is used for SAML authentication configuration.

comment

comment

The SAML Identity Provider descriptive comment.

Type

String.

Create

The default value is empty.

groupname

groupname

The SAML groupname optional user group attribute.

Type

String.

Create

The default value is empty.

idp_type

idp_type

SAML Identity Provider type.

Type

String.

Valid values are:
  • AZURE_SSO
  • OKTA
  • OTHER
  • PING_IDENTITY
  • SHIBBOLETH_SSO

Create

The field is required on creation.

metadata_token

metadata_token

The token returned by the uploadinit function call in object fileop.

Type

String.

Create

The default value is undefined.

Notes

metadata_token is not readable.

metadata_url

metadata_url

Identity Provider Metadata URL.

Type

String.

Create

The default value is undefined.

scheduledbackup : Scheduled backup settings.

You can back up your system files locally on the appliance or to your management system, or use TFTP, FTP or SCP to back them up to a remote server. Backing up and restoring the configuration files using TFTP, FTP and SCP is supported on both IPv4 and IPv6 communication protocols. You can select to back up files manually or schedule automatic backups for a later date.

The scheduled backup setting provides configuration for backing up system files and discovery databases periodically and on demand. It also provides restore settings to restore the files on the same appliance or on a different appliance.

backup_frequency

backup_frequency

The frequency of backups.

Type

String.

Valid values are:
  • DAILY
  • HOURLY
  • WEEKLY

Create

The default value is WEEKLY.

backup_server

backup_server

The IP address of the backup server.

Type

String.

Create

The default value is empty.

backup_type

backup_type

The destination of the backup files.

Type

String.

Valid values are:
  • FTP
  • LOCAL
  • SCP
  • TFTP

Create

The default value is LOCAL.

discovery_data

discovery_data

Determines whether the restore the NetMRI data is enabled.

Type

Bool.

Create

The default value is True.

download_keys

download_keys

If set, scp backup support to download keys

Type

Bool.

Create

The default value is False.

enable

enable

Determines whether the scheduled backup is enabled.

Type

Bool.

Create

The default value is True.

execute

execute

The state for scheduled backup or restore operation.

Type

String.

Valid values are:
  • TRIGGER

Create

The default value is undefined.

Notes

The execute cannot be updated.

execute is not readable.

hour_of_day

hour_of_day

The hour of the day past 12:00 AM the backup is performed.

Type

Unsigned integer.

Create

The default value is 3.

keep_local_copy

keep_local_copy

Determines whether the local backup performed before uploading backup to remote storage.

Type

Bool.

Create

The default value is False.

key_type

key_type

If set, scp backup support based on keys type

Type

String.

Valid values are:
  • id_ecdsa
  • id_rsa

Create

The default value is undefined.

Notes

The key_type cannot be updated.

key_type is not readable.

minutes_past_hour

minutes_past_hour

The minute of the hour when the backup is performed.

Type

Unsigned integer.

Create

The default value is 0.

nios_data

nios_data

Determines whether the restore of the NIOS data is enabled.

Type

Bool.

Create

The default value is True.

operation

operation

The scheduled backup operation.

Type

String.

Valid values are:
  • BACKUP
  • NONE
  • RESTORE

Create

The default value is NONE.

password

password

The user password on the backup server.

Type

String.

Create

The default value is undefined.

Notes

The password cannot be updated.

password is not readable.

path

path

The directory path to the backup file stored on the server.

Type

String.

Create

The default value is empty.

restore_password

restore_password

The password on the restore server.

Type

String.

Create

The default value is undefined.

Notes

The restore_password cannot be updated.

restore_password is not readable.

restore_path

restore_path

The directory path to the restored file on the server.

Type

String.

Create

The default value is empty.

restore_server

restore_server

The IP address of the restore server.

Type

String.

Create

The default value is empty.

restore_type

restore_type

The destination of the restore files.

Type

String.

Valid values are:
  • FTP
  • SCP

Create

The default value is FTP.

restore_username

restore_username

The user name on the restore server.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

splunk_app_data

splunk_app_data

Determines whether the restore of the Splunk application data is enabled.

Type

Bool.

Create

The default value is True.

status

status

The status of the scheduled backup.

Type

String.

Valid values are:
  • ABORTED
  • FAILED
  • FINISHED
  • IDLE
  • IN_PROGRESS
  • ROLL
  • ROLLED
  • SCHEDULING
  • TRIGGERED

Notes

The status cannot be updated.

status cannot be written.

upload_keys

upload_keys

If set, scp backup support to upload keys

Type

Bool.

Create

The default value is False.

use_keys

use_keys

If set, scp backup support based on keys

Type

Bool.

Create

The default value is False.

username

username

The user name on the backup server.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

weekday

weekday

The day of the week when the backup is performed.

Type

String.

Valid values are:
  • FRIDAY
  • MONDAY
  • SATURDAY
  • SUNDAY
  • THURSDAY
  • TUESDAY
  • WEDNESDAY

Create

The default value is SATURDAY.

servicestatus : Node Service Status.

This structure contains a service status of the Grid Member’s node.

description

description

The description of the current service status.

Type

String.

Notes

The description cannot be updated.

description cannot be written.

service

service

The service identifier.

Type

String.

Valid values are:
  • AUTH_NAMED
  • BFD
  • BGP
  • CORE_FILES
  • CPU1_TEMP
  • CPU2_TEMP
  • CPU_USAGE
  • CPU_USAGE
  • DB_OBJECT
  • DISCOVERY_CAPACITY
  • DISK_SIZE
  • DISK_USAGE
  • ENET_HA
  • ENET_LAN
  • ENET_LAN2
  • ENET_MGMT
  • EXTERNAL_STORAGE
  • FAN1
  • FAN2
  • FAN3
  • FAN4
  • FAN5
  • FAN6
  • FAN7
  • FAN8
  • JOIN_STATUS
  • LCD
  • MEMORY
  • MGM_SERVICE
  • NETWORK_CAPACITY
  • NODE_STATUS
  • NTP_SYNC
  • OSPF
  • OSPF6
  • PASSIVE_HA_CONNECTIVITY
  • POWER1
  • POWER2
  • POWER3
  • POWER4
  • POWER_SUPPLY
  • RAID_BATTERY
  • RAID_DISK1
  • RAID_DISK2
  • RAID_DISK3
  • RAID_DISK4
  • RAID_DISK5
  • RAID_DISK6
  • RAID_DISK7
  • RAID_DISK8
  • RAID_SUMMARY
  • REPLICATION
  • SFP_HA
  • SFP_LAN
  • SFP_LAN2
  • SFP_MGMT
  • SNIC_CHIP_TEMP
  • SNIC_CORE_UTIL
  • SNIC_PCB_TEMP
  • SNIC_UTIL
  • SUBGRID_CONN
  • SWAP_USAGE
  • SYS_TEMP
  • VPN_CERT

Notes

The service cannot be updated.

service cannot be written.

status

status

The service status.

Type

String.

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

Notes

The status cannot be updated.

status cannot be written.

setting:atpoutbound : Outbound settings for ATP events

This struct contains information about outbound settings for ATP events.

enable_query_fqdn

enable_query_fqdn

Flag to enable using DNS query FQDN for Outbound.

Type

Bool.

Create

The default value is False.

query_fqdn_limit

query_fqdn_limit

Max domain level for DNS Query FQDN

Type

Unsigned integer.

Create

The default value is 2.

setting:automatedtrafficcapture : Automated Traffic Capture.

Grid level settings for automated traffic capture.

destination

destination

Destination of traffic capture files. Save traffic capture locally or upload to remote server using FTP or SCP.

Type

String.

Valid values are:
  • FTP
  • NONE
  • SCP

Create

The default value is NONE.

destination_host

destination_host

IP Address of the destination host.

Type

String.

Create

The default value is empty.

duration

duration

The time interval on which traffic will be captured(in sec).

Type

Unsigned integer.

Create

The default value is empty.

include_support_bundle

include_support_bundle

Enable automatic download for support bundle.

Type

Bool.

Create

The default value is False.

keep_local_copy

keep_local_copy

Save traffic capture files locally.

Type

Bool.

Create

The default value is False.

password

password

Password for accessing the FTP/SCP server. This field is not readable.

Type

String.

Create

The default value is undefined.

Notes

password is not readable.

support_bundle_directory

support_bundle_directory

Directory to store the support bundle on the remote server.

Type

String.

Create

The default value is empty.

traffic_capture_directory

traffic_capture_directory

Directory to store the traffic capture files on the remote server.

Type

String.

Create

The default value is empty.

traffic_capture_enable

traffic_capture_enable

Enable automated traffic capture based on monitoring thresholds.

Type

Bool.

Create

The default value is False.

username

username

User name for accessing the FTP/SCP server.

Type

String.

Create

The default value is empty.

setting:dnsresolver : DNS resolver Setting.

resolvers

resolvers

The resolvers of a Grid member. The Grid member sends queries to the first name server address in the list. The second name server address is used if first one does not response.

Type

String array. The array supports a maximum of 2 element(s).

Create

The default value is empty.

search_domains

search_domains

The Search Domain Group, which is a group of domain names that the Infoblox device can add to partial queries that do not specify a domain name. Note that you can set this parameter only when prefer_resolver or alternate_resolver is set.

Type

String array.

Create

The default value is empty.

setting:dynamicratio : Dynamic Ratio Setting for DTC Pool.

This structure contains configuration for dynamic ratio load balancing.

invert_monitor_metric

invert_monitor_metric

Determines whether the inverted values of the DTC SNMP monitor metric will be used.

Type

Bool.

Create

The default value is False.

method

method

The method of the DTC dynamic ratio load balancing.

Type

String.

Valid values are:
  • MONITOR
  • ROUND_TRIP_DELAY

Create

The default value is MONITOR.

monitor

monitor

The DTC monitor output of which will be used for dynamic ratio load balancing.

Type

String.

This field supports nested return fields as described here.

Create

The default value is empty.

monitor_metric

monitor_metric

The metric of the DTC SNMP monitor that will be used for dynamic weighing.

Type

String.

Create

The default value is undefined.

monitor_weighing

monitor_weighing

The DTC monitor weight. ‘PRIORITY’ means that all clients will be forwarded to the least loaded server. ‘RATIO’ means that distribution will be calculated based on dynamic weights.

Type

String.

Valid values are:
  • PRIORITY
  • RATIO

Create

The default value is RATIO.

setting:email : The email settings for the Grid member.

address

address

The notification email address of a Grid member.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

enabled

enabled

Determines if email notification is enabled or not.

Type

Bool.

Create

The default value is False.

from_address

from_address

The email address of a Grid Member for ‘from’ field in notification.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

password

password

Password to validate from address

Type

String.

Create

The default value is empty.

Notes

password is not readable.

port_number

port_number

SMTP port number

Type

Unsigned integer.

Create

The default value is 25.

relay

relay

The relay name or IP address.

Type

String.

Create

The default value is empty.

relay_enabled

relay_enabled

Determines if email relay is enabled or not.

Type

Bool.

Create

The default value is False.

smtps

smtps

SMTP over TLS

Type

Bool.

Create

The default value is False.

use_authentication

use_authentication

Enable or disable SMTP auth

Type

Bool.

Create

The default value is False.

setting:httpproxyserver : HTTP Proxy Server Setting.

The Grid HTTP Proxy Server Setting object provides information about the HTTP proxy server configuration.

address

address

The address of the HTTP proxy server.

Type

String.

Create

The field is required on creation.

certificate

certificate

The token returned by the uploadinit function call in object fileop for the CA certificate file used in the content inspection by an HTTP proxy server.

Type

String.

Create

The default value is undefined.

Notes

certificate is not readable.

comment

comment

The descriptive comment for the HTTP proxy server configuration.

Type

String.

Create

The default value is empty.

enable_content_inspection

enable_content_inspection

Determines if HTTPS content inspection by the HTTP proxy server is enabled or not.

Type

Bool.

Create

The default value is False.

enable_proxy

enable_proxy

Determines if the HTTP proxy server is enabled or not.

Type

Bool.

Create

The default value is False.

enable_username_and_password

enable_username_and_password

Determines if username and password for HTTP Proxy Server connectivity is used or not.

Type

Bool.

Create

The default value is False.

password

password

The password for the HTTP proxy server.

Type

String.

Create

The default value is undefined.

Notes

password is not readable.

port

port

The port on which the HTTP proxy server listens.

Type

Unsigned integer.

Create

The field is required on creation.

username

username

The user name for the HTTP proxy server.

Type

String.

Create

The default value is empty.

verify_cname

verify_cname

Determines if the CNAME record query verification is enabled or not.

Type

Bool.

Create

The default value is False.

setting:inactivelockout : Inactivity Lockout settings.

This structure contains inactivity lockout settings.

account_inactivity_lockout_enable

account_inactivity_lockout_enable

Enable/disable the account inactivity lockout.

Type

Bool.

Create

The default value is False.

inactive_days

inactive_days

Number of days after which account gets locked out if user does not login.

Type

Unsigned integer.

Create

The default value is 30.

reactivate_via_remote_console_enable

reactivate_via_remote_console_enable

Enable/disable reactivating user account by logging in from remote console.

Type

Bool.

Create

The default value is True.

reactivate_via_serial_console_enable

reactivate_via_serial_console_enable

Enable/disable reactivating user account by logging in from serial console.

Type

Bool.

Create

The default value is True.

reminder_days

reminder_days

The number of days before the account lockout date when the appliance sends a reminder.

Type

Unsigned integer.

Create

The default value is 15.

setting:ipam:threshold : IPAM Threshold Settings.

This struct contains information about the IPAM theshold settings.

reset_value

reset_value

Indicates the percentage point which resets the email/SNMP trap sending.

Type

Unsigned integer.

Create

The default value is 85.

trigger_value

trigger_value

Indicates the percentage point which triggers the email/SNMP trap sending.

Type

Unsigned integer.

Create

The default value is 95.

setting:ipam:trap : IPAM Trap Settings.

This struct contains information about the IPAM trap settings.

enable_email_warnings

enable_email_warnings

Determines whether sending warnings by email is enabled or not.

Type

Bool.

Create

The default value is False.

enable_snmp_warnings

enable_snmp_warnings

Determines whether sending warnings by SNMP is enabled or not.

Type

Bool.

Create

The default value is False.

setting:msserver : Microsoft server settings structure.

ad_user_default_timeout

ad_user_default_timeout

Determines the default timeout value (in seconds) for Active Directory user synchronization for all Microsoft servers.

Type

Unsigned integer.

Create

The default value is 7200.

default_ip_site_link

The default IP site link for sites created on NIOS for all Microsoft servers.

Type

String.

Create

The default value is DEFAULTIPSITELINK.

enable_ad_user_sync

enable_ad_user_sync

Determines if Active Directory user synchronization for all Microsoft servers in the Grid is enabled or not.

Type

Bool.

Create

The default value is False.

enable_dhcp_monitoring

enable_dhcp_monitoring

Determines if the monitoring and control of DHCP service on all Microsoft servers in the Grid is enabled or not.

Type

Bool.

Create

The default value is True.

enable_dns_monitoring

enable_dns_monitoring

Determines if the monitoring and control of DNS service on all Microsoft servers in the Grid is enabled or not.

Type

Bool.

Create

The default value is True.

enable_dns_reports_sync

enable_dns_reports_sync

Determines if synchronization of DNS reporting data from all Microsoft servers in the Grid is enabled or not.

Type

Bool.

Create

The default value is True.

enable_invalid_mac

enable_invalid_mac

Determines if the invalid MAC address synchronization for DHCP leases and fixed addresses is enabled or not.

Type

Bool.

Create

The default value is True.

enable_network_users

enable_network_users

Determines if the Network Users creation is enabled or not.

Type

Bool.

Create

The default value is False.

ldap_timeout

ldap_timeout

Determines an LDAP connection timeout interval (in seconds) for all Microsoft servers.

Type

Unsigned integer.

Create

The default value is 10.

log_destination

log_destination

The logging of synchronization messages to the syslog or mslog.

Type

String.

Valid values are:
  • MSLOG
  • SYSLOG

Create

The default value is MSLOG.

max_connection

max_connection

Determines the maximum number of connections to Microsoft servers.

Type

Unsigned integer.

Create

The default value is 5.

rpc_timeout

rpc_timeout

Determines the timeout value (in seconds) for RPC connections to all Microsoft servers.

Type

Unsigned integer.

Create

The default value is 10.

setting:network : Network settings.

This structure contains a network settings for the member.

address

address

The IPv4 Address of the Grid Member.

Type

String.

Create

The default value is empty.

dscp

dscp

The DSCP (Differentiated Services Code Point) value determines relative priorities for the type of services on your network. The appliance implements QoS (Quality of Service) rules based on this configuration. Valid values are from 0 to 63.

Type

Unsigned integer.

Create

The default value is 0.

Notes

dscp is associated with the field use_dscp (see use flag).

gateway

gateway

The default gateway for the Grid Member.

Type

String.

Create

The default value is empty.

primary

primary

Determines if the current address is the primary VLAN address or not.

Type

Bool.

Create

The default value is True.

subnet_mask

subnet_mask

The subnet mask for the Grid Member.

Type

String.

Create

The default value is empty.

use_dscp

use_dscp

Use flag for: dscp

Type

Bool.

Create

The default value is False.

vlan_id

vlan_id

The identifier for the VLAN. Valid values are from 1 to 4096.

Type

Unsigned integer.

Create

The default value is empty.

setting:password : Password settings.

This structure contains settings related to the Grid admin passwords.

chars_to_change

chars_to_change

The minimum number of characters that must be changed when revising an admin password.

Type

Unsigned integer.

Create

The default value is 0.

expire_days

expire_days

The number of days of the password expiration period (if enabled).

Type

Unsigned integer.

Create

The default value is 30.

expire_enable

expire_enable

If set to True, password expiration is enabled.

Type

Bool.

Create

The default value is False.

force_reset_enable

force_reset_enable

If set to True, all new users must change their passwords when they first log in to the system, and existing users must change the passwords that were just reset.

Type

Bool.

Create

The default value is False.

history_enable

history_enable

Enable/disable the password history.

Type

Bool.

Create

The default value is False.

min_password_age

min_password_age

Minimum password age in days before password can be updated. Can be set between 1 to 9998 days.

Type

Unsigned integer.

Create

The default value is 0.

num_lower_char

num_lower_char

The minimum number of lowercase characters.

Type

Unsigned integer.

Create

The default value is 0.

num_numeric_char

num_numeric_char

The minimum number of numeric characters.

Type

Unsigned integer.

Create

The default value is 0.

num_passwords_saved

num_passwords_saved

Number of saved passwords if password history is enabled. Can be set between 1 to 20.

Type

Unsigned integer.

Create

The default value is 5.

num_symbol_char

num_symbol_char

The minimum number of symbol characters. The allowed characters are ! @ # $ % ^ & * ( ).

Type

Unsigned integer.

Create

The default value is 0.

num_upper_char

num_upper_char

The minimum number of uppercase characters.

Type

Unsigned integer.

Create

The default value is 0.

password_min_length

password_min_length

The minimum length of the password.

Type

Unsigned integer.

Create

The default value is 4.

reminder_days

reminder_days

The number of days before the password expiration date when the appliance sends a reminder.

Type

Unsigned integer.

Create

The default value is 15.

setting:scavenging : DNS scavenging settings.

The DNS scavenging settings object provides information about scavenging configuration e.g. conditions under which records can be scavenged, periodicity of scavenging operations.

ea_expression_list

ea_expression_list

The extensible attributes expression list.

The particular record is treated as reclaimable if extensible attributes expression condition evaluates to ‘true’ for given record if scavenging hasn’t been manually disabled on a given resource record.

Type

A/An Extensible attribute expression operand struct array.

Create

The default value is empty.

enable_auto_reclamation

enable_auto_reclamation

This flag indicates if the automatic resource record scavenging is enabled or not.

Type

Bool.

Create

The default value is False.

enable_recurrent_scavenging

enable_recurrent_scavenging

This flag indicates if the recurrent resource record scavenging is enabled or not.

Type

Bool.

Create

The default value is False.

enable_rr_last_queried

enable_rr_last_queried

This flag indicates if the resource record last queried monitoring in affected zones is enabled or not.

Type

Bool.

Create

The default value is False.

enable_scavenging

enable_scavenging

This flag indicates if the resource record scavenging is enabled or not.

Type

Bool.

Create

The default value is False.

enable_zone_last_queried

enable_zone_last_queried

This flag indicates if the last queried monitoring for affected zones is enabled or not.

Type

Bool.

Create

The default value is False.

expression_list

expression_list

The expression list.

The particular record is treated as reclaimable if expression condition evaluates to ‘true’ for given record if scavenging hasn’t been manually disabled on a given resource record.

Type

A/An Expression operand struct array.

Create

The default value is empty.

reclaim_associated_records

reclaim_associated_records

This flag indicates if the associated resource record scavenging is enabled or not.

Type

Bool.

Create

The default value is False.

scavenging_schedule

scavenging_schedule

Schedule setting for cloud discovery task.

Type

A/An Schedule Setting struct.

Create

The default value is empty.

setting:schedule : Schedule Setting.

This struct contains information about scheduling settings.

day_of_month

day_of_month

The day of the month for the scheduled task.

Type

Unsigned integer.

Create

The default value is 1.

disable

disable

If set to True, the scheduled task is disabled.

Type

Bool.

Create

The default value is False.

every

every

The number of frequency to wait before repeating the scheduled task.

Type

Unsigned integer.

Create

The default value is 1.

frequency

frequency

The frequency for the scheduled task.

Type

String.

Valid values are:
  • DAILY
  • HOURLY
  • MONTHLY
  • WEEKLY

Create

The default value is empty.

hour_of_day

hour_of_day

The hour of day for the scheduled task.

Type

Unsigned integer.

Create

The default value is 1.

minutes_past_hour

minutes_past_hour

The minutes past the hour for the scheduled task.

Type

Unsigned integer.

Create

The default value is 1.

month

month

The month for the scheduled task.

Type

Unsigned integer.

Create

The default value is 1.

recurring_time

recurring_time

The recurring time for the schedule in Epoch seconds format. This field is obsolete and is preserved only for backward compatibility purposes. Please use other applicable fields to define the recurring schedule. DO NOT use recurring_time together with these fields.

If you use recurring_time with other fields to define the recurring schedule, recurring_time has priority over year, hour_of_day, and minutes_past_hour and will override the values of these fields, although it does not override month and day_of_month. In this case, the recurring time value might be different than the intended value that you define.

Type

Timestamp.

Create

The default value is empty.

repeat

repeat

Indicates if the scheduled task will be repeated or run only once.

Type

String.

Valid values are:
  • ONCE
  • RECUR

Create

The default value is ONCE.

time_zone

time_zone

The time zone for the schedule.

Type

String.

Create

The default value is (UTC) Coordinated Universal Time.

weekdays

weekdays

Days of the week when scheduling is triggered.

Type

Enum values array.

Valid values are:
  • FRIDAY
  • MONDAY
  • SATURDAY
  • SUNDAY
  • THURSDAY
  • TUESDAY
  • WEDNESDAY

Create

The default value is empty.

year

year

The year for the scheduled task.

Type

Unsigned integer.

Create

The default value is undefined.

setting:security : Security settings.

This structure contains the Grid security settings.

admin_access_items

admin_access_items

A list of access control settings used for security access.

Type

One of the following: Address ac struct, TSIG ac struct array.

Create

The default value is:

empty

audit_log_rolling_enable

audit_log_rolling_enable

If set to True, rolling of audit logs is enabled.

Type

Bool.

Create

The default value is True.

disable_concurrent_login

disable_concurrent_login

Whether concurrent login allowed gridlevel

Type

Bool.

Create

The default value is False.

http_redirect_enable

http_redirect_enable

If set to True, HTTP connections are redirected to HTTPS.

Type

Bool.

Create

The default value is False.

inactivity_lockout_setting

inactivity_lockout_setting

The Admin Group security settings.

Type

A/An Inactivity Lockout settings struct.

Create

The default value is:

  { 'account_inactivity_lockout_enable': False,
'inactive_days': 30,
'reactivate_via_remote_console_enable': True,
'reactivate_via_serial_console_enable': True,
'reminder_days': 15}

lcd_input_enable

lcd_input_enable

If set to True, the LCD buttons on the front panel of the NIOS appliance can be used for IP address settings of the LAN1 port.

Type

Bool.

Create

The default value is True.

login_banner_enable

login_banner_enable

If set to True, the login banner is enabled.

Type

Bool.

Create

The default value is True.

login_banner_text

login_banner_text

The login banner text.

Type

String.

Create

The default value is Disconnect NOW if you have not been expressly authorized to use this system.

remote_console_access_enable

remote_console_access_enable

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.

security_access_enable

security_access_enable

If set to True, HTTP access restrictions are enabled.

Type

Bool.

Create

The default value is False.

security_access_remote_console_enable

security_access_remote_console_enable

If set to True, remote console access restrictions will be enabled.

Type

Bool.

Create

The default value is True.

session_timeout

session_timeout

The session timeout interval in seconds.

Type

Unsigned integer.

Create

The default value is 600.

ssh_perm_enable

ssh_perm_enable

If set to False, SSH access is permanently disabled.

Type

Bool.

Notes

The ssh_perm_enable cannot be updated.

ssh_perm_enable cannot be written.

support_access_enable

support_access_enable

If set to True, support access for the Grid has been enabled.

Type

Bool.

Create

The default value is False.

support_access_info

support_access_info

Information string to be used for support access requests.

Type

String.

Create

The default value is empty.

setting:securitybanner : Security banner settings.

This structure contains settings related to the Grid security level banner.

color

color

The security level color.

Type

String.

Valid values are:
  • BLACK
  • BLUE
  • BROWN
  • CYAN
  • GREEN
  • MAGENTA
  • ORANGE
  • PURPLE
  • RED
  • YELLOW

Create

The default value is GREEN.

enable

enable

If set to True, the security banner will be displayed on the header and footer of the Grid Manager screen, including the Login screen.

Type

Bool.

Create

The default value is False.

level

level

The security level.

Type

String.

Valid values are:
  • CONFIDENTIAL
  • RESTRICTED
  • SECRET
  • TOP_SECRET
  • UNCLASSIFIED

Create

The default value is UNCLASSIFIED.

message

message

The classification message to be displayed.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

setting:snmp : SNMP setting.

This structure contains information about the SNMP subsystem.

engine_id

engine_id

The engine ID of the appliance that manages the SNMP agent.

Type

String array.

Notes

The engine_id cannot be updated.

engine_id cannot be written.

queries_community_string

queries_community_string

The community string for SNMP queries.

Type

String.

Create

The default value is empty.

queries_enable

queries_enable

If set to True, SNMP queries are enabled.

Type

Bool.

Create

The default value is empty.

snmpv3_queries_enable

snmpv3_queries_enable

If set to True, SNMPv3 queries are enabled.

Type

Bool.

Create

The default value is empty.

snmpv3_queries_users

snmpv3_queries_users

A list of SNMPv3 queries users.

Type

A/An Queries user struct array.

Create

The default value is empty.

snmpv3_traps_enable

snmpv3_traps_enable

If set to True, SNMPv3 traps are enabled.

Type

Bool.

Create

The default value is empty.

syscontact

syscontact

The name of the contact person for the appliance. Second value is applicable only for HA pair. Otherwise second value is ignored.

Type

String array. The array supports a maximum of 2 element(s).

Create

The default value is empty.

sysdescr

sysdescr

Useful information about the appliance. Second value is applicable only for HA pair. Otherwise second value is ignored.

Type

String array. The array supports a maximum of 2 element(s).

Create

The default value is empty.

syslocation

syslocation

The physical location of the appliance. Second value is applicable only for HA pair. Otherwise second value is ignored.

Type

String array. The array supports a maximum of 2 element(s).

Create

The default value is empty.

sysname

sysname

The FQDN (Fully Qualified Domain Name) of the appliance. Second value is applicable only for HA pair. Otherwise second value is ignored.

Type

String array. The array supports a maximum of 2 element(s).

Create

The default value is empty.

trap_receivers

trap_receivers

A list of trap receivers.

Type

A/An Trap receiver struct array.

Create

The default value is empty.

traps_community_string

traps_community_string

A string the NIOS appliance sends to the management system together with its traps. Note that this community string must match exactly what you enter in the management system.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

traps_enable

traps_enable

If set to True, SNMP traps are enabled.

Type

Bool.

Create

The default value is empty.

setting:syslogproxy : Syslog proxy settings.

This structure contains the syslog proxy settings for the Grid Member.

client_acls

client_acls

This list controls the IP addresses and networks that are allowed to access the syslog proxy.

Type

One of the following: Address ac struct, TSIG ac struct array.

Create

The default value is:

empty

enable

enable

If set to True, the member receives syslog messages from specified devices, such as syslog servers and routers, and then forwards these messages to an external syslog server.

Type

Bool.

Create

The default value is False.

tcp_enable

tcp_enable

If set to True, the appliance can receive messages from other devices via TCP.

Type

Bool.

Create

The default value is False.

tcp_port

tcp_port

The TCP port the appliance must listen on.

Type

Unsigned integer.

Create

The default value is 514.

udp_enable

udp_enable

If set to True, the appliance can receive messages from other devices via UDP.

Type

Bool.

Create

The default value is False.

udp_port

udp_port

The UDP port the appliance must listen on.

Type

Unsigned integer.

Create

The default value is 514.

setting:trafficcapturechr : Grid level Traffic capture chr setting.

Grid level settings for enabling DNS cache hit ratio threshold for automated traffic capture.

chr_min_cache_utilization

chr_min_cache_utilization

Minimum DNS cache utilization threshold(%) for triggering traffic capture based on DNS cache hit ratio.

Type

Unsigned integer.

Create

The default value is empty.

chr_reset

chr_reset

DNS Cache hit ratio threshold(%) above which traffic capture will be triggered.

Type

Unsigned integer.

Create

The default value is empty.

chr_threshold

chr_threshold

DNS Cache hit ratio threshold(%) below which traffic capture will be triggered.

Type

Unsigned integer.

Create

The default value is empty.

chr_trigger_enable

chr_trigger_enable

Enable triggering automated traffic capture based on cache hit ratio thresholds.

Type

Bool.

Create

The default value is False.

setting:trafficcaptureqps : Grid level traffic capture QPS setting.

Grid level settings for enabling DNS query pe second thresholds for automated traffic capture.

qps_reset

qps_reset

DNS queries per second threshold below which traffic capture will be stopped.

Type

Unsigned integer.

Create

The default value is empty.

qps_threshold

qps_threshold

DNS queries per second threshold below which traffic capture will be triggered.

Type

Unsigned integer.

Create

The default value is empty.

qps_trigger_enable

qps_trigger_enable

Enable triggering automated traffic capture based on DNS queries per second threshold.

Type

Bool.

Create

The default value is False.

setting:triggerrecdnslatency : Grid level settings for traffic capture based on recursive

DNS latency.

kpi_monitored_domains

kpi_monitored_domains

List of domains monitored by ‘Recursive DNS Latency Threshold’ trigger.

Type

A/An Monitored domains struct array.

Create

The default value is empty.

rec_dns_latency_listen_on_ip

rec_dns_latency_listen_on_ip

The DNS listen-on IP address used if rec_dns_latency_listen_on_source is IP.

Type

String.

Create

Recursive DNS latency settingis required when the interfaceset to IP.

rec_dns_latency_listen_on_source

rec_dns_latency_listen_on_source

The local IP DNS service is listen on ( for recursive DNS latency trigger).

Type

String.

Valid values are:
  • IP
  • LAN2_V4
  • LAN2_V6
  • MGMT_V4
  • MGMT_V6
  • VIP_V4
  • VIP_V6

Create

The default value is VIP_V4.

rec_dns_latency_reset

rec_dns_latency_reset

Recursive DNS latency above which traffic capture will be stopped.

Type

Unsigned integer.

Create

The default value is empty.

rec_dns_latency_threshold

rec_dns_latency_threshold

Recursive DNS latency below which traffic capture will be triggered.

Type

Unsigned integer.

Create

The default value is empty.

rec_dns_latency_trigger_enable

rec_dns_latency_trigger_enable

Enable triggering automated traffic capture based on recursive DNS latency.

Type

Bool.

Create

The default value is False.

setting:triggerrecqueries : Grid level settings for traffic capture based on recursive

queries.

recursive_clients_count_reset

recursive_clients_count_reset

Concurrent outgoing recursive queries count below which traffic capture will be stopped.

Type

Unsigned integer.

Create

The default value is empty.

recursive_clients_count_threshold

recursive_clients_count_threshold

Concurrent outgoing recursive queries count below which traffic capture will be triggered.

Type

Unsigned integer.

Create

The default value is empty.

recursive_clients_count_trigger_enable

recursive_clients_count_trigger_enable

Enable triggering automated traffic capture based on outgoing recursive queries count.

Type

Bool.

Create

The default value is False.

setting:triggeruthdnslatency : Member level settings for traffic based on authoritative DNS

latency.

auth_dns_latency_listen_on_ip

auth_dns_latency_listen_on_ip

The DNS listen-on IP address used if auth_dns_latency_on_source is IP.

Type

String.

Create

Authoritative DNS latencysetting is required when theinterface is set to IP.

auth_dns_latency_listen_on_source

auth_dns_latency_listen_on_source

The local IP DNS service is listen on (for authoritative DNS latency trigger).

Type

String.

Valid values are:
  • IP
  • LAN2_V4
  • LAN2_V6
  • MGMT_V4
  • MGMT_V6
  • VIP_V4
  • VIP_V6

Create

The default value is VIP_V4.

auth_dns_latency_reset

auth_dns_latency_reset

Authoritative DNS latency above which traffic capture will stopped.

Type

Unsigned integer.

Create

The default value is empty.

auth_dns_latency_threshold

auth_dns_latency_threshold

Authoritative DNS latency below which traffic capture will be triggered.

Type

Unsigned integer.

Create

The default value is empty.

auth_dns_latency_trigger_enable

auth_dns_latency_trigger_enable

Enabling trigger automated traffic capture based on authoritative DNS latency.

Type

Bool.

Create

The default value is False.

setting:viewaddress : Notify and query source settings.

dns_notify_transfer_source

dns_notify_transfer_source

Determines which IP address is used as the source for DDNS notify and transfer operations.

Type

String.

Valid values are:
  • ANY
  • IP
  • LAN2
  • MGMT
  • VIP

Create

The default value is VIP.

dns_notify_transfer_source_address

dns_notify_transfer_source_address

The source address used if dns_notify_transfer_source type is “IP”.

Type

String.

Create

The default value is empty.

dns_query_source_address

dns_query_source_address

The source address used if dns_query_source_interface type is “IP”.

Type

String.

Create

The default value is empty.

dns_query_source_interface

dns_query_source_interface

Determines which IP address is used as the source for DDNS query operations.

Type

String.

Valid values are:
  • ANY
  • IP
  • LAN2
  • MGMT
  • VIP

Create

The default value is VIP.

enable_notify_source_port

enable_notify_source_port

Determines if the notify source port for a view is enabled or not.

Type

Bool.

Create

The default value is False.

Notes

enable_notify_source_port is associated with the field use_source_ports (see use flag).

enable_query_source_port

enable_query_source_port

Determines if the query source port for a view is enabled or not.

Type

Bool.

Create

The default value is False.

Notes

enable_query_source_port is associated with the field use_source_ports (see use flag).

notify_delay

notify_delay

Specifies the number of seconds of delay the notify messages are sent to secondaries.

Type

Unsigned integer.

Create

The default value is 5.

Notes

notify_delay is associated with the field use_notify_delay (see use flag).

notify_source_port

notify_source_port

The source port for notify messages. When requesting zone transfers from the primary server, some secondary DNS servers use the source port number (the primary server used to send the notify message) as the destination port number in the zone transfer request. This setting overrides Grid static source port settings.

Valid values are between 1 and 63999. The default is selected by BIND.

Type

Unsigned integer.

Create

The default value is empty.

Notes

notify_source_port is associated with the field use_source_ports (see use flag).

query_source_port

query_source_port

The source port for queries. Specifying a source port number for recursive queries ensures that a firewall will allow the response.

Valid values are between 1 and 63999. The default is selected by BIND.

Type

Unsigned integer.

Create

The default value is empty.

Notes

query_source_port is associated with the field use_source_ports (see use flag).

use_notify_delay

use_notify_delay

Use flag for: notify_delay

Type

Bool.

Create

The default value is False.

use_source_ports

use_source_ports

Use flag for: enable_notify_source_port , notify_source_port, enable_query_source_port, query_source_port

Type

Bool.

Create

The default value is False.

view_name

view_name

The reference to DNS View

Type

String.

Create

The default value is undefined.

smartfolder:groupby : Smart Folder group by structure.

The Smart Folder group by structure defines grouping information in a global or personal Smart Folder.

enable_grouping

enable_grouping

Determines whether the grouping is enabled.

Type

Bool.

Create

The default value is False.

value

value

The name of the Smart Folder grouping attribute.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

value_type

value_type

The type of the Smart Folder grouping attribute value.

Type

String.

Valid values are:
  • EXTATTR
  • NORMAL

Create

The default value is NORMAL.

smartfolder:groupbyvalue : Smart Folder group by value structure.

This structure is used to query the Smart Folder children items.

name

name

The extensible attribute, object type or object name that is used to group objects.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

value

value

The value of the extensible attribute, object type or object name.

Type

String.

Create

The field is required on creation.

smartfolder:queryitem : Smart Folder query item structure.

The Smart Folder query item contains information about a query to be stored in a global or personal Smart Folder.

field_type

field_type

The Smart Folder query field type.

Type

String.

Valid values are:
  • EXTATTR
  • NORMAL

Create

The field is required on creation.

name

name

The Smart Folder query name.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

op_match

op_match

Determines whether the query operator should match.

Type

Bool.

Create

The default value is True.

operator

operator

The Smart Folder operator used in query.

Type

String.

Valid values are:
  • BEGINS_WITH
  • CONTAINS
  • DROPS_BY
  • ENDS_WITH
  • EQ
  • GEQ
  • GT
  • HAS_VALUE
  • INHERITANCE_STATE_EQUALS
  • IP_ADDR_WITHIN
  • LEQ
  • LT
  • MATCH_EXPR
  • RELATIVE_DATE
  • RISES_BY
  • SUFFIX_MATCH

Create

The field is required on creation.

value

value

The Smart Folder query value.

Type

A/An Smart Folder query item value structure struct.

Create

The default value is undefined.

value_type

value_type

The Smart Folder query value type.

Type

String.

Valid values are:
  • BOOLEAN
  • DATE
  • EMAIL
  • ENUM
  • INTEGER
  • OBJTYPE
  • STRING
  • URL

Create

The default value is STRING.

smartfolder:queryitemvalue : Smart Folder query item value structure.

The Smart Folder query item value contains the value used for the query.

value_boolean

value_boolean

The boolean value of the Smart Folder query.

Type

Bool.

Create

The default value is undefined.

value_date

value_date

The timestamp value of the Smart Folder query.

Type

Timestamp.

Create

The default value is undefined.

value_integer

value_integer

The integer value of the Smart Folder query.

Type

Integer.

Create

The default value is undefined.

value_string

value_string

The string value of the Smart Folder query.

Type

String.

Create

The default value is undefined.

sortlist : DNS Sortlist.

A sortlist defines the order of IP addresses listed in responses sent to DNS queries.

address

address

The source address of a sortlist object.

Type

String.

Create

The field is required on creation.

Notes

The address is part of the base object.

match_list

match_list

The match list of a sortlist.

Type

String array.

Create

The default value is empty.

subjectalternativename : Subject alternative name structure.

type

type

Type for alternative name for certificate.

Type

String.

Valid values are:
  • DNS
  • EMAIL
  • IP
  • URI

Create

The field is required on creation.

value

value

Information for current type.

Type

String.

Create

The field is required on creation.

syslog:endpoint:servers : Syslog server structure

Contains parameres for creatig server. User can create multile server for one syslog endpoint.

address

address

Syslog Server IP address

Type

String.

Create

The field is required on creation.

certificate

certificate

Reference for creating sysog endpoint server.

Type

String.

This field supports nested return fields as described here.

Notes

The certificate cannot be updated.

certificate cannot be written.

certificate_token

certificate_token

The token returned by the uploadinit function call in object fileop.

Type

String.

Create

Field returned is required if connection_type is “stcp”.

Notes

certificate_token is not readable.

connection_type

connection_type

Connection type values

Type

String.

Valid values are:
  • stcp
  • tcp
  • udp

Create

The default value is udp.

facility

facility

Facility values for syslog endpoint server

Type

String.

Valid values are:
  • local0
  • local1
  • local2
  • local3
  • local4
  • local5
  • local6
  • local7

Create

The default value is local0.

format

format

Format vlues for syslog endpoint server

Type

String.

Valid values are:
  • formatted
  • raw

Create

The default value is raw.

hostname

hostname

List of hostnames

Type

String.

Valid values are:
  • FQDN
  • HOSTNAME
  • IP_ADDRESS

Create

The default value is HOSTNAME.

port

port

The port this server listens on.

Type

Unsigned integer.

Create

The default value is 514.

severity

severity

Severity values for syslog endpoint server.

Type

String.

Valid values are:
  • alert
  • crit
  • debug
  • emerg
  • err
  • info
  • notice
  • warning

Create

The default value is debug.

syslogserver : Syslog server.

This structure contains information about a remote syslog server.

address

address

The server address.

Type

String.

Create

The field is required on creation.

category_list

category_list

The list of all syslog logging categories.

Type

Enum values array.

Valid values are:
  • ATP
  • AUTH_ACTIVE_DIRECTORY
  • AUTH_COMMON
  • AUTH_LDAP
  • AUTH_NON_SYSTEM
  • AUTH_RADIUS
  • AUTH_TACACS
  • AUTH_UI_API
  • CLOUD_API
  • DHCPD
  • DNS_CLIENT
  • DNS_CONFIG
  • DNS_DATABASE
  • DNS_DNSSEC
  • DNS_GENERAL
  • DNS_LAME_SERVERS
  • DNS_NETWORK
  • DNS_NOTIFY
  • DNS_QUERIES
  • DNS_QUERY_REWRITE
  • DNS_RESOLVER
  • DNS_RESPONSES
  • DNS_RPZ
  • DNS_SCAVENGING
  • DNS_SECURITY
  • DNS_UNBOUND
  • DNS_UPDATE
  • DNS_UPDATE_SECURITY
  • DNS_XFER_IN
  • DNS_XFER_OUT
  • DTC_HEALTHD
  • DTC_IDNSD
  • FTPD
  • MS_AD_USERS
  • MS_CONNECT_STATUS
  • MS_DHCP_CLEAR_LEASE
  • MS_DHCP_LEASE
  • MS_DHCP_SERVER
  • MS_DNS_SERVER
  • MS_DNS_ZONE
  • MS_SITES
  • NON_CATEGORIZED
  • NTP
  • OUTBOUND_API
  • TFTPD

Create

The default value is empty.

certificate

certificate

Reference to the underlying X509Certificate object.

Type

String.

This field supports nested return fields as described here.

Notes

The certificate cannot be updated.

certificate cannot be written.

certificate_token

certificate_token

The token returned by the uploadinit function call in object fileop.

Type

String.

Create

Field returned is required if connection_type is “STCP”.

Notes

certificate_token is not readable.

connection_type

connection_type

The connection type for communicating with this server.

Type

String.

Valid values are:
  • STCP
  • TCP
  • UDP

Create

The default value is UDP.

local_interface

local_interface

The local interface through which the appliance sends syslog messages to the syslog server.

Type

String.

Valid values are:
  • ANY
  • LAN
  • MGMT

Create

The default value is ANY.

message_node_id

message_node_id

Identify the node in the syslog message.

Type

String.

Valid values are:
  • HOSTNAME
  • IP_HOSTNAME
  • LAN
  • MGMT

Create

The default value is LAN.

message_source

message_source

The source of syslog messages to be sent to the external syslog server. If set to ‘INTERNAL’, only messages the appliance generates will be sent to the syslog server.

If set to ‘EXTERNAL’, the appliance sends syslog messages that it receives from other devices, such as syslog servers and routers.

If set to ‘ANY’, the appliance sends both internal and external syslog messages.

Type

String.

Valid values are:
  • ANY
  • EXTERNAL
  • INTERNAL

Create

The default value is ANY.

only_category_list

only_category_list

The list of selected syslog logging categories. The appliance forwards syslog messages that belong to the selected categories.

Type

Bool.

Create

The default value is False.

port

port

The port this server listens on.

Type

Unsigned integer.

Create

The default value is 514.

severity

severity

The severity filter. The appliance sends log messages of the specified severity and above to the external syslog server.

Type

String.

Valid values are:
  • ALERT
  • CRIT
  • DEBUG
  • EMERG
  • INFO
  • NOTICE
  • WARNING

Create

The default value is DEBUG.

tacacsplus:server : The TACACS+ server structure.

This structure is used for TACACS+ authentication configuration.

address

address

The valid IP address or FQDN of the TACACS+ server.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

auth_type

auth_type

The authentication protocol.

Type

String.

Valid values are:
  • ASCII
  • CHAP
  • PAP

Create

The default value is CHAP.

comment

comment

The TACACS+ descriptive comment.

Type

String.

Create

The default value is undefined.

disable

disable

Determines whether the TACACS+ server is disabled.

Type

Bool.

Create

The default value is False.

port

port

The TACACS+ server port.

Type

Unsigned integer.

Create

The default value is 49.

shared_secret

shared_secret

The secret key with which to connect to the TACACS+ server.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

Notes

shared_secret is not readable.

use_accounting

use_accounting

Determines whether the TACACS+ accounting server is used.

Type

Bool.

Create

The default value is False.

use_mgmt_port

use_mgmt_port

Determines whether the TACACS+ server is connected via the management interface.

Type

Bool.

Create

The default value is False.

taxii:rpzconfig : Taxii Member RPZ Configuration.

The Taxii Member RPZ Configuration object provides configuration for RPZ rule creation through the Taxii protocol. Each Grid member running the Taxii server can support a separate set of RPZs. The RPZs are accessible through a user-configurable name for the STIX collection.

collection_name

collection_name

The STIX collection name.

Type

String.

Create

The field is required on creation.

zone

zone

The reference to the RPZ in which rules are created through the Taxii protocol requests.

Type

String.

This field supports nested return fields as described here.

Create

The field is required on creation.

threatprotection:natport : NAT Threat Protection Port.

The structure provides information about the port blocks configured for NAT mapping.

block_size

block_size

The block size for the NAT Port configuration object.

Type

Unsigned integer.

Create

The field is required on creation.

end_port

end_port

The end port value for the NAT port configuration object.

Type

Unsigned integer.

Create

The field is required on creation.

start_port

start_port

The start port value for the NAT port configuration object.

Type

Unsigned integer.

Create

The field is required on creation.

threatprotection:natrule : NAT Threat Protection Rule.

The structure provides information about NAT rules configured for the threat protection NAT mapping feature.

address

address

The IP address for the threat protection NAT mapping rule.

Type

String.

Create

You must specify the address when the rule_type is set to ‘ADDRESS’.

cidr

cidr

The network CIDR for the threat protection NAT mapping rule.

Type

Unsigned integer.

Create

You must specify the cidr when the rule_type is set to ‘NETWORK’.

end_address

end_address

The end address for the range of the threat protection NAT mapping rule.

Type

String.

Create

You must specify the end_address when the rule_type is set to ‘RANGE’.

nat_ports

nat_ports

The NAT port configuration for the threat protection NAT mapping rule.

Type

A/An NAT Threat Protection Port struct array.

Create

The field is required on creation.

network

network

The network address for the threat protection NAT mapping rule.

Type

String.

Create

You must specify the network when the rule_type is set to ‘NETWORK’.

rule_type

rule_type

The rule type for the threat protection NAT mapping rule.

Type

String.

Valid values are:
  • ADDRESS
  • NETWORK
  • RANGE

Create

The field is required on creation.

start_address

start_address

The start address for the range of the threat protection NAT mapping rule.

Type

String.

Create

You must specify the start_address when the rule_type is set to ‘RANGE’.

threatprotection:ruleconfig : Threat protection rule configuration.

The structure provides information about threat protection rule configuration.

action

action

The rule action.

Type

String.

Valid values are:
  • ALERT
  • DROP
  • PASS

Create

The field is required on creation.

log_severity

log_severity

The rule log severity.

Type

String.

Valid values are:
  • CRITICAL
  • INFORMATIONAL
  • MAJOR
  • WARNING

Create

The field is required on creation.

params

params

The threat protection rule parameters.

Type

A/An Threat protection rule parameter struct array.

Create

The default value is undefined.

threatprotection:ruleparam : Threat protection rule parameter.

The structure provides information about the threat protection rule parameter.

description

description

The rule parameter description.

Type

String.

Notes

The description cannot be updated.

description cannot be written.

enum_values

enum_values

The rule parameter enum values.

Type

String array.

Notes

The enum_values cannot be updated.

enum_values cannot be written.

max

max

The rule parameter maximum.

Type

Unsigned integer.

Notes

The max cannot be updated.

max cannot be written.

min

min

The rule parameter minimum.

Type

Unsigned integer.

Notes

The min cannot be updated.

min cannot be written.

name

name

The rule parameter name.

Type

String.

Create

The field is required on creation.

read_only

read_only

Determines if parameter value is editable at member level.

Type

Bool.

Notes

The read_only cannot be updated.

read_only cannot be written.

syntax

syntax

The rule parameter syntax.

Type

String.

Notes

The syntax cannot be updated.

syntax cannot be written.

value

value

The rule parameter value.

Type

String.

Create

The field is required on creation.

threatprotection:statinfo : Threat protection statistical information.

The structure provides information about threat protection statistical information configuration.

critical

critical

The number of critical events.

Type

Unsigned long integer.

Create

The default value is undefined.

informational

informational

The number of informational events.

Type

Unsigned long integer.

Create

The default value is undefined.

major

major

The number of major events.

Type

Unsigned long integer.

Create

The default value is undefined.

timestamp

timestamp

The timestamp when data was collected.

Type

Timestamp.

Notes

The timestamp cannot be updated.

timestamp cannot be written.

total

total

The total number of events.

Type

Unsigned long integer.

Create

The default value is undefined.

warning

warning

The number of warning events.

Type

Unsigned long integer.

Create

The default value is undefined.

thresholdtrap : The Grid SNMP threshold trap structure.

This structure is used to set the values of the thresholds of the SNMP traps.

trap_reset

trap_reset

Determines the threshold value to reset the trap.

Type

Unsigned integer.

Create

The default value is The default value depends on the trap_type.

trap_trigger

trap_trigger

Determines the threshold value to trigger the trap.

Type

Unsigned integer.

Create

The default value is The default value depends on the trap_type.

trap_type

trap_type

Determines the type of a given trap.

Type

String.

Valid values are:
  • CpuUsage
  • DBObjects
  • Disk
  • ExtStorage
  • FDUsage
  • IPAMUtilization
  • Memory
  • NetworkCapacity
  • RPZHitRate
  • RecursiveClients
  • Reporting
  • ReportingVolume
  • Rootfs
  • SwapUsage
  • TcpUdpFloodAlertRate
  • TcpUdpFloodDropRate
  • ThreatProtectionDroppedTraffic
  • ThreatProtectionTotalTraffic

Create

The field is required on creation.

trapnotification : The Grid SNMP trap notification structure.

This structure represents the trap notification settings of the Grid and Member objects. The structure determines which trap categories are enabled, and for which trap categories mail notification will be sent.

enable_email

enable_email

Determines if the email notifications for the given trap are enabled or not.

Type

Bool.

Create

The default value is False.

enable_trap

enable_trap

Determines if the trap is enabled or not.

Type

Bool.

Create

The default value is True.

trap_type

trap_type

Determines the type of a given trap.

Type

String.

Valid values are:
  • AnalyticsRPZ
  • AutomatedTrafficCapture
  • BFD
  • BGP
  • Backup
  • Bloxtools
  • CPU
  • CaptivePortal
  • CiscoISEServer
  • Clear
  • CloudAPI
  • Cluster
  • Controld
  • DHCP
  • DNS
  • DNSAttack
  • DNSIntegrityCheck
  • DNSIntegrityCheckConnection
  • Database
  • DisconnectedGrid
  • Discovery
  • DiscoveryConflict
  • DiscoveryUnmanaged
  • Disk
  • DuplicateIP
  • ENAT
  • FDUsage
  • FTP
  • Fan
  • HA
  • HSM
  • HTTP
  • IFMAP
  • IMC
  • IPAMUtilization
  • IPMIDevice
  • LCD
  • LDAPServers
  • License
  • Login
  • MGM
  • MSServer
  • Memory
  • NTP
  • Network
  • OCSPResponders
  • OSPF
  • OSPF6
  • Outbound
  • PowerSupply
  • RAID
  • RIRSWIP
  • RPZHitRate
  • RecursiveClients
  • Reporting
  • RootFS
  • SNMP
  • SSH
  • SerialConsole
  • SwapUsage
  • Syslog
  • System
  • TFTP
  • Taxii
  • ThreatAnalytics
  • ThreatProtection

Create

The field is required on creation.

trapreceiver : Trap receiver.

This structure contains information about an SNMP trap receiver.

address

address

The address of the trap receiver.

Type

String.

Create

The default value is empty.

comment

comment

A descriptive comment for this trap receiver.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

user

user

The SNMPv3 user for this trap receiver.

Type

String.

Create

The default value is empty.

tsigac : TSIG ac.

This struct represents a TSIG key.

tsig_key

tsig_key

A generated TSIG key. If the external primary server is a NIOS appliance running DNS One 2.x code, this can be set to :2xCOMPAT.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

tsig_key_alg

tsig_key_alg

The TSIG key algorithm.

Type

String.

Valid values are:
  • HMAC-MD5
  • HMAC-SHA256

Create

The default value is HMAC-MD5.

tsig_key_name

tsig_key_name

The name of the TSIG key. If 2.x TSIG compatibility is used, this is set to ‘tsig_xfer’ on retrieval, and ignored on insert or update.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

Notes

tsig_key_name is associated with the field use_tsig_key_name (see use flag).

use_tsig_key_name

use_tsig_key_name

Use flag for: tsig_key_name

Type

Bool.

Create

The default value is False.

updatesdownloadmemberconfig : Updates Download Member Configuration.

The Updates Download Member Configuration structure provides information and settings for configuring the member that is responsible for downloading updates.

interface

interface

The source interface for updates download requests.

Type

String.

Valid values are:
  • ANY
  • LAN1
  • LAN2
  • MGMT

Create

The field is required on creation.

is_online

is_online

Determines if the updates download member is online or not.

Type

Bool.

Notes

The is_online cannot be updated.

is_online cannot be written.

member

member

The name of the updates download member.

Type

String.

Create

The default value is undefined.

upgradegroup:member : Upgrade group member structure.

This structure represents the upgrade group member settings.

member

member

The upgrade group member name.

Type

String.

Create

The field is required on creation.

time_zone

time_zone

The upgrade group member time zone.

Type

String.

Valid values are:
  • (UTC + 10:00) Brisbane
  • (UTC + 10:00) Canberra, Sydney
  • (UTC + 10:00) Guam
  • (UTC + 10:00) Hobart
  • (UTC + 10:00) Melbourne, Victoria
  • (UTC + 10:00) Vladivostok
  • (UTC + 11:00) Magadan
  • (UTC + 11:00) Solomon Islands
  • (UTC + 12:00) Anadyr
  • (UTC + 12:00) Auckland
  • (UTC + 12:00) Fiji
  • (UTC + 12:00) Marshall Islands
  • (UTC + 1:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna
  • (UTC + 1:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague
  • (UTC + 1:00) Brussels, Copenhagen, Madrid, Paris
  • (UTC + 1:00) Casablanca
  • (UTC + 1:00) Sarajevo, Skopje, Sofija, Warsaw, Zagreb
  • (UTC + 2:00) Athens, Vilnius
  • (UTC + 2:00) Bucharest
  • (UTC + 2:00) Cairo
  • (UTC + 2:00) Harare
  • (UTC + 2:00) Helsinki
  • (UTC + 2:00) Jerusalem
  • (UTC + 2:00) Kaliningrad
  • (UTC + 3:00) Baghdad, Istanbul, Kuwait, Minsk, Riyadh
  • (UTC + 3:00) Moscow, St. Petersburg, Volgograd
  • (UTC + 3:00) Nairobi
  • (UTC + 3:30) Tehran
  • (UTC + 4:00) Baku
  • (UTC + 4:00) Dubai
  • (UTC + 4:00) Samara
  • (UTC + 4:30) Kabul
  • (UTC + 5:00) Ekaterinburg
  • (UTC + 5:00) Islamabad, Karachi
  • (UTC + 5:30) Bombay, Calcutta, Madras, New Delhi
  • (UTC + 5:30) Colombo
  • (UTC + 6:00) Dhaka
  • (UTC + 6:00) Omsk
  • (UTC + 6:30) Rangoon
  • (UTC + 7:00) Bangkok, Hanoi
  • (UTC + 7:00) Krasnoyarsk
  • (UTC + 8:00) Beijing, Chongqing, Shanghai
  • (UTC + 8:00) Hong Kong
  • (UTC + 8:00) Irkutsk
  • (UTC + 8:00) Perth
  • (UTC + 8:00) Singapore
  • (UTC + 8:00) Taipei
  • (UTC + 9:00) Osaka, Sapporo, Tokyo
  • (UTC + 9:00) Seoul
  • (UTC + 9:00) Yakutsk
  • (UTC + 9:30) Adelaide
  • (UTC + 9:30) Darwin
  • (UTC - 10:00) Hawaii
  • (UTC - 11:00) Midway Island, Samoa
  • (UTC - 12:00)
  • (UTC - 1:00) Azores
  • (UTC - 2:00) Mid-Atlantic
  • (UTC - 3:00) Brasilia
  • (UTC - 3:00) Buenos Aires
  • (UTC - 3:30) Newfoundland
  • (UTC - 4:00) Atlantic Time (Canada)
  • (UTC - 4:00) Caracas
  • (UTC - 4:00) Santiago
  • (UTC - 5:00) Bogota, Lima, Quito
  • (UTC - 5:00) Eastern Time (US and Canada)
  • (UTC - 5:00) Indiana (East)
  • (UTC - 6:00) Central Time (US and Canada)
  • (UTC - 6:00) Mexico City, Tegucigalpa
  • (UTC - 6:00) Saskatchewan
  • (UTC - 7:00) Arizona
  • (UTC - 7:00) Mountain Time (US and Canada)
  • (UTC - 8:00) Pacific Time (US and Canada), Tijuana
  • (UTC - 9:00) Alaska
  • (UTC) Coordinated Universal Time
  • (UTC) Dublin
  • (UTC) Lisbon
  • (UTC) London

Notes

The time_zone cannot be updated.

time_zone cannot be written.

upgradegroup:schedule : Upgrade schedule group structure.

This structure is used to configure upgrade scheduling for groups.

distribution_dependent_group

distribution_dependent_group

The distribution dependent group name.

Type

String.

Create

The default value is empty.

distribution_time

distribution_time

The time of the next scheduled distribution.

Type

Timestamp.

Create

The default value is 0.

name

name

The upgrade group name.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

time_zone

time_zone

The time zone for scheduling operations.

Type

String.

Valid values are:
  • (UTC + 10:00) Brisbane
  • (UTC + 10:00) Canberra, Sydney
  • (UTC + 10:00) Guam
  • (UTC + 10:00) Hobart
  • (UTC + 10:00) Melbourne, Victoria
  • (UTC + 10:00) Vladivostok
  • (UTC + 11:00) Magadan
  • (UTC + 11:00) Solomon Islands
  • (UTC + 12:00) Anadyr
  • (UTC + 12:00) Auckland
  • (UTC + 12:00) Fiji
  • (UTC + 12:00) Marshall Islands
  • (UTC + 1:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna
  • (UTC + 1:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague
  • (UTC + 1:00) Brussels, Copenhagen, Madrid, Paris
  • (UTC + 1:00) Casablanca
  • (UTC + 1:00) Sarajevo, Skopje, Sofija, Warsaw, Zagreb
  • (UTC + 2:00) Athens, Vilnius
  • (UTC + 2:00) Bucharest
  • (UTC + 2:00) Cairo
  • (UTC + 2:00) Harare
  • (UTC + 2:00) Helsinki
  • (UTC + 2:00) Jerusalem
  • (UTC + 2:00) Kaliningrad
  • (UTC + 3:00) Baghdad, Istanbul, Kuwait, Minsk, Riyadh
  • (UTC + 3:00) Moscow, St. Petersburg, Volgograd
  • (UTC + 3:00) Nairobi
  • (UTC + 3:30) Tehran
  • (UTC + 4:00) Baku
  • (UTC + 4:00) Dubai
  • (UTC + 4:00) Samara
  • (UTC + 4:30) Kabul
  • (UTC + 5:00) Ekaterinburg
  • (UTC + 5:00) Islamabad, Karachi
  • (UTC + 5:30) Bombay, Calcutta, Madras, New Delhi
  • (UTC + 5:30) Colombo
  • (UTC + 6:00) Dhaka
  • (UTC + 6:00) Omsk
  • (UTC + 6:30) Rangoon
  • (UTC + 7:00) Bangkok, Hanoi
  • (UTC + 7:00) Krasnoyarsk
  • (UTC + 8:00) Beijing, Chongqing, Shanghai
  • (UTC + 8:00) Hong Kong
  • (UTC + 8:00) Irkutsk
  • (UTC + 8:00) Perth
  • (UTC + 8:00) Singapore
  • (UTC + 8:00) Taipei
  • (UTC + 9:00) Osaka, Sapporo, Tokyo
  • (UTC + 9:00) Seoul
  • (UTC + 9:00) Yakutsk
  • (UTC + 9:30) Adelaide
  • (UTC + 9:30) Darwin
  • (UTC - 10:00) Hawaii
  • (UTC - 11:00) Midway Island, Samoa
  • (UTC - 12:00)
  • (UTC - 1:00) Azores
  • (UTC - 2:00) Mid-Atlantic
  • (UTC - 3:00) Brasilia
  • (UTC - 3:00) Buenos Aires
  • (UTC - 3:30) Newfoundland
  • (UTC - 4:00) Atlantic Time (Canada)
  • (UTC - 4:00) Caracas
  • (UTC - 4:00) Santiago
  • (UTC - 5:00) Bogota, Lima, Quito
  • (UTC - 5:00) Eastern Time (US and Canada)
  • (UTC - 5:00) Indiana (East)
  • (UTC - 6:00) Central Time (US and Canada)
  • (UTC - 6:00) Mexico City, Tegucigalpa
  • (UTC - 6:00) Saskatchewan
  • (UTC - 7:00) Arizona
  • (UTC - 7:00) Mountain Time (US and Canada)
  • (UTC - 8:00) Pacific Time (US and Canada), Tijuana
  • (UTC - 9:00) Alaska
  • (UTC) Coordinated Universal Time
  • (UTC) Dublin
  • (UTC) Lisbon
  • (UTC) London

Notes

The time_zone cannot be updated.

time_zone cannot be written.

upgrade_dependent_group

upgrade_dependent_group

The upgrade dependent group name.

Type

String.

Create

The default value is empty.

upgrade_time

upgrade_time

The time of the next scheduled upgrade.

Type

Timestamp.

Create

The default value is 0.

upgradestep : Upgrade process step.

The structure provides information about the status of the upgrade process step.

status_text

status_text

The status text that describes a step.

Type

String.

Create

The default value is undefined.

status_value

status_value

The status value of a step.

Type

String.

Valid values are:
  • COMPLETED
  • FAILURE
  • NOT_CONNECTED
  • NO_STATUS
  • PROGRESSING

Create

The default value is undefined.

vtftpdirmember : Virtual TFTP directory member.

The Virtual TFTP directory member structure is used to create a Virtual TFTP root directory for a specific IP address, network or range of IP addresses. Note that Virtual TFTP root is supported only for file downloads, but not for file uploads using TFTP clients.

address

address

The IP address of the clients which will see the virtual TFTP directory as the root directory.

Type

String.

Create

You must specify the address when the ip_type is set to ‘ADDRESS’

cidr

cidr

The CIDR of network the clients from which will see the virtual TFTP directory as the root directory.

Type

Unsigned integer.

Create

You must specify the cidr when the ip_type is set to ‘NETWORK’

end_address

end_address

The end IP address of the range within which the clients will see the virtual TFTP directory as the root directory.

Type

String.

Create

You must specify the end_address when the ip_type is set to ‘RANGE’

ip_type

ip_type

The IP type of the virtual TFTP root directory.

Type

String.

Valid values are:
  • ADDRESS
  • NETWORK
  • RANGE

Create

The field is required on creation.

member

member

The Grid member on which to create the virtual TFTP directory.

Type

String.

Create

The field is required on creation.

network

network

The IP address of network the clients from which will see the virtual TFTP directory as the root directory.

Type

String.

Create

You must specify the network when the ip_type is set to ‘NETWORK’

start_address

start_address

The start IP address of the range within which the clients will see the virtual TFTP directory as the root directory.

Type

String.

Create

You must specify the start_address when the ip_type is set to ‘RANGE’

zoneassociation : Zone association.

You can associate IPv4 and IPv6 networks with DNS zones to limit the zones that admins can use when they create DNS records for IP addresses in the networks. When a network is associated with one or more zones and an admin creates a DNS record for one of its IP addresses, the appliance allows the admin to create the DNS record in the associated zones only. For example, if you associate the 10.1.0.0/16 network with the corp100.com zone, admins are allowed to create DNS records in the corp100.com zone only for IP addresses in the 10.1.0.0/16 network; or if you associate the 2001:db8:1::/48 network with the corp200.com zone, admins are allowed to create DNS records in the corp200.com zone only for IP addresses in the 2001:db8:1::/48 network.

This feature applies to A, AAAA and host records only. It does not apply to records in a shared record group. If you are creating a host record with multiple IP addresses in different networks, the networks must be associated with the zone of the host record.

If a network is not associated with a zone, admins can create DNS records for its IP addresses only in zones with no network associations as well.

You can associate a network with any authoritative zone whose primary server is a Grid member or a Microsoft server, or is unassigned. You cannot associate networks with zones that have external primary servers.

You can associate a network with multiple zones, and associate a zone with more than one network. You can associate IPv4 and IPv6 network containers and networks with zones. When you associate a network container with zones, its networks inherit the zone associations. You can override the zone associations at the network level.

If you split a network, the resulting subnets inherit the zone associations. If you join networks, the resulting network retains the zone associations of the network that you selected when you performed the join operation. You can override the inherited zone associations of individual networks. Subzones do not inherit the network associations of their parent zones.

When you import data into a zone that is associated with a list of networks, the imported A, AAAA and host records must have IP addresses in the associated networks. Grid Manager does not allow you to import A, AAAA and host records with IP addresses in unassociated networks.

When you associate a network with a zone, the DNS records created before the association are not affected. But if you edit an A, AAAA or host record after the association, Grid Manager does not allow you to save the record if its IP address is not in an associated network.

fqdn

fqdn

The FQDN of the authoritative forward zone.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

is_default

is_default

True if this is the default zone.

Type

Bool.

Create

The default value is undefined.

view

view

The view to which the zone belongs. If a view is not specified, the default view is used.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is undefined.

zonenameserver : Zone Name Server.

The Zone Name Server structure provides IP address information for the name server associated with a NS record.

address

address

The address of the Zone Name Server.

Type

String.

Create

The field is required on creation.

auto_create_ptr

auto_create_ptr

Flag to indicate if ptr records need to be auto created.

Type

Bool.

Create

The default value is True.

zonerolloverinfo : The zone rollover information structure.

This structure is used for displaying zone rollover information.

days

days

The number of days that are left before the rollover period expires. Negative values are assigned if the period has expired.

Type

Integer.

Create

The default value is undefined.

display_domain

display_domain

The domain name of the signed zone.

Type

String.

Create

The default value is undefined.

view

view

The name of the view to which the zone belongs.

Type

String.

Create

The default value is undefined.

zone

zone

The reference to a signed zone whose KSK rollover time falls within the countdown days.

Type

String.

This field supports nested return fields as described here.

Create

The default value is undefined.

Table Of Contents