theforeman.foreman.http_proxy module – Manage HTTP Proxies

Note

This module is part of the theforeman.foreman collection (version 3.6.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 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

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

State of the entity

Choices:

  • present ← (default)

  • absent

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

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.

Choices:

  • no

  • yes ← (default)

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

Description

entity

dictionary

Final state of the affected entities grouped by their type.

Returned: success

http_proxies

list / elements=dictionary

List of HTTP proxies.

Returned: success

Authors

  • Evgeni Golov (@evgeni)