cisco.ise.trustsec_vn_vlan_mapping_info module – Information module for Trustsec Vn Vlan Mapping

Note

This module is part of the cisco.ise collection (version 2.3.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.ise.

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

New in version 2.0.0: of cisco.ise

Synopsis

• Get all Trustsec Vn Vlan Mapping.

• Get Trustsec Vn Vlan Mapping by id.

• Get VN-Vlan Mapping by id.

• Get all VN-Vlan Mappings.

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
filter list / elements=string	Filter query parameter. <div> <style type=”text/css” scoped> .apiServiceTable td, .apiServiceTable th { padding 5px 10px !important; text-align left; } </style> <span> <b>Simple filtering</b> 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 <i>”filterType=or”</i> query string parameter. Each resource Data model description should specify if an attribute is a filtered field. </span> <br /> <table class=”apiServiceTable”> <thead> <tr> <th>OPERATOR</th> <th>DESCRIPTION</th> </tr> </thead> <tbody> <tr> <td>EQ</td> <td>Equals</td> </tr> <tr> <td>NEQ</td> <td>Not Equals</td> </tr> <tr> <td>GT</td> <td>Greater Than</td> </tr> <tr> <td>LT</td> <td>Less Then</td> </tr> <tr> <td>STARTSW</td> <td>Starts With</td> </tr> <tr> <td>NSTARTSW</td> <td>Not Starts With</td> </tr> <tr> <td>ENDSW</td> <td>Ends With</td> </tr> <tr> <td>NENDSW</td> <td>Not Ends With</td> </tr> <tr> <td>CONTAINS</td> <td>Contains</td> </tr> <tr> <td>NCONTAINS</td> <td>Not Contains</td> </tr> </tbody> </table> </div>.
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	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)
page integer	Page query parameter. Page number.
size integer	Size query parameter. Number of objects returned per page.
sort string	Sort query parameter. Sort type - asc or desc.
sortBy string	SortBy query parameter. Sort column by which objects needs to be sorted.

Notes

Note

• SDK Method used are vn_vlan_mapping.VnVlanMapping.get_vn_vlan_mapping_by_id, vn_vlan_mapping.VnVlanMapping.get_vn_vlan_mappings_generator,

• Paths used are get /api/v1/trustsec/vnvlanmapping, get /api/v1/trustsec/vnvlanmapping/{id},

• Supports 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: Get all Trustsec Vn Vlan Mapping
  cisco.ise.trustsec_vn_vlan_mapping_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 0
    size: 0
    sort: string
    sortBy: string
    filter: []
    filterType: string
  register: result

- name: Get Trustsec Vn Vlan Mapping by id
  cisco.ise.trustsec_vn_vlan_mapping_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	Description
ise_response list / elements=dictionary	A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: “[\n {\n \”id\”: \”string\”,\n \”isData\”: true,\n \”isDefaultVlan\”: true,\n \”lastUpdate\”: \”string\”,\n \”maxValue\”: 0,\n \”name\”: \”string\”,\n \”vnId\”: \”string\”,\n \”vnName\”: \”string\”\n }\n]\n”
ise_responses list / elements=dictionary	A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: “[\n {\n \”id\”: \”string\”,\n \”isData\”: true,\n \”isDefaultVlan\”: true,\n \”lastUpdate\”: \”string\”,\n \”maxValue\”: 0,\n \”name\”: \”string\”,\n \”vnId\”: \”string\”,\n \”vnName\”: \”string\”\n }\n]\n”

Authors

• Rafael Campos (@racampos)