eos_interface - Управление интерфейсами на устройствах Arista EOS
Новая версия 2.5.
Обзор
- Этот модуль предоставляет декларативное управление интерфейсами на устройствах Arista EOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate | Список определений интерфейсов. Каждая запись в списке aggregate должна определять имя интерфейса name и другие необходимые параметры. | ||
| auth_pass | По умолчанию: none | Устаревшее Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes с become_pass. Этот параметр требуется только при использовании eAPI. Для получения дополнительной информации см. руководство EOS Platform Options. Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, этот параметр не используется. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| authorize |
| Устаревшее Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes. Этот параметр требуется только при использовании eAPI. Для получения дополнительной информации см. руководство EOS Platform Options. Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед выполнением любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| delay | По умолчанию: 10 | Время ожидания в секундах перед проверкой операционного состояния на удалённом устройстве. Это ожидание применимо к параметру операционного состояния state со значениями up/down, tx_rate и rx_rate. | |
| description | Описание интерфейса до 240 символов. | ||
| enabled | По умолчанию: yes | Статус подключения интерфейса. Если значение True, состояние интерфейса включено, в противном случае (значение False) интерфейс будет в отключённом (выключенном) состоянии. | |
| mtu | Устанавливает максимальный размер единицы передачи (MTU) в байтах для передаваемого пакета интерфейса, указанного в параметре name. | ||
| name обязательно | Имя интерфейса для конфигурации на удаленном устройстве. Имя интерфейса должно быть в развернутой форме, а не сокращённым. | ||
| neighbors | Проверка операционного состояния заданного интерфейса name для соседа LLDP.Доступны следующие подпараметры. | ||
| host | Хост соседа LLDP для данного интерфейса name. | ||
| port | Порт соседа LLDP, к которому подключен данный интерфейс name. | ||
| provider | По умолчанию: None | Устаревшее Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр требуется только при использовании eAPI. Для получения дополнительной информации см. руководство EOS Platform Options. Объект словаря, содержащий данные подключения. | |
| username | Устанавливает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации eAPI в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| authorize |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| ssh_keyfile | Указывает файл SSH-ключа для аутентификации подключения к удаленному устройству. Этот параметр используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| use_proxy (добавлено в 2.5) |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| auth_pass | По умолчанию: none | Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, этот параметр не используется. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| timeout | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку. | |
| use_ssl |
| Настраивает transport для использования SSL, если установлено значение true, только когда transport=eapi. Если параметр transport не eapi, это значение игнорируется. | |
| password | По умолчанию: None | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий параметр, используемый для транспортов cli или eapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | |
| validate_certs |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых пользователем сайтах, использующих самозаверяющие сертификаты. Если параметр transport не eapi, это значение игнорируется. | |
| port | По умолчанию: 0 (использовать общий порт) | Указывает порт для подключения к удалённому устройству. Это значение относится к cli или eapi. Значение порта по умолчанию соответствует общему порту для соответствующего транспорта, если он не указан в задаче (cli=22, http=80, https=443). | |
| transport обязательно |
| Настраивает транспортное подключение для подключения к удалённому устройству. | |
| rx_rate | Скорость приёма в битах в секунду (бит/с) для интерфейса, указанного в параметре name. Это параметр проверки состояния только. Поддерживает условные выражения, см. Условные выражения в сетевых модулях
| ||
| speed | Этот параметр настраивает autoneg и скорость/дуплекс/flowcontrol для интерфейса, указанного в параметре name. | ||
| state |
| Состояние конфигурации интерфейса, up означает присутствие и оперативное включение, а down означает присутствие и оперативное down.
| |
| tx_rate | Скорость передачи в битах в секунду (бит/с) для интерфейса, указанного в параметре name. Это параметр проверки состояния только. Поддерживает условные выражения, см. Условные выражения в сетевых модулях
| ||
Примечания
Примечание
- Проверено на EOS 4.15
- Сведения об использовании командной строки, eAPI и привилегированного режима см. в руководстве Параметры платформы EOS
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Руководство по сети Ansible
- Дополнительную информацию об использовании Ansible для управления устройствами Arista EOS см. на странице интеграции Arista.
Примеры
- name: configure interface
eos_interface:
name: ethernet1
description: test-interface
speed: 100full
mtu: 512
- name: remove interface
eos_interface:
name: ethernet1
state: absent
- name: make interface up
eos_interface:
name: ethernet1
enabled: True
- name: make interface down
eos_interface:
name: ethernet1
enabled: False
- name: Check intent arguments
eos_interface:
name: ethernet1
state: up
tx_rate: ge(0)
rx_rate: le(0)
- name: Check neighbors intent arguments
eos_interface:
name: ethernet1
neighbors:
- port: eth0
host: netdev
- name: Configure interface in disabled state and check if the operational state is disabled or not
eos_interface:
name: ethernet1
enabled: False
state: down
- name: Add interface using aggregate
eos_interface:
aggregate:
- { name: ethernet1, mtu: 256, description: test-interface-1 }
- { name: ethernet2, mtu: 516, description: test-interface-2 }
speed: 100full
state: present
- name: Delete interface using aggregate
eos_interface:
aggregate:
- name: loopback9
- name: loopback10
state: absent
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список | всегда, за исключением платформ, использующих транспорт Netconf для управления устройством. | Список команд режима конфигурации для отправки устройству. Пример: ['interface ethernet1', 'description test-interface', 'speed 100full', 'mtu 512'] |
Статус
Этот модуль помечен как превью, что означает, что интерфейс не гарантируется как обратный.
Поддержка
Дополнительную информацию о поддержке данного модуля 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/eos_interface_module.html