cisco.catalystcenter.icap_settings_deploy module -- Resource module for Icap Settings Deploy

Note

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

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

New in cisco.catalystcenter 2.0.0

Synopsis

• Manage operation create of the resource Icap Settings Deploy.

• Deploys the given ICAP configuration intent without preview and approve.

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 3.2.3.0.0

• python >= 3.12

Parameters

Parameter	Comments
catalystcenter_debug aliases: dnac_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catalystcenter_host aliases: dnac_host string / required	The Cisco Catalyst Center hostname.
catalystcenter_password aliases: dnac_password string	The Cisco Catalyst Center password to authenticate.
catalystcenter_port aliases: dnac_port, catalystcenter_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_username aliases: dnac_username, user string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catalystcenter_verify aliases: dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catalystcenter_version aliases: dnac_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"`
payload list / elements=dictionary	Icap Settings Deploy's payload.
apId string	Icap Settings Deploy's apId.
captureType string	Icap Settings Deploy's captureType.
clientMac string	Icap Settings Deploy's clientMac.
durationInMins integer	Icap Settings Deploy's durationInMins.
otaBand string	Icap Settings Deploy's otaBand.
otaChannel integer	Icap Settings Deploy's otaChannel.
otaChannelWidth integer	Icap Settings Deploy's otaChannelWidth.
slots list / elements=float	Icap Settings Deploy's slots.
wlcId string	Icap Settings Deploy's wlcId.
previewDescription string	PreviewDescription query parameter. The ICAP intent's preview-deploy description string.
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 sensors.Sensors.deploys_the_given_icap_configuration_intent_without_preview_and_approve,

• Paths used are post /dna/intent/api/v1/icapSettings/deploy,

• 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

• Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

See Also

See also

Cisco Catalyst Center documentation for Sensors DeploysTheGivenICAPConfigurationIntentWithoutPreviewAndApprove

Complete reference of the DeploysTheGivenICAPConfigurationIntentWithoutPreviewAndApprove API.

Examples

---
- name: Create
  cisco.catalystcenter.icap_settings_deploy:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    payload:
      - apId: string
        captureType: string
        clientMac: string
        durationInMins: 0
        otaBand: string
        otaChannel: 0
        otaChannelWidth: 0
        slots:
          - 0
        wlcId: string
    previewDescription: 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 Catalyst Center Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

• Bryan Vargas (@bvargasre)

Collection links

Issue Tracker Repository (Sources)