theforeman.foreman.domain_info – Fetch information about Domains

Note

This plugin is part of the theforeman.foreman collection (version 2.1.1).

To install it use: ansible-galaxy collection install theforeman.foreman.

To use it in a playbook, specify: theforeman.foreman.domain_info.

New in version 2.1.0: of theforeman.foreman

Synopsis

• Fetch information about Domains

Requirements

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

• requests

Parameters

Parameter	Choices/Defaults	Comments
location string		Label of the Location to scope the search for.
name string		Name of the resource to fetch information for. Mutually exclusive with search.
organization string		Name of the Organization to scope the search for.
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.
search string		Search query to use If None, and name is not set, all resources are returned. Mutually exclusive with name.
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.
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	Choices: no yes ←	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.

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	Returned	Description
domain dictionary	success and name was passed	Details about the found domain
domains list / elements=dictionary	success and search was passed	List of all found domains and their details

Authors

• Eric Helms (@ehelms)