summaryrefslogtreecommitdiff
path: root/docs/man
diff options
context:
space:
mode:
authorLee Garrett <lgarrett@rocketjump.eu>2022-11-28 08:44:02 +0100
committerLee Garrett <lgarrett@rocketjump.eu>2022-11-28 08:44:02 +0100
commita6f601d820bf261c5f160bfcadb7ca6aa14d6ec2 (patch)
tree9ad0ffc7adc851191aa4787886c45d890d98a48b /docs/man
parentdfc95dfc10415e8ba138e2c042c39632c9251abb (diff)
downloaddebian-ansible-core-a6f601d820bf261c5f160bfcadb7ca6aa14d6ec2.zip
New upstream version 2.14.0
Diffstat (limited to 'docs/man')
-rw-r--r--docs/man/man1/ansible-config.116
-rw-r--r--docs/man/man1/ansible-console.14
-rw-r--r--docs/man/man1/ansible-doc.110
-rw-r--r--docs/man/man1/ansible-galaxy.12
-rw-r--r--docs/man/man1/ansible-inventory.12
-rw-r--r--docs/man/man1/ansible-playbook.14
-rw-r--r--docs/man/man1/ansible-pull.16
-rw-r--r--docs/man/man1/ansible-vault.12
-rw-r--r--docs/man/man1/ansible.16
9 files changed, 33 insertions, 19 deletions
diff --git a/docs/man/man1/ansible-config.1 b/docs/man/man1/ansible-config.1
index ebd09996..b42d8b64 100644
--- a/docs/man/man1/ansible-config.1
+++ b/docs/man/man1/ansible-config.1
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "ANSIBLE-CONFIG" 1 "" "Ansible 2.13.4" "System administration commands"
+.TH "ANSIBLE-CONFIG" 1 "" "Ansible 2.14.0" "System administration commands"
.SH NAME
ansible-config \- View ansible configuration.
.SH SYNOPSIS
@@ -64,6 +64,13 @@ Causes Ansible to print more debug messages. Adding multiple \-v will increase t
.B \fBlist\fP
list and output available configs
.sp
+\fB\-\-format\fP \(aqFORMAT\(aq, \fB\-f\fP \(aqFORMAT\(aq
+.INDENT 7.0
+.INDENT 3.5
+Output format for list
+.UNINDENT
+.UNINDENT
+.sp
\fB\-c\fP \(aqCONFIG_FILE\(aq, \fB\-\-config\fP \(aqCONFIG_FILE\(aq
.INDENT 7.0
.INDENT 3.5
@@ -81,6 +88,13 @@ Filter down to a specific plugin type.
.B \fBdump\fP
Shows the current settings, merges ansible.cfg if specified
.sp
+\fB\-\-format\fP \(aqFORMAT\(aq, \fB\-f\fP \(aqFORMAT\(aq
+.INDENT 7.0
+.INDENT 3.5
+Output format for dump
+.UNINDENT
+.UNINDENT
+.sp
\fB\-\-only\-changed\fP, \fB\-\-changed\-only\fP
.INDENT 7.0
.INDENT 3.5
diff --git a/docs/man/man1/ansible-console.1 b/docs/man/man1/ansible-console.1
index 7bcf5597..c360002c 100644
--- a/docs/man/man1/ansible-console.1
+++ b/docs/man/man1/ansible-console.1
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "ANSIBLE-CONSOLE" 1 "" "Ansible 2.13.4" "System administration commands"
+.TH "ANSIBLE-CONSOLE" 1 "" "Ansible 2.14.0" "System administration commands"
.SH NAME
ansible-console \- REPL console for executing Ansible tasks.
.SH SYNOPSIS
@@ -238,7 +238,7 @@ ask for privilege escalation password
\fB\-M\fP, \fB\-\-module\-path\fP
.INDENT 0.0
.INDENT 3.5
-prepend colon\-separated path(s) to module library (default=~/.ansible/plugins/modules:/usr/share/ansible/plugins/modules)
+prepend colon\-separated path(s) to module library (default={{ ANSIBLE_HOME ~ "/plugins/modules:/usr/share/ansible/plugins/modules" }})
.UNINDENT
.UNINDENT
.sp
diff --git a/docs/man/man1/ansible-doc.1 b/docs/man/man1/ansible-doc.1
index 7f5ec0d6..482e1970 100644
--- a/docs/man/man1/ansible-doc.1
+++ b/docs/man/man1/ansible-doc.1
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "ANSIBLE-DOC" 1 "" "Ansible 2.13.4" "System administration commands"
+.TH "ANSIBLE-DOC" 1 "" "Ansible 2.14.0" "System administration commands"
.SH NAME
ansible-doc \- plugin documentation tool
.SH SYNOPSIS
@@ -35,11 +35,11 @@ ansible-doc \- plugin documentation tool
.TP
.B usage: ansible\-doc [\-h] [\-\-version] [\-v] [\-M MODULE_PATH]
[\-\-playbook\-dir BASEDIR]
-[\-t {become,cache,callback,cliconf,connection,httpapi,inventory,lookup,netconf,shell,vars,module,strategy,role,keyword}]
+[\-t {become,cache,callback,cliconf,connection,httpapi,inventory,lookup,netconf,shell,vars,module,strategy,test,filter,role,keyword}]
[\-j] [\-r ROLES_PATH]
[\-e ENTRY_POINT | \-s | \-F | \-l | \-\-metadata\-dump]
[\-\-no\-fail\-on\-errors]
-[plugin [plugin ...]]
+[plugin ...]
.UNINDENT
.SH DESCRIPTION
.sp
@@ -92,7 +92,7 @@ Show plugin names and their source files without summaries (implies \-\-list). A
\fB\-M\fP, \fB\-\-module\-path\fP
.INDENT 0.0
.INDENT 3.5
-prepend colon\-separated path(s) to module library (default=~/.ansible/plugins/modules:/usr/share/ansible/plugins/modules)
+prepend colon\-separated path(s) to module library (default={{ ANSIBLE_HOME ~ "/plugins/modules:/usr/share/ansible/plugins/modules" }})
.UNINDENT
.UNINDENT
.sp
@@ -141,7 +141,7 @@ Show playbook snippet for these plugin types: inventory, lookup, module
\fB\-t\fP \(aqTYPE\(aq, \fB\-\-type\fP \(aqTYPE\(aq
.INDENT 0.0
.INDENT 3.5
-Choose which plugin type (defaults to "module"). Available plugin types are : (\(aqbecome\(aq, \(aqcache\(aq, \(aqcallback\(aq, \(aqcliconf\(aq, \(aqconnection\(aq, \(aqhttpapi\(aq, \(aqinventory\(aq, \(aqlookup\(aq, \(aqnetconf\(aq, \(aqshell\(aq, \(aqvars\(aq, \(aqmodule\(aq, \(aqstrategy\(aq, \(aqrole\(aq, \(aqkeyword\(aq)
+Choose which plugin type (defaults to "module"). Available plugin types are : (\(aqbecome\(aq, \(aqcache\(aq, \(aqcallback\(aq, \(aqcliconf\(aq, \(aqconnection\(aq, \(aqhttpapi\(aq, \(aqinventory\(aq, \(aqlookup\(aq, \(aqnetconf\(aq, \(aqshell\(aq, \(aqvars\(aq, \(aqmodule\(aq, \(aqstrategy\(aq, \(aqtest\(aq, \(aqfilter\(aq, \(aqrole\(aq, \(aqkeyword\(aq)
.UNINDENT
.UNINDENT
.sp
diff --git a/docs/man/man1/ansible-galaxy.1 b/docs/man/man1/ansible-galaxy.1
index f6686909..9c637b6c 100644
--- a/docs/man/man1/ansible-galaxy.1
+++ b/docs/man/man1/ansible-galaxy.1
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "ANSIBLE-GALAXY" 1 "" "Ansible 2.13.4" "System administration commands"
+.TH "ANSIBLE-GALAXY" 1 "" "Ansible 2.14.0" "System administration commands"
.SH NAME
ansible-galaxy \- Perform various Role and Collection related operations.
.SH SYNOPSIS
diff --git a/docs/man/man1/ansible-inventory.1 b/docs/man/man1/ansible-inventory.1
index 5dea0867..5bcc5101 100644
--- a/docs/man/man1/ansible-inventory.1
+++ b/docs/man/man1/ansible-inventory.1
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "ANSIBLE-INVENTORY" 1 "" "Ansible 2.13.4" "System administration commands"
+.TH "ANSIBLE-INVENTORY" 1 "" "Ansible 2.14.0" "System administration commands"
.SH NAME
ansible-inventory \- None
.SH SYNOPSIS
diff --git a/docs/man/man1/ansible-playbook.1 b/docs/man/man1/ansible-playbook.1
index 49285235..cba2f76a 100644
--- a/docs/man/man1/ansible-playbook.1
+++ b/docs/man/man1/ansible-playbook.1
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "ANSIBLE-PLAYBOOK" 1 "" "Ansible 2.13.4" "System administration commands"
+.TH "ANSIBLE-PLAYBOOK" 1 "" "Ansible 2.14.0" "System administration commands"
.SH NAME
ansible-playbook \- Runs Ansible playbooks, executing the defined tasks on the targeted hosts.
.SH SYNOPSIS
@@ -242,7 +242,7 @@ ask for privilege escalation password
\fB\-M\fP, \fB\-\-module\-path\fP
.INDENT 0.0
.INDENT 3.5
-prepend colon\-separated path(s) to module library (default=~/.ansible/plugins/modules:/usr/share/ansible/plugins/modules)
+prepend colon\-separated path(s) to module library (default={{ ANSIBLE_HOME ~ "/plugins/modules:/usr/share/ansible/plugins/modules" }})
.UNINDENT
.UNINDENT
.sp
diff --git a/docs/man/man1/ansible-pull.1 b/docs/man/man1/ansible-pull.1
index f3856502..78182d34 100644
--- a/docs/man/man1/ansible-pull.1
+++ b/docs/man/man1/ansible-pull.1
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "ANSIBLE-PULL" 1 "" "Ansible 2.13.4" "System administration commands"
+.TH "ANSIBLE-PULL" 1 "" "Ansible 2.14.0" "System administration commands"
.SH NAME
ansible-pull \- pulls playbooks from a VCS repo and executes them for the local host
.SH SYNOPSIS
@@ -49,7 +49,7 @@ ansible-pull \- pulls playbooks from a VCS repo and executes them for the local
[\-C CHECKOUT] [\-\-accept\-host\-key] [\-m MODULE_NAME]
[\-\-verify\-commit] [\-\-clean] [\-\-track\-subs] [\-\-check]
[\-\-diff]
-[playbook.yml [playbook.yml ...]]
+[playbook.yml ...]
.UNINDENT
.SH DESCRIPTION
.sp
@@ -235,7 +235,7 @@ ask for privilege escalation password
\fB\-M\fP, \fB\-\-module\-path\fP
.INDENT 0.0
.INDENT 3.5
-prepend colon\-separated path(s) to module library (default=~/.ansible/plugins/modules:/usr/share/ansible/plugins/modules)
+prepend colon\-separated path(s) to module library (default={{ ANSIBLE_HOME ~ "/plugins/modules:/usr/share/ansible/plugins/modules" }})
.UNINDENT
.UNINDENT
.sp
diff --git a/docs/man/man1/ansible-vault.1 b/docs/man/man1/ansible-vault.1
index c1f85a0d..96a7e82b 100644
--- a/docs/man/man1/ansible-vault.1
+++ b/docs/man/man1/ansible-vault.1
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "ANSIBLE-VAULT" 1 "" "Ansible 2.13.4" "System administration commands"
+.TH "ANSIBLE-VAULT" 1 "" "Ansible 2.14.0" "System administration commands"
.SH NAME
ansible-vault \- encryption/decryption utility for Ansible data files
.SH SYNOPSIS
diff --git a/docs/man/man1/ansible.1 b/docs/man/man1/ansible.1
index 7941dbc1..1342385b 100644
--- a/docs/man/man1/ansible.1
+++ b/docs/man/man1/ansible.1
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "ANSIBLE" 1 "" "Ansible 2.13.4" "System administration commands"
+.TH "ANSIBLE" 1 "" "Ansible 2.14.0" "System administration commands"
.SH NAME
ansible \- Define and run a single task 'playbook' against a set of hosts
.SH SYNOPSIS
@@ -212,7 +212,7 @@ ask for privilege escalation password
\fB\-M\fP, \fB\-\-module\-path\fP
.INDENT 0.0
.INDENT 3.5
-prepend colon\-separated path(s) to module library (default=~/.ansible/plugins/modules:/usr/share/ansible/plugins/modules)
+prepend colon\-separated path(s) to module library (default={{ ANSIBLE_HOME ~ "/plugins/modules:/usr/share/ansible/plugins/modules" }})
.UNINDENT
.UNINDENT
.sp
@@ -233,7 +233,7 @@ override the connection timeout in seconds (default=10)
\fB\-a\fP \(aqMODULE_ARGS\(aq, \fB\-\-args\fP \(aqMODULE_ARGS\(aq
.INDENT 0.0
.INDENT 3.5
-The action\(aqs options in space separated k=v format: \-a \(aqopt1=val1 opt2=val2\(aq
+The action\(aqs options in space separated k=v format: \-a \(aqopt1=val1 opt2=val2\(aq or a json string: \-a \(aq{"opt1": "val1", "opt2": "val2"}\(aq
.UNINDENT
.UNINDENT
.sp