SystemConfiguration

Description

API


    PUT /api/systemconfiguration
    GET /api/systemconfiguration
    GET /api/systemconfiguration

CLI


    configure systemconfiguration
    show systemconfiguration

Data

SystemConfiguration

uuid

Type
string
Category
required
Description

dns_configuration

Type
DNSConfiguration
Category
optional
Description

ntp_configuration

Type
NTPConfiguration
Category
optional
Description

tech_support_uploader_configuration

Type
TechSupportUploaderConfiguration
Category
optional
Description

portal_configuration

Type
PortalConfiguration
Category
optional
Description

global_tenant_config

Type
TenantConfiguration
Category
optional
Description

email_configuration

Type
EmailConfiguration
Category
optional
Description

admin_auth_configuration

Type
AdminAuthConfiguration
Category
optional
Description

docker_mode

Type
bool
Category
optional,readonly
Description
Default
False

snmp_configuration

Type
SnmpConfiguration
Category
optional
Description

linux_configuration

Type
LinuxConfiguration
Category
optional
Description

proxy_configuration

Type
ProxyConfiguration
Category
optional
Description

mgmt_ip_access_control

Type
MgmtIpAccessControl
Category
optional
Description
Configure Ip Access control for controller to restrict open access.

ssh_ciphers

Type
string
Category
repeated
Description
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 -Q cipher provides the list of default ciphers supported.

ssh_hmacs

Type
string
Category
repeated
Description
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. ssh -Q mac provides the list of default HMACs supported.

DNSConfiguration

server_list

Type
IpAddr
Category
repeated
Description
List of DNS Server IP addresses

search_domain

Type
string
Category
optional
Description
Search domain to use in DNS lookup

IpAddr

addr

Type
string
Category
required
Description
IP address

type

Type
enum
Category
required
Description
Choices
V4, DNS

NTPConfiguration

ntp_server_list

Type
IpAddr
Category
repeated
Description
List of NTP server hostnames or IP addresses

TechSupportUploaderConfiguration

auto_upload

Type
bool
Category
optional
Description
Default
False

PortalConfiguration

enable_https

Type
bool
Category
optional
Description
Default
True

redirect_to_https

Type
bool
Category
optional
Description
Default
True

enable_http

Type
bool
Category
optional
Description
Default
True

sslkeyandcertificate_refs

Type
Reference to SSLKeyAndCertificate
Category
repeated
Description
Certificates for system portal. Maximum 2 allowed. Leave list empty to use system default certs

use_uuid_from_input

Type
bool
Category
optional
Description
Use UUID in POST object data as UUID of the new object, instead of a generated UUID.
Default
False

sslprofile_ref

Type
Reference to SSLProfile
Category
optional
Description
Default
/api/sslprofile?name=System-Standard

enable_clickjacking_protection

Type
bool
Category
optional
Description
Enable/Disable Clickjacking protection
Default
True

allow_basic_authentication

Type
bool
Category
optional
Description
Enable/Disable HTTP basic authentication
Default
False

http_port

Type
uint32
Category
optional
Description
HTTP port

https_port

Type
uint32
Category
optional
Description
HTTPS port

password_strength_check

Type
bool
Category
optional
Description
Strict checking of password strength for user accounts
Default
False

disable_remote_cli_shell

Type
bool
Category
optional
Description
Disable Remote CLI Shell Client access
Default
False

TenantConfiguration

tenant_vrf

Type
bool
Category
optional
Description
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.
Default
False

se_in_provider_context

Type
bool
Category
optional
Description
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.
Default
True

tenant_access_to_provider_se

Type
bool
Category
optional
Description
Default
True

EmailConfiguration

smtp_type

Type
enum
Category
required
Description
Type of SMTP Mail Service
Default
SMTP_NONE
Choices
SMTP_NONE, SMTP_LOCAL_HOST, SMTP_SERVER, SMTP_ANONYMOUS_SERVER

from_email

