cisco.ise.subscriber 模块 – Subscriber 的资源模块

注意

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

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

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

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

cisco.ise 2.8.0 中的新增功能

概要

  • 管理资源 Subscriber 的创建、更新和删除操作。

注意

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

要求

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

  • ciscoisesdk >= 2.2.3

  • python >= 3.5

参数

参数

注释

enabled

布尔值

是否启用 Subscriber。

选项

  • false

  • true

friendlyName

字符串

Subscriber 的友好名称。

identityGroups

字符串

身份组。如果有多于一个 idGroups，则需要用逗号分隔。

imeis

字符串

要附加到 Subscriber 的 IMEI。

imsi

字符串

Subscriber 的 IMSI。

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 ← (默认)

ki

字符串

KI。

opc

字符串

OPC。

subscriberId

字符串

SubscriberId 路径参数。subscriber 对象的唯一 ID。

注释

注意

  • 使用的 SDK 方法是 subscriber.Subscriber.create_subscriber、subscriber.Subscriber.delete_subscriber、subscriber.Subscriber.update_subscriber，

  • 使用的路径是 post /api/v1/fiveg/subscriber、delete /api/v1/fiveg/subscriber/{subscriberId}、put /api/v1/fiveg/subscriber/{subscriberId}，

  • 不支持 check_mode

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

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

示例

- name: Create
  cisco.ise.subscriber:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    enabled: true
    friendlyName: string
    identityGroups: string
    imeis: string
    imsi: string
    ki: string
    opc: string

- name: Update by id
  cisco.ise.subscriber:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    enabled: true
    friendlyName: string
    identityGroups: string
    imeis: string
    ki: string
    opc: string
    subscriberId: string

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

返回值

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

键

描述

ise_response

字典

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

返回: 总是

示例: {"createTime": "string", "enabled": true, "friendlyName": "string", "id": "string", "identityGroups": "string", "imeis": "string", "imsi": "string", "ki": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "opc": "string", "updateTime": "string"}

ise_update_response

字典

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

返回: 总是

示例: {"response": {"createTime": "string", "enabled": true, "friendlyName": "string", "id": "string", "identityGroups": "string", "imeis": "string", "imsi": "string", "ki": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "opc": "string", "updateTime": "string"}, "version": "string"}

作者

  • Rafael Campos (@racampos)