On this page
foreman - Manage Foreman Resources
New in version 2.3.
Synopsis
- Allows the management of Foreman resources inside your Foreman server
Requirements (on host that executes module)
- nailgun >= 0.28.0
- python >= 2.6
- datetime
Options
parameter | required | default | choices | comments |
---|---|---|---|---|
entity |
yes |
The Foreman resource that the action will be performed on (e.g. organization, host)
|
||
params |
yes |
Parameters associated to the entity resource to set or edit in dictionary format (e.g. name, description)
|
||
password |
yes |
Password for user accessing Foreman server
|
||
server_url |
yes |
URL of Foreman server
|
||
username |
yes |
Username on Foreman server
|
Examples
- name: "Create CI Organization"
local_action:
module: foreman
username: "admin"
password: "admin"
server_url: "https://fakeserver.com"
entity: "organization"
params:
name: "My Cool New Organization"
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/foreman_module.html