.. Document meta :orphan: .. Anchors .. _ansible_collections.cisco.dnac.global_pool_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.global_pool -- Manage GlobalPool objects of NetworkSettings ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.dnac collection `_ (version 2.0.7). To install it use: :code:`ansible-galaxy collection install cisco.dnac`. To use it in a playbook, specify: :code:`cisco.dnac.global_pool`. .. version_added .. versionadded:: 1.0.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - API to get global pool. - API to create global pool. - API to update global pool. - API to delete global IP pool. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk .. Options Parameters ---------- .. raw:: html

Parameter			Comments
id string			Global pool id. Required for state delete.
limit string			No of Global Pools to be retrieved.
offset string			Offset/starting row.
settings dictionary / required			Settings, property of the request body.
	ippool list / elements=dictionary		It is the global pool's ippool.
		dhcpServerIps list / elements=string	It is the global pool's dhcpServerIps.
		dnsServerIps list / elements=string	It is the global pool's dnsServerIps.
		gateway string	It is the global pool's gateway.
		id string / required	It is the global pool's id.
		IpAddressSpace string	It is the global pool's IpAddressSpace.
		ipPoolCidr string / required	It is the global pool's ipPoolCidr.
		ipPoolName string	It is the global pool's ipPoolName. Required for state create.
		type string / required	It is the global pool's type.

.. Notes .. Seealso See Also -------- .. seealso:: :ref:`cisco.dnac.plugins.module_utils.definitions.global_pool ` The official documentation on the **cisco.dnac.plugins.module_utils.definitions.global_pool** module. `GlobalPool reference `_ Complete reference of the GlobalPool object model. `GlobalPool reference `_ SDK reference. .. Examples Examples -------- .. code-block:: yaml+jinja - name: get_global_pool cisco.dnac.global_pool: state: query # required limit: SomeValue # string offset: SomeValue # string register: nm_get_global_pool - name: create_global_pool cisco.dnac.global_pool: state: create # required settings: # required ippool: - ipPoolName: SomeValue # string, required type: SomeValue # string, required ipPoolCidr: SomeValue # string, required gateway: SomeValue # string dhcpServerIps: - SomeValue # string dnsServerIps: - SomeValue # string IpAddressSpace: SomeValue # string - name: update_global_pool cisco.dnac.global_pool: state: update # required settings: # required ippool: - id: SomeValue # string, required ipPoolName: SomeValue # string gateway: SomeValue # string dhcpServerIps: - SomeValue # string dnsServerIps: - SomeValue # string - name: delete_global_ip_pool cisco.dnac.global_pool: state: delete # required id: SomeValue # string, required .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html

Key	Returned	Description
dnac_response dictionary	always	A dictionary with the response returned by the DNA Center Python SDK Sample: {'response': 29, 'version': '1.0'}
missing_params list / elements=string	when the function request schema is not satisfied	Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function string	always	The DNA Center SDK function used to execute the task Sample: network_settings.create_global_pool

.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors