cisco.ios.ios cliconf — использование ios cliconf для выполнения команд на платформе Cisco IOS

Примечание

Этот плагин cliconf входит в коллекцию cisco.ios (версия 11.4.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.ios.

Чтобы использовать её в плейбуке, укажите: cisco.ios.ios.

Добавлено в cisco.ios 1.0.0

Описание
Параметры
Примеры

Описание

Этот плагин ios предоставляет низкоуровневые API-абстракции для отправки и получения команд CLI на сетевых устройствах Cisco IOS.

Параметры

Параметр	Комментарии
commit_confirm_immediate логический	Включает или отключает режим подтверждения фиксации изменений. Подтверждает отправленную конфигурацию по истечении пользовательского или стандартного тайм-аута (по умолчанию — 1 минута). Чтобы задать пользовательский тайм-аут, укажите значение commit_confirm_timeout. Если используется commit_confirm_immediate, значение commit_confirm_timeout по умолчанию считается равным 1 минуте, когда переменная не объявлена явно. Варианты: `false` ← (по умолчанию) `true` Конфигурация: Переменная среды: `ANSIBLE_IOS_COMMIT_CONFIRM_IMMEDIATE` Переменная: ansible_ios_commit_confirm_immediate
commit_confirm_timeout целое число	Фиксирует конфигурацию в пробном режиме на указанное количество минут. При использовании commit_confirm_timeout без указания commit_confirm_immediate необходимо явно выполнить `configure confirm` с помощью модуля ios_command, чтобы подтвердить или зафиксировать внесённые изменения. Пример использования приведён в разделе примеров. Конфигурация: Переменная среды: `ANSIBLE_IOS_COMMIT_CONFIRM_TIMEOUT` Переменная: ansible_ios_commit_confirm_timeout
config_commands список / элементы типа string добавлено в cisco.ios 2.0.0	Задаёт список команд, которые могут изменять конфигурацию целевого устройства. Если включён режим `ansible_network_single_user_mode` и отправленная устройству команда присутствует в этом списке, существующий кэш становится недействительным. По умолчанию: `[]` Конфигурация: Переменная: ansible_ios_config_commands

Примечание

Записи конфигурации, перечисленные выше для каждого типа записей (переменная Ansible, переменная среды и т. д.), упорядочены от низшего приоритета к высшему. Например, переменная, расположенная ниже в списке, переопределяет переменную, расположенную выше. Типы записей также упорядочены по приоритету от низшего к высшему. Например, запись ansible.cfg (расположенная выше в списке) переопределяется переменной Ansible (расположенной ниже в списке).

Примеры

# 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 Networking (@ansible-network)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/ios/ios_cliconf.html