cisco.ise.ipsec 模块 – Ipsec 资源模块

注意

此模块是 cisco.ise 集合 (版本 2.9.6) 的一部分。

如果您正在使用 ansible 软件包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install cisco.ise。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定：cisco.ise.ipsec。

cisco.ise 1.0.0 中的新增功能

概要

• 管理 Ipsec 资源的创建和更新操作。

• 创建一个 IPsec 连接。

• 更新现有 IPsec 连接的配置。

注意

此模块具有相应的 action 插件。

要求

执行此模块的主机需要以下要求。

• ciscoisesdk >= 2.2.3

• python >= 3.5

参数

参数	注释
authType 字符串	用于建立连接的身份验证类型。
certId 字符串	用于建立连接的证书的 ID。
configureVti 布尔值	用于建立连接的身份验证类型。 选项 false true
espAhProtocol 字符串	用于建立连接的加密协议。
hostName 字符串	节点的主机名。
iface 字符串	节点的以太网端口。
ikeReAuthTime 整数	IKE 重新认证时间。
ikeVersion 字符串	IKE 版本。
ise_debug 布尔值	用于 Identity Services Engine SDK 的标志，用于启用调试。 选项 false ← (默认) true
ise_hostname 字符串 / 必需	Identity Services Engine 主机名。
ise_password 字符串 / 必需	用于身份验证的 Identity Services Engine 密码。
ise_single_request_timeout 整数 在 cisco.ise 3.0.0 中添加	RESTful HTTP 请求的超时时间（以秒为单位）。 默认值： 60
ise_username 字符串 / 必需	用于身份验证的 Identity Services Engine 用户名。
ise_uses_api_gateway 布尔值 在 cisco.ise 1.1.0 中添加	告知 SDK 是否使用 Identity Services Engine 的 API Gateway 发送请求的标志。 如果为真，则使用 ISE 的 API Gateway 并将请求发送到 https://{{ise_hostname}}。 如果为假，则将请求发送到 https://{{ise_hostname}}:{{port}}，其中端口值取决于使用的服务（ERS、Mnt、UI、PxGrid）。 选项 false true ← (默认)
ise_uses_csrf_token 布尔值 在 cisco.ise 3.0.0 中添加	告知 SDK 我们是否将 CSRF 令牌发送到 ISE 的 ERS API 的标志。 如果为 True，则 SDK 假设您的 ISE CSRF 检查已启用。 如果为 True，则假定您需要 SDK 自动为您管理 CSRF 令牌。 选项 false ← (默认) true
ise_verify 布尔值	启用或禁用 SSL 证书验证的标志。 选项 false true ← (默认)
ise_version 字符串	告知 SDK 使用哪个版本的 Identity Services Engine。 默认值： "3.1_Patch_1"
ise_wait_on_rate_limit 布尔值	用于 Identity Services Engine SDK 的标志，用于启用自动速率限制处理。 选项 false true ← (默认)
localInternalIp 字符串	本地隧道 IP 地址。
modeOption 字符串	用于建立连接的模式类型。
nadIp 字符串	用于建立连接的 NAD IP 地址。
phaseOneDHGroup 字符串	用于建立连接的第一阶段 DH 组。
phaseOneEncryptionAlgo 字符串	用于建立连接的第一阶段加密算法。
phaseOneHashAlgo 字符串	用于建立连接的第一阶段哈希算法。
phaseOneLifeTime 整数	第一阶段连接生命周期。
phaseTwoDHGroup 字符串	用于建立连接的第二阶段 DH 组。
phaseTwoEncryptionAlgo 字符串	用于建立连接的第二阶段加密算法。
phaseTwoHashAlgo 字符串	用于建立连接的第二阶段哈希算法。
phaseTwoLifeTime 整数	第二阶段连接生命周期。
psk 字符串	用于建立连接的预共享密钥。
remotePeerInternalIp 字符串	远程隧道 IP 地址。

注释

注意

• 使用的 SDK 方法为 native_ipsec.NativeIpsec.create_ipsec_connection、native_ipsec.NativeIpsec.update_ipsec_connection_config，

• 使用的路径为 post /api/v1/ipsec、put /api/v1/ipsec，

• 不支持 check_mode

• 插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco ISE SDK 中的嵌入式连接管理器

• 以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接

示例

- 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

返回值

常见的返回值已记录在 此处，以下是此模块特有的字段

键	描述
ise_response 列表 / 元素=字典	包含 Cisco ISE Python SDK 返回的响应的字典或列表 返回： 始终 示例： "[\n  {\n    \"authType\": \"字符串\",\n    \"certId\": \"字符串\",\n    \"configureVti\": true,\n    \"createTime\": \"字符串\",\n    \"espAhProtocol\": \"字符串\",\n    \"hostName\": \"字符串\",\n    \"id\": \"字符串\",\n    \"iface\": \"字符串\",\n    \"ikeReAuthTime\": 0,\n    \"ikeVersion\": \"字符串\",\n    \"localInternalIp\": \"字符串\",\n    \"modeOption\": \"字符串\",\n    \"nadIp\": \"字符串\",\n    \"phaseOneDHGroup\": \"字符串\",\n    \"phaseOneEncryptionAlgo\": \"字符串\",\n    \"phaseOneHashAlgo\": \"字符串\",\n    \"phaseOneLifeTime\": 0,\n    \"phaseTwoDHGroup\": \"字符串\",\n    \"phaseTwoEncryptionAlgo\": \"字符串\",\n    \"phaseTwoHashAlgo\": \"字符串\",\n    \"phaseTwoLifeTime\": 0,\n    \"psk\": \"字符串\",\n    \"remotePeerInternalIp\": \"字符串\",\n    \"status\": \"字符串\",\n    \"updateTime\": \"字符串\"\n  }\n]\n"
ise_update_response 字典 在 cisco.ise 1.1.0 中添加	包含 Cisco ISE Python SDK 返回的响应的字典或列表 返回： 始终 示例： {"response": {"authType": "字符串", "certId": "字符串", "configureVti": true, "createTime": "字符串", "espAhProtocol": "字符串", "hostName": "字符串", "id": "字符串", "iface": "字符串", "ikeReAuthTime": 0, "ikeVersion": "字符串", "link": {"href": "字符串", "rel": "字符串", "type": "字符串"}, "localInternalIp": "字符串", "modeOption": "字符串", "nadIp": "字符串", "phaseOneDHGroup": "字符串", "phaseOneEncryptionAlgo": "字符串", "phaseOneHashAlgo": "字符串", "phaseOneLifeTime": 0, "phaseTwoDHGroup": "字符串", "phaseTwoEncryptionAlgo": "字符串", "phaseTwoHashAlgo": "字符串", "phaseTwoLifeTime": 0, "psk": "字符串", "remotePeerInternalIp": "字符串", "status": "字符串", "updateTime": "字符串"}, "version": "字符串"}

作者

• Rafael Campos (@racampos)

资源链接

• 问题跟踪器
• 代码仓库