Spec-Zone.ru › Ansible 2.6

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

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

  • Обзор
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
  • Техническое обслуживание
    • Автор

Обзор

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

Параметры

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

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

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

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


Статус

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

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробности см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых сообществом Ansible, см. здесь.

Автор

  • 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.6/modules/asa_config_module.html

Spec-Zone.ru

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