Class: Ansible::Ruby::Modules::Vmware_host_service_manager

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

Overview

This module can be used to manage (start, stop, restart) services on a given ESXi host. If cluster_name is provided, specified service will be managed on all ESXi host belonging to that cluster. If specific esxi_hostname is provided, then specified service will be managed on given ESXi host only.

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

#cluster_name ⇒ String?

Returns Name of the cluster.,Service settings are applied to every ESXi host system/s in given cluster.,If C(esxi_hostname) is not given, this parameter is required.

Returns:

  • (String, nil) —

    Name of the cluster.,Service settings are applied to every ESXi host system/s in given cluster.,If C(esxi_hostname) is not given, this parameter is required.



14
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_host_service_manager.rb', line 14

attribute :cluster_name

#esxi_hostname ⇒ String?

Returns ESXi hostname.,Service settings are applied to this ESXi host system.,If C(cluster_name) is not given, this parameter is required.

Returns:

  • (String, nil) —

    ESXi hostname.,Service settings are applied to this ESXi host system.,If C(cluster_name) is not given, this parameter is required.



18
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_host_service_manager.rb', line 18

attribute :esxi_hostname

#service_name ⇒ String

Returns Name of Service to be managed. This is brief identifier for the service, for example, ntpd, vxsyslogd etc.,This value should be a valid ESXi service name.

Returns:

  • (String) —

    Name of Service to be managed. This is brief identifier for the service, for example, ntpd, vxsyslogd etc.,This value should be a valid ESXi service name.



30
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_host_service_manager.rb', line 30

attribute :service_name

#service_policy ⇒ :automatic, ...

Returns Set of valid service policy strings.,If set C(on), then service should be started when the host starts up.,If set C(automatic), then service should run if and only if it has open firewall ports.,If set C(off), then Service should not be started when the host starts up.

Returns:

  • (:automatic, :off, :on, nil) —

    Set of valid service policy strings.,If set C(on), then service should be started when the host starts up.,If set C(automatic), then service should run if and only if it has open firewall ports.,If set C(off), then Service should not be started when the host starts up.



26
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_host_service_manager.rb', line 26

attribute :service_policy

#state ⇒ :absent, ...

Returns Desired state of service.,State value ‘start’ and ‘present’ has same effect.,State value ‘stop’ and ‘absent’ has same effect.

Returns:

  • (:absent, :present, :restart, :start, :stop, nil) —

    Desired state of service.,State value ‘start’ and ‘present’ has same effect.,State value ‘stop’ and ‘absent’ has same effect.



22
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_host_service_manager.rb', line 22

attribute :state