community.vmware.vmware_guest_serial_port 模块 – 管理现有虚拟机上的串行端口

注意

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

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

要安装它，请使用：ansible-galaxy collection install community.vmware。

要在剧本中使用它，请指定：community.vmware.vmware_guest_serial_port。

概要

• 此模块可用于管理现有虚拟机上的串行端口

参数

参数	注释
backings 列表 / 元素=字典 / 必需	串行端口的后备列表。 需要 backings[].backing_type 来添加或重新配置或删除现有串行端口。
backing_type 别名：type 字符串 / 必需	添加或重新配置或删除串行端口需要后备类型。
device_name 字符串	串行设备的绝对路径。 当 backings[].backing_type=device 时为必需。
direction 字符串	连接的方向。 当 backings[].backing_type=network 时为必需。 选择 "client" ← (默认) "server"
endpoint 字符串	当您使用串行端口管道后备将虚拟机连接到另一个进程时，必须定义端点。 当 backings[].backing_type=pipe 时为必需。 选择 "client" ← (默认) "server"
file_path 字符串	此后备中使用的宿主机文件的文件路径。需要完全限定的路径，如 <datastore_name>/<file_name>。 当 backings[].backing_type=file 时为必需。
no_rx_loss 布尔值	启用通过管道的优化数据传输。 当 backings[].backing_type=pipe 时为必需。 选择 false ← (默认) true
pipe_name 字符串	主机管道的管道名称。 当 backings[].backing_type=pipe 时为必需。
proxy_uri 字符串 在 community.vmware 3.7.0 中添加	标识提供对 backings[].service_uri 的网络访问的 vSPC 代理服务。 如果您指定代理 URI，则虚拟机将启动与代理服务的连接，并将 serviceURI 和方向转发到代理。 当设置 backings[].proxy_uri 时，将自动启用 Use Virtual Serial Port Concentrator 选项。
service_uri 字符串	根据 backings[].direction 的值，标识本地主机或网络上的系统。 如果您将虚拟机用作服务器，则 URI 将标识虚拟机在其上运行的主机。 在这种情况下，URI 的主机名部分应为空，或应指定本地主机的地址。 如果将虚拟机用作客户端，则 URI 将标识网络上的远程系统。 当 backings[].backing_type=pipe 时为必需。
状态 字符串	backings[].state 是必需的，用于标识我们要添加、修改还是删除串行端口。 如果为 present，则将添加或修改串行端口。 如果为 absent，则将删除现有串行端口。 如果要修改或删除现有串行端口，则需要 backings[].backing_type 以及 backings[].service_uri、backings[].pipe_name、backings[].device_name 或 backings[].file_path 中的任意一个。 选择 "present" ← (默认) "absent"
yield_on_poll 布尔值	启用 CPU 让步行为。 选择 false true ← (默认)
hostname 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。 如果在任务中未指定该值，则将使用环境变量 VMWARE_HOST 的值。
moid 字符串	如果要管理的实例的托管对象 ID（如果已知），这是仅在单个 vCenter 实例中唯一的标识符。 如果未提供 name 或 uuid，则此为必需项。
name 字符串	虚拟机的名称。 如果未提供参数 uuid 或 moid，则此为必需参数。
password 别名：pass, pwd 字符串	vSphere vCenter 或 ESXi 服务器的密码。 如果在任务中未指定该值，则将使用环境变量 VMWARE_PASSWORD 的值。
port 整数	vSphere vCenter 或 ESXi 服务器的端口号。 如果在任务中未指定该值，则将使用环境变量 VMWARE_PORT 的值。 默认值： 443
proxy_host 字符串	将接收所有 HTTPS 请求并转发它们的代理的地址。 格式为主机名或 IP。 如果在任务中未指定该值，则将使用环境变量 VMWARE_PROXY_HOST 的值。
proxy_port 整数	将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。 如果在任务中未指定该值，则将使用环境变量 VMWARE_PROXY_PORT 的值。
use_instance_uuid 布尔值	是否使用 VMware 实例 UUID 而不是 BIOS UUID。 选择 false ← (默认) true
username 别名：admin, user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。 如果在任务中未指定该值，则将使用环境变量 VMWARE_USER 的值。
uuid 字符串	用于管理串行端口的实例的 UUID，这是 VMware 的唯一标识符。 如果未提供参数 name 或 moid，则此为必需参数。
validate_certs 布尔值	在 SSL 证书无效时允许连接。当证书不受信任时，设置为 false。 如果在任务中未指定该值，则将使用环境变量 VMWARE_VALIDATE_CERTS 的值。 选择 false true ← (默认)

注释

注意

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

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

示例

# Create serial ports
- name: Create multiple serial ports with Backing type - network, pipe, device and file
  community.vmware.vmware_guest_serial_port:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    name: "test_vm1"
    backings:
    - type: 'network'
      direction: 'client'
      service_uri: 'tcp://6000'
      yield_on_poll: true
    - type: 'pipe'
      pipe_name: 'serial_pipe'
      endpoint: 'client'
    - type: 'device'
      device_name: '/dev/char/serial/uart0'
    - type: 'file'
      file_path: '[datastore1]/file1'
      yield_on_poll:  true
    register: create_multiple_ports

# Create vSPC port
- name: Create network serial port with vSPC
  community.vmware.vmware_guest_serial_port:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    name: "test_vm1"
    backings:
    - type: 'network'
      direction: 'server'
      service_uri: 'vSPC.py'
      proxy_uri: 'telnets://<host>:<port>'
      yield_on_poll: true

# Modify existing serial port
- name: Modify Network backing type
  community.vmware.vmware_guest_serial_port:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    name: '{{ name }}'
    backings:
    - type: 'network'
      state: 'present'
      direction: 'server'
      service_uri: 'tcp://6000'
  delegate_to: localhost

# Remove serial port
- name: Remove pipe backing type
  community.vmware.vmware_guest_serial_port:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    name: '{{ name }}'
    backings:
    - type: 'pipe'
      state: 'absent'
  delegate_to: localhost

返回值

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

键	描述
serial_port_data 字典	管理虚拟机串行端口后的元数据 返回： 始终 示例： [{"backing_type": "network", "direction": "client", "service_uri": "tcp://6000"}, {"backing_type": "pipe", "direction": "server", "pipe_name": "serial pipe"}]

作者

• Anusha Hegde (@anusha94)

集合链接

• 问题跟踪器
• 主页
• 存储库（来源）