ovirt.ovirt.ovirt_mac_pool 模块 – 用于管理 oVirt/RHV 中 MAC 池的模块

注意

此模块是 ovirt.ovirt 集合 (版本 3.2.0) 的一部分。

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

要安装它,请使用:ansible-galaxy collection install ovirt.ovirt。您需要其他需求才能使用此模块,请参阅 需求 获取详细信息。

要在剧本中使用它,请指定:ovirt.ovirt.ovirt_mac_pool

ovirt.ovirt 1.0.0 中的新增功能

概要

  • 此模块管理 oVirt/RHV 中的 MAC 池。

需求

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

  • python >= 2.7

  • ovirt-engine-sdk-python >= 4.4.0

参数

参数

注释

allow_duplicates

布尔值

如果为 true,则允许在池中多次使用 MAC 地址。

默认值由 oVirt/RHV 引擎设置为 false

选项

  • false

  • true

auth

字典 / 必需

包含创建与 oVirt 的 HTTP/HTTPS 连接所需的值的字典

ca_file

字符串

包含受信任 CA 证书的 PEM 文件。

服务器提供的证书将使用这些 CA 证书进行验证。

如果未设置 ca_file 参数,则使用系统范围的 CA 证书存储。

默认值由 OVIRT_CAFILE 环境变量设置。

compress

布尔值

指示是否使用压缩进行连接的标志。

选项

  • false

  • true ← (默认)

headers

字典

要添加到每个 API 调用的 HTTP 标头的字典。

hostname

字符串

包含服务器主机名的字符串,通常类似于 `_server.example.com_`。

默认值由 OVIRT_HOSTNAME 环境变量设置。

需要 urlhostname 之一。

insecure

布尔值

一个布尔值标志,指示是否应检查服务器 TLS 证书和主机名。

选项

  • false ← (默认)

  • true

kerberos

布尔值

一个布尔值标志,指示是否应使用 Kerberos 身份验证代替默认的基本身份验证。

选项

  • false

  • true

password

字符串

用户的密码。

默认值由 OVIRT_PASSWORD 环境变量设置。

timeout

整数

等待响应的秒数。

token

字符串

要使用的令牌,而不是使用用户名/密码登录。

默认值由 OVIRT_TOKEN 环境变量设置。

url

字符串

包含服务器 API URL 的字符串,通常类似于 `_https://server.example.com/ovirt-engine/api_`。

默认值由 OVIRT_URL 环境变量设置。

需要 urlhostname 之一。

username

字符串

用户名,例如 _admin@internal_。

默认值由 OVIRT_USERNAME 环境变量设置。

description

字符串

MAC 池的描述。

fetch_nested

布尔值

如果为 True,则模块将从 API 获取附加数据。

它将获取虚拟机磁盘、快照等的 ID。用户可以通过指定 nested_attributes 来配置获取嵌套实体的其他属性。

选项

  • false ← (默认)

  • true

id

字符串

要管理的 MAC 池的 ID。

name

字符串 / 必需

要管理的 MAC 池的名称。

nested_attributes

列表 / 元素=字符串

指定应从 API 获取的属性列表。

此参数仅在 fetch_nestedtrue 时适用。

poll_interval

整数

模块在发送对实体状态的另一次轮询请求之前等待的秒数。

默认值: 3

ranges

列表 / 元素=字符串

MAC 范围列表。起始和结束应以逗号分隔。

例如:00:1a:4a:16:01:51,00:1a:4a:16:01:61

state

字符串

MAC 池应该存在还是不存在。

选项

  • "present" ← (默认)

  • "absent"

timeout

整数

模块应等待实例进入所需状态的秒数。

默认值: 180

wait

布尔值

如果模块应等待实体进入所需状态,则为 yes

选项

  • false

  • true ← (默认)

备注

注意

  • 要使用此模块,您必须安装 oVirt Python SDK。为了确保它以正确的版本安装,您可以创建以下任务:_pip: name=ovirt-engine-sdk-python version=4.4.0_

示例

# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:

# Create MAC pool:
- ovirt.ovirt.ovirt_mac_pool:
    name: mymacpool
    allow_duplicates: false
    ranges:
      - 00:1a:4a:16:01:51,00:1a:4a:16:01:61
      - 00:1a:4a:16:02:51,00:1a:4a:16:02:61

# Remove MAC pool:
- ovirt.ovirt.ovirt_mac_pool:
    state: absent
    name: mymacpool

# Change MAC pool Name
- ovirt.ovirt.ovirt_nic:
    id: 00000000-0000-0000-0000-000000000000
    name: "new_mac_pool_name"

返回值

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

描述

id

字符串

正在管理的 MAC 池的 ID

返回:如果找到 MAC 池,则在成功时返回。

示例: "7de90f31-222c-436c-a1ca-7e655bd5b60c"

模板

字典

所有 MAC 池属性的字典。可以在您的 oVirt/RHV 实例上的以下网址找到 MAC 池属性:http://ovirt.github.io/ovirt-engine-api-model/master/#types/mac_pool

返回:如果找到 MAC 池,则在成功时返回。

作者

  • Ondra Machacek (@machacekondra)

  • Martin Necas (@mnecas)