cisco.iosxr.iosxr_banner 模块 – 配置多行横幅的模块。

注意

此模块是 cisco.iosxr 集合（版本 10.2.2）的一部分。

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

要安装它，请使用：ansible-galaxy collection install cisco.iosxr。您需要其他要求才能使用此模块，有关详细信息，请参阅要求。

要在 playbook 中使用它，请指定：cisco.iosxr.iosxr_banner。

cisco.iosxr 1.0.0 中的新增功能

概要 

此模块将配置运行 Cisco IOS XR 的远程设备上的 exec 和 motd 横幅。它允许 playbook 从运行配置中添加或删除横幅文本。

要求 

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

使用 netconf 时，ncclient >= 0.5.3
使用 netconf 时，lxml >= 4.1.1

参数 

参数	注释
banner 字符串 / 必填	指定要在远程设备上配置的横幅类型。选项 `"login"` `"motd"`
state 字符串	设备上配置的存在状态。选项 `"present"` ← (默认) `"absent"`
text 字符串	要配置的横幅文本。接受多行字符串，不包含空行。使用多行字符串时，第一个和最后一个字符必须是横幅的起始和结束分隔符。需要 state=present。

备注 

注意

此模块适用于连接 network_cli 和 netconf。参见 IOS-XR 平台选项。
有关使用 Ansible 管理网络设备的更多信息，请参阅：ref:`Ansible 网络指南 <network_guide>`
有关使用 Ansible 管理 Cisco 设备的更多信息，请参阅 `Cisco 集成页面 <https://ansible.org.cn/integrations/networks/cisco>`_。

示例 

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

返回值 

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

键

描述

列表 / 元素=字符串

使用传输 cli 发送到设备的配置模式命令列表

返回：始终（无命令发送时为空列表）

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

列表 / 元素=字符串

使用传输 netconf 发送到设备的 NetConf rpc xml

返回：始终（无 xml rpc 发送时为空列表）

示例：["<config xmlns:xc=\"urn:ietf:params:xml:ns:netconf:base:1.0\"> <banners xmlns=\"http://cisco.com/ns/yang/Cisco-IOS-XR-infra-infra-cfg\"> <banner xc:operation=\"merge\"> <banner-name>motd</banner-name> <banner-text>Ansible banner example</banner-text> </banner> </banners> </config>"]

作者

Trishna Guha (@trishnaguha)
Kedar Kekan (@kedarX)