cisco.dnac.sda_virtual_network_ip_pool – Manage SdaVirtualNetworkIpPool objects of Sda¶

Note

This plugin is part of the cisco.dnac collection (version 2.0.7).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.sda_virtual_network_ip_pool.

New in version 1.0.0: of cisco.dnac

Synopsis
Requirements
Parameters
See Also
Examples
Return Values

Synopsis ¶

Delete IP Pool from SDA Virtual Network.
Get IP Pool from SDA Virtual Network.
Add IP Pool in SDA Virtual Network.

Note

This module has a corresponding action plugin.

Requirements ¶

The below requirements are needed on the host that executes this module.

dnacentersdk

Parameters ¶

Parameter		Choices/Defaults	Comments
ip_pool_name string / required			IpPoolName query parameter.
payload list / elements=dictionary			An object to send in the Request body. Required for state create.
	authenticationPolicyName string		It is the sda virtual network ip pool's authenticationPolicyName.
	ipPoolName string		It is the sda virtual network ip pool's ipPoolName.
	isL2FloodingEnabled boolean	Choices: no yes	It is the sda virtual network ip pool's isL2FloodingEnabled.
	isThisCriticalPool boolean	Choices: no yes	It is the sda virtual network ip pool's isThisCriticalPool.
	poolType string		It is the sda virtual network ip pool's poolType.
	scalableGroupName string		It is the sda virtual network ip pool's scalableGroupName.
	trafficType string		It is the sda virtual network ip pool's trafficType.
	virtualNetworkName string		It is the sda virtual network ip pool's virtualNetworkName.
virtual_network_name string / required			VirtualNetworkName query parameter.

Examples ¶

- 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

- 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

- 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

Return Values ¶

Common return values are documented here, the following are the fields unique to this module:

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

Authors¶

Rafael Campos (@racampos)

cisco.dnac.sda_virtual_network_ip_pool – Manage SdaVirtualNetworkIpPool objects of Sda¶

Synopsis¶

Requirements¶

Parameters¶

See Also¶

Examples¶

Return Values¶