Avi SystemConfiguration Object API

CLI ``` - configure systemconfiguration - show systemconfiguration - test systememail ```

More information: https://avinetworks.com/contact-us

Contact Info: support@avinetworks.com

Version: 20.1.9

BasePath:/api

http://apache.org/licenses/LICENSE-2.0.html

Access

HTTP Basic Authentication

Methods

[ Jump to Models ]

get /systemconfiguration
patch /systemconfiguration
put /systemconfiguration
post /systemconfiguration/systestemail

get /systemconfiguration

(systemconfigurationGet)

Consumes

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

application/json

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" ],
  "enable_cors" : true,
  "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
  },
  "docker_mode" : true,
  "global_tenant_config" : {
    "tenant_access_to_provider_se" : true,
    "se_in_provider_context" : true,
    "tenant_vrf" : true
  },
  "uuid" : "aeiou",
  "url" : "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"
  },
  "ntp_configuration" : {
    "ntp_servers" : [ {
      "key_number" : 123,
      "server" : ""
    } ],
    "ntp_authentication_keys" : [ {
      "key_number" : 123,
      "key" : "aeiou",
      "algorithm" : "aeiou"
    } ],
    "ntp_server_list" : [ "" ]
  },
  "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" : [ "" ]
    }
  },
  "ssh_ciphers" : [ "aeiou" ],
  "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
  },
  "fips_mode" : true,
  "dns_configuration" : {
    "search_domain" : "aeiou",
    "server_list" : [ {
      "addr" : "aeiou",
      "type" : "aeiou"
    } ]
  },
  "proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "default_license_tier" : "aeiou",
  "welcome_workflow_complete" : true,
  "dns_virtualservice_refs" : [ "aeiou" ]
}

Produces

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

application/json

Responses

200

OK SystemConfiguration

401

patch /systemconfiguration

(systemconfigurationPatch)

Consumes

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

application/json

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" ],
  "enable_cors" : true,
  "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
  },
  "docker_mode" : true,
  "global_tenant_config" : {
    "tenant_access_to_provider_se" : true,
    "se_in_provider_context" : true,
    "tenant_vrf" : true
  },
  "uuid" : "aeiou",
  "url" : "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"
  },
  "ntp_configuration" : {
    "ntp_servers" : [ {
      "key_number" : 123,
      "server" : ""
    } ],
    "ntp_authentication_keys" : [ {
      "key_number" : 123,
      "key" : "aeiou",
      "algorithm" : "aeiou"
    } ],
    "ntp_server_list" : [ "" ]
  },
  "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" : [ "" ]
    }
  },
  "ssh_ciphers" : [ "aeiou" ],
  "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
  },
  "fips_mode" : true,
  "dns_configuration" : {
    "search_domain" : "aeiou",
    "server_list" : [ {
      "addr" : "aeiou",
      "type" : "aeiou"
    } ]
  },
  "proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "default_license_tier" : "aeiou",
  "welcome_workflow_complete" : true,
  "dns_virtualservice_refs" : [ "aeiou" ]
}

Produces

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

application/json

Responses

200

OK SystemConfiguration

401

put /systemconfiguration

(systemconfigurationPut)

Consumes

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

application/json

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" ],
  "enable_cors" : true,
  "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
  },
  "docker_mode" : true,
  "global_tenant_config" : {
    "tenant_access_to_provider_se" : true,
    "se_in_provider_context" : true,
    "tenant_vrf" : true
  },
  "uuid" : "aeiou",
  "url" : "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"
  },
  "ntp_configuration" : {
    "ntp_servers" : [ {
      "key_number" : 123,
      "server" : ""
    } ],
    "ntp_authentication_keys" : [ {
      "key_number" : 123,
      "key" : "aeiou",
      "algorithm" : "aeiou"
    } ],
    "ntp_server_list" : [ "" ]
  },
  "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" : [ "" ]
    }
  },
  "ssh_ciphers" : [ "aeiou" ],
  "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
  },
  "fips_mode" : true,
  "dns_configuration" : {
    "search_domain" : "aeiou",
    "server_list" : [ {
      "addr" : "aeiou",
      "type" : "aeiou"
    } ]
  },
  "proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "default_license_tier" : "aeiou",
  "welcome_workflow_complete" : true,
  "dns_virtualservice_refs" : [ "aeiou" ]
}

