You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ansible/lib/ansible/plugins/doc_fragments/VmwareRestModule_full.py

50 lines
1.6 KiB
Python

# -*- coding: utf-8 -*-
# Copyright: (c) 2019, Paul Knight <paul.knight@delaware.gov>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import absolute_import, division, print_function
__metaclass__ = type
class ModuleDocFragment(object):
# Parameters for VMware ReST HTTPAPI modules includes filters and state
DOCUMENTATION = r'''
options:
allow_multiples:
description:
- Indicates whether get_id() can return multiple IDs for a given name.
- Typically, this should be false when updating or deleting; otherwise, all named objects could be affected.
required: true
version_added: "2.9"
type: bool
filters:
description:
- The key/value pairs describing filters to be applied to the request(s) made by this instance.
required: false
version_added: "2.9"
type: dict
log_level:
description:
- If ANSIBLE_DEBUG is set, this will be forced to 'debug', but can be user-defined otherwise.
required: True
choices: ['debug', 'info', 'normal']
version_added: "2.9"
type: str
default: 'normal'
state:
description:
- Either 'absent' or 'present', depending on whether object should be removed or created.
required: false
choices: ['absent', 'present', 'query']
version_added: "2.9"
type: str
default: 'present'
status_code:
description:
- A list of integer status codes considered to be successful for the this module.
required: true
version_added: "2.9"
type: list
default: [200]
'''