purestorage.flasharray.purefa_saml 模块 – 管理 FlashArray SAML2 服务和身份提供程序

注意

此模块是 purestorage.flasharray 集合（版本 1.32.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install purestorage.flasharray。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。

要在 Playbook 中使用它，请指定：purestorage.flasharray.purefa_saml。

purestorage.flasharray 1.12.0 中的新增功能

概要

  • 启用或禁用 FlashArray SAML2 提供程序

要求

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

  • python >= 3.3

  • purestorage >= 1.19

  • py-pure-client >= 1.26.0

  • netaddr

  • requests

  • pycountry

  • urllib3

参数

参数

评论

api_token

字符串

具有管理员权限的用户的 FlashArray API 令牌。

array_url

字符串

FlashArray 的 URL

decryption_credential

字符串

服务提供商用来解密来自身份提供商的加密 SAML 断言的凭据

disable_warnings

布尔值

在 purestorage.flasharray 1.29.0 中添加

在调试日志中禁用不安全的证书警告

选择

  • false ← (默认)

  • true

enabled

布尔值

定义身份提供商的启用状态

选择

  • false ← (默认)

  • true

encrypt_asserts

布尔值

如果设置为 true，SAML 断言将由身份提供程序加密

选择

  • false ← (默认)

  • true

fa_url

字符串

FlashArray 管理 IPv4 地址或主机名。

metadata_url

字符串

身份提供商元数据的 URL

name

字符串 / 必填

SAML2 身份提供商 (IdP) 的名称

sign_request

布尔值

如果设置为 true，则 SAML 请求将由服务提供商签名。

选择

  • false ← (默认)

  • true

signing_credential

字符串

服务提供商用来签署 SAML 请求的凭据

state

字符串

定义 API 客户端是否存在或不存在，或者测试。

选择

  • "absent"

  • "present" ← (默认)

  • "test"

url

字符串

身份提供商的 URL

x509_cert

字符串

服务提供商用来验证来自身份提供商的 SAML 响应签名的 X509 证书

备注

注意

  • 此模块需要 purestorage 和 py-pure-client Python 库

  • 特定模块可能需要其他 Python 库。

  • 如果未将 fa_url 和 api_token 参数直接传递给模块，则必须设置 PUREFA_URL 和 PUREFA_API 环境变量

示例

- name: Create (disabled) SAML2 SSO with only metadata URL
  purestorage.flasharray.purefa_saml:
    name: myIDP
    array_url: "https://10.10.10.2"
    metadata_url: "https://myidp.acme.com/adfs/ls"
    x509_cert: "{{lookup('file', 'x509_cert_file') }}"
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Enable SAML2 SSO
  purestorage.flasharray.purefa_saml:
    name: myISO
    enabled: true
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Delete SAML2 SSO
  purestorage.flasharray.purefa_saml:
    state: absent
    name: myIDP
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

作者

  • Pure Storage Ansible 团队 (@sdodsley)