cisco.catalystcenter.sda_layer3_virtual_networks module -- Resource module for Sda Layer3virtualnetworks

Note

This module is part of the cisco.catalystcenter collection (version 2.2.2).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.sda_layer3_virtual_networks.

New in cisco.catalystcenter 6.15.0

Synopsis

• Manage operations create, update and delete of the resource Sda Layer3virtualnetworks.

• Adds layer 3 virtual networks based on user input.

• Deletes layer 3 virtual networks based on user input.

• Updates layer 3 virtual networks based on user input.

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 3.1.3.0.0

• python >= 3.5

Parameters

Parameter	Comments
catalystcenter_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catalystcenter_host string / required	The Cisco Catalyst Center hostname.
catalystcenter_password string	The Cisco Catalyst Center password to authenticate.
catalystcenter_username string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catalystcenter_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catalystcenter_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"2.3.7.6"`
payload list / elements=dictionary	Sda Layer3 Virtual Networks's payload.
anchoredSiteId string	Fabric ID of the fabric site this layer 3 virtual network is to be anchored at.
fabricIds list / elements=string	IDs of the fabrics this layer 3 virtual network is to be assigned to.
virtualNetworkName string	Name of the layer 3 virtual network.
validate_response_schema boolean	Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
virtualNetworkName string	VirtualNetworkName query parameter. Name of the layer 3 virtual network.

Notes

Note

• SDK Method used are sda.Sda.add_layer3_virtual_networks, sda.Sda.delete_layer3_virtual_networks, sda.Sda.update_layer3_virtual_networks,

• Paths used are post /dna/intent/api/v1/sda/layer3VirtualNetworks, delete /dna/intent/api/v1/sda/layer3VirtualNetworks, put /dna/intent/api/v1/sda/layer3VirtualNetworks,

• Does not support check_mode

• The plugin runs on the control node and does not use any ansible connection plugins,

• but instead uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for SDA AddLayer3VirtualNetworks

Complete reference of the AddLayer3VirtualNetworks API.

Cisco DNA Center documentation for SDA DeleteLayer3VirtualNetworks

Complete reference of the DeleteLayer3VirtualNetworks API.

Cisco DNA Center documentation for SDA UpdateLayer3VirtualNetworks

Complete reference of the UpdateLayer3VirtualNetworks API.

Examples

---
- name: Create
  cisco.catalystcenter.sda_layer3VirtualNetworks:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_api_port: "{{catalystcenter_api_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    payload:
      - anchoredSiteId: string
        fabricIds:
          - string
        virtualNetworkName: string
- name: Delete all
  cisco.catalystcenter.sda_layer3VirtualNetworks:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_api_port: "{{catalystcenter_api_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: absent
    virtualNetworkName: string
- name: Update all
  cisco.catalystcenter.sda_layer3VirtualNetworks:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_api_port: "{{catalystcenter_api_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    payload:
      - anchoredSiteId: string
        fabricIds:
          - string
        id: string
        virtualNetworkName: string

Return Values

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

Key	Description
dnac_response dictionary	A dictionary or list with the response returned by the Cisco CATALYST Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)