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

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

Overview

nssm is a service helper which doesn’t suck. See 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 ⇒ Hash?

Returns Parameters to be passed to the application when it starts.

Returns:

  • (Hash, nil) —

    Parameters to be passed to the application when it starts



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

attribute :app_parameters

#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 (git.nssm.cc/?p=nssm.git;a=commit;h=0b386fc1984ab74ee59b7bed14b7e8f57212c22b).

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 (git.nssm.cc/?p=nssm.git;a=commit;h=0b386fc1984ab74ee59b7bed14b7e8f57212c22b)



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

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.



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

attribute :dependencies

#name ⇒ String

Returns Name of the service to operate on.

Returns:

  • (String) —

    Name of the service to operate on



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

attribute :name

#password ⇒ String?

Returns Password to be used for service startup.

Returns:

  • (String, nil) —

    Password to be used for service startup



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

attribute :password

#start_mode ⇒ :auto, ...

Returns If C(auto) is selected, the service will start at bootup. 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, :manual, :disabled) —

    If C(auto) is selected, the service will start at bootup. 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.



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

attribute :start_mode

#state ⇒ :present, ...

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:

  • (:present, :started, :stopped, :restarted, :absent, 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



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

attribute :state

#stderr_file ⇒ String?

Returns Path to receive error output.

Returns:

  • (String, nil) —

    Path to receive error output



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

attribute :stderr_file

#stdout_file ⇒ String?

Returns Path to receive output.

Returns:

  • (String, nil) —

    Path to receive output



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

attribute :stdout_file

#user ⇒ String?

Returns User to be used for service startup.

Returns:

  • (String, nil) —

    User to be used for service startup



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

attribute :user