cisco.catalystcenter.transit_peer_network module -- Resource module for Transit Peer Network

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.transit_peer_network.

New in cisco.catalystcenter 6.0.0

Synopsis

  • Manage operations create and delete of the resource Transit Peer Network.

  • Add Transit Peer Network in SD-Access.

  • Delete Transit Peer Network from SD-Access.

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:

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:

catalystcenter_version

string

Informs the SDK which version of Cisco Catalyst Center to use.

Default: :ansible-option-default:`"2.3.7.6"`

ipTransitSettings

dictionary

Transit Peer Network's ipTransitSettings.

autonomousSystemNumber

string

Autonomous System Number.

routingProtocolName

string

Routing Protocol Name.

sdaTransitSettings

dictionary

Transit Peer Network's sdaTransitSettings.

transitControlPlaneSettings

list / elements=dictionary

Transit Peer Network's transitControlPlaneSettings.

deviceManagementIpAddress

string

Device Management Ip Address of provisioned device.

siteNameHierarchy

string

Site Name Hierarchy where device is provisioned.

transitPeerNetworkName

string

TransitPeerNetworkName query parameter. Transit Peer Network Name.

transitPeerNetworkType

string

Transit Peer Network Type.

validate_response_schema

boolean

Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

Notes

Note

  • SDK Method used are sda.Sda.add_transit_peer_network, sda.Sda.delete_transit_peer_network,

  • Paths used are post /dna/intent/api/v1/business/sda/transit-peer-network, delete /dna/intent/api/v1/business/sda/transit-peer-network,

  • 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 AddTransitPeerNetwork

Complete reference of the AddTransitPeerNetwork API.

Cisco DNA Center documentation for SDA DeleteTransitPeerNetwork

Complete reference of the DeleteTransitPeerNetwork API.

Examples

---
- name: Delete all
  cisco.catalystcenter.transit_peer_network:
    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
    transitPeerNetworkName: string
- name: Create
  cisco.catalystcenter.transit_peer_network:
    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
    ipTransitSettings:
      autonomousSystemNumber: string
      routingProtocolName: string
    sdaTransitSettings:
      transitControlPlaneSettings:
        - deviceManagementIpAddress: string
          siteNameHierarchy: string
    transitPeerNetworkName: string
    transitPeerNetworkType: 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:`{"description": "string", "executionId": "string", "executionStatusUrl": "string", "status": "string", "taskId": "string", "taskStatusUrl": "string"}`

Authors

  • Rafael Campos (@racampos)