Produces

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

application/json

Responses

200

OK SystemConfiguration

401

post /systemconfiguration/systestemail

(systemconfigurationSystestemailPost)

Consumes

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

application/json

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 request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK String

401

Models

[ Jump to Methods ]

AdminAuthConfiguration
AlternateAuthConfiguration
AuthMappingRule
AuthMatchAttribute
AuthMatchGroupMembership
DNSConfiguration
EmailConfiguration
IpAddr
IpAddrMatch
IpAddrPrefix
IpAddrRange
LinuxConfiguration
MgmtIpAccessControl
NTPAuthenticationKey
NTPConfiguration
NTPServer
PortalConfiguration
ProxyConfiguration
SecureChannelConfiguration
SnmpConfiguration
SnmpV3Configuration
SnmpV3UserParams
SysTestEmailParams
SystemConfiguration
SystemConfigurationApiResponse
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.

alternate_auth_configurations (optional)

array[AlternateAuthConfiguration] Secondary authentication mechanisms to be used. Field introduced in 20.1.6. Maximum of 1 items allowed.

auth_profile_ref (optional)

String It is a reference to an object of type AuthProfile.

mapping_rules (optional)

array[AuthMappingRule] Rules list for tenant or role mapping.

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.

index

Integer index used for maintaining order of AlternateAuthConfiguration. Field introduced in 20.1.6. format: int32

mapping_rules (optional)

array[AuthMappingRule] Rules list for tenant or role mapping. Field introduced in 20.1.6.

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.

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.

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.

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.

attribute_match (optional)

AuthMatchAttribute Placeholder for description of property attribute_match of obj type AuthMappingRule field type str type object

group_match (optional)

AuthMatchGroupMembership Placeholder for description of property group_match of obj type AuthMappingRule field type str type object

index

Integer Number of index. format: int32

is_superuser (optional)

Boolean Placeholder for description of property is_superuser of obj type AuthMappingRule field type str type boolean

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.

policy_attribute_name (optional)

String Attribute name for Object Access Policy assignment. Field introduced in 18.2.7, 20.1.1.

role_attribute_name (optional)

String role_attribute_name of AuthMappingRule.

role_refs (optional)

array[String] It is a reference to an object of type Role.

tenant_attribute_name (optional)

String tenant_attribute_name of AuthMappingRule.

tenant_refs (optional)

array[String] It is a reference to an object of type Tenant.

userprofile_attribute_name (optional)

String Attribute name for User Account Profile assignment. Field introduced in 20.1.3.

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.

AuthMatchAttribute Up

criteria

String rule match criteria. Enum options - AUTH_MATCH_CONTAINS, AUTH_MATCH_DOES_NOT_CONTAIN, AUTH_MATCH_REGEX.

name (optional)

String Name of the object.

values (optional)

array[String] values of AuthMatchAttribute.

AuthMatchGroupMembership Up

criteria

String rule match criteria. Enum options - AUTH_MATCH_CONTAINS, AUTH_MATCH_DOES_NOT_CONTAIN, AUTH_MATCH_REGEX.

groups (optional)

array[String] groups of AuthMatchGroupMembership.

DNSConfiguration Up

search_domain (optional)

String Search domain to use in DNS lookup.

server_list (optional)

array[IpAddr] List of DNS Server IP addresses.

EmailConfiguration Up

auth_password (optional)

String Password for mail server.

auth_username (optional)

String Username for mail server.

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.

from_email (optional)

String Email address in From field.

mail_server_name (optional)

String Mail server host.

mail_server_port (optional)

Integer Mail server port. format: int32

smtp_type

String Type of SMTP Mail Service. Enum options - SMTP_NONE, SMTP_LOCAL_HOST, SMTP_SERVER, SMTP_ANONYMOUS_SERVER.

IpAddr Up

addr

String IP address.

type

