cisco.ise.guest_user 模块 – 客人用户资源模块

注意

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

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

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

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

cisco.ise 1.0.0 中的新增功能

概要

• 管理对资源“访客用户”的创建、更新和删除操作。

• 此 API 创建一个访客用户。

• 此 API 通过 ID 删除访客用户。

• 此 API 删除访客用户。

• 此 API 允许客户端通过 ID 更新访客用户。

• 此 API 允许客户端通过名称更新访客用户。

注意

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

要求

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

• ciscoisesdk >= 2.2.3

• python >= 3.5

参数

参数	注释
customFields 字典	键值映射。
description 字符串	访客用户的描述。
guestAccessInfo 字典	访客用户的 guestAccessInfo。
fromDate 字符串	访客用户的 fromDate。
groupTag 字符串	访客用户的 groupTag。
location 字符串	访客用户的 location。
ssid 字符串	访客用户的 ssid。
toDate 字符串	访客用户的 toDate。
validDays 整数	访客用户的 validDays。
guestInfo 字典	访客用户的 guestInfo。
company 字符串	访客用户的公司。
creationTime 字符串	访客用户的 creationTime。
emailAddress 字符串	访客用户的电子邮件地址。
enabled 布尔值	此字段仅用于获取操作，不适用于创建、更新操作。 选项 false true
firstName 字符串	访客用户的姓名。
lastName 字符串	访客用户的姓氏。
notificationLanguage 字符串	访客用户的通知语言。
password 字符串	访客用户的密码。
phoneNumber 字符串	电话号码应为 E.164 格式。
smsServiceProvider 字符串	访客用户的短信服务提供商。
userName 字符串	如果需要使用手机号创建帐户，请在此处提供手机号。
guestType 字符串	访客用户的 guestType。
id 字符串	访客用户的 ID。
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 ← (默认)
name 字符串	访客用户的名称。
portalId 字符串	访客用户的 portalId。
reasonForVisit 字符串	访客用户的访问原因。
sponsorUserId 字符串	访客用户的担保人用户 ID。
sponsorUserName 字符串	访客用户的担保人用户名。
status 字符串	访客用户的状态。
statusReason 字符串	访客用户的状态原因。

备注

注意

• 使用的 SDK 方法是 guest_user.GuestUser.create_guest_user、guest_user.GuestUser.delete_guest_user_by_id、guest_user.GuestUser.delete_guest_user_by_name、guest_user.GuestUser.update_guest_user_by_id、guest_user.GuestUser.update_guest_user_by_name，

• 使用的路径是 post /ers/config/guestuser、delete /ers/config/guestuser/name/{name}、delete /ers/config/guestuser/{id}、put /ers/config/guestuser/name/{name}、put /ers/config/guestuser/{id}，

• 不支持 check_mode

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

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

示例

- name: Update by name
  cisco.ise.guest_user:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    customFields: {}
    description: string
    guestAccessInfo:
      fromDate: string
      groupTag: string
      location: string
      ssid: string
      toDate: string
      validDays: 0
    guestInfo:
      company: string
      creationTime: string
      emailAddress: string
      enabled: true
      firstName: string
      lastName: string
      notificationLanguage: string
      password: string
      phoneNumber: string
      smsServiceProvider: string
      userName: string
    guestType: string
    id: string
    name: string
    portalId: string
    reasonForVisit: string
    sponsorUserId: string
    sponsorUserName: string
    status: string
    statusReason: string

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

- name: Update by id
  cisco.ise.guest_user:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    customFields: {}
    description: string
    guestAccessInfo:
      fromDate: string
      groupTag: string
      location: string
      ssid: string
      toDate: string
      validDays: 0
    guestInfo:
      company: string
      creationTime: string
      emailAddress: string
      enabled: true
      firstName: string
      lastName: string
      notificationLanguage: string
      password: string
      phoneNumber: string
      smsServiceProvider: string
      userName: string
    guestType: string
    id: string
    name: string
    portalId: string
    reasonForVisit: string
    sponsorUserId: string
    sponsorUserName: string
    status: string
    statusReason: string

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

- name: Create
  cisco.ise.guest_user:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    customFields: {}
    description: string
    guestAccessInfo:
      fromDate: string
      groupTag: string
      location: string
      ssid: string
      toDate: string
      validDays: 0
    guestInfo:
      company: string
      creationTime: string
      emailAddress: string
      enabled: true
      firstName: string
      lastName: string
      notificationLanguage: string
      password: string
      phoneNumber: string
      smsServiceProvider: string
      userName: string
    guestType: string
    name: string
    portalId: string
    reasonForVisit: string
    sponsorUserId: string
    sponsorUserName: string
    status: string
    statusReason: string

返回值

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

键	描述
ise_response 字典	Cisco ISE Python SDK返回的响应字典或列表 返回值：始终 示例： {"customFields": {}, "description": "string", "guestAccessInfo": {"fromDate": "string", "groupTag": "string", "location": "string", "ssid": "string", "toDate": "string", "validDays": 0}, "guestInfo": {"company": "string", "creationTime": "string", "emailAddress": "string", "enabled": true, "firstName": "string", "lastName": "string", "notificationLanguage": "string", "password": "string", "phoneNumber": "string", "smsServiceProvider": "string", "userName": "string"}, "guestType": "string", "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "portalId": "string", "reasonForVisit": "string", "sponsorUserId": "string", "sponsorUserName": "string", "status": "string", "statusReason": "string"}
ise_update_response 字典 在 cisco.ise 1.1.0 中添加	Cisco ISE Python SDK返回的响应字典或列表 返回值：始终 示例： {"UpdatedFieldsList": {"field": "string", "newValue": "string", "oldValue": "string", "updatedField": [{"field": "string", "newValue": "string", "oldValue": "string"}]}}

作者

• Rafael Campos (@racampos)

收藏链接

• 问题跟踪器
• 代码库（源代码）