.. Document meta :orphan: .. Anchors .. _ansible_collections.theforeman.foreman.http_proxy_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title theforeman.foreman.http_proxy -- Manage HTTP Proxies ++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `theforeman.foreman collection `_ (version 2.1.2). To install it use: :code:`ansible-galaxy collection install theforeman.foreman`. To use it in a playbook, specify: :code:`theforeman.foreman.http_proxy`. .. version_added .. versionadded:: 1.1.0 of theforeman.foreman .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Create, update, and delete HTTP Proxies .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - requests .. Options Parameters ---------- .. raw:: html
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 FOREMAN_PASSWORD will be used instead.
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 FOREMAN_SERVER_URL will be used instead.
state
string
    Choices:
  • present ←
  • absent
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 FOREMAN_USERNAME will be used instead.
validate_certs
boolean
    Choices:
  • no
  • yes ←
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 FOREMAN_VALIDATE_CERTS will be used instead.

.. Notes .. Seealso .. Examples Examples -------- .. code-block:: yaml+jinja - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html
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.



.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Evgeni Golov (@evgeni) .. Parsing errors