vmware.vmware_rest.appliance_access_ssh 模块 – 设置基于 SSH 的控制 CLI 的启用状态。

注意

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

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

要安装它，请使用： ansible-galaxy collection install vmware.vmware_rest。您需要其他需求才能使用此模块，有关详细信息，请参阅 需求。

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

vmware.vmware_rest 2.0.0 中的新增功能

概要

  • 设置基于 SSH 的控制 CLI 的启用状态。

需求

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

  • vSphere 7.0.3 或更高版本

  • python >= 3.6

  • aiohttp

参数

参数

注释

enabled

布尔值 / 必需

启用基于 SSH 的控制 CLI。此参数是必需的。

选项

  • false

  • true

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 上测试

另请参阅

另请参阅

vmware.vmware.vcsa_settings

配置 vCenter Server Appliance 设置。

示例

- name: Ensure the SSH access ie enabled
  vmware.vmware_rest.appliance_access_ssh:
    enabled: true
  register: result

返回值

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

键

描述

值

整数

确保 SSH 访问已启用

返回：成功时

示例： 1

作者

  • Ansible 云团队 (@ansible-collections)