Class: Ansible::Ruby::Modules::Vmware_vm_vm_drs_rule

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

Overview

This module can be used to configure VMware DRS Affinity rule for virtual machine in given cluster.

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

#affinity_rule ⇒ Boolean?

Returns If set to C(True), the DRS rule will be an Affinity rule.,If set to C(False), the DRS rule will be an Anti-Affinity rule.,Effective only if C(state) is set to C(present).

Returns:

  • (Boolean, nil) —

    If set to C(True), the DRS rule will be an Affinity rule.,If set to C(False), the DRS rule will be an Anti-Affinity rule.,Effective only if C(state) is set to C(present).



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vm_vm_drs_rule.rb', line 32

attribute :affinity_rule

#cluster_name ⇒ String

Returns Desired cluster name where virtual machines are present for the DRS rule.

Returns:

  • (String) —

    Desired cluster name where virtual machines are present for the DRS rule.



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

attribute :cluster_name

#drs_rule_name ⇒ String

Returns The name of the DRS rule to manage.

Returns:

  • (String) —

    The name of the DRS rule to manage.



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

attribute :drs_rule_name

#enabled ⇒ Symbol?

Returns If set to C(True), the DRS rule will be enabled.,Effective only if C(state) is set to C(present).

Returns:

  • (Symbol, nil) —

    If set to C(True), the DRS rule will be enabled.,Effective only if C(state) is set to C(present).



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

attribute :enabled

#mandatory ⇒ Symbol?

Returns If set to C(True), the DRS rule will be mandatory.,Effective only if C(state) is set to C(present).

Returns:

  • (Symbol, nil) —

    If set to C(True), the DRS rule will be mandatory.,Effective only if C(state) is set to C(present).



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

attribute :mandatory

#state ⇒ :present, ...

Returns If set to C(present), then the DRS rule is created if not present.,If set to C(present), then the DRS rule is deleted and created if present already.,If set to C(absent), then the DRS rule is deleted if present.

Returns:

  • (:present, :absent, nil) —

    If set to C(present), then the DRS rule is created if not present.,If set to C(present), then the DRS rule is deleted and created if present already.,If set to C(absent), then the DRS rule is deleted if present.



36
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vm_vm_drs_rule.rb', line 36

attribute :state

#vms ⇒ Array<String>, ...

Returns List of virtual machines name for which DRS rule needs to be applied.,Required if C(state) is set to C(present).

Returns:

  • (Array<String>, String, nil) —

    List of virtual machines name for which DRS rule needs to be applied.,Required if C(state) is set to C(present).



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

attribute :vms