An Admin Group object creates and manages a local admin group on the Infoblox appliance. The privileges and properties that are set for the group apply to all the admin accounts that are assigned to the group.
References to admingroup are object references.
The object does not support the following operations:
The object cannot be managed on Cloud Platform members.
These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.
The basic version of the object contains the field(s): comment, name.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| name |
Access methods specify whether an admin group can use the GUI and the API to access the appliance or to send Taxii messages to the appliance. Note that API includes both the Perl API and RESTful API.
Type
Enum values array.
Create
The default value is [‘GUI’, ‘API’, ‘TAXII’, ‘CLI’].
Search
The field is not available for search.
Admin set commands for the admin command group.
Type
A/An Set commands struct.
Create
The default value is:
{ 'set_admin_group_acl': False,
'set_analytics_database_dump': False,
'set_analytics_parameter': False,
'set_bfd': False,
'set_bgp': False,
'set_bloxtools': False,
'set_clean_mscache': False,
'set_collect_old_logs': False,
'set_core_files_quota': False,
'set_debug': False,
'set_delete_tasks_interval': False,
'set_disable_gui_one_click_support': False,
'set_enable_doh_key_logging': False,
'set_enable_dot_key_logging': False,
'set_expertmode': False,
'set_hardware_type': False,
'set_hotfix': False,
'set_hsm_group': False,
'set_ibtrap': False,
'set_lcd': False,
'set_lcd_settings': False,
'set_lines': False,
'set_maintenancemode': False,
'set_mgm': False,
'set_ms_max_connection': False,
'set_nosafemode': False,
'set_ntp_stratum': False,
'set_ocsp': False,
'set_pc_domain': False,
'set_report_frequency': False,
'set_safemode': False,
'set_scheduled': False,
'set_snmptrap': False,
'set_sysname': False,
'set_term': False,
'set_thresholdtrap': False,
'set_transfer_reporting_data': False,
'set_transfer_supportbundle': False,
'set_wred': False}
Search
The field is not available for search.
Admin show commands for the admin command group.
Type
A/An Show commands struct.
Create
The default value is:
{ 'show_admin_group_acl': False,
'show_analytics_database_dumps': False,
'show_arp': False,
'show_bfd': False,
'show_bgp': False,
'show_bloxtools': False,
'show_capacity': False,
'show_clusterd_info': False,
'show_config': False,
'show_cores': False,
'show_coresummary': False,
'show_cpu': False,
'show_csp_threat_db': False,
'show_date': False,
'show_debug': False,
'show_delete_tasks_interval': False,
'show_disk': False,
'show_file': False,
'show_hardware_type': False,
'show_hsm_group': False,
'show_hsm_info': False,
'show_hwid': False,
'show_ibtrap': False,
'show_lcd': False,
'show_lcd_info': False,
'show_lcd_settings': False,
'show_log': False,
'show_logfiles': False,
'show_memory': False,
'show_ntp': False,
'show_ntp_stratum': False,
'show_pc_domain': False,
'show_pmap': False,
'show_process': False,
'show_pstack': False,
'show_report_frequency': False,
'show_safenet_support_info': False,
'show_scheduled': False,
'show_snmp': False,
'show_status': False,
'show_tech_support': False,
'show_temperature': False,
'show_thresholdtrap': False,
'show_upgrade_history': False,
'show_uptime': False,
'show_version': False,
'show_wred_stats': False,
'show_wred_status': False}
Search
The field is not available for search.
Admin_toplevel commands for the admin command group
Type
A/An Toplevel commands struct.
Create
The default value is:
{ 'iostat': False,
'netstat': False,
'ps': False,
'rndc': False,
'sar': False,
'synctime': False,
'tcpdump': False,
'vmstat': False}
Search
The field is not available for search.
Cloud set commands for the cloud command group.
Type
A/An Set commands struct.
Create
The default value is:
{ 'set_cloud_services_portal': False,
'set_cloud_services_portal_force_refresh': False}
Search
The field is not available for search.
Cloud show commands for admin group
Type
A/An Show commands struct.
Create
The default value is:
{ 'show_cloud_services_portal': False}
Search
The field is not available for search.
Comment for the Admin Group; maximum 256 characters.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is empty.
Search
The field is available for search via
Notes
The comment is part of the base object.
Database show commands for admin group.
Type
A/An Set commands struct.
Create
The default value is:
{ 'set_circ_txn_trace': False,
'set_database_transfer': False,
'set_db_rollover': False,
'set_db_snapshot': False,
'set_dbsize': False,
'set_debug_tools': False,
'set_named_max_journal_size': False,
'set_txn_trace': False}
Search
The field is not available for search.
Database show commands for the database command
Type
A/An Show commands struct.
Create
The default value is:
{ 'show_backup': False,
'show_database_transfer_status': False,
'show_db_ph': False,
'show_dbsize': False,
'show_ibdbstat': False,
'show_named_max_journal_size': False,
'show_txn_trace': False}
Search
The field is not available for search.
Dhcp set commands for the dhcp command group.
Type
A/An Set commands struct.
Create
The default value is:
{ 'set_dhcpd_recv_sock_buf_size': False,
'set_log_txn_id': False,
'set_overload_bootp': False,
'set_regenerate_dhcp_updater_keys': False}
Search
The field is not available for search.
Dhcp show commands for the dhcp command group.
Type
A/An show commands struct.
Create
The default value is:
{ 'show_dhcpd_recv_sock_buf_size': False,
'show_log_txn_id': False,
'show_overload_bootp': False}
Search
The field is not available for search.
Determines whether the Admin Group is disabled or not. When this is set to False, the Admin Group is enabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Disable concurrent login feature
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Dns set commands for the dns command group.
Type
A/An Set commands struct.
Create
The default value is:
{ 'set_allow_query_domain': False,
'set_dns': False,
'set_dns_accel': False,
'set_dns_accel_debug': False,
'set_dns_auto_gen': False,
'set_dns_rrl': False,
'set_enable_match_recursive_only': False,
'set_log_guest_lookups': False,
'set_max_recursion_depth': False,
'set_max_recursion_queries': False,
'set_monitor': False,
'set_ms_dns_reports_sync_interval': False,
'set_ms_sticky_ip': False,
'set_restart_anycast_with_dns_restart': False}
Search
The field is not available for search.
Dns show commands for the dns command group.
Type
A/An Show commands struct.
Create
The default value is:
{ 'show_allow_query_domain': False,
'show_allow_query_domain_views': False,
'show_dns': False,
'show_dns_accel': False,
'show_dns_accel_debug': False,
'show_dns_rrl': False,
'show_dtc_ea': False,
'show_dtc_geoip': False,
'show_enable_match_recursive_only': False,
'show_log_guest_lookups': False,
'show_max_recursion_depth': False,
'show_max_recursion_queries': False,
'show_monitor': False,
'show_ms_sticky_ip': False,
'show_query_capture': False,
'show_restart_anycast_with_dns_restart': False}
Search
The field is not available for search.
Dns toplevel commands for the dns command group.
Type
A/An Toplevel commands struct.
Create
The default value is:
{ 'ddns_add': False,
'ddns_delete': False,
'delete': False,
'dns_a_record_delete': False}
Search
The field is not available for search.
Docker set commands for the dcoker command group.
Type
A/An Set commands struct.
Create
The default value is:
{ 'set_docker_bridge': False}
Search
The field is not available for search.
Docker show commands for the dcoker command group.
Type
A/An Show commands struct.
Create
The default value is:
{ 'show_docker_bridge': False}
Search
The field is not available for search.
The e-mail addresses for the Admin Group.
Type
String array.
Create
The default value is empty.
Search
The field is not available for search.
Determines whether the restrictions will be applied to the admin connector level for users of this Admin Group.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Extensible attributes associated with the object.
For valid values for extensible attributes, see the following information.
Type
Extensible attributes.
This field allows +/- to be specified as part of the field name when updating the object, see the following information.
Create
The default value is empty.
Search
For how to search extensible attributes, see the following information.
Grid set commands for the grid command group.
Type
A/An Set commands struct.
Create
The default value is:
{ 'set_default_revert_window': False,
'set_dscp': False,
'set_membership': False,
'set_nogrid': False,
'set_nomastergrid': False,
'set_promote_master': False,
'set_revert_grid': False,
'set_token': False}
Search
The field is not available for search.
Show commands for the grid command group.
Type
A/An Show commands struct.
Create
The default value is:
{ 'show_token': False}
Search
The field is not available for search.
The Admin group inactivity lockout 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}
Search
The field is not available for search.
Notes
inactivity_lockout_setting is associated with the field use_account_inactivity_lockout_enable (see use flag).
Set commands for the licensing command group.
Type
A/An Set commands struct.
Create
The default value is:
{ 'set_license': False,
'set_reporting_reset_license': False,
'set_temp_license': False}
Search
The field is not available for search.
Show commands for the licensing command group.
Type
A/An Show commands struct.
Create
The default value is:
{ 'show_license': False,
'show_license_pool_container': False,
'show_license_uid': False}
Search
The field is not available for search.
This struct specifies security policy settings in admin group.
Type
A/An lockout_setting struct.
Create
The default value is:
{ 'enable_sequential_failed_login_attempts_lockout': False,
'failed_lockout_duration': 5,
'never_unlock_user': False,
'sequential_attempts': 5}
Search
The field is not available for search.
Notes
lockout_setting is associated with the field use_lockout_setting (see use flag).
Machine control toplevel commands for the machine control command group.
Type
A/An Toplevel commands struct.
Create
The default value is:
{ 'reboot': False, 'reset': False, 'restart': False, 'shutdown': False}
Search
The field is not available for search.
The name of the Admin Group.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required on creation.
Search
The field is available for search via
Notes
The name is part of the base object.
Set commands for the networking command group.
Type
A/An Set commands struct.
Create
The default value is:
{ 'set_connection_limit': False,
'set_interface': False,
'set_ip_rate_limit': False,
'set_ipv6_disable_on_dad': False,
'set_ipv6_neighbor': False,
'set_ipv6_ospf': False,
'set_ipv6_status': False,
'set_lom': False,
'set_mld_version_1': False,
'set_named_recv_sock_buf_size': False,
'set_named_tcp_clients_limit': False,
'set_network': False,
'set_ospf': False,
'set_prompt': False,
'set_remote_console': False,
'set_static_route': False,
'set_tcp_timestamps': False,
'set_traffic_capture': False,
'set_wins_forwarding': False}
Search
The field is not available for search.
Show commands for the networking command group.
Type
A/An Show commands struct.
Create
The default value is:
{ 'show_connection_limit': False,
'show_connections': False,
'show_default_route': False,
'show_interface': False,
'show_interface_stats': False,
'show_ip_rate_limit': False,
'show_iproute': False,
'show_iprule': False,
'show_iptables': False,
'show_ipv6_bgp': False,
'show_ipv6_disable_on_dad': False,
'show_ipv6_neighbor': False,
'show_ipv6_ospf': False,
'show_lom': False,
'show_mld_version': False,
'show_mtu_size': False,
'show_named_recv_sock_buf_size': False,
'show_named_tcp_clients_limit': False,
'show_network': False,
'show_network_connectivity': False,
'show_ospf': False,
'show_remote_console': False,
'show_routes': False,
'show_static_routes': False,
'show_tcp_timestamps': False,
'show_traffic_capture_status': False,
'show_trafficfiles': False,
'show_wins_forwarding': False}
Search
The field is not available for search.
The Admin Group password settings.
Type
A/An Password settings struct.
Create
The default value is:
{ 'expire_days': 30, 'expire_enable': False, 'reminder_days': 15}
Search
The field is not available for search.
Notes
password_setting is associated with the field use_password_setting (see use flag).
The names of roles this Admin Group applies to.
Type
String array.
Create
The default value is empty.
Search
The field is available for search via
The Admin Group SAML settings.
Type
A/An SAML settings struct.
Create
The default value is:
{ 'auto_create_user': False, 'persist_auto_created_user': False}
Search
The field is not available for search.
Set commands for the security command group.
Type
A/An Set commands struct.
Create
The default value is:
{ 'set_adp': False,
'set_apache_https_cert': False,
'set_cc_mode': False,
'set_certificate_auth_admins': False,
'set_certificate_auth_services': False,
'set_check_auth_ns': False,
'set_disable_https_cert_regeneration': False,
'set_fips_mode': False,
'set_reporting_cert': False,
'set_security': False,
'set_session_timeout': False,
'set_subscriber_secure_data': False,
'set_support_access': False,
'set_support_timeout': False,
'set_update_rabbitmq_password': False}
Search
The field is not available for search.
Show commands for the security command group.
Type
A/An Show commands struct.
Create
The default value is:
{ 'show_cc_mode': False,
'show_certificate_auth_admins': False,
'show_certificate_auth_services': False,
'show_check_auth_ns': False,
'show_fips_mode': False,
'show_security': False,
'show_session_timeout': False,
'show_subscriber_secure_data': False,
'show_support_access': False,
'show_support_timeout': False,
'show_vpn_cert_dates': False}
Search
The field is not available for search.
Determines whether this Admin Group is a superuser group. A superuser group can perform all operations on the appliance, and can view and configure all types of data.
Type
Bool.
Create
The default value is False.
Search
The field is available for search via
Toplevel commands for the troubleshooting command group.
Type
A/An Toplevel commands struct.
Create
The default value is:
{ 'console': False,
'dig': False,
'ping': False,
'ping6': False,
'rotate': False,
'snmpget': False,
'snmpwalk': False,
'strace': False,
'traceroute': False,
'traffic_capture': False}
Search
The field is not available for search.
This is the use flag for account inactivity lockout settings.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Whether to override grid concurrent login
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Whether to override grid sequential lockout setting
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Whether grid password expiry setting should be override.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The access control items for this Admin Group.
Type
A/An Address ac struct array.
Create
The default value is:
empty
Search
The field is not available for search.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| access_method | [Enum] | N | N | N | N/A |
| admin_set_commands | struct | N | N | N | N/A |
| admin_show_commands | struct | N | N | N | N/A |
| admin_toplevel_commands | struct | N | N | N | N/A |
| cloud_set_commands | struct | N | N | N | N/A |
| cloud_show_commands | struct | N | N | N | N/A |
| comment | String | N | N | Y | : = ~ |
| database_set_commands | struct | N | N | N | N/A |
| database_show_commands | struct | N | N | N | N/A |
| dhcp_set_commands | struct | N | N | N | N/A |
| dhcp_show_commands | struct | N | N | N | N/A |
| disable | Bool | N | N | N | N/A |
| disable_concurrent_login | Bool | N | N | N | N/A |
| dns_set_commands | struct | N | N | N | N/A |
| dns_show_commands | struct | N | N | N | N/A |
| dns_toplevel_commands | struct | N | N | N | N/A |
| docker_set_commands | struct | N | N | N | N/A |
| docker_show_commands | struct | N | N | N | N/A |
| email_addresses | [String] | N | N | N | N/A |
| enable_restricted_user_access | Bool | N | N | N | N/A |
| extattrs | Extattr | N | N | N | ext |
| grid_set_commands | struct | N | N | N | N/A |
| grid_show_commands | struct | N | N | N | N/A |
| inactivity_lockout_setting | struct | N | N | N | N/A |
| licensing_set_commands | struct | N | N | N | N/A |
| licensing_show_commands | struct | N | N | N | N/A |
| lockout_setting | struct | N | N | N | N/A |
| machine_control_toplevel_commands | struct | N | N | N | N/A |
| name | String | Y | N | Y | : = ~ |
| networking_set_commands | struct | N | N | N | N/A |
| networking_show_commands | struct | N | N | N | N/A |
| password_setting | struct | N | N | N | N/A |
| roles | [String] | N | N | N | = |
| saml_setting | struct | N | N | N | N/A |
| security_set_commands | struct | N | N | N | N/A |
| security_show_commands | struct | N | N | N | N/A |
| superuser | Bool | N | N | N | = |
| trouble_shooting_toplevel_commands | struct | N | N | N | N/A |
| use_account_inactivity_lockout_enable | Bool | N | N | N | N/A |
| use_disable_concurrent_login | Bool | N | N | N | N/A |
| use_lockout_setting | Bool | N | N | N | N/A |
| use_password_setting | Bool | N | N | N | N/A |
| user_access | [struct] | N | N | N | N/A |
ad_auth_service : Active Directory Authentication Service object.