New in version 2.8.
Parameter | Choices/Defaults | Comments |
---|---|---|
auto_config_url
string
|
The URL of a proxy configuration script.
Proxy configuration scripts are typically JavaScript files with the
.pac extension that implement the C(FindProxyForURurl function.Omit, set to null or an empty string to remove the auto config URL.
This corresponds to the checkbox Use automatic configuration script in the connection settings window.
|
|
auto_detect
boolean
|
|
Whether to configure WinINet to automatically detect proxy settings through Web Proxy Auto-Detection
WPAD .This corresponds to the checkbox Automatically detect settings in the connection settings window.
|
bypass
list
|
A list of hosts that will bypass the set proxy when being accessed.
Use
<local> to match hostnames that are not fully qualified domain names. This is useful when needing to connect to intranet sites using just the hostname. If defined, this should be the last entry in the bypass list.Use
<-loopback> to stop automatically bypassing the proxy when connecting through any loopback address like 127.0.0.1 , localhost , or the local hostname.Omit, set to null or an empty string/list to remove the bypass list.
If this is set then proxy must also be set.
|
|
connection
string
|
The name of the IE connection to set the proxy settings for.
These are the connections under the Dial-up and Virtual Private Network header in the IE settings.
When ommited, the default LAN connection is used.
|
|
proxy
-
|
A string or dict that specifies the proxy to be set.
If setting a string, should be in the form
hostname , hostname:port , or protocol=hostname:port .If the port is undefined, the default port for the protocol in use is used.
If setting a dict, the keys should be the protocol and the values should be the hostname and/or port for that protocol.
Valid protocols are
http , https , ftp , and socks .Omit, set to null or an empty string to remove the proxy settings.
|
Note
netsh
command. Use the win_http_proxy module to manage that instead.See also
# This should be set before running the win_inet_proxy module
- name: Configure IE proxy settings to apply to all users
win_regedit:
path: HKLM:\SOFTWARE\Policies\Microsoft\Windows\CurrentVersion\Internet Settings
name: ProxySettingsPerUser
data: 0
type: dword
state: present
# This should be set before running the win_inet_proxy module
- name: Configure IE proxy settings to apply per user
win_regedit:
path: HKLM:\SOFTWARE\Policies\Microsoft\Windows\CurrentVersion\Internet Settings
name: ProxySettingsPerUser
data: 1
type: dword
state: present
- name: Configure IE proxy to use auto detected settings without an explicit proxy
win_inet_proxy:
auto_detect: yes
- name: Configure IE proxy to use auto detected settings with a configuration script
win_inet_proxy:
auto_detect: yes
auto_config_url: http://proxy.ansible.com/proxy.pac
- name: Configure IE to use explicit proxy host
win_inet_proxy:
auto_detect: yes
proxy: ansible.proxy
- name: Configure IE to use explicit proxy host with port and without auto detection
win_inet_proxy:
auto_detect: no
proxy: ansible.proxy:8080
- name: Configure IE to use a specific proxy per protocol
win_inet_proxy:
proxy:
http: ansible.proxy:8080
https: ansible.proxy:8443
- name: Configure IE to use a specific proxy per protocol using a string
win_inet_proxy:
proxy: http=ansible.proxy:8080;https=ansible.proxy:8443
- name: Set a proxy with a bypass list
win_inet_proxy:
proxy: ansible.proxy
bypass:
- server1
- server2
- <-loopback>
- <local>
- name: Remove any explicit proxies that are set
win_inet_proxy:
proxy: ''
bypass: ''
# This should be done after setting the IE proxy with win_inet_proxy
- name: Import IE proxy configuration to WinHTTP
win_http_proxy:
source: ie
# Explicit credentials can only be set per user and require become to work
- name: Set credential to use for proxy auth
win_credential:
name: ansible.proxy # The name should be the FQDN of the proxy host
type: generic_password
username: proxyuser
secret: proxypass
state: present
become: yes
become_user: '{{ ansible_user }}'
become_method: runas
Hint
If you notice any issues in this documentation you can edit this document to improve it.