vmware.vmware_rest.appliance_networking_proxy module – Configures which proxy server to use for the specified protocol

Note

This module is part of the vmware.vmware_rest collection (version 4.4.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install vmware.vmware_rest. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: vmware.vmware_rest.appliance_networking_proxy.

New in vmware.vmware_rest 2.0.0

Synopsis

  • Configures which proxy server to use for the specified protocol. This operation sets environment variables for using proxy. In order for this configuration to take effect a logout / service restart is required.

Requirements

The below requirements are needed on the host that executes this module.

  • vSphere 7.0.3 or greater

  • python >= 3.6

  • aiohttp

Parameters

Parameter

Comments

config

dictionary

Proxy configuration for the specific protocol. Required with state=[‘test’]

Valid attributes are:

  • server (str): URL of the proxy server ([‘test’])

This key is required with [‘test’].

  • 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’].

  • username (str): Username for proxy server.

Only set if proxy requires username. ([‘test’])

  • password (str): Password for proxy server.

Only set if proxy requires password. ([‘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. ([‘test’])

This key is required with [‘test’].

enabled

boolean

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 state=[‘set’]

Choices:

  • false

  • true

host

string

A hostname, IPv4 or Ipv6 address. Required with state=[‘test’]

password

string

Password for proxy server.

Only set if proxy requires password.

port

integer

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 state=[‘set’]

protocol

string / required

The protocol for which proxy should be set. This parameter is mandatory.

server

string

URL of the proxy server Required with state=[‘set’]

session_timeout

float

added in vmware.vmware_rest 2.1.0

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.

state

string

Choices:

  • "absent"

  • "set" ← (default)

  • "test"

username

string

Username for proxy server.

Only set if proxy requires username.

vcenter_hostname

string / required

The hostname or IP address of the vSphere vCenter

If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.

vcenter_password

string / required

The vSphere vCenter password

If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD 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 VMWARE_REST_LOG_FILE will be used instead.

vcenter_username

string / required

The vSphere vCenter username

If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.

vcenter_validate_certs

boolean

Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.

If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.

Choices:

  • false

  • true ← (default)

Notes

Note

  • Tested on vSphere 7.0.3

Examples

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

value

dictionary

Delete the HTTP proxy configuration

Returned: On success

Sample: {}

Authors

  • Ansible Cloud Team (@ansible-collections)