cisco.nxos.nxos_ospf – (устаревший, удалён после 2022-06-01) Управляет конфигурацией экземпляра ospf.
Примечание
Этот плагин входит в состав коллекции cisco.nxos (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install cisco.nxos.
Чтобы использовать его в книге задач, укажите: cisco.nxos.nxos_ospf.
Добавлена в версии 1.0.0: 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 ложно, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды 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.
Примеры
- cisco.nxos.nxos_ospf:
ospf: 1
state: present
Возвращаемые значения
Общие возвращаемые значения описаны в разделе здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращённое значение | Описание |
|---|---|---|
| commands список / элементы=строка | всегда | Команды, отправленные на устройство Пример: ['router ospf 1'] |
Статус
- Этот модуль будет удалён в следующей версии после 2022-06-01. [устаревший]
- Для получения дополнительной информации см. УСТАРЕВШИЙ.
Авторы
- 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.10/collections/cisco/nxos/nxos_ospf_module.html