cisco.ise.subscriber_bulk 模块 – 批量订阅者资源模块

注意

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

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

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

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

cisco.ise 2.8.0 中的新增功能

概要 

管理资源批量订阅者的创建操作。

注意

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

要求 

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

ciscoisesdk >= 2.2.3
python >= 3.5

参数 

参数	注释
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 网关发送请求的标志。如果为真，则使用 ISE 的 API 网关并将请求发送到 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 的标志。如果为真，则 SDK 假设您的 ISE CSRF 检查已启用。如果为真，则假定您需要 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` ← (默认)
ItemList 列表 / 元素=字典	批量订阅者的 ItemList。
enabled 布尔值	订阅者是否启用。选项 `false` `true`
friendlyName 字符串	订阅者的友好名称。
id 字符串	批量订阅者的 ID。
identityGroups 字符串	身份组。如果有多个 idGroups，则需要用逗号分隔。
imeis 字符串	要附加到订阅者的用逗号分隔的 IMEI。
imsi 字符串	订阅者的 IMSI。
ki 字符串	KI。
opc 字符串	OPC。
operation 字符串	批量订阅者的操作。

注释 

注意

使用的 SDK 方法是 subscriber.Subscriber.bulk_subscriber_operation，
使用的路径是 post /api/v1/fiveg/subscriber/bulk，
不支持 check_mode
插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco ISE SDK 中的嵌入式连接管理器
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接

示例 

- name: Create
  cisco.ise.subscriber_bulk:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    ItemList:
    - enabled: true
      friendlyName: string
      id: string
      identityGroups: string
      imeis: string
      imsi: string
      ki: string
      opc: string
    operation: string

返回值 

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

键	描述
ise_response 字典	Cisco ISE Python SDK 返回的响应字典或列表。返回值：始终返回示例： `{"id": "string"}`

作者

Rafael Campos (@racampos)