cisco.dnac.sda_virtual_network_ip_pool (6.13.3) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Manage operations create and delete of the resource Sda Virtual Network Ip Pool.

Add IP Pool in SDA Virtual Network.

Delete IP Pool from SDA Virtual Network.

Requirements

• dnacentersdk >= 2.6.0
• python >= 3.9

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Delete all
  cisco.dnac.sda_virtual_network_ip_pool:
    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}}"
    state: absent
    ipPoolName: string
    siteNameHierarchy: string
    virtualNetworkName: string

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create
  cisco.dnac.sda_virtual_network_ip_pool:
    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}}"
    state: present
    autoGenerateVlanName: true
    ipPoolName: string
    isBridgeModeVm: true
    isCommonPool: true
    isIpDirectedBroadcast: true
    isL2FloodingEnabled: true
    isLayer2Only: true
    isThisCriticalPool: true
    isWirelessPool: true
    poolType: string
    scalableGroupName: string
    siteNameHierarchy: string
    trafficType: string
    virtualNetworkName: string
    vlanId: string
    vlanName: string

Inputs

    
vlanId:
    description: Vlan Id(applicable for L3 , L2 and INFRA_VN).
    type: str

poolType:
    description: Pool Type (applicable for INFRA_VN).
    type: str
    version_added: 4.0.0
    version_added_collection: cisco.dnac

vlanName:
    description: Vlan name represent the segment name, if empty, vlanName would be auto
      generated by API.
    type: str
    version_added: 4.0.0
    version_added_collection: cisco.dnac

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

ipPoolName:
    description: IpPoolName query parameter.
    type: str
    version_added: 4.0.0
    version_added_collection: cisco.dnac

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

trafficType:
    description: Traffic type(applicable for L3 and L2).
    type: str
    version_added: 4.0.0
    version_added_collection: cisco.dnac

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

isCommonPool:
    description: Common Pool enablement flag(applicable for L3 and L2 and default value
      is False ).
    type: bool

isLayer2Only:
    description: Layer2 Only enablement flag and default value is False.
    type: bool

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

isBridgeModeVm:
    description: Bridge Mode Vm enablement flag (applicable for L3 and L2 and default
      value is False ).
    type: bool

isWirelessPool:
    description: Wireless Pool enablement flag(applicable for L3 and L2 and default value
      is False ).
    type: bool
    version_added: 4.0.0
    version_added_collection: cisco.dnac

scalableGroupName:
    description: Scalable Group Name(applicable for L3).
    type: str
    version_added: 4.0.0
    version_added_collection: cisco.dnac

siteNameHierarchy:
    description: SiteNameHierarchy query parameter.
    type: str
    version_added: 4.0.0
    version_added_collection: cisco.dnac

isThisCriticalPool:
    description: Critical pool enablement flag(applicable for L3 and default value is
      False ).
    type: bool
    version_added: 4.0.0
    version_added_collection: cisco.dnac

virtualNetworkName:
    description: VirtualNetworkName query parameter.
    type: str

isL2FloodingEnabled:
    description: Layer2 flooding enablement flag(applicable for L3 , L2 and always true
      for L2 and default value is False ).
    type: bool
    version_added: 4.0.0
    version_added_collection: cisco.dnac

autoGenerateVlanName:
    description: It will auto generate vlanName, if vlanName is empty(applicable for L3
      and INFRA_VN).
    type: bool

isIpDirectedBroadcast:
    description: Ip Directed Broadcast enablement flag(applicable for L3 and default value
      is False ).
    type: bool

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"status\": \"string\",\n  \"description\": \"string\",\n  \"taskId\"\
    : \"string\",\n  \"taskStatusUrl\": \"string\",\n  \"executionStatusUrl\": \"\
    string\",\n  \"executionId\": \"string\"\n}\n"
  type: dict

See also

• Cisco DNA Center documentation for SDA AddIPPoolInSDAVirtualNetwork: Complete reference of the AddIPPoolInSDAVirtualNetwork API. link
• Cisco DNA Center documentation for SDA DeleteIPPoolFromSDAVirtualNetwork: Complete reference of the DeleteIPPoolFromSDAVirtualNetwork API. link