Skip to content

Commit 6f880d2

Browse files
committed
Re-generate supported parameters tables.
1 parent 8407175 commit 6f880d2

File tree

5 files changed

+14
-9
lines changed

5 files changed

+14
-9
lines changed

docs/source/_includes/runner_parameters/local_shell_cmd.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
33
* ``kwarg_op`` (string) - Operator to use in front of keyword args i.e. "--" or "-".
44
* ``cmd`` (string) - Arbitrary Linux command to be executed on the host.
5-
* ``timeout`` (integer) - Action timeout in seconds. Action will get killed if it doesn't finish in timeout seconds.
5+
* ``sudo_password`` (string) - Sudo password. To be used when paswordless sudo is not allowed.
66
* ``env`` (object) - Environment variables which will be available to the command(e.g. key1=val1,key2=val2)
7+
* ``timeout`` (integer) - Action timeout in seconds. Action will get killed if it doesn't finish in timeout seconds.
78
* ``sudo`` (boolean) - The command will be executed with sudo.
89
* ``cwd`` (string) - Working directory where the command will be executed in
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
.. NOTE: This file has been generated automatically, don't manually edit it
22
33
* ``kwarg_op`` (string) - Operator to use in front of keyword args i.e. "--" or "-".
4-
* ``sudo`` (boolean) - The command will be executed with sudo.
5-
* ``cwd`` (string) - Working directory where the script will be executed in
4+
* ``sudo_password`` (string) - Sudo password. To be used when paswordless sudo is not allowed.
65
* ``timeout`` (integer) - Action timeout in seconds. Action will get killed if it doesn't finish in timeout seconds.
7-
* ``env`` (object) - Environment variables which will be available to the script(e.g. key1=val1,key2=val2)
6+
* ``env`` (object) - Environment variables which will be available to the script(e.g. key1=val1,key2=val2)
7+
* ``sudo`` (boolean) - The command will be executed with sudo.
8+
* ``cwd`` (string) - Working directory where the script will be executed in
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
.. NOTE: This file has been generated automatically, don't manually edit it
22
3+
* ``log_level`` (string) - Default log level for Python runner actions.
34
* ``env`` (object) - Environment variables which will be available to the script.
45
* ``timeout`` (integer) - Action timeout in seconds. Action will get killed if it doesn't finish in timeout seconds.

docs/source/_includes/runner_parameters/remote_shell_cmd.rst

+6-5
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,17 @@
22
33
* ``username`` (string) - Username used to log-in. If not provided, default username from config is used.
44
* ``private_key`` (string) - Private key material or path to the private key file on disk used to log in.
5-
* ``cmd`` (string) - Arbitrary Linux command to be executed on the remote host(s).
6-
* ``timeout`` (integer) - Action timeout in seconds. Action will get killed if it doesn't finish in timeout seconds.
5+
* ``sudo_password`` (string) - Sudo password. To be used when paswordless sudo is not allowed.
76
* ``env`` (object) - Environment variables which will be available to the command(e.g. key1=val1,key2=val2)
87
* ``sudo`` (boolean) - The remote command will be executed with sudo.
9-
* ``cwd`` (string) - Working directory where the script will be executed in
108
* ``kwarg_op`` (string) - Operator to use in front of keyword args i.e. "--" or "-".
119
* ``bastion_host`` (string) - The host SSH connections will be proxied through. Note: This connection is made using the same parameters as the final connection, and is only used in ParamikoSSHRunner.
12-
* ``hosts`` (string) - A comma delimited string of a list of hosts where the remote command will be executed.
1310
* ``passphrase`` (string) - Passphrase for the private key, if needed.
14-
* ``parallel`` (boolean) - Default to parallel execution.
1511
* ``password`` (string) - Password used to log in. If not provided, private key from the config file is used.
1612
* ``port`` (integer) - SSH port. Note: This parameter is used only in ParamikoSSHRunner.
13+
* ``cmd`` (string) - Arbitrary Linux command to be executed on the remote host(s).
14+
* ``parallel`` (boolean) - Default to parallel execution.
15+
* ``hosts`` (string) - A comma delimited string of a list of hosts where the remote command will be executed.
16+
* ``timeout`` (integer) - Action timeout in seconds. Action will get killed if it doesn't finish in timeout seconds.
17+
* ``cwd`` (string) - Working directory where the script will be executed in
1718
* ``dir`` (string) - The working directory where the script will be copied to on the remote host.

docs/source/_includes/runner_parameters/remote_shell_script.rst

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
33
* ``username`` (string) - Username used to log-in. If not provided, default username from config is used.
44
* ``private_key`` (string) - Private key material to log in. Note: This needs to be actual private key data and NOT path.
5+
* ``sudo_password`` (string) - Sudo password. To be used when paswordless sudo is not allowed.
56
* ``timeout`` (integer) - Action timeout in seconds. Action will get killed if it doesn't finish in timeout seconds.
67
* ``env`` (object) - Environment variables which will be available to the script(e.g. key1=val1,key2=val2)
78
* ``sudo`` (boolean) - The remote command will be executed with sudo.

0 commit comments

Comments
 (0)