From 44fa32f2dcba8bcf93a68861434802094555bcfa Mon Sep 17 00:00:00 2001 From: Jon Hawkesworth Date: Fri, 15 May 2015 00:29:53 +0100 Subject: [PATCH 1/2] Add win_environment module --- windows/win_environment.ps1 | 69 ++++++++++++++++++++++++++++++++ windows/win_environment.py | 80 +++++++++++++++++++++++++++++++++++++ 2 files changed, 149 insertions(+) create mode 100644 windows/win_environment.ps1 create mode 100644 windows/win_environment.py diff --git a/windows/win_environment.ps1 b/windows/win_environment.ps1 new file mode 100644 index 00000000000..3dc936f13ff --- /dev/null +++ b/windows/win_environment.ps1 @@ -0,0 +1,69 @@ +#!powershell +# This file is part of Ansible +# +# Copyright 2015, J Hawkesworth @jhawkesworth +# +# 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 . + +# WANT_JSON +# POWERSHELL_COMMON + +$params = Parse-Args $args; +$result = New-Object PSObject; +Set-Attr $result "changed" $false; + +If ($params.state) { + $state = $params.state.ToString().ToLower() + If (($state -ne 'present') -and ($state -ne 'absent') ) { + Fail-Json $result "state is '$state'; must be 'present', or 'absent'" + } +} else { + $state = 'present' +} + +If ($params.name) +{ + $name = $params.name +} else { + Fail-Json $result "missing required argument: name" +} + +$value = $params.value + +If ($params.level) { + $level = $params.level.ToString().ToLower() + If (( $level -ne 'machine') -and ( $level -ne 'user' ) -and ( $level -ne 'process')) { + Fail-Json $result "level is '$level'; must be 'machine', 'user', or 'process'" + } +} + +$before_value = [Environment]::GetEnvironmentVariable($name, $level) + +if ($state -eq "present" ) { + [Environment]::SetEnvironmentVariable($name, $value, $level) +} Elseif ($state -eq "absent") { + [Environment]::SetEnvironmentVariable($name, $null, $level) +} + +$after_value = [Environment]::GetEnvironmentVariable($name, $level) + +Set-Attr $result "name" $name; +Set-Attr $result "before_value" $before_value; +Set-Attr $result "value" $after_value; +Set-Attr $result "level" $level; +if ($before_value -ne $after_value) { + Set-Attr $result "changed" $true; +} + +Exit-Json $result; diff --git a/windows/win_environment.py b/windows/win_environment.py new file mode 100644 index 00000000000..885649c4137 --- /dev/null +++ b/windows/win_environment.py @@ -0,0 +1,80 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +# (c) 2015, Jon Hawkesworth +# +# This file is part of Ansible +# +# 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 . + +# this is a windows documentation stub. actual code lives in the .ps1 +# file of the same name + +DOCUMENTATION = ''' +--- +module: win_environment +version_added: "2.0" +short_description: Modifies environment variables on windows guests +description: + - Uses .net Environment to set or remove environment variables. + - Can set at User, Machine or Process level. + - Note that usual rules apply, so existing environments will not change until new processes are started. +options: + state: + description: + - present to ensure environment variable is set, or absent to ensure it is removed + required: false + default: present + choices: + - present + - absent + name: + description: + - The name of the environment variable + required: true + default: no default + value: + description: + - The value to store in the environment variable. Can be omitted for state=absent + required: false + default: no default + level: + description: + - The level at which to set the environment variable. + - Use 'machine' to set for all users. + - Use 'user' to set for the current user that ansible is connected as. + - Use 'process' to set for the current process. Probably not that useful. + required: true + default: no default + choices: + - machine + - process + - user +author: "Jon Hawkesworth (@jhawkesworth)" +''' + +EXAMPLES = ''' + # Set an environment variable for all users + win_environment: + state: present + name: TestVariable + value: "Test value" + level: machine + # Remove an environment variable for the current users + win_environment: + state: absent + name: TestVariable + level: user +''' + From ccd9a4eb6abd85f62d72a33ca270173ef0703e68 Mon Sep 17 00:00:00 2001 From: Jon Hawkesworth Date: Fri, 15 May 2015 00:40:30 +0100 Subject: [PATCH 2/2] Update attribution --- windows/win_environment.ps1 | 2 +- windows/win_environment.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/windows/win_environment.ps1 b/windows/win_environment.ps1 index 3dc936f13ff..1398524cfbb 100644 --- a/windows/win_environment.ps1 +++ b/windows/win_environment.ps1 @@ -1,7 +1,7 @@ #!powershell # This file is part of Ansible # -# Copyright 2015, J Hawkesworth @jhawkesworth +# Copyright 2015, Jon Hawkesworth (@jhawkesworth) # # Ansible is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by diff --git a/windows/win_environment.py b/windows/win_environment.py index 885649c4137..8d4a1701695 100644 --- a/windows/win_environment.py +++ b/windows/win_environment.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# (c) 2015, Jon Hawkesworth +# (c) 2015, Jon Hawkesworth (@jhawkesworth) # # This file is part of Ansible #