cisco.catalystcenter.credential_to_site_by_siteid_create module -- Resource module for Credential To Site By Siteid Create

Note

This module is part of the cisco.catalystcenter collection (version 2.2.1).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.credential_to_site_by_siteid_create.

New in cisco.catalystcenter 3.1.0

Synopsis

• This module represents an alias of the module credential_to_site_by_siteid_create_v2

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 2.3.7.9

• python >= 3.5

Parameters

Parameter	Comments
catc_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catc_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catc_host string / required	The Cisco Catalyst Center hostname.
catc_password string	The Cisco Catalyst Center password to authenticate.
catc_username string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catc_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catc_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"2.3.7.6"`
cliId string	CLI Credential Id.
httpRead string	HTTP(S) Read Credential Id.
httpWrite string	HTTP(S) Write Credential Id.
siteId string	SiteId path parameter. Site Id to assign credential.
snmpV2ReadId string	SNMPv2c Read Credential Id.
snmpV2WriteId string	SNMPv2c Write Credential Id.
snmpV3Id string	SNMPv3 Credential Id.
validate_response_schema boolean	Flag for Cisco Catalyst 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 network_settings.NetworkSettings.assign_device_credential_to_site_v2,

• Paths used are post /dna/intent/api/v2/credential-to-site/{siteId},

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

• Does not support check_mode

• The plugin runs on the control node and does not use any ansible connection plugins,

• but instead uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for Network Settings AssignDeviceCredentialToSiteV2

Complete reference of the AssignDeviceCredentialToSiteV2 API.

Examples

- name: Create
  cisco.catalystcenter.credential_to_site_by_siteid_create:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    verify: "{{ verify }}"
    api_port: "{{ api_port }}"
    version: "{{ version }}"
    debug: "{{ debug }}"
    cliId: string
    httpRead: string
    httpWrite: string
    siteId: string
    snmpV2ReadId: string
    snmpV2WriteId: string
    snmpV3Id: string

Return Values

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

Key	Description
catalystcenter_response dictionary	A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)