openstack.cloud.baremetal_port 模块 – 从 OpenStack 创建/删除裸机端口资源

注意

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

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

要安装它，请使用：ansible-galaxy collection install openstack.cloud。您需要进一步的要求才能使用此模块，有关详细信息，请参阅要求。

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

概要 

从 OpenStack 创建、更新和删除 ironic 端口。

要求 

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

python >= 3.6
openstacksdk >= 1.0.0

参数 

参数	注释
address 字符串	此网络端口的物理硬件地址，通常是硬件 MAC 地址。
api_timeout 整数	套接字层在 API 调用超时之前应等待多长时间。如果省略此项，则不会将任何内容传递到请求库。
auth 字典	包含云的身份验证插件策略所需的身份验证信息的字典。对于默认的 password 插件，这将包含 auth_url、username、password、project_name 以及有关域的任何信息（例如，如果云支持 user_domain_name 或 project_domain_name）。对于其他插件，此参数将需要包含该身份验证插件所需的任何参数。如果提供了命名的云或存在 OpenStack OS_* 环境变量，则不需要此参数。
auth_type 字符串	要使用的身份验证插件的名称。如果云使用密码身份验证以外的其他身份验证，则应在此处指示插件的名称，并且应相应地更新 auth 参数的内容。
ca_cert 别名: cacert 字符串	可用作验证 SSL API 请求一部分的 CA 证书捆绑包的路径。
client_cert 别名: cert 字符串	用作 SSL 事务一部分的客户端证书的路径。
client_key 别名: key 字符串	用作 SSL 事务一部分的客户端密钥的路径。
cloud 任意	要对其进行操作的命名云或云配置。如果 cloud 是字符串，则它引用 OpenStack clouds.yaml 文件中定义的命名云配置。提供 auth 和 auth_type 的默认值。如果提供了 auth 或存在 OpenStack OS_* 环境变量，则不需要此参数。如果 cloud 是字典，则它包含完整的云配置，就像 clouds.yaml 的一部分一样。
extra 字典	一组或多组任意的元数据键值对。
id 别名: uuid 字符串	端口的 ID。如果未指定，将自动生成。
interface 别名: endpoint_type 字符串	要从服务目录中获取的端点 URL 类型。选项 `"admin"` `"internal"` `"public"` ←（默认）
is_pxe_enabled 别名: pxe_enabled 布尔值	是否应在端口上启用或禁用 PXE。选项 `false` `true`
local_link_connection 字典	端口绑定配置文件。
port_id 字符串	节点端口连接到的交换机上物理端口的标识符。
switch_id 字符串	交换机的 MAC 地址或基于 OpenFlow 的 datapath_id。
switch_info 字符串	一个可选的字符串字段，用于存储任何特定于供应商的信息。
node 字符串	此资源所属的节点的 ID 或名称。
physical_network 字符串	端口连接到的物理网络的名称。
port_group 别名: portgroup 字符串	此资源所属的端口组的 ID 或名称。
region_name 字符串	区域的名称。
sdk_log_level 字符串	OpenStackSDK 的日志级别选项 `"INFO"` ←（默认） `"DEBUG"`
sdk_log_path 字符串	OpenStackSDK 的日志文件的路径。如果为空，则不写入日志
state 字符串	指示资源的所需状态选项 `"present"` ←（默认） `"absent"`
timeout 整数	Ansible 应该等待请求的资源多长时间。默认值： `180`
validate_certs 别名: verify 布尔值	是否应验证 SSL API 请求。在 Ansible 2.3 之前，默认为 `true`。选项 `false` `true`
wait 布尔值	Ansible 是否应等待直到请求的资源完成。选项 `false` `true` ←（默认）

说明 

注意

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

示例 

- name: Create Bare Metal port
  openstack.cloud.baremetal_port:
    cloud: devstack
    state: present
    node: bm-0
    address: fa:16:3e:aa:aa:aa
    is_pxe_enabled: True
    local_link_connection:
      switch_id: 0a:1b:2c:3d:4e:5f
      port_id: Ethernet3/1
      switch_info: switch1
    extra:
      something: extra
    physical_network: datacenter
  register: result

- name: Delete Bare Metal port
  openstack.cloud.baremetal_port:
    cloud: devstack
    state: absent
    address: fa:16:3e:aa:aa:aa
  register: result

- name: Update Bare Metal port
  openstack.cloud.baremetal_port:
    cloud: devstack
    state: present
    id: 1a85ebca-22bf-42eb-ad9e-f640789b8098
    is_pxe_enabled: False
    local_link_connection:
      switch_id: a0:b1:c2:d3:e4:f5
      port_id: Ethernet4/12
      switch_info: switch2

返回值 

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

键	描述
port 字典	一个端口字典，可能会返回以下列出的字典键的子集，具体取决于您的云提供商。返回: 成功
address 字符串	此网络端口的物理硬件地址，通常是硬件 MAC 地址。返回: 成功
created_at 字符串	裸机端口创建的时间戳。返回: 成功
extra 字典	一组或多组任意的元数据键值对。返回: 成功
id 字符串	裸机端口资源的 UUID。返回: 成功
internal_info 字典	端口设置和存储的内部元数据。此字段是只读的。返回: 成功
is_pxe_enabled 布尔值	端口是否启用或禁用 PXE。返回: 成功
links 列表 / 元素=字符串	相对链接的列表，包括 self 和 bookmark 链接。返回: 成功
local_link_connection 字典	端口绑定配置文件。如果指定，则必须包含 switch_id（此字段仅接受交换机的 MAC 地址或基于 OpenFlow 的 datapath_id）和 port_id（节点端口连接到的交换机上的物理端口标识符）字段。 switch_info 是一个可选的字符串字段，用于存储任何供应商特定的信息。返回: 成功
location 字典	此资源的云位置（云、项目、区域、区域）返回: 成功
name 字符串	裸机端口名称。返回: 成功
node_id 字符串	此资源所属的裸机节点的 UUID。返回: 成功
physical_network 字符串	端口连接到的物理网络的名称。返回: 成功
port_group_id 字符串	此资源所属的端口组的 UUID。返回: 成功
updated_at 字符串	裸机端口更新的时间戳。返回: 成功

作者

OpenStack Ansible SIG