community.general.hwc_vpc_eip 模块 – 在华为云中创建 Vpc/EIP 资源

注意

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

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

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

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

community.general 0.2.0 中的新增功能

概要 

弹性 IP 管理。

要求 

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

keystoneauth1 >= 3.6.0

参数 

参数	注释
dedicated_bandwidth 字典	指定专用带宽对象。
charge_mode 字符串 / 必需	指定带宽是按流量计费还是按带宽大小计费。值可以是 bandwidth 或 traffic。如果此参数为空或为空字符，则使用默认值 bandwidth。对于 IPv6 地址，在中国境外，默认参数值为 bandwidth；在中国境内，默认参数值为 traffic。
name 字符串 / 必需	指定带宽名称。该值为包含字母、数字、下划线 (`_`)、连字符 (`-`) 和句点 (`.`) 的 1 到 64 个字符的字符串。
size 整数 / 必需	指定带宽大小。默认情况下，该值的范围为 1 Mbit/s 到 2000 Mbit/s。（具体范围可能因各个区域的配置而异。您可以在管理控制台上查看各个区域的带宽范围。）带宽调整的最小单位因带宽范围而异。详情如下。如果允许的带宽大小范围为 0 到 300 Mbit/s（包含 300 Mbit/s），则最小单位为 1 Mbit/s。如果允许的带宽大小范围为 300 Mbit/s 到 1000 Mbit/s（包含 1000 Mbit/s），则最小单位为 50 Mbit/s。如果允许的带宽大小大于 1000 Mbit/s，则最小单位为 500 Mbit/s。
domain 字符串 / 必需	要限定范围的域的名称 (Identity v3)。目前仅支持域名，不支持域 ID。
enterprise_project_id 字符串	指定企业项目 ID。
id 字符串	要管理的资源的 ID。
identity_endpoint 字符串 / 必需	身份验证 URL。
ip_version 整数	值可以是 4（IPv4 地址）或 6（IPv6 地址）。如果此参数为空，则将分配 IPv4 地址。
ipv4_address 字符串	指定获得的 IPv4 EIP。如果您没有指定它，系统会自动分配一个 EIP。
password 字符串 / 必需	登录密码。
port_id 字符串	指定端口 ID。只有当私有 IP 地址与 EIP 绑定时，才会返回此参数。
project 字符串 / 必需	租户 (Identity v2) 或项目 (Identity v3) 的名称。目前仅支持项目名称，不支持项目 ID。
region 字符串	项目所属的区域。
shared_bandwidth_id 字符串	指定共享带宽的 ID。
state 字符串	给定对象是否应存在于华为云中。选项 `"present"` ← (默认) `"absent"`
timeouts 字典	每个操作的超时时间。默认值： `{}`
create 字符串	创建操作的超时时间。默认值： `"5m"`
update 字符串	更新操作的超时时间。默认值： `"5m"`
type 字符串 / 必需	指定 EIP 类型。
user 字符串 / 必需	登录用户名。目前仅支持用户名，不支持用户 ID。

属性 

属性	支持	描述
check_mode	支持：完全支持	可以在 `check_mode` 中运行，并在不修改目标的情况下返回更改状态预测。
diff_mode	支持：不支持	在差异模式下，将返回有关已更改内容（或可能需要在 `check_mode` 中更改的内容）的详细信息。

备注 

注意

对于身份验证，您可以使用 ANSIBLE_HWC_IDENTITY_ENDPOINT 环境变量设置 identity_endpoint。
对于身份验证，您可以使用 ANSIBLE_HWC_USER 环境变量设置 user。
对于身份验证，您可以使用 ANSIBLE_HWC_PASSWORD 环境变量设置 password。
对于身份验证，您可以使用 ANSIBLE_HWC_DOMAIN 环境变量设置 domain。
对于身份验证，您可以使用ANSIBLE_HWC_PROJECT环境变量设置项目。
对于身份验证，您可以使用ANSIBLE_HWC_REGION环境变量设置区域。
只有在未设置剧本值的情况下，才会使用环境变量值。

示例 

# create an eip and bind it to a port
- name: Create vpc
  hwc_network_vpc:
    cidr: "192.168.100.0/24"
    name: "ansible_network_vpc_test"
  register: vpc
- name: Create subnet
  hwc_vpc_subnet:
    gateway_ip: "192.168.100.32"
    name: "ansible_network_subnet_test"
    dhcp_enable: true
    vpc_id: "{{ vpc.id }}"
    cidr: "192.168.100.0/26"
  register: subnet
- name: Create a port
  hwc_vpc_port:
    subnet_id: "{{ subnet.id }}"
    ip_address: "192.168.100.33"
  register: port
- name: Create an eip and bind it to a port
  community.general.hwc_vpc_eip:
    type: "5_bgp"
    dedicated_bandwidth:
      charge_mode: "traffic"
      name: "ansible_test_dedicated_bandwidth"
      size: 1
    port_id: "{{ port.id }}"

返回值 

常见的返回值已在此处记录，以下是此模块特有的字段：

键	描述
创建时间 (create_time) 字符串	指定分配EIP的时间（UTC时间）。返回：成功
dedicated_bandwidth 字典	指定专用带宽对象。返回：成功
charge_mode 字符串	指定带宽是按流量计费还是按带宽大小计费。值可以是 bandwidth 或 traffic。如果此参数为空或为空字符，则使用默认值 bandwidth。对于 IPv6 地址，在中国境外，默认参数值为 bandwidth；在中国境内，默认参数值为 traffic。返回：成功
id 字符串	指定专线带宽的ID。返回：成功
name 字符串	指定带宽名称。该值为包含字母、数字、下划线 (`_`)、连字符 (`-`) 和句点 (`.`) 的 1 到 64 个字符的字符串。返回：成功
size 整数	指定带宽大小。默认值为1 Mbit/s 到 2000 Mbit/s。（具体范围可能因各区域的配置而异。您可以在管理控制台中查看每个区域的带宽范围。）带宽调整的最小单位取决于带宽范围，详情如下：如果允许的带宽大小范围为 0 到 300 Mbit/s（包含 300 Mbit/s），则最小单位为 1 Mbit/s。如果允许的带宽大小范围为 300 Mbit/s 到 1000 Mbit/s（包含 1000 Mbit/s），则最小单位为 50 Mbit/s。如果允许的带宽大小大于 1000 Mbit/s，则最小单位为 500 Mbit/s。返回：成功
enterprise_project_id 字符串	指定企业项目 ID。返回：成功
ip_version 整数	值可以是 4（IPv4 地址）或 6（IPv6 地址）。如果此参数为空，则将分配 IPv4 地址。返回：成功
ipv4_address 字符串	指定获得的 IPv4 EIP。如果您没有指定它，系统会自动分配一个 EIP。返回：成功
ipv6_address 字符串	指定获取的IPv6 EIP。返回：成功
port_id 字符串	指定端口 ID。只有当私有 IP 地址与 EIP 绑定时，才会返回此参数。返回：成功
private_ip_address 字符串	指定与EIP绑定的私有IP地址。仅当EIP绑定了私有IP地址时才返回此参数。返回：成功
shared_bandwidth_id 字符串	指定共享带宽的 ID。返回：成功
type 字符串	指定 EIP 类型。返回：成功

作者

华为公司 (@huaweicloud)