Модуль community.network.ce_config – Управление секциями конфигурации Huawei CloudEngine.

Примечание

Этот модуль входит в коллекцию community.network (версия 5.0.3).

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

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

Для использования в плейбуке укажите: community.network.ce_config.

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

Обзор

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

Псевдонимы: network.cloudengine.ce_config

Параметры

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

Примечания

Примечание

Рекомендуемое подключение — network_cli.
Этот модуль также работает с подключениями local для устаревших плейбуков.

Примеры

- name: CloudEngine config test
  hosts: cloudengine
  connection: local
  gather_facts: false

  tasks:
  - name: "Configure top level configuration and save it"
    community.network.ce_config:
      lines: sysname {{ inventory_hostname }}
      save: true

  - 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

  - 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

  - name: Configurable backup path
    community.network.ce_config:
      lines: sysname {{ inventory_hostname }}
      backup: true
      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 список / элементы=строка	Набор команд, которые будут отправлены на удаленное устройство Возвращается: Только если указаны строки. Пример: `["...", "..."]`

Авторы

QijunPan (@QijunPan)

Ссылки на сборку

© 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/community/network/ce_config_module.html