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 |
---|---|
The download policy for the Smart Proxy Only available for Katello installations. The download policy The download policy Choices:
|
|
Lifecycle Environments synced to the Smart Proxy. Only available for Katello installations. |
|
List of locations the entity should be assigned to |
|
Name of the Smart Proxy |
|
List of organizations the entity should be assigned to |
|
Password of the user accessing the Foreman server. If the value is not specified in the task, the value of environment variable |
|
URL of the Foreman server. If the value is not specified in the task, the value of environment variable |
|
State of the entity Choices:
|
|
URL of the Smart Proxy |
|
Username accessing the Foreman server. If the value is not specified in the task, the value of environment variable |
|
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 Choices:
|
Attributes
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 |
---|---|
Final state of the affected entities grouped by their type. Returned: success |
|
List of smart_proxies. Returned: success |