theforeman.foreman.domain – Manage Domains
theforeman.foreman.domain – Manage Domains
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.domain
.
New in version 1.0.0: of theforeman.foreman
Synopsis
- Create, update, and delete Domains
Requirements
The below requirements are needed on the host that executes this module.
- requests
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
description string |
Full name describing the domain
| ||
dns_proxy string |
DNS proxy to use within this domain for managing A records
| ||
locations list / elements=string |
List of locations the entity should be assigned to | ||
name string / required |
The full DNS domain name | ||
organizations list / elements=string |
List of organizations the entity should be assigned to | ||
parameters list / elements=dictionary |
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 | ||
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 | ||
server_url string / required |
URL of the Foreman server. If the value is not specified in the task, the value of environment variable | ||
state string |
|
State of the entity | |
updated_name string |
New domain name. When this parameter is set, the module will not be idempotent. | ||
username string / required |
Username accessing the Foreman server. If the value is not specified in the task, the value of environment variable | ||
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 |
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 | Returned | Description | |
---|---|---|---|
entity dictionary |
success |
Final state of the affected entities grouped by their type.
| |
domains list / elements=dictionary |
success |
List of domains.
|
Authors
- Markus Bucher (@m-bucher) ATIX AG
© 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/domain_module.html