Модуль cisco.dnac.site_v2_info — Модуль информации о сайте V2

Примечание

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

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

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

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

Новое в cisco.dnac 6.14.0

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

Обзор

Получить все сайты V2.
API для получения сайтов по иерархии имени сайта, siteId или типу. Отобразить все сайты, если эти параметры не заданы в качестве входных данных.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

…

Параметр	Комментарии
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"`
groupNameHierarchy string	Параметр запроса groupNameHierarchy. Иерархия имен сайта (например, Global/USA/CA).
headers dictionary	Дополнительные заголовки.
id string	Параметр запроса id. Идентификатор сайта.

Примечания

Примечание

Используемые методы SDK — sites.Sites.get_site_v2,
Используемые пути — get /dna/intent/api/v2/site,
Поддерживает check_mode
Плагин выполняется на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация Cisco DNA Center для Sites GetSiteV2: Полное описание API GetSiteV2.

Примеры

- name: Get all Site V2
  cisco.dnac.site_v2_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}}"
    groupNameHierarchy: string
    id: string
    type: string
    offset: string
    limit: string
  register: result

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

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

Ключ	Описание
dnac_response список / элементы=словарь	Словарь или список с ответом, возвращенным Cisco DNAC Python SDK Возвращается: всегда Пример: "[\n {\n \"parentId\": \"string\",\n \"groupTypeList\": [\n \"string\"\n ],\n \"groupHierarchy\": \"string\",\n \"additionalInfo\": [\n {\n \"nameSpace\": \"string\",\n \"attributes\": {\n \"addressInheritedFrom\": \"string\",\n \"type\": \"string\",\n \"country\": \"string\",\n \"address\": \"string\",\n \"latitude\": \"string\",\n \"longitude\": \"string\"\n }\n }\n ],\n \"groupNameHierarchy\": \"string\",\n \"name\": \"string\",\n \"instanceTenantId\": \"string\",\n \"id\": \"string\"\n }\n]\n"

Ключ

Описание

dnac_response

список / элементы=словарь

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

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

Пример: "[\n {\n \"parentId\": \"string\",\n \"groupTypeList\": [\n \"string\"\n ],\n \"groupHierarchy\": \"string\",\n \"additionalInfo\": [\n {\n \"nameSpace\": \"string\",\n \"attributes\": {\n \"addressInheritedFrom\": \"string\",\n \"type\": \"string\",\n \"country\": \"string\",\n \"address\": \"string\",\n \"latitude\": \"string\",\n \"longitude\": \"string\"\n }\n }\n ],\n \"groupNameHierarchy\": \"string\",\n \"name\": \"string\",\n \"instanceTenantId\": \"string\",\n \"id\": \"string\"\n }\n]\n"

Авторы

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/site_v2_info_module.html