mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 04:11:25 -07:00
96b3ef5553
* promote doc_fragments into actual plugins change tests hardcoded path to doc fragments avoid sanity in fragments avoid improper testing of doc_fragments also change runner paths fix botmeta updated comment for fragments updated docs
41 lines
1.4 KiB
Python
41 lines
1.4 KiB
Python
#
|
|
# Copyright 2018 Red Hat | Ansible
|
|
#
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible 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.
|
|
#
|
|
# Ansible 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 Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
# Options for specifying object state
|
|
|
|
|
|
class ModuleDocFragment(object):
|
|
|
|
DOCUMENTATION = '''
|
|
options:
|
|
state:
|
|
description:
|
|
- Determines if an object should be created, patched, or deleted. When set to C(present), an object will be
|
|
created, if it does not already exist. If set to C(absent), an existing object will be deleted. If set to
|
|
C(present), an existing object will be patched, if its attributes differ from those specified using
|
|
I(resource_definition) or I(src).
|
|
default: present
|
|
choices:
|
|
- present
|
|
- absent
|
|
force:
|
|
description:
|
|
- If set to C(True), and I(state) is C(present), an existing object will be replaced.
|
|
default: false
|
|
type: bool
|
|
'''
|