openstack.cloud.quota 模块 – 管理 OpenStack 配额

注意

此模块是 openstack.cloud 集合（版本 2.3.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install openstack.cloud。您需要更多要求才能使用此模块，请参阅要求了解详细信息。

要在 playbook 中使用它，请指定：openstack.cloud.quota。

概要 

管理 OpenStack 配额。可以使用此模块创建、更新或删除配额。如果配额与现有项目匹配并且存在，则会更新配额。

要求 

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

python >= 3.6
openstacksdk >= 1.0.0

参数 

参数	注释
api_timeout 整数	套接字层在 API 调用超时之前应等待多长时间。如果省略此项，则不会将任何内容传递给 requests 库。
auth 字典	包含云的身份验证插件策略所需的身份验证信息的字典。对于默认的 password 插件，这将包含 auth_url、username、password、project_name 以及有关域的任何信息（例如，如果云支持域，则为 user_domain_name 或 project_domain_name）。对于其他插件，此参数需要包含该身份验证插件所需的任何参数。如果提供了已命名的云或存在 OpenStack OS_* 环境变量，则不需要此参数。
auth_type 字符串	要使用的身份验证插件的名称。如果云使用密码身份验证以外的其他身份验证，则应在此处指示插件的名称，并且应相应地更新 auth 参数的内容。
backup_gigabytes 整数	备份的最大大小（以 GB 为单位）。
backups 整数	允许的最大备份数量。
ca_cert 别名：cacert 字符串	CA 证书捆绑包的路径，可用作验证 SSL API 请求的一部分。
client_cert 别名：cert 字符串	客户端证书的路径，用作 SSL 事务的一部分。
client_key 别名：key 字符串	客户端密钥的路径，用作 SSL 事务的一部分。
cloud 任意	要操作的已命名云或云配置。如果 cloud 是字符串，则它引用 OpenStack clouds.yaml 文件中定义的已命名云配置。为 auth 和 auth_type 提供默认值。如果提供了 auth 或存在 OpenStack OS_* 环境变量，则不需要此参数。如果 cloud 是字典，则它包含完整的云配置，如 clouds.yaml 的一部分。
cores 整数	每个项目的最大 CPU 数量。
fixed_ips 整数	允许的固定 IP 数量。在 Nova API 版本 2.35 之前可用。
floating_ips 别名：compute_floating_ips, floatingip, network_floating_ips 整数	允许的浮动 IP 数量。
gigabytes 整数	允许项目使用的最大卷存储量。
groups 整数	允许项目使用的组数
injected_file_content_bytes 别名：injected_file_size 整数	最大文件大小（以字节为单位）。在 Nova API 版本 2.56 之前可用。
injected_file_path_bytes 别名：injected_path_size 整数	最大路径大小。在 Nova API 版本 2.56 之前可用。
injected_files 整数	允许的注入文件数量。在 Nova API 版本 2.56 之前可用。
instances 整数	允许的最大实例数量。
interface 别名：endpoint_type 字符串	要从服务目录中获取的端点 URL 类型。选择 `"admin"` `"internal"` `"public"` ← (默认)
key_pairs 整数	允许的密钥对数量。
load_balancers 别名：loadbalancer 整数	可以创建的最大负载均衡器数量
metadata_items 整数	每个实例允许的元数据项数量。
name 字符串 / 必需	要管理的 OpenStack 项目的名称。
networks 别名：network 整数	允许的网络数量。
per_volume_gigabytes 整数	单个卷的最大大小（以 GB 为单位）。
pools 别名：pool 整数	可以创建的最大池数量
ports 别名：port 整数	允许的网络端口数量，此数量需要大于实例限制。
ram 整数	允许的最大内存量（以 MB 为单位）。
rbac_policies 别名：rbac_policy 整数	允许的策略数量。
region_name 字符串	区域的名称。
routers 别名：router 整数	允许的路由器数量。
sdk_log_level 字符串	OpenStackSDK 的日志级别选择 `"INFO"` ← (默认) `"DEBUG"`
sdk_log_path 字符串	OpenStackSDK 日志文件的路径。如果为空，则不写入任何日志
security_group_rules 别名：security_group_rule 整数	每个安全组允许的规则数量。
security_groups 别名：security_group 整数	允许的安全组数量。
server_group_members 整数	允许的服务器组成员数量。
server_groups 整数	允许的服务器组数量。
snapshots 整数	允许的快照数量。
state 字符串	`present` 值设置配额，`absent` 值将配额重置为默认值。选择 `"absent"` `"present"` ← (默认)
subnet_pools 别名：subnetpool 整数	允许的子网池数量。
subnets 别名: subnet 整数	允许的子网数量。
timeout 整数	Ansible 应该等待请求的资源多长时间。默认值: `180`
validate_certs 别名: verify 布尔值	是否应该验证 SSL API 请求。在 Ansible 2.3 之前，此项默认值为 `true`。选择 `false` `true`
volumes 整数	允许的卷数量。
wait 布尔值	Ansible 是否应该等待直到请求的资源完成。选择 `false` `true` ← (默认)

