blob: 93c2e0d286aaabc93db06a2872f33b5b62a45386 (
plain)
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
|
#!/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: guest_user_suspend
short_description: Resource module for Guest User Suspend
description:
- Manage operation update of the resource Guest User Suspend.
- This API allows the client to suspend a guest user by ID.
- This API allows the client to suspend a guest user by name.
version_added: '1.0.0'
extends_documentation_fragment:
- cisco.ise.module
author: Rafael Campos (@racampos)
options:
additionalData:
description: Guest User Suspend's additionalData.
elements: dict
suboptions:
name:
description: Guest User Suspend's name.
type: str
value:
description: Guest User Suspend's value.
type: str
type: list
id:
description: Id path parameter.
type: str
name:
description: Name path parameter.
type: str
requirements:
- ciscoisesdk >= 2.1.1
- python >= 3.5
notes:
- SDK Method used are
guest_user.GuestUser.suspend_guest_user_by_id,
guest_user.GuestUser.suspend_guest_user_by_name,
- Paths used are
put /ers/config/guestuser/suspend/name/{name},
put /ers/config/guestuser/suspend/{id},
"""
EXAMPLES = r"""
- name: Update by name
cisco.ise.guest_user_suspend:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
name: string
- name: Update by id
cisco.ise.guest_user_suspend:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
additionalData:
- name: reason
value: reason
id: string
"""
RETURN = r"""
ise_response:
description: A dictionary or list with the response returned by the Cisco ISE Python SDK
returned: always
type: dict
sample: >
{}
"""
|