cisco.ise.repository 模块 – 存储库的资源模块

注意

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

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

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

要在 playbook 中使用它,请指定:cisco.ise.repository

cisco.ise 1.0.0 中的新增功能

概要

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

  • 在系统中创建新的存储库。为存储库提供的名称必须是唯一的。

  • 长描述待定。

  • 更新特定存储库的定义,提供存储库的所有参数。

注意

此模块具有相应的 操作插件

要求

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

  • ciscoisesdk >= 2.2.3

  • python >= 3.5

参数

参数

注释

enablePki

布尔值

EnablePki 标志。

选项

  • false

  • true

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

name

字符串

存储库名称应少于 80 个字符,并且可以包含字母数字、下划线、连字符和点字符。

password

字符串

密码可以包含字母数字和/或特殊字符。

path

字符串

路径应始终以“/”开头,并且可以包含字母数字、下划线、连字符和点字符。

protocol

字符串

存储库的协议。

repositoryName

字符串

RepositoryName 路径参数。存储库的唯一名称。

serverName

字符串

存储库的 serverName。

userName

字符串

用户名可以包含字母数字和 _-./@\$ 字符。

备注

注意

  • 使用的 SDK 方法是 repository.Repository.create_repository、repository.Repository.delete_repository、repository.Repository.update_repository,

  • 使用的路径是 post /api/v1/repository、delete /api/v1/repository/{repositoryName}、put /api/v1/repository/{repositoryName},

  • 不支持 check_mode

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

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

参见

另请参阅

有关存储库的 Cisco ISE 文档

存储库 API 的完整参考。

示例

- name: Create
  cisco.ise.repository:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    enablePki: true
    name: string
    password: string
    path: string
    protocol: string
    serverName: string
    userName: string

- name: Update by name
  cisco.ise.repository:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    enablePki: true
    name: string
    password: string
    path: string
    protocol: string
    repositoryName: string
    serverName: string
    userName: string

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

返回值

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

描述

ise_response

字典

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

返回: 总是

示例: {"enablePki": true, "name": "string", "password": "string", "path": "string", "protocol": "string", "serverName": "string", "userName": "string"}

ise_update_response

字典

在 cisco.ise 1.1.0 中添加

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

返回: 总是

示例: {"success": {"message": "string"}, "version": "string"}

作者

  • Rafael Campos (@racampos)