redhat.satellite.lifecycle_environment module – Manage Lifecycle Environments

Note

This module is part of the redhat.satellite collection (version 3.6.0).

To install it, use: ansible-galaxy collection install redhat.satellite. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: redhat.satellite.lifecycle_environment.

New in version 1.0.0: of redhat.satellite

Synopsis

  • Create and manage lifecycle environments

Requirements

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

  • requests

Parameters

Parameter

Comments

description

string

Description of the lifecycle environment

label

string

Label of the lifecycle environment. This field cannot be updated.

name

string / required

Name of the lifecycle environment

organization

string / required

Organization that the entity is in

password

string / required

Password of the user accessing the Foreman server.

If the value is not specified in the task, the value of environment variable SATELLITE_PASSWORD will be used instead.

prior

string

Name of the parent lifecycle environment

server_url

string / required

URL of the Foreman server.

If the value is not specified in the task, the value of environment variable SATELLITE_SERVER_URL will be used instead.

state

string

State of the entity

Choices:

  • present ← (default)

  • absent

username

string / required

Username accessing the Foreman server.

If the value is not specified in the task, the value of environment variable SATELLITE_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 SATELLITE_VALIDATE_CERTS will be used instead.

Choices:

  • false

  • true ← (default)

Examples

- name: "Add a production lifecycle environment"
  redhat.satellite.lifecycle_environment:
    username: "admin"
    password: "changeme"
    server_url: "https://satellite.example.com"
    name: "Production"
    label: "production"
    organization: "Default Organization"
    prior: "Library"
    description: "The production environment"
    state: "present"

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

lifecycle_environments

list / elements=dictionary

List of lifecycle environments.

Returned: success

Authors

  • Andrew Kofink (@akofink)

  • Baptiste Agasse (@bagasse)