theforeman.foreman.domain_info module – Fetch information about Domains
Note
This module is part of the theforeman.foreman collection (version 5.0.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install theforeman.foreman
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: theforeman.foreman.domain_info
.
New in theforeman.foreman 2.1.0
Synopsis
Fetch information about Domains
Requirements
The below requirements are needed on the host that executes this module.
requests
Parameters
Parameter |
Comments |
---|---|
Label of the Location to scope the search for. |
|
Name of the resource to fetch information for. Mutually exclusive with search. |
|
Name of the Organization to scope the search for. |
|
Password of the user accessing the Foreman server. If the value is not specified in the task, the value of environment variable |
|
Search query to use If None, and name is not set, all resources are returned. Mutually exclusive with name. |
|
URL of the Foreman server. If the value is not specified in the task, the value of environment variable |
|
Username accessing the Foreman server. If the value is not specified in the task, the value of environment variable |
|
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 Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in check_mode and return changed status prediction without modifying the entity |
|
Support: full |
Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode |
Examples
- name: "Show a domain"
theforeman.foreman.domain_info:
username: "admin"
password: "changeme"
server_url: "https://foreman.example.com"
name: "example.com"
- name: "Show all domains with domain example.com"
theforeman.foreman.domain_info:
username: "admin"
password: "changeme"
server_url: "https://foreman.example.com"
search: "name = example.com"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Details about the found domain Returned: success and name was passed |
|
List of all found domains and their details Returned: success and search was passed |