ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

VMware: update documentation and example (#43474)

Browse source 
This fix updates the documenation of vmware_guest_custom_attribute_defs module.

Fixes: #43443

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
This commit is contained in:
Abhijeet Kasurde 2018-07-31 16:11:16 +05:30 committed by GitHub
parent 857200fa7f
commit c44b05e167
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
lib/ansible/modules/cloud/vmware/vmware_guest_custom_attribute_defs.py
View file

@ -20,11 +20,11 @@ DOCUMENTATION = '''
module: vmware_guest_custom_attribute_defs module: vmware_guest_custom_attribute_defs
short_description: Manage custom attributes definitions for virtual machine from VMWare short_description: Manage custom attributes definitions for virtual machine from VMWare
description: description:
- This module can be used to add, remove and list custom attributes definitions for the given virtual machine from VMWare. - This module can be used to add and remove custom attributes definitions for the given virtual machine from VMWare.
version_added: 2.7 version_added: 2.7
author: author:
- Jimmy Conner - Jimmy Conner
- Abhijeet Kasurde (@Akasurde) <akasurde@redhat.com> - Abhijeet Kasurde (@Akasurde)
notes: notes:
- Tested on vSphere 6.5 - Tested on vSphere 6.5
requirements: requirements:
@ -50,22 +50,11 @@ extends_documentation_fragment: vmware.documentation
''' '''
EXAMPLES = ''' EXAMPLES = '''
- name: List VMWare Attribute Definitions
vmware_guest_custom_attribute_defs:
hostname: 192.168.1.209
username: administrator@vsphere.local
password: vmware
validate_certs: no
state: list
delegate_to: localhost
register: defs
- name: Add VMWare Attribute Definition - name: Add VMWare Attribute Definition
vmware_guest_custom_attribute_defs: vmware_guest_custom_attribute_defs:
hostname: 192.168.1.209 hostname: "{{ vcenter_server }}"
username: administrator@vsphere.local username: "{{ vcenter_username }}"
password: vmware password: "{{ vcenter_password }}"
validate_certs: no
state: present state: present
attribute_key: custom_attr_def_1 attribute_key: custom_attr_def_1
delegate_to: localhost delegate_to: localhost
@ -73,10 +62,9 @@ EXAMPLES = '''
- name: Remove VMWare Attribute Definition - name: Remove VMWare Attribute Definition
vmware_guest_custom_attribute_defs: vmware_guest_custom_attribute_defs:
hostname: 192.168.1.209 hostname: "{{ vcenter_server }}"
username: administrator@vsphere.local username: "{{ vcenter_username }}"
password: vmware password: "{{ vcenter_password }}"
validate_certs: no
state: absent state: absent
attribute_key: custom_attr_def_1 attribute_key: custom_attr_def_1
delegate_to: localhost delegate_to: localhost
@ -95,7 +83,6 @@ from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.vmware import PyVmomi, vmware_argument_spec from ansible.module_utils.vmware import PyVmomi, vmware_argument_spec
try: try:
import pyVmomi
from pyVmomi import vim from pyVmomi import vim
except ImportError: except ImportError:
pass pass