community.network.ce_config – Управление разделами конфигурации Huawei CloudEngine.
Примечание
Этот плагин является частью коллекции community.network (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в книге задач укажите: community.network.ce_config.
Обзор
- Конфигурации Huawei CloudEngine используют простой синтаксис отступа блоков для разделения конфигурации на секции. Этот модуль предоставляет реализацию для работы с секциями конфигурации CloudEngine детерминированным способом. Этот модуль работает с транспортными средствами CLI.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| after строка | Упорядоченный набор команд для добавления в конец стека команд, если требуется внести изменения. Подобно параметру before, это позволяет разработчику книги задач добавить набор команд, которые будут выполнены после набора команд. | ||
| backup булево |
| Этот аргумент заставит модуль создать полную резервную копию текущей current-configuration с удаленного устройства перед внесением каких-либо изменений. Если значение backup_options не указано, файл резервной копии записывается в папку backup в корневом каталоге книги задач. Если каталог не существует, он создается. | |
| backup_options словарь | Это объект словаря, содержащий настраиваемые параметры, относящиеся к пути к файлу резервной копии. Значение этого параметра считывается только при условии, что backup установлено в yes. Если backup установлено в no, этот параметр будет проигнорирован. | ||
| dir_path путь | Этот параметр предоставляет путь, заканчивающийся именем каталога, в котором будет храниться файл резервной копии конфигурации. Если каталог не существует, он будет сначала создан, а имя файла будет либо значением filename, либо именем файла по умолчанию, как описано в описании параметров filename. Если значение пути не задано, в текущем рабочем каталоге будет создан каталог backup, и резервная копия конфигурации будет скопирована в filename в каталоге backup. | ||
| filename строка | Имя файла, используемое для хранения резервной копии конфигурации. Если имя файла не указано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <имя хоста>_config.<дата>@<время> | ||
| before строка | Упорядоченный набор команд для добавления в стек команд, если требуется внести изменения. Это позволяет разработчику книги задач выполнить команды конфигурации до добавления любых изменений, не влияя на то, как набор команд сопоставляется с системой. | ||
| config строка | Модуль по умолчанию подключается к удаленному устройству и извлекает текущую текущую конфигурацию для использования в качестве основы для сравнения с содержимым источника. Иногда нежелательно, чтобы задача получала текущую конфигурацию для каждой задачи в книге задач. Аргумент config позволяет реализатору передать конфигурацию для использования в качестве базовой конфигурации для сравнения. | ||
| defaults булево |
| Аргумент defaults повлияет на то, как собирается текущая конфигурация с устройства. Когда значение установлено в true, используемая команда для сбора текущей конфигурации дополняется ключевым словом all. При значении false команда выполняется без ключевого слова all. | |
| lines строка | Упорядоченный набор команд, которые должны быть сконфигурированы в разделе. Команды должны быть точно такими же, как и в текущей конфигурации устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются анализатором конфигурации устройства. | ||
| match строка |
| Указывает модулю способ выполнения сопоставления набора команд с текущей конфигурацией устройства. Если match установлено в line, команды сопоставляются построчно. Если match установлено в strict, строки команд сопоставляются с учетом позиции. Если match установлено в exact, строки команд должны быть точным совпадением. Наконец, если match установлено в none, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией на удаленном устройстве. | |
| parents строка | Упорядоченный набор родительских элементов, которые однозначно идентифицируют раздел или иерархию, с которыми должны быть проверены команды. Если аргумент parents опущен, команды проверяются с учетом набора команд верхнего уровня или глобальных команд. | ||
| replace строка |
| Указывает модулю способ выполнения конфигурации на устройстве. Если параметр replace установлен в line, измененные строки отправляются устройству в режиме конфигурации. Если параметр replace установлен в block, весь блок команд отправляется на устройство в режиме конфигурации, если какая-либо строка неверна. | |
| save булево |
| Аргумент save, указывает модулю сохранить текущую конфигурацию в сохранённую конфигурацию. Эта операция выполняется после внесения любых изменений в текущую рабочую конфигурацию. Если изменений не было, конфигурация всё равно сохраняется в стартовой конфигурации. Этот параметр всегда заставит модуль вернуть изменённое значение. | |
| src строка | Аргумент src предоставляет путь к файлу конфигурации, который нужно загрузить в удаленную систему. Путь может быть полным системным путем к файлу конфигурации, если значение начинается с /, или относительным к корню реализованного роли или книги задач. Этот аргумент несовместим с аргументами lines и parents. | ||
Примечания
Примечание
- Рекомендуемое подключение –
network_cli. - Этот модуль также работает с подключением
localдля устаревших книг задач.
Примеры
# Note: examples below use the following provider dict to handle
# transport and authentication to the node.
- name: CloudEngine config test
hosts: cloudengine
connection: local
gather_facts: no
vars:
cli:
host: "{{ inventory_hostname }}"
port: "{{ ansible_ssh_port }}"
username: "{{ username }}"
password: "{{ password }}"
transport: cli
tasks:
- name: "Configure top level configuration and save it"
community.network.ce_config:
lines: sysname {{ inventory_hostname }}
save: yes
provider: "{{ cli }}"
- name: "Configure acl configuration and save it"
community.network.ce_config:
lines:
- rule 10 permit source 1.1.1.1 32
- rule 20 permit source 2.2.2.2 32
- rule 30 permit source 3.3.3.3 32
- rule 40 permit source 4.4.4.4 32
- rule 50 permit source 5.5.5.5 32
parents: acl 2000
before: undo acl 2000
match: exact
provider: "{{ cli }}"
- name: "Configure acl configuration and save it"
community.network.ce_config:
lines:
- rule 10 permit source 1.1.1.1 32
- rule 20 permit source 2.2.2.2 32
- rule 30 permit source 3.3.3.3 32
- rule 40 permit source 4.4.4.4 32
parents: acl 2000
before: undo acl 2000
replace: block
provider: "{{ cli }}"
- name: Configurable backup path
community.network.ce_config:
lines: sysname {{ inventory_hostname }}
provider: "{{ cli }}"
backup: yes
backup_options:
filename: backup.cfg
dir_path: /home/user
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие — это поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| backup_path строка | при backup = yes | Полный путь к файлу резервной копии Пример: /playbooks/ansible/backup/ce_config.2016-07-16@22:28:34 |
| updates список / элементы=строка | только при указании lines. | Набор команд, которые будут отправлены на удаленное устройство Пример: ['...', '...'] |
Авторы
- QijunPan (@QijunPan)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/ce_config_module.html