cisco.ise.sg_to_vn_to_vlan module – Resource module for Sg To Vn To Vlan

Note

This module is part of the cisco.ise collection (version 2.3.1).

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

To use it in a playbook, specify: cisco.ise.sg_to_vn_to_vlan.

New in version 1.0.0: of cisco.ise

Synopsis

• Manage operations create, update and delete of the resource Sg To Vn To Vlan.

• This API creates a security group to virtual network.

• This API deletes a security group ACL to virtual network.

Note

This module has a corresponding action plugin.

Requirements

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

• ciscoisesdk >= 2.0.1

• python >= 3.5

Parameters

Parameter	Comments
description string	Sg To Vn To Vlan’s description.
id string	Sg To Vn To Vlan’s id.
ise_debug boolean	Flag for Identity Services Engine SDK to enable debugging. Choices: no ← (default) yes
ise_hostname string / required	The Identity Services Engine hostname.
ise_password string / required	The Identity Services Engine password to authenticate.
ise_username string / required	The Identity Services Engine username to authenticate.
ise_uses_api_gateway boolean added in 1.1.0 of cisco.ise	Flag that informs the SDK whether to use the Identity Services Engine’s API Gateway to send requests. If it is true, it uses the ISE’s API Gateway and sends requests to https://{{ise_hostname}}. If it is false, it sends the requests to https://{{ise_hostname}}:{{port}}, where the port value depends on the Service used (ERS, Mnt, UI, PxGrid). Choices: no yes ← (default)
ise_uses_csrf_token boolean added in 3.0.0 of cisco.ise	Flag that informs the SDK whether we send the CSRF token to ISE’s ERS APIs. If it is True, the SDK assumes that your ISE CSRF Check is enabled. If it is True, it assumes you need the SDK to manage the CSRF token automatically for you. Choices: no ← (default) yes
ise_verify boolean	Flag to enable or disable SSL certificate verification. Choices: no yes ← (default)
ise_version string	Informs the SDK which version of Identity Services Engine to use. Default: “3.1.1”
ise_wait_on_rate_limit boolean	Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices: no yes ← (default)
name string	Sg To Vn To Vlan’s name.
sgtId string	Sg To Vn To Vlan’s sgtId.
virtualnetworklist list / elements=dictionary	Sg To Vn To Vlan’s virtualnetworklist.
defaultVirtualNetwork boolean	DefaultVirtualNetwork flag. Choices: no yes
description string	Sg To Vn To Vlan’s description.
id string	Sg To Vn To Vlan’s id.
name string	Sg To Vn To Vlan’s name.
vlans list / elements=dictionary	Sg To Vn To Vlan’s vlans.
data boolean	Data flag. Choices: no yes
defaultVlan boolean	DefaultVlan flag. Choices: no yes
description string	Sg To Vn To Vlan’s description.
id string	Sg To Vn To Vlan’s id.
maxValue integer	Sg To Vn To Vlan’s maxValue.
name string	Sg To Vn To Vlan’s name.

Notes

Note

• SDK Method used are security_group_to_virtual_network.SecurityGroupToVirtualNetwork.create_security_groups_to_vn_to_vlan, security_group_to_virtual_network.SecurityGroupToVirtualNetwork.delete_security_groups_to_vn_to_vlan_by_id, security_group_to_virtual_network.SecurityGroupToVirtualNetwork.update_security_groups_to_vn_to_vlan_by_id,

• Paths used are post /ers/config/sgtvnvlan, delete /ers/config/sgtvnvlan/{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 ISE SDK

• The parameters starting with ise_ are used by the Cisco ISE Python SDK to establish the connection

Examples

- name: Update by id
  cisco.ise.sg_to_vn_to_vlan:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: string
    id: string
    name: string
    sgtId: string
    virtualnetworklist:
    - defaultVirtualNetwork: true
      description: string
      id: string
      name: string
      vlans:
      - data: true
        defaultVlan: true
        description: string
        id: string
        maxValue: 0
        name: string

- name: Delete by id
  cisco.ise.sg_to_vn_to_vlan:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    id: string

- name: Create
  cisco.ise.sg_to_vn_to_vlan:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: string
    id: string
    name: string
    sgtId: string
    virtualnetworklist:
    - defaultVirtualNetwork: true
      description: string
      id: string
      name: string
      vlans:
      - data: true
        defaultVlan: true
        description: string
        id: string
        maxValue: 0
        name: string

Return Values

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

Key	Description
ise_response dictionary	A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: “{\n \”id\”: \”string\”,\n \”name\”: \”string\”,\n \”description\”: \”string\”,\n \”sgtId\”: \”string\”,\n \”virtualnetworklist\”: [\n {\n \”id\”: \”string\”,\n \”name\”: \”string\”,\n \”description\”: \”string\”,\n \”defaultVirtualNetwork\”: true,\n \”vlans\”: [\n {\n \”id\”: \”string\”,\n \”name\”: \”string\”,\n \”description\”: \”string\”,\n \”defaultVlan\”: true,\n \”maxValue\”: 0,\n \”data\”: true\n }\n ]\n }\n ],\n \”link\”: {\n \”rel\”: \”string\”,\n \”href\”: \”string\”,\n \”type\”: \”string\”\n }\n}\n”
ise_update_response dictionary added in 1.1.0 of cisco.ise	A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: “{\n \”UpdatedFieldsList\”: {\n \”updatedField\”: [\n {\n \”field\”: \”string\”,\n \”oldValue\”: \”string\”,\n \”newValue\”: \”string\”\n }\n ],\n \”field\”: \”string\”,\n \”oldValue\”: \”string\”,\n \”newValue\”: \”string\”\n }\n}\n”

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)