vmware.vmware_rest.appliance_access_ssh_info 模块 – 获取基于 SSH 的受控 CLI 的启用状态。

注意

此模块是 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_access_ssh_info

vmware.vmware_rest 2.0.0 中的新增功能

概要

  • 获取基于 SSH 的受控 CLI 的启用状态。

要求

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

  • vSphere 7.0.3 或更高版本

  • python >= 3.6

  • aiohttp

参数

参数

注释

session_timeout

浮点数

在 vmware.vmware_rest 2.1.0 中添加

客户端会话的超时设置。

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

默认值为 300 秒。

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: Check is the SSH access is enabled
  vmware.vmware_rest.appliance_access_ssh_info:
  register: result

返回值

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

描述

整数

检查 SSH 访问是否已启用

返回:成功时

示例: 1

作者

  • Ansible 云团队 (@ansible-collections)