cisco.dnac.security_service_insertions_id module – Resource module for Security Service Insertions Id

Note

This module is part of the cisco.dnac collection (version 6.39.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.security_service_insertions_id.

New in cisco.dnac 6.18.0

Synopsis

  • Manage operations update and delete of the resource Security Service Insertions Id.

  • Removes the Security Service Insertion SSI configuration from the fabric site where it was created. - > Updates the Security Service Insertion SSI. It allows modifications to the associated Virtual Networks VNs , border devices, and firewall ips.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.10.1

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

id

string

Id path parameter. The unique identifier of the Security Service Insertion (SSI).

siteId

string

The ID of the fabric site where the service insertion is configured.

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)

virtualNetworks

list / elements=dictionary

Security Service Insertions Id’s virtualNetworks.

devices

list / elements=dictionary

Security Service Insertions Id’s devices.

id

string

The unique identifier of the network device.

layer3Handoffs

list / elements=dictionary

Security Service Insertions Id’s layer3Handoffs.

firewallIpV4AddressWithMask

string

The IPv4 address and subnet mask of the firewall.

name

string

Name of the virtual network associated with the fabric site.

Notes

Note

  • SDK Method used are sda.Sda.delete_security_service_insertion, sda.Sda.update_the_security_service_insertion,

  • Paths used are delete /dna/intent/api/v1/securityServiceInsertions/{id}, put /dna/intent/api/v1/securityServiceInsertions/{id},

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

Complete reference of the DeleteSecurityServiceInsertion API.

Cisco DNA Center documentation for SDA UpdateTheSecurityServiceInsertion

Complete reference of the UpdateTheSecurityServiceInsertion API.

Examples

---
- name: Delete by id
  cisco.dnac.security_service_insertions_id:
    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
- name: Update by id
  cisco.dnac.security_service_insertions_id:
    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
    id: string
    siteId: string
    virtualNetworks:
      - devices:
          - id: string
            layer3Handoffs:
              - firewallIpV4AddressWithMask: string
        name: 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)