Модуль cisco.dnac.nfv_profile_info – Модуль информации для профиля Nfv

Примечание

Этот модуль является частью коллекции cisco.dnac (версия 6.20.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.dnac. Для использования этого модуля требуются дополнительные зависимости. Подробнее см. Требования.

Для использования в книге задач укажите: cisco.dnac.nfv_profile_info.

Новый в cisco.dnac 3.1.0

Описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Описание

Получение профиля Nfv по идентификатору.
API для получения профиля сети NFV.

Примечание

Этот модуль имеет соответствующий плагин действий.

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

dnacentersdk >= 2.7.2
python >= 3.9

Параметры

Параметр	Комментарии
dnac_debug boolean	Флаг для Cisco DNA Center SDK для включения отладки. Варианты: `false` ← (по умолчанию) `true`
dnac_host string / обязательный	Имя хоста Cisco DNA Center.
dnac_password string	Пароль Cisco DNA Center для аутентификации.
dnac_port integer	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username псевдонимы: user string	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (по умолчанию)
dnac_version string	Уведомляет SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
headers словарь	Дополнительные заголовки.
id строка	Параметр пути id. ID профиля сети для извлечения.
limit целое число	Параметр запроса limit. Количество профилей для извлечения.
name строка	Параметр запроса name. Название профиля сети для извлечения.
offset целое число	Параметр запроса offset. Смещение/строка начала.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения проверки заголовков запроса против JSON-схемы. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK — site_design.SiteDesign.get_nfv_profile,
Используемые пути — get /dna/intent/api/v1/nfv/network-profile/{id},
Поддерживает check_mode
Плагин выполняется на узле управления и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключения из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

Документация Cisco DNA Center для получения профиля Site Design GetNFVProfile: Полное описание API GetNFVProfile.

Примеры

- name: Get Nfv Profile by id
  cisco.dnac.nfv_profile_info:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    headers: "{{my_headers | from_json}}"
    offset: 0
    limit: 0
    name: string
    id: string
  register: result

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ	Описание
dnac_response словарь	Словарь или список с ответом, возвращенным Cisco DNAC Python SDK Возвращается: всегда Пример: {"response": [{"device": [{"customNetworks": [{"connectionType": "string", "networkName": "string", "servicesToConnect": [{"serviceName": "string"}], "vlanId": "string", "vlanMode": "string"}], "customTemplate": [{"deviceType": "string", "template": "string", "templateType": "string"}], "deviceTag": "string", "deviceType": "string", "directInternetAccessForFirewall": true, "serviceProviderProfile": [{"connect": true, "connectDefaultGatewayOnWan": true, "linkType": "string", "serviceProvider": "string"}], "services": [{"firewallMode": "string", "imageName": "string", "profileType": "string", "serviceName": "string", "serviceType": "string", "vNicMapping": [{"assignIpAddressToNetwork": true, "networkType": "string"}]}], "vlanForL2": [{"vlanDescription": "string", "vlanId": "string", "vlanType": "string"}]}], "id": "string", "profileName": "string"}]}

Ключ

Описание

dnac_response

словарь

Словарь или список с ответом, возвращенным Cisco DNAC Python SDK

Возвращается: всегда

Пример: {"response": [{"device": [{"customNetworks": [{"connectionType": "string", "networkName": "string", "servicesToConnect": [{"serviceName": "string"}], "vlanId": "string", "vlanMode": "string"}], "customTemplate": [{"deviceType": "string", "template": "string", "templateType": "string"}], "deviceTag": "string", "deviceType": "string", "directInternetAccessForFirewall": true, "serviceProviderProfile": [{"connect": true, "connectDefaultGatewayOnWan": true, "linkType": "string", "serviceProvider": "string"}], "services": [{"firewallMode": "string", "imageName": "string", "profileType": "string", "serviceName": "string", "serviceType": "string", "vNicMapping": [{"assignIpAddressToNetwork": true, "networkType": "string"}]}], "vlanForL2": [{"vlanDescription": "string", "vlanId": "string", "vlanType": "string"}]}], "id": "string", "profileName": "string"}]}

Авторы

Rafael Campos (@racampos)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/dnac/nfv_profile_info_module.html