GET /systemconfiguration
/systemconfiguration
object name
Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=
Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=
List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
Default values are not set.
It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Avi Tenant Header
Avi Tenant Header UUID
The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.
Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.
OK
{
"_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
}UNIX time since epoch in microseconds. Units(MICROSECONDS).
admin_auth_configuration
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
controller_analytics_policy
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
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.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
email_configuration
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.
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
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.
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
mgmt_ip_access_control
ntp_configuration
portal_configuration
proxy_configuration
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.
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
snmp_configuration
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.
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.
url
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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.
log in failed
curl -H 'Authorization: <value>' https://{api_host}/api/systemconfiguration