infinidat.infinibox.infini_metadata 模块 – 在 Infinibox 上创建、删除或修改元数据

注意

此模块是 infinidat.infinibox 集合 (版本 1.4.5) 的一部分。

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

要安装它,请使用: ansible-galaxy collection install infinidat.infinibox。您需要其他要求才能使用此模块,有关详细信息,请参见 要求

要在剧本中使用它,请指定: infinidat.infinibox.infini_metadata

infinidat.infinibox 2.13.0 中的新增功能

摘要

  • 此模块在 Infinibox 上创建、删除或修改元数据。

  • 对于任何 object_type,都没有实现通过对象删除元数据而不指定键的操作 (例如 DELETE api/rest/metadata/system)。

  • 这将删除属于该对象的所有元数据。请改用其键名显式删除每个键。

要求

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

参数

参数

注释

key

字符串 / 必需

元数据键的名称

object_name

字符串

对象的名称。如果 object_type 为 system,则不使用

object_type

字符串 / 必需

对象的类型

选项

  • "cluster"

  • "fs"

  • "fs-snap"

  • "host"

  • "pool"

  • "system"

  • "vol"

  • "vol-snap"

password

字符串 / 必需

Infinibox 用户密码。

state

字符串

存在时创建/修改元数据,不存在时删除。

选项

  • "stat"

  • "present" ← (默认)

  • "absent"

system

字符串 / 必需

Infinibox 主机名或 IPv4 地址。

user

字符串 / 必需

具有足够权限的 Infinibox 用户用户名(参见注释)。

value

字符串

元数据键的值

注释

注意

  • 此模块需要 infinisdk python 库

  • 如果未将 user 和 password 参数直接传递到模块,则必须设置 INFINIBOX_USER 和 INFINIBOX_PASSWORD 环境变量

  • 如果没有提供凭据,Ansible 将使用 infinisdk 配置文件 ~/.infinidat/infinisdk.ini。参见 http://infinisdk.readthedocs.io/en/latest/getting_started.html

  • 所有 Infinidat 模块都支持检查模式(--check)。但是,如果资源依赖关系未满足任务,则创建资源的预演可能会失败。例如,考虑一个在池中创建卷的任务。如果池不存在,则卷创建任务将失败。即使剧本中存在先前任务会创建池但未创建(因为池创建也是预演的一部分),它也会失败。

示例

- name: Create new metadata key foo with value bar
  infini_metadata:
    name: foo
    key: bar
    state: present
    user: admin
    password: secret
    system: ibox001
- name: Stat metadata key named foo
  infini_metadata:
    name: foo
    state: stat
    user: admin
    password: secret
    system: ibox001
- name: Remove metadata keyn named foo
  infini_vol:
    name: foo_snap
    state: absent
    user: admin
    password: secret
    system: ibox001

作者

  • David Ohlemacher (@ohlemacher)