vyos.vyos.vyos_banner 模块 – 管理 VyOS 设备上的多行横幅

注意

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

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

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

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

vyos.vyos 1.0.0 中的新增功能

概要

  • 这将配置运行 VyOS 的远程设备上的登录前和登录后横幅。它允许 playbook 从活动运行配置中添加或删除横幅文本。

参数

参数

注释

banner

字符串 / 必需

指定应在远程设备上配置哪个横幅。

选择

  • "pre-login"

  • "post-login"

state

字符串

指定配置是否存在于当前设备的活动运行配置中。

选择

  • "present" ← (默认)

  • "absent"

text

字符串

应存在于远程设备运行配置中的横幅文本。此参数接受多行字符串，没有空行。需要state=present。

说明

注意

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

  • 此模块使用连接 ansible.netcommon.network_cli。 请参阅 VyOS 操作系统平台选项。

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

示例

- name: configure the pre-login banner
  vyos.vyos.vyos_banner:
    banner: pre-login
    text: |
      this is my pre-login banner
      that contains a multiline
      string
    state: present
- name: remove the post-login banner
  vyos.vyos.vyos_banner:
    banner: post-login
    state: absent

返回值

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

键

描述

commands

列表 / elements=字符串

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

返回： 总是

示例： ["banner pre-login", "this is my pre-login banner", "that contains a multiline", "string"]

作者

  • Trishna Guha (@trishnaguha)