community.vmware.vmware_vmkernel 模块 – 管理 ESXi 主机的 VMware VMkernel 适配器。

注意

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

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

要安装它,请使用: ansible-galaxy collection install community.vmware

要在剧本中使用它,请指定: community.vmware.vmware_vmkernel

概要

  • 此模块可用于管理 ESXi 主机的 VMkernel 适配器/VMkernel 网络接口。

  • 对于 vSphere 标准交换机 (vSS),该模块假定主机已配置端口组。

  • 对于 vSphere 分布式交换机 (vDS),该模块假定主机已配置分布式端口组。

  • 如果存在,该模块会自动将 VMkernel 适配器从 vSS 迁移到 vDS,反之亦然。

参数

参数

注释

device

字符串

按设备名称搜索 VMkernel 适配器。

仅在 network.type=dhcp 的情况下才需要此参数。

dvswitch_name

别名:dvswitch

字符串

要添加 VMkernel 接口的 vSphere 分布式交换机 (vDS) 的名称。

仅当 state=present 时才需要此参数。

从 2.8 版开始,此参数为可选参数。

enable_backup_nfc

布尔值

在 community.vmware 4.2.0 中添加

在 VMkernel 适配器上启用 vSphere Backup NFC 通信。

仅当使用默认 TCP/IP 堆栈时才允许此选项。

选项

  • false ← (默认值)

  • true

enable_ft

布尔值

在 VMkernel 适配器上启用容错通信。

仅当使用默认 TCP/IP 堆栈时才允许此选项。

选项

  • false ← (默认值)

  • true

enable_mgmt

布尔值

在 VMkernel 适配器上启用管理通信。

仅当使用默认 TCP/IP 堆栈时才允许此选项。

选项

  • false ← (默认值)

  • true

enable_provisioning

布尔值

在 VMkernel 适配器上启用预配通信。

仅当使用默认 TCP/IP 堆栈时才允许此选项。

选项

  • false ← (默认值)

  • true

enable_replication

布尔值

在 VMkernel 适配器上启用 vSphere Replication 通信。

仅当使用默认 TCP/IP 堆栈时才允许此选项。

选项

  • false ← (默认值)

  • true

enable_replication_nfc

布尔值

在 VMkernel 适配器上启用 vSphere Replication NFC 通信。

仅当使用默认 TCP/IP 堆栈时才允许此选项。

选项

  • false ← (默认值)

  • true

enable_vmotion

布尔值

在 VMkernel 适配器上启用 vMotion 通信。

仅当使用默认 TCP/IP 堆栈时才允许此选项。

如果您已配置具有 vMotion TCP/IP 堆栈的适配器,则不能在附加适配器上启用 vMotion。

选项

  • false ← (默认值)

  • true

enable_vsan

布尔值

在 VMkernel 适配器上启用 VSAN 通信。

仅当使用默认 TCP/IP 堆栈时才允许此选项。

选项

  • false ← (默认值)

  • true

esxi_hostname

字符串 / 必需

要管理 VMkernel 的 ESXi 主机的名称。

hostname

字符串

vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。

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

mtu

整数

VMkernel 接口的 MTU。

从 2.5 版开始,默认值 1500 有效。

默认值: 1500

network

字典

网络详细信息的字典。

默认值: {"tcpip_stack": "default", "type": "static"}

default_gateway

字符串

默认网关(覆盖此适配器的默认网关)。

ip_address

字符串

静态 IP 地址。

如果 network.type=static,则需要此参数。

subnet_mask

字符串

必需的静态子网掩码。

如果 network.type=static,则需要此参数。

tcpip_stack

字符串

VMkernel 接口的 TCP/IP 堆栈。

选项

  • "default" ← (默认值)

  • "provisioning"

  • "vmotion"

  • "vxlan"

type

字符串

IP 分配类型。

选项

  • "static" ← (默认值)

  • "dhcp"

password

别名:pass,pwd

字符串

vSphere vCenter 或 ESXi 服务器的密码。

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

port

整数

vSphere vCenter 或 ESXi 服务器的端口号。

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

默认值: 443

portgroup_name

别名:portgroup

字符串 / 必需

VMKernel 接口的端口组名称。

proxy_host

字符串

接收所有 HTTPS 请求并转发它们的代理服务器地址。

格式为主机名或 IP 地址。

如果任务中未指定此值,则将使用环境变量 VMWARE_PROXY_HOST 的值。

proxy_port

整数

接收所有 HTTPS 请求并转发它们的 HTTP 代理服务器端口。

如果任务中未指定此值,则将使用环境变量 VMWARE_PROXY_PORT 的值。

state

字符串

如果设置为 present,则将使用给定的规范创建 VMKernel 适配器。

如果设置为 absent,则将删除 VMKernel 适配器。

