mirror of
https://github.com/thegeeklab/ansible-later.git
synced 2024-11-16 10:00:39 +00:00
74 lines
3.0 KiB
Python
74 lines
3.0 KiB
Python
|
#!/usr/bin/python
|
||
|
|
# -*- coding: utf-8 -*-
|
||
|
|
|
||
|
|
# Copyright: (c) 2016, Red Hat | Ansible
|
||
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||
|
|
|
||
|
|
# This is a windows documentation stub. Actual code lives in the .ps1
|
||
|
|
# file of the same name
|
||
|
|
|
||
|
|
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||
|
|
'status': ['preview'],
|
||
|
|
'supported_by': 'core'}
|
||
|
|
|
||
|
|
DOCUMENTATION = '''
|
||
|
|
---
|
||
|
|
module: win_path
|
||
|
|
version_added: "2.3"
|
||
|
|
short_description: Manage Windows path environment variables
|
||
|
|
description:
|
||
|
|
- Allows element-based ordering, addition, and removal of Windows path environment variables.
|
||
|
|
options:
|
||
|
|
name:
|
||
|
|
description:
|
||
|
|
- Target path environment variable name.
|
||
|
|
default: PATH
|
||
|
|
elements:
|
||
|
|
description:
|
||
|
|
- A single path element, or a list of path elements (ie, directories) to add or remove.
|
||
|
|
- When multiple elements are included in the list (and C(state) is C(present)), the elements are guaranteed to appear in the same relative order
|
||
|
|
in the resultant path value.
|
||
|
|
- Variable expansions (eg, C(%VARNAME%)) are allowed, and are stored unexpanded in the target path element.
|
||
|
|
- Any existing path elements not mentioned in C(elements) are always preserved in their current order.
|
||
|
|
- New path elements are appended to the path, and existing path elements may be moved closer to the end to satisfy the requested ordering.
|
||
|
|
- Paths are compared in a case-insensitive fashion, and trailing backslashes are ignored for comparison purposes. However, note that trailing
|
||
|
|
backslashes in YAML require quotes.
|
||
|
|
required: yes
|
||
|
|
state:
|
||
|
|
description:
|
||
|
|
- Whether the path elements specified in C(elements) should be present or absent.
|
||
|
|
choices: [ absent, present ]
|
||
|
|
scope:
|
||
|
|
description:
|
||
|
|
- The level at which the environment variable specified by C(name) should be managed (either for the current user or global machine scope).
|
||
|
|
choices: [ machine, user ]
|
||
|
|
default: machine
|
||
|
|
author:
|
||
|
|
- Matt Davis (@nitzmahone)
|
||
|
|
notes:
|
||
|
|
- This module is for modifying indidvidual elements of path-like
|
||
|
|
environment variables. For general-purpose management of other
|
||
|
|
environment vars, use the M(win_environment) module.
|
||
|
|
- This module does not broadcast change events.
|
||
|
|
This means that the minority of windows applications which can have
|
||
|
|
their environment changed without restarting will not be notified and
|
||
|
|
therefore will need restarting to pick up new environment settings.
|
||
|
|
User level environment variables will require an interactive user to
|
||
|
|
log out and in again before they become available.
|
||
|
|
'''
|
||
|
|
|
||
|
|
EXAMPLES = r'''
|
||
|
|
- name: Ensure that system32 and Powershell are present on the global system path, and in the specified order
|
||
|
|
win_path:
|
||
|
|
elements:
|
||
|
|
- '%SystemRoot%\system32'
|
||
|
|
- '%SystemRoot%\system32\WindowsPowerShell\v1.0'
|
||
|
|
|
||
|
|
- name: Ensure that C:\Program Files\MyJavaThing is not on the current user's CLASSPATH
|
||
|
|
win_path:
|
||
|
|
name: CLASSPATH
|
||
|
|
elements: C:\Program Files\MyJavaThing
|
||
|
|
scope: user
|
||
|
|
state: absent
|
||
|
|
'''
|