cisco.dnac.sda_site_member_member_info module -- Information module for Sda Site Member Member
Note
This module is part of the cisco.dnac collection (version 6.24.0).
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_info.
New in cisco.dnac 6.14.0
Synopsis
Get all Sda Site Member Member.
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.7.2
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
Flag for Cisco DNA Center SDK to enable debugging. Choices: |
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: :ansible-option-default:`443` |
|
The Cisco DNA Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco DNA Center to use. Default: :ansible-option-default:`"2.3.7.6"` |
|
Additional headers. |
|
Id path parameter. Site Id. |
|
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 query parameter. Number of devices to be listed. Default and max supported value is 500. |
|
MemberType query parameter. Member type (This API only supports the 'networkdevice' type). |
|
Offset query parameter. Offset/starting index for pagination. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
Notes
Note
SDK Method used are sites.Sites.get_devices_that_are_assigned_to_a_site,
Paths used are get /dna/intent/api/v1/site-member/{id}/member,
Supports
check_modeThe 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 GetDevicesThatAreAssignedToASite
Complete reference of the GetDevicesThatAreAssignedToASite API.
Examples
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|