.. 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 .. Anchors .. _ansible_collections.cisco.dnac.sda_port_assignment_for_user_device_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.sda_port_assignment_for_user_device -- Resource module for Sda Port Assignment For User Device +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.dnac collection `_ (version 4.1.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. To use it in a playbook, specify: :code:`cisco.dnac.sda_port_assignment_for_user_device`. .. version_added .. versionadded:: 3.1.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create and delete of the resource Sda Port Assignment For User Device. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk >= 2.4.0 - python >= 3.5 .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
authenticateTemplateName
string
added in 4.0.0 of cisco.dnac
Authenticate TemplateName associated to siteNameHierarchy. Allowed values are 'Open Authentication', 'Closed Authentication', 'Low Impact', 'No Authentication', ''.
dataIpAddressPoolName
string
added in 4.0.0 of cisco.dnac
Ip Pool Name, that is assigned to virtual network with traffic type as DATA(can't be empty if voiceIpAddressPoolName is empty).
deviceManagementIpAddress
string
DeviceManagementIpAddress query parameter.
dnac_debug
boolean
    Choices:
  • no ←
  • yes
Flag for Cisco DNA Center SDK to enable debugging.
dnac_host
string / required
The Cisco DNA Center hostname.
dnac_password
string
The Cisco DNA Center password to authenticate.
dnac_port
string
Default:
443
The Cisco DNA Center port.
dnac_username
string
Default:
"admin"
The Cisco DNA Center username to authenticate.

aliases: user
dnac_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
dnac_version
string
Default:
"2.2.3.3"
Informs the SDK which version of Cisco DNA Center to use.
interfaceDescription
string
added in 4.0.0 of cisco.dnac
Details or note of interface assignment.
interfaceName
string
InterfaceName query parameter.
scalableGroupName
string
added in 4.0.0 of cisco.dnac
Valid name of a scalable group associated with virtual network(Scalable groups are only supported on No Auth profile because the other profiles assign SGTs from ISE).
siteNameHierarchy
string
added in 4.0.0 of cisco.dnac
Site Name Hierarchy should be a valid fabric site name hierarchy. E.g Global/USA/San Jose.
validate_response_schema
boolean
    Choices:
  • no
  • yes ←
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.
voiceIpAddressPoolName
string
added in 4.0.0 of cisco.dnac
Ip Pool Name, that is assigned to virtual network with traffic type as VOICE(can't be empty if dataIpAddressPoolName is emty).

.. Attributes .. Notes Notes ----- .. note:: - 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 .. Seealso See Also -------- .. seealso:: `Sda Port Assignment For User Device reference `_ Complete reference of the Sda Port Assignment For User Device object model. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Delete all cisco.dnac.sda_port_assignment_for_user_device: 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 deviceManagementIpAddress: string interfaceName: string - name: Create cisco.dnac.sda_port_assignment_for_user_device: 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 authenticateTemplateName: string dataIpAddressPoolName: string deviceManagementIpAddress: string interfaceDescription: string interfaceName: string scalableGroupName: string siteNameHierarchy: string voiceIpAddressPoolName: string .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html
Key Returned Description
dnac_response
dictionary
always
A dictionary or list with the response returned by the Cisco DNAC Python SDK

Sample:
{ "status": "string", "description": "string", "taskId": "string", "taskStatusUrl": "string", "executionStatusUrl": "string", "executionId": "string" }


.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors