You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

foreman - Manage Foreman Resources¶

New in version 2.3.

Synopsis
Requirements (on host that executes module)
Options
Examples
- Status

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.