Class: Ansible::Ruby::Modules::Nosh

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/system/nosh.rb

Overview

Control running and enabled state for system-wide or user services. BSD and Linux systems are supported.

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

#enabled ⇒ Symbol?

Returns Enable or disable the service, independently of C(*.preset) file preference or running state. Mutually exclusive with I(preset). Will take effect prior to I(state=reset).

Returns:

  • (Symbol, nil) —

    Enable or disable the service, independently of C(*.preset) file preference or running state. Mutually exclusive with I(preset). Will take effect prior to I(state=reset).



21
 
# File 'lib/ansible/ruby/modules/generated/system/nosh.rb', line 21

attribute :enabled

#name ⇒ String

Returns Name of the service to manage.

Returns:

  • (String) —

    Name of the service to manage.



13
 
# File 'lib/ansible/ruby/modules/generated/system/nosh.rb', line 13

attribute :name

#preset ⇒ Symbol?

Returns Enable or disable the service according to local preferences in *.preset files. Mutually exclusive with I(enabled). Only has an effect if set to true. Will take effect prior to I(state=reset).

Returns:

  • (Symbol, nil) —

    Enable or disable the service according to local preferences in *.preset files. Mutually exclusive with I(enabled). Only has an effect if set to true. Will take effect prior to I(state=reset).



25
 
# File 'lib/ansible/ruby/modules/generated/system/nosh.rb', line 25

attribute :preset

#state ⇒ :started, ...

Returns C(started)/C(stopped) are idempotent actions that will not run commands unless necessary. C(restarted) will always bounce the service. C(reloaded) will send a SIGHUP or start the service. C(reset) will start or stop the service according to whether it is enabled or not.

Returns:

  • (:started, :stopped, :reset, :restarted, :reloaded, nil) —

    C(started)/C(stopped) are idempotent actions that will not run commands unless necessary. C(restarted) will always bounce the service. C(reloaded) will send a SIGHUP or start the service. C(reset) will start or stop the service according to whether it is enabled or not.



17
 
# File 'lib/ansible/ruby/modules/generated/system/nosh.rb', line 17

attribute :state

#user ⇒ :yes, ...

Returns Run system-control talking to the calling user’s service manager, rather than the system-wide service manager.

Returns:

  • (:yes, :no, nil) —

    Run system-control talking to the calling user’s service manager, rather than the system-wide service manager.



29
 
# File 'lib/ansible/ruby/modules/generated/system/nosh.rb', line 29

attribute :user