cisco.dnac.site_membership – Manage SiteMembership objects of Sites

Note

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

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

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

New in version 1.0.0: of cisco.dnac

Synopsis

  • Getting the site children details and device details.

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
site_id
string / required
Site id to retrieve device associated with the site.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.site_membership

The official documentation on the cisco.dnac.plugins.module_utils.definitions.site_membership module.

SiteMembership reference

Complete reference of the SiteMembership object model.

SiteMembership reference

SDK reference.

Examples

- name: get_membership
  cisco.dnac.site_membership:
    state: query  # required
    site_id: SomeValue  # string, required
  register: nm_get_membership

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 with the response returned by the DNA Center Python SDK

Sample:
{'response': 29, 'version': '1.0'}
missing_params
list / elements=string
when the function request schema is not satisfied
Provided arguments do not comply with the schema of the DNA Center Python SDK function

sdk_function
string
always
The DNA Center SDK function used to execute the task

Sample:
sites.get_membership


Authors

  • Rafael Campos (@racampos)