mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-08 06:12:51 +00:00
Windows: Add missing parameter types and doc fixes (#50232)
* Windows: Add missing parameter types and doc fixes This PR includes: - Adding missing parameter types - Various documentation fixes * Update lib/ansible/modules/windows/win_copy.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_credential.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_domain_computer.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_domain_user.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_environment.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_psexec.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_uri.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_wait_for.py Co-Authored-By: dagwieers <dag@wieers.com> * Ensure docstrings are raw strings
This commit is contained in:
committed by
Alicia Cozine
parent
f80ce60cf9
commit
d863027159
@@ -14,14 +14,15 @@ module: win_psexec
|
||||
version_added: '2.3'
|
||||
short_description: Runs commands (remotely) as another (privileged) user
|
||||
description:
|
||||
- Run commands (remotely) through the PsExec service
|
||||
- Run commands as another (domain) user (with elevated privileges)
|
||||
- Run commands (remotely) through the PsExec service.
|
||||
- Run commands as another (domain) user (with elevated privileges).
|
||||
requirements:
|
||||
- Microsoft PsExec
|
||||
options:
|
||||
command:
|
||||
description:
|
||||
- The command line to run through PsExec (limited to 260 characters).
|
||||
type: str
|
||||
required: yes
|
||||
executable:
|
||||
description:
|
||||
@@ -37,10 +38,12 @@ options:
|
||||
description:
|
||||
- The (remote) user to run the command as.
|
||||
- If not provided, the current user is used.
|
||||
type: str
|
||||
password:
|
||||
description:
|
||||
- The password for the (remote) user to run the command as.
|
||||
- This is mandatory in order authenticate yourself.
|
||||
type: str
|
||||
chdir:
|
||||
description:
|
||||
- Run the command from this (remote) directory.
|
||||
@@ -50,23 +53,23 @@ options:
|
||||
- Do not display the startup banner and copyright message.
|
||||
- This only works for specific versions of the PsExec binary.
|
||||
type: bool
|
||||
default: 'no'
|
||||
default: no
|
||||
version_added: '2.4'
|
||||
noprofile:
|
||||
description:
|
||||
- Run the command without loading the account's profile.
|
||||
type: bool
|
||||
default: 'no'
|
||||
default: no
|
||||
elevated:
|
||||
description:
|
||||
- Run the command with elevated privileges.
|
||||
type: bool
|
||||
default: 'no'
|
||||
default: no
|
||||
interactive:
|
||||
description:
|
||||
- Run the program so that it interacts with the desktop on the remote system.
|
||||
type: bool
|
||||
default: 'no'
|
||||
default: no
|
||||
session:
|
||||
description:
|
||||
- Specifies the session ID to use.
|
||||
@@ -78,22 +81,16 @@ options:
|
||||
description:
|
||||
- Run the command as limited user (strips the Administrators group and allows only privileges assigned to the Users group).
|
||||
type: bool
|
||||
default: 'no'
|
||||
default: no
|
||||
system:
|
||||
description:
|
||||
- Run the remote command in the System account.
|
||||
type: bool
|
||||
default: 'no'
|
||||
default: no
|
||||
priority:
|
||||
description:
|
||||
- Used to run the command at a different priority.
|
||||
choices:
|
||||
- background
|
||||
- low
|
||||
- belownormal
|
||||
- abovenormal
|
||||
- high
|
||||
- realtime
|
||||
choices: [ abovenormal, background, belownormal, high, low, realtime ]
|
||||
timeout:
|
||||
description:
|
||||
- The connection timeout in seconds
|
||||
@@ -103,7 +100,7 @@ options:
|
||||
- Wait for the application to terminate.
|
||||
- Only use for non-interactive applications.
|
||||
type: bool
|
||||
default: 'yes'
|
||||
default: yes
|
||||
notes:
|
||||
- More information related to Microsoft PsExec is available from
|
||||
U(https://technet.microsoft.com/en-us/sysinternals/bb897553.aspx)
|
||||
@@ -153,17 +150,17 @@ cmd:
|
||||
type: str
|
||||
sample: psexec.exe -nobanner \\remote_server -u "DOMAIN\Administrator" -p "some_password" -accepteula E:\setup.exe
|
||||
rc:
|
||||
description: The return code for the command
|
||||
description: The return code for the command.
|
||||
returned: always
|
||||
type: int
|
||||
sample: 0
|
||||
stdout:
|
||||
description: The standard output from the command
|
||||
description: The standard output from the command.
|
||||
returned: always
|
||||
type: str
|
||||
sample: Success.
|
||||
stderr:
|
||||
description: The error output from the command
|
||||
description: The error output from the command.
|
||||
returned: always
|
||||
type: str
|
||||
sample: Error 15 running E:\setup.exe
|
||||
|
||||
Reference in New Issue
Block a user