eos_interface – Управление интерфейсами на устройствах Arista EOS
Новая версия с 2.5.
УСТЕРЕГШЕЕ
| Удалено в Ansible: | |
|---|---|
| версия: 2.13 | |
| Почему: | Выпущены обновленные модули с дополнительными функциями |
| Альтернатива: | eos_interfaces |
Синопсис
- Этот модуль предоставляет декларативное управление интерфейсами на устройствах 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 целое число | Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку. | ||
| 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'] |
Статус
- Этот модуль будет удален в версии 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/eos_interface_module.html