cisco.dnac.sda_virtual_network_ip_pool (2.0.7) — module

Manage SdaVirtualNetworkIpPool objects of Sda

| "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

Delete IP Pool from SDA Virtual Network.

Get IP Pool from SDA Virtual Network.

Add IP Pool in SDA Virtual Network.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: delete_ip_pool_from_sda_virtual_network
  cisco.dnac.sda_virtual_network_ip_pool:
    state: delete  # required
    ip_pool_name: SomeValue  # string, required
    virtual_network_name: SomeValue  # string, required
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get_ip_pool_from_sda_virtual_network
  cisco.dnac.sda_virtual_network_ip_pool:
    state: query  # required
    ip_pool_name: SomeValue  # string, required
    virtual_network_name: SomeValue  # string, required
  register: nm_get_ip_pool_from_sda_virtual_network
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: add_ip_pool_in_sda_virtual_network
  cisco.dnac.sda_virtual_network_ip_pool:
    state: create  # required
    payload:  # required
    - virtualNetworkName: SomeValue  # string
      ipPoolName: SomeValue  # string
      trafficType: SomeValue  # string
      authenticationPolicyName: SomeValue  # string
      scalableGroupName: SomeValue  # string
      isL2FloodingEnabled: True  # boolean
      isThisCriticalPool: True  # boolean
      poolType: SomeValue  # string

Inputs

    
payload:
    description:
    - An object to send in the Request body.
    - Required for state create.
    elements: dict
    suboptions:
      authenticationPolicyName:
        description:
        - It is the sda virtual network ip pool's authenticationPolicyName.
        type: str
      ipPoolName:
        description:
        - It is the sda virtual network ip pool's ipPoolName.
        type: str
      isL2FloodingEnabled:
        description:
        - It is the sda virtual network ip pool's isL2FloodingEnabled.
        type: bool
      isThisCriticalPool:
        description:
        - It is the sda virtual network ip pool's isThisCriticalPool.
        type: bool
      poolType:
        description:
        - It is the sda virtual network ip pool's poolType.
        type: str
      scalableGroupName:
        description:
        - It is the sda virtual network ip pool's scalableGroupName.
        type: str
      trafficType:
        description:
        - It is the sda virtual network ip pool's trafficType.
        type: str
      virtualNetworkName:
        description:
        - It is the sda virtual network ip pool's virtualNetworkName.
        type: str
    type: list

ip_pool_name:
    description:
    - IpPoolName query parameter.
    required: true
    type: str

virtual_network_name:
    description:
    - VirtualNetworkName query parameter.
    required: true
    type: str

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: sda.add_ip_pool_in_sda_virtual_network
  type: str

See also