cisco.ios.ios_banner 模块 – 用于配置多行横幅的模块。

注意

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

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

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

要在 playbook 中使用它,请指定:cisco.ios.ios_banner

cisco.ios 1.0.0 中的新功能

概要

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

参数

参数

注释

banner

字符串 / 必需

指定应在远程设备上配置哪个横幅。在 Ansible 2.4 及更早版本中,仅支持 loginmotd

选项

  • "login"

  • "motd"

  • "exec"

  • "incoming"

  • "slip-ppp"

multiline_delimiter

字符串

指定将用于配置的分隔符字符。

默认: "@"

state

字符串

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

选项

  • "present" ← (默认)

  • "absent"

text

字符串

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

注意

注意

示例

- name: Configure the login banner
  cisco.ios.ios_banner:
    banner: login
    text: |
      this is my login banner
      that contains a multiline
      string
    state: present

- name: Remove the motd banner
  cisco.ios.ios_banner:
    banner: motd
    state: absent

- name: Configure banner from file
  cisco.ios.ios_banner:
    banner: motd
    text: "{{ lookup('file', './config_partial/raw_banner.cfg') }}"  # Use unix formatted text files (LF not CRLF) to avoid idempotency issues.
    state: present

- name: Configure the login banner using delimiter
  cisco.ios.ios_banner:
    banner: login
    multiline_delimiter: x
    text: this is my login banner
    state: present

返回值

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

描述

commands

列表 / elements=字符串

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

已返回: 始终

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

作者

  • Ricardo Carrillo Cruz (@rcarrillocruz)