Spec-Zone.ru › Ansible

community.network.nos_config модуль — Управление секциями конфигурации Extreme Networks NOS

Примечание

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

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

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

Чтобы использовать её в книге задач, укажите: community.network.nos_config.

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

Обзор

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

Примечание

У этого модуля есть соответствующий плагин действий.

Псевдонимы: network.nos.nos_config

Параметры

Параметр

Комментарии

after

строка

Упорядоченный набор команд, добавляемых в конец стека команд, если требуется внести изменения. Как и в случае с параметром before, это позволяет разработчику playbook добавить набор команд, которые будут выполнены после набора команд.

backup

логическое значение

Этот аргумент заставит модуль создать полную резервную копию текущей running-config с удалённого устройства перед внесением каких-либо изменений. Если значение backup_options не задано, файл резервной копии записывается в папку backup в корневом каталоге playbook. Если папка не существует, она создаётся.

Варианты:

  • false ← (по умолчанию)
  • true

backup_options

словарь

Это объект типа dict, содержащий настраиваемые параметры, связанные с путём к файлу резервной копии. Значение этого параметра читается только тогда, когда backup установлено в yes. Если backup установлено в no, этот параметр будет проигнорирован.

dir_path

путь

Этот параметр задаёт путь, заканчивающийся именем каталога, в котором будет храниться файл резервной копии конфигурации. Если каталог не существует, он будет создан. Имя файла — это либо значение filename, либо имя файла по умолчанию, как описано в параметрах filename. Если путь не задан, в текущей рабочей директории будет создан каталог backup, и резервная копия конфигурации будет скопирована в filename внутри каталога backup.

filename

строка

Имя файла, используемое для хранения резервной копии конфигурации. Если имя файла не задано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <имя_хоста>_config.<дата>@<время>

before

строка

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

diff_against

строка

При использовании аргумента командной строки ansible-playbook --diff модуль может генерировать различия по отношению к различным источникам.

Когда этот параметр настроен как intended, модуль вернёт разницу между текущей конфигурацией и конфигурацией, указанной в аргументе intended_config.

Когда этот параметр настроен как running, модуль вернёт разницу до и после выполнения конфигурации с учётом изменений на устройстве.

Варианты:

  • "running"
  • "intended"

diff_ignore_lines

строка

Используйте этот аргумент, чтобы указать одну или несколько строк, которые следует игнорировать во время сравнения. Это используется для строк в конфигурации, которые автоматически обновляются системой. Этот аргумент принимает список регулярных выражений или точных совпадений строк.

intended_config

строка

intended_config предоставляет основную конфигурацию, которой должен соответствовать узел, и используется для проверки окончательной текущей конфигурации. Этот аргумент не будет изменять настройки на удалённом устройстве и используется исключительно для проверки соответствия текущей конфигурации устройства. При указании этого аргумента необходимо также изменить значение diff_against и установить его в intended.

lines

псевдонимы: commands

строка

Упорядоченный набор команд, которые должны быть настроены в разделе. Команды должны быть абсолютно такими же, как и в текущей конфигурации устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются парсером конфигурации устройства.

match

строка

Указывает модулю способ сравнения набора команд с текущей конфигурацией устройства. Если match установлено в line, команды сравниваются по строкам. Если match установлено в strict, строки команд сравниваются с учётом позиции. Если match установлено в exact, строки команд должны быть идентичными. Если match установлено в none, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией удалённого устройства.

Варианты:

  • "line" ← (по умолчанию)
  • "strict"
  • "exact"
  • "none"

multiline_delimiter

строка

Этот аргумент используется при передаче многострочного элемента конфигурации на устройство NOS. Он указывает символ, используемый в качестве разделителя. Это применимо только к действию конфигурации.

По умолчанию: "@"

parents

строка

Упорядоченный набор родителей, однозначно определяющих раздел или иерархию, с которыми должны сравниваться команды. Если аргумент parents опущен, команды сравниваются с набором команд верхнего уровня или глобальных команд.

replace

строка

Указывает модулю способ выполнения конфигурации на устройстве. Если аргумент replace установлен в line, изменённые строки отправляются на устройство в режиме конфигурации. Если аргумент replace установлен в block, весь блок команд отправляется на устройство в режиме конфигурации, если какая-либо строка некорректна.

Варианты:

  • "line" ← (по умолчанию)
  • "block"

running_config

aliases: config

string

Модуль по умолчанию подключается к удалённому устройству и извлекает текущую конфигурацию running-config, чтобы использовать её как базу для сравнения с содержимым источника. Иногда нежелательно получать текущую running-config для каждой задачи в книге задач. Аргумент running_config позволяет разработчику передать конфигурацию, которая будет использоваться в качестве базовой конфигурации для сравнения.

src

string

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

Примечания

Примечание

  • Тестировано на NOS 7.2.0

Примеры

- name: Configure top level configuration
  community.network.nos_config:
    lines: logging raslog console INFO

- name: Configure interface settings
  community.network.nos_config:
    lines:
      - description test interface
      - ip address 172.31.1.1/24
    parents:
      - interface TenGigabitEthernet 104/0/1

- name: Configure multiple interfaces
  community.network.nos_config:
    lines:
      - lacp timeout long
    parents: "{{ item }}"
  with_items:
    - interface TenGigabitEthernet 104/0/1
    - interface TenGigabitEthernet 104/0/2

- name: Load new acl into device
  community.network.nos_config:
    lines:
      - seq 10 permit ip host 1.1.1.1 any log
      - seq 20 permit ip host 2.2.2.2 any log
      - seq 30 permit ip host 3.3.3.3 any log
      - seq 40 permit ip host 4.4.4.4 any log
      - seq 50 permit ip host 5.5.5.5 any log
    parents: ip access-list extended test
    before: no ip access-list extended test
    match: exact

- name: Check the running-config against master config
  community.network.nos_config:
    diff_against: intended
    intended_config: "{{ lookup('file', 'master.cfg') }}"

- name: Configurable backup path
  community.network.nos_config:
    lines: logging raslog console INFO
    backup: true
    backup_options:
      filename: backup.cfg
      dir_path: /home/user

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

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

Ключ

Описание

backup_path

string

Полный путь к резервной копии файла

Возвращается: при backup = yes

Пример: "/playbooks/ansible/backup/nos_config.2018-02-12@18:26:34"

commands

list / elements=string

Набор команд, которые будут отправлены на удалённое устройство

Возвращается: всегда

Пример: ["switch-attributes hostname foo", "router ospf", "area 0"]

updates

list / elements=string

Набор команд, которые будут отправлены на удалённое устройство

Возвращается: всегда

Пример: ["switch-attributes hostname foo", "router ospf", "area 0"]

Авторы

  • Lindsay Hill (@LindsayHill)

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

  • Система отслеживания ошибок
  • Репозиторий (источники)

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

Spec-Zone.ru

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