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 boolean |
| Устарело Начиная с 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 - | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр требуется только при использовании eAPI. Для получения дополнительной информации см. руководство EOS Platform Options. Объект словаря, содержащий данные соединения. | ||
| auth_pass - | Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, этот параметр не имеет эффекта. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean |
| Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host - / обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение параметра host используется в качестве адреса назначения для транспорта. | ||
| password - | Указывает пароль для аутентификации подключения к удаленному устройству. Этот параметр обычно используется для транспортов cli или eapi. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port - | Значение по умолчанию: "0 (использовать стандартный порт)" | Указывает порт для подключения к удаленному устройству. Если значение не указано в задаче, будет использован стандартный порт для транспорта (cli=22, http=80, https=443). | |
| ssh_keyfile - | Указывает SSH-ключевой файл для аутентификации подключения к удаленному устройству. Этот параметр используется только для транспортов cli. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout - | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку. | |
| transport - / обязательно |
| Настраивает транспортное соединение для подключения к удаленному устройству. | |
| use_proxy boolean добавлено в 2.5 |
| Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. | |
| use_ssl boolean |
| Настраивает transport для использования SSL, если значение true только тогда, когда transport=eapi. Если параметр transport не eapi, это значение игнорируется. | |
| username - | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации eAPI в зависимости от используемого транспорта. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверяющих сертификатов. Если параметр transport не eapi, это значение игнорируется. | |
| rx_rate - | Скорость приема в битах в секунду (bps) для интерфейса, указанного в параметре name. Этот параметр используется только для проверки состояния. Поддерживает условные выражения, см. Условные выражения в сетевых модулях
| ||
| speed - | Этот параметр настраивает autoneg и скорость/дуплекс/flowcontrol для интерфейса, указанного в параметре 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 Network Team. [сеть]
Поддержка 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/eos_interface_module.html