cisco.dnac.credential_to_site – Manage CredentialToSite objects of NetworkSettings

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.credential_to_site.

New in version 1.0.0: of cisco.dnac

Synopsis

  • Assign Device Credential To Site.

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
cliId
string
Cli Id, property of the request body.
httpRead
string
Http Read, property of the request body.
httpWrite
string
Http Write, property of the request body.
site_id
string / required
Site id to assign credential.
snmpV2ReadId
string
Snmp V2 Read Id, property of the request body.
snmpV2WriteId
string
Snmp V2 Write Id, property of the request body.
snmpV3Id
string
Snmp V3 Id, property of the request body.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.credential_to_site

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

CredentialToSite reference

Complete reference of the CredentialToSite object model.

CredentialToSite reference

SDK reference.

Examples

- name: assign_credential_to_site
  cisco.dnac.credential_to_site:
    state: create  # required
    site_id: SomeValue  # string, required
    cliId: SomeValue  # string
    httpRead: SomeValue  # string
    httpWrite: SomeValue  # string
    snmpV2ReadId: SomeValue  # string
    snmpV2WriteId: SomeValue  # string
    snmpV3Id: SomeValue  # string

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:
network_settings.assign_credential_to_site


Authors

  • Rafael Campos (@racampos)