.. 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_intent_module:
.. Anchors: short name for ansible.builtin
.. Anchors: aliases
.. Title
cisco.dnac.network_settings_intent module -- Resource module for IP Address pools and network functions
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. Collection note
.. note::
This module is part of the `cisco.dnac collection <https://galaxy.ansible.com/cisco/dnac>`_ (version 6.17.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 <ansible_collections.cisco.dnac.network_settings_intent_module_requirements>` for details.
To use it in a playbook, specify: :code:`cisco.dnac.network_settings_intent`.
.. 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_intent_module_requirements:
Requirements
------------
The below requirements are needed on the host that executes this module.
- dnacentersdk == 2.4.5
- python \>= 3.9
.. 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-config"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config:
.. rst-class:: ansible-option-title
**config**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` / :ansible-option-required:`required`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
List of details of global pool, reserved pool, network being managed.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/global_pool_details"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/global_pool_details:
.. rst-class:: ansible-option-title
**global_pool_details**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/global_pool_details" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`dictionary`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Manages IPv4 and IPv6 IP pools in the global level.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/global_pool_details/settings"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/global_pool_details/settings:
.. rst-class:: ansible-option-title
**settings**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/global_pool_details/settings" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`dictionary`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Global Pool's settings.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/global_pool_details/settings/ip_pool"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/global_pool_details/settings/ip_pool:
.. rst-class:: ansible-option-title
**ip_pool**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/global_pool_details/settings/ip_pool" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Contains a list of global IP pool configurations.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/global_pool_details/settings/ip_pool/cidr"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/global_pool_details/settings/ip_pool/cidr:
.. rst-class:: ansible-option-title
**cidr**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/global_pool_details/settings/ip_pool/cidr" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Defines the IP pool's Classless Inter-Domain Routing block, enabling systematic IP address distribution within a network.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/global_pool_details/settings/ip_pool/dhcp_server_ips"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/global_pool_details/settings/ip_pool/dhcp_server_ips:
.. rst-class:: ansible-option-title
**dhcp_server_ips**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/global_pool_details/settings/ip_pool/dhcp_server_ips" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`list` / :ansible-option-elements:`elements=string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
The DHCP server IPs responsible for automatically assigning IP addresses and network configuration parameters to devices on a local network.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/global_pool_details/settings/ip_pool/dns_server_ips"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/global_pool_details/settings/ip_pool/dns_server_ips:
.. rst-class:: ansible-option-title
**dns_server_ips**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/global_pool_details/settings/ip_pool/dns_server_ips" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`list` / :ansible-option-elements:`elements=string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Responsible for translating domain names into corresponding IP addresses.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/global_pool_details/settings/ip_pool/gateway"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/global_pool_details/settings/ip_pool/gateway:
.. rst-class:: ansible-option-title
**gateway**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/global_pool_details/settings/ip_pool/gateway" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Serves as an entry or exit point for data traffic between networks.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/global_pool_details/settings/ip_pool/ip_address_space"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/global_pool_details/settings/ip_pool/ip_address_space:
.. rst-class:: ansible-option-title
**ip_address_space**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/global_pool_details/settings/ip_pool/ip_address_space" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
IP address space either IPv4 or IPv6.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/global_pool_details/settings/ip_pool/name"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/global_pool_details/settings/ip_pool/name:
.. rst-class:: ansible-option-title
**name**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/global_pool_details/settings/ip_pool/name" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Specifies the name assigned to the Global IP Pool.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/global_pool_details/settings/ip_pool/pool_type"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/global_pool_details/settings/ip_pool/pool_type:
.. rst-class:: ansible-option-title
**pool_type**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/global_pool_details/settings/ip_pool/pool_type" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
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
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/global_pool_details/settings/ip_pool/prev_name"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/global_pool_details/settings/ip_pool/prev_name:
.. rst-class:: ansible-option-title
**prev_name**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/global_pool_details/settings/ip_pool/prev_name" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
The former identifier for the global pool. It should be used exclusively when you need to update the global pool's name.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details:
.. rst-class:: ansible-option-title
**network_management_details**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`dictionary`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Set default network settings for the site
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings:
.. rst-class:: ansible-option-title
**settings**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`dictionary`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Network management details settings.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/client_and_endpoint_aaa"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/client_and_endpoint_aaa:
.. rst-class:: ansible-option-title
**client_and_endpoint_aaa**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/client_and_endpoint_aaa" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`dictionary`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Network V2's clientAndEndpoint\_aaa.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/client_and_endpoint_aaa/ip_address"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/client_and_endpoint_aaa/ip_address:
.. rst-class:: ansible-option-title
**ip_address**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/client_and_endpoint_aaa/ip_address" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
IP address for ISE serve (eg 1.1.1.4).
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/client_and_endpoint_aaa/network"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/client_and_endpoint_aaa/network:
.. rst-class:: ansible-option-title
**network**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/client_and_endpoint_aaa/network" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
IP address for AAA or ISE server (eg 2.2.2.1).
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/client_and_endpoint_aaa/protocol"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/client_and_endpoint_aaa/protocol:
.. rst-class:: ansible-option-title
**protocol**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/client_and_endpoint_aaa/protocol" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Protocol for AAA or ISE serve (eg RADIUS).
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/client_and_endpoint_aaa/servers"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/client_and_endpoint_aaa/servers:
.. rst-class:: ansible-option-title
**servers**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/client_and_endpoint_aaa/servers" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Server type AAA or ISE server (eg AAA).
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/client_and_endpoint_aaa/shared_secret"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/client_and_endpoint_aaa/shared_secret:
.. rst-class:: ansible-option-title
**shared_secret**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/client_and_endpoint_aaa/shared_secret" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Shared secret for ISE server.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/dhcp_server"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/dhcp_server:
.. rst-class:: ansible-option-title
**dhcp_server**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/dhcp_server" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`list` / :ansible-option-elements:`elements=string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
DHCP Server IP (eg 1.1.1.1).
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/dns_server"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/dns_server:
.. rst-class:: ansible-option-title
**dns_server**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/dns_server" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`dictionary`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Network V2's dnsServer.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/dns_server/domain_name"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/dns_server/domain_name:
.. rst-class:: ansible-option-title
**domain_name**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/dns_server/domain_name" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Domain Name of DHCP (eg; cisco).
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/dns_server/primary_ip_address"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/dns_server/primary_ip_address:
.. rst-class:: ansible-option-title
**primary_ip_address**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/dns_server/primary_ip_address" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Primary IP Address for DHCP (eg 2.2.2.2).
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/dns_server/secondary_ip_address"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/dns_server/secondary_ip_address:
.. rst-class:: ansible-option-title
**secondary_ip_address**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/dns_server/secondary_ip_address" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Secondary IP Address for DHCP (eg 3.3.3.3).
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/message_of_the_day"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/message_of_the_day:
.. rst-class:: ansible-option-title
**message_of_the_day**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/message_of_the_day" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`dictionary`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Network V2's messageOfTheday.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/message_of_the_day/banner_message"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/message_of_the_day/banner_message:
.. rst-class:: ansible-option-title
**banner_message**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/message_of_the_day/banner_message" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Massage for Banner message (eg; Good day).
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/message_of_the_day/retain_existing_banner"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/message_of_the_day/retain_existing_banner:
.. rst-class:: ansible-option-title
**retain_existing_banner**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/message_of_the_day/retain_existing_banner" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Retain existing Banner Message (eg "true" or "false").
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/netflow_collector"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/netflow_collector:
.. rst-class:: ansible-option-title
**netflow_collector**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/netflow_collector" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`dictionary`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Network V2's netflowcollector.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/netflow_collector/ip_address"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/netflow_collector/ip_address:
.. rst-class:: ansible-option-title
**ip_address**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/netflow_collector/ip_address" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
IP Address for NetFlow collector (eg 3.3.3.1).
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/netflow_collector/port"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/netflow_collector/port:
.. rst-class:: ansible-option-title
**port**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/netflow_collector/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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Port for NetFlow Collector (eg; 443).
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/network_aaa"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/network_aaa:
.. rst-class:: ansible-option-title
**network_aaa**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/network_aaa" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`dictionary`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Network V2's network\_aaa.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/network_aaa/ip_address"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/network_aaa/ip_address:
.. rst-class:: ansible-option-title
**ip_address**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/network_aaa/ip_address" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
IP address for AAA and ISE server (eg 1.1.1.1).
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/network_aaa/network"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/network_aaa/network:
.. rst-class:: ansible-option-title
**network**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/network_aaa/network" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
IP Address for AAA or ISE server (eg 2.2.2.2).
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/network_aaa/protocol"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/network_aaa/protocol:
.. rst-class:: ansible-option-title
**protocol**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/network_aaa/protocol" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Protocol for AAA or ISE serve (eg RADIUS).
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/network_aaa/servers"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/network_aaa/servers:
.. rst-class:: ansible-option-title
**servers**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/network_aaa/servers" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Server type for AAA Network (eg AAA).
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/network_aaa/shared_secret"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/network_aaa/shared_secret:
.. rst-class:: ansible-option-title
**shared_secret**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/network_aaa/shared_secret" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Shared secret for ISE Server.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/ntp_server"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/ntp_server:
.. rst-class:: ansible-option-title
**ntp_server**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/ntp_server" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`list` / :ansible-option-elements:`elements=string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
IP address for NTP server (eg 1.1.1.2).
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/snmp_server"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/snmp_server:
.. rst-class:: ansible-option-title
**snmp_server**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/snmp_server" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`dictionary`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Network V2's snmpServer.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/snmp_server/configure_dnac_ip"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/snmp_server/configure_dnac_ip:
.. rst-class:: ansible-option-title
**configure_dnac_ip**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/snmp_server/configure_dnac_ip" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
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
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/snmp_server/ip_addresses"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/snmp_server/ip_addresses:
.. rst-class:: ansible-option-title
**ip_addresses**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/snmp_server/ip_addresses" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`list` / :ansible-option-elements:`elements=string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
IP Address for SNMP Server (eg 4.4.4.1).
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/syslog_server"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/syslog_server:
.. rst-class:: ansible-option-title
**syslog_server**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/syslog_server" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`dictionary`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Network V2's syslogServer.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/syslog_server/configure_dnac_ip"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/syslog_server/configure_dnac_ip:
.. rst-class:: ansible-option-title
**configure_dnac_ip**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/syslog_server/configure_dnac_ip" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
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
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/syslog_server/ip_addresses"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/syslog_server/ip_addresses:
.. rst-class:: ansible-option-title
**ip_addresses**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/syslog_server/ip_addresses" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`list` / :ansible-option-elements:`elements=string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
IP Address for syslog server (eg 4.4.4.4).
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/settings/timezone"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/settings/timezone:
.. rst-class:: ansible-option-title
**timezone**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/settings/timezone" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Input for time zone (eg Africa/Abidjan).
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/network_management_details/site_name"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/network_management_details/site_name:
.. rst-class:: ansible-option-title
**site_name**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/network_management_details/site_name" 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-indent-desc"></div><div class="ansible-option-cell">
The name of the site provided as a path parameter, used to specify where the IP sub-pool will be reserved.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/reserve_pool_details"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reserve_pool_details:
.. rst-class:: ansible-option-title
**reserve_pool_details**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/reserve_pool_details" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`dictionary`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Reserved IP subpool details from the global pool.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/reserve_pool_details/ipv4_dhcp_servers"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reserve_pool_details/ipv4_dhcp_servers:
.. rst-class:: ansible-option-title
**ipv4_dhcp_servers**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/reserve_pool_details/ipv4_dhcp_servers" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`list` / :ansible-option-elements:`elements=string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Specifies the IPv4 addresses for DHCP servers, for example, "1.1.1.1".
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/reserve_pool_details/ipv4_dns_servers"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reserve_pool_details/ipv4_dns_servers:
.. rst-class:: ansible-option-title
**ipv4_dns_servers**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/reserve_pool_details/ipv4_dns_servers" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`list` / :ansible-option-elements:`elements=string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Specifies the IPv4 addresses for DNS servers, for example, "4.4.4.4".
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/reserve_pool_details/ipv4_gateway"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reserve_pool_details/ipv4_gateway:
.. rst-class:: ansible-option-title
**ipv4_gateway**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/reserve_pool_details/ipv4_gateway" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
:ansible-option-versionadded:`added in cisco.dnac 4.0.0`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Provides the gateway's IPv4 address, for example, "175.175.0.1".
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/reserve_pool_details/ipv4_global_pool"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reserve_pool_details/ipv4_global_pool:
.. rst-class:: ansible-option-title
**ipv4_global_pool**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/reserve_pool_details/ipv4_global_pool" 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-indent-desc"></div><div class="ansible-option-cell">
IP v4 Global pool address with cidr, example 175.175.0.0/16.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/reserve_pool_details/ipv4_prefix"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reserve_pool_details/ipv4_prefix:
.. rst-class:: ansible-option-title
**ipv4_prefix**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/reserve_pool_details/ipv4_prefix" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
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
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/reserve_pool_details/ipv4_prefix_length"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reserve_pool_details/ipv4_prefix_length:
.. rst-class:: ansible-option-title
**ipv4_prefix_length**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/reserve_pool_details/ipv4_prefix_length" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
The ipv4 prefix length is required when ipv4\_prefix value is true.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/reserve_pool_details/ipv4_subnet"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reserve_pool_details/ipv4_subnet:
.. rst-class:: ansible-option-title
**ipv4_subnet**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/reserve_pool_details/ipv4_subnet" 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-indent-desc"></div><div class="ansible-option-cell">
Indicates the IPv4 subnet address, for example, "175.175.0.0".
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/reserve_pool_details/ipv4_total_host"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reserve_pool_details/ipv4_total_host:
.. rst-class:: ansible-option-title
**ipv4_total_host**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/reserve_pool_details/ipv4_total_host" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
The total number of hosts for IPv4, required when the 'ipv4\_prefix' is set to false.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/reserve_pool_details/ipv6_address_space"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reserve_pool_details/ipv6_address_space:
.. rst-class:: ansible-option-title
**ipv6_address_space**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/reserve_pool_details/ipv6_address_space" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
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
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/reserve_pool_details/ipv6_dhcp_servers"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reserve_pool_details/ipv6_dhcp_servers:
.. rst-class:: ansible-option-title
**ipv6_dhcp_servers**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/reserve_pool_details/ipv6_dhcp_servers" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`list` / :ansible-option-elements:`elements=string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Specifies the IPv6 addresses for DHCP servers in the format. For example, "2001:0db8:0123:4567:89ab:cdef:0001:0001".
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/reserve_pool_details/ipv6_dns_servers"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reserve_pool_details/ipv6_dns_servers:
.. rst-class:: ansible-option-title
**ipv6_dns_servers**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/reserve_pool_details/ipv6_dns_servers" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`list` / :ansible-option-elements:`elements=string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Specifies the IPv6 addresses for DNS servers. For example, "2001:0db8:0123:4567:89ab:cdef:0002:0002".
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/reserve_pool_details/ipv6_gateway"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reserve_pool_details/ipv6_gateway:
.. rst-class:: ansible-option-title
**ipv6_gateway**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/reserve_pool_details/ipv6_gateway" 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-indent-desc"></div><div class="ansible-option-cell">
Provides the gateway's IPv6 address. For example, "2001:0db8:0123:4567:89ab:cdef:0003:0003".
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/reserve_pool_details/ipv6_global_pool"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reserve_pool_details/ipv6_global_pool:
.. rst-class:: ansible-option-title
**ipv6_global_pool**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/reserve_pool_details/ipv6_global_pool" 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-indent-desc"></div><div class="ansible-option-cell">
IPv6 Global pool address with cidr this is required when ipv6\_address\_space value is true, example 2001 db8 85a3 /64.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/reserve_pool_details/ipv6_prefix"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reserve_pool_details/ipv6_prefix:
.. rst-class:: ansible-option-title
**ipv6_prefix**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/reserve_pool_details/ipv6_prefix" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Ipv6 prefix value is true, the ip6 prefix length input field is enabled, if it is false ipv6 total Host input is enable.
.. rst-class:: ansible-option-line
:ansible-option-choices:`Choices:`
- :ansible-option-choices-entry:`false`
- :ansible-option-choices-entry:`true`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/reserve_pool_details/ipv6_prefix_length"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reserve_pool_details/ipv6_prefix_length:
.. rst-class:: ansible-option-title
**ipv6_prefix_length**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/reserve_pool_details/ipv6_prefix_length" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
IPv6 prefix length is required when the ipv6\_prefix value is true.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/reserve_pool_details/ipv6_subnet"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reserve_pool_details/ipv6_subnet:
.. rst-class:: ansible-option-title
**ipv6_subnet**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/reserve_pool_details/ipv6_subnet" 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-indent-desc"></div><div class="ansible-option-cell">
IPv6 Subnet address, example 2001 db8 85a3 0 100.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/reserve_pool_details/ipv6_total_host"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reserve_pool_details/ipv6_total_host:
.. rst-class:: ansible-option-title
**ipv6_total_host**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/reserve_pool_details/ipv6_total_host" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
The total number of hosts for IPv6 is required if the 'ipv6\_prefix' is set to false.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/reserve_pool_details/name"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reserve_pool_details/name:
.. rst-class:: ansible-option-title
**name**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/reserve_pool_details/name" 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-indent-desc"></div><div class="ansible-option-cell">
Name of the reserve IP subpool.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/reserve_pool_details/pool_type"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reserve_pool_details/pool_type:
.. rst-class:: ansible-option-title
**pool_type**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/reserve_pool_details/pool_type" 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-indent-desc"></div><div class="ansible-option-cell">
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
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/reserve_pool_details/prev_name"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reserve_pool_details/prev_name:
.. rst-class:: ansible-option-title
**prev_name**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/reserve_pool_details/prev_name" 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-indent-desc"></div><div class="ansible-option-cell">
The former name associated with the reserved IP sub-pool.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/reserve_pool_details/site_name"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reserve_pool_details/site_name:
.. rst-class:: ansible-option-title
**site_name**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/reserve_pool_details/site_name" 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-indent-desc"></div><div class="ansible-option-cell">
The name of the site provided as a path parameter, used to specify where the IP sub-pool will be reserved.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/reserve_pool_details/slaac_support"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reserve_pool_details/slaac_support:
.. rst-class:: ansible-option-title
**slaac_support**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/reserve_pool_details/slaac_support" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
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
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config_verify"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config_verify:
.. rst-class:: ansible-option-title
**config_verify**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config_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">
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
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dnac_api_task_timeout"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-dnac_api_task_timeout:
.. rst-class:: ansible-option-title
**dnac_api_task_timeout**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dnac_api_task_timeout" 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">
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
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dnac_debug"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_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.network_settings_intent_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_log"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-dnac_log:
.. rst-class:: ansible-option-title
**dnac_log**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dnac_log" 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/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
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dnac_log_append"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-dnac_log_append:
.. rst-class:: ansible-option-title
**dnac_log_append**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dnac_log_append" 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">
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
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dnac_log_file_path"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-dnac_log_file_path:
.. rst-class:: ansible-option-title
**dnac_log_file_path**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dnac_log_file_path" 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">
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
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dnac_log_level"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-dnac_log_level:
.. rst-class:: ansible-option-title
**dnac_log_level**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dnac_log_level" 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">
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
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dnac_password"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_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.network_settings_intent_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:`string`
.. 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_task_poll_interval"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-dnac_task_poll_interval:
.. rst-class:: ansible-option-title
**dnac_task_poll_interval**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dnac_task_poll_interval" 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">
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
</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.network_settings_intent_module__parameter-dnac_username:
.. _ansible_collections.cisco.dnac.network_settings_intent_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.network_settings_intent_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.network_settings_intent_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.2.3.3"`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-state"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-state:
.. rst-class:: ansible-option-title
**state**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-state" 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 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
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-validate_response_schema"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_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>
.. 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, 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
.. Examples
Examples
--------
.. code-block:: yaml+jinja
- name: Create global pool, reserve an ip pool and network
cisco.dnac.network_settings_intent:
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
gateway: string
ip_address_space: string
cidr: string
pool_type: Generic
dhcp_server_ips: list
dns_server_ips: list
reserve_pool_details:
ipv6_address_space: True
ipv4_global_pool: string
ipv4_prefix: True
ipv4_prefix_length: 9
ipv4_subnet: string
name: string
ipv6_prefix: True
ipv6_prefix_length: 64
ipv6_global_pool: string
ipv6_subnet: string
site_name: string
slaac_support: True
pool_type: LAN
network_management_details:
settings:
dhcp_server: list
dns_server:
domain_name: string
primary_ip_address: string
secondary_ip_address: string
client_and_endpoint_aaa:
network: string
protocol: string
servers: string
message_of_the_day:
banner_message: string
retain_existing_banner: string
netflow_collector:
ip_address: string
port: 443
network_aaa:
network: string
protocol: string
servers: string
ntp_server: list
snmp_server:
configure_dnac_ip: True
ip_addresses: list
syslog_server:
configure_dnac_ip: True
ip_addresses: list
site_name: 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-response_1"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__return-response_1:
.. rst-class:: ansible-option-title
**response_1**
.. raw:: html
<a class="ansibleOptionLink" href="#return-response_1" 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 DNA 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
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-response_2"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__return-response_2:
.. rst-class:: ansible-option-title
**response_2**
.. raw:: html
<a class="ansibleOptionLink" href="#return-response_2" 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 DNA 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
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-response_3"></div>
.. _ansible_collections.cisco.dnac.network_settings_intent_module__return-response_3:
.. rst-class:: ansible-option-title
**response_3**
.. raw:: html
<a class="ansibleOptionLink" href="#return-response_3" 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 DNA 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
</div>
.. Status (Presently only deprecated)
.. Authors
Authors
~~~~~~~
- Muthu Rakesh (@MUTHU-RAKESH-27) Madhan Sankaranarayanan (@madhansansel)
.. 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