sros_config – Управление конфигурацией устройства Nokia SR OS
Обзор
- Конфигурации Nokia SR OS используют простой синтаксис блочного отступа для разделения конфигурации на секции. Этот модуль предоставляет реализацию для работы с секциями конфигурации SR OS детерминированным способом.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| after - | Упорядоченный набор команд, которые нужно добавить в конец стека команд, если требуется внести изменения. Аналогично параметру before, это позволяет разработчику сценария добавить набор команд, которые должны быть выполнены после исходного набора. | ||
| backup boolean |
| Этот аргумент заставит модуль создать полную резервную копию текущей running-config с удаленного устройства перед внесением каких-либо изменений. Если значение backup_options не задано, файл резервной копии записывается в папку backup в корневом каталоге сценария. Если папки нет, она создается. | |
| backup_options dictionary добавлено в 2.8 | Это объект типа dict, содержащий настраиваемые параметры, относящиеся к пути к файлу резервной копии. Значение этого параметра читается только тогда, когда backup установлено в yes, если backup установлено в no, этот параметр будет проигнорирован. | ||
| dir_path path | Этот параметр указывает путь, заканчивающийся именем каталога, в котором будет храниться файл резервной копии конфигурации. Если каталога не существует, он будет сначала создан, а имя файла будет либо значением filename, либо значением по умолчанию, как описано в описании параметров filename. Если путь не задан, в этом случае будет создана папка backup в текущем рабочем каталоге, и резервная копия конфигурации будет скопирована в filename внутри папки backup. | ||
| filename - | Имя файла, используемое для хранения резервной копии конфигурации. Если имя файла не задано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <имя_хоста>_config.<дата>@<время>. | ||
| before - | Упорядоченный набор команд для добавления в стек команд, если необходимо внести изменения. Это позволяет разработчику сценария выполнить команды конфигурации до внесения каких-либо изменений, не влияя на то, как набор команд сопоставляется с системой. | ||
| config - | Аргумент config позволяет разработчику сценария предоставить базовую конфигурацию для проверки необходимых изменений конфигурации. Если этот аргумент предоставлен, модуль не загрузит running-config с удаленного узла. | ||
| defaults boolean |
| Этот аргумент определяет, собирать ли все значения по умолчанию при получении running-config удаленного устройства. При включении модуль получит текущую конфигурацию, выполнив команду admin display-config detail. псевдонимы: detail | |
| force boolean |
| Аргумент force указывает модулю не учитывать текущую running-config устройства. При установке в значение true, это заставит модуль передать содержимое src на устройство, не проверяя, уже ли оно настроено. Обратите внимание, что этот аргумент следует считать устаревшим. Для достижения эквивалентного результата установите match=none, которое является идемпотентным. Этот аргумент будет удален в будущих релизах. | |
| lines - | Упорядоченный набор команд, которые должны быть настроены в секции. Команды должны быть идентичны командам, найденным в running-config устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются парсером конфигурации устройства. Аргумент lines поддерживает только текущие строки контекста. См. ПРИМЕРЫ. псевдонимы: commands | ||
| match - |
| Указывает модулю способ сравнения набора команд с текущей конфигурацией устройства. Если match установлен в line, команды сравниваются по строкам. Если match установлен в none, модуль не будет пытаться сравнивать исходную конфигурацию с текущей конфигурацией на удаленном устройстве. | |
| parents - | Упорядоченный набор родительских элементов, которые однозначно определяют секцию или иерархию, с которой должны сравниваться команды. Если аргумент parents опущен, команды сравниваются с набором команд верхнего уровня или глобальных команд. | ||
| provider dictionary | Объект типа dict, содержащий данные подключения. | ||
| host string / обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password string | Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port integer | Значение по умолчанию: 22 | Указывает порт для создания соединения с удаленным устройством. | |
| ssh_keyfile path | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout integer | Значение по умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку. | |
| username string | Устанавливает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| replace - |
| Указывает модулю способ выполнения конфигурации на устройстве. Если параметр replace установлен в line, измененные строки передаются на устройство в режиме конфигурации. Если replace установлен в block, весь блок команд передается на устройство в режиме конфигурации, если какая-либо строка некорректна. | |
| save boolean |
| Аргумент save указывает модулю сохранить running-config в startup-config по завершении работы модуля. Если указан режим проверки, этот аргумент игнорируется. | |
| src - | Указывает исходный путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путем на хосте Ansible или относительным путем от корня playbook или роли. Этот аргумент взаимоисключающий с lines, parents. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами сети Nokia SR OS см. на странице https://www.ansible.com/ansible-nokia.
Примеры
# Note: examples below use the following provider dict to handle
# transport and authentication to the node.
---
vars:
cli:
host: "{{ inventory_hostname }}"
username: admin
password: admin
transport: cli
---
- name: enable rollback location
sros_config:
lines: configure system rollback rollback-location "cf3:/ansible"
provider: "{{ cli }}"
- name: set system name to {{ inventory_hostname }} using one line
sros_config:
lines:
- configure system name "{{ inventory_hostname }}"
provider: "{{ cli }}"
- name: set system name to {{ inventory_hostname }} using parents
sros_config:
lines:
- 'name "{{ inventory_hostname }}"'
parents:
- configure
- system
provider: "{{ cli }}"
backup: yes
- name: load config from file
sros_config:
src: "{{ inventory_hostname }}.cfg"
provider: "{{ cli }}"
save: yes
- name: invalid use of lines
sros_config:
lines:
- service
- vpls 1000 customer foo 1 create
- description "invalid lines example"
provider: "{{ cli }}"
- name: valid use of lines
sros_config:
lines:
- description "invalid lines example"
parents:
- service
- vpls 1000 customer foo 1 create
provider: "{{ cli }}"
- name: configurable backup path
sros_config:
backup: yes
backup_options:
filename: backup.cfg
dir_path: /home/user
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| backup_path строка | при backup = yes | Полный путь к файлу резервной копии Пример: /playbooks/ansible/backup/sros_config.2016-07-16@22:28:34 |
| commands список | всегда | Набор команд, которые будут отправлены на удалённое устройство Пример: ['config system name "sros01"'] |
| updates список | всегда | Набор команд, которые будут отправлены на удалённое устройство Пример: ['config system name "sros01"'] |
Статус
- Данному модулю не гарантируется обратная совместимость. [предварительная версия]
- Этот модуль поддерживается партнером Ansible. [сертифицированный]
Авторы
- Peter Sprygada (@privateip)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/sros_config_module.html