cisco.nxos.nxos_static_route – (устаревший, удалён после 2022-06-01) Управляет конфигурацией статического маршрута
Примечание
Этот плагин является частью коллекции cisco.nxos (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install cisco.nxos.
Чтобы использовать его в книге задач, укажите: cisco.nxos.nxos_static_route.
Новый в версии 1.0.0: плагина cisco.nxos
УСТАРЕВШИЙ
- Удален в
-
главной версии после 2022-06-01
- Почему
-
Выпущены обновлённые модули с большей функциональностью
- Альтернатива
-
nxos_static_routes
Обзор
- Управляет конфигурацией статических маршрутов
Примечание
У этого модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate список / элементы=словарь | Список определений статических маршрутов | ||
| next_hop строка / обязательно | Адрес или интерфейс следующего узла статического маршрута. Если интерфейс, он должен быть полным именем интерфейса. | ||
| pref строка | Предпочтение или административное различие маршрута (диапазон 1-255) или ключевое слово 'default'. Псевдонимы: admin_distance | ||
| prefix строка / обязательно | Префикс назначения статического маршрута. | ||
| route_name строка | Имя маршрута или ключевое слово 'default'. Используется с параметром имени в командной строке. | ||
| state строка |
| Управление состоянием ресурса. | |
| tag строка | Значение тега маршрута (числовое) или ключевое слово 'default'. | ||
| track целое число | Значение отслеживания (диапазон 1 - 512). Отслеживание должно быть уже настроено на устройстве перед добавлением маршрута. | ||
| vrf строка | VRF для статического маршрута. | ||
| next_hop строка | Адрес или интерфейс следующего узла статического маршрута. Если интерфейс, он должен быть полным именем интерфейса. | ||
| pref строка | Предпочтение или административное различие маршрута (диапазон 1-255) или ключевое слово 'default'. Псевдонимы: admin_distance | ||
| prefix строка | Префикс назначения статического маршрута. Псевдонимы: address | ||
| provider словарь | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Начиная с Ansible 2.6, рекомендуется использовать connection: httpapi для NX-API.Этот параметр будет удален в версии после 2022-06-01. Дополнительную информацию можно найти в руководстве NXOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| auth_pass строка | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если требуется. Если authorize имеет значение false, то этот аргумент ничего не делает. Если значение не указано в задаче, вместо него используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое значение |
| Инструктирует модуль перейти в привилегированный режим на удалённом устройстве перед отправкой каких-либо команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host строка | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, вместо него используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port целое число | Указывает порт для построения подключения к удалённому устройству. Это значение относится как к cli, так и к nxapi. Значение порта по умолчанию будет соответствовать общему порту транспорта, если он не предоставлен в задаче (cli=22, http=80, https=443). | ||
| ssh_keyfile строка | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, вместо него используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку. NX-API может быть медленным при возврате на длительных командах (sh mac, sh bgp и т.д.). | ||
| transport строка |
| Настраивает транспортное соединение для использования при подключении к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_proxy логическое значение |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| use_ssl логическое значение |
| Настраивает transport для использования SSL, если значение равно yes, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username строка | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, вместо него используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs логическое значение |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверяющих сертификатов. Если аргумент transport не nxapi, это значение игнорируется. | |
| route_name строка | Имя маршрута или ключевое слово 'default'. Используется с параметром имени в командной строке. | ||
| state строка |
| Управление состоянием ресурса. | |
| tag строка | Значение тега маршрута (числовое) или ключевое слово 'default'. | ||
| track целое число | Значение отслеживания (диапазон 1 - 512). Отслеживание должно быть уже настроено на устройстве перед добавлением маршрута. | ||
| vrf строка | Значение по умолчанию: "default" | VRF для статического маршрута. | |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Если vrf не указан, vrf устанавливается по умолчанию.
- Если
state=absent, маршрут будет удален независимо от не требуемых параметров. - Дополнительную информацию об использовании CLI и NX-API см. в руководстве по параметрам платформы NXOS
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве по сети Ansible
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
- cisco.nxos.nxos_static_route:
prefix: 192.168.20.64/24
next_hop: 192.0.2.3
route_name: testing
pref: 100
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список / элементы=строка | всегда | команды, отправленные на устройство Пример: ['ip route 192.168.20.0/24 192.0.2.3 name testing 100'] |
Статус
- Этот модуль будет удален в основной версии после 2022-06-01. [устаревший]
- Дополнительную информацию см. в УСТАРЕВШИЙ.
Авторы
- Gabriele Gerbino (@GGabriele)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/nxos/nxos_static_route_module.html
