cisco.ios.ios cliconf – 在 Cisco IOS 平台上使用 ios cliconf 运行命令

注意

此 cliconf 插件是 cisco.ios 集合 (版本 9.0.3) 的一部分。

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

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

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

cisco.ios 1.0.0 中的新增功能

概要

  • 此 ios 插件为从 Cisco IOS 网络设备发送和接收 CLI 命令提供低级别抽象 API。

参数

参数

注释

commit_confirm_immediate

布尔值

启用或禁用提交确认模式。

在自定义/默认超时后确认推送的配置。（默认 1 分钟）。

对于自定义超时配置，请设置 commit_confirm_timeout 值。

在 commit_confirm_immediate 上，当未显式声明变量时，commit_confirm_timeout 的默认值被认为是 1 分钟。

选项

  • false ← (默认)

  • true

配置

commit_confirm_timeout

整数

在指定的时间（以分钟为单位）内试用方式提交配置。

在不指定 commit_confirm_immediate 的情况下使用 commit_confirm_timeout 将需要使用 ios_command 模块显式 configure confirm 来确认/提交所做的更改。

请参阅示例以了解用例演示。

配置

config_commands

列表 / 元素=字符串

在 cisco.ios 2.0.0 中添加

指定一个命令列表，这些命令可以对目标设备进行配置更改。

当启用 `ansible_network_single_user_mode` 时，如果发送到设备的命令在此列表中，则现有缓存将失效。

默认值： []

配置

  • 变量：ansible_ios_config_commands

示例

# NOTE - IOS waits for a `configure confirm` when the configure terminal
# command executed is `configure terminal revert timer <timeout>` within the timeout
# period for the configuration to commit successfully, else a rollback
# happens.

# Use commit confirm with timeout and confirm the commit explicitly

- name: Example commit confirmed
  vars:
    ansible_ios_commit_confirm_timeout: 1
  tasks:
    - name: "Commit confirmed with timeout"
      cisco.ios.ios_hostname:
        state: merged
        config:
          hostname: R1

    - name: "Confirm the Commit"
      cisco.ios.ios_command:
        commands:
          - configure confirm

# Commands fired
# - configure terminal revert timer 1 (cliconf specific)
# - hostname R1 (from hostname resource module)
# - configure confirm (from ios_command module)

# Use commit confirm with timeout and confirm the commit via cliconf

- name: Example commit confirmed
  vars:
    ansible_ios_commit_confirm_immediate: True
    ansible_ios_commit_confirm_timeout: 3
  tasks:
    - name: "Commit confirmed with timeout"
      cisco.ios.ios_hostname:
        state: merged
        config:
          hostname: R1

# Commands fired
# - configure terminal revert timer 3 (cliconf specific)
# - hostname R1 (from hostname resource module)
# - configure confirm (cliconf specific)

# Use commit confirm via cliconf using default timeout

- name: Example commit confirmed
  vars:
    ansible_ios_commit_confirm_immediate: True
  tasks:
    - name: "Commit confirmed with timeout"
      cisco.ios.ios_hostname:
        state: merged
        config:
          hostname: R1

# Commands fired
# - configure terminal revert timer 1 (cliconf specific with default timeout)
# - hostname R1 (from hostname resource module)
# - configure confirm (cliconf specific)

作者

  • Ansible 网络团队 (@ansible-network)

提示

每个条目类型的配置条目都有一个从低到高的优先级顺序。例如，列表中较低的变量将覆盖较高的变量。