cisco.nxos.nxos_banner 模块 – 在 Cisco NXOS 设备上管理多行横幅

注意

此模块是 cisco.nxos 集合 (版本 9.2.1) 的一部分。

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

要安装它,请使用: ansible-galaxy collection install cisco.nxos

要在剧本中使用它,请指定: cisco.nxos.nxos_banner

cisco.nxos 1.0.0 中的新增功能

概要

  • 这将在运行 Cisco NXOS 的远程设备上配置 exec 和 motd 横幅。它允许剧本向活动运行配置添加或删除横幅文本。

参数

参数

注释

banner

字符串 / 必需

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

选项

  • "exec"

  • "motd"

multiline_delimiter

字符串

指定将用于配置的定界符。

默认值: "@"

state

字符串

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

选项

  • "present" ← (默认)

  • "absent"

text

字符串

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

备注

注意

  • 由于始终去除前后空格后读取设备的响应,因此配置带有前导或尾随空格的横幅的任务将不是幂等的。

  • 对 Cisco MDS 的支持有限

  • 有关使用 CLI 和 NX-API 的信息,请参见:ref:`NXOS 平台选项指南 <nxos_platform_options>`

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

  • 有关使用 Ansible 管理 Cisco 设备的更多信息,请参见 `Cisco 集成页面 <https://ansible.org.cn/integrations/networks/cisco>`_。

示例

- name: configure the exec banner
  cisco.nxos.nxos_banner:
    banner: exec
    text: |
      this is my exec banner
      that contains a multiline
      string
    state: present
- name: remove the motd banner
  cisco.nxos.nxos_banner:
    banner: motd
    state: absent
- name: Configure banner from file
  cisco.nxos.nxos_banner:
    banner: motd
    text: "{{ lookup('file', './config_partial/raw_banner.cfg') }}"
    state: present

返回值

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

描述

commands

列表 / 元素=字符串

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

返回: 始终

示例: ["banner exec", "this is my exec banner", "that contains a multiline", "string"]

作者

  • Trishna Guha (@trishnaguha)