.. _vyos.rest.vyos_system_module: ********************* vyos.rest.vyos_system ********************* **Manage system settings on VyOS via the REST API.** Version added: 1.0.0 .. contents:: :local: :depth: 1 Synopsis -------- - Manages system-level settings — hostname, domain name, name servers, domain search list — using the VyOS HTTPS REST API. - Mirrors ``vyos.vyos.vyos_system`` but uses the HTTP API. Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
api_key
string / required
domain_name
string
System domain name.
domain_search
list / elements=string
List of domain search suffixes. Mutually exclusive with name_server.
host_name
string
System hostname.
hostname
string / required
name_server
list / elements=string
List of DNS name servers. Mutually exclusive with domain_search.

aliases: name_servers
port
integer
Default:
443
state
string
    Choices:
  • present ←
  • absent
present to apply, absent to remove.
timeout
integer
Default:
30
verify_ssl
boolean
    Choices:
  • no ←
  • yes

Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: .. raw:: html
Key Returned Description
commands
list
always
set/delete commands issued.


Status ------ Authors ~~~~~~~ - VyOS Community (@vyos)