cisco.nxos.nxos_ospf – (устаревший, удален после 2022-06-01) Управляет конфигурацией экземпляра ospf.
Примечание
Этот плагин входит в сборку cisco.nxos (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install cisco.nxos.
Чтобы использовать его в книге задач, укажите: cisco.nxos.nxos_ospf.
Новое в версии 1.0.0: of cisco.nxos
УСТАРЕВШЕЕ
- Удалено в
-
главной версии после 2022-06-01
- Почему
-
Выпущены обновлённые модули с большей функциональностью.
- Альтернатива
-
nxos_ospfv2 и nxos_ospfv3
Обзор
- Управляет конфигурацией экземпляра ospf.
Примечание
У этого модуля есть соответствующий плагин действия.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| ospf строка / обязательно | Имя экземпляра ospf. | ||
| 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, это значение игнорируется. | |
| state строка |
| Определяет, должен ли конфиг быть присутствующим или отсутствовать на устройстве. | |
Примечания
Примечание
- Информация об использовании CLI и NX-API доступна в руководстве NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco https://www.ansible.com/integrations/networks/cisco.
Примеры
- cisco.nxos.nxos_ospf:
ospf: 1
state: present
Возвращаемые значения
Общие возвращаемые значения описаны в разделе здесь, а следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список / элементы=строка | всегда | команды, отправленные на устройство Пример: ['router ospf 1'] |
Статус
- Этот модуль будет удален в основной версии после 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_ospf_module.html