String Enum options - V4, DNS, V6.

IpAddrMatch Up

addrs (optional)

array[IpAddr] IP address(es).

group_refs (optional)

array[String] UUID of IP address group(s). It is a reference to an object of type IpAddrGroup.

match_criteria

String Criterion to use for IP address matching the HTTP request. Enum options - IS_IN, IS_NOT_IN.

prefixes (optional)

array[IpAddrPrefix] IP address prefix(es).

ranges (optional)

array[IpAddrRange] IP address range(s).

IpAddrPrefix Up

ip_addr

IpAddr Placeholder for description of property ip_addr of obj type IpAddrPrefix field type str type object

mask

Integer Number of mask. format: int32

IpAddrRange Up

begin

IpAddr Starting IP address of the range.

end

IpAddr Ending IP address of the range.

LinuxConfiguration Up

banner (optional)

String Banner displayed before login to ssh, and UI.

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.

motd (optional)

String Message of the day, shown to users on login via the command line interface, web interface, or ssh.

MgmtIpAccessControl Up

api_access (optional)

IpAddrMatch Configure IP addresses to access controller using API.

shell_server_access (optional)

IpAddrMatch Configure IP addresses to access controller using CLI Shell.

snmp_access (optional)

IpAddrMatch Configure IP addresses to access controller using SNMP.

ssh_access (optional)

IpAddrMatch Configure IP addresses to access controller using SSH.

sysint_access (optional)

IpAddrMatch Configure IP addresses to access controller using sysint access. Field introduced in 18.1.3, 18.2.1.

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.

key

String NTP Authentication key.

key_number

Integer Key number to be assigned to the authentication-key. Allowed values are 1-65534. format: int32

NTPConfiguration Up

ntp_authentication_keys (optional)

array[NTPAuthenticationKey] NTP Authentication keys.

ntp_server_list (optional)

array[IpAddr] List of NTP server hostnames or IP addresses.

ntp_servers (optional)

array[NTPServer] List of NTP Servers.

NTPServer Up

key_number (optional)

Integer Key number from the list of trusted keys used to authenticate this server. Allowed values are 1-65534. format: int32

server

IpAddr IP Address of the NTP Server.

PortalConfiguration Up

allow_basic_authentication (optional)

Boolean Enable/Disable HTTP basic authentication.

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. format: int32

disable_remote_cli_shell (optional)

Boolean Disable Remote CLI Shell Client access.

disable_swagger (optional)

Boolean Disable Swagger access. Field introduced in 18.2.3.

enable_clickjacking_protection (optional)

Boolean Enable/Disable Clickjacking protection.

enable_http (optional)

Boolean Placeholder for description of property enable_http of obj type PortalConfiguration field type str type boolean

enable_https (optional)

Boolean Placeholder for description of property enable_https of obj type PortalConfiguration field type str type boolean

http_port (optional)

Integer HTTP port. format: int32

https_port (optional)

Integer HTTPS port. format: int32

minimum_password_length (optional)

Integer Minimum password length for user accounts. Allowed values are 6-32. Field introduced in 20.1.3. format: int32

password_strength_check (optional)

Boolean Strict checking of password strength for user accounts.

redirect_to_https (optional)

Boolean Placeholder for description of property redirect_to_https of obj type PortalConfiguration field type str type boolean

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.

sslprofile_ref (optional)

String It is a reference to an object of type SSLProfile.

use_uuid_from_input (optional)

Boolean Use UUID in POST object data as UUID of the new object, instead of a generated UUID.

ProxyConfiguration Up

host

String Proxy hostname or IP address.

password (optional)

String Password for proxy.

port

Integer Proxy port. format: int32

username (optional)

String Username for proxy.

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.

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.

SnmpConfiguration Up

community (optional)

String Community string for SNMP v2c.

large_trap_payload (optional)

Boolean Support for 4096 bytes trap payload. Field introduced in 17.2.13,18.1.4,18.2.1.

snmp_v3_config (optional)

SnmpV3Configuration SNMP version 3 configuration. Field introduced in 17.2.3.

sys_contact (optional)

String Sets the sysContact in system MIB.

