SystemConfiguration

SystemConfiguration
SystemConfiguration
JSON Example
{
    "_last_modified": "string",
    "admin_auth_configuration": {
        "allow_local_user_login": false,
        "remote_auth_configurations": [
            {
                "auth_mapping_profile_ref": "string",
                "auth_profile_ref": "string",
                "index": 0
            }
        ],
        "service_auth_configurations": [
            {
                "index": 0,
                "service_auth_mapping_profile_ref": "string",
                "service_auth_profile_ref": "string"
            }
        ]
    },
    "common_criteria_mode": false,
    "configpb_attributes": {
        "version": 0
    },
    "controller_analytics_policy": {
        "metrics_event_thresholds": [
            {
                "metrics_event_threshold_type": "string",
                "reset_threshold": "number",
                "watermark_thresholds": [
                    0
                ]
            }
        ]
    },
    "default_license_tier": "string",
    "dns_configuration": {
        "search_domain": "string",
        "server_list": [
            {
                "addr": "string",
                "type": "string"
            }
        ]
    },
    "dns_virtualservice_refs": [
        "string"
    ],
    "docker_mode": false,
    "email_configuration": {
        "auth_password": "string",
        "auth_username": "string",
        "disable_tls": false,
        "email_timezone": "string",
        "from_email": "string",
        "from_name": "string",
        "mail_server_name": "string",
        "mail_server_port": 0,
        "smtp_type": "string"
    },
    "enable_cors": false,
    "fips_mode": false,
    "global_tenant_config": {
        "se_in_provider_context": false,
        "tenant_access_to_provider_se": false,
        "tenant_vrf": false
    },
    "host_key_algorithm_exclude": "string",
    "kex_algorithm_exclude": "string",
    "linux_configuration": {
        "banner": "string",
        "cis_mode": false,
        "motd": "string"
    },
    "mgmt_ip_access_control": {
        "api_access": {
            "addrs": [
                {
                    "addr": "string",
                    "type": "string"
                }
            ],
            "group_refs": [
                "string"
            ],
            "match_criteria": "string",
            "prefixes": [
                {
                    "ip_addr": {
                        "addr": "string",
                        "type": "string"
                    },
                    "mask": 0
                }
            ],
            "ranges": [
                {
                    "begin": {
                        "addr": "string",
                        "type": "string"
                    },
                    "end": {
                        "addr": "string",
                        "type": "string"
                    }
                }
            ]
        },
        "shell_server_access": {
            "addrs": [
                {
                    "addr": "string",
                    "type": "string"
                }
            ],
            "group_refs": [
                "string"
            ],
            "match_criteria": "string",
            "prefixes": [
                {
                    "ip_addr": {
                        "addr": "string",
                        "type": "string"
                    },
                    "mask": 0
                }
            ],
            "ranges": [
                {
                    "begin": {
                        "addr": "string",
                        "type": "string"
                    },
                    "end": {
                        "addr": "string",
                        "type": "string"
                    }
                }
            ]
        },
        "snmp_access": {
            "addrs": [
                {
                    "addr": "string",
                    "type": "string"
                }
            ],
            "group_refs": [
                "string"
            ],
            "match_criteria": "string",
            "prefixes": [
                {
                    "ip_addr": {
                        "addr": "string",
                        "type": "string"
                    },
                    "mask": 0
                }
            ],
            "ranges": [
                {
                    "begin": {
                        "addr": "string",
                        "type": "string"
                    },
                    "end": {
                        "addr": "string",
                        "type": "string"
                    }
                }
            ]
        },
        "ssh_access": {
            "addrs": [
                {
                    "addr": "string",
                    "type": "string"
                }
            ],
            "group_refs": [
                "string"
            ],
            "match_criteria": "string",
            "prefixes": [
                {
                    "ip_addr": {
                        "addr": "string",
                        "type": "string"
                    },
                    "mask": 0
                }
            ],
            "ranges": [
                {
                    "begin": {
                        "addr": "string",
                        "type": "string"
                    },
                    "end": {
                        "addr": "string",
                        "type": "string"
                    }
                }
            ]
        },
        "sysint_access": {
            "addrs": [
                {
                    "addr": "string",
                    "type": "string"
                }
            ],
            "group_refs": [
                "string"
            ],
            "match_criteria": "string",
            "prefixes": [
                {
                    "ip_addr": {
                        "addr": "string",
                        "type": "string"
                    },
                    "mask": 0
                }
            ],
            "ranges": [
                {
                    "begin": {
                        "addr": "string",
                        "type": "string"
                    },
                    "end": {
                        "addr": "string",
                        "type": "string"
                    }
                }
            ]
        }
    },
    "ntp_configuration": {
        "ntp_authentication_keys": [
            {
                "algorithm": "string",
                "key": "string",
                "key_number": 0
            }
        ],
        "ntp_server_list": [
            {
                "addr": "string",
                "type": "string"
            }
        ],
        "ntp_servers": [
            {
                "key_number": 0,
                "server": {
                    "addr": "string",
                    "type": "string"
                }
            }
        ]
    },
    "portal_configuration": {
        "allow_basic_authentication": false,
        "api_force_timeout": 0,
        "disable_remote_cli_shell": false,
        "disable_swagger": false,
        "enable_clickjacking_protection": false,
        "enable_http": false,
        "enable_https": false,
        "http_port": 0,
        "https_port": 0,
        "minimum_password_length": 0,
        "password_strength_check": false,
        "pkiprofile_ref": "string",
        "redirect_to_https": false,
        "sslkeyandcertificate_refs": [
            "string"
        ],
        "sslprofile_ref": "string",
        "use_uuid_from_input": false
    },
    "proxy_configuration": {
        "host": "string",
        "password": "string",
        "port": 0,
        "username": "string"
    },
    "rekey_time_limit": "string",
    "rekey_volume_limit": "string",
    "secure_channel_configuration": {
        "sslkeyandcertificate_refs": [
            "string"
        ]
    },
    "snmp_configuration": {
        "community": "string",
        "large_trap_payload": false,
        "snmp_v3_config": {
            "engine_id": "string",
            "user": {
                "auth_passphrase": "string",
                "auth_type": "string",
                "priv_passphrase": "string",
                "priv_type": "string",
                "username": "string"
            }
        },
        "sys_contact": "string",
        "sys_location": "string",
        "version": "string"
    },
    "ssh_ciphers": [
        "string"
    ],
    "ssh_hmacs": [
        "string"
    ],
    "url": "string",
    "uuid": "string",
    "welcome_workflow_complete": false
}
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

