Note
This plugin is part of the theforeman.foreman collection.
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
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
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 | |
value raw / 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 FOREMAN_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 FOREMAN_SERVER_URL will be used instead. | ||
state string |
| State of the entity | |
username string / required | Username accessing the Foreman server. If the value is not specified in the task, the value of environment variable FOREMAN_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 FOREMAN_VALIDATE_CERTS will be used instead. |
# 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
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. |
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/theforeman/foreman/location_module.html