summaryrefslogtreecommitdiffstats
path: root/ansible_collections/cisco/ise/plugins/modules/ipsec_bulk.py
blob: 9ebc9574ec1e796a7dd8a08869647b9e0e898157 (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
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
142
143
#!/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: ipsec_bulk
short_description: Resource module for Ipsec Bulk
description:
- Manage operation create of the resource Ipsec Bulk.
version_added: '1.0.0'
extends_documentation_fragment:
  - cisco.ise.module
author: Rafael Campos (@racampos)
options:
  ItemList:
    description: Ipsec Bulk's ItemList.
    elements: dict
    suboptions:
      authType:
        description: Authentication type for establishing connection.
        type: str
      certId:
        description: ID of the certificate for establishing connection.
        type: str
      configureVti:
        description: Authentication type for establishing connection.
        type: bool
      espAhProtocol:
        description: Encryption protocol used for establishing connection.
        type: str
      hostName:
        description: Hostname of the node.
        type: str
      iface:
        description: Ethernet port of the node.
        type: str
      ikeReAuthTime:
        description: IKE re-authentication time.
        type: int
      ikeVersion:
        description: IKE version.
        type: str
      localInternalIp:
        description: Local Tunnel IP address.
        type: str
      modeOption:
        description: The Mode type used for establishing the connection.
        type: str
      nadIp:
        description: NAD IP address for establishing connection.
        type: str
      phaseOneDHGroup:
        description: Phase-one DH group used for establishing connection.
        type: str
      phaseOneEncryptionAlgo:
        description: Phase-one encryption algorithm used for establishing connection.
        type: str
      phaseOneHashAlgo:
        description: Phase-one hashing algorithm used for establishing connection.
        type: str
      phaseOneLifeTime:
        description: Phase-one connection lifetime.
        type: int
      phaseTwoDHGroup:
        description: Phase-two DH group used for establishing connection.
        type: str
      phaseTwoEncryptionAlgo:
        description: Phase-two encryption algorithm used for establishing connection.
        type: str
      phaseTwoHashAlgo:
        description: Phase-two hashing algorithm used for establishing connection.
        type: str
      phaseTwoLifeTime:
        description: Phase-two connection lifetime.
        type: int
      psk:
        description: Pre-shared key used for establishing connection.
        type: str
      remotePeerInternalIp:
        description: Remote Tunnel IP address.
        type: str
    type: list
  operation:
    description: Ipsec Bulk's operation.
    type: str
requirements:
- ciscoisesdk >= 2.2.1
- python >= 3.5
notes:
  - SDK Method used are
    native_ipsec.NativeIpsec.bulk_ip_sec_operation,

  - Paths used are
    post /api/v1/ipsec/bulk,

"""

EXAMPLES = r"""
- name: Create
  cisco.ise.ipsec_bulk:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    ItemList:
    - authType: string
      certId: string
      configureVti: true
      espAhProtocol: string
      hostName: string
      iface: string
      ikeReAuthTime: 0
      ikeVersion: string
      localInternalIp: string
      modeOption: string
      nadIp: string
      phaseOneDHGroup: string
      phaseOneEncryptionAlgo: string
      phaseOneHashAlgo: string
      phaseOneLifeTime: 0
      phaseTwoDHGroup: string
      phaseTwoEncryptionAlgo: string
      phaseTwoHashAlgo: string
      phaseTwoLifeTime: 0
      psk: string
      remotePeerInternalIp: string
    operation: 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: >
    {
      "id": "string"
    }
"""