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

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

TenantConfiguration

tenant_vrf

Type
bool
Category
optional
Description
Default
False

se_in_provider_context

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

default_tenant_ref

Type
Reference to Tenant
Category
optional
Description

default_role_name

Type
string
Category
optional
Description
Roles name to lookup if no roles match using groups or attributes

use_group_membership_for_roles

Type
bool
Category
optional
Description
Use group membership identify the roles for this session

attribute_for_roles

Type
string
Category
optional
Description
Attribute whole value matches the roles for this session

use_group_membership_for_tenant

Type
bool
Category
optional
Description
Use group membership identify the tenant

attribute_for_tenant

Type
string
Category
optional
Description
Attribute whole value matches the tenant

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

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

References

AuthProfile SSLProfile Tenant SSLKeyAndCertificate

Sub Objects