cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

win_nssm: Clean up parameter handling + docs (#21625)

Browse source
This commit is contained in:
Dag Wieers 2017-02-24 08:14:12 +01:00 committed by Matt Davis
parent 58cbf1bfe0
commit ff1efb2c1c
2 changed files with 105 additions and 116 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

175
lib/ansible/modules/windows/win_nssm.ps1
View file

@ -23,25 +23,26 @@ $ErrorActionPreference = "Stop"
# WANT_JSON # WANT_JSON
# POWERSHELL_COMMON # POWERSHELL_COMMON
$params = Parse-Args $args; $params = Parse-Args $args
$result = New-Object PSObject; $result = @{
Set-Attr $result "changed" $false; changed = $false
}
$name = Get-Attr $params "name" -failifempty $true $name = Get-AnsibleParam -obj $params -name "name" -type "str" -failifempty $true
$state = Get-Attr $params "state" -default "present" -validateSet "present", "absent", "started", "stopped", "restarted" -resultobj $result $state = Get-AnsibleParam -obj $params -name "state" -type "str" -default "present" -validateset "present","absent","started","stopped","restarted" -resultobj $result
$application = Get-Attr $params "application" -default $null $application = Get-AnsibleParam -obj $params -name "application" -type "str"
$appParameters = Get-Attr $params "app_parameters" -default $null $appParameters = Get-AnsibleParam -obj $params -name "app_parameters" -type "str"
$appParametersFree = Get-Attr $params "app_parameters_free_form" -default $null $appParametersFree = Get-AnsibleParam -obj $params -name "app_parameters_free_form" -type "str"
$startMode = Get-Attr $params "start_mode" -default "auto" -validateSet "auto", "manual", "disabled" -resultobj $result $startMode = Get-AnsibleParam -obj $params -name "start_mode" -type "str" -default "auto" -validateset "auto","manual","disabled" -resultobj $result
$stdoutFile = Get-Attr $params "stdout_file" -default $null $stdoutFile = Get-AnsibleParam -obj $params -name "stdout_file" -type "str"
$stderrFile = Get-Attr $params "stderr_file" -default $null $stderrFile = Get-AnsibleParam -obj $params -name "stderr_file" -type "str"
$dependencies = Get-Attr $params "dependencies" -default $null $dependencies = Get-AnsibleParam -obj $params -name "dependencies" -type "str"
$user = Get-Attr $params "user" -default $null $user = Get-AnsibleParam -obj $params -name "user" -type "str"
$password = Get-Attr $params "password" -default $null $password = Get-AnsibleParam -obj $params -name "password" -type "str"
if (($appParameters -ne $null) -and ($appParametersFree -ne $null)) if (($appParameters -ne $null) -and ($appParametersFree -ne $null))
{ {
@ -103,12 +104,12 @@ Function Nssm-Remove
if ($LastExitCode -ne 0) if ($LastExitCode -ne 0)
{ {
Set-Attr $result "nssm_error_cmd" $cmd $result.nssm_error_cmd = $cmd
Set-Attr $result "nssm_error_log" "$results" $result.nssm_error_log = "$results"
Throw "Error removing service ""$name""" Throw "Error removing service ""$name"""
} }
Set-Attr $result "changed_by" "remove_service" $result.changed_by = "remove_service"
$result.changed = $true $result.changed = $true
} }
} }
@ -138,21 +139,21 @@ Function Nssm-Install
if ($LastExitCode -ne 0) if ($LastExitCode -ne 0)
{ {
Set-Attr $result "nssm_error_cmd" $cmd $result.nssm_error_cmd = $cmd
Set-Attr $result "nssm_error_log" "$results" $result.nssm_error_log = "$results"
Throw "Error installing service ""$name""" Throw "Error installing service ""$name"""
} }
Set-Attr $result "changed_by" "install_service" $result.changed_by = "install_service"
$result.changed = $true $result.changed = $true
} else { } else {
$results = Nssm-Invoke "get ""$name"" Application" $results = Nssm-Invoke "get ""$name"" Application"
if ($LastExitCode -ne 0) if ($LastExitCode -ne 0)
{ {
Set-Attr $result "nssm_error_cmd" $cmd $result.nssm_error_cmd = $cmd
Set-Attr $result "nssm_error_log" "$results" $result.nssm_error_log = "$results"
Throw "Error installing service ""$name""" Throw "Error installing service ""$name"""
} }
@ -164,13 +165,13 @@ Function Nssm-Install
if ($LastExitCode -ne 0) if ($LastExitCode -ne 0)
{ {
Set-Attr $result "nssm_error_cmd" $cmd $result.nssm_error_cmd = $cmd
Set-Attr $result "nssm_error_log" "$results" $result.nssm_error_log = "$results"
Throw "Error installing service ""$name""" Throw "Error installing service ""$name"""
} }
Set-Attr $result "application" "$application" $result.application = "$application"
Set-Attr $result "changed_by" "reinstall_service" $result.changed_by = "reinstall_service"
$result.changed = $true $result.changed = $true
} }
} }
@ -184,8 +185,8 @@ Function Nssm-Install
if ($LastExitCode -ne 0) if ($LastExitCode -ne 0)
{ {
Set-Attr $result "nssm_error_cmd" $cmd $result.nssm_error_cmd = $cmd
Set-Attr $result "nssm_error_log" "$results" $result.nssm_error_log = "$results"
Throw "Error installing service ""$name""" Throw "Error installing service ""$name"""
} }
} }
@ -223,15 +224,15 @@ Function Nssm-Update-AppParameters
if ($LastExitCode -ne 0) if ($LastExitCode -ne 0)
{ {
Set-Attr $result "nssm_error_cmd" $cmd $result.nssm_error_cmd = $cmd
Set-Attr $result "nssm_error_log" "$results" $result.nssm_error_log = "$results"
Throw "Error updating AppParameters for service ""$name""" Throw "Error updating AppParameters for service ""$name"""
} }
$appParamKeys = @() $appParamKeys = @()
$appParamVals = @() $appParamVals = @()
$singleLineParams = "" $singleLineParams = ""
if ($appParameters) if ($appParameters)
{ {
$appParametersHash = ParseAppParameters -appParameters $appParameters $appParametersHash = ParseAppParameters -appParameters $appParameters
@ -250,17 +251,17 @@ Function Nssm-Update-AppParameters
} }
} }
Set-Attr $result "nssm_app_parameters_parsed" $appParametersHash $result.nssm_app_parameters_parsed = $appParametersHash
Set-Attr $result "nssm_app_parameters_keys" $appParamKeys $result.nssm_app_parameters_keys = $appParamKeys
Set-Attr $result "nssm_app_parameters_vals" $appParamVals $result.nssm_app_parameters_vals = $appParamVals
} }
elseif ($appParametersFree) { elseif ($appParametersFree) {
Set-Attr $result "nssm_app_parameters_free_form" $appParametersFree $result.nssm_app_parameters_free_form = $appParametersFree
$singleLineParams = $appParametersFree $singleLineParams = $appParametersFree
} }
Set-Attr $result "nssm_app_parameters" $appParameters $result.nssm_app_parameters = $appParameters
Set-Attr $result "nssm_single_line_app_parameters" $singleLineParams $result.nssm_single_line_app_parameters = $singleLineParams
if ($results -ne $singleLineParams) if ($results -ne $singleLineParams)
{ {
@ -274,12 +275,12 @@ Function Nssm-Update-AppParameters
if ($LastExitCode -ne 0) if ($LastExitCode -ne 0)
{ {
Set-Attr $result "nssm_error_cmd" $cmd $result.nssm_error_cmd = $cmd
Set-Attr $result "nssm_error_log" "$results" $result.nssm_error_log = "$results"
Throw "Error updating AppParameters for service ""$name""" Throw "Error updating AppParameters for service ""$name"""
} }
Set-Attr $result "changed_by" "update_app_parameters" $result.changed_by = "update_app_parameters"
$result.changed = $true $result.changed = $true
} }
} }
@ -299,8 +300,8 @@ Function Nssm-Set-Output-Files
if ($LastExitCode -ne 0) if ($LastExitCode -ne 0)
{ {
Set-Attr $result "nssm_error_cmd" $cmd $result.nssm_error_cmd = $cmd
Set-Attr $result "nssm_error_log" "$results" $result.nssm_error_log = "$results"
Throw "Error retrieving existing stdout file for service ""$name""" Throw "Error retrieving existing stdout file for service ""$name"""
} }
@ -310,19 +311,19 @@ Function Nssm-Set-Output-Files
{ {
$cmd = "reset ""$name"" AppStdout" $cmd = "reset ""$name"" AppStdout"
} else { } else {
$cmd = "set ""$name"" AppStdout $stdout" $cmd = "set ""$name"" AppStdout $stdout"
} }
$results = Nssm-Invoke $cmd $results = Nssm-Invoke $cmd
if ($LastExitCode -ne 0) if ($LastExitCode -ne 0)
{ {
Set-Attr $result "nssm_error_cmd" $cmd $result.nssm_error_cmd = $cmd
Set-Attr $result "nssm_error_log" "$results" $result.nssm_error_log = "$results"
Throw "Error setting stdout file for service ""$name""" Throw "Error setting stdout file for service ""$name"""
} }
Set-Attr $result "changed_by" "set_stdout" $result.changed_by = "set_stdout"
$result.changed = $true $result.changed = $true
} }
@ -331,8 +332,8 @@ Function Nssm-Set-Output-Files
if ($LastExitCode -ne 0) if ($LastExitCode -ne 0)
{ {
Set-Attr $result "nssm_error_cmd" $cmd $result.nssm_error_cmd = $cmd
Set-Attr $result "nssm_error_log" "$results" $result.nssm_error_log = "$results"
Throw "Error retrieving existing stderr file for service ""$name""" Throw "Error retrieving existing stderr file for service ""$name"""
} }
@ -345,8 +346,8 @@ Function Nssm-Set-Output-Files
if ($LastExitCode -ne 0) if ($LastExitCode -ne 0)
{ {
Set-Attr $result "nssm_error_cmd" $cmd $result.nssm_error_cmd = $cmd
Set-Attr $result "nssm_error_log" "$results" $result.nssm_error_log = "$results"
Throw "Error clearing stderr file setting for service ""$name""" Throw "Error clearing stderr file setting for service ""$name"""
} }
} else { } else {
@ -355,13 +356,13 @@ Function Nssm-Set-Output-Files
if ($LastExitCode -ne 0) if ($LastExitCode -ne 0)
{ {
Set-Attr $result "nssm_error_cmd" $cmd $result.nssm_error_cmd = $cmd
Set-Attr $result "nssm_error_log" "$results" $result.nssm_error_log = "$results"
Throw "Error setting stderr file for service ""$name""" Throw "Error setting stderr file for service ""$name"""
} }
} }
Set-Attr $result "changed_by" "set_stderr" $result.changed_by = "set_stderr"
$result.changed = $true $result.changed = $true
} }
@ -411,8 +412,8 @@ Function Nssm-Update-Credentials
if ($LastExitCode -ne 0) if ($LastExitCode -ne 0)
{ {
Set-Attr $result "nssm_error_cmd" $cmd $result.nssm_error_cmd = $cmd
Set-Attr $result "nssm_error_log" "$results" $result.nssm_error_log = "$results"
Throw "Error updating credentials for service ""$name""" Throw "Error updating credentials for service ""$name"""
} }
@ -432,12 +433,12 @@ Function Nssm-Update-Credentials
if ($LastExitCode -ne 0) if ($LastExitCode -ne 0)
{ {
Set-Attr $result "nssm_error_cmd" $cmd $result.nssm_error_cmd = $cmd
Set-Attr $result "nssm_error_log" "$results" $result.nssm_error_log = "$results"
Throw "Error updating credentials for service ""$name""" Throw "Error updating credentials for service ""$name"""
} }
Set-Attr $result "changed_by" "update_credentials" $result.changed_by = "update_credentials"
$result.changed = $true $result.changed = $true
} }
} }
@ -459,8 +460,8 @@ Function Nssm-Update-Dependencies
if ($LastExitCode -ne 0) if ($LastExitCode -ne 0)
{ {
Set-Attr $result "nssm_error_cmd" $cmd $result.nssm_error_cmd = $cmd
Set-Attr $result "nssm_error_log" "$results" $result.nssm_error_log = "$results"
Throw "Error updating dependencies for service ""$name""" Throw "Error updating dependencies for service ""$name"""
} }
@ -470,12 +471,12 @@ Function Nssm-Update-Dependencies
if ($LastExitCode -ne 0) if ($LastExitCode -ne 0)
{ {
Set-Attr $result "nssm_error_cmd" $cmd $result.nssm_error_cmd = $cmd
Set-Attr $result "nssm_error_log" "$results" $result.nssm_error_log = "$results"
Throw "Error updating dependencies for service ""$name""" Throw "Error updating dependencies for service ""$name"""
} }
Set-Attr $result "changed_by" "update-dependencies" $result.changed_by = "update-dependencies"
$result.changed = $true $result.changed = $true
} }
} }
@ -495,8 +496,8 @@ Function Nssm-Update-StartMode
if ($LastExitCode -ne 0) if ($LastExitCode -ne 0)
{ {
Set-Attr $result "nssm_error_cmd" $cmd $result.nssm_error_cmd = $cmd
Set-Attr $result "nssm_error_log" "$results" $result.nssm_error_log = "$results"
Throw "Error updating start mode for service ""$name""" Throw "Error updating start mode for service ""$name"""
} }
@ -508,12 +509,12 @@ Function Nssm-Update-StartMode
if ($LastExitCode -ne 0) if ($LastExitCode -ne 0)
{ {
Set-Attr $result "nssm_error_cmd" $cmd $result.nssm_error_cmd = $cmd
Set-Attr $result "nssm_error_log" "$results" $result.nssm_error_log = "$results"
Throw "Error updating start mode for service ""$name""" Throw "Error updating start mode for service ""$name"""
} }
Set-Attr $result "changed_by" "start_mode" $result.changed_by = "start_mode"
$result.changed = $true $result.changed = $true
} }
} }
@ -544,8 +545,8 @@ Function Nssm-Start
if ($LastExitCode -ne 0) if ($LastExitCode -ne 0)
{ {
Set-Attr $result "nssm_error_cmd" $cmd $result.nssm_error_cmd = $cmd
Set-Attr $result "nssm_error_log" "$results" $result.nssm_error_log = "$results"
Throw "Error starting service ""$name""" Throw "Error starting service ""$name"""
} }
@ -553,7 +554,7 @@ Function Nssm-Start
{ {
"SERVICE_RUNNING" { <# Nothing to do #> } "SERVICE_RUNNING" { <# Nothing to do #> }
"SERVICE_STOPPED" { Nssm-Start-Service-Command -name $name } "SERVICE_STOPPED" { Nssm-Start-Service-Command -name $name }
"SERVICE_CONTINUE_PENDING" { Nssm-Stop-Service-Command -name $name; Nssm-Start-Service-Command -name $name } "SERVICE_CONTINUE_PENDING" { Nssm-Stop-Service-Command -name $name; Nssm-Start-Service-Command -name $name }
"SERVICE_PAUSE_PENDING" { Nssm-Stop-Service-Command -name $name; Nssm-Start-Service-Command -name $name } "SERVICE_PAUSE_PENDING" { Nssm-Stop-Service-Command -name $name; Nssm-Start-Service-Command -name $name }
"SERVICE_PAUSED" { Nssm-Stop-Service-Command -name $name; Nssm-Start-Service-Command -name $name } "SERVICE_PAUSED" { Nssm-Stop-Service-Command -name $name; Nssm-Start-Service-Command -name $name }
@ -576,12 +577,12 @@ Function Nssm-Start-Service-Command
if ($LastExitCode -ne 0) if ($LastExitCode -ne 0)
{ {
Set-Attr $result "nssm_error_cmd" $cmd $result.nssm_error_cmd = $cmd
Set-Attr $result "nssm_error_log" "$results" $result.nssm_error_log = "$results"
Throw "Error starting service ""$name""" Throw "Error starting service ""$name"""
} }
Set-Attr $result "changed_by" "start_service" $result.changed_by = "start_service"
$result.changed = $true $result.changed = $true
} }
@ -599,12 +600,12 @@ Function Nssm-Stop-Service-Command
if ($LastExitCode -ne 0) if ($LastExitCode -ne 0)
{ {
Set-Attr $result "nssm_error_cmd" $cmd $result.nssm_error_cmd = $cmd
Set-Attr $result "nssm_error_log" "$results" $result.nssm_error_log = "$results"
Throw "Error stopping service ""$name""" Throw "Error stopping service ""$name"""
} }
Set-Attr $result "changed_by" "stop_service_command" $result.changed_by = "stop_service_command"
$result.changed = $true $result.changed = $true
} }
@ -620,8 +621,8 @@ Function Nssm-Stop
if ($LastExitCode -ne 0) if ($LastExitCode -ne 0)
{ {
Set-Attr $result "nssm_error_cmd" $cmd $result.nssm_error_cmd = $cmd
Set-Attr $result "nssm_error_log" "$results" $result.nssm_error_log = "$results"
Throw "Error stopping service ""$name""" Throw "Error stopping service ""$name"""
} }
@ -633,12 +634,12 @@ Function Nssm-Stop
if ($LastExitCode -ne 0) if ($LastExitCode -ne 0)
{ {
Set-Attr $result "nssm_error_cmd" $cmd $result.nssm_error_cmd = $cmd
Set-Attr $result "nssm_error_log" "$results" $result.nssm_error_log = "$results"
Throw "Error stopping service ""$name""" Throw "Error stopping service ""$name"""
} }
Set-Attr $result "changed_by" "stop_service" $result.changed_by = "stop_service"
$result.changed = $true $result.changed = $true
} }
} }
@ -669,7 +670,9 @@ Try
{ {
switch ($state) switch ($state)
{ {
"absent" { Nssm-Remove -name $name } "absent" {
Nssm-Remove -name $name
}
"present" { "present" {
NssmProcedure NssmProcedure
} }
@ -687,7 +690,7 @@ Try
} }
} }
Exit-Json $result; Exit-Json $result
} }
Catch Catch
{ {

46
lib/ansible/modules/windows/win_nssm.py
View file

@ -31,7 +31,7 @@ module: win_nssm
version_added: "2.0" version_added: "2.0"
short_description: NSSM - the Non-Sucking Service Manager short_description: NSSM - the Non-Sucking Service Manager
description: description:
- nssm is a service helper which doesn't suck. See https://nssm.cc/ for more information. - nssm is a service helper which doesn't suck. See U(https://nssm.cc/) for more information.
requirements: requirements:
- "nssm >= 2.24.0 # (install via win_chocolatey) win_chocolatey: name=nssm" - "nssm >= 2.24.0 # (install via win_chocolatey) win_chocolatey: name=nssm"
options: options:
@ -43,7 +43,6 @@ options:
description: description:
- State of the service on the system - 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 - 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
required: false
choices: choices:
- present - present
- started - started
@ -57,47 +56,34 @@ options:
- "Specify this whenever the service may need to be installed (state: present, started, stopped, restarted)" - "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:" - "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\\"' - 'nssm install service "c:\\Program Files\\app.exe\\" "C:\\Path with spaces\\"'
- "See commit 0b386fc1984ab74ee59b7bed14b7e8f57212c22b in the nssm.git project for more info (https://git.nssm.cc/?p=nssm.git;a=commit;h=0b386fc1984ab74ee59b7bed14b7e8f57212c22b)" - "See commit 0b386fc1984ab74ee59b7bed14b7e8f57212c22b in the nssm.git project for more info: U(https://git.nssm.cc/?p=nssm.git;a=commit;h=0b386fc1984ab74ee59b7bed14b7e8f57212c22b)"
required: false
default: null
stdout_file: stdout_file:
description: description:
- Path to receive output - Path to receive output
required: false
default: null
stderr_file: stderr_file:
description: description:
- Path to receive error output - Path to receive error output
required: false
default: null
app_parameters: app_parameters:
description: description:
- Parameters to be passed to the application when it starts - Parameters to be passed to the application when it starts.
required: false - Use either this or C(app_parameters_free_form), not both
default: null
app_parameters_free_form: app_parameters_free_form:
version_added: "2.3.0" version_added: "2.3.0"
description: description:
- Single string of parameters to be passed to the service. Use either this or 'app_parameters', not both - Single string of parameters to be passed to the service.
- Use either this or C(app_parameters), not both
dependencies: dependencies:
description: description:
- Service dependencies that has to be started to trigger startup, separated by comma. - Service dependencies that has to be started to trigger startup, separated by comma.
required: false
default: null
user: user:
description: description:
- User to be used for service startup - User to be used for service startup
required: false
default: null
password: password:
description: description:
- Password to be used for service startup - Password to be used for service startup
required: false
default: null
start_mode: start_mode:
description: description:
- 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. - 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.
required: true
default: auto default: auto
choices: choices:
- auto - auto
@ -121,7 +107,7 @@ EXAMPLES = r'''
name: foo name: foo
application: C:\windows\foo.exe application: C:\windows\foo.exe
app_parameters: app_parameters:
bar: true bar: true
# Install and start the foo service with a key-value pair argument, where the argument needs to start with a dash # Install and start the foo service with a key-value pair argument, where the argument needs to start with a dash
# This will yield the following command: C:\windows\\foo.exe -bar "true" # This will yield the following command: C:\windows\\foo.exe -bar "true"
@ -129,7 +115,7 @@ EXAMPLES = r'''
name: foo name: foo
application: C:\windows\foo.exe application: C:\windows\foo.exe
app_parameters: app_parameters:
"-bar": true "-bar": true
# Install and start the foo service with a single parameter # Install and start the foo service with a single parameter
# This will yield the following command: C:\windows\\foo.exe bar # This will yield the following command: C:\windows\\foo.exe bar
@ -137,7 +123,7 @@ EXAMPLES = r'''
name: foo name: foo
application: C:\windows\foo.exe application: C:\windows\foo.exe
app_parameters: app_parameters:
_: bar _: bar
# Install and start the foo service with a mix of single params, and key value pairs # Install and start the foo service with a mix of single params, and key value pairs
# This will yield the following command: C:\windows\\foo.exe bar -file output.bat # This will yield the following command: C:\windows\\foo.exe bar -file output.bat
@ -145,18 +131,18 @@ EXAMPLES = r'''
name: foo name: foo
application: C:\windows\foo.exe application: C:\windows\foo.exe
app_parameters: app_parameters:
_: bar _: bar
"-file": "output.bat" "-file": "output.bat"
# Use the single line parameters option to specify an arbitrary string of parameters # Use the single line parameters option to specify an arbitrary string of parameters
# for the service executable # for the service executable
- name: Make sure the Consul service runs - name: Make sure the Consul service runs
win_nssm: win_nssm:
name: consul name: consul
application: "C:\\consul\\consul.exe" application: C:\consul\consul.exe
app_parameters_free_form: "agent -config-dir=C:\\consul\\config" app_parameters_free_form: agent -config-dir=C:\consul\config
stdout_file: "C:\\consul\\log.txt" stdout_file: C:\consul\log.txt
stderr_file: "C:\\consul\\error.txt" stderr_file: C:\consul\error.txt
# Install and start the foo service, redirecting stdout and stderr to the same file # Install and start the foo service, redirecting stdout and stderr to the same file
- win_nssm: - win_nssm: