racampos.dnac.global_pool (0.0.1) — module

Manage GlobalPool objects of NetworkSettings

| "added in version" 1.0 of racampos.dnac"

Authors: first last (@GitHubID)

preview | supported by community

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install racampos.dnac:==0.0.1


Add to requirements.yml

  collections:
    - name: racampos.dnac
      version: 0.0.1

Description

API to get global pool.

API to create global pool.

API to update global pool.

API to delete global IP pool.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get_global_pool
  cisco.dnac.global_pool:
    state: query  # required
    limit: SomeValue  # string
    offset: SomeValue  # string
  register: query_result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- 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

create_global_pool:
  contains: null
  description: API to create global pool.
  executionId:
    description: Execution Id, property of the response body.
    returned: success
    sample: <executionid>
    type: str
  executionStatusUrl:
    description: Execution Status Url, property of the response body.
    returned: success
    sample: <executionstatusurl>
    type: str
  message:
    description: Message, property of the response body.
    returned: success
    sample: <message>
    type: str
  returned: success
  type: dict
delete_global_ip_pool:
  contains: null
  description: API to delete global IP pool.
  executionId:
    description: Execution Id, property of the response body.
    returned: success
    sample: <executionid>
    type: str
  executionStatusUrl:
    description: Execution Status Url, property of the response body.
    returned: success
    sample: <executionstatusurl>
    type: str
  message:
    description: Message, property of the response body.
    returned: success
    sample: <message>
    type: str
  returned: success
  type: dict
get_global_pool:
  contains: null
  description: API to get global pool.
  response:
    contains:
      clientOptions:
        description: It is the global pool's clientOptions.
        returned: always
        type: dict
      configureExternalDhcp:
        description: It is the global pool's configureExternalDhcp.
        returned: always
        sample: <configureexternaldhcp>
        type: str
      context:
        contains:
          contextKey:
            description: It is the global pool's contextKey.
            returned: always
            sample: <contextkey>
            type: str
          contextValue:
            description: It is the global pool's contextValue.
            returned: always
            sample: <contextvalue>
            type: str
          owner:
            description: It is the global pool's owner.
            returned: always
            sample: <owner>
            type: str
        description: It is the global pool's context.
        returned: always
        type: list
      createTime:
        description: It is the global pool's createTime.
        returned: always
        sample: <createtime>
        type: str
      dhcpServerIps:
        description: It is the global pool's dhcpServerIps.
        returned: always
        type: list
      dnsServerIps:
        description: It is the global pool's dnsServerIps.
        returned: always
        type: list
      gateways:
        description: It is the global pool's gateways.
        returned: always
        type: list
      id:
        description: It is the global pool's id.
        returned: always
        sample: '478012'
        type: str
      ipPoolCidr:
        description: It is the global pool's ipPoolCidr.
        returned: always
        sample: <ippoolcidr>
        type: str
      ipPoolName:
        description: It is the global pool's ipPoolName.
        returned: always
        sample: <ippoolname>
        type: str
      ipv6:
        description: It is the global pool's ipv6.
        returned: always
        sample: <ipv6>
        type: str
      lastUpdateTime:
        description: It is the global pool's lastUpdateTime.
        returned: always
        sample: <lastupdatetime>
        type: str
      overlapping:
        description: It is the global pool's overlapping.
        returned: always
        sample: <overlapping>
        type: str
      owner:
        description: It is the global pool's owner.
        returned: always
        sample: <owner>
        type: str
      parentUuid:
        description: It is the global pool's parentUuid.
        returned: always
        sample: <parentuuid>
        type: str
      shared:
        description: It is the global pool's shared.
        returned: always
        sample: <shared>
        type: str
      totalIpAddressCount:
        description: It is the global pool's totalIpAddressCount.
        returned: always
        sample: <totalipaddresscount>
        type: str
      usedIpAddressCount:
        description: It is the global pool's usedIpAddressCount.
        returned: always
        sample: <usedipaddresscount>
        type: str
      usedPercentage:
        description: It is the global pool's usedPercentage.
        returned: always
        sample: <usedpercentage>
        type: str
    description: Response, property of the response body (list of objects).
    returned: always
    type: list
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str
update_global_pool:
  contains: null
  description: API to update global pool.
  executionId:
    description: Execution Id, property of the response body.
    returned: changed
    sample: <executionid>
    type: str
  executionStatusUrl:
    description: Execution Status Url, property of the response body.
    returned: changed
    sample: <executionstatusurl>
    type: str
  message:
    description: Message, property of the response body.
    returned: changed
    sample: <message>
    type: str
  returned: changed
  type: dict

See also