community.general.packet_project 模块 – 在 Packet 主机中创建/删除项目

注意

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

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

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

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

community.general 0.2.0 中的新增功能

概要 

在 Packet 主机中创建/删除项目。
API 文档位于 https://www.packet.com/developers/api/#projects。

要求 

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

packet-python >= 1.40

参数 

参数	注释
auth_token 字符串	Packet API 令牌。您也可以在环境变量 `PACKET_API_TOKEN` 中提供它。
custom_data 字符串	有关要创建的项目的自定义数据。
id 字符串	您想要删除的项目的 UUID。
name 字符串	项目的名称。
org_id 字符串	要为其创建项目的组织的 UUID。如果为空，API 会假定为默认组织。
payment_method 字符串	支付方式是您的用户可用的支付方式之一的名称。如果为空，API 会假定为默认支付方式。
state 字符串	指示目标所需的状态。选择 `"present"` ←（默认） `"absent"`

属性 

属性	支持	描述
check_mode	支持: 完整	可以在 `check_mode` 中运行并返回已更改的状态预测，而无需修改目标。
diff_mode	支持: 无	当处于 diff 模式时，将返回有关已更改的内容（或可能需要在 `check_mode` 中更改的内容）的详细信息。

示例 

# All the examples assume that you have your Packet API token in env var PACKET_API_TOKEN.
# You can also pass the api token in module param auth_token.

- name: Create new project
  hosts: localhost
  tasks:
    community.general.packet_project:
      name: "new project"

- name: Create new project within non-default organization
  hosts: localhost
  tasks:
    community.general.packet_project:
      name: "my org project"
      org_id: a4cc87f9-e00f-48c2-9460-74aa60beb6b0

- name: Remove project by id
  hosts: localhost
  tasks:
    community.general.packet_project:
      state: absent
      id: eef49903-7a09-4ca1-af67-4087c29ab5b6

- name: Create new project with non-default billing method
  hosts: localhost
  tasks:
    community.general.packet_project:
      name: "newer project"
      payment_method: "the other visa"

返回值 

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

键	描述
changed 布尔值	如果创建或删除了项目，则为 True。返回: 成功示例: `true`
id 字符串	寻址项目的 UUID。返回: 成功
name 字符串	寻址项目的名称。返回: 成功

作者

Tomas Karasek (@t0mk)
Nurfet Becirevic (@nurfet-becirevic)