mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
commit
d7ad85340b
4 changed files with 70 additions and 45 deletions
|
@ -92,14 +92,16 @@ Ignore the inventory file and run the playbook against only these hosts\&. "host
|
||||||
\fIall\fR
|
\fIall\fR
|
||||||
when using this option\&.
|
when using this option\&.
|
||||||
.RE
|
.RE
|
||||||
.sp
|
.PP
|
||||||
\fB\-s\fR, \fB\-\-sudo\fR
|
\fB\-s\fR, \fB\-\-sudo\fR
|
||||||
.sp
|
.RS 4
|
||||||
Force all plays to use sudo, even if not marked as such\&.
|
Force all plays to use sudo, even if not marked as such\&.
|
||||||
.sp
|
.RE
|
||||||
|
.PP
|
||||||
\fB\-u\fR \fIUSERNAME\fR, \fB\-\-remote\-user=\fR\fIUSERNAME\fR
|
\fB\-u\fR \fIUSERNAME\fR, \fB\-\-remote\-user=\fR\fIUSERNAME\fR
|
||||||
.sp
|
.RS 4
|
||||||
Use this remote user name on playbook steps that do not indicate a user name to run as\&.
|
Use this remote user name on playbook steps that do not indicate a user name to run as\&.
|
||||||
|
.RE
|
||||||
.SH "ENVIRONMENT"
|
.SH "ENVIRONMENT"
|
||||||
.sp
|
.sp
|
||||||
The following environment variables may specified\&.
|
The following environment variables may specified\&.
|
||||||
|
|
|
@ -75,12 +75,12 @@ Ignore the inventory file and run the playbook against only these hosts. "hosts
|
||||||
in playbook should be set to 'all' when using this option.
|
in playbook should be set to 'all' when using this option.
|
||||||
|
|
||||||
|
|
||||||
*-s*, *--sudo*
|
*-s*, *--sudo*::
|
||||||
|
|
||||||
Force all plays to use sudo, even if not marked as such.
|
Force all plays to use sudo, even if not marked as such.
|
||||||
|
|
||||||
|
|
||||||
*-u* 'USERNAME', *--remote-user=*'USERNAME'
|
*-u* 'USERNAME', *--remote-user=*'USERNAME'::
|
||||||
|
|
||||||
Use this remote user name on playbook steps that do not indicate a user name to run as.
|
Use this remote user name on playbook steps that do not indicate a user name to run as.
|
||||||
|
|
||||||
|
|
|
@ -78,50 +78,73 @@ The
|
||||||
\fIARGUMENTS\fR
|
\fIARGUMENTS\fR
|
||||||
to pass to the module\&.
|
to pass to the module\&.
|
||||||
.RE
|
.RE
|
||||||
.sp
|
.PP
|
||||||
\fB\-D\fR, \fB\-\-debug\fR
|
\fB\-D\fR, \fB\-\-debug\fR
|
||||||
.sp
|
.RS 4
|
||||||
Print any messages the remote module sends to standard error to the console
|
Print any messages the remote module sends to standard error to the console
|
||||||
.sp
|
.RE
|
||||||
|
.PP
|
||||||
\fB\-k\fR, \fB\-\-ask\-pass\fR
|
\fB\-k\fR, \fB\-\-ask\-pass\fR
|
||||||
.sp
|
.RS 4
|
||||||
Prompt for the SSH password instead of assuming key\-based authentication with ssh\-agent\&.
|
Prompt for the SSH password instead of assuming key\-based authentication with ssh\-agent\&.
|
||||||
.sp
|
.RE
|
||||||
|
.PP
|
||||||
\fB\-K\fR, \fB\-\-ask\-sudo\-pass\fR
|
\fB\-K\fR, \fB\-\-ask\-sudo\-pass\fR
|
||||||
.sp
|
.RS 4
|
||||||
Prompt for the password to use with \-\-sudo, if any
|
Prompt for the password to use with \-\-sudo, if any
|
||||||
.sp
|
.RE
|
||||||
|
.PP
|
||||||
\fB\-o\fR, \fB\-\-one\-line\fR
|
\fB\-o\fR, \fB\-\-one\-line\fR
|
||||||
.sp
|
.RS 4
|
||||||
Try to output everything on one line\&.
|
Try to output everything on one line\&.
|
||||||
.sp
|
.RE
|
||||||
|
.PP
|
||||||
\fB\-s\fR, \fB\-\-sudo\fR
|
\fB\-s\fR, \fB\-\-sudo\fR
|
||||||
.sp
|
.RS 4
|
||||||
Run the command as the user given by \-u and sudo to root\&.
|
Run the command as the user given by \-u and sudo to root\&.
|
||||||
.sp
|
.RE
|
||||||
|
.PP
|
||||||
\fB\-t\fR \fIDIRECTORY\fR, \fB\-\-tree=\fR\fIDIRECTORY\fR
|
\fB\-t\fR \fIDIRECTORY\fR, \fB\-\-tree=\fR\fIDIRECTORY\fR
|
||||||
.sp
|
.RS 4
|
||||||
Save contents in this output \fIDIRECTORY\fR, with the results saved in a file named after each host\&.
|
Save contents in this output
|
||||||
.sp
|
\fIDIRECTORY\fR, with the results saved in a file named after each host\&.
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
\fB\-T\fR \fISECONDS\fR, \fB\-\-timeout=\fR\fISECONDS\fR
|
\fB\-T\fR \fISECONDS\fR, \fB\-\-timeout=\fR\fISECONDS\fR
|
||||||
.sp
|
.RS 4
|
||||||
Connection timeout to use when trying to talk to hosts, in \fISECONDS\fR\&.
|
Connection timeout to use when trying to talk to hosts, in
|
||||||
.sp
|
\fISECONDS\fR\&.
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
\fB\-B\fR \fINUM\fR, \fB\-\-background=\fR\fINUM\fR
|
\fB\-B\fR \fINUM\fR, \fB\-\-background=\fR\fINUM\fR
|
||||||
.sp
|
.RS 4
|
||||||
Run commands in the background, killing the task after \fINUM\fR seconds\&.
|
Run commands in the background, killing the task after
|
||||||
.sp
|
\fINUM\fR
|
||||||
|
seconds\&.
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
\fB\-P\fR \fINUM\fR, \fB\-\-poll=\fR\fINUM\fR
|
\fB\-P\fR \fINUM\fR, \fB\-\-poll=\fR\fINUM\fR
|
||||||
.sp
|
.RS 4
|
||||||
Poll a background job every \fINUM\fR seconds\&. Requires \fB\-B\fR\&.
|
Poll a background job every
|
||||||
.sp
|
\fINUM\fR
|
||||||
|
seconds\&. Requires
|
||||||
|
\fB\-B\fR\&.
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
\fB\-u\fR \fIUSERNAME\fR, \fB\-\-remote\-user=\fR\fIUSERNAME\fR
|
\fB\-u\fR \fIUSERNAME\fR, \fB\-\-remote\-user=\fR\fIUSERNAME\fR
|
||||||
.sp
|
.RS 4
|
||||||
Use this remote \fIUSERNAME\fR instead of root\&.
|
Use this remote
|
||||||
.sp
|
\fIUSERNAME\fR
|
||||||
|
instead of root\&.
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
\fB\-c\fR \fICONNECTION\fR, \fB\-\-connection=\fR\fICONNECTION\fR
|
\fB\-c\fR \fICONNECTION\fR, \fB\-\-connection=\fR\fICONNECTION\fR
|
||||||
.sp
|
.RS 4
|
||||||
Connection type to use\&. Possible options are \fIparamiko\fR (SSH) and \fIlocal\fR\&. Local is mostly useful for crontab or kickstarts\&.
|
Connection type to use\&. Possible options are
|
||||||
|
\fIparamiko\fR
|
||||||
|
(SSH) and
|
||||||
|
\fIlocal\fR\&. Local is mostly useful for crontab or kickstarts\&.
|
||||||
|
.RE
|
||||||
.SH "INVENTORY"
|
.SH "INVENTORY"
|
||||||
.sp
|
.sp
|
||||||
Ansible stores the hosts it can potentially operate on in an inventory file\&. The syntax is one host per line\&. Groups headers are allowed and are included on their own line, enclosed in square brackets\&.
|
Ansible stores the hosts it can potentially operate on in an inventory file\&. The syntax is one host per line\&. Groups headers are allowed and are included on their own line, enclosed in square brackets\&.
|
||||||
|
|
|
@ -60,48 +60,48 @@ The 'DIRECTORY' to load modules from. The default is '/usr/share/ansible'.
|
||||||
|
|
||||||
The 'ARGUMENTS' to pass to the module.
|
The 'ARGUMENTS' to pass to the module.
|
||||||
|
|
||||||
*-D*, *--debug*
|
*-D*, *--debug*::
|
||||||
|
|
||||||
Print any messages the remote module sends to standard error to the console
|
Print any messages the remote module sends to standard error to the console
|
||||||
|
|
||||||
*-k*, *--ask-pass*
|
*-k*, *--ask-pass*::
|
||||||
|
|
||||||
Prompt for the SSH password instead of assuming key-based authentication with ssh-agent.
|
Prompt for the SSH password instead of assuming key-based authentication with ssh-agent.
|
||||||
|
|
||||||
*-K*, *--ask-sudo-pass*
|
*-K*, *--ask-sudo-pass*::
|
||||||
|
|
||||||
Prompt for the password to use with --sudo, if any
|
Prompt for the password to use with --sudo, if any
|
||||||
|
|
||||||
*-o*, *--one-line*
|
*-o*, *--one-line*::
|
||||||
|
|
||||||
Try to output everything on one line.
|
Try to output everything on one line.
|
||||||
|
|
||||||
*-s*, *--sudo*
|
*-s*, *--sudo*::
|
||||||
|
|
||||||
Run the command as the user given by -u and sudo to root.
|
Run the command as the user given by -u and sudo to root.
|
||||||
|
|
||||||
*-t* 'DIRECTORY', *--tree=*'DIRECTORY'
|
*-t* 'DIRECTORY', *--tree=*'DIRECTORY'::
|
||||||
|
|
||||||
Save contents in this output 'DIRECTORY', with the results saved in a
|
Save contents in this output 'DIRECTORY', with the results saved in a
|
||||||
file named after each host.
|
file named after each host.
|
||||||
|
|
||||||
*-T* 'SECONDS', *--timeout=*'SECONDS'
|
*-T* 'SECONDS', *--timeout=*'SECONDS'::
|
||||||
|
|
||||||
Connection timeout to use when trying to talk to hosts, in 'SECONDS'.
|
Connection timeout to use when trying to talk to hosts, in 'SECONDS'.
|
||||||
|
|
||||||
*-B* 'NUM', *--background=*'NUM'
|
*-B* 'NUM', *--background=*'NUM'::
|
||||||
|
|
||||||
Run commands in the background, killing the task after 'NUM' seconds.
|
Run commands in the background, killing the task after 'NUM' seconds.
|
||||||
|
|
||||||
*-P* 'NUM', *--poll=*'NUM'
|
*-P* 'NUM', *--poll=*'NUM'::
|
||||||
|
|
||||||
Poll a background job every 'NUM' seconds. Requires *-B*.
|
Poll a background job every 'NUM' seconds. Requires *-B*.
|
||||||
|
|
||||||
*-u* 'USERNAME', *--remote-user=*'USERNAME'
|
*-u* 'USERNAME', *--remote-user=*'USERNAME'::
|
||||||
|
|
||||||
Use this remote 'USERNAME' instead of root.
|
Use this remote 'USERNAME' instead of root.
|
||||||
|
|
||||||
*-c* 'CONNECTION', *--connection=*'CONNECTION'
|
*-c* 'CONNECTION', *--connection=*'CONNECTION'::
|
||||||
|
|
||||||
Connection type to use. Possible options are 'paramiko' (SSH) and 'local'.
|
Connection type to use. Possible options are 'paramiko' (SSH) and 'local'.
|
||||||
Local is mostly useful for crontab or kickstarts.
|
Local is mostly useful for crontab or kickstarts.
|
||||||
|
|
Loading…
Reference in a new issue