cisco.ise.ipsec_info 模块 – Ipsec 信息的信息模块

注意

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

如果您使用的是 ansible 包,您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用:ansible-galaxy collection install cisco.ise。您需要进一步的要求才能使用此模块,请参阅 要求 以了解详细信息。

要在 playbook 中使用它,请指定:cisco.ise.ipsec_info

cisco.ise 1.0.0 中的新功能

概要

  • 获取所有 Ipsec 信息。

  • 按 ID 获取 Ipsec 信息。

  • 返回所有已启用 IPsec 的节点及其配置详细信息。

  • 返回具有主机名和 NAD IP 的给定节点的 IPsec 配置详细信息。

注意

此模块具有相应的 操作插件

要求

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

  • ciscoisesdk >= 2.2.3

  • python >= 3.5

参数

参数

注释

filter

字符串

过滤器查询参数。.. 容器 **简单的筛选** 应该可以通过过滤器查询字符串参数获得。过滤器的结构是一个由点分隔的字段运算符和值的三元组。可以发送多个过滤器。所有过滤器条件通用的逻辑运算符默认为 AND,并且可以通过使用 *“filterType=or”* 查询字符串参数来更改。

每个资源数据模型描述都应指定属性是否为筛选字段。

“EQ”运算符描述“等于”。

“NEQ”运算符描述“不等于”。

“GT”运算符描述“大于”。

“LT”运算符描述“小于”。

“STARTSW”运算符描述“以...开头”。

“NSTARTSW”运算符描述“不以...开头”。

“ENDSW”运算符描述“以...结尾”。

“NENDSW”运算符描述“不以...结尾”。

“CONTAINS”运算符描述“包含”。

“NCONTAINS”运算符描述“不包含”。

filterType

字符串

FilterType 查询参数。所有过滤器条件通用的逻辑运算符默认为 AND,并且可以通过使用此参数来更改。

hostName

字符串

HostName 路径参数。已部署节点的主机名。

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 网关发送请求的标志。

如果为 true,它将使用 ISE 的 API 网关并将请求发送到 https://{{ise_hostname}}。

如果为 false,它将请求发送到 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 ← (默认)

nadIp

字符串

NadIp 路径参数。NAD 的 IP 地址。

page

整数

Page 查询参数。页码。

size

整数

Size 查询参数。每页返回的对象数。

sort

字符串

Sort 查询参数。排序类型 - asc 或 desc。

sortBy

字符串

SortBy 查询参数。排序列 - 已启用 IPsec 的节点根据列进行排序。这适用于字段 - hostName。

注释

注意

  • 使用的 SDK 方法是 native_ipsec.NativeIpsec.get_ipsec_enabled_nodes_generator, native_ipsec.NativeIpsec.get_ipsec_node,

  • 使用的路径是 get /api/v1/ipsec, get /api/v1/ipsec/{hostName}/{nadIp},

  • 支持 check_mode

  • 该插件在控制节点上运行,不使用任何 ansible 连接插件,而是使用来自 Cisco ISE SDK 的嵌入式连接管理器

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

示例

- name: Get all Ipsec Info
  cisco.ise.ipsec_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 0
    size: 0
    filter: string
    filterType: string
    sort: string
    sortBy: string
  register: result

- name: Get Ipsec Info by id
  cisco.ise.ipsec_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    hostName: string
    nadIp: string
  register: result

返回值

通用返回值记录在此处,以下是此模块特有的字段

描述

ise_response

字典

一个字典或列表,其中包含 Cisco ISE Python SDK 返回的响应

返回值:始终

示例: {"authType": "string", "certId": "string", "configureVti": true, "createTime": "string", "espAhProtocol": "string", "hostName": "string", "id": "string", "iface": "string", "ikeReAuthTime": 0, "ikeVersion": "string", "link": {"href": "string", "rel": "string", "type": "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", "status": "string", "updateTime": "string"}

ise_responses

列表 / 元素=字典

在 cisco.ise 1.1.0 中添加

一个字典或列表,其中包含 Cisco ISE Python SDK 返回的响应

返回值:始终

示例: "[\n  {\n    \"authType\": \"string\",\n    \"certId\": \"string\",\n    \"configureVti\": true,\n    \"createTime\": \"string\",\n    \"espAhProtocol\": \"string\",\n    \"hostName\": \"string\",\n    \"id\": \"string\",\n    \"iface\": \"string\",\n    \"ikeReAuthTime\": 0,\n    \"ikeVersion\": \"string\",\n    \"link\": {\n      \"href\": \"string\",\n      \"rel\": \"string\",\n      \"type\": \"string\"\n    },\n    \"localInternalIp\": \"string\",\n    \"modeOption\": \"string\",\n    \"nadIp\": \"string\",\n    \"phaseOneDHGroup\": \"string\",\n    \"phaseOneEncryptionAlgo\": \"string\",\n    \"phaseOneHashAlgo\": \"string\",\n    \"phaseOneLifeTime\": 0,\n    \"phaseTwoDHGroup\": \"string\",\n    \"phaseTwoEncryptionAlgo\": \"string\",\n    \"phaseTwoHashAlgo\": \"string\",\n    \"phaseTwoLifeTime\": 0,\n    \"psk\": \"string\",\n    \"remotePeerInternalIp\": \"string\",\n    \"status\": \"string\",\n    \"updateTime\": \"string\"\n  }\n]\n"

作者

  • Rafael Campos (@racampos)