theforeman.foreman.location – Manage Locations¶
Note
This plugin is part of the theforeman.foreman collection (version 1.5.1).
To install it use: ansible-galaxy collection install theforeman.foreman
.
To use it in a playbook, specify: theforeman.foreman.location
.
New in version 1.0.0: of theforeman.foreman
Parameters¶
Examples¶
# Create a simple location
- name: "Create CI Location"
theforeman.foreman.location:
username: "admin"
password: "changeme"
server_url: "https://foreman.example.com"
name: "My Cool New Location"
organizations:
- "Default Organization"
state: present
# Create a nested location
- name: "Create Nested CI Location"
theforeman.foreman.location:
username: "admin"
password: "changeme"
server_url: "https://foreman.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"
theforeman.foreman.location:
username: "admin"
password: "changeme"
server_url: "https://foreman.example.com"
name: "My Cool New Location/New nested location"
state: present
# Move a nested location to another parent
- name: "Create Nested CI Location"
theforeman.foreman.location:
username: "admin"
password: "changeme"
server_url: "https://foreman.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 | Returned | Description | |
---|---|---|---|
entity
dictionary
|
success |
Final state of the affected entities grouped by their type.
|
|
locations
list
/ elements=dictionary
|
success |
List of locations.
|
Authors¶
Matthias M Dellweg (@mdellweg) ATIX AG