Модуль community.network.sros_config – Управление конфигурацией устройства Nokia SR OS

Примечание

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

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

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

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

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

Обзор

Конфигурации Nokia SR OS используют простой синтаксис отступов для разделения конфигурации на секции. Данный модуль предоставляет реализацию для работы с секциями конфигурации SR OS детерминированным способом.

Псевдонимы: network.sros.sros_config

Параметры

Параметр	Комментарии
after строка	Упорядоченный набор команд, добавляемых в конец стека команд, если требуется изменение. Так же, как и в случае с before, это позволяет разработчику playbook добавить набор команд, которые будут выполнены после набора команд.
backup логическое значение	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` с удаленного устройства перед внесением каких-либо изменений. Если значение `backup_options` не задано, файл резервной копии записывается в папку `backup` в корневой директории playbook. Если директория не существует, она создается. Варианты: `false` ← (по умолчанию) `true`
backup_options словарь	Это объект типа dict, содержащий настраиваемые параметры, относящиеся к пути к файлу резервной копии. Значение этого параметра читается только тогда, когда `backup` установлено в да, если `backup` установлено в нет, этот параметр будет проигнорирован.
dir_path путь	Этот параметр предоставляет путь, заканчивающийся именем каталога, в котором будет храниться файл конфигурации резервной копии. Если директория не существует, она будет создана, а имя файла — это значение `filename` или имя файла по умолчанию, как описано в `filename` описание параметров. Если значение пути не указано, в текущей рабочей директории будет создана директория backup, и конфигурация резервной копии будет скопирована в `filename` внутри директории backup.
filename строка	Имя файла, которое будет использоваться для хранения резервной копии конфигурации. Если имя файла не указано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <имя_хоста>_config.<дата>@<время>
before строка	Упорядоченный набор команд, которые будут добавлены в стек команд, если необходимо внести изменения. Это позволяет разработчику playbook выполнить команды конфигурации до внесения каких-либо изменений без влияния на то, как набор команд сопоставляется с системой.
config строка	Аргумент `config` позволяет разработчику playbook предоставить базу конфигурации, которая будет использоваться для проверки необходимых изменений конфигурации. Если этот аргумент предоставлен, модуль не будет загружать running-config с удаленного узла.
defaults псевдонимы: detail логическое значение	Этот аргумент указывает, нужно ли собирать все значения по умолчанию при получении running-config удаленного устройства. При включении модуль получит текущую конфигурацию, выполнив команду `admin display-config detail`. Варианты: `false` ← (по умолчанию) `true`
force логическое значение	Аргумент force инструктирует модуль не учитывать текущую конфигурацию устройства. При установке в значение true, это заставит модуль перенести содержимое src на устройство без предварительной проверки, настроено ли оно уже. Обратите внимание, что этот аргумент следует считать устаревшим. Для достижения эквивалентного результата установите `match=none`, который является идемпотентным. Этот аргумент будет удален в будущей версии. Варианты: `false` `true`
lines псевдонимы: commands строка	Упорядоченный набор команд, которые должны быть настроены в разделе. Команды должны быть точно такими же, как и в running-конфигурации устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются анализатором конфигурации устройства. Аргумент lines поддерживает только текущие строки контекста. См. ПРИМЕРЫ.
match строка	Инструктирует модуль о способе сопоставления набора команд с текущей конфигурацией устройства. Если match установлено в line, команды сопоставляются построчно. Если match установлено в none, модуль не будет пытаться сравнить исходную конфигурацию с рабочей конфигурацией на удалённом устройстве. Варианты: `"line"` ← (по умолчанию) `"none"`
parents строка	Упорядоченный набор родителей, которые однозначно идентифицируют раздел или иерархию, с которыми должны быть проверены команды. Если аргумент parents опущен, команды проверяются по отношению к набору команд верхнего уровня или глобальным командам.
replace строка	Инструктирует модуль о способе выполнения конфигурации на устройстве. Если аргумент replace установлен в line, изменённые строки передаются на устройство в режиме конфигурации. Если аргумент replace установлен в block, весь блок команд передаётся на устройство в режиме конфигурации, если какая-либо строка неверна. Варианты: `"line"` ← (по умолчанию) `"block"`
save логическое значение	Аргумент `save` инструктирует модуль сохранить running-конфигурацию в startup-конфигурацию по завершении работы модуля. Если указан режим проверки, этот аргумент игнорируется. Варианты: `false` ← (по умолчанию) `true`

src

string

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

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами сети Nokia SR OS см. на странице https://www.ansible.com/ansible-nokia.

Примеры

---
- name: Enable rollback location
  community.network.sros_config:
    lines: configure system rollback rollback-location "cf3:/ansible"

- name: Set system name to {{ inventory_hostname }} using one line
  community.network.sros_config:
    lines:
        - configure system name "{{ inventory_hostname }}"

- name: Set system name to {{ inventory_hostname }} using parents
  community.network.sros_config:
    lines:
        - 'name "{{ inventory_hostname }}"'
    parents:
        - configure
        - system
    backup: true

- name: Load config from file
  community.network.sros_config:
      src: "{{ inventory_hostname }}.cfg"
      save: true

- name: Invalid use of lines
  community.network.sros_config:
    lines:
      - service
      -     vpls 1000 customer foo 1 create
      -         description "invalid lines example"

- name: Valid use of lines
  community.network.sros_config:
    lines:
      - description "invalid lines example"
    parents:
      - service
      - vpls 1000 customer foo 1 create

- name: Configurable backup path
  community.network.sros_config:
    backup: true
    backup_options:
      filename: backup.cfg
      dir_path: /home/user

Значения возврата

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

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

Авторы

Peter Sprygada (@privateip)

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

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