.. 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.tag_v1_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.catalystcenter.tag_v1 module -- Resource module for Tag V1 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.catalystcenter collection `_ (version 2.1.4). 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.tag_v1`. .. version_added .. rst-class:: ansible-version-added New in cisco.catalystcenter 3.1.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource Tag V1. - Creates tag with specified tag attributes. - Deletes a tag specified by id. - Updates a tag specified by id. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.catalystcenter.tag_v1_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - catalystcentersdk \>= 2.3.7.9 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.tag_v1_module__parameter-_api_port: .. rst-class:: ansible-option-title **_api_port** .. raw:: html .. 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.tag_v1_module__parameter-_debug: .. rst-class:: ansible-option-title **_debug** .. raw:: html .. 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.tag_v1_module__parameter-_host: .. rst-class:: ansible-option-title **_host** .. raw:: html .. 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.tag_v1_module__parameter-_password: .. rst-class:: ansible-option-title **_password** .. raw:: html .. 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.tag_v1_module__parameter-_username: .. _ansible_collections.cisco.catalystcenter.tag_v1_module__parameter-user: .. rst-class:: ansible-option-title **_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: 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.tag_v1_module__parameter-_verify: .. rst-class:: ansible-option-title **_verify** .. raw:: html .. 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.tag_v1_module__parameter-_version: .. rst-class:: ansible-option-title **_version** .. raw:: html .. 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:`"2.3.7.6"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.tag_v1_module__parameter-description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Description of the tag. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.tag_v1_module__parameter-dynamicrules: .. rst-class:: ansible-option-title **dynamicRules** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Tag's dynamicRules. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.tag_v1_module__parameter-dynamicrules/membertype: .. rst-class:: ansible-option-title **memberType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
MemberType of the tag (e.g. Networkdevice, interface). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.tag_v1_module__parameter-dynamicrules/rules: .. rst-class:: ansible-option-title **rules** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Tag's rules. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.tag_v1_module__parameter-dynamicrules/rules/items: .. rst-class:: ansible-option-title **items** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Items details,multiple rules can be defined by items(e.g. "items" {"operation" "ILIKE", "name" "managementIpAddress", "value" "%10%"}, {"operation" "ILIKE", "name" "hostname", "value" "%NA%"} ). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.tag_v1_module__parameter-dynamicrules/rules/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the parameter (e.g. For interface portName,adminStatus,speed,status,description. For networkdevice family,series,hostname,managementIpAddress,groupNameHierarchy,softwareVersion). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.tag_v1_module__parameter-dynamicrules/rules/operation: .. rst-class:: ansible-option-title **operation** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Opeartion used in the rules (e.g. OR,IN,EQ,LIKE,ILIKE,AND). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.tag_v1_module__parameter-dynamicrules/rules/value: .. rst-class:: ansible-option-title **value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Value of the parameter (e.g. For portName 1/0/1,for adminStatus,status up/down, for speed any integer value, for description any valid string, for family switches, for series C3650, for managementIpAddress 10.197.124.90, groupNameHierarchy Global, softwareVersion 16.9.1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.tag_v1_module__parameter-dynamicrules/rules/values: .. rst-class:: ansible-option-title **values** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Values of the parameter,Only one of the value or values can be used for the given parameter. (for managementIpAddress e.g. "10.197.124.90","10.197.124.91"). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.tag_v1_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Mandatory instanceUuid of the tag that needs to be updated. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.tag_v1_module__parameter-instancetenantid: .. rst-class:: ansible-option-title **instanceTenantId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
InstanceTenantId generated for the tag. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.tag_v1_module__parameter-name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the tag. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.tag_v1_module__parameter-systemtag: .. rst-class:: ansible-option-title **systemTag** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
True for system created tags, false for user defined tags. .. 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.tag_v1_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
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are tag.Tag.create\_tag\_v1, tag.Tag.delete\_tag\_v1, tag.Tag.update\_tag\_v1, - Paths used are post /dna/intent/api/v1/tag, delete /dna/intent/api/v1/tag/{id}, put /dna/intent/api/v1/tag, - Does not support \ :literal:`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 CATALYST SDK - The parameters starting with catalystCenter\_ are used by the Cisco CATALYST Python SDK to establish the connection .. Seealso See Also -------- .. seealso:: `Cisco DNA Center documentation for Tag CreateTagV1 `_ Complete reference of the CreateTagV1 API. `Cisco DNA Center documentation for Tag DeleteTagV1 `_ Complete reference of the DeleteTagV1 API. `Cisco DNA Center documentation for Tag UpdateTagV1 `_ Complete reference of the UpdateTagV1 API. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Update all cisco.catalystcenter.tag_v1: _host: "{{ _host }}" _username: "{{ _username }}" _password: "{{ _password }}" _verify: "{{ _verify }}" _api_port: "{{ _api_port }}" _version: "{{ _version }}" _debug: "{{ _debug }}" state: present description: string dynamicRules: - memberType: string rules: items: - {} name: string operation: string value: string values: - string id: string instanceTenantId: string name: string systemTag: true - name: Create cisco.catalystcenter.tag_v1: _host: "{{ _host }}" _username: "{{ _username }}" _password: "{{ _password }}" _verify: "{{ _verify }}" _api_port: "{{ _api_port }}" _version: "{{ _version }}" _debug: "{{ _debug }}" state: present description: string dynamicRules: - memberType: string rules: items: - {} name: string operation: string value: string values: - string id: string instanceTenantId: string name: string systemTag: true - name: Delete by id cisco.catalystcenter.tag_v1: _host: "{{ _host }}" _username: "{{ _username }}" _password: "{{ _password }}" _verify: "{{ _verify }}" _api_port: "{{ _api_port }}" _version: "{{ _version }}" _debug: "{{ _debug }}" state: absent id: 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.tag_v1_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 DNAC 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 ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors