theforeman.foreman.smart_proxy – Manage Smart Proxies

From Get docs
Ansible/docs/2.10/collections/theforeman/foreman/smart proxy module


theforeman.foreman.smart_proxy – Manage Smart 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.smart_proxy.


New in version 1.4.0: of theforeman.foreman


Synopsis

  • Create, update and delete Smart Proxies

Requirements

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

  • requests

Parameters

Parameter Choices/Defaults Comments

download_policy

string

  • background
  • immediate
  • on_demand

The download policy for the Smart Proxy

Only available for Katello installations.

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

  • present

  • absent

State of the entity

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

  • 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

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 Returned Description

entity

dictionary

success

Final state of the affected entities grouped by their type.


smart_proxies

list / elements=dictionary

success

List of smart_proxies.





Authors

  • James Stuart (@jstuart)
  • Matthias M Dellweg (@mdellweg)
  • Jeffrey van Pelt (@Thulium-Drake)

© 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/smart_proxy_module.html