cisco.dnac.sda_extranet_policies module – Resource module for Sda Extranetpolicies
Note
This module is part of the cisco.dnac collection (version 6.18.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
.
New in cisco.dnac 6.14.0
Synopsis
Manage operations create, update and delete of the resource Sda Extranetpolicies.
Adds an extranet policy based on user input.
Deletes an extranet policy based on id.
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.7.2
python >= 3.5
Parameters
Parameter |
Comments |
---|---|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Id path parameter. ID of the extranet policy. |
|
Sda Extranet Policies’s payload. |
|
Name of the existing extranet policy (updating this field is not allowed). |
|
ID of the fabric sites/zones that associated with this extranet policy. |
|
ID of the existing extranet policy (updating this field is not allowed). |
|
Name of the existing provider virtual network (updating this field is not allowed). |
|
Name of the subscriber virtual networks. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are sda.Sda.add_extranet_policy, sda.Sda.delete_extranet_policy_by_id, sda.Sda.update_extranet_policy,
Paths used are post /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 AddExtranetPolicy
Complete reference of the AddExtranetPolicy API.
- Cisco DNA Center documentation for SDA DeleteExtranetPolicyById
Complete reference of the DeleteExtranetPolicyById API.
- Cisco DNA Center documentation for SDA UpdateExtranetPolicy
Complete reference of the UpdateExtranetPolicy API.
Examples
- name: Update all
cisco.dnac.sda_extranet_policies:
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:
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:
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 |
---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |