vyos.vyos.vyos_system 模块 – 在 VyOS 设备上运行 `set system` 命令

注意

此模块是 vyos.vyos 集合（版本 5.0.0）的一部分。

如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install vyos.vyos。

要在 playbook 中使用它，请指定：vyos.vyos.vyos_system。

vyos.vyos 1.0.0 中的新功能

概要

  • 在运行 VyOS 的远程设备上运行一个或多个命令。此模块还可以进行自省，以在成功返回之前验证关键参数。

参数

参数

注释

domain_name

字符串

要应用于设备的新域名。

列表 / 元素=字符串

要搜索的域名列表。与 *name_server* 互斥

host_name

字符串

配置设备主机名参数。此选项采用 ASCII 字符串值。

name_server

别名：name_servers

列表 / 元素=字符串

要与设备一起使用的名称服务器列表。与 *domain_search* 互斥

state

字符串

是应用 (present) 还是删除 (absent) 设置。

选项

  • "present" ← (默认)

  • "absent"

注意

注意

  • 已针对 VyOS 1.1.8 (helium) 进行测试。

  • 此模块与连接 ansible.netcommon.network_cli 一起工作。请参阅 VyOS 操作系统平台选项。

  • 有关使用 Ansible 管理网络设备的更多信息，请参阅 :ref:`Ansible 网络指南 <network_guide>`

示例

- name: configure hostname and domain-name
  vyos.vyos.vyos_system:
    host_name: vyos01
    domain_name: test.example.com

- name: remove all configuration
  vyos.vyos.vyos_system:
    state: absent

- name: configure name servers
  vyos.vyos.vyos_system: name_servers - 8.8.8.8 - 8.8.4.4
- name: configure domain search suffixes
  vyos.vyos.vyos_system:
    domain_search:
      - sub1.example.com
      - sub2.example.com

返回值

常见的返回值记录在 此处，以下是此模块独有的字段

键

描述

命令

列表 / 元素=字符串

要发送到设备的配置模式命令列表

返回: 总是

示例: ["set system hostname vyos01", "set system domain-name foo.example.com"]

作者

  • Nathaniel Case (@Qalthos)