appliance_networking_proxy
Configures which proxy server to use for the specified protocol
Collection: vmware.vmware_rest
Full Name: vmware.vmware_rest.appliance_networking_proxy
Synopsis
Configures which proxy server to use for the specified protocol
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| vcenter_hostname | string | yes | The hostname or IP address of the vSphere vCenter | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_HOST) will be used instead. | ||||
| vcenter_username | string | yes | The vSphere vCenter username | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_USER) will be used instead. | ||||
| vcenter_password | string | yes | The vSphere vCenter password | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_PASSWORD) will be used instead. | ||||
| vcenter_validate_certs | bool | true | Allows connection when SSL certificates are not valid. Set to C(false) when certificates are not trusted. | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_VALIDATE_CERTS) will be used instead. | ||||
| vcenter_rest_log_file | string | You can use this optional parameter to set the location of a log file. | ||
| This file will be used to record the HTTP REST interaction. | ||||
| The file will be stored on the host that runs the module. | ||||
| If the value is not specified in the task, the value of | ||||
| environment variable C(VMWARE_REST_LOG_FILE) will be used instead. | ||||
| session_timeout | float | Timeout settings for client session. | ||
| The maximal number of seconds for the whole operation including connection establishment, request sending and response. | ||||
| The default value is 300s. | ||||
| config | dict | Proxy configuration for the specific protocol. Required with I(state=[’test’]) | ||
| Valid attributes are: |
- C(server) (str): URL of the proxy server ([’test’]) This key is required with [’test’].
- C(port) (int): Port to connect to the proxy server. In a ‘get’ call, indicates the port connected to the proxy server. In a ‘set’ call, specifies the port to connect to the proxy server. A value of -1 indicates the default port. ([’test’]) This key is required with [’test’].
- C(username) (str): Username for proxy server. Only set if proxy requires username. ([’test’])
- C(password) (str): Password for proxy server. Only set if proxy requires password. ([’test’])
- C(enabled) (bool): In the result of the #get and #list operations this field indicates whether proxying is enabled for a particular protocol. In the input to the test and set operations this field specifies whether proxying should be enabled for a particular protocol. ([’test’])
This key is required with [’test’]. |
| enabled | bool | | | In the result of the #get and #list operations this field indicates whether proxying is enabled for a particular protocol. In the input to the test and set operations this field specifies whether proxying should be enabled for a particular protocol. Required with I(state=[‘set’]) |
| host | string | | | A hostname, IPv4 or Ipv6 address. Required with I(state=[’test’]) |
| password | string | | | Password for proxy server.
Only set if proxy requires password. |
| port | int | | | Port to connect to the proxy server. In a ‘get’ call, indicates the port connected to the proxy server. In a ‘set’ call, specifies the port to connect to the proxy server. A value of -1 indicates the default port. Required with I(state=[‘set’]) |
| protocol | string | yes | | The protocol for which proxy should be set. This parameter is mandatory. |
| server | string | | | URL of the proxy server Required with I(state=[‘set’]) |
| state | string | |
set| Operation to perform; allowed values: absent, set, test. | | username | string | | | Username for proxy server. Only set if proxy requires username. |
Example
yaml
- 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