community.general.ibm_sa_domain 模块 – 管理 IBM Spectrum Accelerate 系列存储系统上的域

注意

此模块是 community.general 集合（版本 10.1.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install community.general。您需要满足其他要求才能使用此模块，请参阅 要求 了解详细信息。

要在 playbook 中使用它，请指定：community.general.ibm_sa_domain。

概要

  • 此模块可用于在 IBM Spectrum Accelerate 系列存储系统中添加或删除域。

要求

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

  • pyxcli

参数

参数

注释

domain

字符串 / 必需

要管理的域的名称。

endpoints

字符串 / 必需

Spectrum Accelerate 存储系统的主机名或管理 IP。

hard_capacity

字符串

域的硬容量。

ldap_id

字符串

要添加到域的 ldap id。

max_cgs

字符串

最大 cgs 数。

max_dms

字符串

最大 dms 数。

max_mirrors

字符串

最大镜像数。

max_pools

字符串

最大池数。

max_volumes

字符串

最大卷数。

password

字符串 / 必需

Spectrum Accelerate 存储系统上用户名的密码。

perf_class

字符串

将域添加到性能类。

size

字符串

域的大小。

soft_capacity

字符串

域的软容量。

state

字符串

域的期望状态。

选择

  • "present" ← (默认)

  • "absent"

username

字符串 / 必需

Spectrum Accelerate 存储系统上的管理用户。

属性

属性

支持

描述

check_mode

支持: 无

可以在 check_mode 中运行，并在不修改目标的情况下返回更改状态预测。

diff_mode

支持: 无

当处于 diff 模式时，将返回已更改（或可能需要在 check_mode 中更改）的详细信息。

备注

注意

  • 此模块需要 pyxcli Python 库。使用 pip install pyxcli 获取 pyxcli。

示例

- name: Define new domain.
  community.general.ibm_sa_domain:
    domain: domain_name
    size: domain_size
    state: present
    username: admin
    password: secret
    endpoints: hostdev-system

- name: Delete domain.
  community.general.ibm_sa_domain:
    domain: domain_name
    state: absent
    username: admin
    password: secret
    endpoints: hostdev-system

返回值

常见的返回值在 此处 有文档记录，以下是此模块独有的字段

键

描述

msg

字符串

模块返回状态。

返回: 根据需要

示例: "domain 'domain_name' created successfully."

作者

  • Tzur Eliyahu (@tzure)