cisco.catalystcenter.capture_wired_deploy_create module -- Resource module for Capture Wired Deploy Create

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

New in cisco.catalystcenter 2.11.0

Synopsis

  • Manage operation create of the resource Capture Wired Deploy Create. - > Deploy the wired capture sessions to the switch device without preview-aprove. This is currently only available for only 1 switch at a time.

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:

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:

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"`

deploymentOptions

dictionary

Additional deployment options.

rollbackOnFailure

boolean

Rollback changes if deployment fails.

Choices:

validateBeforeDeploy

boolean

Validate configuration before deployment.

Choices:

metadata

dictionary

Additional metadata for the deployment.

previewDescription

string

The wired capture session'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:

wiredCaptureSettings

list / elements=dictionary

A list of wired capture session intents parameters that will be applied to switch.

bufferSizeInMb

integer

The capture buffer size in megabytes. This value is enforced to 100 MB by the server regardless of client input and should not be provided in request payloads.

bufferType

string

This is the buffer type. Only LINEAR is supported.

deviceId

string

The switch UUID.

durationInSeconds

integer

The duration of the wired capture session in minutes.

filterExpression

string

The filter expression which will be used in capturing packets at the switch interface. Packets that are not satisfied the filter conditions will not be captured.

interfaceName

string

The switch interface where the capture settings are applied. In wired packet capture intent API, tell user to use API /data/api/v1/interfaces/query to get the interface name list by following the example below. The switch is identified by networkDeviceId=<UUID> in the POST body. It is best to use startTime and endTime as time range for the last 15 minutes.

Notes

Note

  • SDK Method used are devices.Devices.deploys_the_wired_capture_without_preview,

  • Paths used are post /dna/intent/api/v1/capture/wired/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 Devices DeploysTheWiredCaptureWithoutPreview

Complete reference of the DeploysTheWiredCaptureWithoutPreview API.

Examples

---
- name: Create
  cisco.catalystcenter.capture_wired_deploy_create:
    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}}"
    deploymentOptions:
      rollbackOnFailure: true
      validateBeforeDeploy: true
    metadata: {}
    previewDescription: string
    wiredCaptureSettings:
      - bufferSizeInMb: 0
        bufferType: string
        deviceId: string
        durationInSeconds: 0
        filterExpression: string
        interfaceName: 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)