{
"name": "ansible-doc",
"description": "Displays information on modules installed in Ansible libraries",
"options": [
{
"names": [
"--metadata-dump"
],
"description": "For internal testing only Dump json metadata for all plugins",
"takes_arg": true
},
{
"names": [
"--playbook-dir"
],
"description": "Sets the relative path for many features including roles/ group_vars/ etc",
"takes_arg": true,
"arg": {
"name": "BASEDIR",
"description": "Base directory",
"template": "filepaths"
}
},
{
"names": [
"--version"
],
"description": "Shows version number, config file location, module search path, module location, executable location and exit",
"takes_arg": true
},
{
"names": [
"--list_files",
"-F"
],
"description": "Show plugin names and their source files without summaries (implies --list)",
"takes_arg": true
},
{
"names": [
"--module-path",
"-M"
],
"description": "Prepend colon-separated path(s) to module library",
"takes_arg": true
},
{
"names": [
"--entry-point",
"-E"
],
"description": "Select the entry point for role(s)",
"takes_arg": true,
"arg": {
"name": "ENTRY_POINT"
}
},
{
"names": [
"--help",
"-h"
],
"description": "Show help and exit",
"takes_arg": true
},
{
"names": [
"--json",
"-j"
],
"description": "Change output into json format",
"takes_arg": true
},
{
"names": [
"--list",
"-l"
],
"description": "List available plugins; a supplied argument will be used for filtering (can be a namespace or full collection name)",
"takes_arg": true,
"arg": {
"name": "NAMESPACE|COLLECTION"
}
},
{
"names": [
"--roles-path",
"-r"
],
"description": "The path to the directory containing your roles",
"takes_arg": true,
"arg": {
"name": "PATH",
"template": "filepaths"
}
},
{
"names": [
"--snippet",
"-s"
],
"description": "Show playbook snippet for these plugin types: inventory, lookup, module",
"takes_arg": true,
"arg": {
"name": "PLUGIN_TYPE",
"suggestions": [
"inventory",
"lookup",
"module"
]
}
},
{
"names": [
"--type",
"-t"
],
"description": "Choose which plugin type (defaults to \"module\")",
"takes_arg": true,
"arg": {
"name": "PLUGIN_TYPE",
"suggestions": [
"become",
"cache",
"callback",
"cliconf",
"connection",
"httpapi",
"inventory",
"lookup",
"netconf",
"shell",
"vars",
"module",
"strategy",
"role",
"keyword"
]
}
},
{
"names": [
"--verbose"
],
"description": "Verbose mode (-vvv for more, -vvvv to enable connection debugging)",
"takes_arg": true
},
{
"names": [
"-v"
],
"description": "Verbose mode (-vvv for more, -vvvv to enable connection debugging)",
"takes_arg": true
}
],
"args": [
{
"name": "plugin",
"is_variadic": true
}
]
}