theforeman.foreman.smart_proxy_refresh module – Refresh Smart Proxy features

Note

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

New in theforeman.foreman 5.9.0

Synopsis
Requirements
Parameters
Attributes
Examples
Return Values

Synopsis

Refresh Smart Proxy features

Requirements

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

requests

Parameters

Parameter	Comments
ca_path path	PEM formatted file that contains a CA certificate to be used for validation. If the value is not specified in the task, the value of environment variable `FOREMAN_CA_PATH` will be used instead.
locations list / elements=string	List of locations the entity should be assigned to
oauth1_consumer_key string	OAuth1 consumer key for accessing the Foreman server. If the value is not specified in the task, the value of environment variable `FOREMAN_OAUTH1_CONSUMER_KEY` will be used instead.
oauth1_consumer_secret string	OAuth1 consumer secret for accessing the Foreman server. If the value is not specified in the task, the value of environment variable `FOREMAN_OAUTH1_CONSUMER_SECRET` will be used instead.
organizations list / elements=string	List of organizations the entity should be assigned to
password string	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.
smart_proxy string / required	Name of the Smart Proxy
use_gssapi boolean	Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library requests-gssapi to be installed. If the value is not specified in the task, the value of environment variable `FOREMAN_USE_GSSAPI` will be used instead. Choices: `false` ← (default) `true`
username string	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: none	Can run in check_mode and return changed status prediction without modifying the entity
diff_mode	Support: none	Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode

Examples

- name: "Refresh Smart Proxy"
  theforeman.foreman.smart_proxy_refresh:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    smart_proxy: "foreman-proxy.example.com"

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

Evgeni Golov (@evgeni)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/theforeman/foreman/smart_proxy_refresh_module.html