From 9f9bff88c2baa9f8e553015bf40817f8381fb2db Mon Sep 17 00:00:00 2001 From: Charles Paul Date: Tue, 12 Jan 2016 11:06:22 -0600 Subject: [PATCH] doc fragments for vmware_ vca_ --- .../utils/module_docs_fragments/vca.py | 83 +++++++++++++++++++ .../utils/module_docs_fragments/vmware.py | 37 +++++++++ 2 files changed, 120 insertions(+) create mode 100644 lib/ansible/utils/module_docs_fragments/vca.py create mode 100644 lib/ansible/utils/module_docs_fragments/vmware.py diff --git a/lib/ansible/utils/module_docs_fragments/vca.py b/lib/ansible/utils/module_docs_fragments/vca.py new file mode 100644 index 00000000000..88cb1b41846 --- /dev/null +++ b/lib/ansible/utils/module_docs_fragments/vca.py @@ -0,0 +1,83 @@ +# (c) 2016, Charles Paul +# +# 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 . + + +class ModuleDocFragment(object): + # Parameters for VCA modules + DOCUMENTATION = """ +options: + username: + description: + - The vca username or email address, if not set the environment variable VCA_USER is checked for the username. + required: false + default: None + aliases: ['user'] + password: + description: + - The vca password, if not set the environment variable VCA_PASS is checked for the password + required: false + default: None + aliases: ['pass', 'pwd'] + org: + description: + - The org to login to for creating vapp, mostly set when the service_type is vdc. + required: false + default: None + instance_id: + description: + - The instance id in a vchs environment to be used for creating the vapp + required: false + default: None + host: + description: + - The authentication host to be used when service type is vcd. + required: false + default: None + api_version: + description: + - The api version to be used with the vca + required: false + default: "5.7" + service_type: + description: + - The type of service we are authenticating against + required: false + default: vca + choices: [ "vca", "vchs", "vcd" ] + state: + description: + - if the object should be added or removed + required: false + default: present + choices: [ "present", "absent" ] + verify_certs: + description: + - If the certificates of the authentication is to be verified + required: false + default: True + vdc_name: + description: + - The name of the vdc where the gateway is located. + required: false + default: None + gateway_name: + description: + - The name of the gateway of the vdc where the rule should be added + required: false + default: gateway +""" + diff --git a/lib/ansible/utils/module_docs_fragments/vmware.py b/lib/ansible/utils/module_docs_fragments/vmware.py new file mode 100644 index 00000000000..0b698865947 --- /dev/null +++ b/lib/ansible/utils/module_docs_fragments/vmware.py @@ -0,0 +1,37 @@ +# (c) 2016, Charles Paul +# +# 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 . + + +class ModuleDocFragment(object): + # Paramaters for VMware modules + DOCUMENTATION = ''' +options: + hostname: + description: + - The hostname or IP address of the vSphere vCenter + required: True + username: + description: + - The username of the vSphere vCenter + required: True + aliases: ['user', 'admin'] + password: + description: + - The password of the vSphere vCenter + required: True + aliases: ['pass', 'pwd'] +'''