purestorage.flasharray.purefa_volume 模块 – 管理 Pure Storage FlashArrays 上的卷

注意

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

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

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

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

purestorage.flasharray 1.0.0 中的新增功能

概要

• 在 Pure Storage FlashArray 上创建、删除或扩展卷的容量。

要求

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

• python >= 3.3

• purestorage >= 1.19

• py-pure-client >= 1.26.0

• netaddr

• requests

• pycountry

• urllib3

参数

参数	注释
add_to_pgs 列表 / 元素=字符串 在 purestorage.flasharray 1.14.0 中添加	新卷将在创建时添加到指定的保护组
api_token 字符串	具有管理员权限用户的 FlashArray API 令牌。
bw_qos 别名：qos 字符串	卷的带宽限制，单位为 M 或 G。M 将设置 MB/s，G 将设置 GB/s。要清除现有的 QoS 设置，请使用 0 (零)
count 整数	在多卷创建中要创建的卷数 仅从 Purity//FA v6.0.0 及更高版本支持
digits 整数	用于多卷计数的位数。这将在必要时用零填充索引号 仅从 Purity//FA v6.0.0 及更高版本支持 范围介于 1 和 10 之间 默认值： 1
disable_warnings 布尔值 在 purestorage.flasharray 1.29.0 中添加	在调试日志中禁用不安全的证书警告 选项 false ← (默认) true
eradicate 布尔值	定义在删除时是否彻底清除卷或将其留在回收站中。 选项 false ← (默认) true
fa_url 字符串	FlashArray 管理 IPv4 地址或主机名。
iops_qos 字符串	卷的 IOPS 限制 - 使用值或 K 或 M，K 表示 1000，M 表示 1000000。要清除现有的 IOPS 设置，请使用 0 (零)
move 字符串	将卷移入和移出 Pod 或 vgroup 提供要将卷移动到的 Pod 或 vgroup 的名称 Pod 和 Vgroup 名称在阵列中必须唯一 要移动到本地阵列，请指定 local 这不是幂等的 - 在 Playbook 中使用 ignore_errors
name 字符串 / 必需	卷的名称。 可以使用此语法 POD_NAME::VOLUME_NAME 在 POD 中创建卷。 可以使用此语法 VG_NAME/VOLUME_NAME 在卷组中创建卷。 多卷支持从 Purity//FA 6.0.0 开始提供 ***注意*** 手动删除或彻底清除使用多卷创建的单个卷将导致幂等性失败 多卷支持仅适用于卷创建
overwrite 布尔值	定义是否覆盖已存在的目标卷。 选项 false ← (默认) true
pgroup 字符串 在 purestorage.flasharray 1.8.0 中添加	要将卷添加到的现有（未删除）保护组的名称 仅适用于卷创建 从 Purity//FA 6.3.4 开始被 add_to_pgs 取代
priority_operator 字符串 在 purestorage.flasharray 1.13.0 中添加	DMM 优先级调整运算符 选项 "=" "+" "-"
priority_value 整数 在 purestorage.flasharray 1.13.0 中添加	DMM 优先级调整值 选项 -10 0 10
promotion_state 字符串 在 purestorage.flasharray 1.16.0 中添加	提升或降级卷，以便卷开始或停止接受写入请求。 选项 “已提升” “已降级”
rename 字符串	要将指定卷重命名的值。 重命名仅适用于当前卷所在的容器。 不需要指定 Pod 或 vgroup 名称，因为这是隐含的。
size 字符串	卷大小，单位为 M、G、T 或 P。
start 整数	多卷创建索引的起始编号 仅从 Purity//FA v6.0.0 及更高版本支持 默认值： 0
state 字符串	定义卷是否存在。 选项 “不存在” "存在" ← (默认)
suffix 字符串	如果需要，用于多卷创建的后缀字符串 卷名称将形成为 <name>#I<suffix>，其中 # 是卷索引的占位符。请参阅相关描述 仅从 Purity//FA v6.0.0 及更高版本支持 默认值： ""
target 字符串	如果是复制，则为目标卷的名称。
with_default_protection 布尔值 在 purestorage.flasharray 1.14.0 中添加	是否将默认容器保护组添加到 add_to_pgs 中指定的组，作为新卷的初始保护。 选项 false true ← (默认)

注释

注意

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

• 特定模块可能需要额外的 Python 库。

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

示例

- name: Create new volume named foo with a QoS limit
  purestorage.flasharray.purefa_volume:
    name: foo
    size: 1T
    bw_qos: 58M
    iops_qos: 23K
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: present

- name: Create new volume named foo with a DMM priority (Purity//FA 6.1.2+)
  purestorage.flasharray.purefa_volume:
    name: foo
    size: 1T
    priority_operator: +
    priorty_value: 10
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: present

- name: Create new volume named foo in pod bar in protection group pg1
  purestorage.flasharray.purefa_volume:
    name: bar::foo
    pgroup: pg1
    size: 1T
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: present

- name: Create 10 volumes with index starting at 10 but padded with 3 digits
  purestorage.flasharray.purefa_volume:
    name: foo
    size: 1T
    suffix: bar
    count: 10
    start: 10
    digits: 3
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: present

- name: Extend the size of an existing volume named foo
  purestorage.flasharray.purefa_volume:
    name: foo
    size: 2T
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: present

- name: Delete and eradicate volume named foo
  purestorage.flasharray.purefa_volume:
    name: foo
    eradicate: true
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: absent

- name: Create clone of volume bar named foo
  purestorage.flasharray.purefa_volume:
    name: foo
    target: bar
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: present

- name: Overwrite volume bar with volume foo
  purestorage.flasharray.purefa_volume:
    name: foo
    target: bar
    overwrite: true
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: present

- name: Clear volume QoS from volume foo
  purestorage.flasharray.purefa_volume:
    name: foo
    bw_qos: 0
    iops_qos: 0
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: present

- name: Move local volume foo from local array to pod bar
  purestorage.flasharray.purefa_volume:
    name: foo
    move: bar
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Move volume foo in pod bar to local array
  purestorage.flasharray.purefa_volume:
    name: bar::foo
    move: local
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Move volume foo in pod bar to vgroup fin
  purestorage.flasharray.purefa_volume:
    name: bar::foo
    move: fin
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

返回值

通用返回值记录在这里，以下是本模块特有的字段。

键	描述
volume 字典	一个描述已更改卷的字典。只有以下某些属性会随着各种操作返回。 返回：成功
bandwidth_limit 整数	卷带宽限制，单位为字节/秒 返回：成功
created 字符串	卷创建时间 返回：成功 示例： "2019-03-13T22:49:24Z"
iops_limit 整数	卷 IOPS 限制 返回：成功
name 字符串	name 返回：成功
nvme_nguid 字符串	卷 NVMe 命名空间全局唯一标识符 返回：成功 示例： "eui.00cd6b99ef25864724a937c5000be684"
page83_naa 字符串	卷 NAA 规范名称 返回：成功 示例： "naa.624a9370361019ecace43db3000120a4"
priority_operator 字符串	DMM 优先级调整运算符 返回：成功
priority_value 整数	DMM 优先级调整值 返回：成功
serial 字符串	卷序列号 返回：成功 示例： "361019ECACE43D83000120A4"
size 整数	size 返回：成功
source 字符串	用于卷复制的源卷的卷名称 返回：成功

作者

• Pure Storage Ansible 团队 (@sdodsley)

集合链接

• 问题跟踪器
• 存储库（源代码）
• 提交错误报告
• 请求功能
• 通信