备注 

注意

可以使用标准的 OpenStack 环境变量，例如 OS_USERNAME，而不是提供显式值。
身份验证信息由 openstacksdk 驱动，这意味着值可以来自 /etc/ansible/openstack.yaml、/etc/openstack/clouds.yaml 或 ~/.config/openstack/clouds.yaml 中的 yaml 配置文件，然后来自标准环境变量，最后来自剧本中的显式参数。更多信息可以在 https://docs.openstack.org/openstacksdk/ 找到

示例 

- name: Fetch current project quota
  openstack.cloud.quota:
    cloud: mycloud
    name: demoproject

- name: Reset project quota back to defaults
  openstack.cloud.quota:
    cloud: mycloud
    name: demoproject
    state: absent

- name: Change number of cores and volumes
  openstack.cloud.quota:
    cloud: mycloud
    name: demoproject
    cores: 100
    volumes: 20

- name: Update quota again
  openstack.cloud.quota:
    cloud: mycloud
    name: demo_project
    floating_ips: 5
    networks: 50
    ports: 300
    rbac_policies: 5
    routers: 5
    subnets: 5
    subnet_pools: 5
    security_group_rules: 5
    security_groups: 5
    backup_gigabytes: 500
    backups: 5
    gigabytes: 500
    groups: 1
    pools: 5
    per_volume_gigabytes: 10
    snapshots: 5
    volumes: 5
    cores: 5
    instances: 5
    key_pairs: 5
    metadata_items: 5
    ram: 5
    server_groups: 5
    server_group_members: 5

返回值 

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

键	描述
quotas 字典	描述项目配额的字典。返回: 无论是否进行了更改示例: {"quotas": {"compute": {"cores": "150,", "fixed_ips": "-1,", "floating_ips": "10,", "injected_file_content_bytes": "10240,", "injected_file_path_bytes": "255,", "injected_files": "5,", "instances": "100,", "key_pairs": "100,", "metadata_items": "128,", "networks": "-1,", "ram": "153600,", "security_group_rules": "-1,", "security_groups": "-1,", "server_group_members": "10,", "server_groups": "10,"}, "network": {"floating_ips": "50,", "load_balancers": "10,", "networks": "10,", "pools": "10,", "ports": "160,", "rbac_policies": "10,", "routers": "10,", "security_group_rules": "100,", "security_groups": "10,", "subnet_pools": "-1,", "subnets": "10,"}, "volume": {"backup_gigabytes": "1000,", "backups": "10,", "gigabytes": "1000,", "groups": "10,", "per_volume_gigabytes": "-1,", "snapshots": "10,", "volumes": "10,"}}}
compute 字典	计算服务配额返回: 成功
cores 整数	每个项目的最大 CPU 数量。返回: 成功
injected_file_content_bytes 整数	最大文件大小（以字节为单位）。返回: 成功
injected_file_path_bytes 整数	最大路径大小。返回: 成功
injected_files 整数	允许的注入文件数量。返回: 成功
instances 整数	允许的最大实例数量。返回: 成功
key_pairs 整数	允许的密钥对数量。返回: 成功
metadata_items 整数	每个实例允许的元数据项数量。返回: 成功
ram 整数	允许的最大内存量（以 MB 为单位）。返回: 成功
server_group_members 整数	允许的服务器组成员数量。返回: 成功
server_groups 整数	允许的服务器组数量。返回: 成功
network 字典	网络服务配额返回: 成功
floating_ips 整数	允许的浮动 IP 数量。返回: 成功
load_balancers 整数	一个人可以创建的最大负载均衡器数量返回: 成功
networks 整数	允许的网络数量。返回: 成功
pools 整数	一个人可以创建的最大池数量。返回: 成功
ports 整数	允许的网络端口数量，此数量需要大于实例限制。返回: 成功
rbac_policies 整数	允许的策略数量。返回: 成功
routers 整数	允许的路由器数量。返回: 成功
security_group_rules 整数	每个安全组允许的规则数量。返回: 成功
security_groups 整数	允许的安全组数量。返回: 成功
subnet_pools 整数	允许的子网池数量。返回: 成功
subnets 整数	允许的子网数量。返回: 成功
volume 字典	块存储服务配额返回: 成功
backup_gigabytes 整数	备份的最大大小（以 GB 为单位）。返回: 成功
backups 整数	允许的最大备份数量。返回: 成功
gigabytes 整数	允许项目使用的最大卷存储量。返回: 成功
groups 整数	允许项目使用的组数返回: 成功
per_volume_gigabytes 整数	单个卷的最大大小（以 GB 为单位）。返回: 成功
snapshots 整数	允许的快照数量。返回: 成功
volumes 整数	允许的卷数量。返回: 成功

作者

OpenStack Ansible SIG