New in version 2.3.
parameter | required | default | choices | comments | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
domain_name |
no | The new domain name to apply to the device. | |||||||||||||||||||||||||||||||||||||
domain_search |
no | A list of domain names to search. Mutually exclusive with name_server | |||||||||||||||||||||||||||||||||||||
hostname |
no | Configure the device hostname parameter. This option takes an ASCII string value. | |||||||||||||||||||||||||||||||||||||
name_server |
no | A list of name servers to use with the device. Mutually exclusive with domain_search | |||||||||||||||||||||||||||||||||||||
provider |
no | A dict object containing connection details. | |||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||
state |
no | present |
|
Whether to apply ( present ) or remove (absent ) the settings. |
- name: configure hostname and domain-name vyos_system: hostname: vyos01 domain_name: test.example.com - name: remove all configuration vyos_system: state: absent - name: configure name servers vyos_system: name_server: - 8.8.8.8 - 8.8.4.4 - name: configure domain search suffixes vyos_system: domain_search: - sub1.example.com - sub2.example.com
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
commands | The list of configuration mode commands to send to the device | always | list | ['set system hostname vyos01', 'set system domain-name foo.example.com'] |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is community maintained without core committer oversight.
For more information on what this means please read Module Support
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.