.. 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 `_ (version 6.8.2). To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.dnac.network_settings_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.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config: .. rst-class:: ansible-option-title **config** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
List of details of global pool, reserved pool, network being managed. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/globalpooldetails: .. rst-class:: ansible-option-title **GlobalPoolDetails** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Global ip pool manages IPv4 and IPv6 IP pools. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/globalpooldetails/settings: .. rst-class:: ansible-option-title **settings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Global Pool's settings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/globalpooldetails/settings/ippool: .. rst-class:: ansible-option-title **ippool** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Global Pool's ippool. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/globalpooldetails/settings/ippool/dhcpserverips: .. rst-class:: ansible-option-title **dhcpServerIps** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Dhcp Server Ips. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/globalpooldetails/settings/ippool/dnsserverips: .. rst-class:: ansible-option-title **dnsServerIps** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Dns Server Ips. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/globalpooldetails/settings/ippool/gateway: .. rst-class:: ansible-option-title **gateway** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Gateway. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/globalpooldetails/settings/ippool/ipaddressspace: .. rst-class:: ansible-option-title **IpAddressSpace** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Ip address space. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/globalpooldetails/settings/ippool/ippoolcidr: .. rst-class:: ansible-option-title **ipPoolCidr** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Ip pool cidr. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/globalpooldetails/settings/ippool/ippoolname: .. rst-class:: ansible-option-title **ipPoolName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Ip Pool Name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/globalpooldetails/settings/ippool/prev_name: .. rst-class:: ansible-option-title **prev_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
previous name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails: .. rst-class:: ansible-option-title **NetworkManagementDetails** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Set default network settings for the site .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings: .. rst-class:: ansible-option-title **settings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network management details settings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/clientandendpoint_aaa: .. rst-class:: ansible-option-title **clientAndEndpoint_aaa** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network V2's clientAndEndpoint\_aaa. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/clientandendpoint_aaa/ipaddress: .. rst-class:: ansible-option-title **ipAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP address for ISE serve (eg 1.1.1.4). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/clientandendpoint_aaa/network: .. rst-class:: ansible-option-title **network** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP address for AAA or ISE server (eg 2.2.2.1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/clientandendpoint_aaa/protocol: .. rst-class:: ansible-option-title **protocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Protocol for AAA or ISE serve (eg RADIUS). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/clientandendpoint_aaa/servers: .. rst-class:: ansible-option-title **servers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Server type AAA or ISE server (eg AAA). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/clientandendpoint_aaa/sharedsecret: .. rst-class:: ansible-option-title **sharedSecret** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Shared secret for ISE server. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/dhcpserver: .. rst-class:: ansible-option-title **dhcpServer** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
DHCP Server IP (eg 1.1.1.1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/dnsserver: .. rst-class:: ansible-option-title **dnsServer** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network V2's dnsServer. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/dnsserver/domainname: .. rst-class:: ansible-option-title **domainName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Domain Name of DHCP (eg; cisco). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/dnsserver/primaryipaddress: .. rst-class:: ansible-option-title **primaryIpAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Primary IP Address for DHCP (eg 2.2.2.2). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/dnsserver/secondaryipaddress: .. rst-class:: ansible-option-title **secondaryIpAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Secondary IP Address for DHCP (eg 3.3.3.3). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/messageoftheday: .. rst-class:: ansible-option-title **messageOfTheday** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network V2's messageOfTheday. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/messageoftheday/bannermessage: .. rst-class:: ansible-option-title **bannerMessage** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Massage for Banner message (eg; Good day). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/messageoftheday/retainexistingbanner: .. rst-class:: ansible-option-title **retainExistingBanner** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Retain existing Banner Message (eg "true" or "false"). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/netflowcollector: .. rst-class:: ansible-option-title **netflowcollector** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network V2's netflowcollector. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/netflowcollector/ipaddress: .. rst-class:: ansible-option-title **ipAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP Address for NetFlow collector (eg 3.3.3.1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/netflowcollector/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Port for NetFlow Collector (eg; 443). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/network_aaa: .. rst-class:: ansible-option-title **network_aaa** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network V2's network\_aaa. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/network_aaa/ipaddress: .. rst-class:: ansible-option-title **ipAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP address for AAA and ISE server (eg 1.1.1.1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/network_aaa/network: .. rst-class:: ansible-option-title **network** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP Address for AAA or ISE server (eg 2.2.2.2). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/network_aaa/protocol: .. rst-class:: ansible-option-title **protocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Protocol for AAA or ISE serve (eg RADIUS). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/network_aaa/servers: .. rst-class:: ansible-option-title **servers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Server type for AAA Network (eg AAA). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/network_aaa/sharedsecret: .. rst-class:: ansible-option-title **sharedSecret** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Shared secret for ISE Server. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/ntpserver: .. rst-class:: ansible-option-title **ntpServer** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
IP address for NTP server (eg 1.1.1.2). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/snmpserver: .. rst-class:: ansible-option-title **snmpServer** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network V2's snmpServer. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/snmpserver/configurednacip: .. rst-class:: ansible-option-title **configureDnacIP** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Configuration Cisco DNA Center IP for SNMP Server (eg true). .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/snmpserver/ipaddresses: .. rst-class:: ansible-option-title **ipAddresses** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
IP Address for SNMP Server (eg 4.4.4.1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/syslogserver: .. rst-class:: ansible-option-title **syslogServer** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network V2's syslogServer. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/syslogserver/configurednacip: .. rst-class:: ansible-option-title **configureDnacIP** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Configuration Cisco DNA Center IP for syslog server (eg true). .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/syslogserver/ipaddresses: .. rst-class:: ansible-option-title **ipAddresses** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
IP Address for syslog server (eg 4.4.4.4). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/settings/timezone: .. rst-class:: ansible-option-title **timezone** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Input for time zone (eg Africa/Abidjan). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/networkmanagementdetails/sitename: .. rst-class:: ansible-option-title **siteName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Site name path parameter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reservepooldetails: .. rst-class:: ansible-option-title **ReservePoolDetails** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Reserving IP subpool from the global pool .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reservepooldetails/ipv4dhcpservers: .. rst-class:: ansible-option-title **ipv4DhcpServers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
IPv4 input for dhcp server ip example 1.1.1.1. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reservepooldetails/ipv4dnsservers: .. rst-class:: ansible-option-title **ipv4DnsServers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
IPv4 input for dns server ip example 4.4.4.4. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reservepooldetails/ipv4gateway: .. rst-class:: ansible-option-title **ipv4GateWay** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` :ansible-option-versionadded:`added in cisco.dnac 4.0.0` .. raw:: html
- .. raw:: html
Gateway ip address details, example 175.175.0.1. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reservepooldetails/ipv4globalpool: .. rst-class:: ansible-option-title **ipv4GlobalPool** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP v4 Global pool address with cidr, example 175.175.0.0/16. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reservepooldetails/ipv4prefix: .. rst-class:: ansible-option-title **ipv4Prefix** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
ip4 prefix length is enabled or ipv4 total Host input is enabled .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reservepooldetails/ipv4prefixlength: .. rst-class:: ansible-option-title **ipv4PrefixLength** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The ipv4 prefix length is required when ipv4prefix value is true. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reservepooldetails/ipv4subnet: .. rst-class:: ansible-option-title **ipv4Subnet** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IPv4 Subnet address, example 175.175.0.0. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reservepooldetails/ipv4totalhost: .. rst-class:: ansible-option-title **ipv4TotalHost** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
IPv4 total host is required when ipv4prefix value is false. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reservepooldetails/ipv6addressspace: .. rst-class:: ansible-option-title **ipv6AddressSpace** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
If the value is false only ipv4 input are required, otherwise both ipv6 and ipv4 are required. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reservepooldetails/ipv6dhcpservers: .. rst-class:: ansible-option-title **ipv6DhcpServers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
IPv6 format dhcp server as input example 2001 db8 1234. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reservepooldetails/ipv6dnsservers: .. rst-class:: ansible-option-title **ipv6DnsServers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
IPv6 format dns server input example 2001 db8 1234. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reservepooldetails/ipv6gateway: .. rst-class:: ansible-option-title **ipv6GateWay** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Gateway ip address details, example 2001 db8 85a3 0 100 1. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reservepooldetails/ipv6globalpool: .. rst-class:: ansible-option-title **ipv6GlobalPool** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IPv6 Global pool address with cidr this is required when Ipv6AddressSpace value is true, example 2001 db8 85a3 /64. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reservepooldetails/ipv6prefix: .. rst-class:: ansible-option-title **ipv6Prefix** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
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
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reservepooldetails/ipv6prefixlength: .. rst-class:: ansible-option-title **ipv6PrefixLength** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
IPv6 prefix length is required when the ipv6prefix value is true. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reservepooldetails/ipv6subnet: .. rst-class:: ansible-option-title **ipv6Subnet** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IPv6 Subnet address, example 2001 db8 85a3 0 100. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reservepooldetails/ipv6totalhost: .. rst-class:: ansible-option-title **ipv6TotalHost** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
IPv6 total host is required when ipv6prefix value is false. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reservepooldetails/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the reserve ip sub pool. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reservepooldetails/prev_name: .. rst-class:: ansible-option-title **prev_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Previous name of the reserve ip sub pool. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reservepooldetails/sitename: .. rst-class:: ansible-option-title **siteName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Site name path parameter. Site name to reserve the ip sub pool. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reservepooldetails/slaacsupport: .. rst-class:: ansible-option-title **slaacSupport** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Slaac Support. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-config/reservepooldetails/type: .. rst-class:: ansible-option-title **type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of the reserve ip sub pool. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
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
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco DNA Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-dnac_log: .. rst-class:: ansible-option-title **dnac_log** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for logging playbook execution details. If set to true the log file will be created at the location of the execution with the name dnac.log .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"443"` .. raw:: html
* - .. raw:: html
.. _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 .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-state: .. rst-class:: ansible-option-title **state** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The state of Cisco DNA Center after module completion. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"merged"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"deleted"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco 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
.. 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 state: merged config: - GlobalPoolDetails: settings: ippool: - ipPoolName: string gateway: string IpAddressSpace: string ipPoolCidr: string type: Generic dhcpServerIps: list dnsServerIps: list ReservePoolDetails: ipv6AddressSpace: True ipv4GlobalPool: string ipv4Prefix: True ipv4PrefixLength: 9 ipv4Subnet: string name: string ipv6Prefix: True ipv6PrefixLength: 64 ipv6GlobalPool: string ipv6Subnet: string siteName: string slaacSupport: True type: LAN NetworkManagementDetails: settings: dhcpServer: list dnsServer: domainName: string primaryIpAddress: string secondaryIpAddress: string clientAndEndpoint_aaa: network: string protocol: string servers: string messageOfTheday: bannerMessage: string retainExistingBanner: string netflowcollector: ipAddress: string port: 443 network_aaa: network: string protocol: string servers: string ntpServer: list snmpServer: configureDnacIP: True ipAddresses: list syslogServer: configureDnacIP: True ipAddresses: list siteName: string .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__return-response_1: .. rst-class:: ansible-option-title **response_1** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco 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
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__return-response_2: .. rst-class:: ansible-option-title **response_2** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco 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
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_settings_intent_module__return-response_3: .. rst-class:: ansible-option-title **response_3** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco 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
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Muthu Rakesh (@MUTHU-RAKESH-27) Madhan Sankaranarayanan (@madhansansel) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors