mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 12:50:22 -07:00
win_environment: Added tests and return info in document (#25064)
* win_environment: Added tests and return info in document * fixing up some yaml issues * some more things I should have detected * fixing up test tag name
This commit is contained in:
parent
357069afcb
commit
89caef8fb6
5 changed files with 315 additions and 2 deletions
|
@ -79,15 +79,41 @@ notes:
|
|||
'''
|
||||
|
||||
EXAMPLES = r'''
|
||||
# Set an environment variable for all users
|
||||
- name: 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
|
||||
|
||||
- name: Remove an environment variable for the current user
|
||||
win_environment:
|
||||
state: absent
|
||||
name: TestVariable
|
||||
level: user
|
||||
'''
|
||||
|
||||
RETURN = r'''
|
||||
before_value:
|
||||
description:
|
||||
- the value of the environment key before a change, this is null if it didn't
|
||||
exist
|
||||
returned: always
|
||||
type: string
|
||||
sample: C:\Windows\System32
|
||||
level:
|
||||
description: the level set when calling the module
|
||||
returned: always
|
||||
type: string
|
||||
sample: machine
|
||||
name:
|
||||
description: the name of the environment key the module checked
|
||||
returned: always
|
||||
type: string
|
||||
sample: JAVA_HOME
|
||||
value:
|
||||
description: the value the environment key has been set to
|
||||
returned: always
|
||||
type: string
|
||||
sample: C:\Program Files\jdk1.8
|
||||
'''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue