.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.catalystcenter.capture_wired_deploy_create module -- Resource module for Capture Wired Deploy Create ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.catalystcenter collection `_ (version 2.11.0). To install it, use: :code:`ansible-galaxy collection install cisco.catalystcenter`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.catalystcenter.capture_wired_deploy_create`. .. version_added .. rst-class:: ansible-version-added New in cisco.catalystcenter 2.11.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - 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 :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - catalystcentersdk \>= 3.2.3.0.0 - python \>= 3.12 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-catalystcenter_debug: .. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **catalystcenter_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_debug` .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco Catalyst Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-catalystcenter_host: .. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-dnac_host: .. rst-class:: ansible-option-title **catalystcenter_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_host` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-catalystcenter_password: .. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-dnac_password: .. rst-class:: ansible-option-title **catalystcenter_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_password` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-catalystcenter_api_port: .. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-catalystcenter_port: .. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-dnac_port: .. rst-class:: ansible-option-title **catalystcenter_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_port, catalystcenter_api_port` .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-catalystcenter_username: .. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-dnac_username: .. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-user: .. rst-class:: ansible-option-title **catalystcenter_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_username, user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-catalystcenter_verify: .. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **catalystcenter_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_verify` .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-catalystcenter_version: .. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-dnac_version: .. rst-class:: ansible-option-title **catalystcenter_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_version` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco Catalyst Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"3.1.6.0"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-deploymentoptions: .. rst-class:: ansible-option-title **deploymentOptions** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Additional deployment options. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-deploymentoptions/rollbackonfailure: .. rst-class:: ansible-option-title **rollbackOnFailure** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Rollback changes if deployment fails. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-deploymentoptions/validatebeforedeploy: .. rst-class:: ansible-option-title **validateBeforeDeploy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Validate configuration before deployment. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-metadata: .. rst-class:: ansible-option-title **metadata** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Additional metadata for the deployment. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-previewdescription: .. rst-class:: ansible-option-title **previewDescription** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The wired capture session's preview-deploy description string. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-wiredcapturesettings: .. rst-class:: ansible-option-title **wiredCaptureSettings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
A list of wired capture session intents parameters that will be applied to switch. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-wiredcapturesettings/buffersizeinmb: .. rst-class:: ansible-option-title **bufferSizeInMb** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-wiredcapturesettings/buffertype: .. rst-class:: ansible-option-title **bufferType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
This is the buffer type. Only LINEAR is supported. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-wiredcapturesettings/deviceid: .. rst-class:: ansible-option-title **deviceId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The switch UUID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-wiredcapturesettings/durationinseconds: .. rst-class:: ansible-option-title **durationInSeconds** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The duration of the wired capture session in minutes. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-wiredcapturesettings/filterexpression: .. rst-class:: ansible-option-title **filterExpression** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__parameter-wiredcapturesettings/interfacename: .. rst-class:: ansible-option-title **interfaceName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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=\ in the POST body. It is best to use startTime and endTime as time range for the last 15 minutes. .. raw:: html
.. Attributes .. Notes 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 \ :literal:`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) .. Seealso See Also -------- .. seealso:: `Cisco Catalyst Center documentation for Devices DeploysTheWiredCaptureWithoutPreview `_ Complete reference of the DeploysTheWiredCaptureWithoutPreview API. .. Examples Examples -------- .. code-block:: yaml+jinja --- - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.capture_wired_deploy_create_module__return-catalystcenter_response: .. rst-class:: ansible-option-title **catalystcenter_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Bryan Vargas (@bvargasre) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors