cisco.ise.sxp_vpns_info – Information module for Sxp Vpns

Note

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

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

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

New in version 1.0.0: of cisco.ise

Synopsis

  • Get all Sxp Vpns.

  • Get Sxp Vpns by id.

Note

This module has a corresponding action plugin.

Requirements

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

  • ciscoisesdk

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.
page
integer
Page query parameter. Page number.
size
integer
Size query parameter. Number of objects returned per page.
sortasc
string
Sortasc query parameter. Sort asc.
sortdsc
string
Sortdsc query parameter. Sort desc.

See Also

See also

cisco.ise.plugins.module_utils.definitions.sxp_vpns

The official documentation on the cisco.ise.plugins.module_utils.definitions.sxp_vpns module.

Sxp Vpns reference

Complete reference of the Sxp Vpns object model.

Examples

- name: Get all Sxp Vpns
  cisco.ise.sxp_vpns_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 1
    size: 20
    filter: []
    filterType: AND
    sortasc: string
    sortdsc: string
  register: result

- name: Get Sxp Vpns by id
  cisco.ise.sxp_vpns_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", "sxpVpnName": "string" }


Authors

  • Rafael Campos (@racampos)