c404a9003f
* Output version_added on top level, and improve version_added formatting * Handle 'historical' version_added.
105 lines
1.9 KiB
Text
105 lines
1.9 KiB
Text
> TESTNS.TESTCOL.RANDOMMODULE (./collections/ansible_collections/testns/testcol/plugins/modules/randommodule.py)
|
|
|
|
A random module.
|
|
|
|
ADDED IN: version 1.0.0 of testns.testcol
|
|
|
|
DEPRECATED:
|
|
|
|
Reason: Test deprecation
|
|
Will be removed in: Ansible 3.0.0
|
|
Alternatives: Use some other module
|
|
|
|
|
|
OPTIONS (= is mandatory):
|
|
|
|
- sub
|
|
Suboptions.
|
|
[Default: (null)]
|
|
set_via:
|
|
env:
|
|
- deprecated:
|
|
alternative: none
|
|
removed_in: 2.0.0
|
|
version: 2.0.0
|
|
why: Test deprecation
|
|
name: TEST_ENV
|
|
|
|
type: dict
|
|
|
|
OPTIONS:
|
|
|
|
- subtest2
|
|
Another suboption.
|
|
[Default: (null)]
|
|
type: float
|
|
added in: version 1.1.0
|
|
|
|
|
|
|
|
SUBOPTIONS:
|
|
|
|
- subtest
|
|
A suboption.
|
|
[Default: (null)]
|
|
type: int
|
|
added in: version 1.1.0 of testns.testcol
|
|
|
|
|
|
- test
|
|
Some text.
|
|
[Default: (null)]
|
|
type: str
|
|
added in: version 1.2.0 of testns.testcol
|
|
|
|
|
|
- testcol2option
|
|
An option taken from testcol2
|
|
[Default: (null)]
|
|
type: str
|
|
added in: version 1.0.0 of testns.testcol2
|
|
|
|
|
|
- testcol2option2
|
|
Another option taken from testcol2
|
|
[Default: (null)]
|
|
type: str
|
|
|
|
|
|
AUTHOR: Ansible Core Team
|
|
|
|
EXAMPLES:
|
|
|
|
|
|
|
|
|
|
RETURN VALUES:
|
|
- a_first
|
|
A first result.
|
|
|
|
returned: success
|
|
type: str
|
|
|
|
- m_middle
|
|
This should be in the middle.
|
|
Has some more data
|
|
|
|
returned: success and 1st of month
|
|
type: dict
|
|
|
|
CONTAINS:
|
|
|
|
- suboption
|
|
A suboption.
|
|
(Choices: ARF, BARN, c_without_capital_first_letter)
|
|
type: str
|
|
added in: version 1.4.0 of testns.testcol
|
|
|
|
|
|
- z_last
|
|
A last result.
|
|
|
|
returned: success
|
|
type: str
|
|
added in: version 1.3.0 of testns.testcol
|
|
|