foreman_domain – Manage Foreman Domains using Foreman API¶
Parameters¶
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
description
string
|
Full name describing the domain
aliases: fullname |
||
dns_proxy
string
|
DNS proxy to use within this domain for managing A records
aliases: dns |
||
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
|
||
server_url
string
/ required
|
URL of the Foreman server
|
||
state
string
|
|
State of the entity in Foreman
|
|
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
|
||
validate_certs
boolean
|
|
Whether or not to verify the TLS certificates of the Foreman server
aliases: verify_ssl |
Examples¶
- name: domain
foreman_domain:
name: "example.org"
description: "Example Domain"
locations:
- "Munich"
organizations:
- "ATIX"
server_url: "https://foreman.example.com"
username: "admin"
password: "secret"
state: present
Status¶
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]
Authors¶
Markus Bucher (@m-bucher) ATIX AG
Hint
If you notice any issues in this documentation, you can edit this document to improve it.