cisco.dnac.sda_extranet_policies_v1 module – Resource module for Sda Extranet Policies V1

Note

This module is part of the cisco.dnac collection (version 6.25.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

New in cisco.dnac 6.14.0

Synopsis

  • Manage operations create, update and delete of the resource Sda Extranet Policies V1.

  • Adds an extranet policy based on user input.

  • Deletes an extranet policy based on id.

  • Deletes extranet policies based on user input.

  • Updates an extranet policy 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.

  • dnacentersdk >= 2.4.9

  • python >= 3.5

Parameters

Parameter

Comments

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)

  • true

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: "admin"

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false

  • true ← (default)

dnac_version

string

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

Default: "2.3.7.6"

extranetPolicyName

string

ExtranetPolicyName query parameter. Name of the extranet policy.

id

string

Id path parameter. ID of the extranet policy.

payload

list / elements=dictionary

Sda Extranet Policies’s payload.

extranetPolicyName

string

Name of the existing extranet policy (updating this field is not allowed).

fabricIds

list / elements=string

IDs of the fabric sites associated with this extranet policy.

id

string

ID of the existing extranet policy (updating this field is not allowed).

providerVirtualNetworkName

string

Name of the existing provider virtual network (updating this field is not allowed).

subscriberVirtualNetworkNames

list / elements=string

Name of the subscriber virtual networks.

validate_response_schema

boolean

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

Choices:

  • false

  • true ← (default)

Notes

Note

  • SDK Method used are sda.Sda.add_extranet_policy_v1, sda.Sda.delete_extranet_policy_by_id_v1, sda.Sda.update_extranet_policy_v1,

  • Paths used are post /dna/intent/api/v1/sda/extranetPolicies, delete /dna/intent/api/v1/sda/extranetPolicies, delete /dna/intent/api/v1/sda/extranetPolicies/{id}, put /dna/intent/api/v1/sda/extranetPolicies,

  • Does not support check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK

  • The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for SDA AddExtranetPolicyV1

Complete reference of the AddExtranetPolicyV1 API.

Cisco DNA Center documentation for SDA DeleteExtranetPoliciesV1

Complete reference of the DeleteExtranetPoliciesV1 API.

Cisco DNA Center documentation for SDA DeleteExtranetPolicyByIdV1

Complete reference of the DeleteExtranetPolicyByIdV1 API.

Cisco DNA Center documentation for SDA UpdateExtranetPolicyV1

Complete reference of the UpdateExtranetPolicyV1 API.

Examples

- name: Delete all
  cisco.dnac.sda_extranet_policies_v1:
    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
    extranetPolicyName: string

- name: Update all
  cisco.dnac.sda_extranet_policies_v1:
    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
    payload:
    - extranetPolicyName: string
      fabricIds:
      - string
      id: string
      providerVirtualNetworkName: string
      subscriberVirtualNetworkNames:
      - string

- name: Create
  cisco.dnac.sda_extranet_policies_v1:
    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
    payload:
    - extranetPolicyName: string
      fabricIds:
      - string
      providerVirtualNetworkName: string
      subscriberVirtualNetworkNames:
      - string

- name: Delete by id
  cisco.dnac.sda_extranet_policies_v1:
    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
    id: 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 DNAC Python SDK

Returned: always

Sample: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

Authors

  • Rafael Campos (@racampos)