cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge pull request #1487 from chrrrles/vmware_doc_fragments

Browse source 
use doc fragments
This commit is contained in:
Chrrrles Paul 2016-01-15 15:42:25 -06:00
commit 570869ef48
19 changed files with 20 additions and 341 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
cloud/vmware/vca_fw.py
View file

@ -27,69 +27,12 @@ description:
version_added: "2.0"
author: Peter Sprygada (@privateip)
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
password:
description:
- The vca password, if not set the environment variable VCA_PASS is checked for the password
required: false
default: None
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
fw_rules:
description:
- A list of firewall rules to be added to the gateway, Please see examples on valid entries
required: True
default: false
extends_documentation_fragment: vca.documentation
'''
EXAMPLES = '''

58
cloud/vmware/vca_nat.py
View file

@ -27,63 +27,6 @@ description:
version_added: "2.0"
author: Peter Sprygada (@privateip)
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
password:
description:
- The vca password, if not set the environment variable VCA_PASS is checked for the password
required: false
default: None
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
purge_rules:
description:
- If set to true, it will delete all rules in the gateway that are not given as paramter to this module.
@ -94,6 +37,7 @@ options:
- A list of rules to be added to the gateway, Please see examples on valid entries
required: True
default: false
extends_documentation_fragment: vca.documentation
'''
EXAMPLES = '''

15
cloud/vmware/vmware_cluster.py
View file

@ -31,20 +31,6 @@ requirements:
- Tested on ESXi 5.5
- PyVmomi installed
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']
datacenter_name:
description:
- The name of the datacenter the cluster will be created in.
@ -68,6 +54,7 @@ options:
- If set to True will enable vSAN when the cluster is created.
required: False
default: False
extends_documentation_fragment: vmware.documentation
'''
EXAMPLES = '''

1
cloud/vmware/vmware_datacenter.py
View file

@ -55,6 +55,7 @@ options:
- If the datacenter should be present or absent
choices: ['present', 'absent']
required: True
extends_documentation_fragment: vmware.documentation
'''
EXAMPLES = '''

15
cloud/vmware/vmware_dns_config.py
View file

@ -32,20 +32,6 @@ requirements:
- "python >= 2.6"
- PyVmomi
options:
hostname:
description:
- The hostname or IP address of the vSphere vCenter API server
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']
change_hostname_to:
description:
- The hostname that an ESXi host should be changed to.
@ -58,6 +44,7 @@ options:
description:
- The DNS servers that the host should be configured to use.
required: True
extends_documentation_fragment: vmware.documentation
'''
EXAMPLES = '''

15
cloud/vmware/vmware_dvs_host.py
View file

@ -32,20 +32,6 @@ requirements:
- "python >= 2.6"
- PyVmomi
options:
hostname:
description:
- The hostname or IP address of the vSphere vCenter API server
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']
esxi_hostname:
description:
- The ESXi hostname
@ -63,6 +49,7 @@ options:
- If the host should be present or absent attached to the vSwitch
choices: ['present', 'absent']
required: True
extends_documentation_fragment: vmware.documentation
'''
EXAMPLES = '''

15
cloud/vmware/vmware_dvs_portgroup.py
View file

@ -32,20 +32,6 @@ requirements:
- "python >= 2.6"
- PyVmomi
options:
hostname:
description:
- The hostname or IP address of the vSphere vCenter API server
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']
portgroup_name:
description:
- The name of the portgroup that is to be created or deleted
@ -70,6 +56,7 @@ options:
- 'earlyBinding'
- 'lateBinding'
- 'ephemeral'
extends_documentation_fragment: vmware.documentation
'''
EXAMPLES = '''

15
cloud/vmware/vmware_dvswitch.py
View file

@ -32,20 +32,6 @@ requirements:
- "python >= 2.6"
- PyVmomi
options:
hostname:
description:
- The hostname or IP address of the vSphere vCenter API server
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']
datacenter_name:
description:
- The name of the datacenter that will contain the dvSwitch
@ -85,6 +71,7 @@ options:
- 'present'
- 'absent'
required: False
extends_documentation_fragment: vmware.documentation
'''
EXAMPLES = '''
- name: Create dvswitch

15
cloud/vmware/vmware_host.py
View file

@ -32,20 +32,6 @@ requirements:
- "python >= 2.6"
- PyVmomi
options:
hostname:
description:
- The hostname or IP address of the vSphere vCenter API server
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']
datacenter_name:
description:
- Name of the datacenter to add the host
@ -74,6 +60,7 @@ options:
- 'present'
- 'absent'
required: False
extends_documentation_fragment: vmware.documentation
'''
EXAMPLES = '''

15
cloud/vmware/vmware_migrate_vmk.py
View file

@ -32,20 +32,6 @@ requirements:
- "python >= 2.6"
- PyVmomi
options:
hostname:
description:
- The hostname or IP address of the vSphere vCenter API server
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']
esxi_hostname:
description:
- ESXi hostname to be managed
@ -70,6 +56,7 @@ options:
description:
- Portgroup name to migrate VMK interface to
required: True
extends_documentation_fragment: vmware.documentation
'''
EXAMPLES = '''

