1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright (c) 2021, Cisco Systems
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
DOCUMENTATION = r"""
---
module: sxp_vpns_info
short_description: Information module for SXP VPNs
description:
- Get all SXP VPNs.
- Get SXP VPNs by id.
- This API allows the client to get a SXP VPN by ID.
- This API allows the client to get all the SXP VPNs.
version_added: '1.0.0'
extends_documentation_fragment:
- cisco.ise.module_info
author: Rafael Campos (@racampos)
options:
id:
description:
- Id path parameter.
type: str
page:
description:
- Page query parameter. Page number.
type: int
size:
description:
- Size query parameter. Number of objects returned per page.
type: int
filter:
description:
- >
Filter query parameter. **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.
- The 'EQ' operator describes 'Equals'.
- The 'NEQ' operator describes 'Not Equals'.
- The 'GT' operator describes 'Greater Than'.
- The 'LT' operator describes 'Less Than'.
- The 'STARTSW' operator describes 'Starts With'.
- The 'NSTARTSW' operator describes 'Not Starts With'.
- The 'ENDSW' operator describes 'Ends With'.
- The 'NENDSW' operator describes 'Not Ends With'.
- The 'CONTAINS' operator describes 'Contains'.
- The 'NCONTAINS' operator describes 'Not Contains'.
elements: str
type: list
filterType:
description:
- >
FilterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and
can be changed by using the parameter.
type: str
sortasc:
description:
- Sortasc query parameter. Sort asc.
type: str
sortdsc:
description:
- Sortdsc query parameter. Sort desc.
type: str
requirements:
- ciscoisesdk >= 2.2.1
- python >= 3.5
notes:
- SDK Method used are
sxp_vpns.SxpVpns.get_sxp_vpn_by_id,
sxp_vpns.SxpVpns.get_sxp_vpns_generator,
- Paths used are
get /ers/config/sxpvpns,
get /ers/config/sxpvpns/{id},
"""
EXAMPLES = r"""
- 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 = r"""
ise_response:
description: A dictionary or list with the response returned by the Cisco ISE Python SDK
returned: always
type: dict
sample: >
{
"id": "string",
"sxpVpnName": "string",
"link": {
"rel": "string",
"href": "string",
"type": "string"
}
}
ise_responses:
description: A dictionary or list with the response returned by the Cisco ISE Python SDK
returned: always
version_added: '1.1.0'
type: list
elements: dict
sample: >
[
{
"id": "string",
"sxpVpnName": "string",
"link": {
"rel": "string",
"href": "string",
"type": "string"
}
}
]
"""
|
