You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ansible/test/integration/targets/ansible-doc/randommodule-text.output

126 lines
3.0 KiB
Plaintext

> 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. Contains `sub.subtest', which can be set to `123'.
You can use `TEST_ENV' to set this.
set_via:
env:
- deprecated:
alternative: none
removed_in: 2.0.0
version: 2.0.0
why: Test deprecation
name: TEST_ENV
default: null
type: dict
OPTIONS:
- subtest2
Another suboption. Useful when [ansible.builtin.shuffle]
is used with value `[a,b,),d\]'.
default: null
type: float
added in: version 1.1.0
SUBOPTIONS:
- subtest
A suboption. Not compatible to `path=c:\foo(1).txt' (of
module ansible.builtin.copy).
default: null
type: int
added in: version 1.1.0 of testns.testcol
- test
Some text. Consider not using `foo=bar'.
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
SEE ALSO:
* Module ansible.builtin.ping
The official documentation on the
ansible.builtin.ping module.
https://docs.ansible.com/ansible-core/devel/collections/ansible/builtin/ping_module.html
* Module ansible.builtin.uri
Use this to fetch an URI
https://docs.ansible.com/ansible-core/devel/collections/ansible/builtin/uri_module.html
* Module testns.testcol.test
* Module testns.testcol.fakemodule
A fake module
* Ansible docsite
See also the Ansible docsite.
https://docs.ansible.com
* Ansible documentation [foo_bar]
Some foo bar.
https://docs.ansible.com/ansible-core/devel/#stq=foo_bar&stp=1
AUTHOR: Ansible Core Team
EXAMPLES:
RETURN VALUES:
- a_first
A first result. Use `a_first=foo(bar\baz)bam'.
returned: success
type: str
- m_middle
This should be in the middle.
Has some more data.
Check out `m_middle.suboption' and compare it to `a_first=foo'
and `value' (of lookup community.general.foo).
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