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 boolean |
| Устарело Начиная с Ansible 2.5 рекомендуется использовать connection: network_cli и become: yes. Этот параметр необходим только если используется eAPI. Для получения дополнительной информации, см. руководство EOS Platform Options. Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, то используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| ipv4 - | IPv4 адрес, который необходимо установить для интерфейса L3, указанного в параметре name. Формат адреса - <ipv4 адрес>/<маска>, маска - число в диапазоне от 0 до 32, например 192.168.0.1/24. | ||
| ipv6 - | 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. Объект dict, содержащий данные подключения. | ||
| 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 или eapi. Значение порта будет по умолчанию соответствовать стандартному порту для транспорта, если не указано другое в задаче (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, это значение игнорируется. | |
| state - |
| Состояние конфигурации интерфейса L3. Указывает, должна ли конфигурация присутствовать или отсутствовать на удалённом устройстве. | |
Примечания
Примечание
- Тестировано с EOS 4.15
- Информация об использовании CLI, eAPI и привилегированного режима находится в руководстве EOS Platform Options
- Дополнительная информация об использовании Ansible для управления сетевыми устройствами находится в руководстве Ansible Network Guide
- Дополнительная информация об использовании Ansible для управления устройствами Arista EOS находится на странице интеграции Arista: Arista integration page.
Примеры
- 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 interface Vlan1 (SVI) IPv4 address
eos_l3_interface:
name: Vlan1
ipv4: 192.168.0.5/24
- 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'] |
Состояние
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Данный модуль поддерживается командой 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_l3_interface_module.html