eos_l3_interface — Управление интерфейсами L3 на устройствах Arista EOS
Новая версия с 2.5.
Обзор
- Этот модуль предоставляет декларативное управление интерфейсами L3 на устройствах Arista EOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate | Список определений интерфейсов L3. Каждое из записей в списке aggregate должно определять имя интерфейса name и необязательный ipv4 или ipv6 адрес. | ||
| 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. | |
| ipv4 | IP-адрес IPv4, который должен быть задан для интерфейса L3, упомянутого в параметре name. Формат адреса — <ipv4 адрес>/<маска>, маска — число в диапазоне 0-32, например, 192.168.0.1/24. | ||
| ipv6 | IP-адрес IPv6, который должен быть задан для интерфейса L3, упомянутого в параметре name. Формат адреса — <ipv6 адрес>/<маска>, маска — число в диапазоне 0-128, например, fd5d:12c9:2201:1::1/64. | ||
| name | Имя интерфейса L3, который должен быть настроен, например, ethernet1. | ||
| provider | По умолчанию: Нет | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр необходим только если используется eAPI. Для более подробной информации см. руководство EOS Platform Options. Объект словаря, содержащий данные подключения. | |
| username | Указывает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в командную строку или аутентификации 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 | По умолчанию: нет | Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize равен false, этот параметр не влияет. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве целевого адреса для транспорта. | ||
| timeout | По умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания превышено до завершения операции, модуль вернёт ошибку. | |
| use_ssl |
| Устанавливает для транспорта transport использование SSL, если значение равно true только когда transport=eapi. Если параметр transport не равен eapi, это значение игнорируется. | |
| password | По умолчанию: Нет | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий параметр, используемый для транспорта cli или eapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | |
| validate_certs |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых лично сайтах, использующих самозаверяющие сертификаты. Если параметр transport не равен eapi, это значение игнорируется. | |
| port | По умолчанию: 0 (использовать стандартный порт) | Указывает порт для подключения к удаленному устройству. Это значение относится к транспорту cli или eapi. Значение порта по умолчанию будет соответствовать стандартному порту для выбранного транспорта, если в задаче не указано другое значение (cli=22, http=80, https=443). | |
| transport обязательно |
| Настраивает транспортное подключение для подключения к удаленному устройству. | |
| state |
| Состояние конфигурации интерфейса L3. Указывает, должна ли конфигурация присутствовать или отсутствовать на удаленном устройстве. | |
Примечания
Примечание
- Проверено на EOS 4.15
- Информация об использовании командной строки, eAPI и привилегированного режима находится в руководстве EOS Platform Options
- Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. руководство Ansible Network Guide
- Для получения дополнительной информации об использовании Ansible для управления устройствами Arista EOS см. страницу интеграции Arista.
Примеры
- name: Remove ethernet1 IPv4 and IPv6 address
eos_l3_interface:
name: ethernet1
state: absent
- name: Set ethernet1 IPv4 address
eos_l3_interface:
name: ethernet1
ipv4: 192.168.0.1/24
- name: Set ethernet1 IPv6 address
eos_l3_interface:
name: ethernet1
ipv6: "fd5d:12c9:2201:1::1/64"
- name: Set IP addresses on aggregate
eos_l3_interface:
aggregate:
- { name: ethernet1, ipv4: 192.168.2.10/24 }
- { name: ethernet1, ipv4: 192.168.3.10/24, ipv6: "fd5d:12c9:2201:1::1/64" }
- name: Remove IP addresses on aggregate
eos_l3_interface:
aggregate:
- { name: ethernet1, ipv4: 192.168.2.10/24 }
- { name: ethernet1, ipv4: 192.168.3.10/24, ipv6: "fd5d:12c9:2201:1::1/64" }
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны в разделе, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список | всегда, за исключением платформ, которые используют транспорт Netconf для управления устройством. | Список команд режима конфигурации, которые нужно отправить устройству Пример: ['interface ethernet1', 'ip address 192.168.0.1/24', 'ipv6 address fd5d:12c9:2201:1::1/64'] |
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантируется обратной совместимостью.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией 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_l3_interface_module.html
