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

Примечание

Этот плагин cliconf является частью коллекции cisco.ios (версия 8.0.0).

Эта коллекция может быть уже установлена, если вы используете пакет 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 boolean	Включить или выключить режим подтверждения commit. Подтверждает конфигурацию, отправленную после пользовательского/стандартного таймаута (по умолчанию 1 минута). Для настройки пользовательского таймаута установите значение commit_confirm_timeout. По умолчанию для commit_confirm_timeout используется 1 минута, если переменная не объявлена явно. Варианты: `false` ← (по умолчанию) `true` Настройка: Переменная окружения: `ANSIBLE_IOS_COMMIT_CONFIRM_IMMEDIATE` Переменная: ansible_ios_commit_confirm_immediate
commit_confirm_timeout integer	Подтверждает конфигурацию в режиме испытания на заданное время в минутах. Использование commit_confirm_timeout без указания commit_confirm_immediate потребует явного `configure confirm` с помощью модуля ios_command для подтверждения/сохранения внесённых изменений. Обратитесь к примеру для демонстрации варианта использования. Настройка: Переменная окружения: `ANSIBLE_IOS_COMMIT_CONFIRM_TIMEOUT` Переменная: ansible_ios_commit_confirm_timeout
config_commands list / elements=string добавлено в 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 Networking (@ansible-network)

Подсказка

Элементы конфигурации для каждого типа имеют порядок приоритета от низкого к высокому. Например, переменная, которая расположена ниже в списке, переопределит переменную, которая находится выше.

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

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