Модуль cisco.dnac.sda_site_member_member_info – Модуль информации для элемента Sda Site Member Member

Примечание

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

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

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

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

Добавлена в cisco.dnac 6.14.0

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

Обзор

Получение всех элементов Sda Site Member Member.
API для получения устройств, назначенных сайту.

Примечание

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

Требования

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

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	Дополнительные заголовки.
… (and so on, translating all subsequent rows)	…

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all Sda Site Member Member
  cisco.dnac.sda_site_member_member_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: string
    limit: string
    memberType: string
    level: string
    id: string
  register: result

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

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

Ключ	Описание
dnac_response список / элементы=словарь	Словарь или список с ответом, возвращенным Cisco DNAC Python SDK Возвращаемое значение: всегда Пример: "[\n {\n \"instanceUuid\": \"string\",\n \"instanceId\": 0,\n \"authEntityId\": 0,\n \"authEntityClass\": 0,\n \"instanceTenantId\": \"string\",\n \"deployPending\": \"string\",\n \"instanceVersion\": 0,\n \"apManagerInterfaceIp\": \"string\",\n \"associatedWlcIp\": \"string\",\n \"bootDateTime\": \"string\",\n \"collectionInterval\": \"string\",\n \"collectionIntervalValue\": \"string\",\n \"collectionStatus\": \"string\",\n \"description\": \"string\",\n \"deviceSupportLevel\": \"string\",\n \"dnsResolvedManagementAddress\": \"string\",\n \"family\": \"string\",\n \"hostname\": \"string\",\n \"interfaceCount\": \"string\",\n \"inventoryStatusDetail\": \"string\",\n \"lastUpdateTime\": 0,\n \"lastUpdated\": \"string\",\n \"lineCardCount\": \"string\",\n \"lineCardId\": \"string\",\n \"lastDeviceResyncStartTime\": \"string\",\n \"macAddress\": \"string\",\n \"managedAtleastOnce\": true,\n \"managementIpAddress\": \"string\",\n \"managementState\": \"string\",\n \"memorySize\": \"string\",\n \"paddedMgmtIpAddress\": \"string\",\n \"pendingSyncRequestsCount\": \"string\",\n \"platformId\": \"string\",\n \"reachabilityFailureReason\": \"string\",\n \"reachabilityStatus\": \"string\",\n \"reasonsForDeviceResync\": \"string\",\n \"reasonsForPendingSyncRequests\": \"string\",\n \"role\": \"string\",\n \"roleSource\": \"string\",\n \"serialNumber\": \"string\",\n \"series\": \"string\",\n \"snmpContact\": \"string\",\n \"snmpLocation\": \"string\",\n \"softwareType\": \"string\",\n \"softwareVersion\": \"string\",\n \"tagCount\": \"string\",\n \"type\": \"string\",\n \"upTime\": \"string\",\n \"uptimeSeconds\": 0,\n \"vendor\": \"string\",\n \"displayName\": \"string\"\n }\n]\n"

Ключ

Описание

dnac_response

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

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

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

Пример: "[\n {\n \"instanceUuid\": \"string\",\n \"instanceId\": 0,\n \"authEntityId\": 0,\n \"authEntityClass\": 0,\n \"instanceTenantId\": \"string\",\n \"deployPending\": \"string\",\n \"instanceVersion\": 0,\n \"apManagerInterfaceIp\": \"string\",\n \"associatedWlcIp\": \"string\",\n \"bootDateTime\": \"string\",\n \"collectionInterval\": \"string\",\n \"collectionIntervalValue\": \"string\",\n \"collectionStatus\": \"string\",\n \"description\": \"string\",\n \"deviceSupportLevel\": \"string\",\n \"dnsResolvedManagementAddress\": \"string\",\n \"family\": \"string\",\n \"hostname\": \"string\",\n \"interfaceCount\": \"string\",\n \"inventoryStatusDetail\": \"string\",\n \"lastUpdateTime\": 0,\n \"lastUpdated\": \"string\",\n \"lineCardCount\": \"string\",\n \"lineCardId\": \"string\",\n \"lastDeviceResyncStartTime\": \"string\",\n \"macAddress\": \"string\",\n \"managedAtleastOnce\": true,\n \"managementIpAddress\": \"string\",\n \"managementState\": \"string\",\n \"memorySize\": \"string\",\n \"paddedMgmtIpAddress\": \"string\",\n \"pendingSyncRequestsCount\": \"string\",\n \"platformId\": \"string\",\n \"reachabilityFailureReason\": \"string\",\n \"reachabilityStatus\": \"string\",\n \"reasonsForDeviceResync\": \"string\",\n \"reasonsForPendingSyncRequests\": \"string\",\n \"role\": \"string\",\n \"roleSource\": \"string\",\n \"serialNumber\": \"string\",\n \"series\": \"string\",\n \"snmpContact\": \"string\",\n \"snmpLocation\": \"string\",\n \"softwareType\": \"string\",\n \"softwareVersion\": \"string\",\n \"tagCount\": \"string\",\n \"type\": \"string\",\n \"upTime\": \"string\",\n \"uptimeSeconds\": 0,\n \"vendor\": \"string\",\n \"displayName\": \"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/sda_site_member_member_info_module.html