Avi SystemConfiguration Object API

CLI ``` - configure systemconfiguration - show systemconfiguration - test systememail ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 21.1.6
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /systemconfiguration
  2. patch /systemconfiguration
  3. put /systemconfiguration
  4. post /systemconfiguration/systestemail
Up 
get /systemconfiguration
(systemconfigurationGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — 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.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

SystemConfiguration

Example data

Content-Type: application/json
{
  "admin_auth_configuration" : {
    "mapping_rules" : [ "" ],
    "allow_local_user_login" : true,
    "auth_profile_ref" : "aeiou",
    "alternate_auth_configurations" : [ {
      "mapping_rules" : [ {
        "role_attribute_name" : "aeiou",
        "userprofile_ref" : "aeiou",
        "assign_role" : "aeiou",
        "is_superuser" : true,
        "assign_tenant" : "aeiou",
        "assign_userprofile" : "aeiou",
        "index" : 123,
        "object_access_policy_refs" : [ "aeiou" ],
        "policy_attribute_name" : "aeiou",
        "role_refs" : [ "aeiou" ],
        "tenant_refs" : [ "aeiou" ],
        "assign_policy" : "aeiou",
        "attribute_match" : {
          "criteria" : "aeiou",
          "values" : [ "aeiou" ],
          "name" : "aeiou"
        },
        "group_match" : {
          "criteria" : "aeiou",
          "groups" : [ "aeiou" ]
        },
        "userprofile_attribute_name" : "aeiou",
        "tenant_attribute_name" : "aeiou"
      } ],
      "auth_profile_ref" : "aeiou",
      "index" : 123
    } ]
  },
  "ssh_hmacs" : [ "aeiou" ],
  "email_configuration" : {
    "mail_server_name" : "aeiou",
    "from_email" : "aeiou",
    "smtp_type" : "aeiou",
    "mail_server_port" : 123,
    "auth_username" : "aeiou",
    "auth_password" : "aeiou",
    "disable_tls" : true,
    "email_timezone" : "aeiou",
    "from_name" : "aeiou"
  },
  "global_tenant_config" : {
    "tenant_access_to_provider_se" : true,
    "se_in_provider_context" : true,
    "tenant_vrf" : true
  },
  "uuid" : "aeiou",
  "_last_modified" : "aeiou",
  "common_criteria_mode" : true,
  "secure_channel_configuration" : {
    "sslkeyandcertificate_refs" : [ "aeiou" ],
    "bypass_secure_channel_must_checks" : true
  },
  "linux_configuration" : {
    "motd" : "aeiou",
    "cis_mode" : true,
    "banner" : "aeiou"
  },
  "snmp_configuration" : {
    "snmp_v3_config" : {
      "engine_id" : "aeiou",
      "user" : {
        "auth_type" : "aeiou",
        "auth_passphrase" : "aeiou",
        "priv_passphrase" : "aeiou",
        "priv_type" : "aeiou",
        "username" : "aeiou"
      }
    },
    "sys_contact" : "aeiou",
    "large_trap_payload" : true,
    "community" : "aeiou",
    "version" : "aeiou",
    "sys_location" : "aeiou"
  },
  "mgmt_ip_access_control" : {
    "ssh_access" : "",
    "sysint_access" : "",
    "shell_server_access" : "",
    "snmp_access" : "",
    "api_access" : {
      "group_refs" : [ "aeiou" ],
      "match_criteria" : "aeiou",
      "prefixes" : [ {
        "ip_addr" : "",
        "mask" : 123
      } ],
      "ranges" : [ {
        "end" : "",
        "begin" : ""
      } ],
      "addrs" : [ "" ]
    }
  },
  "portal_configuration" : {
    "disable_remote_cli_shell" : true,
    "disable_swagger" : true,
    "sslkeyandcertificate_refs" : [ "aeiou" ],
    "password_strength_check" : true,
    "enable_https" : true,
    "http_port" : 123,
    "use_uuid_from_input" : true,
    "https_port" : 123,
    "enable_http" : true,
    "enable_clickjacking_protection" : true,
    "redirect_to_https" : true,
    "api_force_timeout" : 123,
    "sslprofile_ref" : "aeiou",
    "allow_basic_authentication" : true,
    "minimum_password_length" : 123
  },
  "configpb_attributes" : {
    "version" : 123
  },
  "proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "welcome_workflow_complete" : true,
  "enable_cors" : true,
  "docker_mode" : true,
  "url" : "aeiou",
  "ntp_configuration" : {
    "ntp_servers" : [ {
      "key_number" : 123,
      "server" : ""
    } ],
    "ntp_authentication_keys" : [ {
      "key_number" : 123,
      "key" : "aeiou",
      "algorithm" : "aeiou"
    } ],
    "ntp_server_list" : [ "" ]
  },
  "ssh_ciphers" : [ "aeiou" ],
  "fips_mode" : true,
  "dns_configuration" : {
    "search_domain" : "aeiou",
    "server_list" : [ {
      "addr" : "aeiou",
      "type" : "aeiou"
    } ]
  },
  "default_license_tier" : "aeiou",
  "dns_virtualservice_refs" : [ "aeiou" ],
  "controller_analytics_policy" : {
    "metrics_event_thresholds" : [ {
      "reset_threshold" : 1.3579000000000001069366817318950779736042022705078125,
      "watermark_thresholds" : [ "" ],
      "metrics_event_threshold_type" : "aeiou"
    } ]
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SystemConfiguration

401

log in failed
Up 
patch /systemconfiguration
(systemconfigurationPatch)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — SystemConfiguration object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

SystemConfiguration

Example data

Content-Type: application/json
{
  "admin_auth_configuration" : {
    "mapping_rules" : [ "" ],
    "allow_local_user_login" : true,
    "auth_profile_ref" : "aeiou",
    "alternate_auth_configurations" : [ {
      "mapping_rules" : [ {
        "role_attribute_name" : "aeiou",
        "userprofile_ref" : "aeiou",
        "assign_role" : "aeiou",
        "is_superuser" : true,
        "assign_tenant" : "aeiou",
        "assign_userprofile" : "aeiou",
        "index" : 123,
        "object_access_policy_refs" : [ "aeiou" ],
        "policy_attribute_name" : "aeiou",
        "role_refs" : [ "aeiou" ],
        "tenant_refs" : [ "aeiou" ],
        "assign_policy" : "aeiou",
        "attribute_match" : {
          "criteria" : "aeiou",
          "values" : [ "aeiou" ],
          "name" : "aeiou"
        },
        "group_match" : {
          "criteria" : "aeiou",
          "groups" : [ "aeiou" ]
        },
        "userprofile_attribute_name" : "aeiou",
        "tenant_attribute_name" : "aeiou"
      } ],
      "auth_profile_ref" : "aeiou",
      "index" : 123
    } ]
  },
  "ssh_hmacs" : [ "aeiou" ],
  "email_configuration" : {
    "mail_server_name" : "aeiou",
    "from_email" : "aeiou",
    "smtp_type" : "aeiou",
    "mail_server_port" : 123,
    "auth_username" : "aeiou",
    "auth_password" : "aeiou",
    "disable_tls" : true,
    "email_timezone" : "aeiou",
    "from_name" : "aeiou"
  },
  "global_tenant_config" : {
    "tenant_access_to_provider_se" : true,
    "se_in_provider_context" : true,
    "tenant_vrf" : true
  },
  "uuid" : "aeiou",
  "_last_modified" : "aeiou",
  "common_criteria_mode" : true,
  "secure_channel_configuration" : {
    "sslkeyandcertificate_refs" : [ "aeiou" ],
    "bypass_secure_channel_must_checks" : true
  },
  "linux_configuration" : {
    "motd" : "aeiou",
    "cis_mode" : true,
    "banner" : "aeiou"
  },
  "snmp_configuration" : {
    "snmp_v3_config" : {
      "engine_id" : "aeiou",
      "user" : {
        "auth_type" : "aeiou",
        "auth_passphrase" : "aeiou",
        "priv_passphrase" : "aeiou",
        "priv_type" : "aeiou",
        "username" : "aeiou"
      }
    },
    "sys_contact" : "aeiou",
    "large_trap_payload" : true,
    "community" : "aeiou",
    "version" : "aeiou",
    "sys_location" : "aeiou"
  },
  "mgmt_ip_access_control" : {
    "ssh_access" : "",
    "sysint_access" : "",
    "shell_server_access" : "",
    "snmp_access" : "",
    "api_access" : {
      "group_refs" : [ "aeiou" ],
      "match_criteria" : "aeiou",
      "prefixes" : [ {
        "ip_addr" : "",
        "mask" : 123
      } ],
      "ranges" : [ {
        "end" : "",
        "begin" : ""
      } ],
      "addrs" : [ "" ]
    }
  },
  "portal_configuration" : {
    "disable_remote_cli_shell" : true,
    "disable_swagger" : true,
    "sslkeyandcertificate_refs" : [ "aeiou" ],
    "password_strength_check" : true,
    "enable_https" : true,
    "http_port" : 123,
    "use_uuid_from_input" : true,
    "https_port" : 123,
    "enable_http" : true,
    "enable_clickjacking_protection" : true,
    "redirect_to_https" : true,
    "api_force_timeout" : 123,
    "sslprofile_ref" : "aeiou",
    "allow_basic_authentication" : true,
    "minimum_password_length" : 123
  },
  "configpb_attributes" : {
    "version" : 123
  },
  "proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "welcome_workflow_complete" : true,
  "enable_cors" : true,
  "docker_mode" : true,
  "url" : "aeiou",
  "ntp_configuration" : {
    "ntp_servers" : [ {
      "key_number" : 123,
      "server" : ""
    } ],
    "ntp_authentication_keys" : [ {
      "key_number" : 123,
      "key" : "aeiou",
      "algorithm" : "aeiou"
    } ],
    "ntp_server_list" : [ "" ]
  },
  "ssh_ciphers" : [ "aeiou" ],
  "fips_mode" : true,
  "dns_configuration" : {
    "search_domain" : "aeiou",
    "server_list" : [ {
      "addr" : "aeiou",
      "type" : "aeiou"
    } ]
  },
  "default_license_tier" : "aeiou",
  "dns_virtualservice_refs" : [ "aeiou" ],
  "controller_analytics_policy" : {
    "metrics_event_thresholds" : [ {
      "reset_threshold" : 1.3579000000000001069366817318950779736042022705078125,
      "watermark_thresholds" : [ "" ],
      "metrics_event_threshold_type" : "aeiou"
    } ]
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SystemConfiguration

401

log in failed
Up 
put /systemconfiguration
(systemconfigurationPut)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — SystemConfiguration object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

SystemConfiguration

Example data

Content-Type: application/json
{
  "admin_auth_configuration" : {
    "mapping_rules" : [ "" ],
    "allow_local_user_login" : true,
    "auth_profile_ref" : "aeiou",
    "alternate_auth_configurations" : [ {
      "mapping_rules" : [ {
        "role_attribute_name" : "aeiou",
        "userprofile_ref" : "aeiou",
        "assign_role" : "aeiou",
        "is_superuser" : true,
        "assign_tenant" : "aeiou",
        "assign_userprofile" : "aeiou",
        "index" : 123,
        "object_access_policy_refs" : [ "aeiou" ],
        "policy_attribute_name" : "aeiou",
        "role_refs" : [ "aeiou" ],
        "tenant_refs" : [ "aeiou" ],
        "assign_policy" : "aeiou",
        "attribute_match" : {
          "criteria" : "aeiou",
          "values" : [ "aeiou" ],
          "name" : "aeiou"
        },
        "group_match" : {
          "criteria" : "aeiou",
          "groups" : [ "aeiou" ]
        },
        "userprofile_attribute_name" : "aeiou",
        "tenant_attribute_name" : "aeiou"
      } ],
      "auth_profile_ref" : "aeiou",
      "index" : 123
    } ]
  },
  "ssh_hmacs" : [ "aeiou" ],
  "email_configuration" : {
    "mail_server_name" : "aeiou",
    "from_email" : "aeiou",
    "smtp_type" : "aeiou",
    "mail_server_port" : 123,
    "auth_username" : "aeiou",
    "auth_password" : "aeiou",
    "disable_tls" : true,
    "email_timezone" : "aeiou",
    "from_name" : "aeiou"
  },
  "global_tenant_config" : {
    "tenant_access_to_provider_se" : true,
    "se_in_provider_context" : true,
    "tenant_vrf" : true
  },
  "uuid" : "aeiou",
  "_last_modified" : "aeiou",
  "common_criteria_mode" : true,
  "secure_channel_configuration" : {
    "sslkeyandcertificate_refs" : [ "aeiou" ],
    "bypass_secure_channel_must_checks" : true
  },
  "linux_configuration" : {
    "motd" : "aeiou",
    "cis_mode" : true,
    "banner" : "aeiou"
  },
  "snmp_configuration" : {
    "snmp_v3_config" : {
      "engine_id" : "aeiou",
      "user" : {
        "auth_type" : "aeiou",
        "auth_passphrase" : "aeiou",
        "priv_passphrase" : "aeiou",
        "priv_type" : "aeiou",
        "username" : "aeiou"
      }
    },
    "sys_contact" : "aeiou",
    "large_trap_payload" : true,
    "community" : "aeiou",
    "version" : "aeiou",
    "sys_location" : "aeiou"
  },
  "mgmt_ip_access_control" : {
    "ssh_access" : "",
    "sysint_access" : "",
    "shell_server_access" : "",
    "snmp_access" : "",
    "api_access" : {
      "group_refs" : [ "aeiou" ],
      "match_criteria" : "aeiou",
      "prefixes" : [ {
        "ip_addr" : "",
        "mask" : 123
      } ],
      "ranges" : [ {
        "end" : "",
        "begin" : ""
      } ],
      "addrs" : [ "" ]
    }
  },
  "portal_configuration" : {
    "disable_remote_cli_shell" : true,
    "disable_swagger" : true,
    "sslkeyandcertificate_refs" : [ "aeiou" ],
    "password_strength_check" : true,
    "enable_https" : true,
    "http_port" : 123,
    "use_uuid_from_input" : true,
    "https_port" : 123,
    "enable_http" : true,
    "enable_clickjacking_protection" : true,
    "redirect_to_https" : true,
    "api_force_timeout" : 123,
    "sslprofile_ref" : "aeiou",
    "allow_basic_authentication" : true,
    "minimum_password_length" : 123
  },
  "configpb_attributes" : {
    "version" : 123
  },
  "proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "welcome_workflow_complete" : true,
  "enable_cors" : true,
  "docker_mode" : true,
  "url" : "aeiou",
  "ntp_configuration" : {
    "ntp_servers" : [ {
      "key_number" : 123,
      "server" : ""
    } ],
    "ntp_authentication_keys" : [ {
      "key_number" : 123,
      "key" : "aeiou",
      "algorithm" : "aeiou"
    } ],
    "ntp_server_list" : [ "" ]
  },
  "ssh_ciphers" : [ "aeiou" ],
  "fips_mode" : true,
  "dns_configuration" : {
    "search_domain" : "aeiou",
    "server_list" : [ {
      "addr" : "aeiou",
      "type" : "aeiou"
    } ]
  },
  "default_license_tier" : "aeiou",
  "dns_virtualservice_refs" : [ "aeiou" ],
  "controller_analytics_policy" : {
    "metrics_event_thresholds" : [ {
      "reset_threshold" : 1.3579000000000001069366817318950779736042022705078125,
      "watermark_thresholds" : [ "" ],
      "metrics_event_threshold_type" : "aeiou"
    } ]
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SystemConfiguration

401

log in failed
Up 
post /systemconfiguration/systestemail
(systemconfigurationSystestemailPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — SysTestEmailParams

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

401

log in failed
Up

Models

[ Jump to Methods ]

Table of Contents

  1. AdminAuthConfiguration
  2. AlternateAuthConfiguration
  3. AuthMappingRule
  4. AuthMatchAttribute
  5. AuthMatchGroupMembership
  6. ConfigPbAttributes
  7. ControllerAnalyticsPolicy
  8. DNSConfiguration
  9. EmailConfiguration
  10. IpAddr
  11. IpAddrMatch
  12. IpAddrPrefix
  13. IpAddrRange
  14. LinuxConfiguration
  15. MetricsEventThreshold
  16. MgmtIpAccessControl
  17. NTPAuthenticationKey
  18. NTPConfiguration
  19. NTPServer
  20. PortalConfiguration
  21. ProxyConfiguration
  22. SecureChannelConfiguration
  23. SnmpConfiguration
  24. SnmpV3Configuration
  25. SnmpV3UserParams
  26. SysTestEmailParams
  27. SystemConfiguration
  28. SystemConfigurationApiResponse
  29. TenantConfiguration

AdminAuthConfiguration Up

allow_local_user_login (optional)
Boolean Allow any user created locally to login with local credentials. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
alternate_auth_configurations (optional)
array[AlternateAuthConfiguration] Secondary authentication mechanisms to be used. Field introduced in 20.1.6. Maximum of 1 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
auth_profile_ref (optional)
String It is a reference to an object of type AuthProfile. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mapping_rules (optional)
array[AuthMappingRule] Rules list for tenant or role mapping. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

AlternateAuthConfiguration Up

auth_profile_ref (optional)
String UUID of the authprofile. It is a reference to an object of type AuthProfile. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
index
Integer index used for maintaining order of AlternateAuthConfiguration. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
mapping_rules (optional)
array[AuthMappingRule] Rules list for tenant or role mapping. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

AuthMappingRule Up

assign_policy (optional)
String Assignment rule for the Object Access Policy. Enum options - ASSIGN_ALL, ASSIGN_FROM_SELECT_LIST, ASSIGN_MATCHING_GROUP_NAME, ASSIGN_MATCHING_ATTRIBUTE_VALUE, ASSIGN_MATCHING_GROUP_REGEX, ASSIGN_MATCHING_ATTRIBUTE_REGEX. Field introduced in 18.2.7, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
assign_role (optional)
String Enum options - ASSIGN_ALL, ASSIGN_FROM_SELECT_LIST, ASSIGN_MATCHING_GROUP_NAME, ASSIGN_MATCHING_ATTRIBUTE_VALUE, ASSIGN_MATCHING_GROUP_REGEX, ASSIGN_MATCHING_ATTRIBUTE_REGEX. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
assign_tenant (optional)
String Enum options - ASSIGN_ALL, ASSIGN_FROM_SELECT_LIST, ASSIGN_MATCHING_GROUP_NAME, ASSIGN_MATCHING_ATTRIBUTE_VALUE, ASSIGN_MATCHING_GROUP_REGEX, ASSIGN_MATCHING_ATTRIBUTE_REGEX. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
assign_userprofile (optional)
String Assignment rule for the User Account Profile. Enum options - ASSIGN_ALL, ASSIGN_FROM_SELECT_LIST, ASSIGN_MATCHING_GROUP_NAME, ASSIGN_MATCHING_ATTRIBUTE_VALUE, ASSIGN_MATCHING_GROUP_REGEX, ASSIGN_MATCHING_ATTRIBUTE_REGEX. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
attribute_match (optional)
AuthMatchAttribute Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
group_match (optional)
AuthMatchGroupMembership Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
index
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
is_superuser (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
object_access_policy_refs (optional)
array[String] Object Access Policies to assign to user on successful match. It is a reference to an object of type ObjectAccessPolicy. Field deprecated in 20.1.2. Field introduced in 18.2.7, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
policy_attribute_name (optional)
String Attribute name for Object Access Policy assignment. Field introduced in 18.2.7, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
role_attribute_name (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
role_refs (optional)
array[String] It is a reference to an object of type Role. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_attribute_name (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_refs (optional)
array[String] It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
userprofile_attribute_name (optional)
String Attribute name for User Account Profile assignment. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
userprofile_ref (optional)
String User Account Profile to assign to user on successful match. It is a reference to an object of type UserAccountProfile. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

AuthMatchAttribute Up

criteria
String rule match criteria. Enum options - AUTH_MATCH_CONTAINS, AUTH_MATCH_DOES_NOT_CONTAIN, AUTH_MATCH_REGEX. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
name (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
values (optional)
array[String] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

AuthMatchGroupMembership Up

criteria
String rule match criteria. Enum options - AUTH_MATCH_CONTAINS, AUTH_MATCH_DOES_NOT_CONTAIN, AUTH_MATCH_REGEX. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
groups (optional)
array[String] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ConfigPbAttributes Up

version (optional)
Integer Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. format: int32

ControllerAnalyticsPolicy Up

metrics_event_thresholds (optional)
array[MetricsEventThreshold] Thresholds for various events generated by metrics system. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

DNSConfiguration Up

search_domain (optional)
String Search domain to use in DNS lookup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server_list (optional)
array[IpAddr] List of DNS Server IP addresses. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

EmailConfiguration Up

auth_password (optional)
String Password for mail server. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
auth_username (optional)
String Username for mail server. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
disable_tls (optional)
Boolean When set, disables TLS on the connection to the mail server. Field introduced in 17.2.12, 18.1.3, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
email_timezone (optional)
String Timezone for timestamps in alert emails. Enum options - UTC, AFRICA_ABIDJAN, AFRICA_ACCRA, AFRICA_ADDIS_ABABA, AFRICA_ALGIERS, AFRICA_ASMARA, AFRICA_ASMERA, AFRICA_BAMAKO, AFRICA_BANGUI, AFRICA_BANJUL, AFRICA_BISSAU, AFRICA_BLANTYRE, AFRICA_BRAZZAVILLE, AFRICA_BUJUMBURA, AFRICA_CAIRO, AFRICA_CASABLANCA, AFRICA_CEUTA, AFRICA_CONAKRY, AFRICA_DAKAR, AFRICA_DAR_ES_SALAAM, AFRICA_DJIBOUTI, AFRICA_DOUALA, AFRICA_EL_AAIUN, AFRICA_FREETOWN, AFRICA_GABORONE, AFRICA_HARARE, AFRICA_JOHANNESBURG, AFRICA_JUBA, AFRICA_KAMPALA, AFRICA_KHARTOUM, AFRICA_KIGALI, AFRICA_KINSHASA, AFRICA_LAGOS, AFRICA_LIBREVILLE, AFRICA_LOME, AFRICA_LUANDA, AFRICA_LUBUMBASHI, AFRICA_LUSAKA, AFRICA_MALABO, AFRICA_MAPUTO, AFRICA_MASERU, AFRICA_MBABANE, AFRICA_MOGADISHU, AFRICA_MONROVIA, AFRICA_NAIROBI, AFRICA_NDJAMENA, AFRICA_NIAMEY, AFRICA_NOUAKCHOTT, AFRICA_OUAGADOUGOU, AFRICA_PORTO_MINUS_NOVO, AFRICA_SAO_TOME, AFRICA_TIMBUKTU, AFRICA_TRIPOLI, AFRICA_TUNIS, AFRICA_WINDHOEK, AMERICA_ADAK, AMERICA_ANCHORAGE, AMERICA_ANGUILLA, AMERICA_ANTIGUA, AMERICA_ARAGUAINA, AMERICA_ARGENTINA_BUENOS_AIRES, AMERICA_ARGENTINA_CATAMARCA, AMERICA_ARGENTINA_COMODRIVADAVIA, AMERICA_ARGENTINA_CORDOBA, AMERICA_ARGENTINA_JUJUY, AMERICA_ARGENTINA_LA_RIOJA, AMERICA_ARGENTINA_MENDOZA, AMERICA_ARGENTINA_RIO_GALLEGOS, AMERICA_ARGENTINA_SALTA, AMERICA_ARGENTINA_SAN_JUAN, AMERICA_ARGENTINA_SAN_LUIS, AMERICA_ARGENTINA_TUCUMAN, AMERICA_ARGENTINA_USHUAIA, AMERICA_ARUBA, AMERICA_ASUNCION, AMERICA_ATIKOKAN, AMERICA_ATKA, AMERICA_BAHIA, AMERICA_BAHIA_BANDERAS, AMERICA_BARBADOS, AMERICA_BELEM, AMERICA_BELIZE, AMERICA_BLANC_MINUS_SABLON, AMERICA_BOA_VISTA, AMERICA_BOGOTA, AMERICA_BOISE, AMERICA_BUENOS_AIRES, AMERICA_CAMBRIDGE_BAY, AMERICA_CAMPO_GRANDE, AMERICA_CANCUN, AMERICA_CARACAS, AMERICA_CATAMARCA, AMERICA_CAYENNE, AMERICA_CAYMAN, AMERICA_CHICAGO, AMERICA_CHIHUAHUA, AMERICA_CORAL_HARBOUR, AMERICA_CORDOBA, AMERICA_COSTA_RICA, AMERICA_CRESTON, AMERICA_CUIABA, AMERICA_CURACAO, AMERICA_DANMARKSHAVN, AMERICA_DAWSON, AMERICA_DAWSON_CREEK, AMERICA_DENVER, AMERICA_DETROIT, AMERICA_DOMINICA, AMERICA_EDMONTON, AMERICA_EIRUNEPE, AMERICA_EL_SALVADOR, AMERICA_ENSENADA, AMERICA_FORT_NELSON, AMERICA_FORT_WAYNE, AMERICA_FORTALEZA, AMERICA_GLACE_BAY, AMERICA_GODTHAB, AMERICA_GOOSE_BAY, AMERICA_GRAND_TURK, AMERICA_GRENADA, AMERICA_GUADELOUPE, AMERICA_GUATEMALA, AMERICA_GUAYAQUIL, AMERICA_GUYANA, AMERICA_HALIFAX, AMERICA_HAVANA, AMERICA_HERMOSILLO, AMERICA_INDIANA_INDIANAPOLIS, AMERICA_INDIANA_KNOX, AMERICA_INDIANA_MARENGO, AMERICA_INDIANA_PETERSBURG, AMERICA_INDIANA_TELL_CITY, AMERICA_INDIANA_VEVAY, AMERICA_INDIANA_VINCENNES, AMERICA_INDIANA_WINAMAC, AMERICA_INDIANAPOLIS, AMERICA_INUVIK, AMERICA_IQALUIT, AMERICA_JAMAICA, AMERICA_JUJUY, AMERICA_JUNEAU, AMERICA_KENTUCKY_LOUISVILLE, AMERICA_KENTUCKY_MONTICELLO, AMERICA_KNOX_IN, AMERICA_KRALENDIJK, AMERICA_LA_PAZ, AMERICA_LIMA, AMERICA_LOS_ANGELES, AMERICA_LOUISVILLE, AMERICA_LOWER_PRINCES, AMERICA_MACEIO, AMERICA_MANAGUA, AMERICA_MANAUS, AMERICA_MARIGOT, AMERICA_MARTINIQUE, AMERICA_MATAMOROS, AMERICA_MAZATLAN, AMERICA_MENDOZA, AMERICA_MENOMINEE, AMERICA_MERIDA, AMERICA_METLAKATLA, AMERICA_MEXICO_CITY, AMERICA_MIQUELON, AMERICA_MONCTON, AMERICA_MONTERREY, AMERICA_MONTEVIDEO, AMERICA_MONTREAL, AMERICA_MONTSERRAT, AMERICA_NASSAU, AMERICA_NEW_YORK, AMERICA_NIPIGON, AMERICA_NOME, AMERICA_NORONHA, AMERICA_NORTH_DAKOTA_BEULAH, AMERICA_NORTH_DAKOTA_CENTER, AMERICA_NORTH_DAKOTA_NEW_SALEM, AMERICA_OJINAGA, AMERICA_PANAMA, AMERICA_PANGNIRTUNG, AMERICA_PARAMARIBO, AMERICA_PHOENIX, AMERICA_PORT_MINUS_AU_MINUS_PRINCE, AMERICA_PORT_OF_SPAIN, AMERICA_PORTO_ACRE, AMERICA_PORTO_VELHO, AMERICA_PUERTO_RICO, AMERICA_PUNTA_ARENAS, AMERICA_RAINY_RIVER, AMERICA_RANKIN_INLET, AMERICA_RECIFE, AMERICA_REGINA, AMERICA_RESOLUTE, AMERICA_RIO_BRANCO, AMERICA_ROSARIO, AMERICA_SANTA_ISABEL, AMERICA_SANTAREM, AMERICA_SANTIAGO, AMERICA_SANTO_DOMINGO, AMERICA_SAO_PAULO, AMERICA_SCORESBYSUND, AMERICA_SHIPROCK, AMERICA_SITKA, AMERICA_ST_BARTHELEMY, AMERICA_ST_JOHNS, AMERICA_ST_KITTS, AMERICA_ST_LUCIA, AMERICA_ST_THOMAS, AMERICA_ST_VINCENT, AMERICA_SWIFT_CURRENT, AMERICA_TEGUCIGALPA, AMERICA_THULE, AMERICA_THUNDER_BAY, AMERICA_TIJUANA, AMERICA_TORONTO, AMERICA_TORTOLA, AMERICA_VANCOUVER, AMERICA_VIRGIN, AMERICA_WHITEHORSE, AMERICA_WINNIPEG, AMERICA_YAKUTAT, AMERICA_YELLOWKNIFE, ANTARCTICA_CASEY, ANTARCTICA_DAVIS, ANTARCTICA_DUMONTDURVILLE, ANTARCTICA_MACQUARIE, ANTARCTICA_MAWSON, ANTARCTICA_MCMURDO, ANTARCTICA_PALMER, ANTARCTICA_ROTHERA, ANTARCTICA_SOUTH_POLE, ANTARCTICA_SYOWA, ANTARCTICA_TROLL, ANTARCTICA_VOSTOK, ARCTIC_LONGYEARBYEN, ASIA_ADEN, ASIA_ALMATY, ASIA_AMMAN, ASIA_ANADYR, ASIA_AQTAU, ASIA_AQTOBE, ASIA_ASHGABAT, ASIA_ASHKHABAD, ASIA_ATYRAU, ASIA_BAGHDAD, ASIA_BAHRAIN, ASIA_BAKU, ASIA_BANGKOK, ASIA_BARNAUL, ASIA_BEIRUT, ASIA_BISHKEK, ASIA_BRUNEI, ASIA_CALCUTTA, ASIA_CHITA, ASIA_CHOIBALSAN, ASIA_CHONGQING, ASIA_CHUNGKING, ASIA_COLOMBO, ASIA_DACCA, ASIA_DAMASCUS, ASIA_DHAKA, ASIA_DILI, ASIA_DUBAI, ASIA_DUSHANBE, ASIA_FAMAGUSTA, ASIA_GAZA, ASIA_HARBIN, ASIA_HEBRON, ASIA_HO_CHI_MINH, ASIA_HONG_KONG, ASIA_HOVD, ASIA_IRKUTSK, ASIA_ISTANBUL, ASIA_JAKARTA, ASIA_JAYAPURA, ASIA_JERUSALEM, ASIA_KABUL, ASIA_KAMCHATKA, ASIA_KARACHI, ASIA_KASHGAR, ASIA_KATHMANDU, ASIA_KATMANDU, ASIA_KHANDYGA, ASIA_KOLKATA, ASIA_KRASNOYARSK, ASIA_KUALA_LUMPUR, ASIA_KUCHING, ASIA_KUWAIT, ASIA_MACAO, ASIA_MACAU, ASIA_MAGADAN, ASIA_MAKASSAR, ASIA_MANILA, ASIA_MUSCAT, ASIA_NICOSIA, ASIA_NOVOKUZNETSK, ASIA_NOVOSIBIRSK, ASIA_OMSK, ASIA_ORAL, ASIA_PHNOM_PENH, ASIA_PONTIANAK, ASIA_PYONGYANG, ASIA_QATAR, ASIA_QOSTANAY, ASIA_QYZYLORDA, ASIA_RANGOON, ASIA_RIYADH, ASIA_SAIGON, ASIA_SAKHALIN, ASIA_SAMARKAND, ASIA_SEOUL, ASIA_SHANGHAI, ASIA_SINGAPORE, ASIA_SREDNEKOLYMSK, ASIA_TAIPEI, ASIA_TASHKENT, ASIA_TBILISI, ASIA_TEHRAN, ASIA_TEL_AVIV, ASIA_THIMBU, ASIA_THIMPHU, ASIA_TOKYO, ASIA_TOMSK, ASIA_UJUNG_PANDANG, ASIA_ULAANBAATAR, ASIA_ULAN_BATOR, ASIA_URUMQI, ASIA_UST_MINUS_NERA, ASIA_VIENTIANE, ASIA_VLADIVOSTOK, ASIA_YAKUTSK, ASIA_YANGON, ASIA_YEKATERINBURG, ASIA_YEREVAN, ATLANTIC_AZORES, ATLANTIC_BERMUDA, ATLANTIC_CANARY, ATLANTIC_CAPE_VERDE, ATLANTIC_FAEROE, ATLANTIC_FAROE, ATLANTIC_JAN_MAYEN, ATLANTIC_MADEIRA, ATLANTIC_REYKJAVIK, ATLANTIC_SOUTH_GEORGIA, ATLANTIC_ST_HELENA, ATLANTIC_STANLEY, AUSTRALIA_ACT, AUSTRALIA_ADELAIDE, AUSTRALIA_BRISBANE, AUSTRALIA_BROKEN_HILL, AUSTRALIA_CANBERRA, AUSTRALIA_CURRIE, AUSTRALIA_DARWIN, AUSTRALIA_EUCLA, AUSTRALIA_HOBART, AUSTRALIA_LHI, AUSTRALIA_LINDEMAN, AUSTRALIA_LORD_HOWE, AUSTRALIA_MELBOURNE, AUSTRALIA_NSW, AUSTRALIA_NORTH, AUSTRALIA_PERTH, AUSTRALIA_QUEENSLAND, AUSTRALIA_SOUTH, AUSTRALIA_SYDNEY, AUSTRALIA_TASMANIA, AUSTRALIA_VICTORIA, AUSTRALIA_WEST, AUSTRALIA_YANCOWINNA, BRAZIL_ACRE, BRAZIL_DENORONHA, BRAZIL_EAST, BRAZIL_WEST, CET, CST6CDT, CANADA_ATLANTIC, CANADA_CENTRAL, CANADA_EASTERN, CANADA_MOUNTAIN, CANADA_NEWFOUNDLAND, CANADA_PACIFIC, CANADA_SASKATCHEWAN, CANADA_YUKON, CHILE_CONTINENTAL, CHILE_EASTERISLAND, CUBA, EET, EST, EST5EDT, EGYPT, EIRE, ETC_GMT, ETC_GMT_PLUS_0, ETC_GMT_PLUS_1, ETC_GMT_PLUS_10, ETC_GMT_PLUS_11, ETC_GMT_PLUS_12, ETC_GMT_PLUS_2, ETC_GMT_PLUS_3, ETC_GMT_PLUS_4, ETC_GMT_PLUS_5, ETC_GMT_PLUS_6, ETC_GMT_PLUS_7, ETC_GMT_PLUS_8, ETC_GMT_PLUS_9, ETC_GMT_MINUS_0, ETC_GMT_MINUS_1, ETC_GMT_MINUS_10, ETC_GMT_MINUS_11, ETC_GMT_MINUS_12, ETC_GMT_MINUS_13, ETC_GMT_MINUS_14, ETC_GMT_MINUS_2, ETC_GMT_MINUS_3, ETC_GMT_MINUS_4, ETC_GMT_MINUS_5, ETC_GMT_MINUS_6, ETC_GMT_MINUS_7, ETC_GMT_MINUS_8, ETC_GMT_MINUS_9, ETC_GMT0, ETC_GREENWICH, ETC_UCT, ETC_UTC, ETC_UNIVERSAL, ETC_ZULU, EUROPE_AMSTERDAM, EUROPE_ANDORRA, EUROPE_ASTRAKHAN, EUROPE_ATHENS, EUROPE_BELFAST, EUROPE_BELGRADE, EUROPE_BERLIN, EUROPE_BRATISLAVA, EUROPE_BRUSSELS, EUROPE_BUCHAREST, EUROPE_BUDAPEST, EUROPE_BUSINGEN, EUROPE_CHISINAU, EUROPE_COPENHAGEN, EUROPE_DUBLIN, EUROPE_GIBRALTAR, EUROPE_GUERNSEY, EUROPE_HELSINKI, EUROPE_ISLE_OF_MAN, EUROPE_ISTANBUL, EUROPE_JERSEY, EUROPE_KALININGRAD, EUROPE_KIEV, EUROPE_KIROV, EUROPE_LISBON, EUROPE_LJUBLJANA, EUROPE_LONDON, EUROPE_LUXEMBOURG, EUROPE_MADRID, EUROPE_MALTA, EUROPE_MARIEHAMN, EUROPE_MINSK, EUROPE_MONACO, EUROPE_MOSCOW, EUROPE_NICOSIA, EUROPE_OSLO, EUROPE_PARIS, EUROPE_PODGORICA, EUROPE_PRAGUE, EUROPE_RIGA, EUROPE_ROME, EUROPE_SAMARA, EUROPE_SAN_MARINO, EUROPE_SARAJEVO, EUROPE_SARATOV, EUROPE_SIMFEROPOL, EUROPE_SKOPJE, EUROPE_SOFIA, EUROPE_STOCKHOLM, EUROPE_TALLINN, EUROPE_TIRANE, EUROPE_TIRASPOL, EUROPE_ULYANOVSK, EUROPE_UZHGOROD, EUROPE_VADUZ, EUROPE_VATICAN, EUROPE_VIENNA, EUROPE_VILNIUS, EUROPE_VOLGOGRAD, EUROPE_WARSAW, EUROPE_ZAGREB, EUROPE_ZAPOROZHYE, EUROPE_ZURICH, GB_, GB_MINUS_EIRE, GMT, GMT_PLUS_0, GMT_MINUS_0, GMT0, GREENWICH, HST, HONGKONG, ICELAND, INDIAN_ANTANANARIVO, INDIAN_CHAGOS, INDIAN_CHRISTMAS, INDIAN_COCOS, INDIAN_COMORO, INDIAN_KERGUELEN, INDIAN_MAHE, INDIAN_MALDIVES, INDIAN_MAURITIUS, INDIAN_MAYOTTE, INDIAN_REUNION, IRAN, ISRAEL, JAMAICA, JAPAN, KWAJALEIN, LIBYA, MET, MST, MST7MDT, MEXICO_BAJANORTE, MEXICO_BAJASUR, MEXICO_GENERAL, NZ, NZ_MINUS_CHAT, NAVAJO, PRC, PST8PDT, PACIFIC_APIA, PACIFIC_AUCKLAND, PACIFIC_BOUGAINVILLE, PACIFIC_CHATHAM, PACIFIC_CHUUK, PACIFIC_EASTER, PACIFIC_EFATE, PACIFIC_ENDERBURY, PACIFIC_FAKAOFO, PACIFIC_FIJI, PACIFIC_FUNAFUTI, PACIFIC_GALAPAGOS, PACIFIC_GAMBIER, PACIFIC_GUADALCANAL, PACIFIC_GUAM, PACIFIC_HONOLULU, PACIFIC_JOHNSTON, PACIFIC_KIRITIMATI, PACIFIC_KOSRAE, PACIFIC_KWAJALEIN, PACIFIC_MAJURO, PACIFIC_MARQUESAS, PACIFIC_MIDWAY, PACIFIC_NAURU, PACIFIC_NIUE, PACIFIC_NORFOLK, PACIFIC_NOUMEA, PACIFIC_PAGO_PAGO, PACIFIC_PALAU, PACIFIC_PITCAIRN, PACIFIC_POHNPEI, PACIFIC_PONAPE, PACIFIC_PORT_MORESBY, PACIFIC_RAROTONGA, PACIFIC_SAIPAN, PACIFIC_SAMOA, PACIFIC_TAHITI, PACIFIC_TARAWA, PACIFIC_TONGATAPU, PACIFIC_TRUK, PACIFIC_WAKE, PACIFIC_WALLIS, PACIFIC_YAP, POLAND, PORTUGAL, ROC, ROK, SINGAPORE, TURKEY, UCT, US_ALASKA, US_ALEUTIAN, US_ARIZONA, US_CENTRAL, US_EAST_MINUS_INDIANA, US_EASTERN, US_HAWAII, US_INDIANA_MINUS_STARKE, US_MICHIGAN, US_MOUNTAIN, US_PACIFIC, US_SAMOA, UNIVERSAL, W_MINUS_SU, WET, ZULU. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
from_email (optional)
String Email address in From field. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
from_name (optional)
String Friendly name in From field. Field introduced in 21.1.4. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
mail_server_name (optional)
String Mail server host. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mail_server_port (optional)
Integer Mail server port. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
smtp_type
String Type of SMTP Mail Service. Enum options - SMTP_NONE, SMTP_LOCAL_HOST, SMTP_SERVER, SMTP_ANONYMOUS_SERVER. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

IpAddr Up

addr
String IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
type
String Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

IpAddrMatch Up

addrs (optional)
array[IpAddr] IP address(es). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
group_refs (optional)
array[String] UUID of IP address group(s). It is a reference to an object of type IpAddrGroup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
match_criteria
String Criterion to use for IP address matching the HTTP request. Enum options - IS_IN, IS_NOT_IN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
prefixes (optional)
array[IpAddrPrefix] IP address prefix(es). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ranges (optional)
array[IpAddrRange] IP address range(s). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

IpAddrPrefix Up

ip_addr
IpAddr Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mask
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

IpAddrRange Up

begin
IpAddr Starting IP address of the range. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
end
IpAddr Ending IP address of the range. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

LinuxConfiguration Up

banner (optional)
String Banner displayed before login to ssh, and UI. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
cis_mode (optional)
Boolean Enforce CIS benchmark recommendations for Avi Controller and Service Engines. The enforcement is as per CIS DIL 1.0.1 level 2, for applicable controls. Field introduced in 17.2.8. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
motd (optional)
String Message of the day, shown to users on login via the command line interface, web interface, or ssh. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

MetricsEventThreshold Up

metrics_event_threshold_type
String Type of the metrics event threshold. This value will decide which metric rule (or rules) use configured thresholds. Enum options - THRESHOLD_TYPE_STATIC, SE_CPU_THRESHOLD, SE_MEM_THRESHOLD, SE_DISK_THRESHOLD, CONTROLLER_CPU_THRESHOLD, CONTROLLER_MEM_THRESHOLD, CONTROLLER_DISK_THRESHOLD. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
reset_threshold (optional)
Double This value is used to reset the event state machine. Allowed values are 0-100. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: double
watermark_thresholds (optional)
array[Integer] Threshold value for which event in raised. There can be multiple thresholds defined.Health score degrades when the the target is higher than this threshold. Allowed values are 0-100. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

MgmtIpAccessControl Up

api_access (optional)
IpAddrMatch Configure IP addresses to access controller using API. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
shell_server_access (optional)
IpAddrMatch Configure IP addresses to access controller using CLI Shell. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
snmp_access (optional)
IpAddrMatch Configure IP addresses to access controller using SNMP. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ssh_access (optional)
IpAddrMatch Configure IP addresses to access controller using SSH. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
sysint_access (optional)
IpAddrMatch Configure IP addresses to access controller using sysint access. Field introduced in 18.1.3, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

NTPAuthenticationKey Up

algorithm (optional)
String Message Digest Algorithm used for NTP authentication. Default is NTP_AUTH_ALGORITHM_MD5. Enum options - NTP_AUTH_ALGORITHM_MD5, NTP_AUTH_ALGORITHM_SHA1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
key
String NTP Authentication key. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
key_number
Integer Key number to be assigned to the authentication-key. Allowed values are 1-65534. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

NTPConfiguration Up

ntp_authentication_keys (optional)
array[NTPAuthenticationKey] NTP Authentication keys. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ntp_server_list (optional)
array[IpAddr] List of NTP server hostnames or IP addresses. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ntp_servers (optional)
array[NTPServer] List of NTP Servers. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

NTPServer Up

key_number (optional)
Integer Key number from the list of trusted keys used to authenticate this server. Allowed values are 1-65534. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
server
IpAddr IP Address of the NTP Server. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

PortalConfiguration Up

allow_basic_authentication (optional)
Boolean Enable/Disable HTTP basic authentication. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
api_force_timeout (optional)
Integer Force API session timeout after the specified time (in hours). Allowed values are 1-24. Field introduced in 18.2.3. Unit is HOURS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
disable_remote_cli_shell (optional)
Boolean Disable Remote CLI Shell Client access. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
disable_swagger (optional)
Boolean Disable Swagger access. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
enable_clickjacking_protection (optional)
Boolean Enable/Disable Clickjacking protection. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
enable_http (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
enable_https (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
http_port (optional)
Integer HTTP port. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
https_port (optional)
Integer HTTPS port. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
minimum_password_length (optional)
Integer Minimum password length for user accounts. Allowed values are 6-32. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
password_strength_check (optional)
Boolean Strict checking of password strength for user accounts. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
redirect_to_https (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
sslkeyandcertificate_refs (optional)
array[String] Certificates for system portal. Maximum 2 allowed. Leave list empty to use system default certs. It is a reference to an object of type SSLKeyAndCertificate. Maximum of 2 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
sslprofile_ref (optional)
String It is a reference to an object of type SSLProfile. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
use_uuid_from_input (optional)
Boolean Use UUID in POST object data as UUID of the new object, instead of a generated UUID. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ProxyConfiguration Up

host
String Proxy hostname or IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
password (optional)
String Password for proxy. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
port
Integer Proxy port. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
username (optional)
String Username for proxy. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

SecureChannelConfiguration Up

bypass_secure_channel_must_checks (optional)
Boolean Boolean which allowed force update of secure channel certificate. Forced updating has been disallowed. Field deprecated in 18.2.8. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
sslkeyandcertificate_refs (optional)
array[String] Certificate for secure channel. Leave list empty to use system default certs. It is a reference to an object of type SSLKeyAndCertificate. Field introduced in 18.1.4, 18.2.1. Maximum of 1 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

SnmpConfiguration Up

community (optional)
String Community string for SNMP v2c. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
large_trap_payload (optional)
Boolean Support for 4096 bytes trap payload. Field introduced in 17.2.13,18.1.4,18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
snmp_v3_config (optional)
SnmpV3Configuration SNMP version 3 configuration. Field introduced in 17.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
sys_contact (optional)
String Sets the sysContact in system MIB. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
sys_location (optional)
String Sets the sysLocation in system MIB. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
version (optional)
String SNMP version support. V2 or V3. Enum options - SNMP_VER2, SNMP_VER3. Field introduced in 17.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

SnmpV3Configuration Up

engine_id (optional)
String Engine Id of the Avi Controller SNMP. Field introduced in 17.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
user (optional)
SnmpV3UserParams SNMP ver 3 user definition. Field introduced in 17.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

SnmpV3UserParams Up

auth_passphrase (optional)
String SNMP V3 authentication passphrase. Field introduced in 17.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
auth_type (optional)
String SNMP V3 user authentication type. Enum options - SNMP_V3_AUTH_MD5, SNMP_V3_AUTH_SHA, SNMP_V3_AUTH_SHA_224, SNMP_V3_AUTH_SHA_256, SNMP_V3_AUTH_SHA_384, SNMP_V3_AUTH_SHA_512. Field introduced in 17.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
priv_passphrase (optional)
String SNMP V3 privacy passphrase. Field introduced in 17.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
priv_type (optional)
String SNMP V3 privacy setting. Enum options - SNMP_V3_PRIV_DES, SNMP_V3_PRIV_AES. Field introduced in 17.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
username (optional)
String SNMP username to be used by SNMP clients for performing SNMP walk. Field introduced in 17.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

SysTestEmailParams Up

cc_emails (optional)
String Alerts are copied to the comma separated list of email recipients. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
subject
String The Subject line of the originating email from Avi Controller. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
text
String The email context. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
to_emails
String Alerts are sent to the comma separated list of email recipients. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

SystemConfiguration Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
admin_auth_configuration (optional)
AdminAuthConfiguration Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
common_criteria_mode (optional)
Boolean 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)
ConfigPbAttributes Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
controller_analytics_policy (optional)
ControllerAnalyticsPolicy Controller metrics event dynamic thresholds can be set here. CONTROLLER_CPU_HIGH and CONTROLLER_MEM_HIGH evets can take configured dynamic thresholds. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
default_license_tier (optional)
String 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)
DNSConfiguration Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dns_virtualservice_refs (optional)
array[String] 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.
docker_mode (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
email_configuration (optional)
EmailConfiguration Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
enable_cors (optional)
Boolean 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 (optional)
Boolean 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)
TenantConfiguration Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
linux_configuration (optional)
LinuxConfiguration Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mgmt_ip_access_control (optional)
MgmtIpAccessControl Configure Ip Access control for controller to restrict open access. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ntp_configuration (optional)
NTPConfiguration Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
portal_configuration (optional)
PortalConfiguration Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
proxy_configuration (optional)
ProxyConfiguration Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
secure_channel_configuration (optional)
SecureChannelConfiguration Configure Secure Channel properties. Field introduced in 18.1.4, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
snmp_configuration (optional)
SnmpConfiguration Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ssh_ciphers (optional)
array[String] 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.
ssh_hmacs (optional)
array[String] 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 (optional)
String url
uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
welcome_workflow_complete (optional)
Boolean 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.

SystemConfigurationApiResponse Up

count
Integer format: int32
results
array[SystemConfiguration]
next (optional)
String

TenantConfiguration Up

se_in_provider_context (optional)
Boolean Controls the ownership of ServiceEngines. Service Engines can either be exclusively owned by each tenant or owned by the administrator and shared by all tenants. When ServiceEngines are owned by the administrator, each tenant can have either read access or no access to their Service Engines. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_access_to_provider_se (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_vrf (optional)
Boolean When 'Per Tenant IP Domain' is selected, each tenant gets its own routing domain that is not shared with any other tenant. When 'Share IP Domain across all tenants' is selected, all tenants share the same routing domain. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.