Class: Ansible::Ruby::Modules::Win_psexec

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/windows/win_psexec.rb

Overview

Run commands (remotely) through the PsExec service Run commands as another (domain) user (with elevated privileges)

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#chdir ⇒ Object?

Returns Run the command from this (remote) directory.

Returns:

  • (Object, nil) —

    Run the command from this (remote) directory.



33
 
# File 'lib/ansible/ruby/modules/generated/windows/win_psexec.rb', line 33

attribute :chdir

#command ⇒ String

Returns The command line to run through PsExec (limited to 260 characters).

Returns:

  • (String) —

    The command line to run through PsExec (limited to 260 characters).



13
 
# File 'lib/ansible/ruby/modules/generated/windows/win_psexec.rb', line 13

attribute :command

#elevated ⇒ String?

Returns Run the command with elevated privileges.

Returns:

  • (String, nil) —

    Run the command with elevated privileges.



44
 
# File 'lib/ansible/ruby/modules/generated/windows/win_psexec.rb', line 44

attribute :elevated

#executable ⇒ String?

Returns The location of the PsExec utility (in case it is not located in your PATH).

Returns:

  • (String, nil) —

    The location of the PsExec utility (in case it is not located in your PATH).



17
 
# File 'lib/ansible/ruby/modules/generated/windows/win_psexec.rb', line 17

attribute :executable

#hostnames ⇒ Array<String>, ...

Returns The hostnames to run the command.,If not provided, the command is run locally.

Returns:

  • (Array<String>, String, nil) —

    The hostnames to run the command.,If not provided, the command is run locally.



21
 
# File 'lib/ansible/ruby/modules/generated/windows/win_psexec.rb', line 21

attribute :hostnames

#interactive ⇒ String?

Returns Run the program so that it interacts with the desktop on the remote system.

Returns:

  • (String, nil) —

    Run the program so that it interacts with the desktop on the remote system.



48
 
# File 'lib/ansible/ruby/modules/generated/windows/win_psexec.rb', line 48

attribute :interactive

#limited ⇒ String?

Returns Run the command as limited user (strips the Administrators group and allows only privileges assigned to the Users group).

Returns:

  • (String, nil) —

    Run the command as limited user (strips the Administrators group and allows only privileges assigned to the Users group).



55
 
# File 'lib/ansible/ruby/modules/generated/windows/win_psexec.rb', line 55

attribute :limited

#nobanner ⇒ String?

Returns Do not display the startup banner and copyright message.,This only works for specific versions of the PsExec binary.

Returns:

  • (String, nil) —

    Do not display the startup banner and copyright message.,This only works for specific versions of the PsExec binary.



36
 
# File 'lib/ansible/ruby/modules/generated/windows/win_psexec.rb', line 36

attribute :nobanner

#noprofile ⇒ String?

Returns Run the command without loading the account’s profile.

Returns:

  • (String, nil) —

    Run the command without loading the account’s profile.



40
 
# File 'lib/ansible/ruby/modules/generated/windows/win_psexec.rb', line 40

attribute :noprofile

#password ⇒ String?

Returns The password for the (remote) user to run the command as.,This is mandatory in order authenticate yourself.

Returns:

  • (String, nil) —

    The password for the (remote) user to run the command as.,This is mandatory in order authenticate yourself.



29
 
# File 'lib/ansible/ruby/modules/generated/windows/win_psexec.rb', line 29

attribute :password

#priority ⇒ :background, ...

Returns Used to run the command at a different priority.

Returns:

  • (:background, :low, :belownormal, :abovenormal, :high, :realtime, nil) —

    Used to run the command at a different priority.



63
 
# File 'lib/ansible/ruby/modules/generated/windows/win_psexec.rb', line 63

attribute :priority

#session ⇒ Object?

Returns Specifies the session ID to use.,This parameter works in conjunction with I(interactive).,It has no effect when I(interactive) is set to C(no).

Returns:

  • (Object, nil) —

    Specifies the session ID to use.,This parameter works in conjunction with I(interactive).,It has no effect when I(interactive) is set to C(no).



52
 
# File 'lib/ansible/ruby/modules/generated/windows/win_psexec.rb', line 52

attribute :session

#system ⇒ String?

Returns Run the remote command in the System account.

Returns:

  • (String, nil) —

    Run the remote command in the System account.



59
 
# File 'lib/ansible/ruby/modules/generated/windows/win_psexec.rb', line 59

attribute :system

#timeout ⇒ Object?

Returns The connection timeout in seconds.

Returns:

  • (Object, nil) —

    The connection timeout in seconds



67
 
# File 'lib/ansible/ruby/modules/generated/windows/win_psexec.rb', line 67

attribute :timeout

#username ⇒ String?

Returns The (remote) user to run the command as.,If not provided, the current user is used.

Returns:

  • (String, nil) —

    The (remote) user to run the command as.,If not provided, the current user is used.



25
 
# File 'lib/ansible/ruby/modules/generated/windows/win_psexec.rb', line 25

attribute :username

#wait ⇒ String?

Returns Wait for the application to terminate.,Only use for non-interactive applications.

Returns:

  • (String, nil) —

    Wait for the application to terminate.,Only use for non-interactive applications.



70
 
# File 'lib/ansible/ruby/modules/generated/windows/win_psexec.rb', line 70

attribute :wait