theforeman.foreman.smart_proxy module – Manage Smart Proxies

Note

This module is part of the theforeman.foreman collection (version 4.2.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. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: theforeman.foreman.smart_proxy.

New in theforeman.foreman 1.4.0

Synopsis

  • Create, update and delete Smart Proxies

Requirements

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

  • requests

Parameters

Parameter

Comments

download_policy

string

The download policy for the Smart Proxy

Only available for Katello installations.

The download policy background is deprecated and not available since Katello 4.3.

The download policy streamed is available since Katello 4.5.

Choices:

  • "background"

  • "immediate"

  • "on_demand"

  • "streamed"

  • "inherit"

lifecycle_environments

list / elements=string

Lifecycle Environments synced to the Smart Proxy.

Only available for Katello installations.

locations

list / elements=string

List of locations the entity should be assigned to

name

string / required

Name of the Smart Proxy

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.

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 / required

URL of the Smart 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:

  • false

  • true ← (default)

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying the entity

diff_mode

Support: full

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode

Notes

Note

  • Even with state=present this module does not install a new Smart Proxy.

  • It can only associate an existing Smart Proxy listening at the specified url.

  • Consider using foreman-installer to create Smart Proxies.

Examples

# Create a local Smart Proxy
- name: "Create Smart Proxy"
  theforeman.foreman.smart_proxy:
    username: "admin"
    password: "changeme"
    server_url: "https://{{ ansible_fqdn }}"
    name: "{{ ansible_fqdn }}"
    url: "https://{{ ansible_fqdn }}:9090"
    download_policy: "immediate"
    lifecycle_environments:
      - "Development"
    organizations:
      - "Default Organization"
    locations:
      - "Default Location"
    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

smart_proxies

list / elements=dictionary

List of smart_proxies.

Returned: success

Authors

  • James Stuart (@jstuart)

  • Matthias M Dellweg (@mdellweg)

  • Jeffrey van Pelt (@Thulium-Drake)