如果设置为 present 且 VMKernel 适配器已存在,则将更新配置。

选项

  • "present" ← (默认)

  • "absent"

username

别名:admin, user

字符串

vSphere vCenter 或 ESXi 服务器的用户名。

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

validate_certs

布尔值

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

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

选项

  • false

  • true ← (默认)

vswitch_name

别名:vswitch

字符串

添加 VMKernel 接口的 vSwitch 名称。

仅当 state=present 时才需要此参数。

2.5 及更高版本中的可选参数。

注释

注意

  • 选项 device 需要与 DHCP 一起使用,否则无法检查 VMkernel 设备是否存在。

  • 您只能一步一步地将 DHCP 更改为静态,将 vSS 更改为 vDS,反之亦然,而无需创建新的设备,前提是已指定 device

  • 只有在已通过身份验证连接到 vCenter,而不是已通过身份验证连接到 ESXi 时,才能在 vDS 上创建 VMKernel 适配器。

  • 所有模块都需要 API 写入访问权限,因此在免费 ESXi 许可证上不支持。

  • 所有变量和 VMware 对象名称都区分大小写。

示例

-  name: Add Management vmkernel port using static network type
   community.vmware.vmware_vmkernel:
      hostname: '{{ esxi_hostname }}'
      username: '{{ esxi_username }}'
      password: '{{ esxi_password }}'
      esxi_hostname: '{{ esxi_hostname }}'
      vswitch_name: vSwitch0
      portgroup_name: PG_0001
      network:
        type: 'static'
        ip_address: 192.168.127.10
        subnet_mask: 255.255.255.0
      state: present
      enable_mgmt: true
   delegate_to: localhost

-  name: Add Management vmkernel port using DHCP network type
   community.vmware.vmware_vmkernel:
      hostname: '{{ esxi_hostname }}'
      username: '{{ esxi_username }}'
      password: '{{ esxi_password }}'
      esxi_hostname: '{{ esxi_hostname }}'
      vswitch_name: vSwitch0
      portgroup_name: PG_0002
      state: present
      network:
        type: 'dhcp'
      enable_mgmt: true
   delegate_to: localhost

-  name: Change IP allocation from static to dhcp
   community.vmware.vmware_vmkernel:
      hostname: '{{ esxi_hostname }}'
      username: '{{ esxi_username }}'
      password: '{{ esxi_password }}'
      esxi_hostname: '{{ esxi_hostname }}'
      vswitch_name: vSwitch0
      portgroup_name: PG_0002
      state: present
      device: vmk1
      network:
        type: 'dhcp'
      enable_mgmt: true
   delegate_to: localhost

-  name: Delete VMkernel port
   community.vmware.vmware_vmkernel:
      hostname: '{{ esxi_hostname }}'
      username: '{{ esxi_username }}'
      password: '{{ esxi_password }}'
      esxi_hostname: '{{ esxi_hostname }}'
      vswitch_name: vSwitch0
      portgroup_name: PG_0002
      state: absent
   delegate_to: localhost

-  name: Add Management vmkernel port to Distributed Switch
   community.vmware.vmware_vmkernel:
      hostname: '{{ vcenter_hostname }}'
      username: '{{ vcenter_username }}'
      password: '{{ vcenter_password }}'
      esxi_hostname: '{{ esxi_hostname }}'
      dvswitch_name: dvSwitch1
      portgroup_name: dvPG_0001
      network:
        type: 'static'
        ip_address: 192.168.127.10
        subnet_mask: 255.255.255.0
      state: present
      enable_mgmt: true
   delegate_to: localhost

-  name: Add vMotion vmkernel port with vMotion TCP/IP stack
   community.vmware.vmware_vmkernel:
      hostname: '{{ vcenter_hostname }}'
      username: '{{ vcenter_username }}'
      password: '{{ vcenter_password }}'
      esxi_hostname: '{{ esxi_hostname }}'
      dvswitch_name: dvSwitch1
      portgroup_name: dvPG_0001
      network:
        type: 'static'
        ip_address: 192.168.127.10
        subnet_mask: 255.255.255.0
        tcpip_stack: vmotion
      state: present
   delegate_to: localhost

返回值

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

描述

result

字典

关于 VMKernel 名称的元数据

返回:始终返回

示例: {"changed": false, "device": "vmk1", "ipv4": "static", "ipv4_gw": "No override", "ipv4_ip": "192.168.1.15", "ipv4_sm": "255.255.255.0", "msg": "VMkernel Adapter already configured properly", "mtu": 9000, "services": "vMotion", "switch": "vDS"}

作者

  • Joseph Callen (@jcpowermac)

  • Russell Teague (@mtnbikenc)

  • Abhijeet Kasurde (@Akasurde)

  • Christian Kotte (@ckotte)

  • Nina Loser (@Nina2244)