W3cubDocs

/Ansible

cisco.dnac.sda_site_member_member_v1_info module – Information module for Sda Site Member Member V1

Note

This module is part of the cisco.dnac collection (version 6.31.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.dnac. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.dnac.sda_site_member_member_v1_info.

New in cisco.dnac 6.14.0

Synopsis

  • Get all Sda Site Member Member V1.
  • API to get devices that are assigned to a site.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • dnacentersdk >= 2.4.9
  • python >= 3.5

Parameters

Parameter

Comments

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)
  • true

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: "admin"

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false
  • true ← (default)

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: "2.3.7.6"

headers

dictionary

Additional headers.

id

string

Id path parameter. Site Id.

level

string

Level query parameter. Depth of site hierarchy to be considered to list the devices. If the provided value is -1, devices for all child sites will be listed.

limit

string

Limit query parameter. Number of devices to be listed. Default and max supported value is 500.

memberType

string

MemberType query parameter. Member type (This API only supports the ‘networkdevice’ type).

offset

string

Offset query parameter. Offset starting index for pagination.

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

  • false
  • true ← (default)

Notes

Note

  • SDK Method used are sites.Sites.get_devices_that_are_assigned_to_a_site_v1,
  • Paths used are get /dna/intent/api/v1/site-member/{id}/member,
  • Supports check_mode
  • The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK
  • The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Sites GetDevicesThatAreAssignedToASiteV1

Complete reference of the GetDevicesThatAreAssignedToASiteV1 API.

Examples

- name: Get all Sda Site Member Member V1
  cisco.dnac.sda_site_member_member_v1_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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

dnac_response

list / elements=dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: "[\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"

Authors

  • Rafael Campos (@racampos)

© 2012–2018 Michael DeHaan
© 2018–2025 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_v1_info_module.html