cisco.ise.sg_to_vn_to_vlan_info – Information module for Sg To Vn To Vlan

Note

This plugin is part of the cisco.ise collection (version 1.1.0).

To install it use: ansible-galaxy collection install cisco.ise.

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

New in version 1.0.0: of cisco.ise

Synopsis

• Get all Sg To Vn To Vlan.

• Get Sg To Vn To Vlan by id.

Note

This module has a corresponding action plugin.

Requirements

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

• ciscoisesdk >= 1.0.0

• python >= 3.5

Parameters

Parameter	Choices/Defaults	Comments
filter list / elements=string		Filter query parameter. <br/> **Simple filtering** should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the "filterType=or" query string parameter. Each resource Data model description should specify if an attribute is a filtered field. <br/> Operator | Description <br/> ------------|----------------- <br/> EQ | Equals <br/> NEQ | Not Equals <br/> GT | Greater Than <br/> LT | Less Then <br/> STARTSW | Starts With <br/> NSTARTSW | Not Starts With <br/> ENDSW | Ends With <br/> NENDSW | Not Ends With <br/> CONTAINS | Contains <br/> NCONTAINS | Not Contains <br/>.
filterType string		FilterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
id string		Id path parameter.
ise_debug boolean	Choices: no ← yes	Flag for Identity Services Engine SDK to enable debugging.
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_verify boolean	Choices: no yes ←	Flag to enable or disable SSL certificate verification.
ise_version string	Default: "3.0.0"	Informs the SDK which version of Identity Services Engine to use.
ise_wait_on_rate_limit boolean	Choices: no yes ←	Flag for Identity Services Engine SDK to enable automatic rate-limit handling.
page integer		Page query parameter. Page number.
size integer		Size query parameter. Number of objects returned per page.

Notes

Note

• Supports check_mode

See Also

See also

Sg To Vn To Vlan reference

Complete reference of the Sg To Vn To Vlan object model.

Examples

- name: Get all Sg To Vn To Vlan
  cisco.ise.sg_to_vn_to_vlan_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 1
    size: 20
    filter: []
    filterType: AND
  register: result

- name: Get Sg To Vn To Vlan by id
  cisco.ise.sg_to_vn_to_vlan_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    id: string
  register: result

Return Values

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

Key	Returned	Description
ise_response dictionary	always	A dictionary or list with the response returned by the Cisco ISE Python SDK Sample: { "id": "string", "name": "string", "description": "string", "sgtId": "string", "virtualnetworklist": [ { "id": "string", "name": "string", "description": "string", "defaultVirtualNetwork": true, "vlans": [ { "id": "string", "name": "string", "description": "string", "defaultVlan": true, "maxValue": 0, "data": true } ] } ], "link": { "rel": "string", "href": "string", "type": "string" } }

Authors

• Rafael Campos (@racampos)