purestorage.flasharray.purefa_apiclient 模块 – 管理 FlashArray API 客户端

注意

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

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

要安装它，请使用：ansible-galaxy collection install purestorage.flasharray。您需要更多要求才能使用此模块，有关详细信息，请参见 需求。

要在 playbook 中使用它，请指定：purestorage.flasharray.purefa_apiclient。

purestorage.flasharray 1.5.0 中的新增功能

概要

  • 启用或禁用 FlashArray API 客户端

需求

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

  • python >= 3.3

  • purestorage >= 1.19

  • py-pure-client >= 1.26.0

  • netaddr

  • requests

  • pycountry

  • urllib3

参数

参数

注释

api_token

字符串

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

disable_warnings

布尔值

在 purestorage.flasharray 1.29.0 中添加

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

选项

  • false ← (默认)

  • true

enabled

布尔值

API 客户端密钥的状态

选项

  • false

  • true ← (默认)

fa_url

字符串

FlashArray 管理 IPv4 地址或主机名。

issuer

字符串

将为该 API 客户端颁发 ID 令牌的身份提供商的名称

如果未指定，则默认为 API 客户端名称 *name*。

name

字符串 / 必填

API 客户端的名称

public_key

字符串

API 客户端的 PEM 格式（Base64 编码）RSA 公钥。

包含 *—–BEGIN PUBLIC KEY—–* 和 *—–END PUBLIC KEY—–* 行

role

字符串

此 API 客户端颁发的 ID 令牌允许的最大角色

选项

  • "readonly"

  • "ops_admin"

  • "storage_admin"

  • "array_admin"

state

字符串

定义 API 客户端是否存在。

选项

  • "absent"

  • "present" ← (默认)

token_ttl

整数

交换的访问令牌的生存时间（以秒为单位）

范围为 1 秒到 1 天（86400 秒）

默认： 86400

备注

注意

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

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

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

示例

- name: Create API token ansible-token
  purestorage.flasharray.purefa_apiclient:
    name: ansible-token
    issuer: "Pure Storage"
    token_ttl: 3000
    role: array_admin
    public_key: "{{lookup('file', 'public_pem_file') }}"
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Disable API CLient
  purestorage.flasharray.purefa_apiclient:
    name: ansible-token
    enabled: false
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Enable API CLient
  purestorage.flasharray.purefa_apiclient:
    name: ansible-token
    enabled: true
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Delete API Client
  purestorage.flasharray.purefa_apiclient:
    state: absent
    name: ansible-token
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

作者

  • Pure Storage Ansible 团队 (@sdodsley)