admin_auth_configuration
Optional

admin_auth_configuration

boolean
common_criteria_mode
Optional

Common criteria mode's current state. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

configpb_attributes
Optional

configpb_attributes

controller_analytics_policy
Optional

controller_analytics_policy

string
default_license_tier
Optional
Constraints: default: ENTERPRISE_WITH_CLOUD_SERVICES

Specifies the default license tier which would be used by new Clouds. Enum options - ENTERPRISE_16, ENTERPRISE, ENTERPRISE_18, BASIC, ESSENTIALS, ENTERPRISE_WITH_CLOUD_SERVICES. Field introduced in 17.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Special default for Essentials edition is ESSENTIALS, Basic edition is BASIC, Enterprise is ENTERPRISE_WITH_CLOUD_SERVICES.

dns_configuration
Optional

dns_configuration

array of string
dns_virtualservice_refs
Optional

DNS virtualservices hosting FQDN records for applications across Avi Vantage. If no virtualservices are provided, Avi Vantage will provide DNS services for configured applications. Switching back to Avi Vantage from DNS virtualservices is not allowed. It is a reference to an object of type VirtualService. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
docker_mode
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

email_configuration
Optional

email_configuration

boolean
enable_cors
Optional

Enable CORS Header. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

boolean
fips_mode
Optional

FIPS mode current state. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

global_tenant_config
Optional

global_tenant_config

string
host_key_algorithm_exclude
Optional

Users can specify comma separated list of deprecated host key algorithm.If nothing is specified, all known algorithms provided by OpenSSH will be supported.This change could only apply on the controller node. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
kex_algorithm_exclude
Optional

Users can specify comma separated list of deprecated key exchange algorithm.If nothing is specified, all known algorithms provided by OpenSSH will be supported.This change could only apply on the controller node. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

linux_configuration
Optional

linux_configuration

mgmt_ip_access_control
Optional

mgmt_ip_access_control

ntp_configuration
Optional

ntp_configuration

portal_configuration
Optional

portal_configuration

proxy_configuration
Optional

proxy_configuration

string
rekey_time_limit
Optional
Constraints: default: none

Users can specify and update the time limit of RekeyLimit in sshd_config.If nothing is specified, the default setting will be none. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
rekey_volume_limit
Optional
Constraints: default: default

Users can specify and update the size/volume limit of RekeyLimit in sshd_config.If nothing is specified, the default setting will be default. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

secure_channel_configuration
Optional

secure_channel_configuration

snmp_configuration
Optional

snmp_configuration

array of string
ssh_ciphers
Optional

Allowed Ciphers list for SSH to the management interface on the Controller and Service Engines. If this is not specified, all the default ciphers are allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of string
ssh_hmacs
Optional

Allowed HMAC list for SSH to the management interface on the Controller and Service Engines. If this is not specified, all the default HMACs are allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
welcome_workflow_complete
Optional

This flag is set once the Initial Controller Setup workflow is complete. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.