vyos_interface – Управление интерфейсами на устройствах VyOS
Новая версия 2.4.
УСТЕРЕГШИЙСЯ
| Удалено в Ansible: | |
|---|---|
| версия: 2.13 | |
| Почему: | Выпущены обновленные модули с большей функциональностью. |
| Альтернатива: | vyos_interfaces |
Синопсис
- Этот модуль предоставляет декларативное управление интерфейсами на устройствах VyOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate - | Список определений интерфейсов. | ||
| delay - | По умолчанию: 10 | Время в секундах, которое необходимо подождать перед проверкой операционного состояния на удалённом устройстве. Это ожидание применимо к аргументу операционного состояния, который имеет значения up/down и neighbors. | |
| description - | Описание интерфейса. | ||
| duplex - |
| Статус подключения интерфейса. | |
| enabled boolean |
| Статус подключения интерфейса. | |
| 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 - |
| Состояние конфигурации интерфейса, 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'] |
Статус
- Этот модуль будет удалён в версии 2.13. [устаревший]
- Для получения дополнительной информации см. УСТЕРЕГШИЙСЯ.
Авторы
- 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.9/modules/vyos_interface_module.html