Class: Ansible::Ruby::Modules::Win_nssm

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/windows/win_nssm.rb

Overview

nssm is a service helper which doesn’t suck. See U(nssm.cc/) for more information.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

#app_parameters ⇒ String?

Returns A string representing a dictionary of parameters to be passed to the application when it starts.,Use either this or C(app_parameters_free_form), not both.

Returns:

  • (String, nil) —

    A string representing a dictionary of parameters to be passed to the application when it starts.,Use either this or C(app_parameters_free_form), not both.



32
 
# File 'lib/ansible/ruby/modules/generated/windows/win_nssm.rb', line 32

attribute :app_parameters

#app_parameters_free_form ⇒ String?

Returns Single string of parameters to be passed to the service.,Use either this or C(app_parameters), not both.

Returns:

  • (String, nil) —

    Single string of parameters to be passed to the service.,Use either this or C(app_parameters), not both.



36
 
# File 'lib/ansible/ruby/modules/generated/windows/win_nssm.rb', line 36

attribute :app_parameters_free_form

#application ⇒ String?

Returns The application binary to run as a service,Specify this whenever the service may need to be installed (state: present, started, stopped, restarted),Note that the application name must look like the following, if the directory includes spaces:,nssm install service “C:\Program Files\app.exe\” “C:\Path with spaces\”,See commit 0b386fc1984ab74ee59b7bed14b7e8f57212c22b in the nssm.git project for more info: U(git.nssm.cc/?p=nssm.git;a=commit;h=0b386fc1984ab74ee59b7bed14b7e8f57212c22b)rn.

Returns:

  • (String, nil) —

    The application binary to run as a service,Specify this whenever the service may need to be installed (state: present, started, stopped, restarted),Note that the application name must look like the following, if the directory includes spaces:,nssm install service “C:\Program Files\app.exe\” “C:\Path with spaces\”,See commit 0b386fc1984ab74ee59b7bed14b7e8f57212c22b in the nssm.git project for more info: U(git.nssm.cc/?p=nssm.git;a=commit;h=0b386fc1984ab74ee59b7bed14b7e8f57212c22b)rn



20
 
# File 'lib/ansible/ruby/modules/generated/windows/win_nssm.rb', line 20

attribute :application

#dependencies ⇒ Array<String>, ...

Returns Service dependencies that has to be started to trigger startup, separated by comma.

Returns:

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

    Service dependencies that has to be started to trigger startup, separated by comma.



40
 
# File 'lib/ansible/ruby/modules/generated/windows/win_nssm.rb', line 40

attribute :dependencies

#name ⇒ String

Returns Name of the service to operate on.

Returns:

  • (String) —

    Name of the service to operate on.



12
 
# File 'lib/ansible/ruby/modules/generated/windows/win_nssm.rb', line 12

attribute :name

#password ⇒ String?

Returns Password to be used for service startup.

Returns:

  • (String, nil) —

    Password to be used for service startup.



48
 
# File 'lib/ansible/ruby/modules/generated/windows/win_nssm.rb', line 48

attribute :password

#start_mode ⇒ :auto, ...

Returns If C(auto) is selected, the service will start at bootup.,C(delayed) causes a delayed but automatic start after boot (added in version 2.5).,C(manual) means that the service will start only when another service needs it.,C(disabled) means that the service will stay off, regardless if it is needed or not.

Returns:

  • (:auto, :delayed, :disabled, :manual, nil) —

    If C(auto) is selected, the service will start at bootup.,C(delayed) causes a delayed but automatic start after boot (added in version 2.5).,C(manual) means that the service will start only when another service needs it.,C(disabled) means that the service will stay off, regardless if it is needed or not.



52
 
# File 'lib/ansible/ruby/modules/generated/windows/win_nssm.rb', line 52

attribute :start_mode

#state ⇒ :absent, ...

Returns State of the service on the system.,Note that NSSM actions like “pause”, “continue”, “rotate” do not fit the declarative style of ansible, so these should be implemented via the ansible command module.

Returns:

  • (:absent, :present, :started, :stopped, :restarted, nil) —

    State of the service on the system.,Note that NSSM actions like “pause”, “continue”, “rotate” do not fit the declarative style of ansible, so these should be implemented via the ansible command module.



16
 
# File 'lib/ansible/ruby/modules/generated/windows/win_nssm.rb', line 16

attribute :state

#stderr_file ⇒ String?

Returns Path to receive error output.

Returns:

  • (String, nil) —

    Path to receive error output.



28
 
# File 'lib/ansible/ruby/modules/generated/windows/win_nssm.rb', line 28

attribute :stderr_file

#stdout_file ⇒ String?

Returns Path to receive output.

Returns:

  • (String, nil) —

    Path to receive output.



24
 
# File 'lib/ansible/ruby/modules/generated/windows/win_nssm.rb', line 24

attribute :stdout_file

#user ⇒ String?

Returns User to be used for service startup.

Returns:

  • (String, nil) —

    User to be used for service startup.



44
 
# File 'lib/ansible/ruby/modules/generated/windows/win_nssm.rb', line 44

attribute :user