theforeman.foreman.domain module – Manage Domains
Note
This module is part of the theforeman.foreman collection (version 4.3.0-dev).
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
.
New in theforeman.foreman 1.0.0
Synopsis
Create, update, and delete Domains
Aliases: foreman_domain
Requirements
The below requirements are needed on the host that executes this module.
requests
Parameters
Parameter |
Comments |
---|---|
Full name describing the domain |
|
DNS proxy to use within this domain for managing A records |
|
List of locations the entity should be assigned to |
|
The full DNS domain name |
|
List of organizations the entity should be assigned to |
|
Domain specific host parameters |
|
Should the value be hidden Choices:
|
|
Name of the parameter |
|
Type of the parameter Choices:
|
|
Value of the parameter |
|
Password of the user accessing the Foreman server. If the value is not specified in the task, the value of environment variable |
|
URL of the Foreman server. If the value is not specified in the task, the value of environment variable |
|
State of the entity Choices:
|
|
New domain name. When this parameter is set, the module will not be idempotent. |
|
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: domain
theforeman.foreman.domain:
name: "example.org"
description: "Example Domain"
locations:
- "Munich"
organizations:
- "ACME"
server_url: "https://foreman.example.com"
username: "admin"
password: "changeme"
state: present
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Final state of the affected entities grouped by their type. Returned: success |
|
List of domains. Returned: success |