mirror of https://github.com/ansible/ansible.git
win_environment: Make this the Windows reference module
As discussed before we selected win_environment to the documentation, and point to win_uri for a more advanced module. If we want to make this the reference module, we have to get this one absolutely right in every possible way. This PR cleans up both win_environment and win_uri, and makes the required changes to the windows module development section.pull/30670/head
Dag Wieers
7 years ago
parent
9f4d73b699
commit
31e7d735a3
@ -1,86 +1,67 @@
|
||||
#!powershell
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# Copyright 2015, Jon Hawkesworth (@jhawkesworth) <figs@unity.demon.co.uk>
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
# WANT_JSON
|
||||
# POWERSHELL_COMMON
|
||||
|
||||
$params = Parse-Args $args -supports_check_mode $true
|
||||
|
||||
# Copyright: (c) 2015, Jon Hawkesworth (@jhawkesworth) <figs@unity.demon.co.uk>
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
#Requires -Module Ansible.ModuleUtils.Legacy.psm1
|
||||
|
||||
$ErrorActionPreference = "Stop"
|
||||
|
||||
$params = Parse-Args -arguments $args -supports_check_mode $true
|
||||
$check_mode = Get-AnsibleParam -obj $params -name "_ansible_check_mode" -type "bool" -default $false
|
||||
$diff_support = Get-AnsibleParam -obj $params -name "_ansible_diff" -type "bool" -default $false
|
||||
$diff_mode = Get-AnsibleParam -obj $params -name "_ansible_diff" -type "bool" -default $false
|
||||
|
||||
$name = Get-AnsibleParam -obj $params -name "name" -type "str" -failifempty $true
|
||||
$state = Get-AnsibleParam -obj $params -name "state" -type "str" -default "present" -validateset "present","absent"
|
||||
$state = Get-AnsibleParam -obj $params -name "state" -type "str" -default "present" -validateset "absent","present"
|
||||
$value = Get-AnsibleParam -obj $params -name "value" -type "str"
|
||||
$level = Get-AnsibleParam -obj $params -name "level" -type "str" -validateSet "machine","user","process" -failifempty $true
|
||||
|
||||
$before_value = [Environment]::GetEnvironmentVariable($name, $level)
|
||||
|
||||
# When removing environment, set value to $null if set
|
||||
if ($state -eq "absent" -and $value) {
|
||||
$value = $null
|
||||
}
|
||||
|
||||
$result = @{
|
||||
before_value = $before_value
|
||||
changed = $false
|
||||
level = $level
|
||||
name = $name
|
||||
value = $value
|
||||
}
|
||||
|
||||
if ($diff_support) {
|
||||
$result.diff = @{}
|
||||
# When removing environment, set value to $null if set
|
||||
if ($state -eq "absent" -and $value) {
|
||||
Add-Warning -obj $result -message "When removing environment variable '$name' it should not have a value '$value' set"
|
||||
$value = $null
|
||||
}
|
||||
|
||||
if ($state -eq "present" -and $before_value -ne $value) {
|
||||
|
||||
if (-not $check_mode) {
|
||||
[Environment]::SetEnvironmentVariable($name, $value, $level)
|
||||
}
|
||||
$result.changed = $true
|
||||
|
||||
if ($diff_support) {
|
||||
if ($diff_mode) {
|
||||
if ($before_value -eq $null) {
|
||||
$result.diff.prepared = @"
|
||||
[$level]
|
||||
+$NAME = $value
|
||||
"@
|
||||
$result.diff = @{
|
||||
prepared = " [$level]`n+$name = $value`n"
|
||||
}
|
||||
} else {
|
||||
$result.diff.prepared = @"
|
||||
[$level]
|
||||
-$NAME = $before_value
|
||||
+$NAME = $value
|
||||
"@
|
||||
$result.diff = @{
|
||||
prepared = " [$level]`n-$name = $before_value`n+$name = $value`n"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
} elseif ($state -eq "absent" -and $before_value -ne $null) {
|
||||
|
||||
if (-not $check_mode) {
|
||||
[Environment]::SetEnvironmentVariable($name, $null, $level)
|
||||
}
|
||||
$result.changed = $true
|
||||
|
||||
if ($diff_support) {
|
||||
$result.diff.prepared = @"
|
||||
[$level]
|
||||
-$NAME = $before_value
|
||||
"@
|
||||
if ($diff_mode) {
|
||||
$result.diff = @{
|
||||
prepared = " [$level]`n-$name = $before_value`n"
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
Exit-Json $result
|
||||
Exit-Json -obj $result
|
||||
|
||||
Loading…
Reference in New Issue