theforeman.foreman.http_proxy – Manage HTTP Proxies
theforeman.foreman.http_proxy – Manage HTTP Proxies
Note
This plugin is part of the theforeman.foreman collection (version 1.5.1).
To install it use: ansible-galaxy collection install theforeman.foreman
.
To use it in a playbook, specify: theforeman.foreman.http_proxy
.
New in version 1.1.0: of theforeman.foreman
Synopsis
- Create, update, and delete HTTP Proxies
Requirements
The below requirements are needed on the host that executes this module.
- requests
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
locations list / elements=string |
List of locations the entity should be assigned to | |
name string / required |
The HTTP Proxy name | |
organizations list / elements=string |
List of organizations the entity should be assigned to | |
password string / required |
Password of the user accessing the Foreman server. If the value is not specified in the task, the value of environment variable | |
proxy_password string |
Password used to authenticate with the HTTP Proxy When this parameter is set, the module will not be idempotent. | |
proxy_username string |
Username used to authenticate with the HTTP Proxy | |
server_url string / required |
URL of the Foreman server. If the value is not specified in the task, the value of environment variable | |
state string |
|
State of the entity |
url string |
URL of the HTTP Proxy Required when creating a new HTTP Proxy. | |
username string / required |
Username accessing the Foreman server. If the value is not specified in the task, the value of environment variable | |
validate_certs boolean |
|
Whether or not to verify the TLS certificates of the Foreman server. If the value is not specified in the task, the value of environment variable |
Examples
- name: create example.org proxy
theforeman.foreman.http_proxy:
name: "example.org"
url: "http://example.org:3128"
locations:
- "Munich"
organizations:
- "ACME"
server_url: "https://foreman.example.com"
username: "admin"
password: "changeme"
state: present
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
entity dictionary |
success |
Final state of the affected entities grouped by their type.
| |
http_proxies list / elements=dictionary |
success |
List of HTTP proxies.
|
Authors
- Evgeni Golov (@evgeni)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/theforeman/foreman/http_proxy_module.html