/ home / cisco / cisco.dnac / 2.0.7 / module / global_pool

cisco.dnac.global_pool (2.0.7) — module

Manage GlobalPool objects of NetworkSettings

| "added in version" 1.0.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==2.0.7

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 2.0.7

Description

API to get global pool.

API to create global pool.

API to update global pool.

API to delete global IP pool.

Requirements

dnacentersdk

Usage examples

Scanned by Steampunk Spotter

- name: get_global_pool
  cisco.dnac.global_pool:
    state: query  # required
    limit: SomeValue  # string
    offset: SomeValue  # string
  register: nm_get_global_pool

Scanned by Steampunk Spotter

- 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

Scanned by Steampunk Spotter

- 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

Scanned by Steampunk Spotter

- name: delete_global_ip_pool
  cisco.dnac.global_pool:
    state: delete  # required
    id: SomeValue  # string, required

Inputs

    
id:
    description:
    - Global pool id.
    - Required for state delete.
    type: str

limit:
    description:
    - No of Global Pools to be retrieved.
    type: str

offset:
    description:
    - Offset/starting row.
    type: str

settings:
    description:
    - Settings, property of the request body.
    required: true
    suboptions:
      ippool:
        description:
        - It is the global pool's ippool.
        elements: dict
        suboptions:
          IpAddressSpace:
            description:
            - It is the global pool's IpAddressSpace.
            type: str
          dhcpServerIps:
            description:
            - It is the global pool's dhcpServerIps.
            type: list
          dnsServerIps:
            description:
            - It is the global pool's dnsServerIps.
            type: list
          gateway:
            description:
            - It is the global pool's gateway.
            type: str
          id:
            description:
            - It is the global pool's id.
            required: true
            type: str
          ipPoolCidr:
            description:
            - It is the global pool's ipPoolCidr.
            required: true
            type: str
          ipPoolName:
            description:
            - It is the global pool's ipPoolName.
            - Required for state create.
            type: str
          type:
            description:
            - It is the global pool's type.
            required: true
            type: str
        type: list
    type: dict

Outputs

dnac_response:
  description: A dictionary with the response returned by the DNA Center Python SDK
  returned: always
  sample:
    response: 29
    version: '1.0'
  type: dict
missing_params:
  description: Provided arguments do not comply with the schema of the DNA Center
    Python SDK function
  returned: when the function request schema is not satisfied
  sample: null
  type: list
sdk_function:
  description: The DNA Center SDK function used to execute the task
  returned: always
  sample: network_settings.create_global_pool
  type: str

Install collection

Add to requirements.yml

Description

Requirements

Usage examples

Inputs

Outputs

See also