Class: Ansible::Ruby::Modules::Vcenter_folder

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/vmware/vcenter_folder.rb

Overview

This module can be used to create, delete, move and rename folder on then given datacenter.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#datacenter ⇒ String

Returns Name of the datacenter.

Returns:

  • (String) —

    Name of the datacenter.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vcenter_folder.rb', line 12

attribute :datacenter

#folder_name ⇒ String

Returns Name of folder to be managed.,This is case sensitive parameter.,Folder name should be under 80 characters. This is a VMware restriction.

Returns:

  • (String) —

    Name of folder to be managed.,This is case sensitive parameter.,Folder name should be under 80 characters. This is a VMware restriction.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vcenter_folder.rb', line 16

attribute :folder_name

#folder_type ⇒ :datastore, ...

Returns This is type of folder.,If set to C(vm), then ‘VM and Template Folder’ is created under datacenter.,If set to C(host), then ‘Host and Cluster Folder’ is created under datacenter.,If set to C(datastore), then ‘Storage Folder’ is created under datacenter.,If set to C(network), then ‘Network Folder’ is created under datacenter.,This parameter is required, if C(state) is set to C(present) and parent_folder is absent.,This option is ignored, if C(parent_folder) is set.

Returns:

  • (:datastore, :host, :network, :vm, nil) —

    This is type of folder.,If set to C(vm), then ‘VM and Template Folder’ is created under datacenter.,If set to C(host), then ‘Host and Cluster Folder’ is created under datacenter.,If set to C(datastore), then ‘Storage Folder’ is created under datacenter.,If set to C(network), then ‘Network Folder’ is created under datacenter.,This parameter is required, if C(state) is set to C(present) and parent_folder is absent.,This option is ignored, if C(parent_folder) is set.



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vcenter_folder.rb', line 24

attribute :folder_type

#parent_folder ⇒ String?

Returns Name of the parent folder under which new folder needs to be created.,This is case sensitive parameter.,Please specify unique folder name as there is no way to detect duplicate names.,If user wants to create a folder under ‘/DC0/vm/vm_folder’, this value will be ‘vm_folder’.

Returns:

  • (String, nil) —

    Name of the parent folder under which new folder needs to be created.,This is case sensitive parameter.,Please specify unique folder name as there is no way to detect duplicate names.,If user wants to create a folder under ‘/DC0/vm/vm_folder’, this value will be ‘vm_folder’.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vcenter_folder.rb', line 20

attribute :parent_folder

#state ⇒ :present, ...

Returns State of folder.,If set to C(present) without parent folder parameter, then folder with C(folder_type) is created.,If set to C(present) with parent folder parameter, then folder in created under parent folder. C(folder_type) is ignored.,If set to C(absent), then folder is unregistered and destroyed.

Returns:

  • (:present, :absent, nil) —

    State of folder.,If set to C(present) without parent folder parameter, then folder with C(folder_type) is created.,If set to C(present) with parent folder parameter, then folder in created under parent folder. C(folder_type) is ignored.,If set to C(absent), then folder is unregistered and destroyed.



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vcenter_folder.rb', line 28

attribute :state