cisco.dnac.site_membership_info – Information module for Site Membership

Note

This plugin is part of the cisco.dnac collection (version 3.0.0).

To install it use: ansible-galaxy collection install cisco.dnac.

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

New in version 1.0.0: of cisco.dnac

Synopsis

• Get Site Membership by id.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk

Parameters

Parameter	Choices/Defaults	Comments
deviceFamily string		DeviceFamily query parameter. Device family name.
limit string		Limit query parameter. Number of sites to be retrieved.
offset string		Offset query parameter. Offset/starting row.
serialNumber string		SerialNumber query parameter. Device serial number.
siteId string		SiteId path parameter. Site id to retrieve device associated with the site.

See Also

See also

Site Membership reference

Complete reference of the Site Membership object model.

Examples

- name: Get Site Membership by id
  cisco.dnac.site_membership_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}}"
    offset: string
    limit: string
    deviceFamily: string
    serialNumber: string
    siteId: string
  register: result

Return Values

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

Key	Returned	Description
dnac_response dictionary	always	A dictionary or list with the response returned by the Cisco DNAC Python SDK Sample: { "site": { "response": [ {} ], "version": "string" }, "device": [ { "response": [ {} ], "version": "string", "siteId": "string" } ] }

Authors

• Rafael Campos (@racampos)