cisco.ise.device_administration_network_conditions 模块 – 设备管理网络条件资源模块

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.ise。您需要其他要求才能使用此模块，请参阅 要求 了解更多详情。

要在剧本中使用它，请指定：cisco.ise.device_administration_network_conditions。

cisco.ise 1.0.0 中的新增功能

概要

  • 管理设备管理网络条件资源的创建、更新和删除操作。

  • 设备管理员 - 创建网络条件。

  • 设备管理员 - 删除网络条件。

  • 设备管理员 - 更新网络条件。

注意

此模块具有相应的 动作插件。

要求

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

  • ciscoisesdk >= 2.2.3

  • python >= 3.5

参数

参数

注释

cliDnisList

列表 / 元素=字符串

<p>此字段应包含主叫号码 (CLI)、逗号和被叫号码 (DNIS)。<br> 行格式 - 主叫号码 (CLI)、被叫号码 (DNIS)</p>。

conditionType

字符串

此字段确定条件字段的内容。

description

字符串

设备管理网络条件的描述。

deviceGroupList

列表 / 元素=字符串

<p>此字段应包含一个包含 NDG 根、逗号和 NDG（位于根目录下）的元组。<br> 行格式 - NDG 根名称、NDG、端口</p>。

deviceList

列表 / 元素=字符串

<p>此字段应包含设备名称。设备名称必须与网络设备对象中的名称字段相同。行格式 - 设备名称</p>。

id

字符串

设备管理网络条件的 ID。

ipAddrList

列表 / 元素=字符串

<p>此字段应包含 IP 地址或子网。<br> IP 地址可以是 IPV4 格式 (n.n.n.n) 或 IPV6 格式 (n n n n n n n n)。<br> IP 子网可以是 IPV4 格式 (n.n.n.n/m) 或 IPV6 格式 (n n n n n n n n/m)。<br> 行格式 - IP 地址或子网</p>。

ise_debug

布尔值

用于启用身份服务引擎 SDK 调试的标志。

选项

  • false ← (默认)

  • true

ise_hostname

字符串 / 必需

身份服务引擎主机名。

ise_password

字符串 / 必需

身份服务引擎密码，用于身份验证。

ise_single_request_timeout

整数

在 cisco.ise 3.0.0 中添加

RESTful HTTP 请求的超时时间（以秒为单位）。

默认值： 60

ise_username

字符串 / 必需

身份服务引擎用户名，用于身份验证。

ise_uses_api_gateway

布尔值

在 cisco.ise 1.1.0 中添加

告知 SDK 是否使用身份服务引擎的 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 使用哪个版本的身份服务引擎。

默认值： "3.1_Patch_1"

ise_wait_on_rate_limit

布尔值

用于启用身份服务引擎 SDK 自动速率限制处理的标志。

选项

  • false

  • true ← (默认)

字典

设备管理网络条件的链接。

字符串

设备管理网络条件的 href。

字符串

设备管理网络条件的 rel。

字符串

设备管理网络条件的类型。

macAddrList

列表 / 元素=字符串

<p>此字段应包含终端 MAC 地址、逗号和目标 MAC 地址。<br> 每个 Max 地址必须包含十二个十六进制数字，使用格式 nn nn nn nn nn nn 或 nn-nn-nn-nn-nn-nn 或 nnnn.nnnn.nnnn 或 nnnnnnnnnnnn。<br> 行格式 - 终端 MAC、目标 MAC </p>。

name

字符串

网络条件名称。

备注

注意

  • 使用的 SDK 方法为 device_administration_network_conditions.DeviceAdministrationNetworkConditions.create_device_admin_network_condition、device_administration_network_conditions.DeviceAdministrationNetworkConditions.delete_device_admin_network_condition_by_id、device_administration_network_conditions.DeviceAdministrationNetworkConditions.update_device_admin_network_condition_by_id，

  • 使用的路径为 post /device-admin/network-condition、delete /device-admin/network-condition/{id}、put /device-admin/network-condition/{id}，

  • 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco ISE 设备管理 - 网络条件文档

设备管理 - 网络条件 API 的完整参考。

示例

- name: Create
  cisco.ise.device_administration_network_conditions:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    cliDnisList:
    - string
    conditionType: string
    description: string
    deviceGroupList:
    - string
    deviceList:
    - string
    id: string
    ipAddrList:
    - string
    link:
      href: string
      rel: string
      type: string
    macAddrList:
    - string
    name: string

- name: Update by id
  cisco.ise.device_administration_network_conditions:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    cliDnisList:
    - string
    conditionType: string
    description: string
    deviceGroupList:
    - string
    deviceList:
    - string
    id: string
    ipAddrList:
    - string
    link:
      href: string
      rel: string
      type: string
    macAddrList:
    - string
    name: string

- name: Delete by id
  cisco.ise.device_administration_network_conditions:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    id: string

返回值

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

键

描述

ise_response

字典

包含 Cisco ISE Python SDK 返回的响应的字典或列表

返回： 始终

示例： {"cliDnisList": ["string"], "conditionType": "string", "description": "string", "deviceGroupList": ["string"], "deviceList": ["string"], "id": "string", "ipAddrList": ["string"], "link": {"href": "string", "rel": "string", "type": "string"}, "macAddrList": ["string"], "name": "string"}

ise_update_response

字典

在 cisco.ise 1.1.0 中添加

包含 Cisco ISE Python SDK 返回的响应的字典或列表

返回： 始终

示例： {"response": {"cliDnisList": ["string"], "conditionType": "string", "description": "string", "deviceGroupList": ["string"], "deviceList": ["string"], "id": "string", "ipAddrList": ["string"], "link": {"href": "string", "rel": "string", "type": "string"}, "macAddrList": ["string"], "name": "string"}, "version": "string"}

作者

  • Rafael Campos (@racampos)