cisco.dnac.icap_settings_configuration_models module -- Resource module for Icap Settings Configuration Models

Note

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

New in cisco.dnac 6.17.0

Synopsis

  • This module represents an alias of the module icap_settings_configuration_models_v1

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:

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:

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: :ansible-option-default:`"2.3.7.6"`

payload

list / elements=dictionary

Icap Settings Configuration Models's payload.

apId

string

Ap Id.

captureType

string

Capture Type.

clientMac

string

Client Mac.

durationInMins

integer

Duration In Mins.

otaBand

string

Ota Band.

otaChannel

integer

Ota Channel.

otaChannelWidth

integer

Ota Channel Width.

slot

list / elements=float

Slot.

wlcId

string

Wlc Id.

previewDescription

string

PreviewDescription query parameter. The ICAP intent's preview-deploy description string.

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

Notes

Note

  • SDK Method used are sensors.Sensors.creates_an_i_cap_configuration_intent_for_preview_approve_v1,

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

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

  • Does not support 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 Sensors CreatesAnICAPConfigurationIntentForPreviewApproveV1

Complete reference of the CreatesAnICAPConfigurationIntentForPreviewApproveV1 API.

Examples

- name: Create
  cisco.dnac.icap_settings_configuration_models:
    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}}"
    payload:
    - apId: string
      captureType: string
      clientMac: string
      durationInMins: 0
      otaBand: string
      otaChannel: 0
      otaChannelWidth: 0
      slot:
      - 0
      wlcId: string
    previewDescription: string

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": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)