Spec-Zone.ru › Ansible 2.5

asa_config — Управление разделами конфигурации на устройствах Cisco ASA

Новая версия 2.2.

  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
    • Автор

Описание

  • Конфигурации Cisco ASA используют простой синтаксис с отступами для разделения конфигурации на секции. Этот модуль предоставляет реализацию для работы с секциями конфигурации ASA детерминированным способом.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
after По умолчанию:
Нет
Упорядоченный набор команд для добавления в конец стека команд, если требуется изменение. Аналогично параметру before, это позволяет разработчику playbook добавить набор команд для выполнения после набора команд.
authorize
    Варианты:
  • да
  • нет ←
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes.
Дополнительную информацию можно найти в Руководстве по сети.
Указывает модулю перейти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE.
backup
    Варианты:
  • да
  • нет ←
Этот аргумент заставит модуль создать полную резервную копию текущей running-config с удалённого устройства перед внесением любых изменений. Файл резервной копии записывается в папку backup в корневой директории playbook. Если директория не существует, она создается.
before По умолчанию:
Нет
Упорядоченный набор команд для добавления в стек команд, если требуется изменение. Это позволяет разработчику playbook выполнить команды конфигурации перед внесением изменений, не влияя на сопоставление набора команд с системой.
config По умолчанию:
Нет
Аргумент config позволяет разработчику playbook указать базу конфигурации, которая используется для проверки изменений конфигурации. Если этот аргумент указан, модуль не загрузит running-config с удалённого узла.
context По умолчанию:
Нет
Указывает, какой контекст использовать, если вы работаете в режиме нескольких контекстов на устройстве ASA. По умолчанию используется текущий контекст входа.
defaults
    Варианты:
  • да
  • нет ←
Этот аргумент указывает, нужно ли собирать все значения по умолчанию при получении running-config удалённого устройства. При включении модуль получит текущую конфигурацию, выполнив команду show running-config all.
lines По умолчанию:
Нет
Упорядоченный набор команд, которые должны быть настроены в секции. Команды должны быть точно такими же, как и в running-config устройства. Убедитесь, что вы учли синтаксис команд конфигурации, поскольку некоторые команды автоматически изменяются парсером конфигурации устройства.

Псевдонимы: команды
match
    Варианты:
  • строка ←
  • строго
  • точно
  • нет
Указывает модулю способ сопоставления набора команд с текущей конфигурацией устройства. Если match установлен на строка, команды сопоставляются по строкам. Если match установлен на строго, строки команд сопоставляются относительно позиции. Если match установлен на точно, строки команд должны быть точным совпадением. Наконец, если match установлен на нет, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией на удалённом устройстве.
parents По умолчанию:
Нет
Упорядоченный набор родительских элементов, которые однозначно идентифицируют секцию или иерархию, с которой должны быть проверены команды. Если аргумент parents опущен, команды проверяются с учётом команд верхнего уровня или глобальных команд.
passwords
    Варианты:
  • да
  • нет ←
Этот аргумент указывает на включение паролей в конфигурацию при получении running-config с удалённого устройства. Это включает пароли, связанные с конечными точками VPN. Этот аргумент несовместим с аргументом defaults.
provider По умолчанию:
Нет
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.
Дополнительную информацию можно найти в Руководстве по сети.
Объект словаря, содержащий данные подключения.
username
Указывает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации SSH-сессии. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME.
authorize
    Варианты:
  • да
  • нет ←
Указывает модулю перейти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE.
ssh_keyfile
Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации SSH-сессии. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE.
auth_pass По умолчанию:
нет
Указывает пароль для перехода в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize — ложь, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS.
host
Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве целевого адреса для транспорта.
timeout По умолчанию:
10
Устанавливает таймаут бездействия соединения в секундах. Полезно, если консоль зависает перед продолжением, например, при сохранении конфигураций.
password По умолчанию:
Нет
Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации SSH-сессии. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD.
port По умолчанию:
22
Указывает порт, используемый при подключении к удалённому устройству.
replace
    Варианты:
  • строка ←
  • блок
Указывает модулю способ внесения изменений на устройстве. Если аргумент replace установлен на строка, изменённые строки передаются устройству в режиме конфигурации. Если аргумент replace установлен на блок, весь блок команд передаётся устройству в режиме конфигурации, если какая-либо строка неверна.
save
    Варианты:
  • да
  • нет ←
Аргумент save указывает модулю сохранить running-config в startup-config по завершении работы модуля. Если указан режим проверки, этот аргумент игнорируется.
src По умолчанию:
Нет
Указывает исходный путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путём на хосте Ansible или относительным путём от корня playbook или роли. Этот аргумент несовместим с аргументами lines и parents.

Примечания

Примечание

  • Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сети Ansible

Примеры

# Note: examples below use the following provider dict to handle
#       transport and authentication to the node.
---
vars:
  cli:
    host: "{{ inventory_hostname }}"
    username: cisco
    password: cisco
    authorize: yes
    auth_pass: cisco

---
- asa_config:
    lines:
      - network-object host 10.80.30.18
      - network-object host 10.80.30.19
      - network-object host 10.80.30.20
    parents: ['object-group network OG-MONITORED-SERVERS']
    provider: "{{ cli }}"

- asa_config:
    host: "{{ inventory_hostname }}"
    lines:
      - message-length maximum client auto
      - message-length maximum 512
    match: line
    parents: ['policy-map type inspect dns PM-DNS', 'parameters']
    authorize: yes
    auth_pass: cisco
    username: admin
    password: cisco
    context: ansible

- asa_config:
    lines:
      - ikev1 pre-shared-key MyS3cretVPNK3y
    parents: tunnel-group 1.1.1.1 ipsec-attributes
    passwords: yes
    provider: "{{ cli }}"

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ Возвращаемое значение Описание
backup_path
строка
при backup равно yes
Полный путь к резервной копии файла

Пример:
/playbooks/ansible/backup/asa_config.2016-07-16@22:28:34
updates
список
всегда
Набор команд, которые будут переданы удалённому устройству

Пример:
['...', '...']


Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратной совместимости интерфейса.

Автор

  • Peter Sprygada (@privateip), Patrick Ogenstad (@ogenstad)

Подсказка

Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/asa_config_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API