vmware.vmware_rest.appliance_networking_proxy 模块 – 配置哪个代理服务器用于指定的协议

注意

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

vmware.vmware_rest 2.0.0 中的新增功能

概要 

配置哪个代理服务器用于指定的协议。此操作设置用于代理的环境变量。为了使此配置生效，需要注销/重新启动服务。

要求 

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

vSphere 7.0.3 或更高版本
python >= 3.6
aiohttp

参数 

参数	注释
config 字典	特定协议的代理配置。需要与 state=[‘test’] 一起使用。有效属性为 `server` (str): 代理服务器的 URL ([‘test’]) 此键与 [‘test’] 一起使用时是必需的。 `port` (int): 连接到代理服务器的端口。在 “get” 调用中，指示连接到代理服务器的端口。在 “set” 调用中，指定连接到代理服务器的端口。值为 -1 表示默认端口。([‘test’]) 此键与 [‘test’] 一起使用时是必需的。 `username` (str): 代理服务器的用户名。只有在代理需要用户名时才设置。([‘test’]) `password` (str): 代理服务器的密码。只有在代理需要密码时才设置。([‘test’]) `enabled` (bool): 在 #get 和 #list 操作的结果中，此字段指示是否为特定协议启用了代理。在 test 和 set 操作的输入中，此字段指定是否应为特定协议启用代理。([‘test’]) 此键与 [‘test’] 一起使用时是必需的。
enabled 布尔值	在 #get 和 #list 操作的结果中，此字段指示是否为特定协议启用了代理。在 test 和 set 操作的输入中，此字段指定是否应为特定协议启用代理。需要与 state=[‘set’] 一起使用。选项 `false` `true`
host 字符串	主机名、IPv4 或 IPv6 地址。需要与 state=[‘test’] 一起使用。
password 字符串	代理服务器密码。只有在代理需要密码时才设置。
port 整数	连接到代理服务器的端口。在 “get” 调用中，指示连接到代理服务器的端口。在 “set” 调用中，指定连接到代理服务器的端口。值为 -1 表示默认端口。需要与 state=[‘set’] 一起使用。
protocol 字符串 / 必需	应为其设置代理的协议。此参数是必需的。
server 字符串	代理服务器的 URL 需要与 state=[‘set’] 一起使用。
session_timeout 浮点数在 vmware.vmware_rest 2.1.0 中添加	客户端会话的超时设置。整个操作（包括连接建立、请求发送和响应）的最大秒数。默认值为 300 秒。
state 字符串	选项 `"absent"` `"set"` ← (默认) `"test"`
username 字符串	代理服务器的用户名。只有在代理需要用户名时才设置。
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: Set the HTTP proxy configuration
  vmware.vmware_rest.appliance_networking_proxy:
    enabled: true
    server: http://datastore.test
    port: 3128
    protocol: http
  register: result

- name: Delete the HTTP proxy configuration
  vmware.vmware_rest.appliance_networking_proxy:
    protocol: http
    state: absent
  register: result

返回值 

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

键	描述
值字典	删除HTTP代理配置返回：成功时示例： `{}`

作者

Ansible云团队 (@ansible-collections)