redhat.satellite.location module – Manage Locations

Note

This module is part of the redhat.satellite collection (version 3.8.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.location.

New in redhat.satellite 1.0.0

Synopsis

  • Manage Locations

Requirements

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

  • requests

Parameters

Parameter

Comments

ignore_types

aliases: select_all_types

list / elements=string

added in redhat.satellite 3.8.0

List of resources types that will be automatically associated

name

string / required

Name of the Location

organizations

list / elements=string

List of organizations the location should be assigned to

parameters

list / elements=dictionary

Entity domain specific host parameters

name

string / required

Name of the parameter

parameter_type

string

Type of the parameter

Choices:

  • "string" ← (default)

  • "boolean"

  • "integer"

  • "real"

  • "array"

  • "hash"

  • "yaml"

  • "json"

value

any / required

Value of the parameter

parent

string

Title of a parent Location for nesting

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.

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

# Create a simple location
- name: "Create CI Location"
  redhat.satellite.location:
    username: "admin"
    password: "changeme"
    server_url: "https://satellite.example.com"
    name: "My Cool New Location"
    organizations:
      - "Default Organization"
    state: present

# Create a nested location
- name: "Create Nested CI Location"
  redhat.satellite.location:
    username: "admin"
    password: "changeme"
    server_url: "https://satellite.example.com"
    name: "My Nested location"
    parent: "My Cool New Location"
    state: present

# Create a new nested location with parent included in name
- name: "Create New Nested Location"
  redhat.satellite.location:
    username: "admin"
    password: "changeme"
    server_url: "https://satellite.example.com"
    name: "My Cool New Location/New nested location"
    state: present

# Move a nested location to another parent
- name: "Create Nested CI Location"
  redhat.satellite.location:
    username: "admin"
    password: "changeme"
    server_url: "https://satellite.example.com"
    name: "My Cool New Location/New nested location"
    parent: "My Cool New Location/My Nested location"
    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

locations

list / elements=dictionary

List of locations.

Returned: success

Authors

  • Matthias M Dellweg (@mdellweg) ATIX AG