summaryrefslogtreecommitdiff
path: root/test/integration/targets/ansible-doc/randommodule-text.output
blob: 602d66ec9f58e5a9c45975f882a6cb34381732ff (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
> 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.
        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.
            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


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.
        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