.. 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.switches_configs_deployed_security_info_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.catalystcenter.switches_configs_deployed_security_info module -- Information module for Switches Configs Deployed Security ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.catalystcenter collection `_ (version 2.12.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.switches_configs_deployed_security_info`. .. version_added .. rst-class:: ansible-version-added New in cisco.catalystcenter 2.11.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Get Switches Configs Deployed Security by id. - \> Returns deployed configuration entries for the specified security feature on the switch. The device config learning must have enabled for the switch using the API /dna/campus/api/v1/switches/configs/deployed/enable. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.catalystcenter.switches_configs_deployed_security_info_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.switches_configs_deployed_security_info_module__parameter-catalystcenter_debug: .. _ansible_collections.cisco.catalystcenter.switches_configs_deployed_security_info_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.switches_configs_deployed_security_info_module__parameter-catalystcenter_host: .. _ansible_collections.cisco.catalystcenter.switches_configs_deployed_security_info_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.switches_configs_deployed_security_info_module__parameter-catalystcenter_password: .. _ansible_collections.cisco.catalystcenter.switches_configs_deployed_security_info_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.switches_configs_deployed_security_info_module__parameter-catalystcenter_api_port: .. _ansible_collections.cisco.catalystcenter.switches_configs_deployed_security_info_module__parameter-catalystcenter_port: .. _ansible_collections.cisco.catalystcenter.switches_configs_deployed_security_info_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.switches_configs_deployed_security_info_module__parameter-catalystcenter_username: .. _ansible_collections.cisco.catalystcenter.switches_configs_deployed_security_info_module__parameter-dnac_username: .. _ansible_collections.cisco.catalystcenter.switches_configs_deployed_security_info_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.switches_configs_deployed_security_info_module__parameter-catalystcenter_verify: .. _ansible_collections.cisco.catalystcenter.switches_configs_deployed_security_info_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.switches_configs_deployed_security_info_module__parameter-catalystcenter_version: .. _ansible_collections.cisco.catalystcenter.switches_configs_deployed_security_info_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.switches_configs_deployed_security_info_module__parameter-feature: .. rst-class:: ansible-option-title **feature** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Feature path parameter. Name of the feature to retrieve security configuration for. The API /api/v1/switches/{id}/configs/supported/security can be used to get the list of features supported on a device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.switches_configs_deployed_security_info_module__parameter-headers: .. rst-class:: ansible-option-title **headers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Additional headers. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.switches_configs_deployed_security_info_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
Id path parameter. Network device id of the switch. The Network device id can be identified from the GET network device API /dna/intent/api/v1/network-device response. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.switches_configs_deployed_security_info_module__parameter-limit: .. rst-class:: ansible-option-title **limit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Limit query parameter. The number of records to show for this page. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.switches_configs_deployed_security_info_module__parameter-offset: .. rst-class:: ansible-option-title **offset** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Offset query parameter. The first record to show for this page; the first record is numbered 1. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.switches_configs_deployed_security_info_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 wired.Wired.get\_deployed\_security\_configurations, - Paths used are get /dna/campus/api/v1/switches/{id}/configs/deployed/security/{feature}, - Supports \ :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 Wired GetDeployedSecurityConfigurations `_ Complete reference of the GetDeployedSecurityConfigurations API. .. Examples Examples -------- .. code-block:: yaml+jinja --- - name: Get Switches Configs Deployed Security by id cisco.catalystcenter.switches_configs_deployed_security_info: 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}}" headers: "{{my_headers | from_json}}" offset: 1 limit: 0 id: string feature: string register: result .. 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.switches_configs_deployed_security_info_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": {"arpInspectionConfig": {"items": [{"configType": "string", "vlanId": 0}]}, "ctsConfig": {"items": [{"authorizationList": "string", "configType": "string", "ctsSgt": 0, "defaultSxpPassword": "string", "enforcementVlans": "string", "ipSgtMappings": {"configType": "string", "items": [{"configType": "string", "hostOrSubnetIpAddress": "string", "sgt": 0}]}, "ipVrfSgtMappings": {"configType": "string", "items": [{"configType": "string", "ipAddress": "string", "sgt": 0, "vrfName": "string"}]}, "isRoleBasedEnforcementEnabled": true, "isSxpEnabled": true, "roleBasedPermissions": {"configType": "string", "items": [{"configType": "string", "destinationSgtRanges": {"configType": "string", "items": [{"configType": "string", "destinationSgt": 0, "ipv4RoleBasedAclName": "string", "ipv6RoleBasedAclName": "string"}]}, "sourceSgtRange": 0}]}, "sxpIpV4Peers": {"configType": "string", "items": [{"configType": "string", "ipV4Address": "string", "localDeviceMode": "string", "maximumHoldTime": 0, "minimumHoldTime": 0, "mode": "string", "passwordType": "string", "sourceIpv4Address": "string"}]}}]}, "deviceTrackingConfig": {"items": [{"configType": "string", "deviceTrackingPolicy": {"configType": "string", "items": [{"addressCountLimit": 0, "configType": "string", "deviceRole": "string", "isDestinationGleanLogOnly": true, "isPrefixGleanEnabled": true, "isProtocolArpEnabled": true, "isProtocolDhcp4Enabled": true, "isProtocolDhcp6Enabled": true, "isProtocolNdpEnabled": true, "isSecurityLevelGleanEnabled": true, "isTrackingEnabled": true, "isTrustedPortEnabled": true, "policyName": "string"}]}, "fallbackSourceIpv4Address": "string", "fallbackSourceIpv4Mask": "string", "isAutoSourceEnabled": true, "isFallbackSourceOverrideEnabled": true, "isLoggingTheftEnabled": true, "isTrackingEnabled": true, "maxBindingEntries": 0}]}, "deviceTrackingVlanConfig": {"items": [{"configType": "string", "deviceTrackingPolicy": "string", "isDeviceTrackingEnabled": true, "vlanId": "string"}]}, "dhcpSnoopingConfig": {"items": [{"configType": "string", "databaseTimeout": 0, "databaseUrl": "string", "dhcpSnoopingVlans": {"configType": "string", "items": [{"configType": "string", "vlanId": 0}]}, "isDhcpSnoopingEnabled": true, "isGleanEnabled": true, "isSnoopingInfoOptionEnabled": true, "isSnoopingOptionAllowUntrustedEnabled": true, "writeDelay": 0}]}, "dot1xConfig": {"items": [{"configType": "string", "dot1xCredentials": {"configType": "string", "items": [{"configType": "string", "password": "string", "passwordType": "string", "profileName": "string", "username": "string"}]}, "isDot1xEnabled": true, "isLoggingVerboseEnabled": true}]}, "ipV4ExtendedAccessListConfig": {"items": [{"accessListSequenceRules": {"configType": "string", "items": [{"action": "string", "configType": "string", "destinationEndRange": "string", "destinationIpV4Address": "string", "destinationIpV4Subnet": "string", "destinationStartRange": "string", "destinationType": "string", "destinationValue": "string", "destinationWildcard": "string", "isDestinationAnyEnabled": true, "isLoggingEnabled": true, "isSourceAnyEnabled": true, "matchDscp": "string", "protocol": "string", "sequence": 0, "sourceEndRange": "string", "sourceIpV4Address": "string", "sourceIpV4Subnet": "string", "sourceStartRange": "string", "sourceType": "string", "sourceValue": "string", "sourceWildcard": "string"}]}, "aclName": "string", "configType": "string"}]}, "ipV4RoleBasedAccessListConfig": {"items": [{"accessListSequenceRules": {"configType": "string", "items": [{"action": "string", "configType": "string", "isLoggingEnabled": true, "protocol": "string", "sequence": 0}]}, "aclName": "string", "configType": "string"}]}, "ipV4StandardAccessListConfig": {"items": [{"accessListSequenceRules": {"configType": "string", "items": [{"configType": "string", "isDenyAnyEnabled": true, "isDenyLogEnabled": true, "isPermitAnyEnabled": true, "isPermitLogEnabled": true, "sequence": 0, "sourceHostIpV4Address": "string", "sourceIpV4Address": "string", "sourceWildcard": "string", "subnetHostIpV4Address": "string", "subnetIpV4Address": "string", "subnetWildcard": "string"}]}, "aclName": "string", "configType": "string"}]}, "ipV6AccessListConfig": {"items": [{"accessListSequenceRules": {"configType": "string", "items": [{"action": "string", "configType": "string", "destinationEndRange": "string", "destinationIpV6Address": "string", "destinationNetworkAddress": "string", "destinationNetworkWildcard": "string", "destinationPrefix": "string", "destinationStartRange": "string", "destinationType": "string", "destinationValue": "string", "isDestinationAnyEnabled": true, "isEstablishedEnabled": true, "isLoggingEnabled": true, "isSourceAnyEnabled": true, "matchDscp": "string", "protocol": "string", "sequence": 0, "sourceEndRange": "string", "sourceIpV6Address": "string", "sourceNetworkAddress": "string", "sourceNetworkWildcard": "string", "sourcePrefix": "string", "sourceStartRange": "string", "sourceType": "string", "sourceValue": "string"}]}, "aclName": "string", "configType": "string"}]}, "ipV6RoleBasedAccessListConfig": {"items": [{"accessListSequenceRules": {"configType": "string", "items": [{"action": "string", "configType": "string", "isLogEnabled": true, "protocolType": "string", "protocolValue": "string", "sequence": 0}]}, "aclName": "string", "configType": "string"}]}, "macExtendedAccessListConfig": {"items": [{"accessListExtendedEntries": {"configType": "string", "items": [{"action": "string", "configType": "string", "values": "string"}]}, "aclName": "string", "configType": "string"}]}}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Bryan Vargas (@bvargasre) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors