File: randommodule-text.output

package info (click to toggle)
ansible-core 2.19.0~beta6-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 32,628 kB
  • sloc: python: 180,313; cs: 4,929; sh: 4,601; xml: 34; makefile: 21
file content (115 lines) | stat: -rw-r--r-- 3,642 bytes parent folder | download | duplicates (2)
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
> MODULE testns.testcol.randommodule (./collections/ansible_collections/testns/testcol/plugins/modules/randommodule.py)

  A random module.
  See `foo=bar' (of role foo.bar.baz, main entrypoint) for how this is
  used in the [[foo.bar.baz]]'s `main' entrypoint.
  See the docsite <https://docs.ansible.com/ansible-core/devel/> for
  more information on ansible-core.
  This module is not related to the [ansible.builtin.copy] module.
  -------------  You might also be interested in
  ansible_python_interpreter.
  Sometimes you have [broken markup] that will result in error
  messages.
DEPRECATED: 
	Reason: Test deprecation
	Will be removed in: testns.testcol 3.0.0
	Alternatives: Use some other module

OPTIONS (= indicates it is required):

- 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

- testcol2option  An option taken from testcol2
        default: null
        type: str

- testcol2option2  Another option taken from testcol2
        default: null
        type: str

NOTES:
      * This is a note.
      * This is a multi-paragraph note.
        This is its second paragraph. This is just another line
        in the second paragraph. Eventually this will break into
        a new line, depending with which line width this is
        rendered.

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