sys_location (optional)

String Sets the sysLocation in system MIB.

version (optional)

String SNMP version support. V2 or V3. Enum options - SNMP_VER2, SNMP_VER3. Field introduced in 17.2.3.

SnmpV3Configuration Up

engine_id (optional)

String Engine Id of the Avi Controller SNMP. Field introduced in 17.2.3.

user (optional)

SnmpV3UserParams SNMP ver 3 user definition. Field introduced in 17.2.3.

SnmpV3UserParams Up

auth_passphrase (optional)

String SNMP V3 authentication passphrase. Field introduced in 17.2.3.

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.

priv_passphrase (optional)

String SNMP V3 privacy passphrase. Field introduced in 17.2.3.

priv_type (optional)

String SNMP V3 privacy setting. Enum options - SNMP_V3_PRIV_DES, SNMP_V3_PRIV_AES. Field introduced in 17.2.3.

username (optional)

String SNMP username to be used by SNMP clients for performing SNMP walk. Field introduced in 17.2.3.

SysTestEmailParams Up

cc_emails (optional)

String Alerts are copied to the comma separated list of email recipients.

subject

String The Subject line of the originating email from Avi Controller.

text

String The email context.

to_emails

String Alerts are sent to the comma separated list of email recipients.

SystemConfiguration Up

_last_modified (optional)

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

admin_auth_configuration (optional)

AdminAuthConfiguration Placeholder for description of property admin_auth_configuration of obj type SystemConfiguration field type str type object

common_criteria_mode (optional)

Boolean Common criteria mode's current state. Field introduced in 20.1.3.

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. Field introduced in 17.2.5. Allowed in Basic edition, Essentials edition, Enterprise edition. Special default for Basic edition is BASIC, Essentials edition is ESSENTIALS, Enterprise is ENTERPRISE.

dns_configuration (optional)

DNSConfiguration Placeholder for description of property dns_configuration of obj type SystemConfiguration field type str type object

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.

docker_mode (optional)

Boolean Placeholder for description of property docker_mode of obj type SystemConfiguration field type str type boolean

email_configuration (optional)

EmailConfiguration Placeholder for description of property email_configuration of obj type SystemConfiguration field type str type object

enable_cors (optional)

Boolean Enable CORS Header. Field introduced in 20.1.3. Allowed in Basic edition, Essentials edition, Enterprise edition.

fips_mode (optional)

Boolean FIPS mode current state. Field introduced in 20.1.1.

global_tenant_config (optional)

TenantConfiguration Placeholder for description of property global_tenant_config of obj type SystemConfiguration field type str type object

linux_configuration (optional)

LinuxConfiguration Placeholder for description of property linux_configuration of obj type SystemConfiguration field type str type object

mgmt_ip_access_control (optional)

MgmtIpAccessControl Configure Ip Access control for controller to restrict open access.

ntp_configuration (optional)

NTPConfiguration Placeholder for description of property ntp_configuration of obj type SystemConfiguration field type str type object

portal_configuration (optional)

PortalConfiguration Placeholder for description of property portal_configuration of obj type SystemConfiguration field type str type object

proxy_configuration (optional)

ProxyConfiguration Placeholder for description of property proxy_configuration of obj type SystemConfiguration field type str type object

secure_channel_configuration (optional)

SecureChannelConfiguration Configure Secure Channel properties. Field introduced in 18.1.4, 18.2.1.

snmp_configuration (optional)

SnmpConfiguration Placeholder for description of property snmp_configuration of obj type SystemConfiguration field type str type object

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.

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.

url (optional)

String url

uuid (optional)

String Unique object identifier of the object.

welcome_workflow_complete (optional)

Boolean This flag is set once the Initial Controller Setup workflow is complete. Field introduced in 18.2.3.

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.

tenant_access_to_provider_se (optional)

Boolean Placeholder for description of property tenant_access_to_provider_se of obj type TenantConfiguration field type str type boolean

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.

Avi SystemConfiguration Object API

Access

Table of Contents

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Consumes

Request body

Return type

Example data

Produces

Responses

200

401

Table of Contents