Spec-Zone.ru › Ansible 2.9

ce_config – Управление секциями конфигурации Huawei CloudEngine

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

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

Обзор

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
after
-
Упорядоченный набор команд для добавления в конец стека команд, если требуется изменение. Подобно параметру before, это позволяет разработчику плейбука добавить набор команд, которые будут выполнены после набора команд.
backup
boolean
    Варианты:
  • no ←
  • yes
Этот аргумент заставит модуль создать полную резервную копию текущей current-configuration с удалённого устройства перед внесением каких-либо изменений. Если значение backup_options не задано, файл резервной копии записывается в папку backup в корневой директории плейбука. Если директория не существует, она создаётся.
backup_options
словарь
добавлено в 2.8
Это объект словаря, содержащий настраиваемые параметры, относящиеся к пути к файлу резервной копии. Значение этого параметра читается только когда backup установлено в yes; если backup установлено в no, этот параметр будет проигнорирован.
dir_path
путь
Этот параметр предоставляет путь, заканчивающийся именем директории, в которой будет храниться файл резервной копии конфигурации. Если директория не существует, она будет создана первой, а имя файла будет либо значением filename, либо именем по умолчанию, как описано в описании параметров filename. Если значение пути не указано, в этом случае будет создана директория backup в текущей рабочей директории, и резервная копия конфигурации будет скопирована в filename внутри директории backup.
filename
-
Имя файла, используемое для хранения резервной копии конфигурации. Если имя файла не задано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <имя_хоста>_config.<дата>@<время>
before
-
Упорядоченный набор команд для добавления в стек команд, если требуется изменение. Это позволяет разработчику плейбука выполнить команды конфигурации перед добавлением любых изменений, не влияя на способ сопоставления набора команд с системой.
config
-
Модуль по умолчанию подключается к удалённому устройству и получает текущую конфигурацию для использования в качестве основы для сравнения с содержимым источника. Иногда нежелательно получать текущую конфигурацию для каждой задачи в плейбуке. Аргумент config позволяет реализатору передать конфигурацию для использования в качестве основной конфигурации для сравнения.
defaults
boolean
    Варианты:
  • no ←
  • yes
Аргумент defaults повлияет на то, как собирается текущая конфигурация с устройства. При установке значения в true, команда для сбора текущей конфигурации дополняется ключевым словом all. При установке значения в false, команда выполняется без ключевого слова all.
lines
-
Упорядоченный набор команд, которые должны быть настроены в разделе. Команды должны быть точно такими же, как и в текущей конфигурации устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются анализатором конфигурации устройства.
match
-
    Варианты:
  • line ←
  • strict
  • exact
  • none
Указывает модулю способ сопоставления набора команд с текущей конфигурацией устройства. Если match установлено в line, команды сопоставляются построчно. Если match установлено в strict, строки команд сопоставляются относительно позиции. Если match установлено в exact, строки команд должны быть точным совпадением. Наконец, если match установлено в none, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией на удалённом устройстве.
parents
-
Упорядоченный набор родительских элементов, которые однозначно идентифицируют раздел или иерархию, с которыми должны быть проверены команды. Если аргумент parents опущен, команды проверяются с набором команд верхнего уровня или глобальными командами.
replace
-
    Варианты:
  • line ←
  • block
Указывает модулю способ выполнения конфигурации на устройстве. Если replace установлено в line, изменённые строки передаются на устройство в режиме конфигурации. Если replace установлено в block, весь блок команд передаётся на устройство в режиме конфигурации, если какая-либо строка неверна.
save
boolean
    Варианты:
  • no ←
  • yes
Аргумент save сообщает модулю сохранить текущую конфигурацию в сохранённую конфигурацию. Эта операция выполняется после внесения любых изменений в текущую рабочую конфигурацию. Если изменений не внесено, конфигурация всё равно сохраняется в стартовую конфигурацию. Этот параметр всегда приведет к тому, что модуль вернёт значение changed.
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"
    ce_config:
      lines: sysname {{ inventory_hostname }}
      save: yes
      provider: "{{ cli }}"

  - name: "Configure acl configuration and save it"
    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"
    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
    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.
Набор команд, которые будут переданы на удалённое устройство

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


Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • 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.9/modules/ce_config_module.html

Spec-Zone.ru

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