mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-08-03 04:34:24 -07:00
parent
b132593861
commit
bb9bad89bb
1 changed files with 6 additions and 6 deletions
|
@ -11,31 +11,31 @@ DOCUMENTATION = """
|
||||||
short_description: read data from a ini file
|
short_description: read data from a ini file
|
||||||
description:
|
description:
|
||||||
- "The ini lookup reads the contents of a file in INI format C(key1=value1).
|
- "The ini lookup reads the contents of a file in INI format C(key1=value1).
|
||||||
This plugin retrieve the value on the right side after the equal sign C('=') of a given section C([section])."
|
This plugin retrieves the value on the right side after the equal sign C('=') of a given section C([section])."
|
||||||
- "You can also read a property file which - in this case - does not contain section."
|
- "You can also read a property file which - in this case - does not contain section."
|
||||||
options:
|
options:
|
||||||
_terms:
|
_terms:
|
||||||
description: The key(s) to look up
|
description: The key(s) to look up
|
||||||
required: True
|
required: True
|
||||||
type:
|
type:
|
||||||
description: ini Type of the file. 'properties' refers to the Java properties files.
|
description: Type of the file. 'properties' refers to the Java properties files.
|
||||||
default: 'ini'
|
default: 'ini'
|
||||||
choices: ['ini', 'properties']
|
choices: ['ini', 'properties']
|
||||||
file:
|
file:
|
||||||
description: Name of the file to load
|
description: Name of the file to load.
|
||||||
default: ansible.ini
|
default: ansible.ini
|
||||||
section:
|
section:
|
||||||
default: global
|
default: global
|
||||||
description: section where to lookup for key.
|
description: Section where to lookup the key.
|
||||||
re:
|
re:
|
||||||
default: False
|
default: False
|
||||||
type: boolean
|
type: boolean
|
||||||
description: Flag to indicate if the key supplied is a regexp.
|
description: Flag to indicate if the key supplied is a regexp.
|
||||||
encoding:
|
encoding:
|
||||||
default: utf-8
|
default: utf-8
|
||||||
description: Text encoding to use.
|
description: Text encoding to use.
|
||||||
default:
|
default:
|
||||||
description: return value if the key is not in the ini file
|
description: Return value if the key is not in the ini file.
|
||||||
default: ''
|
default: ''
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue