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

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: cisco.dnac.site_info.

Новый в cisco.dnac 3.1.0

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

Описание

Получение всех сайтов.
Получение сайтов по иерархии имени сайта или 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"`
headers dictionary	Дополнительные заголовки.
limit integer	Параметр запроса limit. Количество сайтов для отображения.
name string	Параметр запроса name. Иерархия имен сайта (например, Global/USA/CA).
offset integer	Параметр запроса offset. Смещение/начальный индекс для постраничной навигации. Индексируется с 1.
siteId string	Параметр запроса siteId. Идентификатор сайта.
type string	Параметр запроса type. Тип сайта (например, область, здание, этаж).
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения проверки тел запросов по отношению к схеме JSON. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

См. также

Документация Cisco DNA Center для получения сайтов GetSite: Полная справка по API GetSite.

Примеры

- name: Get all Site
  cisco.dnac.site_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}}"
    name: string
    siteId: string
    type: string
    offset: 0
    limit: 0
  register: result

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

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

Ключ	Описание
dnac_response список / элементы=словарь	Словарь или список со значением возврата Python SDK Cisco DNAC Возвращаемое значение: всегда Пример: `"[\n {\n \"parentId\": \"string\",\n \"name\": \"string\",\n \"additionalInfo\": [\n \"string\"\n ],\n \"siteHierarchy\": \"string\",\n \"siteNameHierarchy\": \"string\",\n \"instanceTenantId\": \"string\",\n \"id\": \"string\"\n }\n]\n"`

Ключ

Описание

dnac_response

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

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

Возвращаемое значение: всегда

Пример: "[\n {\n \"parentId\": \"string\",\n \"name\": \"string\",\n \"additionalInfo\": [\n \"string\"\n ],\n \"siteHierarchy\": \"string\",\n \"siteNameHierarchy\": \"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_info_module.html