primary¶
- primary¶
Determines if the current address is the primary VLAN address or not.
Type
Bool.
Create
The default value is True.
Represents an AD authentication server (i.e., domain controller) that is used to authenticate administrators.
The authentication port.
Type
Unsigned integer.
Create
The default value is 389.
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.
Determines if the AD authorization server is disabled.
Type
Bool.
Create
The default value is False.
The type of encryption to use.
Type
String.
Create
The default value is NONE.
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.
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).
This struct represents an access control rule for an address.
This structure contains the set commands for admin command group.
If True then disable all fields
Type
Bool.
Create
The default value is False.
If True then enable all fields
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
This structure contains the show commands for admin command group.
If True then disable all fields
Type
Bool.
Create
The default value is False.
If True then enable all fields
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
This structure contains the toplevel commands for admin command group.
If True then disable all fields
Type
Bool.
Create
The default value is False.
If True then enable all fields
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
This structure contains the set commands for cloud command group.
If True then disable all fields
Type
Bool.
Create
The default value is False.
If True then enable all fields
Type
Bool.
Create
The default value is False.
This structure contains the show commands for cloud command group.
If True then disable all fields
Type
Bool.
Create
The default value is False.
This structure contains the set commands for databse command group
If True then disable all fields
Type
Bool.
Create
The default value is False.
If True then enable all fields
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
This structure contains the show commands for datebase command group.
If True then disable all fields
Type
Bool.
Create
The default value is False.
If True then enable all fields
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
This structure contains the set commands for DHCP command group.
If True then disable all fields
Type
Bool.
Create
The default value is False.
If True then enable all fields
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
This structure contains the show commands for DHCP command group.
If True then disable all fields
Type
Bool.
Create
The default value is False.
If True then enable all fields
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
This structure contains the set commands for DNS command group.
If True then disable all fields
Type
Bool.
Create
The default value is False.
If True then enable all fields
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
This structure contains the show commands for DNS command group.
If True then disable all fields
Type
Bool.
Create
The default value is False.
If True then enable all fields
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
This structure contains the toplevel commands for DNS command group.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then disable all fields
Type
Bool.
Create
The default value is False.
This structure contains the set commands for Docker command group.
If True then disable all fields
Type
Bool.
Create
The default value is False.
This structure contains the show commands for Docker command group.
If True then disable all fields
Type
Bool.
Create
The default value is False.
This structure contains the set commands for Grid command group.
If True then disable all fields
Type
Bool.
Create
The default value is False.
If True then enable all fields
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
This structure contains the show commands for Grid command group.
If True then disable all fields
Type
Bool.
Create
The default value is False.
If True then enable all fields
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
This structure contains the set commands for Licensing command group.
If True then disable all fields
Type
Bool.
Create
The default value is False.
If True then enable all fields
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
This structure contains the show commands for Licensing command group.
If True then disable all fields
Type
Bool.
Create
The default value is False.
If True then enable all fields
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
This is a new struct to specify security policy settings.
Enable/disable sequential failed login attempts lockout for local users
Type
Bool.
Create
The default value is False.
Time period the account remains locked after sequential failed login attempt lockout.
Type
Unsigned integer.
Create
The default value is 60.
This structure contains the toplevel commands for machine controlcommand group.
If True then disable all fields
Type
Bool.
Create
The default value is False.
If True then enable all fields
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
This structure contains the set commands for networkig command group.
If True then disable all fields
Type
Bool.
Create
The default value is False.
If True then enable all fields
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
This structure contains the show commands for networking command group.
If True then disable all fields
Type
Bool.
Create
The default value is False.
If True then enable all fields
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
This structure contains password settings related to each admin groups.
The days that password must expire
Type
Unsigned integer.
Create
The default value is 30.
This structure contains SAML settings related to each admin group.
This structure contains the set commands for security command group.
If True then disable all fields
Type
Bool.
Create
The default value is False.
If True then enable all fields
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
This structure contains the show commands for security command group.
If True then disable all fields
Type
Bool.
Create
The default value is False.
If True then enable all fields
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
This structure contains the toplevel commands for Trobleshooting command group.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then disable all fields
Type
Bool.
Create
The default value is False.
If True then enable all fields
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
If True then CLI user has permission to run the command
Type
Bool.
Create
The default value is False.
This structure contains information about the Microsoft Server Active Directory Sites.
Default IP site link for sites created from NIOS
Type
String.
Create
The default value is undefined.
Notes
default_ip_site_link is associated with the field use_default_ip_site_link (see use flag).
The detailed status of the last synchronization attempt.
Type
String.
Notes
The last_sync_detail cannot be updated.
last_sync_detail cannot be written.
Status of the last synchronization attempt
Type
String.
Notes
The last_sync_status cannot be updated.
last_sync_status cannot be written.
Timestamp of the last synchronization attempt
Type
Timestamp.
Notes
The last_sync_ts cannot be updated.
last_sync_ts cannot be written.
TCP port for LDAP connections for this
Type
Unsigned integer.
Create
The default value is undefined.
Encryption for LDAP connections for this MS Server
Type
String.
Create
The default value is undefined.
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).
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).
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.
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.
Enable/disable read-only synchronization of Sites for this Active Directory domain
Type
Bool.
Create
The default value is False.
Flag indicating if the server supports IPv6
Type
Bool.
Notes
The supports_ipv6 cannot be updated.
supports_ipv6 cannot be written.
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).
Flag to override MS Server default IP site link
Type
Bool.
Create
The default value is False.
Flag to override cluster LDAP timeoutMS Server
Type
Bool.
Create
The default value is False.
Additional information for Route53 resource record.
DNS name of the alias target.
Type
String.
Notes
The alias_target_dns_name cannot be updated.
alias_target_dns_name cannot be written.
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.
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.
Indicates whether this is the primary or secondary resource record for Amazon Route 53 failover routing.
Type
String.
Notes
The failover cannot be updated.
failover cannot be written.
Continent code for Amazon Route 53 geolocation routing.
Type
String.
Notes
The geolocation_continent_code cannot be updated.
geolocation_continent_code cannot be written.
Country code for Amazon Route 53 geolocation routing.
Type
String.
Notes
The geolocation_country_code cannot be updated.
geolocation_country_code cannot be written.
Subdivision code for Amazon Route 53 geolocation routing.
Type
String.
Notes
The geolocation_subdivision_code cannot be updated.
geolocation_subdivision_code cannot be written.
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.
Amazon EC2 region where this resource record resides for latency routing.
Type
String.
Notes
The region cannot be updated.
region cannot be written.
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.
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.
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 used for connecting to the cloud management platform.
Type
String.
Create
The default value is DIRECT.
Indicates if the task is enabled or disabled.
Type
Bool.
Create
The default value is False.
The timestamp when the task was started last.
Type
Timestamp.
Notes
The last_run cannot be updated.
last_run cannot be written.
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.
Periodic interval for this task.
Type
Unsigned integer.
Create
The default value is 60.
Units for the schedule interval.
Type
String.
Create
The default value is MINS.
Indicate the sync status of this task.
Type
String.
Notes
The state cannot be updated.
state cannot be written.
State message for the task.
Type
String.
Notes
The state_msg cannot be updated.
state_msg cannot be written.
The timestamp when the last state was logged.
Type
Timestamp.
Notes
The status_timestamp cannot be updated.
status_timestamp cannot be written.
Indicates whether private zones are synchronized.
Type
Bool.
Create
The default value is True.
Additional information for Route53 zone.
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.
User specified caller reference when zone was created.
Type
String.
Notes
The caller_reference cannot be updated.
caller_reference cannot be written.
ID of delegation set associated with this zone.
Type
String.
Notes
The delegation_set_id cannot be updated.
delegation_set_id cannot be written.
AWS route 53 assigned ID for this zone.
Type
String.
Notes
The hosted_zone_id cannot be updated.
hosted_zone_id cannot be written.
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.
Represents a BGP Autonomous System configured at the grid member level.
The number of this autonomous system.
Type
Unsigned integer.
Create
The field is required on creation.
The AS holddown timer (in seconds). The valid value is from 3 to 65535.
Type
Unsigned integer.
Create
The default value is 16.
The AS keepalive timer (in seconds). The valid value is from 1 to 21845.
Type
Unsigned integer.
Create
The default value is 4.
Determines if link detection on the interface is enabled or not.
Type
Bool.
Create
The default value is False.
The BGP neighbors for this AS.
Type
A/An BGP (Border Gateway Protocol) Neighbor struct array.
Create
The default value is:
empty
Represents the BGP neighbor that is configured in an autonomous system (AS). BGP neighbors are configured at the Grid member level.
The BGP authentication mode.
Type
String.
Create
The field is required on creation.
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.
User comments for this BGP neighbor.
Type
String.
Create
The default value is empty.
Determines if BFD is enabled or not.
Type
Bool.
Create
The default value is False.
Determines if BFD internal DNS monitor is enabled or not.
Type
Bool.
Create
The default value is True.
The interface that sends BGP advertisement information.
Type
String.
Create
The field is required on creation.
Determines if the multi-hop support is enabled or not.
Type
Bool.
Create
The default value is False.
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.
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.
This structure is used to represent files uploaded to the captive portal.
This struct contains information about changes to be made to the specified object.
This is a description of the action that is applied to this object.
Type
String.
Notes
The action cannot be updated.
action cannot be written.
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.
The structure contains the Cisco ISE attributes allowed for subscription and the NIOS extensible attribute definition name the Cisco ISE attribute is mapped on.
This strcture contains list of NIOS extensible attributes that are allowed for publishing to Cisco ISE endpoint.
The list of NIOS extensible attributes enalbed for publishsing to Cisco ISE endpoint.
Type
Enum values array.
Create
The field is required on creation.
This structure contains settings for subscription of the Cisco ISE attributes and mapping of them to a NIOS extensible attributes.
The list of Cisco ISE attributes allowed for subscription.
Type
Enum values array.
Create
The field is required on creation.
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
The client subnet domain structure represents the zone domain name that is allowed or forbidden for the EDNS client subnet (ECS) recursion.
The object is used to configure Multi-Grid Master preferences for updates from DHCP to Multi-Grid Master zones.
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”.
The name of external zone in FQDN format.
Type
String.
Create
Field dns_ext_zone is required if zone_match is “EXTERNAL”.
The name of a Grid member.
Type
String.
Create
Field dns_grid_primary is required if zone_match is “GRID” or “ANY_GRID”.
This struct contains the name and address of the Grid Member serving DHCP.
The IPv4 Address of the Grid Member.
Type
String.
Create
The default value is undefined.
The IPv6 Address of the Grid Member.
Type
String.
Create
The default value is undefined.
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 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.
The code of the DHCP option.
Type
Unsigned integer.
Create
The default value is undefined.
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.
This structure contains MS server DHCP properties
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).
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).
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).
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.
flag indicating if the DNS service is managed
Type
Bool.
Create
The default value is undefined.
Defines what control to apply on the DNS server
Type
String.
Create
The default value is undefined.
Status of the Microsoft DNS Service
Type
String.
Notes
The status cannot be updated.
status cannot be written.
Timestamp of the last update
Type
Timestamp.
Notes
The status_last_updated cannot be updated.
status_last_updated cannot be written.
Flag indicating if the DHCP supports Failover
Type
Bool.
Notes
The supports_failover cannot be updated.
supports_failover cannot be written.
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).
Override setting for Enable Invalid Mac Address
Type
Bool.
Create
The default value is False.
Override enable monitoring inherited from grid level
Type
Bool.
Create
The default value is False.
The structure provides information about the advanced polling settings.
The ARP aggregate limit.
Type
Unsigned integer.
Create
The default value is undefined.
The refresh interval in seconds for ARP cache.
Type
Unsigned integer.
Create
The default value is undefined.
Determines if DHCP router is used as seed for discovery.
Type
Bool.
Create
The default value is undefined.
Determines if discovery of networks that are not in IPAM is disabled.
Type
Bool.
Create
The default value is undefined.
Determines if purge of expired end host data is enabled.
Type
Bool.
Create
The default value is undefined.
The number of ping retries.
Type
Unsigned integer.
Create
The default value is undefined.
The hourly wait interval between ping sweeps for individual discovery ranges.
Type
Unsigned integer.
Create
The default value is undefined.
The ping timeout in seconds.
Type
Unsigned integer.
Create
The default value is undefined.
Determines if polling and authenticating using SNMPv2c or later is enabled.
Type
Bool.
Create
The default value is undefined.
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.
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.
Type
Unsigned integer.
Create
The default value is undefined.
Determines if syslogging of IPAM sync events is enabled.
Type
Bool.
Create
The default value is undefined.
The structure provides information about the advanced SDN polling settings.
This structure provides settings for Advisor application
Host name or ip address of the Advisor server
Type
String.
Create
The default value is undefined.
Authentication type used for Advisor server
Type
String.
Create
The field is required on creation.
Application execution hour.
Type
Unsigned integer.
Create
The default value is 3.
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.
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.
Result of the last execution attempt of Advisor
Type
String.
Notes
The last_exec_status cannot be updated.
last_exec_status cannot be written.
Timestamp of the Advisor last execution attempt’
Type
Timestamp.
Notes
The last_exec_time cannot be updated.
last_exec_time cannot be written.
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.
Result of the last Run Now attempt of Advisor
Type
String.
Notes
The last_run_now_status cannot be updated.
last_run_now_status cannot be written.
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.
Advisor minimal severity
Type
String.
Create
The field is required on creation.
The type of the network interface on consolidator member.
Type
String.
Create
The default value is undefined.
The interface for Advisor application on consolidator member.
Type
String.
Create
This field must be specified when network_interface_type is set to “VLAN”
Port number the Advisor server listens on
Type
Unsigned integer.
Create
The default value is undefined.
Host name or ip address of the proxy server.
Type
String.
Create
The default value is undefined.
Port number the proxy listens on.
Type
Unsigned integer.
Create
The default value is undefined.
of discovered data to managed objects.
The string that contains condition of use the auto conversion settings.
Type
String.
Create
The default value is undefined.
Template string used to generate host names.
Type
String.
Create
The field is required on creation.
This struct contains information about the discovery basic poll settings.
Determines whether auto ARP refresh before switch port polling is enabled or not.
Type
Bool.
Create
The field is required on creation.
Determines whether CLI collection is enabled or not.
Type
Bool.
Create
The field is required on creation.
Determines whether complete ping sweep is enabled or not.
Type
Bool.
Create
The field is required on creation.
Credential group.
Type
String.
Create
The default value is default.
Determines whether device profile is enabled or not.
Type
Bool.
Create
The field is required on creation.
Determines whether netbios scanning is enabled or not.
Type
Bool.
Create
The field is required on creation.
Determines whether port scanning is enabled or not.
Type
Bool.
Create
The field is required on creation.
Determines whether smart subnet ping sweep is enabled or not.
Type
Bool.
Create
The field is required on creation.
Determines whether SNMP collection is enabled or not.
Type
Bool.
Create
The field is required on creation.
A switch port data collection polling mode.
Type
String.
Create
The field is required on creation.
Indicates the interval for switch port data collection polling.
Type
Unsigned integer.
Create
The default value is empty.
A Schedule Setting struct that determines switch port data collection polling schedule.
Type
A/An Schedule Setting struct.
Create
The default value is undefined.
This struct contains information about the discovery basic SDN poll settings.
Default network view to map collected SDN networks.
Type
String.
Create
The default value is undefined.
SDN end host polling mode.
Type
String.
Create
The default value is DISABLED.
Valid SDN end host polling interval in seconds. Must be between 1800 and 86400 seconds.
Type
Unsigned integer.
Create
end_host_polling_interval should be provided when SDN end host polling mode is PERIODIC
A Schedule Setting struct that determines SDN end host polling schedule.
Type
A/An Schedule Setting struct.
Create
Schedule Setting should be provided when SDN end host polling mode is SCHEDULED
CLI credentials for devices discovered by Network Automation.
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.
Group for the CLI credential.
Type
String.
Create
The default value is default.
The type of the credential.
Type
String.
Create
The field is required on creation.
The Credentials ID.
Type
Unsigned integer.
Notes
The id cannot be updated.
id cannot be written.
Specify these attributes in the Discovery Data Conversion function call to override default values of the target objects.
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.
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.
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.
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.
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.
This struct contains information about port statistics.
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.
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.
These parameters are related to the result of the Get Device Support Info call.
These parameters are related to the result of the Get Device Support Info call.
Shows whether the function is available for the device or not.
Type
String.
Notes
The available cannot be updated.
available cannot be written.
The function of the device.
Type
String.
Notes
The function cannot be updated.
function cannot be written.
These parameters are related to the result of the Discovery Data Conversion call.
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.
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.
IfAddr information on devices discovered by Network Automation.
The IPv4 Address or IPv6 Address of the device.
Type
String.
Notes
The address cannot be updated.
address cannot be written.
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.
The network to which this device belongs, in IPv4 Address/CIDR format.
Type
String.
Notes
The network cannot be updated.
network cannot be written.
This struct contains details about a discovery job process.
The end line of the returned stream.
Type
Unsigned integer.
Notes
The end_line cannot be updated.
end_line cannot be written.
This struct contains information about interface and network for de-provisioning.
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.
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.
This struct contains information about network.
The structure provides information about discovery port.
The comment for this discovery port.
Type
String.
Create
The default value is undefined.
This struct contains information about admin status.
The associated port control task details.
Type
A/An Port Control Task Details struct.
Notes
The details cannot be updated.
details cannot be written.
This struct contains information about config description.
The configured description value.
Type
String.
Notes
The description cannot be updated.
description cannot be written.
The associated port control task details.
Type
A/An Port Control Task Details struct.
Notes
The details cannot be updated.
details cannot be written.
This struct contains information about 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.
The associated port control task details.
Type
A/An Port Control Task Details struct.
Notes
The details cannot be updated.
details cannot be written.
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.
This struct contains information about Port Control.
The administrative state of the interface.
Type
String.
Create
The default value is undefined.
Notes
The admin_status cannot be updated.
admin_status is not readable.
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.
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.
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.
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.
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.
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.
This struct contains information about task details.
The ID of the associated port control task.
Type
Unsigned integer.
Notes
The id cannot be updated.
id cannot be written.
The structure provides information about the discovery scan interface.
The name of the network view associated with the network discovery probing member.
Type
String.
Create
The field is required on creation.
The structure provides information about SDN controller configuration.
SDN controller IP addresses or FQDNs.
Type
String array.
Create
The default value is undefined.
SDN controller API key.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is undefined.
Notes
api_key is not readable.
Additional information about the SDN configuration.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is undefined.
Unique configuration handle.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
Configuration handle must be specified when creating new sdn_config structure.
The type of the network interface on discovery member used for SDN controller discovery
Type
String.
Create
The default value is undefined.
Virtual IP of VLAN network interface on discovery member
Type
String.
Create
This field must be specified when network_interface_type is set to “VLAN”
The network view associated with SDN controller.
Type
String.
Create
The default value is undefined.
True if controller is on-premises, otherwise we consider it is in cloud.
Type
Bool.
Create
The default value is undefined.
SDN controller login password.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is undefined.
Notes
password is not readable.
The connection protocol. Valid values are ‘HTTP’ and ‘HTTPS’.
Type
String.
Create
The default value is undefined.
Type of SDN controller.
Type
String.
Create
SDN type must be specified when creating new sdn_config structure.
Use global proxy settings to access SDN controller.
Type
Bool.
Create
The default value is False.
SDN controller login name.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is undefined.
Unique key of SDN controller structure. Must be specified for existing sdn_config structures, otherwise they will be removed. If not specified, new structure will be created.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is undefined.
The structure provides information about the seed router.
This struct contains SNMPv3 credential data.
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 for the SNMPv3 user.
Type
String.
Create
The field is required on creation.
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.
Group for the SNMPv3 credential.
Type
String.
Create
The default value is default.
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.
This struct contains SNMPv1 and SNMPv2 credential data.
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.
Status information on devices discovered by Network Automation.
The detailed message.
Type
String.
Notes
The message cannot be updated.
message cannot be written.
VLAN information on devices discovered by Network Automation.
VRF mapping rule is a regular expression that is defining what VRFs will be used to populate the specified Network View.
This struct contains data gathered during a network discovery.
Discovered IP address of Wireless Access Point.
Type
String.
Notes
The ap_ip_address cannot be updated.
ap_ip_address cannot be written.
Discovered name of Wireless Access Point.
Type
String.
Notes
The ap_name cannot be updated.
ap_name cannot be written.
Service set identifier (SSID) associated with Wireless Access Point.
Type
String.
Notes
The ap_ssid cannot be updated.
ap_ssid cannot be written.
The BGP autonomous system number.
Type
Unsigned integer.
Notes
The bgp_as cannot be updated.
bgp_as cannot be written.
Discovered bridge domain.
Type
String.
Notes
The bridge_domain cannot be updated.
bridge_domain cannot be written.
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.
The Cisco ISE security group name.
Type
String.
Notes
The cisco_ise_security_group cannot be updated.
cisco_ise_security_group cannot be written.
The Cisco ISE connection session state.
Type
String.
Notes
The cisco_ise_session_state cannot be updated.
cisco_ise_session_state cannot be written.
The Cisco ISE SSID.
Type
String.
Notes
The cisco_ise_ssid cannot be updated.
cisco_ise_ssid cannot be written.
Type
String.
Notes
The cmp_type cannot be updated.
cmp_type cannot be written.
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.
Location of device on which the IP address was discovered.
Type
String.
Notes
The device_location cannot be updated.
device_location cannot be written.
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.
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.
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.
The type of end host in vendor terminology.
Type
String.
Notes
The device_type cannot be updated.
device_type cannot be written.
The vendor name of the end host.
Type
String.
Notes
The device_vendor cannot be updated.
device_vendor cannot be written.
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.
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.
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.
A comma-separated list of the discovered endpoint groups.
Type
String.
Notes
The endpoint_groups cannot be updated.
endpoint_groups cannot be written.
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.
The port redundant group number.
Type
Unsigned integer.
Notes
The iprg_no cannot be updated.
iprg_no cannot be written.
The status for the IP address within port redundant group.
Type
String.
Notes
The iprg_state cannot be updated.
iprg_state cannot be written.
The port redundant group type.
Type
String.
Notes
The iprg_type cannot be updated.
iprg_type cannot be written.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
The link status of the switch port connected to the end device. Indicates whether it is connected.
Type
String.
Notes
The port_link_status cannot be updated.
port_link_status cannot be written.
The interface speed, in Mbps, of the switch port.
Type
String.
Notes
The port_speed cannot be updated.
port_speed cannot be written.
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.
The type of switch port.
Type
String.
Notes
The port_type cannot be updated.
port_type cannot be written.
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.
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.
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.
The name of the discovery task.
Type
String.
Notes
The task_name cannot be updated.
task_name cannot be written.
Discovered tenant.
Type
String.
Notes
The tenant cannot be updated.
tenant cannot be written.
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.
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.
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.
The name of the virtual entity.
Type
String.
Notes
The v_entity_name cannot be updated.
v_entity_name cannot be written.
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.
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.
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.
Port group which the virtual machine belongs to.
Type
String.
Notes
The vlan_port_group cannot be updated.
vlan_port_group cannot be written.
Type
String.
Notes
The vmhost_ip_address cannot be updated.
vmhost_ip_address cannot be written.
Type
String.
Notes
The vmhost_mac_address cannot be updated.
vmhost_mac_address cannot be written.
Type
String.
Notes
The vmhost_name cannot be updated.
vmhost_name cannot be written.
Type
String.
Notes
The vmhost_nic_names cannot be updated.
vmhost_nic_names cannot be written.
Type
Unsigned integer.
Notes
The vmhost_subnet_cidr cannot be updated.
vmhost_subnet_cidr cannot be written.
ID of the virtual machine.
Type
String.
Notes
The vmi_id cannot be updated.
vmi_id cannot be written.
Discovered IP address type.
Type
String.
Notes
The vmi_ip_type cannot be updated.
vmi_ip_type cannot be written.
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.
Name of the virtual machine.
Type
String.
Notes
The vmi_name cannot be updated.
vmi_name cannot be written.
Private IP address of the virtual machine.
Type
String.
Notes
The vmi_private_address cannot be updated.
vmi_private_address cannot be written.
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.
Type
String.
Notes
The vport_conf_mode cannot be updated.
vport_conf_mode cannot be written.
Type
String.
Notes
The vport_conf_speed cannot be updated.
vport_conf_speed cannot be written.
Type
String.
Notes
The vport_link_status cannot be updated.
vport_link_status cannot be written.
Type
String.
Notes
The vport_mac_address cannot be updated.
vport_mac_address cannot be written.
Type
String.
Notes
The vport_mode cannot be updated.
vport_mode cannot be written.
Type
String.
Notes
The vport_name cannot be updated.
vport_name cannot be written.
Type
String.
Notes
The vport_speed cannot be updated.
vport_speed cannot be written.
Description of the VRF.
Type
String.
Notes
The vrf_description cannot be updated.
vrf_description cannot be written.
The name of the VRF.
Type
String.
Notes
The vrf_name cannot be updated.
vrf_name cannot be written.
Route distinguisher of the VRF.
Type
String.
Notes
The vrf_rd cannot be updated.
vrf_rd cannot be written.
Type
Unsigned integer.
Notes
The vswitch_available_ports_count cannot be updated.
vswitch_available_ports_count cannot be written.
ID of the virtual switch.
Type
String.
Notes
The vswitch_id cannot be updated.
vswitch_id cannot be written.
Indicates the virtual switch has IPV6 enabled.
Type
Bool.
Notes
The vswitch_ipv6_enabled cannot be updated.
vswitch_ipv6_enabled cannot be written.
Name of the virtual switch.
Type
String.
Notes
The vswitch_name cannot be updated.
vswitch_name cannot be written.
Type
String.
Notes
The vswitch_segment_id cannot be updated.
vswitch_segment_id cannot be written.
Type
String.
Notes
The vswitch_segment_name cannot be updated.
vswitch_segment_name cannot be written.
Type
String.
Notes
The vswitch_segment_port_group cannot be updated.
vswitch_segment_port_group cannot be written.
Type
String.
Notes
The vswitch_segment_type cannot be updated.
vswitch_segment_type cannot be written.
Type
String.
Notes
The vswitch_tep_dhcp_server cannot be updated.
vswitch_tep_dhcp_server cannot be written.
Type
String.
Notes
The vswitch_tep_ip cannot be updated.
vswitch_tep_ip cannot be written.
Type
String.
Notes
The vswitch_tep_multicast cannot be updated.
vswitch_tep_multicast cannot be written.
Type
String.
Notes
The vswitch_tep_port_group cannot be updated.
vswitch_tep_port_group cannot be written.
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.
This structure represents the TCP port that network discovery jobs use to find IP addresses.
Contains information about the vSphere servers on which the VM discovery is performed.
The connection protocol of a vSphere server.
Type
String.
Create
The default value is HTTPS.
The disable flag of a vSphere server.
Type
Bool.
Create
The default value is False.
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.
The user password on the vSphere server.
Type
String.
Create
The field is required on creation.
Notes
password is not readable.
The DNSSEC key object.
The public-key encryption algorithm.
Type
String.
Notes
The algorithm cannot be updated.
algorithm cannot be written.
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.
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.
The status of the key for the zone.
Type
String.
Notes
The status cannot be updated.
status cannot be written.
The DNSSEC key algorithm structure is used for configuring algorithms for Key-signing and Zone-signing keys.
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.
If set to True, automatic rollovers for the signing key is enabled.
Type
Bool.
Create
The default value is False.
Key Signing Key algorithm. Deprecated.
Type
String.
Create
The default value is 8.
A list of Key Signing Key Algorithms.
Type
A/An DNSSEC Key Algorithm struct array.
Create
The default value is:
[{ 'algorithm': 'RSASHA256', 'size': 2048}]
Enable email notifications for KSK related events.
Type
Bool.
Create
The default value is False.
Key Signing Key rollover interval, in seconds.
Type
Unsigned integer.
Create
The default value is 31536000.
This field controls events for which users will be notified.
Type
String.
Create
The default value is REQUIRE_MANUAL_INTERVENTION.
Key Signing Key size, in bits. Deprecated.
Type
Unsigned integer.
Create
The default value is 2048.
Enable SNMP notifications for KSK related events.
Type
Bool.
Create
The default value is True.
NSEC (next secure) types.
Type
String.
Create
The default value is NSEC3.
The number of iterations used for hashing NSEC3.
Type
Unsigned integer.
Create
The default value is 10.
The maximum length for NSEC3 salts.
Type
Unsigned integer.
Create
The default value is 15.
The minimum length for NSEC3 salts.
Type
Unsigned integer.
Create
The default value is 1.
Signature expiration time, in seconds.
Type
Unsigned integer.
Create
The default value is 345600.
Zone Signing Key algorithm. Deprecated.
Type
String.
Create
The default value is 8.
A list of Zone Signing Key Algorithms.
Type
A/An DNSSEC Key Algorithm struct array.
Create
The default value is:
[{ 'algorithm': 'RSASHA256', 'size': 1024}]
Zone Signing Key rollover interval, in seconds.
Type
Unsigned integer.
Create
The default value is 2592000.
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.
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.
Responses must be DNSSEC secure for this hierarchy/domain.
Type
Bool.
Create
The default value is False.
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.
This structure contains DNS properties of microsoft server
MS Server ip address
Type
String.
Notes
The address cannot be updated.
address cannot be written.
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).
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).
Ordered list of IP addresses to forward queries to
Type
String.
Notes
The forwarders cannot be updated.
forwarders cannot be written.
Detailled status of the last synchronization attempt
Type
String.
Notes
The last_sync_detail cannot be updated.
last_sync_detail cannot be written.
Status of the last synchronization attempt
Type
String.
Notes
The last_sync_status cannot be updated.
last_sync_status cannot be written.
Timestamp of the last synchronization attempt
Type
Timestamp.
Notes
The last_sync_ts cannot be updated.
last_sync_ts cannot be written.
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).
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.
flag indicating if the DNS service is managed
Type
Bool.
Create
The default value is undefined.
Defines what control to apply on the DNS server
Type
String.
Create
The default value is undefined.
Status of the Microsoft DNS Service
Type
String.
Notes
The status cannot be updated.
status cannot be written.
Detailed status of the DNS status
Type
String.
Notes
The status_detail cannot be updated.
status_detail cannot be written.
Timestamp of the last update
Type
Timestamp.
Notes
The status_last_updated cannot be updated.
status_last_updated cannot be written.
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.
Flag indicating if the server supports
Type
Bool.
Notes
The supports_dnssec cannot be updated.
supports_dnssec cannot be written.
Flag indicating if the server supports IPv6
Type
Bool.
Notes
The supports_ipv6 cannot be updated.
supports_ipv6 cannot be written.
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.
Flag indicating if the server supports DNAME records
Type
Bool.
Notes
The supports_rr_dname cannot be updated.
supports_rr_dname cannot be written.
Flag indicating if the server supports NAPTR records
Type
Bool.
Notes
The supports_rr_naptr cannot be updated.
supports_rr_naptr cannot be written.
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).
Override enable reports data inherited from grid level
Type
Bool.
Create
The default value is False.
Override enable monitoring inherited from grid level
Type
Bool.
Create
The default value is False.
This struct provides information and configuration for DNSTAP receiver.
DNSTAP id string.
Type
String.
Notes
The dnstap_identity cannot be updated.
dnstap_identity cannot be written.
Address of DNSTAP receiver.
Type
String.
Create
The field is required on creation.
Notes
The dnstap_receiver_address is part of the base object.
The DTC Health structure contains health information of the DTC objects.
The availability color status.
Type
String.
Create
The default value is NONE.
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.
The comment for a DTC SNMP Health Monitor OID object.
Type
String.
Create
The default value is empty.
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.
Create
The default value is ANY.
The condition’s first term to match against the SNMP health check result.
Type
String.
Create
The default value is empty.
The condition’s second term to match against the SNMP health check result with ‘RANGE’ condition.
Type
String.
Create
The default value is empty.
Servers assigned to a pool with monitor defined are healthy if ANY or ALL members report healthy status.
Type
String.
Create
The field is required on creation.
Flag for switching health performing and sharing behavior to perform health checks on each DTC grid member that serves related LBDN(s) and send them across all DTC grid members from both selected and non-selected lists.
Type
Bool.
Create
The default value is False.
This structure used to link LBDN object with specific pool from queue.
The structure contains result of a query call.
DNS record data. Address for A or AAAA and name for CNAME.
Type
String.
Notes
The rdata cannot be updated.
rdata cannot be written.
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.
This structure used to link object with specific server from queue.
This structure used to link DTC server with specific DTC Monitor.
The structure contains information about DTC topology rule source.
The operation used to match the value.
Type
String.
Create
The default value is undefined.
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.
The IPv4 Address or IPv6 Address for the DXL endpoint broker.
Type
String.
Create
The default value is empty.
The FQDN for the DXL endpoint broker.
Type
String.
Create
The field is required on creation.
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.
The operation name.
Type
String.
Create
The field is required on creation.
The name of the Extensible Attribute Definition object which is used as the first operand value.
Type
String.
Create
The default value is undefined.
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 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.
The IPv4 Address ending address of the exclusion range.
Type
String.
Create
The field is required on creation.
The IPv4 Address starting address of the exclusion range.
Type
String.
Create
The field is required on creation.
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.
A descriptive comment of a DHCP exclusion range template.
Type
String.
Create
The default value is empty.
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.
The operation name.
Type
String.
Create
The field is required on creation.
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.
This option describes which action must be taken if the extensible attribute exists for the descendant, but is absent for the parent object:
Type
String.
Create
The default value is undefined.
This option describes which action must be taken if the extensible attribute exists for both the parent and descendant objects:
Type
String.
Create
The default value is undefined.
This option describes which action must be taken if the extensible attribute exists for the parent, but is absent from the descendant object:
Type
String.
Create
The default value is undefined.
The structure contains the list of extensible attribute values.
This struct represents an external DNS server.
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.
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.
Set this flag to hide the NS record for the primary name server from DNS queries.
Type
Bool.
Create
The default value is False.
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.
The TSIG key algorithm.
Type
String.
Create
The default value is HMAC-MD5.
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).
This structure contains information about the external server for backing up the rotated syslog files.
The IPv4 or IPv6 address of the backup syslog server.
Type
String.
Create
The field is required on creation.
The directory path for the replication of the rotated syslog files.
Type
String.
Create
The default value is undefined.
If set to True, the syslog backup server is enabled.
Type
Bool.
Create
The default value is True.
The password of the backup syslog server.
Type
String.
Create
The default value is undefined.
Notes
password is not readable.
The port used to connect to the backup syslog server.
Type
Unsigned integer.
Create
The default value is 22.
This struct provides information and configuration for captured DNS traffic transfer to a remote server.
The directory to save the captured DNS queries and responses.
Type
String.
Create
The default value is empty.
The host name of the destination server for DNS capture transfer.
Type
String.
Create
The default value is empty.
The password to access the destination server directory.
Type
String.
Create
The default value is undefined.
Notes
password is not readable.
This structure references defined DHCP filters.
The FireEye Alert Map used to configure FireEye alerts to Response Policy Zone rules.
The type of Fireeye Alert.
Type
String.
Create
The field is required on creation.
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.
The FireEye Rule Mapping used to configure rule mapping for FireEye devices and Response Policy Zones.
The override setting for APT alerts.
Type
String.
Create
The default value is undefined.
The FireEye alert mapping.
Type
A/An FireEye Alert Map struct array.
Create
The default value is undefined.
This struct contains per-Grid-member forwarding configuration.
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).
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.
This structure represents the member settings in each group.
This structure provides information about DNS attack detection settings.
Determines if DNS attack detection is enabled or not.
Type
Bool.
Create
The default value is True.
The high threshold value (in percentage) for starting DNS attack detection.
Type
Unsigned integer.
Create
The default value is empty.
The maximum number of events that have occurred before processing DNS attack detection.
Type
Unsigned integer.
Create
The default value is undefined.
The minimum number of events that have occurred before processing DNS attack detection.
Type
Unsigned integer.
Create
The default value is empty.
The DNS Attack Mitigation structure provides information about mitigation configuration for DNS attacks.
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}
The cache utilization (in percentage) when Cache Hit Ratio (CHR) starts.
Type
Unsigned integer.
Create
The default value is 75.
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}
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}
The minimum time interval (in seconds) between changes in attack status.
Type
Unsigned integer.
Create
The default value is 10.
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.
The DNS Auto Blackhole provides information about DNS auto blackhole configuration.
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.
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.
Enables or disables the holddown configuration when the appliance stops sending queries to non-responsive servers.
Type
Bool.
Create
The default value is False.
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.
The maximum number of concurrent recursive queries that a server sends for its domains.
Type
Unsigned integer.
Create
The default value is 200.
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.
The holddown duration for non-responsive servers.
Type
Unsigned integer.
Create
The default value is 60.
Struct for storing certificate verification message.
Structure containing all the information related to Gateway configuration.
Enable Gateway Service.
Type
Bool.
Create
The default value is undefined.
List of Gateway FQDN to AWS Endpoint Mapping.
Type
A/An Endpoint mapping struct array.
Create
The default value is undefined.
Structure defining an entry in the mapping table of Gateway to AWS endpoint.
The structure aggregates all information related to Cloud objects.
Type of authority over the object.
Type
String.
Notes
The authority_type cannot be updated.
authority_type cannot be written.
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.
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.
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.
Notes
The delegated_scope is part of the base object.
The delegated_scope cannot be updated.
delegated_scope cannot be written.
Indicates the specified cloud management platform.
Type
String.
Notes
The mgmt_platform cannot be updated.
mgmt_platform cannot be written.
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.
This object represents Cloud grid user.
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.
This structure contains configuration for consent banner. This banner appears as the first screen when users access Grid Manager. Users must read the terms and conditions and then click Accept on the consent screen before they can access the login screen of Grid Manager.
Determines whether the consent banner is enabled.
Type
Bool.
Create
The default value is False.
The message included in the consent banner.
Type
String.
Create
The default value is empty.
This structure contains a csp api config.
The password for the CspApiConfig.
Type
String.
Create
The default value is empty.
Notes
The password cannot be updated.
password is not readable.
Structure specify csp setting for grid
IP address of DNS resolver in DFP
Type
String.
Create
The default value is undefined.
A fixed RRset order FQDN contains information about the fixed RRset configuration items.
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.
The color for the informational level banner.
Type
String.
Create
The default value is GREEN.
Determines whether the display of the informational level banner is enabled.
Type
Bool.
Create
The default value is True.
The message included in the informational level banner.
Type
String.
Create
The default value is empty.
License expiration date.
Type
Timestamp.
Notes
The expiry_date cannot be updated.
expiry_date cannot be written.
Structure specify security lockout setting.
Enable/disable sequential failed login attempts lockout for local users
Type
Bool.
Create
The default value is False.
Time period the account remains locked after sequential failed login attempt lockout.
Type
Unsigned integer.
Create
The default value is 5.
The logging categories. It is possible to specify several BIND logging message categories to be captured by syslog.
Determines whether the client requests are captured or not.
Type
Bool.
Create
The default value is undefined.
Determines whether the configuration file parsing is captured or not.
Type
Bool.
Create
The default value is undefined.
Determines whether the BIND’s internal database processes are captured or not.
Type
Bool.
Create
The default value is undefined.
Determines whether the DNSSEC-signed responses are captured or not.
Type
Bool.
Create
The default value is undefined.
Determines whether the DTC GSLB activity is captured or not.
Type
Bool.
Create
The default value is undefined.
Determines whether the DTC health monitoring information is captured or not.
Type
Bool.
Create
The default value is undefined.
Determines whether the BIND messages that are not specifically classified are captured or not.
Type
Bool.
Create
The default value is undefined.
Determines whether the bad delegation instances are captured or not.
Type
Bool.
Create
The default value is undefined.
Determines whether the network operation messages are captured or not.
Type
Bool.
Create
The default value is undefined.
Determines whether the asynchronous zone change notification messages are captured or not.
Type
Bool.
Create
The default value is undefined.
Determines whether the query messages are captured or not.
Type
Bool.
Create
The default value is undefined.
Determines whether the query rewrite messages are captured or not.
Type
Bool.
Create
The default value is undefined.
Determines whether the rate limit messages are captured or not.
Type
Bool.
Create
The default value is undefined.
Determines whether the DNS resolution instances, including recursive queries from resolvers are captured or not.
Type
Bool.
Create
The default value is undefined.
Determines whether the response messages are captured or not.
Type
Bool.
Create
The default value is undefined.
Determines whether the Response Policy Zone messages are captured or not.
Type
Bool.
Create
The default value is undefined.
Determines whether the approved and denied requests are captured or not.
Type
Bool.
Create
The default value is undefined.
Determines whether the dynamic update instances are captured or not.
Type
Bool.
Create
The default value is undefined.
Determines whether the security update messages are captured or not.
Type
Bool.
Create
The default value is undefined.
The Grid NTP settings structure is used to control the NTP synchronization of the date and time for all Infoblox appliances.
Determines whether NTP is enabled on the Grid.
Type
Bool.
Create
The default value is False.
Grid level GM local NTP stratum.
Type
Unsigned integer.
Create
The default value is 13.
Local NTP stratum for non-GM members.
Type
Unsigned integer.
Create
The default value is 15.
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'}
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
Determines whether the Kiss-o’-Death packets are enabled.
Type
Bool.
Create
The default value is False.
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
The DNS Response Rate Limiting structure provides information about DNS response rate limiting configuration.
Determines if the response rate limiting is enabled or not.
Type
Bool.
Create
The default value is False.
Determines if logging for response rate limiting without dropping any requests is enabled or not.
Type
Bool.
Create
The default value is False.
The number of responses per client per second.
Type
Unsigned integer.
Create
The default value is 100.
This structure contains information about the Restart Banner.
If set to True, the user is required to input name before restarting the services.
Type
Bool.
Create
The default value is False.
If set to True, the restart banner is enabled.
Type
Bool.
Create
The default value is True.
The restart setting at the Grid level.
The time duration to delay a restart for a restart group.
Type
Unsigned integer.
Create
The default value is 10.
This struct contains information about Restart Group scheduling settings.
Determines if the Restart Group should have a force restart.
Type
Bool.
Create
The default value is False.
The restart method for a Grid restart.
Type
String.
Create
The default value is empty.
The Schedule Setting struct that determines the schedule for the restart.
Type
A/An Schedule Setting struct.
Create
The field is required on creation.
This struct contains the SOA MNAME and the primary server for this zone.
Master’s SOA MNAME in punycode format.
Type
String.
Notes
The dns_mname cannot be updated.
dns_mname cannot be written.
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.
This struct contains the SOA serial number and the primary server for this zone.
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.
The structure provides information about the status of upgrade process hotfixes.
The Entrust nShield Hardware Security Module (HSM) structure represents the Entrust nShield HSM device configuration.
Determines whether the Entrust nShield HSM device is disabled.
Type
Bool.
Create
The default value is False.
The Entrust nShield HSM device public key digest.
Type
String.
Create
The default value is empty.
The Entrust nShield HSM device electronic serial number.
Type
String.
Notes
The remote_esn cannot be updated.
remote_esn cannot be written.
The IPv4 Address of the Entrust nShield HSM device.
Type
String.
Create
The field is required on creation.
Deprecated. You need to use Thales Luna Object instead. The Harware Security Module (HSM) SafeNet structure represents the HSM SafeNet device configuration.
Determines whether the HSM SafeNet device is disabled.
Type
Bool.
Create
The default value is False.
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.
The HSM SafeNet device IPv4 Address or FQDN.
Type
String.
Create
The field is required on creation.
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 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.
The HSM SafeNet device partition serial number (PSN).
Type
String.
Create
The field is required on creation.
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.
Deprecated. You need to use Entrust nShield object instead. The Thales Hardware Security Module (HSM) structure represents the Thales HSM device configuration.
Determines whether the Thales HSM device is disabled.
Type
Bool.
Create
The default value is False.
The Thales HSM device public key digest.
Type
String.
Create
The default value is empty.
The Thales HSM device electronic serial number.
Type
String.
Notes
The remote_esn cannot be updated.
remote_esn cannot be written.
The IPv4 Address of the Thales HSM device.
Type
String.
Create
The field is required on creation.
The Harware Security Module (HSM) Thales Luna structure represents the HSM Thales Luna device configuration.
Determines whether the HSM Thales Luna device is disabled.
Type
Bool.
Create
The default value is False.
Determines whether the HSM Thales Luna device is FIPS compliant.
Type
Bool.
Notes
The is_fips_compliant cannot be updated.
is_fips_compliant cannot be written.
The HSM Thales Luna device IPv4 Address or FQDN.
Type
String.
Create
The field is required on creation.
The HSM Thales Luna device partition capacity percentage used.
Type
Unsigned integer.
Notes
The partition_capacity cannot be updated.
partition_capacity cannot be written.
Partition ID that is displayed after the appliance has successfully connected to the HSM Thales Luna device.
Type
String.
Notes
The partition_id cannot be updated.
partition_id cannot be written.
The HSM Thales Luna device partition serial number (PSN).
Type
String.
Create
The field is required on creation.
The token returned by the uploadinit function call in object fileop for a Thales Luna HSM device certificate.
Type
String.
Create
The default value is undefined.
Notes
server_cert is not readable.
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.
Determines if anycast for the Interface object is enabled or not.
Type
Bool.
Create
The default value is False.
A descriptive comment of this structure.
Type
String.
Create
The default value is empty.
Determines if the BGP advertisement setting is enabled for this interface or not.
Type
Bool.
Create
The default value is False.
Determines if the OSPF advertisement setting is enabled for this interface or not.
Type
Bool.
Create
The default value is False.
The interface type for the Interface object.
Type
String.
Create
The default value is LOOPBACK.
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.
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.
Used for ipv6 static routes object.
The structure contains IPv6 settings for a member.
Determines if automatic router configuration should be enabled.
Type
Bool.
Create
The default value is undefined.
IPv6 cidr prefix
Type
Unsigned integer.
Create
The default value is undefined.
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
Determines if IPv6 networking should be enabled.
Type
Bool.
Create
The default value is undefined.
Settings used to configure IP parameters for the LAN2 port.
Default route failover for LAN1 and LAN2.
Type
Bool.
Create
The default value is False.
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.
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:
{ }
Prefer LAN1 when available.
Type
Bool.
Create
The default value is False.
Determines if NIC failover is enabled or not.
Type
Bool.
Create
The default value is False.
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:
{ }
This structure contains LAN/HA port settings for the HA node.
Physical port settings for the HA interface.
Type
A/An Physical Port Settings struct.
Create
The default value is undefined.
Physical port settings for the LAN interface.
Type
A/An Physical Port Settings struct.
Create
The default value is undefined.
This structure is used to map LDAP fields to NIOS extensible attributes.
This structure is used for LDAP authentication configuration.
The IP address or FQDN of the LDAP server.
Type
String.
Create
The field is required on creation.
The authentication type for the LDAP server.
Type
String.
Create
The default value is ANONYMOUS.
The base DN for the LDAP server.
Type
String.
Create
The field is required on creation.
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.
The user DN for authentication.
Type
String.
Create
You must specify bind_user_dn when authentication type is set to “AUTHENTICATED”.
Determines if the LDAP server is disabled.
Type
Bool.
Create
The default value is False.
The LDAP server encryption type.
Type
String.
Create
The default value is SSL.
This structure references defined DHCP filters.
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.
The IPv4 Address of the Grid member.
Type
String.
Create
The default value is empty.
The default gateway for the Grid member.
Type
String.
Create
The default value is empty.
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.
The descriptive comment for the LOM user.
Type
String.
Create
The default value is empty.
Determines whether the LOM user is disabled.
Type
Bool.
Create
The default value is False.
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.
Structure specify csp setting for member
IP address of DNS resolver in DFP
Type
String.
Create
The default value is undefined.
Notes
csp_dns_resolver is associated with the field use_csp_dns_resolver (see use flag).
HTTP Proxy IP address of CSP Portal
Type
String.
Create
The default value is undefined.
Notes
csp_https_proxy is associated with the field use_csp_https_proxy (see use flag).
Join token required to connect to a cluster
Type
String.
Create
The default value is empty.
Notes
csp_join_token is associated with the field use_csp_join_token (see use flag).
Overrides CSP DNS Resolver
Type
Bool.
Create
The default value is False.
This structure holds information about interface which address the appliance uses to generate the glue record for each view.
Determines if empty view with recursion enabled will be written into the conf file.
Type
Bool.
Create
The default value is False.
The address choice for auto-created glue records for this view.
Type
String.
Create
The default value is INTERFACE.
The DNS IP structure is used to configure additional DNS-enabled interfaces for Grid member.
The member NTP settings structure is used to control the NTP synchronization of the date and time of the particular Infoblox appliance.
Determines whether the use of the external NTP servers is enabled for the member.
Type
Bool.
Create
The default value is False.
Determines whether the NTP service is enabled on the member.
Type
Bool.
Create
The default value is False.
Determines whether the Grid Master is excluded as an NTP server.
Type
Bool.
Create
The default value is False.
Vnode level local NTP stratum.
Type
Unsigned integer.
Create
The default value is 15.
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).
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).
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).
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).
Vnode level default stratum.
Type
Bool.
Create
The default value is False.
This structure contains information required for a physical node to join the Grid using a one-time token.
OID of the physical node.
Type
String.
Notes
The physical_oid cannot be updated.
physical_oid cannot be written.
This struct represents a Grid member.
This flag represents whether the preferred_primaries field values of this member are used.
Type
Bool.
Create
The default value is False.
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.
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.
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
The structure contains service type communication options for a Grid member.
The option for communication type.
Type
String.
Notes
The option is part of the base object.
The option cannot be updated.
option cannot be written.
This structure contains a service status of the Grid Member.
The description of the current service status.
Type
String.
Notes
The description cannot be updated.
description cannot be written.
The service identifier.
Type
String.
Notes
The service cannot be updated.
service cannot be written.
The structure that defines whether the MGMT port settings must be used.
Determines if MGMT port settings should be enabled.
Type
Bool.
Create
The default value is False.
This structure contains list of domains monitored by Recursive DNS latency trigger.
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.
The code of the DHCP option.
Type
Unsigned integer.
Create
The field is required on creation.
Type
String.
Notes
The type cannot be updated.
type cannot be written.
This struct contains the name and address of the Microsoft(r) DHCP server.
The IPv4 Address or FQDN of the Microsoft server.
Type
String.
Create
The field is required on creation.
This struct represents a Microsoft DNS server.
The address of the server.
Type
String.
Create
The field is required on creation.
Notes
The address is part of the base object.
This flag indicates if this server is a synchronization master.
Type
Bool.
Create
The default value is False.
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.
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.
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.
This structure contains information about the Microsoft Server Active Directory user synchronization.
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).
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.
The detailed status of the last synchronization attempt.
Type
String.
Notes
The last_sync_detail cannot be updated.
last_sync_detail cannot be written.
The status of the last synchronization attempt.
Type
String.
Notes
The last_sync_status cannot be updated.
last_sync_status cannot be written.
Timestamp of the last synchronization attempt.
Type
Timestamp.
Notes
The last_sync_time cannot be updated.
last_sync_time cannot be written.
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).
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.
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).
Flag to override AD User sync from grid level
Type
Bool.
Create
The default value is False.
Use flag for: enable_user_sync
Type
Bool.
Create
The default value is False.
Flag to override login name and password from MS server
Type
Bool.
Create
The default value is False.
This struct contains information about the Active Directory users.
The Active Directory Domain Controller object represents the Active Directory domain controller that is allowed to create NS records for authoritative zones.
The structure contains NAT settings for a member.
Determines if NAT should be enabled.
Type
Bool.
Create
The default value is undefined.
The Network View Associated Members structure provides information about members associated with a particular Network View.
This structure contains a detailed status report about Grid member operations.
Status about the node of an HA pair.
Type
String.
Notes
The ha_status cannot be updated.
ha_status cannot be written.
Host Platform.
Type
String.
Notes
The host_platform cannot be updated.
host_platform cannot be written.
Hardware model.
Type
String.
Notes
The hwmodel cannot be updated.
hwmodel cannot be written.
Hardware type.
Type
String.
Notes
The hwtype cannot be updated.
hwtype cannot be written.
Hypervisor
Type
String.
Notes
The hypervisor cannot be updated.
hypervisor cannot be written.
Physical port settings for the LAN2 interface.
Type
A/An Physical Port Settings struct.
Create
The default value is undefined.
LAN/HA port settings for the node.
Type
A/An LAN/HA Port Settings struct.
Create
The default value is undefined.
Network settings for the MGMT port of the node.
Type
A/An Network settings struct.
Create
The default value is undefined.
Physical port settings for the MGMT interface.
Type
A/An Physical Port Settings struct.
Create
The default value is undefined.
The NAT external IP address for the node.
Type
String.
Create
The default value is empty.
True if node is Paid NIOS.
Type
Bool.
Notes
The paid_nios cannot be updated.
paid_nios cannot be written.
The OID of the physical node.
Type
String.
Notes
The physical_oid cannot be updated.
physical_oid cannot be written.
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.
The network settings for the IPv6 MGMT port of the node.
Type
A/An IPv6 Settings struct.
Create
The default value is undefined.
This structure holds information about a notification REST template instance.
The notification REST template parameters.
Type
A/An Notification REST template parameter struct array.
Create
The default value is undefined.
This structure holds information about a notification REST template parameter.
The default value of the REST API template parameter.
Type
String.
Notes
The default_value cannot be updated.
default_value cannot be written.
The name of the REST API template parameter.
Type
String.
Create
The field is required on creation.
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.
Rule expression type.
Type
String.
Create
The field is required on creation.
Rule expression first operand value.
Type
String.
Create
The default value is undefined.
The NTP access control item specifies clients that have permissions to access the NTP service.
The client address/network with access control.
Type
A/An Address ac struct.
Create
The field is required on creation.
The NTP access control setting specifies either a named ACL or the list of clients that have permissions to access the NTP service.
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
The NTP authentication key is used by NTP servers to authenticate clients.
The NTP authentication key identifier.
Type
Unsigned integer.
Create
The field is required on creation.
The NTP server structure is used to synchronize the date and time for the Infoblox appliance.
The NTP server IP address or FQDN.
Type
String.
Create
The field is required on creation.
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.
Determines whether the NTP authentication is enabled.
Type
Bool.
Create
The default value is False.
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.
Represents a rule that is used to match a domain name.
The objects changes tracking setting structure is used to enable or disable the object changes tracking feature and to display the objects changes state.
Determines whether the objects changes tracking feature is enabled or not.
Type
Bool.
Create
The default value is False.
Determines the percentage of completion for objects changes tracking.
Type
Unsigned integer.
Notes
The enable_completion cannot be updated.
enable_completion cannot be written.
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.
This struct provides configuration for OCSP Responder.
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.
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.
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.
Determines if this OCSP authentication responder is disabled.
Type
Bool.
Create
The default value is undefined.
An Option 60 Match Rule structure allows specifying match rules for Option 60 globally.
Determines if the match value is a substring.
Type
Bool.
Create
The default value is False.
The match value for this DHCP Option 60 match rule.
Type
String.
Create
The field is required on creation.
The option space for this DHCP Option 60 match rule.
Type
String.
Create
The field is required on creation.
Settings are used to configure OSPF parameters for the member.
The VLAN used as the advertising interface for sending OSPF announcements.
Type
String.
Create
Advertise VLAN setting is required when the interface is set to “IP”.
The area ID value of the OSPF settings.
Type
String.
Create
The field is required on creation.
The OSPF area type.
Type
String.
Create
The default value is STANDARD.
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.
The authentication type used for the OSPF advertisement.
Type
String.
Create
The field is required on creation.
Determines if auto calculate cost is enabled or not.
Type
Bool.
Create
The field is required on creation.
Determines BFD template name.
Type
String.
Create
The default value is empty.
A descriptive comment of the OSPF configuration.
Type
String.
Create
The default value is Empty string.
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”.
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.
Determines if the BFD is enabled or not.
Type
Bool.
Create
The default value is False.
Determines if BFD internal DNS monitor is enabled or not.
Type
Bool.
Create
The default value is True.
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.
The interface that sends out OSPF advertisement information.
Type
String.
Create
The field is required on creation.
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.
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.
The parental control settings for additional blocking server.
The parental control settings for MSP.
The parental control network accounting server (NAS) gateway object provides configuration for transmission of authentication protocol accounting information to the NIOS accounting collector.
The human readable comment for NAS gateway.
Type
String.
Create
The default value is undefined.
The IP address of NAS gateway.
Type
String.
Create
The field is required on creation.
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.
The parental control settings for SPM.
This structure contains settings for an appliance physical port.
Enable or disalbe the auto port setting.
Type
Bool.
Create
The default value is undefined.
The structure contains pre-provisioning settings.
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.
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.
Create
The field is required on creation.
The structure contains hardware information for a pre-provisioned member.
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, ‘IB-2215, IB-2225.
Type
String.
Create
The default value is undefined.
Hardware type.
Type
String.
Create
The field is required on creation.
This struct contains information about blackout settings.
The blackout duration in seconds; minimum value is 1 minute.
Type
Unsigned integer.
Create
The default value is empty.
A Schedule Setting struct that determines blackout schedule.
Type
A/An Schedule Setting struct.
Create
The default value is undefined.
This structure contains information about the SNMPv3 queries user.
This structure is used for RADIUS authentication configuration.
The accounting port.
Type
Unsigned integer.
Create
The default value is The default value is 1813 if use_accounting is set to False.
The FQDN or the IP address of the RADIUS server that is used for authentication.
Type
String.
Create
The field is required on creation.
The authorization port.
Type
Unsigned integer.
Create
The default value is The default value is 1812 if use_accounting is set to True.
The authentication protocol.
Type
String.
Create
The default value is PAP.
The RADIUS descriptive comment.
Type
String.
Create
The default value is undefined.
Determines whether the RADIUS server is disabled.
Type
Bool.
Create
The default value is False.
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.
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.
The Remote DDNS Zone structure provides information about the remote DDNS zone associated with a particular object.
The principal name in which GSS-TSIG for dynamic updates is enabled.
Type
String.
Create
The default value is empty.
The domain in which GSS-TSIG for dynamic updates is enabled.
Type
String.
Create
The default value is empty.
The key type to be used.
Type
String.
Create
The default value is NONE.
The remote server IP address.
Type
String.
Create
The field is required on creation.
This structure is used for SAML authentication configuration.
The SAML Identity Provider descriptive comment.
Type
String.
Create
The default value is empty.
The SAML groupname optional user group attribute.
Type
String.
Create
The default value is empty.
SAML Identity Provider type.
Type
String.
Create
The field is required on creation.
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.
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.
The frequency of backups.
Type
String.
Create
The default value is WEEKLY.
The IP address of the backup server.
Type
String.
Create
The default value is empty.
The destination of the backup files.
Type
String.
Create
The default value is LOCAL.
Determines whether the restore the NetMRI data is enabled.
Type
Bool.
Create
The default value is True.
If set, scp backup support to download keys
Type
Bool.
Create
The default value is False.
Determines whether the scheduled backup is enabled.
Type
Bool.
Create
The default value is True.
The state for scheduled backup or restore operation.
Type
String.
Create
The default value is undefined.
Notes
The execute cannot be updated.
execute is not readable.
The hour of the day past 12:00 AM the backup is performed.
Type
Unsigned integer.
Create
The default value is 3.
Determines whether the local backup performed before uploading backup to remote storage.
Type
Bool.
Create
The default value is False.
If set, scp backup support based on keys type
Type
String.
Create
The default value is undefined.
Notes
The key_type cannot be updated.
key_type is not readable.
The minute of the hour when the backup is performed.
Type
Unsigned integer.
Create
The default value is 0.
Determines whether the restore of the NIOS data is enabled.
Type
Bool.
Create
The default value is True.
The scheduled backup operation.
Type
String.
Create
The default value is NONE.
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.
The directory path to the backup file stored on the server.
Type
String.
Create
The default value is empty.
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.
The directory path to the restored file on the server.
Type
String.
Create
The default value is empty.
The IP address of the restore server.
Type
String.
Create
The default value is empty.
The destination of the restore files.
Type
String.
Create
The default value is FTP.
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.
Determines whether the restore of the Splunk application data is enabled.
Type
Bool.
Create
The default value is True.
The status of the scheduled backup.
Type
String.
Notes
The status cannot be updated.
status cannot be written.
If set, scp backup support to upload keys
Type
Bool.
Create
The default value is False.
If set, scp backup support based on keys
Type
Bool.
Create
The default value is False.
This structure contains a service status of the Grid Member’s node.
The description of the current service status.
Type
String.
Notes
The description cannot be updated.
description cannot be written.
The service identifier.
Type
String.
Notes
The service cannot be updated.
service cannot be written.
This struct contains information about outbound settings for ATP events.
Grid level settings for automated traffic capture.
Destination of traffic capture files. Save traffic capture locally or upload to remote server using FTP or SCP.
Type
String.
Create
The default value is NONE.
IP Address of the destination host.
Type
String.
Create
The default value is empty.
The time interval on which traffic will be captured(in sec).
Type
Unsigned integer.
Create
The default value is empty.
Enable automatic download for support bundle.
Type
Bool.
Create
The default value is False.
Save traffic capture files locally.
Type
Bool.
Create
The default value is False.
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.
Directory to store the support bundle on the remote server.
Type
String.
Create
The default value is empty.
Directory to store the traffic capture files on the remote server.
Type
String.
Create
The default value is empty.
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.
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.
This structure contains configuration for dynamic ratio load balancing.
Determines whether the inverted values of the DTC SNMP monitor metric will be used.
Type
Bool.
Create
The default value is False.
The method of the DTC dynamic ratio load balancing.
Type
String.
Create
The default value is 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.
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.
Determines if email notification is enabled or not.
Type
Bool.
Create
The default value is False.
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 to validate from address
Type
String.
Create
The default value is empty.
Notes
password is not readable.
The Grid HTTP Proxy Server Setting object provides information about the HTTP proxy server configuration.
The address of the HTTP proxy server.
Type
String.
Create
The field is required on creation.
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.
The descriptive comment for the HTTP proxy server configuration.
Type
String.
Create
The default value is empty.
Determines if HTTPS content inspection by the HTTP proxy server is enabled or not.
Type
Bool.
Create
The default value is False.
Determines if the HTTP proxy server is enabled or not.
Type
Bool.
Create
The default value is False.
Determines if username and password for HTTP Proxy Server connectivity is used or not.
Type
Bool.
Create
The default value is False.
The password for the HTTP proxy server.
Type
String.
Create
The default value is undefined.
Notes
password is not readable.
The port on which the HTTP proxy server listens.
Type
Unsigned integer.
Create
The field is required on creation.
This structure contains inactivity lockout settings.
Enable/disable the account inactivity lockout.
Type
Bool.
Create
The default value is False.
Number of days after which account gets locked out if user does not login.
Type
Unsigned integer.
Create
The default value is 30.
Enable/disable reactivating user account by logging in from remote console.
Type
Bool.
Create
The default value is True.
This struct contains information about the IPAM theshold settings.
This struct contains information about the IPAM trap settings.
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.
The default IP site link for sites created on NIOS for all Microsoft servers.
Type
String.
Create
The default value is DEFAULTIPSITELINK.
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.
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.
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.
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.
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.
Determines if the Network Users creation is enabled or not.
Type
Bool.
Create
The default value is False.
Determines an LDAP connection timeout interval (in seconds) for all Microsoft servers.
Type
Unsigned integer.
Create
The default value is 10.
The logging of synchronization messages to the syslog or mslog.
Type
String.
Create
The default value is MSLOG.
This structure contains a network settings for the member.
The IPv4 Address of the Grid Member.
Type
String.
Create
The default value is empty.
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
The default gateway for the Grid Member.
Type
String.
Create
The default value is empty.
Determines if the current address is the primary VLAN address or not.
Type
Bool.
Create
The default value is True.
This structure contains settings related to the Grid admin passwords.
The minimum number of characters that must be changed when revising an admin password.
Type
Unsigned integer.
Create
The default value is 0.
The number of days of the password expiration period (if enabled).
Type
Unsigned integer.
Create
The default value is 30.
If set to True, password expiration is enabled.
Type
Bool.
Create
The default value is False.
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.
Enable/disable the password history.
Type
Bool.
Create
The default value is False.
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.
The minimum number of lowercase characters.
Type
Unsigned integer.
Create
The default value is 0.
The minimum number of numeric characters.
Type
Unsigned integer.
Create
The default value is 0.
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.
The minimum number of symbol characters. The allowed characters are ! @ # $ % ^ & * ( ).
Type
Unsigned integer.
Create
The default value is 0.
The minimum number of uppercase characters.
Type
Unsigned integer.
Create
The default value is 0.
The DNS scavenging settings object provides information about scavenging configuration e.g. conditions under which records can be scavenged, periodicity of scavenging operations.
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.
This flag indicates if the automatic resource record scavenging is enabled or not.
Type
Bool.
Create
The default value is False.
This flag indicates if the recurrent resource record scavenging is enabled or not.
Type
Bool.
Create
The default value is False.
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.
This flag indicates if the resource record scavenging is enabled or not.
Type
Bool.
Create
The default value is False.
This flag indicates if the last queried monitoring for affected zones is enabled or not.
Type
Bool.
Create
The default value is False.
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.
This flag indicates if the associated resource record scavenging is enabled or not.
Type
Bool.
Create
The default value is False.
Schedule setting for cloud discovery task.
Type
A/An Schedule Setting struct.
Create
The default value is empty.
This struct contains information about scheduling settings.
The day of the month for the scheduled task.
Type
Unsigned integer.
Create
The default value is 1.
If set to True, the scheduled task is disabled.
Type
Bool.
Create
The default value is False.
The number of frequency to wait before repeating the scheduled task.
Type
Unsigned integer.
Create
The default value is 1.
The frequency for the scheduled task.
Type
String.
Create
The default value is empty.
The hour of day for the scheduled task.
Type
Unsigned integer.
Create
The default value is 1.
The minutes past the hour for the scheduled task.
Type
Unsigned integer.
Create
The default value is 1.
The month for the scheduled task.
Type
Unsigned integer.
Create
The default value is 1.
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.
Indicates if the scheduled task will be repeated or run only once.
Type
String.
Create
The default value is ONCE.
The time zone for the schedule.
Type
String.
Create
The default value is (UTC) Coordinated Universal Time.
This structure contains the Grid security settings.
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
If set to True, rolling of audit logs is enabled.
Type
Bool.
Create
The default value is True.
Whether concurrent login allowed gridlevel
Type
Bool.
Create
The default value is False.
If set to True, HTTP connections are redirected to HTTPS.
Type
Bool.
Create
The default value is False.
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}
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.
If set to True, the login banner is enabled.
Type
Bool.
Create
The default value is True.
The login banner text.
Type
String.
Create
The default value is Disconnect NOW if you have not been expressly authorized to use this system.
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.
If set to True, HTTP access restrictions are enabled.
Type
Bool.
Create
The default value is False.
If set to True, remote console access restrictions will be enabled.
Type
Bool.
Create
The default value is True.
The session timeout interval in seconds.
Type
Unsigned integer.
Create
The default value is 600.
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.
This structure contains settings related to the Grid security level banner.
The security level color.
Type
String.
Create
The default value is GREEN.
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.
The security level.
Type
String.
Create
The default value is UNCLASSIFIED.
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.
This structure contains information about the SNMP subsystem.
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.
The community string for SNMP queries.
Type
String.
Create
The default value is empty.
If set to True, SNMP queries are enabled.
Type
Bool.
Create
The default value is empty.
If set to True, SNMPv3 queries are enabled.
Type
Bool.
Create
The default value is empty.
A list of SNMPv3 queries users.
Type
A/An Queries user struct array.
Create
The default value is empty.
If set to True, SNMPv3 traps are enabled.
Type
Bool.
Create
The default value is empty.
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.
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.
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.
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.
A list of trap receivers.
Type
A/An Trap receiver struct array.
Create
The default value is empty.
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.
This structure contains the syslog proxy settings for the Grid Member.
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
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.
If set to True, the appliance can receive messages from other devices via TCP.
Type
Bool.
Create
The default value is False.
The TCP port the appliance must listen on.
Type
Unsigned integer.
Create
The default value is 514.
Grid level settings for enabling DNS cache hit ratio threshold for automated traffic capture.
Minimum DNS cache utilization threshold(%) for triggering traffic capture based on DNS cache hit ratio.
Type
Unsigned integer.
Create
The default value is empty.
DNS Cache hit ratio threshold(%) above which traffic capture will be triggered.
Type
Unsigned integer.
Create
The default value is empty.
Grid level settings for enabling DNS query pe second thresholds for automated traffic capture.
DNS queries per second threshold below which traffic capture will be stopped.
Type
Unsigned integer.
Create
The default value is empty.
DNS latency.
List of domains monitored by ‘Recursive DNS Latency Threshold’ trigger.
Type
A/An Monitored domains struct array.
Create
The default value is empty.
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.
The local IP DNS service is listen on ( for recursive DNS latency trigger).
Type
String.
Create
The default value is VIP_V4.
Recursive DNS latency above which traffic capture will be stopped.
Type
Unsigned integer.
Create
The default value is empty.
queries.
Concurrent outgoing recursive queries count below which traffic capture will be stopped.
Type
Unsigned integer.
Create
The default value is empty.
latency.
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.
The local IP DNS service is listen on (for authoritative DNS latency trigger).
Type
String.
Create
The default value is VIP_V4.
Authoritative DNS latency above which traffic capture will stopped.
Type
Unsigned integer.
Create
The default value is empty.
Determines which IP address is used as the source for DDNS notify and transfer operations.
Type
String.
Create
The default value is VIP.
The source address used if dns_notify_transfer_source type is “IP”.
Type
String.
Create
The default value is empty.
The source address used if dns_query_source_interface type is “IP”.
Type
String.
Create
The default value is empty.
Determines which IP address is used as the source for DDNS query operations.
Type
String.
Create
The default value is VIP.
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).
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).
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).
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).
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 flag for: notify_delay
Type
Bool.
Create
The default value is False.
The Smart Folder group by structure defines grouping information in a global or personal Smart Folder.
Determines whether the grouping is enabled.
Type
Bool.
Create
The default value is False.
This structure is used to query the Smart Folder children items.
The Smart Folder query item contains information about a query to be stored in a global or personal Smart Folder.
The Smart Folder query field type.
Type
String.
Create
The field is required on creation.
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.
Determines whether the query operator should match.
Type
Bool.
Create
The default value is True.
The Smart Folder operator used in query.
Type
String.
Create
The field is required on creation.
The Smart Folder query value.
Type
A/An Smart Folder query item value structure struct.
Create
The default value is undefined.
The Smart Folder query item value contains the value used for the query.
The boolean value of the Smart Folder query.
Type
Bool.
Create
The default value is undefined.
The timestamp value of the Smart Folder query.
Type
Timestamp.
Create
The default value is undefined.
A sortlist defines the order of IP addresses listed in responses sent to DNS queries.
This structure contains the details of the key.
Unique identifier for the key
Type
String.
Create
The default value is undefined.
Notes
The key_name is part of the base object.
Contains parameres for creatig server. User can create multile server for one syslog endpoint.
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.
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 values
Type
String.
Create
The default value is udp.
Facility values for syslog endpoint server
Type
String.
Create
The default value is local0.
Format vlues for syslog endpoint server
Type
String.
Create
The default value is raw.
List of hostnames
Type
String.
Create
The default value is HOSTNAME.
This structure contains information about a remote syslog server.
The list of all syslog logging categories.
Type
Enum values array.
Create
The default value is empty.
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.
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.
The connection type for communicating with this server.
Type
String.
Create
The default value is UDP.
The local interface through which the appliance sends syslog messages to the syslog server.
Type
String.
Create
The default value is ANY.
Identify the node in the syslog message.
Type
String.
Create
The default value is LAN.
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.
Create
The default value is ANY.
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.
This structure is used for TACACS+ authentication configuration.
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.
The authentication protocol.
Type
String.
Create
The default value is CHAP.
The TACACS+ descriptive comment.
Type
String.
Create
The default value is undefined.
Determines whether the TACACS+ server is disabled.
Type
Bool.
Create
The default value is False.
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.
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.
The structure provides information about the port blocks configured for NAT mapping.
The block size for the NAT Port configuration object.
Type
Unsigned integer.
Create
The field is required on creation.
The structure provides information about NAT rules configured for the threat protection NAT mapping feature.
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’.
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’.
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’.
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.
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’.
The structure provides information about threat protection rule configuration.
The rule action.
Type
String.
Create
The field is required on creation.
The rule log severity.
Type
String.
Create
The field is required on creation.
The threat protection rule parameters.
Type
A/An Threat protection rule parameter struct array.
Create
The default value is undefined.
The structure provides information about the threat protection rule parameter.
The rule parameter description.
Type
String.
Notes
The description cannot be updated.
description cannot be written.
The rule parameter enum values.
Type
String array.
Notes
The enum_values cannot be updated.
enum_values cannot be written.
The rule parameter maximum.
Type
Unsigned integer.
Notes
The max cannot be updated.
max cannot be written.
The rule parameter minimum.
Type
Unsigned integer.
Notes
The min cannot be updated.
min cannot be written.
Determines if parameter value is editable at member level.
Type
Bool.
Notes
The read_only cannot be updated.
read_only cannot be written.
The structure provides information about threat protection statistical information configuration.
The number of critical events.
Type
Unsigned long integer.
Create
The default value is undefined.
The number of informational events.
Type
Unsigned long integer.
Create
The default value is undefined.
The number of major events.
Type
Unsigned long integer.
Create
The default value is undefined.
The timestamp when data was collected.
Type
Timestamp.
Notes
The timestamp cannot be updated.
timestamp cannot be written.
This structure is used to set the values of the thresholds of the SNMP traps.
Determines the threshold value to reset the trap.
Type
Unsigned integer.
Create
The default value is The default value depends on the trap_type.
Determines the threshold value to trigger the trap.
Type
Unsigned integer.
Create
The default value is The default value depends on the trap_type.
Determines the type of a given trap.
Type
String.
Create
The field is required on creation.
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.
Determines if the email notifications for the given trap are enabled or not.
Type
Bool.
Create
The default value is False.
Determines if the trap is enabled or not.
Type
Bool.
Create
The default value is True.
Determines the type of a given trap.
Type
String.
Create
The field is required on creation.
This structure contains information about an SNMP trap receiver.
This struct represents a 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.
The TSIG key algorithm.
Type
String.
Create
The default value is HMAC-MD5.
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).
The Updates Download Member Configuration structure provides information and settings for configuring the member that is responsible for downloading updates.
The source interface for updates download requests.
Type
String.
Create
The field is required on creation.
This structure represents the upgrade group member settings.
The upgrade group member name.
Type
String.
Create
The field is required on creation.
The upgrade group member time zone.
Type
String.
Notes
The time_zone cannot be updated.
time_zone cannot be written.
This structure is used to configure upgrade scheduling for groups.
The distribution dependent group name.
Type
String.
Create
The default value is empty.
The time of the next scheduled distribution.
Type
Timestamp.
Create
The default value is 0.
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.
The time zone for scheduling operations.
Type
String.
Notes
The time_zone cannot be updated.
time_zone cannot be written.
The structure provides information about the status of the upgrade process step.
This structure conatains information about VLAN object.
VLAN ID value.
Type
Unsigned integer.
Notes
The id is part of the base object.
The id cannot be updated.
id cannot be written.
Name of the VLAN.
Type
String.
Notes
The name is part of the base object.
The name cannot be updated.
name cannot be written.
Reference to the underlying StaticVlan object.
Type
SubObj.
The field also supports automatic selection of the next available VLAN in the specified vlanview or vlanrange. You can specify the vlanview or vlanrange in the following way:
Using a vlanview or vlanrange WAPI reference:
- func:nextavailablevlan:<reference>
Scheduled and approval operations are not supported when using the automatic VLAN selection.
NOTE: Automatic selection is supported only for JSON and XML requests.
Examples:
- func:nextavailablevlan:vlanview/ZG5zLnZsYW5fdmlldyRW:vl_view1/1/100
- func:nextavailablevlan:vlanrange/ZG5zLm5ldHdvcmskMTAu:vl_view1/vl_range1/1/10
This field can also be retrieved from a function call as part of an object insertion. The supported function calls for this field are:
- the next_available_vlan function call in object ipv6network (default parameters: {‘num’: 1})
- the next_available_vlan function call in object network (default parameters: {‘num’: 1})
To find out if the function can be called when _object_parameters matches multiple objects, see the function documentation.
The default parameters are passed to the specified function call and can be overridden by passing different values for the same parameter in _parameters.
To execute the function call, a dictionary must be set in this field with the following parameters:
Mandatory Name Comment Y _object_function The name of the function. Y _result_field The field in which the function returns its result. See comment _object The WAPI object type on which the function calls. Either _object or _object_ref must be set. See comment _object_ref A WAPI object reference on which the function calls. Either _object or _object_ref must be set. N _parameters The parameters to be passed to the function. See comment _object_parameters The parameters used for the object search, mandatory if _object is set. As part of the insertion, the object identified by _object and _object_parameters will be fetched, and the function identified by _object_function will be called with the parameters specified in _parameters. The result of this function will be retrieved and the field of this function specified in _result_field will be extracted and used as the value for this field.
Note that if the function call returns a list, and the field requires a single value, the first value on the list will be used.
The following example uses a value for the ‘next_available_ip’ field in the 9.0.0.0/8 network, excluding IP addresses 9.0.0.1 and 9.0.0.2:
{ '_object_function': 'next_available_ip', '_parameters': { 'exclude': ['9.0.0.1', '9.0.0.2'], }, '_result_field': 'ips', '_object': 'network', '_object_parameters': { 'network': '9.0.0.0/8', 'network_view': 'newdefaultnv', } }Note this function call might not be valid for this particular field, this is just an example.
This field supports nested return fields as described here.
Create
The field is required on creation.
Notes
The vlan is part of the base object.
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.
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’
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’
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’
The IP type of the virtual TFTP root directory.
Type
String.
Create
The field is required on creation.
The Grid member on which to create the virtual TFTP directory.
Type
String.
Create
The field is required on creation.
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.
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.
The Zone Name Server structure provides IP address information for the name server associated with a NS record.
This structure is used for displaying zone rollover information.
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.
The domain name of the signed zone.
Type
String.
Create
The default value is undefined.
zone_stub : DNS Stub Zone object.