cisco.dnac.network_devices_network_profiles_for_sites_info module -- Information module for Network Devices Network Profiles For Sites Info

Note

This module is part of the cisco.dnac collection (version 6.27.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.network_devices_network_profiles_for_sites_info.

New in cisco.dnac 6.15.0

Synopsis

• This module represents an alias of the module network_devices_network_profiles_for_sites_v1_info

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: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`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: :ansible-option-default:`443`
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: :ansible-option-default:`"admin"`
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: :ansible-option-default:`"2.3.7.6"`
headers dictionary	Additional headers.
id string	Id path parameter. The `id` of the network profile, retrievable from `GET /intent/api/v1/networkProfilesForSites`.
limit float	Limit query parameter. The number of records to show for this page;The minimum is 1, and the maximum is 500.
offset float	Offset query parameter. The first record to show for this page; the first record is numbered 1.
order string	Order query parameter. Whether ascending or descending order should be used to sort the response.
sortBy string	SortBy query parameter. A property within the response to sort by.
type string	Type query parameter. Filter responses to only include profiles of a given type.
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are site_design.SiteDesign.retrieve_a_network_profile_for_sites_by_id_v1, site_design.SiteDesign.retrieves_the_list_of_network_profiles_for_sites_v1,

• Paths used are get /dna/intent/api/v1/networkProfilesForSites, get /dna/intent/api/v1/networkProfilesForSites/{id},

• It should be noted that this module is an alias of network_devices_network_profiles_for_sites_v1_info

• 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 Site Design RetrieveANetworkProfileForSitesByIdV1

Complete reference of the RetrieveANetworkProfileForSitesByIdV1 API.

Cisco DNA Center documentation for Site Design RetrievesTheListOfNetworkProfilesForSitesV1

Complete reference of the RetrievesTheListOfNetworkProfilesForSitesV1 API.

Examples

- name: Get all Network Devices Network Profiles For Sites Info
  cisco.dnac.network_devices_network_profiles_for_sites_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: 0
    limit: 0
    sortBy: string
    order: string
    type: string
  register: result

- name: Get Network Devices Network Profiles For Sites Info by id
  cisco.dnac.network_devices_network_profiles_for_sites_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}}"
    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 dictionary	A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"id": "string", "name": "string", "type": "string"}}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)