15
cloud/vmware/vmware_portgroup.py
View file

@ -32,20 +32,6 @@ requirements:
- "python >= 2.6"
- PyVmomi
options:
hostname:
description:
- The hostname or IP address of the ESXi server
required: True
username:
description:
- The username of the ESXi server
required: True
aliases: ['user', 'admin']
password:
description:
- The password of the ESXi server
required: True
aliases: ['pass', 'pwd']
switch_name:
description:
- vSwitch to modify
@ -58,6 +44,7 @@ options:
description:
- VLAN ID to assign to portgroup
required: True
extends_documentation_fragment: vmware.documentation
'''
EXAMPLES = '''

15
cloud/vmware/vmware_target_canonical_facts.py
View file

@ -31,24 +31,11 @@ requirements:
- Tested on vSphere 5.5
- PyVmomi installed
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']
target_id:
description:
- The target id based on order of scsi device
required: True
extends_documentation_fragment: vmware.documentation
'''
EXAMPLES = '''

16
cloud/vmware/vmware_vm_facts.py
View file

@ -31,21 +31,7 @@ notes:
requirements:
- "python >= 2.6"
- PyVmomi
options:
hostname:
description:
- The hostname or IP address of the vSphere vCenter API server
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']
extends_documentation_fragment: vmware.documentation
'''
EXAMPLES = '''

15
cloud/vmware/vmware_vm_shell.py
View file

@ -33,20 +33,6 @@ requirements:
- "python >= 2.6"
- PyVmomi
options:
hostname:
description:
- The hostname or IP address of the vSphere vCenter API server
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']
datacenter:
description:
- The datacenter hosting the VM
@ -92,6 +78,7 @@ options:
- The current working directory of the application from which it will be run
required: False
default: None
extends_documentation_fragment: vmware.documentation
'''
EXAMPLES = '''

17
cloud/vmware/vmware_vm_vss_dvs_migrate.py
View file

@ -32,20 +32,6 @@ requirements:
- "python >= 2.6"
- PyVmomi
options:
hostname:
description:
- The hostname or IP address of the vSphere vCenter API server
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']
vm_name:
description:
- Name of the virtual machine to migrate to a dvSwitch
@ -54,6 +40,7 @@ options:
description:
- Name of the portgroup to migrate to the virtual machine to
required: True
extends_documentation_fragment: vmware.documentation
'''
EXAMPLES = '''
@ -173,4 +160,4 @@ from ansible.module_utils.vmware import *
from ansible.module_utils.basic import *
if __name__ == '__main__':
main()
main()

15
cloud/vmware/vmware_vmkernel.py
View file

@ -32,20 +32,6 @@ requirements:
- "python >= 2.6"
- PyVmomi
options:
hostname:
description:
- The hostname or IP address of the ESXi Server
required: True
username:
description:
- The username of the ESXi Server
required: True
aliases: ['user', 'admin']
password:
description:
- The password of ESXi Server
required: True
aliases: ['pass', 'pwd']
vswitch_name:
description:
- The name of the vswitch where to add the VMK interface
@ -86,6 +72,7 @@ options:
description:
- Enable the VMK interface for Fault Tolerance traffic
required: False
extends_documentation_fragment: vmware.documentation
'''
EXAMPLES = '''

15
cloud/vmware/vmware_vmkernel_ip_config.py
View file

@ -32,20 +32,6 @@ requirements:
- "python >= 2.6"
- PyVmomi
options:
hostname:
description:
- The hostname or IP address of the ESXi server
required: True
username:
description:
- The username of the ESXi server
required: True
aliases: ['user', 'admin']
password:
description:
- The password of the ESXi server
required: True
aliases: ['pass', 'pwd']
vmk_name:
description:
- VMkernel interface name
@ -58,6 +44,7 @@ options:
description:
- Subnet Mask to assign to VMkernel interface
required: True
extends_documentation_fragment: vmware.documentation
'''
EXAMPLES = '''

15
cloud/vmware/vmware_vsan_cluster.py
View file

@ -32,24 +32,11 @@ requirements:
- "python >= 2.6"
- PyVmomi
options:
hostname:
description:
- The hostname or IP address of the ESXi Server
required: True
username:
description:
- The username of the ESXi Server
required: True
aliases: ['user', 'admin']
password:
description:
- The password of ESXi Server
required: True
aliases: ['pass', 'pwd']
cluster_uuid:
description:
- Desired cluster UUID
required: False
extends_documentation_fragment: vmware.documentation
'''
EXAMPLES = '''

15
cloud/vmware/vmware_vswitch.py
View file

@ -32,20 +32,6 @@ requirements:
- "python >= 2.6"
- PyVmomi
options:
hostname:
description:
- The hostname or IP address of the ESXi server
required: True
username:
description:
- The username of the ESXi server
required: True
aliases: ['user', 'admin']
password:
description:
- The password of the ESXi server
required: True
aliases: ['pass', 'pwd']
switch_name:
description:
- vSwitch name to add
@ -71,6 +57,7 @@ options:
- 'present'
- 'absent'
required: False
extends_documentation_fragment: vmware.documentation
'''
EXAMPLES = '''