vmware.vmware_rest.appliance_networking_interfaces_ipv4 模块 – 为特定网络接口设置 IPv4 网络配置。

注意

此模块是 vmware.vmware_rest 集合(版本 4.3.0)的一部分。

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

要安装它,请使用:ansible-galaxy collection install vmware.vmware_rest。 您需要进一步的要求才能使用此模块,请参阅 要求 了解详细信息。

要在 playbook 中使用它,请指定:vmware.vmware_rest.appliance_networking_interfaces_ipv4

vmware.vmware_rest 2.0.0 中的新增功能

概要

  • 为特定网络接口设置 IPv4 网络配置。

要求

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

  • vSphere 7.0.3 或更高版本

  • python >= 3.6

  • aiohttp

参数

参数

注释

地址

字符串

IPv4 地址,例如“10.20.80.191”。

此字段是可选的,仅当 *mode* 的值为 STATIC 时才相关。

default_gateway

字符串

默认网关的 IPv4 地址。 这会在 appliance 上配置具有指定网关地址和接口的全局默认网关。 此网关会替换 appliance 上配置的现有默认网关。 但是,如果网关地址是链路本地地址,则会为该接口添加该地址。 这不支持通过不同接口配置多个全局默认网关。

如果未设置,则表示 defaultGateway 从未设置。

interface_name

字符串 / 必需

要更新的网络接口,例如 “nic0”。

该参数必须是 vmware.vmware_rest.appliance_networking_interfaces_info 返回的资源的 ID。此参数是强制性的。

mode

字符串 / 必需

*mode* 枚举类型定义不同的 IPv4 地址分配模式。 此参数是强制性的。

选项

  • "DHCP"

  • "STATIC"

  • "UNCONFIGURED"

prefix

整数

IPv4 CIDR 前缀,例如 24。有关网络掩码到前缀的转换,请参阅 http://www.oav.net/mirrors/cidr.html

此字段是可选的,仅当 *mode* 的值为 STATIC 时才相关。

session_timeout

浮点数

在 vmware.vmware_rest 2.1.0 中添加

客户端会话的超时设置。

整个操作(包括连接建立、请求发送和响应)的最大秒数。

默认值为 300 秒。

state

字符串

选项

  • "set" ← (默认)

vcenter_hostname

字符串 / 必需

vSphere vCenter 的主机名或 IP 地址

如果未在任务中指定该值,则将改用环境变量 VMWARE_HOST 的值。

vcenter_password

字符串 / 必需

vSphere vCenter 密码

如果未在任务中指定该值,则将改用环境变量 VMWARE_PASSWORD 的值。

vcenter_rest_log_file

字符串

您可以使用此可选参数来设置日志文件的位置。

此文件将用于记录 HTTP REST 交互。

该文件将存储在运行该模块的主机上。

如果未在任务中指定该值,则将改用

环境变量 VMWARE_REST_LOG_FILE 的值。

vcenter_username

字符串 / 必需

vSphere vCenter 用户名

如果未在任务中指定该值,则将改用环境变量 VMWARE_USER 的值。

vcenter_validate_certs

布尔值

允许在 SSL 证书无效时进行连接。 当证书不受信任时设置为 false

如果未在任务中指定该值,则将改用环境变量 VMWARE_VALIDATE_CERTS 的值。

选项

  • false

  • true ← (默认)

说明

注意

  • 在 vSphere 7.0.3 上测试

示例

- name: Set the IPv4 network information of nic99 (which does not exist)
  vmware.vmware_rest.appliance_networking_interfaces_ipv4:
    interface_name: nic99
    config:
      address: 10.20.80.191
      prefix: '32'
      mode: STATIC
  failed_when:
  - not(result.failed)
  - result.value.messages[0].default_message msg == "The interface is unknown."
  register: result

返回值

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

描述

failed_when_result

整数

设置 nic99(不存在)的 IPv4 网络信息

返回: 成功时

示例: 0

msg

字符串

设置 nic99(不存在)的 IPv4 网络信息

返回: 成功时

示例: "缺少必需的参数:mode"

作者

  • Ansible 云团队 (@ansible-collections)