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

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

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

Описание

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

Параметры

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

Статус

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

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

Этот модуль помечен как сетевой, что означает, что его обслуживает команда по разработке сетевых модулей 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/vyos_interface_module.html