.. 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.network_settings_workflow_manager_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.network_settings_workflow_manager module -- Resource module for IP Address pools and network functions +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.25.1). 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 ` for details. To use it in a playbook, specify: :code:`cisco.dnac.network_settings_workflow_manager`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 6.6.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations on Global Pool, Reserve Pool, Network resources. - API to create/update/delete global pool. - API to reserve/update/delete an ip subpool from the global pool. - API to update network settings for DHCP, Syslog, SNMP, NTP, Network AAA, Client and Endpoint AAA, and/or DNS center server settings. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.7.2 - python \>= 3.9 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config: .. rst-class:: ansible-option-title **config** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
List of details of global pool, reserved pool, network being managed. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/global_pool_details: .. rst-class:: ansible-option-title **global_pool_details** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Manages IPv4 and IPv6 IP pools in the global level. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/global_pool_details/settings: .. rst-class:: ansible-option-title **settings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Global Pool's settings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/global_pool_details/settings/ip_pool: .. rst-class:: ansible-option-title **ip_pool** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Contains a list of global IP pool configurations. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/global_pool_details/settings/ip_pool/cidr: .. rst-class:: ansible-option-title **cidr** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Defines the IP pool's Classless Inter-Domain Routing block, enabling systematic IP address distribution within a network. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/global_pool_details/settings/ip_pool/dhcp_server_ips: .. rst-class:: ansible-option-title **dhcp_server_ips** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
The DHCP server IPs responsible for automatically assigning IP addresses and network configuration parameters to devices on a local network. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/global_pool_details/settings/ip_pool/dns_server_ips: .. rst-class:: ansible-option-title **dns_server_ips** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Responsible for translating domain names into corresponding IP addresses. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/global_pool_details/settings/ip_pool/gateway: .. rst-class:: ansible-option-title **gateway** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Serves as an entry or exit point for data traffic between networks. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/global_pool_details/settings/ip_pool/ip_address_space: .. rst-class:: ansible-option-title **ip_address_space** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP address space either IPv4 or IPv6. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/global_pool_details/settings/ip_pool/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specifies the name assigned to the Global IP Pool. Required for the operations in the Global IP Pool. Length should be less than or equal to 100. Only letters, numbers and -\_./ characters are allowed. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/global_pool_details/settings/ip_pool/pool_type: .. rst-class:: ansible-option-title **pool_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Includes both the Generic Ip Pool and Tunnel Ip Pool. Generic - Used for general purpose within the network such as device management or communication between the network devices. Tunnel - Designated for the tunnel interfaces to encapsulate packets within the network protocol. It is used in VPN connections, GRE tunnels, or other types of overlay networks. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"Generic"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"Tunnel"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/global_pool_details/settings/ip_pool/prev_name: .. rst-class:: ansible-option-title **prev_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The former identifier for the global pool. It should be used exclusively when you need to update the global pool's name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details: .. rst-class:: ansible-option-title **network_management_details** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Set default network settings for the site .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings: .. rst-class:: ansible-option-title **settings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network management details settings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/client_and_endpoint_aaa: .. rst-class:: ansible-option-title **client_and_endpoint_aaa** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Manages AAA (Authentication Authorization Accounting) for clients and endpoints. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/client_and_endpoint_aaa/pan_address: .. rst-class:: ansible-option-title **pan_address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` :ansible-option-versionadded:`added in cisco.dnac 6.14.0` .. raw:: html
- .. raw:: html
PAN IP address for the ISE server. For example, 1.1.1.1. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/client_and_endpoint_aaa/primary_server_address: .. rst-class:: ansible-option-title **primary_server_address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` :ansible-option-versionadded:`added in cisco.dnac 6.14.0` .. raw:: html
- .. raw:: html
Primary IP address for the ISE/AAA server. For example, 1.1.1.2. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/client_and_endpoint_aaa/protocol: .. rst-class:: ansible-option-title **protocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Protocol for AAA or ISE server. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"RADIUS"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"TACACS"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/client_and_endpoint_aaa/secondary_server_address: .. rst-class:: ansible-option-title **secondary_server_address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` :ansible-option-versionadded:`added in cisco.dnac 6.14.0` .. raw:: html
- .. raw:: html
Secondary IP address for the AAA server. For example, 1.1.1.3. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/client_and_endpoint_aaa/server_type: .. rst-class:: ansible-option-title **server_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Server type for managing AAA for client and endpoints. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"AAA"` - :ansible-option-choices-entry:`"ISE"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/client_and_endpoint_aaa/shared_secret: .. rst-class:: ansible-option-title **shared_secret** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Shared secret for ISE Server. Length of the shared secret should be atleast 4 characters. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/dhcp_server: .. rst-class:: ansible-option-title **dhcp_server** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
DHCP Server IP address (eg 1.1.1.4). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/dns_server: .. rst-class:: ansible-option-title **dns_server** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
DNS server details of the network under a specific site. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/dns_server/domain_name: .. rst-class:: ansible-option-title **domain_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Domain Name of DHCP (eg; cisco.com, cisco.net). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/dns_server/primary_ip_address: .. rst-class:: ansible-option-title **primary_ip_address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Primary IP Address for DHCP (eg 2.2.2.2). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/dns_server/secondary_ip_address: .. rst-class:: ansible-option-title **secondary_ip_address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Secondary IP Address for DHCP (eg 3.3.3.3). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/message_of_the_day: .. rst-class:: ansible-option-title **message_of_the_day** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Banner details under a specific site. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/message_of_the_day/banner_message: .. rst-class:: ansible-option-title **banner_message** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Message for the banner (eg; Good day). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/message_of_the_day/retain_existing_banner: .. rst-class:: ansible-option-title **retain_existing_banner** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Retain existing banner message. .. 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.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/netflow_collector: .. rst-class:: ansible-option-title **netflow_collector** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
NetFlow collector configuration for a specific site. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/netflow_collector/collector_type: .. rst-class:: ansible-option-title **collector_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of NetFlow collector. Supported values include 'Builtin' and 'Telemetry\_broker\_or\_UDP\_director'. Applicable from Cisco Catalyst Center version 2.3.7.6 onwards. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"Builtin"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"Telemetry\_broker\_or\_UDP\_director"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/netflow_collector/enable_on_wired_access_devices: .. rst-class:: ansible-option-title **enable_on_wired_access_devices** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Enable or disable wired access device. Applicable from Cisco Catalyst Center version 2.3.7.6 onwards.. .. 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.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/netflow_collector/ip_address: .. rst-class:: ansible-option-title **ip_address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP Address for NetFlow collector. For example, 3.3.3.1. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/netflow_collector/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Port number used by the NetFlow collector. For example, 443. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/network_aaa: .. rst-class:: ansible-option-title **network_aaa** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Manages AAA (Authentication Authorization Accounting) for network devices. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/network_aaa/pan_address: .. rst-class:: ansible-option-title **pan_address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` :ansible-option-versionadded:`added in cisco.dnac 6.14.0` .. raw:: html
- .. raw:: html
PAN IP address for the ISE server. For example, 1.1.1.1. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/network_aaa/primary_server_address: .. rst-class:: ansible-option-title **primary_server_address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` :ansible-option-versionadded:`added in cisco.dnac 6.14.0` .. raw:: html
- .. raw:: html
Primary IP address for the ISE/AAA server. For example, 1.1.1.2. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/network_aaa/protocol: .. rst-class:: ansible-option-title **protocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Protocol for AAA or ISE server. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"RADIUS"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"TACACS"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/network_aaa/secondary_server_address: .. rst-class:: ansible-option-title **secondary_server_address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` :ansible-option-versionadded:`added in cisco.dnac 6.14.0` .. raw:: html
- .. raw:: html
Secondary IP address for the AAA server. For example, 1.1.1.3. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/network_aaa/server_type: .. rst-class:: ansible-option-title **server_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Server type for managing AAA for network devices. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"AAA"` - :ansible-option-choices-entry:`"ISE"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/network_aaa/shared_secret: .. rst-class:: ansible-option-title **shared_secret** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Shared secret for ISE Server. Length of the shared secret should be atleast 4 characters. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/ntp_server: .. rst-class:: ansible-option-title **ntp_server** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
IP address for NTP server under a specific site (eg 1.1.1.2). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/snmp_server: .. rst-class:: ansible-option-title **snmp_server** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Snmp Server details under a specific site. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/snmp_server/configure_dnac_ip: .. rst-class:: ansible-option-title **configure_dnac_ip** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Configuration Cisco Catalyst Center IP for SNMP Server (eg true). .. 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.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/snmp_server/ip_addresses: .. rst-class:: ansible-option-title **ip_addresses** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
IP Address for SNMP Server (eg 4.4.4.1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/syslog_server: .. rst-class:: ansible-option-title **syslog_server** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
syslog Server details under a specific site. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/syslog_server/configure_dnac_ip: .. rst-class:: ansible-option-title **configure_dnac_ip** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Configuration Cisco Catalyst Center IP for syslog server (eg true). .. 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.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/syslog_server/ip_addresses: .. rst-class:: ansible-option-title **ip_addresses** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
IP Address for syslog server (eg 4.4.4.4). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/timezone: .. rst-class:: ansible-option-title **timezone** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Time zone of a specific site. (eg Africa/Abidjan/GMT). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/wired_data_collection: .. rst-class:: ansible-option-title **wired_data_collection** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Enables or disables the collection of data from wired network devices for telemetry and monitoring purposes. Applicable from Cisco Catalyst Center version 2.3.7.6 onwards. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/wired_data_collection/enable_wired_data_collection: .. rst-class:: ansible-option-title **enable_wired_data_collection** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Enable or disable wired data collection. .. 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.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/wireless_telemetry: .. rst-class:: ansible-option-title **wireless_telemetry** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Enables or disables the collection of telemetry data from wireless network devices for performance monitoring and analysis. Applicable from Cisco Catalyst Center version 2.3.7.6 onwards. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/settings/wireless_telemetry/enable_wireless_telemetry: .. rst-class:: ansible-option-title **enable_wireless_telemetry** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Enable or disable wireless telemetry. .. 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.dnac.network_settings_workflow_manager_module__parameter-config/network_management_details/site_name: .. rst-class:: ansible-option-title **site_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The name of the site provided as a path parameter, used to specify where the IP sub-pool will be reserved. (eg Global/Chennai/Trill) .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/reserve_pool_details: .. rst-class:: ansible-option-title **reserve_pool_details** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Reserved IP subpool details from the global pool. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/reserve_pool_details/ipv4_dhcp_servers: .. rst-class:: ansible-option-title **ipv4_dhcp_servers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Specifies the IPv4 addresses for DHCP servers, for example, "1.1.1.1". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/reserve_pool_details/ipv4_dns_servers: .. rst-class:: ansible-option-title **ipv4_dns_servers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Specifies the IPv4 addresses for DNS servers, for example, "4.4.4.4". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/reserve_pool_details/ipv4_gateway: .. rst-class:: ansible-option-title **ipv4_gateway** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` :ansible-option-versionadded:`added in cisco.dnac 4.0.0` .. raw:: html
- .. raw:: html
Provides the gateway's IPv4 address, for example, "175.175.0.1". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/reserve_pool_details/ipv4_global_pool: .. rst-class:: ansible-option-title **ipv4_global_pool** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP v4 Global pool address with cidr, example 175.175.0.0/16. If both 'ipv6\_global\_pool' and 'ipv4\_global\_pool\_name' are provided, the 'ipv4\_global\_pool' will be given priority. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/reserve_pool_details/ipv4_global_pool_name: .. rst-class:: ansible-option-title **ipv4_global_pool_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` :ansible-option-versionadded:`added in cisco.dnac 6.14.0` .. raw:: html
- .. raw:: html
Specifies the name to be associated with the IPv4 Global IP Pool. If both 'ipv4\_global\_pool' and 'ipv4\_global\_pool\_name' are provided, the 'ipv4\_global\_pool' will be given priority. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/reserve_pool_details/ipv4_prefix: .. rst-class:: ansible-option-title **ipv4_prefix** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
ip4 prefix length is enabled or ipv4 total Host input is enabled .. 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.dnac.network_settings_workflow_manager_module__parameter-config/reserve_pool_details/ipv4_prefix_length: .. rst-class:: ansible-option-title **ipv4_prefix_length** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The ipv4 prefix length is required when ipv4\_prefix value is true. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/reserve_pool_details/ipv4_subnet: .. rst-class:: ansible-option-title **ipv4_subnet** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Indicates the IPv4 subnet address, for example, "175.175.0.0". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/reserve_pool_details/ipv4_total_host: .. rst-class:: ansible-option-title **ipv4_total_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The total number of hosts for IPv4, required when the 'ipv4\_prefix' is set to false. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/reserve_pool_details/ipv6_address_space: .. rst-class:: ansible-option-title **ipv6_address_space** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Determines whether both IPv6 and IPv4 inputs are required. If set to false, only IPv4 inputs are required. If set to true, both IPv6 and IPv4 inputs are required. .. 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.dnac.network_settings_workflow_manager_module__parameter-config/reserve_pool_details/ipv6_dhcp_servers: .. rst-class:: ansible-option-title **ipv6_dhcp_servers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Specifies the IPv6 addresses for DHCP servers in the format. For example, "2001:0db8:0123:4567:89ab:cdef:0001:0001". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/reserve_pool_details/ipv6_dns_servers: .. rst-class:: ansible-option-title **ipv6_dns_servers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Specifies the IPv6 addresses for DNS servers. For example, "2001:0db8:0123:4567:89ab:cdef:0002:0002". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/reserve_pool_details/ipv6_gateway: .. rst-class:: ansible-option-title **ipv6_gateway** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Provides the gateway's IPv6 address. For example, "2001:0db8:0123:4567:89ab:cdef:0003:0003". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/reserve_pool_details/ipv6_global_pool: .. rst-class:: ansible-option-title **ipv6_global_pool** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The ipv6\_global\_pool is a required when the ipv6\_address\_space is set to true. It specifies the global IPv6 address pool using CIDR notation, such as "2001:db8:85a3::/64". In cases where both ipv6\_global\_pool and ipv6\_global\_pool\_name are specified, ipv6\_global\_pool will take precedence. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/reserve_pool_details/ipv6_global_pool_name: .. rst-class:: ansible-option-title **ipv6_global_pool_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` :ansible-option-versionadded:`added in cisco.dnac 6.14.0` .. raw:: html
- .. raw:: html
Specifies the name assigned to the Ip v6 Global IP Pool. If both 'ipv6\_global\_pool' and 'ipv6\_global\_pool\_name' are provided, the 'ipv6\_global\_pool' will be given priority. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/reserve_pool_details/ipv6_prefix: .. rst-class:: ansible-option-title **ipv6_prefix** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Determines whether to enable the 'ipv6\_prefix\_length' or 'ipv6\_total\_host' input field. If IPv6 prefix value is true, the IPv6 prefix length input field is required, If it is false ipv6 total Host input is required. .. 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.dnac.network_settings_workflow_manager_module__parameter-config/reserve_pool_details/ipv6_prefix_length: .. rst-class:: ansible-option-title **ipv6_prefix_length** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Specifies the IPv6 prefix length. Required when 'ipv6\_prefix' is set to true. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/reserve_pool_details/ipv6_subnet: .. rst-class:: ansible-option-title **ipv6_subnet** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IPv6 Subnet address, example 2001:db8:85a3:0:100. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/reserve_pool_details/ipv6_total_host: .. rst-class:: ansible-option-title **ipv6_total_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Specifies the total number of IPv6 hosts. Required when 'ipv6\_prefix' is set to false. Must specify a number of IPv6 IP addresses that is less than 256. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/reserve_pool_details/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 reserve IP subpool. Required for the operations in the Reserve IP Pool. Length should be less than or equal to 100. Only letters, numbers and -\_./ characters are allowed. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/reserve_pool_details/pool_type: .. rst-class:: ansible-option-title **pool_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of the reserve ip sub pool. Generic - Used for general purpose within the network such as device management or communication between the network devices. LAN - Used for the devices and the resources within the Local Area Network such as device connectivity, internal communication, or services. Management - Used for the management purposes such as device management interfaces, management access, or other administrative functions. Service - Used for the network services and application such as DNS (Domain Name System), DHCP (Dynamic Host Configuration Protocol), NTP (Network Time Protocol). WAN - Used for the devices and resources with the Wide Area Network such as remote sites interconnection with other network or services hosted within WAN. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"Generic"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"LAN"` - :ansible-option-choices-entry:`"Management"` - :ansible-option-choices-entry:`"Service"` - :ansible-option-choices-entry:`"WAN"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/reserve_pool_details/prev_name: .. rst-class:: ansible-option-title **prev_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The former name associated with the reserved IP sub-pool. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/reserve_pool_details/site_name: .. rst-class:: ansible-option-title **site_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The name of the site provided as a path parameter, used to specify where the IP sub-pool will be reserved. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-config/reserve_pool_details/slaac_support: .. rst-class:: ansible-option-title **slaac_support** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Allows devices on IPv6 networks to self-configure their IP addresses autonomously, eliminating the need for manual setup. .. 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.dnac.network_settings_workflow_manager_module__parameter-config_verify: .. rst-class:: ansible-option-title **config_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Set to True to verify the Cisco Catalyst Center after applying the playbook config. .. 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.dnac.network_settings_workflow_manager_module__parameter-dnac_api_task_timeout: .. rst-class:: ansible-option-title **dnac_api_task_timeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Defines the timeout in seconds for API calls to retrieve task details. If the task details are not received within this period, the process will end, and a timeout notification will be logged. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`1200` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Indicates whether debugging is enabled in the Cisco Catalyst Center SDK. .. 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.dnac.network_settings_workflow_manager_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The hostname of the Cisco Catalyst Center. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-dnac_log: .. rst-class:: ansible-option-title **dnac_log** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable/disable playbook execution logging. When true and dnac\_log\_file\_path is provided, - Create the log file at the execution location with the specified name. When true and dnac\_log\_file\_path is not provided, - Create the log file at the execution location with the name 'dnac.log'. When false, - Logging is disabled. If the log file doesn't exist, - It is created in append or write mode based on the "dnac\_log\_append" flag. If the log file exists, - It is overwritten or appended based on the "dnac\_log\_append" flag. .. 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.dnac.network_settings_workflow_manager_module__parameter-dnac_log_append: .. rst-class:: ansible-option-title **dnac_log_append** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Determines the mode of the file. Set to True for 'append' mode. Set to False for 'write' mode. .. 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.dnac.network_settings_workflow_manager_module__parameter-dnac_log_file_path: .. rst-class:: ansible-option-title **dnac_log_file_path** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Governs logging. Logs are recorded if dnac\_log is True. If path is not specified, - When 'dnac\_log\_append' is True, 'dnac.log' is generated in the current Ansible directory; logs are appended. - When 'dnac\_log\_append' is False, 'dnac.log' is generated; logs are overwritten. If path is specified, - When 'dnac\_log\_append' is True, the file opens in append mode. - When 'dnac\_log\_append' is False, the file opens in write (w) mode. - In shared file scenarios, without append mode, content is overwritten after each module execution. - For a shared log file, set append to False for the 1st module (to overwrite); for subsequent modules, set append to True. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"dnac.log"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-dnac_log_level: .. rst-class:: ansible-option-title **dnac_log_level** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Sets the threshold for log level. Messages with a level equal to or higher than this will be logged. Levels are listed in order of severity [CRITICAL, ERROR, WARNING, INFO, DEBUG]. CRITICAL indicates serious errors halting the program. Displays only CRITICAL messages. ERROR indicates problems preventing a function. Displays ERROR and CRITICAL messages. WARNING indicates potential future issues. Displays WARNING, ERROR, CRITICAL messages. INFO tracks normal operation. Displays INFO, WARNING, ERROR, CRITICAL messages. DEBUG provides detailed diagnostic info. Displays all log messages. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"WARNING"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The password for authentication at the Cisco Catalyst Center. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specifies the port number associated with the Cisco Catalyst Center. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"443"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-dnac_task_poll_interval: .. rst-class:: ansible-option-title **dnac_task_poll_interval** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Specifies the interval in seconds between successive calls to the API to retrieve task details. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`2` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-user: .. rst-class:: ansible-option-title **dnac_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 username for authentication at the Cisco Catalyst Center. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_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.dnac.network_settings_workflow_manager_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specifies the version of the Cisco Catalyst Center that the SDK should use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.2.3.3"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__parameter-state: .. rst-class:: ansible-option-title **state** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The state of Cisco Catalyst Center after module completion. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"merged"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"deleted"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_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 network\_settings.NetworkSettings.create\_global\_pool, network\_settings.NetworkSettings.delete\_global\_ip\_pool, network\_settings.NetworkSettings.update\_global\_pool, network\_settings.NetworkSettings.release\_reserve\_ip\_subpool, network\_settings.NetworkSettings.reserve\_ip\_subpool, network\_settings.NetworkSettings.update\_reserve\_ip\_subpool, network\_settings.NetworkSettings.update\_network\_v2, - Paths used are post /dna/intent/api/v1/global-pool, delete /dna/intent/api/v1/global-pool/{id}, put /dna/intent/api/v1/global-pool, post /dna/intent/api/v1/reserve-ip-subpool/{siteId}, delete /dna/intent/api/v1/reserve-ip-subpool/{id}, put /dna/intent/api/v1/reserve-ip-subpool/{siteId}, put /dna/intent/api/v2/network/{siteId}, - Does not support \ :literal:`check\_mode`\ - The plugin runs on the control node and does not use any ansible connection plugins instead embedded connection manager from Cisco Catalyst Center SDK - The parameters starting with dnac\_ are used by the Cisco Catalyst Center Python SDK to establish the connection .. Seealso .. Examples Examples -------- .. code-block:: yaml+jinja - name: Create global pool cisco.dnac.network_settings_workflow_manager: 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}}" dnac_log: True dnac_log_level: "{{ dnac_log_level }}" state: merged config_verify: True config: - global_pool_details: settings: ip_pool: - name: string pool_type: Generic ip_address_space: string cidr: string gateway: string dhcp_server_ips: list dns_server_ips: list - name: Create reserve an ip pool cisco.dnac.network_settings_workflow_manager: 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}}" dnac_log: True dnac_log_level: "{{ dnac_log_level }}" state: merged config_verify: True config: - reserve_pool_details: - site_name: string name: string pool_type: LAN ipv6_address_space: True ipv4_global_pool: string ipv4_prefix: True ipv4_prefix_length: 9 ipv4_subnet: string ipv6_prefix: True ipv6_prefix_length: 64 ipv6_global_pool: string ipv6_subnet: string slaac_support: True - name: Create reserve an ip pool using global pool name cisco.dnac.network_settings_workflow_manager: 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}}" dnac_log: True dnac_log_level: "{{ dnac_log_level }}" state: merged config_verify: True config: - reserve_pool_details: - name: string site_name: string pool_type: LAN ipv6_address_space: True ipv4_global_pool_name: string ipv4_prefix: True ipv4_prefix_length: 9 ipv4_subnet: string ipv6_prefix: True ipv6_prefix_length: 64 ipv6_global_pool_name: string ipv6_subnet: string slaac_support: True - name: Delete reserved pool cisco.dnac.network_settings_workflow_manager: 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}}" dnac_log: True dnac_log_level: "{{ dnac_log_level }}" state: deleted config_verify: True config: - reserve_pool_details: - site_name: string name: string - name: Delete Global Pool cisco.dnac.network_settings_workflow_manager: dnac_host: "{{ dnac_host }}" dnac_port: "{{ dnac_port }}" dnac_username: "{{ dnac_username }}" dnac_password: "{{ dnac_password }}" dnac_verify: "{{ dnac_verify }}" dnac_debug: "{{ dnac_debug }}" dnac_version: "{{ dnac_version }}" dnac_log_level: "{{ dnac_log_level }}" dnac_log: true state: deleted config_verify: true config: - global_pool_details: settings: ip_pool: - name: string - name: Manage the network functions cisco.dnac.network_settings_workflow_manager: 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}}" dnac_log: True dnac_log_level: "{{ dnac_log_level }}" state: merged config_verify: True config: - network_management_details: - site_name: string settings: dhcp_server: list dns_server: domain_name: string primary_ip_address: string secondary_ip_address: string ntp_server: list timezone: string message_of_the_day: banner_message: string retain_existing_banner: bool netflow_collector: ip_address: string port: 443 snmp_server: configure_dnac_ip: True ip_addresses: list syslog_server: configure_dnac_ip: True ip_addresses: list - name: Adding the network_aaa and client_and_endpoint_aaa AAA server cisco.dnac.network_settings_workflow_manager: 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}}" dnac_log: True dnac_log_level: "{{ dnac_log_level }}" state: merged config_verify: True config: - network_management_details: - site_name: string settings: network_aaa: server_type: AAA primary_server_address: string secondary_server_address: string protocol: string client_and_endpoint_aaa: server_type: AAA primary_server_address: string secondary_server_address: string protocol: string - name: Adding the network_aaa and client_and_endpoint_aaa ISE server cisco.dnac.network_settings_workflow_manager: 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}}" dnac_log: True dnac_log_level: "{{ dnac_log_level }}" state: merged config_verify: True config: - network_management_details: - site_name: string settings: network_aaa: server_type: ISE pan_address: string primary_server_address: string protocol: string client_and_endpoint_aaa: server_type: ISE pan_address: string primary_server_address: string protocol: 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.dnac.network_settings_workflow_manager_module__return-response_1: .. rst-class:: ansible-option-title **response_1** .. 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:`{"executionId": "string", "executionStatusUrl": "string", "message": "string"}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__return-response_2: .. rst-class:: ansible-option-title **response_2** .. 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:`{"executionId": "string", "executionStatusUrl": "string", "message": "string"}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_workflow_manager_module__return-response_3: .. rst-class:: ansible-option-title **response_3** .. 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:`{"executionId": "string", "executionStatusUrl": "string", "message": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Muthu Rakesh (@MUTHU-RAKESH-27) Madhan Sankaranarayanan (@madhansansel) Megha Kandari (@kandarimegha) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors