eos_interface – Управление интерфейсами на устройствах Arista EOS
Новая версия 2.5.
Обзор
- Этот модуль предоставляет декларативное управление интерфейсами на устройствах Arista EOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate - | Список определений интерфейсов. Каждая запись в списке aggregate должна определять имя интерфейса name и другие необходимые параметры. | ||
| auth_pass строка | Устаревший Начиная с 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 логическое значение |
| Статус соединения интерфейса. Если значение True, состояние интерфейса будет включено, иначе, если значение False, интерфейс будет в выключенном (выключен) состоянии. | |
| mtu - | Устанавливает максимальный размер транспортного блока (MTU) в байтах для передающего пакета интерфейса, указанного в параметре name. | ||
| name - / обязательно | Имя интерфейса, которое необходимо настроить на удалённом устройстве. Имя интерфейса должно быть в полном формате, а не сокращённым. | ||
| neighbors - | Проверяет операционное состояние указанного интерфейса name для соседа LLDP.Доступны следующие подпараметры. | ||
| host - | Хост соседа LLDP для данного интерфейса name. | ||
| port - | Порт соседа LLDP, к которому подключён данный интерфейс name. | ||
| provider словарь | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр необходим только при использовании eAPI. Для получения дополнительной информации см. руководство EOS Platform Options. Объект словаря, содержащий данные о подключении. | ||
| auth_pass строка | Указывает пароль, необходимый для входа в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое значение |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host строка / обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение параметра host используется в качестве целевого адреса для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или eapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port целое число | По умолчанию: "0 (использовать общий порт)" | Указывает порт для использования при построении соединения с удалённым устройством. Это значение относится к транспорту cli или eapi. Значение порта по умолчанию соответствует обычному порту транспорта, если не указано в задаче. (cli=22, http=80, https=443). | |
| ssh_keyfile путь | Указывает SSH-ключевой файл для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку. | |
| transport строка / обязательно |
| Настраивает транспортное подключение для подключения к удалённому устройству. | |
| use_proxy логическое значение добавлено в 2.5 |
| Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. | |
| use_ssl логическое значение |
| Настраивает transport для использования SSL, если установлено значение yes, только когда transport=eapi. Если аргумент transport не eapi, это значение игнорируется. | |
| username строка | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа CLI или аутентификации eAPI в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs логическое значение |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверяющих сертификатов. Если аргумент transport не eapi, это значение игнорируется. | |
| rx_rate - | Скорость приёма в битах в секунду (bps) для интерфейса, указанного в параметре name.Это параметр проверки состояния. Поддерживает условные выражения, см. Условные выражения в сетевых модулях | ||
| Скорость - | Этот параметр настраивает autoneg и скорость/дуплекс/управление потоком для интерфейса, указанного в параметре name. | ||
| Состояние - |
| Состояние конфигурации интерфейса. up означает, что интерфейс присутствует и работает, а down означает, что интерфейс присутствует и находится в состоянии down.
| |
| tx_rate - | Скорость передачи данных в битах в секунду (бит/с) для интерфейса, указанного в параметре name. Это только параметр проверки состояния. Поддерживает условные выражения, см. Условные выражения в модулях сети
| ||
Примечания
Примечание
- Проверено на EOS 4.15
- Сведения об использовании CLI, 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
Значения возврата
Общие значения возврата описаны здесь, а следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| команды список | всегда, за исключением платформ, которые используют транспорт Netconf для управления устройством. | Список команд режима конфигурации для отправки на устройство. Пример: ['interface ethernet1', 'description test-interface', 'speed 100full', 'mtu 512'] |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается командой Ansible по работе с сетями. [сеть]
Поддержка 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.8/modules/eos_interface_module.html