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 -			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Дополнительную информацию см. в Руководстве по сети. Объект словаря, содержащий данные соединения.
	host - / требуется		Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	password -		Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него используется значение переменной среды `ANSIBLE_NET_PASSWORD`.
	port -	По умолчанию: 22	Указывает порт для создания подключения к удаленному устройству.
	ssh_keyfile -		Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него используется значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout -	По умолчанию: 10	Указывает таймаут в секундах для взаимодействия с сетевым устройством при подключении или отправке команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку.
	username -		Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него используется значение переменной среды `ANSIBLE_NET_USERNAME`.
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 Network. [сеть]

Поддержка Red Hat

Дополнительную информацию о поддержке этого модуля Red Hat см. в этой статье базы знаний 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.7/modules/vyos_interface_module.html