.. 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.dnac.sda_port_assignments_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.sda_port_assignments module -- Resource module for Sda Port Assignments ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection <https://galaxy.ansible.com/cisco/dnac>`_ (version 6.25.0). To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. You need further requirements to be able to use this module, see :ref:`Requirements <ansible_collections.cisco.dnac.sda_port_assignments_module_requirements>` for details. To use it in a playbook, specify: :code:`cisco.dnac.sda_port_assignments`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 6.14.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - This module represents an alias of the module sda\_port\_assignments\_v1 .. note:: This module has a corresponding :ref:`action plugin <action_plugins>`. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.sda_port_assignments_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.4.9 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-dataVlanName"></div> .. _ansible_collections.cisco.dnac.sda_port_assignments_module__parameter-datavlanname: .. rst-class:: ansible-option-title **dataVlanName** .. raw:: html <a class="ansibleOptionLink" href="#parameter-dataVlanName" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> DataVlanName query parameter. Data VLAN name of the port assignment. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-dnac_debug"></div> .. _ansible_collections.cisco.dnac.sda_port_assignments_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html <a class="ansibleOptionLink" href="#parameter-dnac_debug" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> Flag for Cisco DNA 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 </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-dnac_host"></div> .. _ansible_collections.cisco.dnac.sda_port_assignments_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html <a class="ansibleOptionLink" href="#parameter-dnac_host" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> The Cisco DNA Center hostname. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-dnac_password"></div> .. _ansible_collections.cisco.dnac.sda_port_assignments_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html <a class="ansibleOptionLink" href="#parameter-dnac_password" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> The Cisco DNA Center password to authenticate. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-dnac_port"></div> .. _ansible_collections.cisco.dnac.sda_port_assignments_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html <a class="ansibleOptionLink" href="#parameter-dnac_port" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> The Cisco DNA Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-dnac_username"></div> <div class="ansibleOptionAnchor" id="parameter-user"></div> .. _ansible_collections.cisco.dnac.sda_port_assignments_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.sda_port_assignments_module__parameter-user: .. rst-class:: ansible-option-title **dnac_username** .. raw:: html <a class="ansibleOptionLink" href="#parameter-dnac_username" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> The Cisco DNA Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-dnac_verify"></div> .. _ansible_collections.cisco.dnac.sda_port_assignments_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_verify** .. raw:: html <a class="ansibleOptionLink" href="#parameter-dnac_verify" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> 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 </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-dnac_version"></div> .. _ansible_collections.cisco.dnac.sda_port_assignments_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html <a class="ansibleOptionLink" href="#parameter-dnac_version" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> Informs the SDK which version of Cisco DNA Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.3.7.6"` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-fabricId"></div> .. _ansible_collections.cisco.dnac.sda_port_assignments_module__parameter-fabricid: .. rst-class:: ansible-option-title **fabricId** .. raw:: html <a class="ansibleOptionLink" href="#parameter-fabricId" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> FabricId query parameter. ID of the fabric the device is assigned to. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-id"></div> .. _ansible_collections.cisco.dnac.sda_port_assignments_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html <a class="ansibleOptionLink" href="#parameter-id" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> Id path parameter. ID of the port assignment. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-interfaceName"></div> .. _ansible_collections.cisco.dnac.sda_port_assignments_module__parameter-interfacename: .. rst-class:: ansible-option-title **interfaceName** .. raw:: html <a class="ansibleOptionLink" href="#parameter-interfaceName" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> InterfaceName query parameter. Interface name of the port assignment. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-networkDeviceId"></div> .. _ansible_collections.cisco.dnac.sda_port_assignments_module__parameter-networkdeviceid: .. rst-class:: ansible-option-title **networkDeviceId** .. raw:: html <a class="ansibleOptionLink" href="#parameter-networkDeviceId" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> NetworkDeviceId query parameter. Network device ID of the port assignment. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-payload"></div> .. _ansible_collections.cisco.dnac.sda_port_assignments_module__parameter-payload: .. rst-class:: ansible-option-title **payload** .. raw:: html <a class="ansibleOptionLink" href="#parameter-payload" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> Sda Port Assignments's payload. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-payload/authenticateTemplateName"></div> .. _ansible_collections.cisco.dnac.sda_port_assignments_module__parameter-payload/authenticatetemplatename: .. rst-class:: ansible-option-title **authenticateTemplateName** .. raw:: html <a class="ansibleOptionLink" href="#parameter-payload/authenticateTemplateName" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Authenticate template name of the port assignment. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-payload/connectedDeviceType"></div> .. _ansible_collections.cisco.dnac.sda_port_assignments_module__parameter-payload/connecteddevicetype: .. rst-class:: ansible-option-title **connectedDeviceType** .. raw:: html <a class="ansibleOptionLink" href="#parameter-payload/connectedDeviceType" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Connected device type of the port assignment. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-payload/dataVlanName"></div> .. _ansible_collections.cisco.dnac.sda_port_assignments_module__parameter-payload/datavlanname: .. rst-class:: ansible-option-title **dataVlanName** .. raw:: html <a class="ansibleOptionLink" href="#parameter-payload/dataVlanName" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Data VLAN name of the port assignment. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-payload/fabricId"></div> .. _ansible_collections.cisco.dnac.sda_port_assignments_module__parameter-payload/fabricid: .. rst-class:: ansible-option-title **fabricId** .. raw:: html <a class="ansibleOptionLink" href="#parameter-payload/fabricId" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> ID of the fabric the device is assigned to. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-payload/interfaceDescription"></div> .. _ansible_collections.cisco.dnac.sda_port_assignments_module__parameter-payload/interfacedescription: .. rst-class:: ansible-option-title **interfaceDescription** .. raw:: html <a class="ansibleOptionLink" href="#parameter-payload/interfaceDescription" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Interface description of the port assignment. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-payload/interfaceName"></div> .. _ansible_collections.cisco.dnac.sda_port_assignments_module__parameter-payload/interfacename: .. rst-class:: ansible-option-title **interfaceName** .. raw:: html <a class="ansibleOptionLink" href="#parameter-payload/interfaceName" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Interface name of the port assignment. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-payload/networkDeviceId"></div> .. _ansible_collections.cisco.dnac.sda_port_assignments_module__parameter-payload/networkdeviceid: .. rst-class:: ansible-option-title **networkDeviceId** .. raw:: html <a class="ansibleOptionLink" href="#parameter-payload/networkDeviceId" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Network device ID of the port assignment. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-payload/securityGroupName"></div> .. _ansible_collections.cisco.dnac.sda_port_assignments_module__parameter-payload/securitygroupname: .. rst-class:: ansible-option-title **securityGroupName** .. raw:: html <a class="ansibleOptionLink" href="#parameter-payload/securityGroupName" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Security group name of the port assignment. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-payload/voiceVlanName"></div> .. _ansible_collections.cisco.dnac.sda_port_assignments_module__parameter-payload/voicevlanname: .. rst-class:: ansible-option-title **voiceVlanName** .. raw:: html <a class="ansibleOptionLink" href="#parameter-payload/voiceVlanName" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Voice VLAN name of the port assignment. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-validate_response_schema"></div> .. _ansible_collections.cisco.dnac.sda_port_assignments_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html <a class="ansibleOptionLink" href="#parameter-validate_response_schema" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> Flag for Cisco DNA 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 </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-voiceVlanName"></div> .. _ansible_collections.cisco.dnac.sda_port_assignments_module__parameter-voicevlanname: .. rst-class:: ansible-option-title **voiceVlanName** .. raw:: html <a class="ansibleOptionLink" href="#parameter-voiceVlanName" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> VoiceVlanName query parameter. Voice VLAN name of the port assignment. .. raw:: html </div> .. Attributes .. Notes Notes ----- .. note:: - SDK Method used are sda.Sda.add\_port\_assignments\_v1, sda.Sda.delete\_port\_assignment\_by\_id\_v1, sda.Sda.update\_port\_assignments\_v1, - Paths used are post /dna/intent/api/v1/sda/portAssignments, delete /dna/intent/api/v1/sda/portAssignments, delete /dna/intent/api/v1/sda/portAssignments/{id}, put /dna/intent/api/v1/sda/portAssignments, - It should be noted that this module is an alias of sda\_port\_assignments\_v1 - 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 DNAC SDK - The parameters starting with dnac\_ are used by the Cisco DNAC Python SDK to establish the connection .. Seealso See Also -------- .. seealso:: `Cisco DNA Center documentation for SDA AddPortAssignmentsV1 <https://developer.cisco.com/docs/dna-center/#!add-port-assignments>`_ Complete reference of the AddPortAssignmentsV1 API. `Cisco DNA Center documentation for SDA DeletePortAssignmentByIdV1 <https://developer.cisco.com/docs/dna-center/#!delete-port-assignment-by-id>`_ Complete reference of the DeletePortAssignmentByIdV1 API. `Cisco DNA Center documentation for SDA DeletePortAssignmentsV1 <https://developer.cisco.com/docs/dna-center/#!delete-port-assignments>`_ Complete reference of the DeletePortAssignmentsV1 API. `Cisco DNA Center documentation for SDA UpdatePortAssignmentsV1 <https://developer.cisco.com/docs/dna-center/#!update-port-assignments>`_ Complete reference of the UpdatePortAssignmentsV1 API. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Create cisco.dnac.sda_port_assignments: 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}}" state: present payload: - authenticateTemplateName: string connectedDeviceType: string dataVlanName: string fabricId: string interfaceDescription: string interfaceName: string networkDeviceId: string securityGroupName: string voiceVlanName: string - name: Update all cisco.dnac.sda_port_assignments: 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}}" state: present payload: - authenticateTemplateName: string connectedDeviceType: string dataVlanName: string fabricId: string id: string interfaceDescription: string interfaceName: string networkDeviceId: string scalableGroupName: string voiceVlanName: string - name: Delete all cisco.dnac.sda_port_assignments: 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}}" state: absent dataVlanName: string fabricId: string interfaceName: string networkDeviceId: string voiceVlanName: string - name: Delete by id cisco.dnac.sda_port_assignments: 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}}" state: absent id: string .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here <common_return_values>`, 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 <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="return-dnac_response"></div> .. _ansible_collections.cisco.dnac.sda_port_assignments_module__return-dnac_response: .. rst-class:: ansible-option-title **dnac_response** .. raw:: html <a class="ansibleOptionLink" href="#return-dnac_response" title="Permalink to this return value"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> 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 </div> .. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html <p class="ansible-links"> <a href="https://github.com/cisco-en-programmability/dnacenter-ansible/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a> <a href="https://github.com/cisco-en-programmability/dnacenter-ansible" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a> </p> .. Parsing errors