foreman - Manage Foreman Resources

New in version 2.3.

Synopsis
- Requirements
Parameters
Examples
Status
Maintenance
- Author

Synopsis

Allows the management of Foreman resources inside your Foreman server.

Requirements

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

nailgun >= 0.28.0
python >= 2.6
datetime

Parameters

Parameter	Choices/Defaults	Comments
entity required		The Foreman resource that the action will be performed on (e.g. organization, host).
params required		Parameters associated to the entity resource to set or edit in dictionary format (e.g. name, description).
password required		Password for user accessing Foreman server.
server_url required		URL of Foreman server.
username required		Username on Foreman server.

Examples

- name: Create CI Organization
  foreman:
    username: admin
    password: admin
    server_url: https://fakeserver.com
    entity: organization
    params:
      name: My Cool New Organization
  delegate_to: localhost

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

Eric D Helms (@ehelms)

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/foreman_module.html