.. 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.reserve_ip_subpool_update_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.reserve_ip_subpool_update module -- Resource module for Reserve Ip Subpool Update ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection <https://galaxy.ansible.com/cisco/dnac>`_ (version 6.19.0). 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.reserve_ip_subpool_update_module_requirements>` for details. To use it in a playbook, specify: :code:`cisco.dnac.reserve_ip_subpool_update`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 4.0.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operation update of the resource Reserve Ip Subpool Update. - API to update ip subpool from the global pool. .. note:: This module has a corresponding :ref:`action plugin <action_plugins>`. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.reserve_ip_subpool_update_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.7.2 - python \>= 3.5 .. 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-dnac_debug"></div> .. _ansible_collections.cisco.dnac.reserve_ip_subpool_update_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.reserve_ip_subpool_update_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_password"></div> .. _ansible_collections.cisco.dnac.reserve_ip_subpool_update_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.reserve_ip_subpool_update_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:`integer` .. 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_username"></div> <div class="ansibleOptionAnchor" id="parameter-user"></div> .. _ansible_collections.cisco.dnac.reserve_ip_subpool_update_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.reserve_ip_subpool_update_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.reserve_ip_subpool_update_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.reserve_ip_subpool_update_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.3.7.6"` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-id"></div> .. _ansible_collections.cisco.dnac.reserve_ip_subpool_update_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html <a class="ansibleOptionLink" href="#parameter-id" 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"> Id query parameter. Id of subpool group. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-ipv4DhcpServers"></div> .. _ansible_collections.cisco.dnac.reserve_ip_subpool_update_module__parameter-ipv4dhcpservers: .. rst-class:: ansible-option-title **ipv4DhcpServers** .. raw:: html <a class="ansibleOptionLink" href="#parameter-ipv4DhcpServers" 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-cell"> IPv4 input for dhcp server ip example "1.1.1.1". .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-ipv4DnsServers"></div> .. _ansible_collections.cisco.dnac.reserve_ip_subpool_update_module__parameter-ipv4dnsservers: .. rst-class:: ansible-option-title **ipv4DnsServers** .. raw:: html <a class="ansibleOptionLink" href="#parameter-ipv4DnsServers" 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-cell"> IPv4 input for dns server ip example "4.4.4.4". .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-ipv4GateWay"></div> .. _ansible_collections.cisco.dnac.reserve_ip_subpool_update_module__parameter-ipv4gateway: .. rst-class:: ansible-option-title **ipv4GateWay** .. raw:: html <a class="ansibleOptionLink" href="#parameter-ipv4GateWay" 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"> Gateway ip address details, example 175.175.0.1. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-ipv6AddressSpace"></div> .. _ansible_collections.cisco.dnac.reserve_ip_subpool_update_module__parameter-ipv6addressspace: .. rst-class:: ansible-option-title **ipv6AddressSpace** .. raw:: html <a class="ansibleOptionLink" href="#parameter-ipv6AddressSpace" 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"> If the value is false only ipv4 input are required. NOTE if value is false then any existing ipv6 subpool in the group will be removed. .. 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-ipv6DhcpServers"></div> .. _ansible_collections.cisco.dnac.reserve_ip_subpool_update_module__parameter-ipv6dhcpservers: .. rst-class:: ansible-option-title **ipv6DhcpServers** .. raw:: html <a class="ansibleOptionLink" href="#parameter-ipv6DhcpServers" 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-cell"> IPv6 format dhcp server as input example "2001 db8 1234". .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-ipv6DnsServers"></div> .. _ansible_collections.cisco.dnac.reserve_ip_subpool_update_module__parameter-ipv6dnsservers: .. rst-class:: ansible-option-title **ipv6DnsServers** .. raw:: html <a class="ansibleOptionLink" href="#parameter-ipv6DnsServers" 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-cell"> IPv6 format dns server input example "2001 db8 1234". .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-ipv6GateWay"></div> .. _ansible_collections.cisco.dnac.reserve_ip_subpool_update_module__parameter-ipv6gateway: .. rst-class:: ansible-option-title **ipv6GateWay** .. raw:: html <a class="ansibleOptionLink" href="#parameter-ipv6GateWay" 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"> Gateway ip address details, example 2001 db8 85a3 0 100 1. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-ipv6GlobalPool"></div> .. _ansible_collections.cisco.dnac.reserve_ip_subpool_update_module__parameter-ipv6globalpool: .. rst-class:: ansible-option-title **ipv6GlobalPool** .. raw:: html <a class="ansibleOptionLink" href="#parameter-ipv6GlobalPool" 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"> IPv6 Global pool address with cidr this is required when Ipv6AddressSpace value is true, example 2001 db8 85a3 /64. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-ipv6Prefix"></div> .. _ansible_collections.cisco.dnac.reserve_ip_subpool_update_module__parameter-ipv6prefix: .. rst-class:: ansible-option-title **ipv6Prefix** .. raw:: html <a class="ansibleOptionLink" href="#parameter-ipv6Prefix" 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"> 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-cell"> <div class="ansibleOptionAnchor" id="parameter-ipv6PrefixLength"></div> .. _ansible_collections.cisco.dnac.reserve_ip_subpool_update_module__parameter-ipv6prefixlength: .. rst-class:: ansible-option-title **ipv6PrefixLength** .. raw:: html <a class="ansibleOptionLink" href="#parameter-ipv6PrefixLength" 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"> IPv6 prefix length is required when the ipv6prefix value is true. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-ipv6Subnet"></div> .. _ansible_collections.cisco.dnac.reserve_ip_subpool_update_module__parameter-ipv6subnet: .. rst-class:: ansible-option-title **ipv6Subnet** .. raw:: html <a class="ansibleOptionLink" href="#parameter-ipv6Subnet" 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"> IPv6 Subnet address, example 2001 db8 85a3 0 100 . .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-ipv6TotalHost"></div> .. _ansible_collections.cisco.dnac.reserve_ip_subpool_update_module__parameter-ipv6totalhost: .. rst-class:: ansible-option-title **ipv6TotalHost** .. raw:: html <a class="ansibleOptionLink" href="#parameter-ipv6TotalHost" 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"> Size of pool in terms of number of IPs. IPv6 total host is required when ipv6prefix value is false. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-name"></div> .. _ansible_collections.cisco.dnac.reserve_ip_subpool_update_module__parameter-name: .. rst-class:: ansible-option-title **name** .. raw:: html <a class="ansibleOptionLink" href="#parameter-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-cell"> Name of the reserve ip sub pool. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-siteId"></div> .. _ansible_collections.cisco.dnac.reserve_ip_subpool_update_module__parameter-siteid: .. rst-class:: ansible-option-title **siteId** .. raw:: html <a class="ansibleOptionLink" href="#parameter-siteId" 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"> SiteId path parameter. Site id of site to update sub pool. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-slaacSupport"></div> .. _ansible_collections.cisco.dnac.reserve_ip_subpool_update_module__parameter-slaacsupport: .. rst-class:: ansible-option-title **slaacSupport** .. raw:: html <a class="ansibleOptionLink" href="#parameter-slaacSupport" 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"> Slaac Support. .. 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-validate_response_schema"></div> .. _ansible_collections.cisco.dnac.reserve_ip_subpool_update_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.update\_reserve\_ip\_subpool, - Paths used are put /dna/intent/api/v1/reserve-ip-subpool/{siteId}, - Removed 'type', 'ipv4GlobalPool', 'ipv4Prefix', 'ipv4PrefixLength', 'ipv4Subnet' and 'ipv4TotalHost' options in v4.3.0. - 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 See Also -------- .. seealso:: `Cisco DNA Center documentation for Network Settings UpdateReserveIPSubpool <https://developer.cisco.com/docs/dna-center/#!update-reserve-ip-subpool>`_ Complete reference of the UpdateReserveIPSubpool API. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Update by id cisco.dnac.reserve_ip_subpool_update: 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}}" id: string ipv4DhcpServers: - string ipv4DnsServers: - string ipv4GateWay: string ipv6AddressSpace: true ipv6DhcpServers: - string ipv6DnsServers: - string ipv6GateWay: string ipv6GlobalPool: string ipv6Prefix: true ipv6PrefixLength: 0 ipv6Subnet: string ipv6TotalHost: 0 name: string siteId: string slaacSupport: true .. 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-dnac_response"></div> .. _ansible_collections.cisco.dnac.reserve_ip_subpool_update_module__return-dnac_response: .. rst-class:: ansible-option-title **dnac_response** .. raw:: html <a class="ansibleOptionLink" href="#return-dnac_response" 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 DNAC 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 ~~~~~~~ - Rafael Campos (@racampos) .. 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