vyos_interface — Управление интерфейсами на устройствах VyOS

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

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

Описание

Этот модуль обеспечивает декларативное управление интерфейсами на устройствах VyOS.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
aggregate			Список определений интерфейсов.
delay		По умолчанию: 10	Время в секундах ожидания проверки оперативного состояния на удалённом устройстве. Это ожидание применяется к аргументу оперативного состояния, которые являются state со значениями `up`/`down` и neighbors.
description			Описание интерфейса.
duplex		Варианты: full half auto ←	Статус соединения интерфейса.
enabled			Статус соединения интерфейса.
mtu			Максимальный размер передаваемого пакета.
name обязательно			Имя интерфейса.
neighbors (добавлено в 2.5)			Проверка оперативного состояния заданного интерфейса `name` для соседа LLDP. Доступны следующие параметры.
	host		Хост соседа LLDP для данного интерфейса `name`.
	port		Порт соседа LLDP, к которому подключён данный интерфейс `name`.
provider		По умолчанию: None	Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Для получения дополнительной информации см. Руководство по сетям. Объект словаря, содержащий данные соединения.
	username		Настройка имени пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_USERNAME`.
	host обязательно		Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве целевого адреса для транспорта.
	ssh_keyfile		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout	По умолчанию: 10	Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истечёт до завершения операции, модуль выдаст ошибку.
	password	По умолчанию: None	Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	port	По умолчанию: 22	Указывает порт, используемый при создании соединения с удалённым устройством.
speed			Скорость интерфейса.
state		Варианты: present ← absent up down	Состояние конфигурации интерфейса, `up` означает присутствие и оперативное включение, а `down` означает присутствие и оперативное состояние `down`

Примечания

Примечание

Проверено на VYOS 1.1.7
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сетям Ansible

Примеры

- name: configure interface
  vyos_interface:
    name: eth0
    description: test-interface

- name: remove interface
  vyos_interface:
    name: eth0
    state: absent

- name: make interface down
  vyos_interface:
    name: eth0
    enabled: False

- name: make interface up
  vyos_interface:
    name: eth0
    enabled: True

- name: Configure interface speed, mtu, duplex
  vyos_interface:
    name: eth5
    state: present
    speed: 100
    mtu: 256
    duplex: full

- name: Set interface using aggregate
  vyos_interface:
    aggregate:
      - { name: eth1, description: test-interface-1,  speed: 100, duplex: half, mtu: 512}
      - { name: eth2, description: test-interface-2,  speed: 1000, duplex: full, mtu: 256}

- name: Disable interface on aggregate
  net_interface:
    aggregate:
      - name: eth1
      - name: eth2
    enabled: False

- name: Delete interface using aggregate
  net_interface:
    aggregate:
      - name: eth1
      - name: eth2
    state: absent

- name: Check lldp neighbors intent arguments
  vyos_interface:
    name: eth0
    neighbors:
    - port: eth0
      host: netdev

- name: Config + intent
  vyos_interface:
    name: eth1
    enabled: False
    state: down

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

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

Ключ	Возвращаемое значение	Описание
commands список	всегда, за исключением платформ, использующих транспорт Netconf для управления устройством.	Список команд режима конфигурации для отправки на устройство Пример: ['set interfaces ethernet eth0 description "test-interface"', 'set interfaces ethernet eth0 speed 100', 'set interfaces ethernet eth0 mtu 256', 'set interfaces ethernet eth0 duplex full']

Статус

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

Поддержка

Дополнительную информацию о поддержке этого модуля 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.5/modules/vyos_interface_module.html