Spec-Zone.ru › Ansible 2.4

junos_config - Управление конфигурацией на устройствах с Juniper JUNOS

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

  • Обзор
  • Требования (к хосту, на котором выполняется модуль)
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Примечания
    • Статус
    • Информация о техническом обслуживании

Обзор

  • Этот модуль реализует работу с активной конфигурацией на устройствах Juniper JUNOS. Он предоставляет набор аргументов для загрузки конфигурации, выполнения операций отката и сброса активной конфигурации на устройстве.

Требования (к хосту, на котором выполняется модуль)

  • ncclient (>=v0.5.2)

Параметры

параметр обязательно по умолчанию варианты комментарии
backup
(добавлен в 2.2)
нет
  • да
  • нет
Этот аргумент заставит модуль создать полную резервную копию текущей running-config с удаленного устройства перед внесением каких-либо изменений. Файл резервной копии записывается в папку backup в корневой директории плейбука. Если папка не существует, она создается.
comment
нет настраивается junos_config
Аргумент comment указывает текстовую строку, которая будет использоваться при подтверждении конфигурации. Если аргумент confirm установлен в False, этот аргумент будет проигнорирован.
confirm
нет
Аргумент confirm настраивает значение таймаута для подтверждения коммита перед его автоматическим откатом. Если аргумент confirm установлен в False, этот аргумент будет проигнорирован. Если значение этого аргумента установлено в 0, коммит подтверждается немедленно.
confirm_commit
(добавлен в 2.4)
нет
  • да
  • нет
Этот аргумент выполнит операцию коммита на удаленном устройстве. Он может использоваться для подтверждения предыдущего коммита.
lines
нет
Этот аргумент принимает список строк конфигурации set или delete для передачи на удаленное устройство. Каждая строка должна начинаться с set или delete. Этот аргумент несовместим с аргументом src.
provider
нет
Объект словаря, содержащий данные подключения.
Объект словаря provider
параметр обязательно по умолчанию варианты комментарии
username
нет
Устанавливает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации SSH-сессии. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME.
host
да
Указывает имя DNS хоста или адрес для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве целевого адреса для транспорта.
ssh_keyfile
нет
Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это путь к ключу, используемому для аутентификации SSH-сессии. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE.
timeout
нет 10
Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истекает до завершения операции, модуль вернет ошибку.
password
нет
Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации SSH-сессии. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD.
port
нет 22
Указывает порт для подключения к удаленному устройству. Значение порта по умолчанию — 22 (для transport=cli) или 830 (для transport=netconf) устройства.
replace
нет
  • да
  • нет
Аргумент replace указывает удаленному устройству заменить текущую иерархию конфигурации на иерархию, указанную в соответствующей иерархии исходной конфигурации, загруженной из этого модуля.
Обратите внимание, что этот аргумент следует считать устаревшим. Для достижения эквивалента установите аргумент update в replace. Этот аргумент будет удален в будущей версии. Аргументы replace и update взаимоисключающие.
rollback
нет
Аргумент rollback указывает модулю откатить текущую конфигурацию до идентификатора, указанного в аргументе. Если указанный идентификатор отката не существует на удаленном устройстве, модуль завершится с ошибкой. Чтобы откатиться до последнего коммита, установите аргумент rollback в 0.
src
(добавлен в 2.2)
нет
Аргумент src предоставляет путь к файлу конфигурации для загрузки на удаленную систему. Путь может быть полным системным путем к файлу конфигурации, если значение начинается с /, или относительным к корню реализованного роли или плейбука. Этот аргумент несовместим с аргументом lines.
src_format
(добавлен в 2.2)
нет
  • xml
  • set
  • text
  • json
Аргумент src_format указывает формат конфигурации, найденной в src. Если аргумент src_format не указан, модуль попытается определить формат файла конфигурации, указанного в src.
update
(добавлен в 2.3)
нет merge
  • merge
  • override
  • replace
Этот аргумент определяет способ загрузки данных конфигурации, особенно когда кандидатская конфигурация и загруженная конфигурация содержат противоречивые утверждения. Ниже приведены допустимые значения. merge объединяет данные в загруженной конфигурации с кандидатской конфигурацией. Если утверждения в загруженной конфигурации противоречат утверждениям в кандидатской конфигурации, загруженные утверждения заменяют кандидатские. override отбрасывает всю кандидатскую конфигурацию и заменяет ее загруженной конфигурацией. replace заменяет каждый уровень иерархии в загруженной конфигурации соответствующим уровнем.
zeroize
нет
Аргумент zeroize используется для полного очистки конфигурации удаленного устройства до начальных значений по умолчанию. Этот аргумент эффективно удаляет все текущие утверждения конфигурации на удаленном устройстве.

Примеры

- name: load configure file into device
  junos_config:
    src: srx.cfg
    comment: update config
    provider: "{{ netconf }}"

- name: load configure lines into device
  junos_config:
    lines:
      - set interfaces ge-0/0/1 unit 0 description "Test interface"
      - set vlans vlan01 description "Test vlan"
    comment: update config
    provider: "{{ netconf }}"

- name: rollback the configuration to id 10
  junos_config:
    rollback: 10
    provider: "{{ netconf }}"

- name: zero out the current configuration
  junos_config:
    zeroize: yes
    provider: "{{ netconf }}"

- name: confirm a previous commit
  junos_config:
    confirm_commit: yes
    provider: "{{ netconf }}"

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

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

имя описание возвращается тип пример
backup_path
Полный путь к файлу резервной копии
при backup = да строка /playbooks/ansible/backup/config.2016-07-16@22:28:34

Примечания

Примечание

  • Для работы этого модуля требуется включенная служба netconf на удаленном управляемом устройстве.
  • Загрузка конфигурации в формате JSON (json) поддерживается начиная с Junos OS Release 16.1.
  • Тестировалось на vSRX JUNOS версии 15.1X49-D15.4, vqfx-10000 JUNOS версии 15.1X53-D60.4.

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратную совместимость.

Информация о техническом обслуживании

Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

Для получения помощи в разработке модулей ознакомьтесь с Информация о сообществе и участие в разработке, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/junos_config_module.html

Spec-Zone.ru

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