Class: Ansible::Ruby::Modules::Ovirt_host
- Inherits:
-
Base
- Object
- Ansible::Ruby::Models::Base
- Base
- Ansible::Ruby::Modules::Ovirt_host
- Defined in:
- lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_host.rb,
lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_hosts.rb
Overview
Module to manage hosts in oVirt/RHV
Instance Method Summary collapse
-
#activate ⇒ Boolean?
If C(state) is I(present) activate the host.,This parameter is good to disable, when you don’t want to change the state of host when using I(present) C(state).
-
#address ⇒ String?
Host address.
-
#check_upgrade ⇒ Boolean?
If I(true) and C(state) is I(upgraded) run check for upgrade action before executing upgrade action.
-
#cluster ⇒ String?
Name of the cluster, where host should be created.
-
#comment ⇒ Object?
Description of the host.
-
#force ⇒ Symbol?
If True host will be forcibly moved to desired state.
-
#hosted_engine ⇒ :deploy, ...
If I(deploy) it means this host should deploy also hosted engine components.,If I(undeploy) it means this host should un-deploy hosted engine components and this host will not function as part of the High Availability cluster.
-
#iscsi ⇒ Hash?
If C(state) is I(iscsidiscover) it means that the iscsi attribute is being used to discover targets,If C(state) is I(iscsilogin) it means that the iscsi attribute is being used to login to the specified targets passed as part of the iscsi attribute.
-
#kdump_integration ⇒ :enabled, ...
Specify if host will have enabled Kdump integration.
-
#kernel_params ⇒ Array<String>, ...
List of kernel boot parameters.,Following are most common kernel parameters used for host:,Hostdev Passthrough & SR-IOV: intel_iommu=on,Nested Virtualization: kvm-intel.nested=1,Unsafe Interrupts: vfio_iommu_type1.allow_unsafe_interrupts=1,PCI Reallocation: pci=realloc,C(Note:),Modifying kernel boot parameters settings can lead to a host boot failure.
-
#name ⇒ String
Name of the host to manage.
-
#override_display ⇒ Symbol?
Override the display address of all VMs on this host with specified address.
-
#override_iptables ⇒ Symbol?
If True host iptables will be overridden by host deploy script.,Note that C(override_iptables) is I(false) by default in oVirt/RHV.
-
#password ⇒ String?
Password of the root.
-
#power_management_enabled ⇒ Symbol?
Enable or disable power management of the host.,For more comprehensive setup of PM use C(ovirt_host_pm) module.
-
#public_key ⇒ Symbol?
I(True) if the public key should be used to authenticate to host.,It’s required in case C(password) is not set.
-
#reboot_after_upgrade ⇒ Boolean?
If I(true) and C(state) is I(upgraded) reboot host after successful upgrade.
-
#spm_priority ⇒ Object?
SPM priority of the host.
-
#state ⇒ :present, ...
State which should a host to be in after successful completion.,I(iscsilogin) and I(iscsidiscover) are supported since version 2.4.
-
#timeout ⇒ Integer?
The amount of time in seconds the module should wait for the host to get into desired state.
Methods inherited from Base
Methods inherited from Ansible::Ruby::Models::Base
attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates
Constructor Details
This class inherits a constructor from Ansible::Ruby::Models::Base
Instance Method Details
#activate ⇒ Boolean?
Returns If C(state) is I(present) activate the host.,This parameter is good to disable, when you don’t want to change the state of host when using I(present) C(state).
74 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_host.rb', line 74 attribute :activate |
#address ⇒ String?
Returns Host address. It can be either FQDN (preferred) or IP address.
31 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_host.rb', line 31 attribute :address |
#check_upgrade ⇒ Boolean?
Returns If I(true) and C(state) is I(upgraded) run check for upgrade action before executing upgrade action.
82 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_host.rb', line 82 attribute :check_upgrade |
#cluster ⇒ String?
Returns Name of the cluster, where host should be created.
27 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_host.rb', line 27 attribute :cluster |
#comment ⇒ Object?
Returns Description of the host.
20 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_host.rb', line 20 attribute :comment |
#force ⇒ Symbol?
Returns If True host will be forcibly moved to desired state.
54 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_host.rb', line 54 attribute :force |
#hosted_engine ⇒ :deploy, ...
Returns If I(deploy) it means this host should deploy also hosted engine components.,If I(undeploy) it means this host should un-deploy hosted engine components and this host will not function as part of the High Availability cluster.
66 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_host.rb', line 66 attribute :hosted_engine |
#iscsi ⇒ Hash?
Returns If C(state) is I(iscsidiscover) it means that the iscsi attribute is being used to discover targets,If C(state) is I(iscsilogin) it means that the iscsi attribute is being used to login to the specified targets passed as part of the iscsi attribute.
78 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_host.rb', line 78 attribute :iscsi |
#kdump_integration ⇒ :enabled, ...
Returns Specify if host will have enabled Kdump integration.
43 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_host.rb', line 43 attribute :kdump_integration |
#kernel_params ⇒ Array<String>, ...
Returns List of kernel boot parameters.,Following are most common kernel parameters used for host:,Hostdev Passthrough & SR-IOV: intel_iommu=on,Nested Virtualization: kvm-intel.nested=1,Unsafe Interrupts: vfio_iommu_type1.allow_unsafe_interrupts=1,PCI Reallocation: pci=realloc,C(Note:),Modifying kernel boot parameters settings can lead to a host boot failure. Please consult the product documentation before doing any changes.,Kernel boot parameters changes require host deploy and restart. The host needs to be I(reinstalled) successfully and then to be I(rebooted) for kernel boot parameters to be applied.
62 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_host.rb', line 62 attribute :kernel_params |
#name ⇒ String
Returns Name of the host to manage.
12 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_host.rb', line 12 attribute :name |
#override_display ⇒ Symbol?
Returns Override the display address of all VMs on this host with specified address.
58 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_host.rb', line 58 attribute :override_display |
#override_iptables ⇒ Symbol?
Returns If True host iptables will be overridden by host deploy script.,Note that C(override_iptables) is I(false) by default in oVirt/RHV.
50 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_host.rb', line 50 attribute :override_iptables |
#password ⇒ String?
Returns Password of the root. It’s required in case C(public_key) is set to I(False).
35 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_host.rb', line 35 attribute :password |
#power_management_enabled ⇒ Symbol?
Returns Enable or disable power management of the host.,For more comprehensive setup of PM use C(ovirt_host_pm) module.
70 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_host.rb', line 70 attribute :power_management_enabled |
#public_key ⇒ Symbol?
Returns I(True) if the public key should be used to authenticate to host.,It’s required in case C(password) is not set.
39 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_host.rb', line 39 attribute :public_key |
#reboot_after_upgrade ⇒ Boolean?
Returns If I(true) and C(state) is I(upgraded) reboot host after successful upgrade.
86 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_host.rb', line 86 attribute :reboot_after_upgrade |
#spm_priority ⇒ Object?
Returns SPM priority of the host. Integer value from 1 to 10, where higher number means higher priority.
47 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_host.rb', line 47 attribute :spm_priority |
#state ⇒ :present, ...
Returns State which should a host to be in after successful completion.,I(iscsilogin) and I(iscsidiscover) are supported since version 2.4.
16 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_host.rb', line 16 attribute :state |
#timeout ⇒ Integer?
Returns The amount of time in seconds the module should wait for the host to get into desired state.
23 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_host.rb', line 23 attribute :timeout |