Spec-Zone.ru › Ansible 2.4

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

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

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

Обзор

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

Параметры

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

Примеры

# 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 и Разработка модулей.

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

Spec-Zone.ru

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