eos_static_route – Управление статическими маршрутами IP на устройствах Arista EOS
Новая версия 2.5.
Описание
- Этот модуль предоставляет декларативное управление статическими маршрутами IP на устройствах Arista EOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| address - / обязательно | Сеть адресов с префиксом статического маршрута. псевдонимы: prefix | ||
| admin_distance - | По умолчанию: 1 | Административная дистанция статического маршрута. | |
| aggregate - | Список определений статических маршрутов | ||
| auth_pass строка | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes с become_pass. Этот параметр необходим только при использовании eAPI. Для получения дополнительной информации см. руководство EOS Platform Options. Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, вместо него используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое значение |
| Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes.Этот параметр необходим только при использовании eAPI. Для получения дополнительной информации см. руководство EOS Platform Options. Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| next_hop - / обязательно | Следующий IP-хост статического маршрута. | ||
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр необходим только при использовании eAPI. Для получения дополнительной информации см. руководство EOS Platform Options. Объект словаря, содержащий сведения о подключении. | ||
| auth_pass строка | Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, вместо него используется значение переменной окружения 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 целое число | По умолчанию: 10 | Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут истек до завершения операции, модуль вернет ошибку. | |
| transport строка / обязательно |
| Настройка транспортного подключения для подключения к удаленному устройству. | |
| use_proxy логическое значение добавлено в 2.5 |
| Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. | |
| use_ssl логическое значение |
| Настройка транспорта transport для использования SSL, если установлено значение yes, только когда transport=eapi. Если параметр транспорта не eapi, это значение игнорируется. | |
| username строка | Указывает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации eAPI в зависимости от используемого транспорта. Если значение не указано в задаче, вместо него используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs логическое значение |
| Если no, сертификаты SSL не будут проверяться. Это следует использовать только на контролируемых лично сайтах, использующих самозаверяющие сертификаты. Если параметр транспорта не eapi, это значение игнорируется. | |
| state - |
| Состояние конфигурации статического маршрута. | |
Примечания
Примечание
- Проверено на EOS 4.15
- Дополнительная информация о работе с CLI, eAPI и привилегированным режимом содержится в Руководстве по параметрам платформы EOS
- Дополнительная информация о работе с Ansible для управления сетевыми устройствами приведена в Руководстве по сети Ansible
- Для получения дополнительной информации о работе с Ansible для управления устройствами Arista EOS, ознакомьтесь со страницей интеграции Arista здесь.
Примеры
- name: configure static route
eos_static_route:
address: 10.0.2.0/24
next_hop: 10.8.38.1
admin_distance: 2
- name: delete static route
eos_static_route:
address: 10.0.2.0/24
next_hop: 10.8.38.1
state: absent
- name: configure static routes using aggregate
eos_static_route:
aggregate:
- { address: 10.0.1.0/24, next_hop: 10.8.38.1 }
- { address: 10.0.3.0/24, next_hop: 10.8.38.1 }
- name: Delete static route using aggregate
eos_static_route:
aggregate:
- { address: 10.0.1.0/24, next_hop: 10.8.38.1 }
- { address: 10.0.3.0/24, next_hop: 10.8.38.1 }
state: absent
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands list | всегда | Список команд режима конфигурации для отправки устройству Пример: ['ip route 10.0.2.0/24 10.8.38.1 3', 'no ip route 10.0.2.0/24 10.8.38.1'] |
Статус
- Гарантия обратной совместимости этого модуля не предоставляется. [превью]
- Этот модуль поддерживается командой Ansible Network Team. [сеть]
Поддержка Red Hat
Дополнительная информация о поддержке этого модуля компанией Red Hat доступна в этой статье базы знаний Red Hat.
Авторы
- Trishna Guha (@trishnaguha)
Подсказка
Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/eos_static_route_module.html
