Модуль cisco.asa.asa_config — Управление секциями конфигурации на устройствах Cisco ASA

Примечание

Этот модуль входит в состав коллекции cisco.asa (версия 5.0.1).

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

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

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

Новая функция в cisco.asa 1.0.0

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

Обзор

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

Псевдонимы: config

Параметры

Параметр	Комментарии
after список / элементы=строка	Упорядоченный набор команд для добавления в конец стека команд, если требуется внести изменения. Как и в случае с параметром before, это позволяет разработчику плейбука добавить набор команд, которые будут выполнены после набора команд.
backup логический	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` с удалённого устройства перед внесением любых изменений. Если значение `backup_options` не указано, файл резервной копии записывается в папку `backup` в корневой директории плейбука. Если директория не существует, она создаётся. Варианты: `false` ← (по умолчанию) `true`
backup_options словарь	Это объект словаря, содержащий конфигурируемые параметры, относящиеся к пути к файлу резервной копии. Значение этого параметра считывается только тогда, когда `backup` установлено в true; если `backup` установлено в no, этот параметр будет проигнорирован.
dir_path путь	Этот параметр задаёт путь к папке, в которой будет храниться файл резервной копии конфигурации. Если папка не существует, она будет создана. Имя файла — это либо значение `filename`, либо имя файла по умолчанию, как описано в `filename` описании параметров. Если путь не задан, будет создана папка backup в текущей рабочей директории, и резервная копия конфигурации будет скопирована в `filename` внутри папки backup.
filename строка	Имя файла, используемого для хранения резервной копии конфигурации. Если имя файла не задано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <имя_хоста>_config.<дата>@<время>.
before список / элементы=строка	Упорядоченный набор команд, которые необходимо добавить в стек команд, если нужно внести изменения. Это позволяет разработчику плейбука выполнить команды конфигурации перед внесением каких-либо изменений, не влияя на соответствие набора команд системе.
config строка	Аргумент `config` позволяет разработчику плейбука предоставить базовые конфигурации для проверки необходимых изменений конфигурации. Если этот аргумент задан, модуль не будет загружать текущую конфигурацию с удалённого узла.
context строка	Указывает, какой контекст необходимо выбрать, если вы работаете с ASA в режиме нескольких контекстов. По умолчанию используется текущий контекст, к которому вы подключились.
defaults логический	Этот аргумент указывает, следует ли собирать все значения по умолчанию при получении текущей конфигурации удалённого устройства. При включении модуль получит текущую конфигурацию, выполнив команду `show running-config all`. Варианты: `false` ← (по умолчанию) `true`
строки псевдонимы: команды список / элементы=строка	Упорядоченный набор команд, которые должны быть сконфигурированы в разделе. Команды должны быть идентичны командам, найденным в текущей конфигурации устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются анализатором конфигурации устройства.
match строка	Указывает модулю способ сопоставления набора команд с текущей конфигурацией устройства. Если match установлено в line, команды сопоставляются построчно. Если match установлено в strict, строки команд сопоставляются относительно позиции. Если match установлено в exact, строки команд должны точно совпадать. Если match установлено в none, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией удалённого устройства. Варианты: `"line"` ← (по умолчанию) `"strict"` `"exact"` `"none"`
parents список / элементы=строка	Упорядоченный набор родительских элементов, которые однозначно идентифицируют раздел или иерархию, по которым должны проверяться команды. Если аргумент parents опущен, команды проверяются по отношению к набору команд верхнего уровня или глобальных команд.
passwords логический	Этот аргумент указывает на необходимость включения паролей в конфигурацию при получении текущей конфигурации с удалённого устройства. Это включает пароли, связанные с конечными точками VPN. Этот аргумент несовместим с аргументом defaults. Варианты: `false` `true`
replace строка	Указывает модулю способ выполнения конфигурации на устройстве. Если параметр replace установлен в line, изменённые строки передаются устройству в режиме конфигурации. Если replace установлен в block, весь блок команд передаётся на устройство в режиме конфигурации, если какая-либо строка неверна. Варианты: `"line"` ← (по умолчанию) `"block"`
save логический	Аргумент `save` указывает модулю сохранить текущую конфигурацию в постоянную конфигурацию по завершении выполнения модуля. Если задан режим проверки, этот аргумент игнорируется. Варианты: `false` ← (по умолчанию) `true`

save_when

string

added in cisco.asa 1.1.0

При внесении изменений в конфигурацию устройства (running-configuration), изменения по умолчанию не копируются в постоянную память. Использование этого аргумента изменит это поведение. Если аргумент установлен в always, то running-config всегда будет скопирован в startup-config, и флаг modified всегда будет установлен в True. Если аргумент установлен в modified, то running-config будет скопирован в startup-config только в том случае, если он изменился с момента последнего сохранения в startup-config. Если аргумент установлен в never, running-config никогда не будет скопирован в startup-config. Если аргумент установлен в changed, то running-config будет скопирован в startup-config только в том случае, если задача внесла изменения. changed был добавлен в Ansible 2.5.

Возможные значения:

"always"
"never" ← (по умолчанию)
"modified"
"changed"

src

path

Указывает путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путем на хосте Ansible или относительным путем от корня playbook или роли. Этот аргумент взаимоисключающ с lines, parents.

Примечания

Примечание

Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. :ref:`Руководство по Ansible для сети <network_guide>`

Примеры

- cisco.asa.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]

- cisco.asa.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]
    auth_pass: cisco
    username: admin
    password: cisco
    context: ansible

- cisco.asa.asa_config:
    lines:
      - ikev1 pre-shared-key MyS3cretVPNK3y
    parents: tunnel-group 1.1.1.1 ipsec-attributes
    passwords: true

- name: attach ASA acl on interface vlan13/nameif cloud13
  cisco.asa.asa_config:
    lines:
      - access-group cloud-acl_access_in in interface cloud13

- name: configure ASA (>=9.2) default BGP
  cisco.asa.asa_config:
    lines:
      - bgp log-neighbor-changes
      - bgp bestpath compare-routerid
    parents:
      - router bgp 65002
  register: bgp
  when: bgp_default_config is defined
- name: configure ASA (>=9.2) BGP neighbor in default/single context mode
  cisco.asa.asa_config:
    lines:
      - bgp router-id {{ bgp_router_id }}
      - neighbor {{ bgp_neighbor_ip }} remote-as {{ bgp_neighbor_as }}
      - neighbor {{ bgp_neighbor_ip }} description {{ bgp_neighbor_name }}
    parents:
      - router bgp 65002
      - address-family ipv4 unicast
  register: bgp
  when: bgp_neighbor_as is defined
- name: configure ASA interface with standby
  cisco.asa.asa_config:
    lines:
      - description my cloud interface
      - nameif cloud13
      - security-level 50
      - ip address 192.168.13.1 255.255.255.0 standby 192.168.13.2
    parents: [interface Vlan13]
  register: interface
- name: Show changes to interface from task above
  ansible.builtin.debug:
    var: interface

- name: configurable backup path
  cisco.asa.asa_config:
    lines:
      - access-group cloud-acl_access_in in interface cloud13
    backup: true
    backup_options:
      filename: backup.cfg
      dir_path: /home/user

- name: save running to startup when modified
  cisco.asa.asa_config:
    save_when: modified

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

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

Ключ	Описание
backup_path string	Полный путь к резервной копии файла Возвращается: при backup = true Пример: `"/playbooks/ansible/backup/asa_config.2016-07-16@22:28:34"`
updates list / элементы=string	Набор команд, которые будут отправлены на удаленное устройство Возвращается: всегда Пример: `["...", "..."]`

Авторы

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

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

© 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/asa/asa_config_module.html