mirror of
https://github.com/freeipa/ansible-freeipa.git
synced 2026-06-10 02:35:54 +00:00
8bc6b01f49
Add a new configuration variable, `ipaapi_context` to IPAAnsibleModule base specs, accepting only 'server' or 'client' values. By using this variable, an user can select the environment context in which the module will execute, server or client. This change will allow configuration of the server without requiring login access (e.g. `ssh`) to the server. The default behavior is to use a `server` context, but this behavior can be modified by the plugin, if it sets the `context` parameter when connecting to IPA API.
41 lines
1.3 KiB
Python
41 lines
1.3 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Authors:
|
|
# Thomas Woerner <twoerner@redhat.com>
|
|
#
|
|
# Copyright (C) 2021 Red Hat
|
|
# see file 'COPYING' for use and warranty information
|
|
#
|
|
# This program is free software; you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
|
class ModuleDocFragment(object): # pylint: disable=R0205,R0903
|
|
DOCUMENTATION = r"""
|
|
options:
|
|
ipaadmin_principal:
|
|
description: The admin principal.
|
|
default: admin
|
|
ipaadmin_password:
|
|
description: The admin password.
|
|
required: false
|
|
ipaapi_context:
|
|
description: |
|
|
The context in which the module will execute. Executing in a
|
|
server context is preferred. If not provided context will be
|
|
determined by the execution environment.
|
|
choices: ["server", "client"]
|
|
required: false
|
|
"""
|