junipernetworks.junos.junos_banner 模块 – 管理 Juniper JUNOS 设备上的多行横幅

注意

此模块是 junipernetworks.junos 集合(版本 9.1.0)的一部分。

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

要安装它,请使用:ansible-galaxy collection install junipernetworks.junos。您需要其他要求才能使用此模块,有关详细信息,请参见 要求

要在 playbook 中使用它,请指定:junipernetworks.junos.junos_banner

junipernetworks.junos 1.0.0 中的新增功能

概要

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

要求

在执行此模块的主机上需要以下要求。

  • ncclient (>=v0.5.2)

参数

参数

注释

active

布尔值

指定配置是否处于活动状态或已停用

选择

  • false

  • true ←(默认)

banner

字符串 / 必需

指定应在远程设备上配置哪个横幅。值 login 表示身份验证之前的系统登录消息,motd 是身份验证成功后的登录公告。

选择

  • "login"

  • "motd"

state

字符串

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

选择

  • "present" ←(默认)

  • "absent"

text

字符串

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

注释

注意

  • 此模块要求在被管理的远程设备上启用 netconf 系统服务。

  • 针对 vSRX JUNOS 版本 15.1X49-D15.4、vqfx-10000 JUNOS 版本 15.1X53-D60.4 进行了测试。

  • 推荐的连接是 netconf。请参阅 Junos OS 平台选项

  • 此模块还适用于旧版 playbook 的 local 连接。

  • 有关使用 CLI 和 netconf 的信息,请参见:ref:`Junos OS 平台选项指南 <junos_platform_options>`

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

  • 有关使用 Ansible 管理 Juniper 网络设备的更多信息,请参见 https://ansible.org.cn/ansible-juniper

示例

- name: configure the login banner
  junipernetworks.junos.junos_banner:
    banner: login
    text: |
      this is my login banner
      that contains a multiline
      string
    state: present

- name: remove the motd banner
  junipernetworks.junos.junos_banner:
    banner: motd
    state: absent

- name: deactivate the motd banner
  junipernetworks.junos.junos_banner:
    banner: motd
    state: present
    active: false

- name: activate the motd banner
  junipernetworks.junos.junos_banner:
    banner: motd
    state: present
    active: true

- name: Configure banner from file
  junipernetworks.junos.junos_banner:
    banner: motd
    text: "{{ lookup('file', './config_partial/raw_banner.cfg') }}"
    state: present

返回值

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

描述

diff.prepared

字符串

应用更改之前和之后的配置差异。

返回:当配置更改且启用了 diff 选项时。

示例: "[edit system login] +   message \"this is my login banner\";\n"

作者

  • Ganesh Nalawade (@ganeshrn)