cisco.ise.ipsec module – Resource module for Ipsec
Note
This module is part of the cisco.ise collection (version 2.9.6).
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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.ise.ipsec.
New in cisco.ise 1.0.0
Synopsis
Manage operations create and update of the resource Ipsec.
Creates an IPsec connection.
Updates the configuration of existing IPsec connection.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
ciscoisesdk >= 2.2.3
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
Authentication type for establishing connection. |
|
ID of the certificate for establishing connection. |
|
Authentication type for establishing connection. Choices:
|
|
Encryption protocol used for establishing connection. |
|
Hostname of the node. |
|
Ethernet port of the node. |
|
IKE re-authentication time. |
|
IKE version. |
|
Flag for Identity Services Engine SDK to enable debugging. Choices:
|
|
The Identity Services Engine hostname. |
|
The Identity Services Engine password to authenticate. |
|
Timeout (in seconds) for RESTful HTTP requests. Default: |
|
The Identity Services Engine username to authenticate. |
|
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:
|
|
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:
|
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Identity Services Engine to use. Default: |
|
Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices:
|
|
Local Tunnel IP address. |
|
The Mode type used for establishing the connection. |
|
NAD IP address for establishing connection. |
|
Phase-one DH group used for establishing connection. |
|
Phase-one encryption algorithm used for establishing connection. |
|
Phase-one hashing algorithm used for establishing connection. |
|
Phase-one connection lifetime. |
|
Phase-two DH group used for establishing connection. |
|
Phase-two encryption algorithm used for establishing connection. |
|
Phase-two hashing algorithm used for establishing connection. |
|
Phase-two connection lifetime. |
|
Pre-shared key used for establishing connection. |
|
Remote Tunnel IP address. |
Notes
Note
SDK Method used are native_ipsec.NativeIpsec.create_ipsec_connection, native_ipsec.NativeIpsec.update_ipsec_connection_config,
Paths used are post /api/v1/ipsec, put /api/v1/ipsec,
Does not support
check_modeThe 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: Update all
cisco.ise.ipsec:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
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
- name: Create
cisco.ise.ipsec:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: |
|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: |