Type
string
Category
optional
Description
Email address in From field
Default
admin@avicontroller.net

mail_server_name

Type
string
Category
optional
Description
Mail server host
Default
localhost

mail_server_port

Type
uint32
Category
optional
Description
Mail server port
Default
25

auth_username

Type
string
Category
optional
Description
Username for mail server

auth_password

Type
string
Category
optional
Description
Password for mail server

AdminAuthConfiguration

auth_profile_ref

Type
Reference to AuthProfile
Category
optional
Description

mapping_rules

Type
AuthMappingRule
Category
repeated
Description
Rules list for tenant or role mapping

AuthMappingRule

index

Type
int32
Category
required
Description

group_match

Type
AuthMatchGroupMembership
Category
optional
Description

attribute_match

Type
AuthMatchAttribute
Category
optional
Description

assign_tenant

Type
enum
Category
optional
Description
Choices
ASSIGN_ALL, ASSIGN_MATCHING_ATTRIBUTE_VALUE, ASSIGN_FROM_SELECT_LIST, ASSIGN_MATCHING_GROUP_NAME

tenant_attribute_name

Type
string
Category
optional
Description

tenant_refs

Type
Reference to Tenant
Category
repeated
Description

assign_role

Type
enum
Category
optional
Description
Choices
ASSIGN_ALL, ASSIGN_MATCHING_ATTRIBUTE_VALUE, ASSIGN_FROM_SELECT_LIST, ASSIGN_MATCHING_GROUP_NAME

role_attribute_name

Type
string
Category
optional
Description

role_refs

Type
Reference to Role
Category
repeated
Description

is_superuser

Type
bool
Category
optional
Description

AuthMatchGroupMembership

criteria

Type
enum
Category
optional
Description
rule match criteria
Choices
AUTH_MATCH_DOES_NOT_CONTAIN, AUTH_MATCH_CONTAINS

groups

Type
string
Category
repeated
Description

SnmpConfiguration

community

Type
string
Category
required
Description
Community string for SNMP v2c
Default
public

LinuxConfiguration

motd

Type
string
Category
optional
Description
Message of the day, shown to users on login via the command line interface, web interface, or ssh.
Default

banner

Type
string
Category
optional
Description
Banner displayed before login to ssh, and UI
Default

ProxyConfiguration

host

Type
string
Category
required
Description
Proxy hostname or IP address

port

Type
uint32
Category
required
Description
Proxy port

username

Type
string
Category
optional
Description
Username for proxy

password

Type
string
Category
optional
Description
Password for proxy

MgmtIpAccessControl

ssh_access

Type
IpAddrMatch
Category
optional
Description
Configure ip addresses to access controller using SSH

api_access

Type
IpAddrMatch
Category
optional
Description
Configure ip addresses to access controller using api

shell_server_access

Type
IpAddrMatch
Category
optional
Description
Configure ip addresses to access controller using shell cli

snmp_access

Type
IpAddrMatch
Category
optional
Description
Configure ip addresses to access controller using snmp

IpAddrMatch

match_criteria

Type
enum
Category
required
Description
Criterion to use for IP address matching the HTTP request
Choices
IS_NOT_IN, IS_IN

addrs

Type
IpAddr
Category
repeated
Description
IP address(es)

ranges

Type
IpAddrRange
Category
repeated
Description
IP address range(s)

prefixes

Type
IpAddrPrefix
Category
repeated
Description
IP address prefix(es)

group_refs

Type
Reference to IpAddrGroup
Category
repeated
Description
UUID of IP address group(s)

IpAddrRange

begin

Type
IpAddr
Category
required
Description
Starting IP address of the range

end

Type
IpAddr
Category
required
Description
Ending IP address of the range

IpAddrPrefix

ip_addr

Type
IpAddr
Category
required
Description

mask

Type
int32
Category
required
Description

References

SSLKeyAndCertificate IpAddrGroup SSLProfile Role AuthProfile Tenant

Sub Objects