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

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

概要

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

  • 该模块假定在 vSphere 标准交换机 (vSS) 的情况下,主机已配置了端口组。

  • 该模块假定在 vSphere 分布式交换机 (vDS) 的情况下,主机已配置了分布式端口组。

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

参数

参数

注释

device

string

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

仅当 network.type=dhcp 时才需要此参数。

dvswitch_name

别名:dvswitch

string

要将 VMKernel 接口添加到其中的 vSphere 分布式交换机 (vDS) 的名称。

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

从 2.8 版本及更高版本开始为可选参数。

enable_backup_nfc

boolean

在 community.vmware 4.2.0 中添加

在 VMKernel 适配器上启用 vSphere 备份 NFC 流量。

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

选项

  • false ← (默认)

  • true

enable_ft

boolean

在 VMKernel 适配器上启用容错流量。

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

选项

  • false ← (默认)

  • true

enable_mgmt

boolean

在 VMKernel 适配器上启用管理流量。

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

选项

  • false ← (默认)

  • true

enable_provisioning

boolean

在 VMKernel 适配器上启用置备流量。

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

选项

  • false ← (默认)

  • true

enable_replication

boolean

在 VMKernel 适配器上启用 vSphere Replication 流量。

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

选项

  • false ← (默认)

  • true

enable_replication_nfc

boolean

在 VMKernel 适配器上启用 vSphere Replication NFC 流量。

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

选项

  • false ← (默认)

  • true

enable_vmotion

boolean

在 VMKernel 适配器上启用 vMotion 流量。

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

如果已配置 vMotion TCP/IP 堆栈的适配器,则无法在其他适配器上启用 vMotion。

选项

  • false ← (默认)

  • true

enable_vsan

boolean

在 VMKernel 适配器上启用 VSAN 流量。

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

选项

  • false ← (默认)

  • true

esxi_hostname

string / required

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

hostname

string

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

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

mtu

integer

VMKernel 接口的 MTU。

从 2.5 版本及更高版本开始,默认值 1500 有效。

默认值: 1500

network

dictionary

网络详细信息的字典。

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

default_gateway

string

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

ip_address

string

静态 IP 地址。

如果 network.type=static,则为必需项。

subnet_mask

string

必需的静态子网掩码。

如果 network.type=static,则为必需项。

tcpip_stack

string

VMKernel 接口的 TCP/IP 堆栈。

选项

  • "default" ← (默认)

  • "provisioning"

  • "vmotion"

  • "vxlan"

type

string

IP 分配的类型。

选项

  • "static" ← (默认)

  • "dhcp"

password

别名:pass,pwd

string

vSphere vCenter 或 ESXi 服务器的密码。

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

端口

integer

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

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

默认值: 443

portgroup_name

别名: portgroup

string / required

VMKernel 接口的端口组名称。

proxy_host

string

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

格式为主机名或 IP。

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

proxy_port

integer

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

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

state

string

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

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

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

选项

  • "present" ← (默认)

  • "absent"

username

别名: admin, user

string

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

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

validate_certs

boolean

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

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

选项

  • false

  • true ← (默认)

vswitch_name

别名: vswitch

string

要在其中添加 VMKernel 接口的 vSwitch 的名称。

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

从 2.5 版本开始的可选参数。

备注

注意

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

  • 您只能在指定了 device 的情况下,一步从 DHCP 更改为静态,以及从 vSS 更改为 vDS,反之亦然,而无需创建新设备。

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

  • 所有模块都需要 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

返回值

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

描述

结果

dictionary

关于 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)