junos_vlan - Управление VLAN на сетевых устройствах Juniper JUNOS

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

Описание
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Поддержка
- Автор

Описание

Этот модуль обеспечивает декларативное управление VLAN на сетевых устройствах Juniper JUNOS.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

ncclient (>=v0.5.2)

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
active bool		Варианты: no yes ←	Указывает, активна или деактивирована конфигурация.
aggregate			Список определений VLAN.
description			Текстовое описание VLAN.
interfaces			Список интерфейсов, для проверки правильной настройки VLAN.
name обязательно			Имя VLAN.
provider			Устаревшее Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli` или `connection: netconf`. Для получения дополнительной информации, пожалуйста, обратитесь к руководству Junos OS Platform Options. Объект словаря, содержащий данные подключения.
	host обязательно		Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта.
	port	По умолчанию: 22	Указывает порт для подключения к удаленному устройству. Значение порта по умолчанию равно общеизвестному порту SSH 22 (для `transport=cli`) или порту 830 (для `transport=netconf`) устройства.
	username		Устанавливает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
	password		Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	timeout	По умолчанию: 10	Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль вернет ошибку.
	ssh_keyfile		Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
state		Варианты: present ← absent	Состояние конфигурации VLAN.
vlan_id обязательно			Идентификатор VLAN. Диапазон 1-4094.

Примечания

Примечание

Данному модулю требуется включенная служба netconf на управляемом удаленном устройстве.
Тестировалось на vSRX JUNOS версии 15.1X49-D15.4, vqfx-10000 JUNOS версии 15.1X53-D60.4.
Рекомендуемое подключение — netconf. См. параметры платформы JUNOS OS.
Этот модуль также работает с подключениями local для устаревших playbooks.
Справочная информация по использованию CLI и netconf — в руководстве по параметрам платформы Junos OS
Дополнительная информация по использованию Ansible для управления сетевыми устройствами — в руководстве по сетям Ansible
Дополнительная информация по использованию Ansible для управления сетевыми устройствами Juniper — в https://www.ansible.com/ansible-juniper.

Примеры

- name: configure VLAN ID and name
  junos_vlan:
    vlan_name: test
    vlan_id: 20
    name: test-vlan

- name: remove VLAN configuration
  junos_vlan:
    vlan_name: test
    state: absent

- name: deactive VLAN configuration
  junos_vlan:
    vlan_name: test
    state: present
    active: False

- name: activate VLAN configuration
  junos_vlan:
    vlan_name: test
    state: present
    active: True

- name: Create vlan configuration using aggregate
  junos_vlan:
    aggregate:
      - { vlan_id: 159, name: test_vlan_1, description: test vlan-1 }
      - { vlan_id: 160, name: test_vlan_2, description: test vlan-2 }

- name: Delete vlan configuration using aggregate
  junos_vlan:
    aggregate:
      - { vlan_id: 159, name: test_vlan_1 }
      - { vlan_id: 160, name: test_vlan_2 }
    state: absent

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

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

Ключ	Возвращаемое значение	Описание
diff.prepared строка	при изменении конфигурации и включении опции diff.	Разница в конфигурации до и после внесения изменений. Пример: [edit vlans] + test-vlan-1 { + vlan-id 60; + }

Статус

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

Техническое обслуживание

Этот модуль помечен как сетевой, что означает, что его поддерживает команда Ansible по сетям. Подробнее см. Техническое обслуживание и поддержка модулей.

Список других модулей, также поддерживаемых командой Ansible по сетям, см. в этом разделе.

Поддержка

Дополнительную информацию о поддержке этого модуля Red Hat см. в этой статье базы знаний.

Автор

Ganesh Nalawade (@ganeshrn)

Подсказка

Если вы заметили какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.

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