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