cisco.ise.guest_type 模块 – 访客类型资源模块

注意

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

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

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

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

cisco.ise 1.0.0 中的新增功能

概要

• 管理访客类型资源的创建、更新和删除操作。

• 此 API 创建访客类型。

• 此 API 删除访客类型。

• 此 API 允许客户端更新访客类型。

注意

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

要求

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

• ciscoisesdk >= 2.2.3

• python >= 3.5

参数

参数	注释
accessTime 字典	访客类型的 accessTime。
allowAccessOnSpecificDaysTimes 布尔值	AllowAccessOnSpecificDaysTimes 标志。 选项 false true
dayTimeLimits 列表 / 元素=字典	帐户访问的时间范围列表。
days 列表 / 元素=字符串	日期列表，值应为一周中的某一天。允许的值为 - 星期日，- 星期一，- 星期二，- 星期三，- 星期四，- 星期五，- 星期六。
endTime 字符串	结束时间，格式为 HH mm。
startTime 字符串	开始时间，格式为 HH mm。
defaultDuration 整数	访客类型的 defaultDuration。
durationTimeUnit 字符串	允许的值为 - 天，- 小时，- 分钟。
fromFirstLogin 布尔值	帐户持续时间从第一次登录或指定日期开始。 选项 false true
maxAccountDuration 整数	帐户持续时间的最大值。
description 字符串	访客类型的描述。
expirationNotification 字典	过期通知设置。
advanceNotificationDuration 整数	提前（天、小时、分钟）发送帐户过期通知的持续时间。
advanceNotificationUnits 字符串	允许的值为 - 天，- 小时，- 分钟。
emailText 字符串	访客类型的 emailText。
enableNotification 布尔值	启用通知设置。 选项 false true
sendEmailNotification 布尔值	启用电子邮件通知。 选项 false true
sendSMSNotification 布尔值	访客可以注册的最大设备数。 选项 false true
smsText 字符串	访客类型的 smsText。
id 字符串	访客类型的 ID。
isDefaultType 布尔值	IsDefaultType 标志。 选项 false true
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 网关发送请求的标志。 如果为真，则使用 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 使用哪个版本的标识服务引擎。 默认值： "3.1_Patch_1"
ise_wait_on_rate_limit 布尔值	用于标识服务引擎 SDK 的标志，用于启用自动速率限制处理。 选项 false true ← (默认)
loginOptions 字典	访客类型的 loginOptions。
allowGuestPortalBypass 布尔值	AllowGuestPortalBypass 标志。 选项 false true
failureAction 字符串	当访客超过限制时将调用此操作。允许的值为 - 断开最旧连接，- 断开最新连接。
identityGroupId 字符串	访客类型的 identityGroupId。
limitSimultaneousLogins 布尔值	启用同时登录。 选项 false true
maxRegisteredDevices 整数	访客可以注册的最大设备数。
maxSimultaneousLogins 整数	同时登录的数量。
name 字符串	访客类型的名称。
sponsorGroups 列表 / 元素=字符串	访客类型的 sponsorGroups。

注释

注意

• 使用的 SDK 方法为 guest_type.GuestType.create_guest_type、guest_type.GuestType.delete_guest_type_by_id、guest_type.GuestType.update_guest_type_by_id，

• 使用的路径为 post /ers/config/guesttype、delete /ers/config/guesttype/{id}、put /ers/config/guesttype/{id}，

• 不支持check_mode

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

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

示例

- name: Update by id
  cisco.ise.guest_type:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    accessTime:
      allowAccessOnSpecificDaysTimes: true
      dayTimeLimits:
      - days:
        - string
        endTime: string
        startTime: string
      defaultDuration: 0
      durationTimeUnit: string
      fromFirstLogin: true
      maxAccountDuration: 0
    description: string
    expirationNotification:
      advanceNotificationDuration: 0
      advanceNotificationUnits: string
      emailText: string
      enableNotification: true
      sendEmailNotification: true
      sendSmsNotification: true
      smsText: string
    id: string
    isDefaultType: true
    loginOptions:
      allowGuestPortalBypass: true
      failureAction: string
      identityGroupId: string
      limitSimultaneousLogins: true
      maxRegisteredDevices: 0
      maxSimultaneousLogins: 0
    name: string
    sponsorGroups:
    - string

- name: Delete by id
  cisco.ise.guest_type:
    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_type:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    accessTime:
      allowAccessOnSpecificDaysTimes: true
      dayTimeLimits:
      - days:
        - string
        endTime: string
        startTime: string
      defaultDuration: 0
      durationTimeUnit: string
      fromFirstLogin: true
      maxAccountDuration: 0
    description: string
    expirationNotification:
      advanceNotificationDuration: 0
      advanceNotificationUnits: string
      emailText: string
      enableNotification: true
      sendEmailNotification: true
      sendSmsNotification: true
      smsText: string
    isDefaultType: true
    loginOptions:
      allowGuestPortalBypass: true
      failureAction: string
      identityGroupId: string
      limitSimultaneousLogins: true
      maxRegisteredDevices: 0
      maxSimultaneousLogins: 0
    name: string
    sponsorGroups:
    - string

返回值

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

键	描述
ise_response 字典	Cisco ISE Python SDK 返回的响应的字典或列表。 返回：始终 示例：{"accessTime": {"allowAccessOnSpecificDaysTimes": true, "dayTimeLimits": [{"days": ["string"], "endTime": "string", "startTime": "string"}], "defaultDuration": 0, "durationTimeUnit": "string", "fromFirstLogin": true, "maxAccountDuration": 0}, "description": "string", "expirationNotification": {"advanceNotificationDuration": 0, "advanceNotificationUnits": "string", "emailText": "string", "enableNotification": true, "sendEmailNotification": true, "sendSmsNotification": true, "smsText": "string"}, "id": "string", "isDefaultType": true, "link": {"href": "string", "rel": "string", "type": "string"}, "loginOptions": {"allowGuestPortalBypass": true, "failureAction": "string", "identityGroupId": "string", "limitSimultaneousLogins": true, "maxRegisteredDevices": 0, "maxSimultaneousLogins": 0}, "name": "string", "sponsorGroups": ["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)

集合链接

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