From a1444aa06f3ae38f154c66b5cecda68f0535718c Mon Sep 17 00:00:00 2001
From: Rafael Guterres Jeffman <rjeffman@redhat.com>
Date: Wed, 4 Mar 2020 12:13:35 -0300
Subject: [PATCH] Fixes documentation for module ipaservice.
Add missing documentation for the `principal` variable.
---
README-service.md | 3 ++-
plugins/modules/ipaservice.py | 2 +-
2 files changed, 3 insertions(+), 2 deletions(-)
diff --git a/README-service.md b/README-service.md
index 8125190b..da0c692c 100644
--- a/README-service.md
+++ b/README-service.md
@@ -197,7 +197,7 @@ Example playbook to add a principal to the service:
gather_facts: false
tasks:
- # Principal host/test.example.com present in service.
+ # Principal host/principal.example.com present in service.
- ipaservice:
ipaadmin_password: SomeADMINpassword
name: HTTP/www.example.com
@@ -301,6 +301,7 @@ Variable | Description | Required
`skip_host_check` | Force service to be created even when host object does not exist to manage it. Default to false. (bool)| no
`force` | Force principal name even if host not in DNS. Default to false. (bool) | no
`host` \| `managedby_host`| Hosts that can manage the service. | no
+`principal` \| `krbprincipalname` | List of principal aliases for the service. | no
`allow_create_keytab_user` \| `ipaallowedtoperform_write_keys_user` | Users allowed to create a keytab of this host. | no
`allow_create_keytab_group` \| `ipaallowedtoperform_write_keys_group`| Groups allowed to create a keytab of this host. | no
`allow_create_keytab_host` \| `ipaallowedtoperform_write_keys_host`| Hosts allowed to create a keytab of this host. | no
diff --git a/plugins/modules/ipaservice.py b/plugins/modules/ipaservice.py
index d3074ffe..e0da817c 100644
--- a/plugins/modules/ipaservice.py
+++ b/plugins/modules/ipaservice.py
@@ -86,7 +86,7 @@ options:
default: False
aliases:["ipakrboktoauthasdelegate"]
principal:
- description:
+ description: List of principal aliases for the service.
required: false
type: list
aliases: ["krbprincipalname"]
--
GitLab