arista.eos.eos_interface – (deprecated, removed after 2022-06-01) Управление интерфейсом на устройствах Arista EOS
Примечание
Этот плагин входит в коллекцию arista.eos (версия 1.2.0).
Для его установки используйте: ansible-galaxy collection install arista.eos.
Для использования в playbook, укажите: arista.eos.eos_interface.
Введено в версии 1.0.0: of arista.eos
УСТАНОВЛЕНО
- Удалино в
-
главном выпуске после 2022-06-01
- Почему
-
Выпущены обновленные модули с большей функциональностью
- Альтернатива
-
eos_interfaces
Описание
- Этот модуль предоставляет декларативное управление интерфейсами на устройствах Arista EOS.
Примечание
У этого модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| aggregate список / элементы=словарь | Список определений интерфейсов. Каждый элемент в списке aggregate должен определять имя интерфейса name и другие необходимые параметры. | |||
| 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. | |||
| rx_rate строка | Скорость приёма в битах в секунду (бит/с) для интерфейса, указанного в параметре name. Этот параметр предназначен только для проверки состояния. Поддерживает условные выражения, см. Условные выражения в модулях сетевых операций
| |||
| speed строка | Этот параметр настраивает autoneg и скорость/дуплекс/управление потоком для интерфейса, указанного в параметре name. | |||
| state строка |
| Состояние конфигурации интерфейса. up означает наличие и работоспособность, а down означает наличие и оперативно down.
| ||
| tx_rate строка | Скорость передачи в битах в секунду (бит/с) для интерфейса, указанного в параметре name. Этот параметр предназначен только для проверки состояния. Поддерживает условные выражения, см. Условные выражения в модулях сетевых операций
| |||
| 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. Начиная с Ansible 2.6, рекомендуется использовать connection: httpapi для eAPI.Этот параметр будет удалён в релизе после 2022-06-01. Для получения дополнительной информации см. руководство 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 булево |
| Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. | ||
| use_ssl булево |
| Настраивает transport для использования SSL, если установлено yes только при transport=eapi. Если аргумент transport не eapi, это значение игнорируется. | ||
| username строка | Настраивает имя пользователя для аутентификации соединения с удалённым устройством. Это значение используется для аутентификации входа в CLI или аутентификации eAPI в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | |||
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверенных сертификатов. Если аргумент transport не равен eapi, это значение игнорируется. | ||
| rx_rate string | Скорость приема в битах в секунду (bps) для интерфейса, указанного в опции name. Этот параметр предназначен только для проверки состояния. Поддерживает условные выражения, см. Условные выражения в модулях сети
| |||
| speed string | Этот параметр настраивает autoneg и скорость/дуплекс/flowcontrol для интерфейса, указанного в опции name. | |||
| state string |
| Состояние конфигурации интерфейса, up означает присутствие и операционную активность, а down означает присутствие и операционную down
| ||
| tx_rate string | Скорость передачи в битах в секунду (bps) для интерфейса, указанного в опции name. Этот параметр предназначен только для проверки состояния. Поддерживает условные выражения, см. Условные выражения в модулях сети
| |||
Примечания
Примечание
- Тестировано на EOS 4.15
- Для получения информации об использовании CLI, eAPI и привилегированного режима см. руководство EOS Platform Options
- Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. Руководство по сетям Ansible
- Для получения дополнительной информации об использовании Ansible для управления устройствами Arista EOS см. страницу интеграции Arista.
Примеры
- name: configure interface
arista.eos.eos_interface:
name: ethernet1
description: test-interface
speed: 100full
mtu: 512
- name: remove interface
arista.eos.eos_interface:
name: ethernet1
state: absent
- name: make interface up
arista.eos.eos_interface:
name: ethernet1
enabled: true
- name: make interface down
arista.eos.eos_interface:
name: ethernet1
enabled: false
- name: Check intent arguments
arista.eos.eos_interface:
name: ethernet1
state: up
tx_rate: ge(0)
rx_rate: le(0)
- name: Check neighbors intent arguments
arista.eos.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
arista.eos.eos_interface:
name: ethernet1
enabled: false
state: down
- name: Add interface using aggregate
arista.eos.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
arista.eos.eos_interface:
aggregate:
- name: loopback9
- name: loopback10
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны в этом разделе. Следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список / элементы=строка | всегда, за исключением платформ, которые используют транспорт Netconf для управления устройством. | Список команд режима конфигурации, которые необходимо отправить устройству. Пример: ['interface ethernet1', 'description test-interface', 'speed 100full', 'mtu 512'] |
Статус
- Этот модуль будет удалён в основной версии после 2022-06-01. [устарел]
- Для получения дополнительной информации см. УСТАРЕВШИЙ.
Авторы
- 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.10/collections/arista/eos/eos_interface_module.html