|
1 |
| -generator_version: 1.0 |
2 |
| -metadata: |
3 |
| - vesion: 1.1 |
4 |
| - status: |
5 |
| - - preview |
6 |
| - supported_by: |
7 |
| - - '<support_group>' |
8 |
| - copyright_str: Copyright 2019 <company_name> |
9 |
| - license: gpl-3.0.txt |
10 |
| -info: |
11 |
| - network_os: myos |
12 |
| - resource: interfaces |
13 |
| - version_added: 2.8 |
| 1 | +--- |
| 2 | +GENERATOR_VERSION: '1.0' |
| 3 | +ANSIBLE_METADATA: | |
| 4 | + { |
| 5 | + 'metadata_version': '1.1', |
| 6 | + 'status': ['preview'], |
| 7 | + 'supported_by': '<support_group>' |
| 8 | + } |
| 9 | +
|
| 10 | +NETWORK_OS: myos |
| 11 | +RESOURCE: interfaces |
| 12 | +COPYRIGHT: Copyright 2019 Red Hat |
| 13 | +LICENSE: gpl-3.0.txt |
| 14 | + |
| 15 | +DOCUMENTATION: | |
| 16 | + module: myos_interfaces |
| 17 | + version_added: 2.9 |
14 | 18 | short_description: 'Manages <xxxx> attributes of <network_os> <resource>.'
|
15 |
| - description: |
16 |
| - - Manages <xxxx> attributes of <network_os> <resource>. |
17 |
| - authors: |
18 |
| - - Ansible Network Engineer |
19 |
| - extends_documentation_fragment: myos |
| 19 | + description: 'Manages <xxxx> attributes of <network_os> <resource>' |
| 20 | + author: Ansible Network Engineer |
20 | 21 | notes:
|
21 |
| - - Tested against <network_os> <version> |
22 |
| -schema: |
23 |
| - type: object |
24 |
| - description: The schema used for the argspec and docstring |
25 |
| - properties: |
| 22 | + - 'Tested against <network_os> <version>' |
| 23 | + options: |
26 | 24 | config:
|
27 |
| - type: array |
28 | 25 | description: The provided configuration
|
29 |
| - items: |
30 |
| - type: object |
31 |
| - properties: |
32 |
| - some_string: |
33 |
| - $ref: '#/definitions/some_string' |
34 |
| - some_bool: |
35 |
| - $ref: '#/definitions/some_bool' |
36 |
| - some_int: |
37 |
| - $ref: '#/definitions/some_int' |
38 |
| - some_dict: |
39 |
| - $ref: '#/definitions/some_dict' |
40 |
| - some_list_of_dicts: |
41 |
| - type: array |
42 |
| - description: An array of dicts |
43 |
| - items: |
44 |
| - $ref: '#/definitions/some_dict' |
45 |
| - required: |
46 |
| - - some_string |
47 |
| - state: |
48 |
| - $ref: '#/definitions/state' |
49 |
| - |
50 |
| -definitions: |
51 |
| - some_string: |
52 |
| - type: str |
53 |
| - description: |
54 |
| - - The some_string_01 |
55 |
| - enum: |
56 |
| - - choice_a |
57 |
| - - choice_b |
58 |
| - - choice_c |
59 |
| - default: choice_a |
60 |
| - some_bool: |
61 |
| - description: |
62 |
| - - The some_bool. |
63 |
| - type: bool |
64 |
| - some_int: |
65 |
| - description: |
66 |
| - - The some_int. |
67 |
| - type: int |
68 |
| - version_added: '1.1' |
69 |
| - some_dict: |
70 |
| - description: |
71 |
| - - The some_dict. |
72 |
| - type: object |
73 |
| - properties: |
74 |
| - property_01: |
75 |
| - description: |
76 |
| - - The property_01 |
77 |
| - type: str |
78 |
| - property_02: |
79 |
| - $ref: '#/definitions/some_string' |
80 |
| - state: |
81 |
| - description: |
82 |
| - - The state the configuration should be left in |
83 |
| - type: str |
84 |
| - enum: |
85 |
| - - merged |
86 |
| - - replaced |
87 |
| - - overridden |
88 |
| - - deleted |
89 |
| - default: merged |
90 |
| -examples: |
91 |
| -- merged_example_01.txt |
92 |
| -- replaced_example_01.txt |
93 |
| -- overridden_example_01.txt |
94 |
| -- deleted_example_01.txt |
| 26 | + type: list |
| 27 | + elements: dict |
| 28 | + suboptions: |
| 29 | + some_string: |
| 30 | + type: str |
| 31 | + description: |
| 32 | + - The some_string_01 |
| 33 | + chocies: |
| 34 | + - choice_a |
| 35 | + - choice_b |
| 36 | + - choice_c |
| 37 | + default: choice_a |
| 38 | + some_bool: |
| 39 | + description: |
| 40 | + - The some_bool. |
| 41 | + type: bool |
| 42 | + some_int: |
| 43 | + description: |
| 44 | + - The some_int. |
| 45 | + type: int |
| 46 | + version_added: '1.1' |
| 47 | + some_dict: |
| 48 | + type: dict |
| 49 | + description: |
| 50 | + - The some_dict. |
| 51 | + suboptions: |
| 52 | + property_01: |
| 53 | + description: |
| 54 | + - The property_01 |
| 55 | + type: str |
| 56 | + state: |
| 57 | + description: |
| 58 | + - The state the configuration should be left in |
| 59 | + type: str |
| 60 | + choices: |
| 61 | + - merged |
| 62 | + - replaced |
| 63 | + - overridden |
| 64 | + - deleted |
| 65 | + default: merged |
| 66 | +EXAMPLES: |
| 67 | + - deleted_example_01.txt |
| 68 | + - merged_example_01.txt |
| 69 | + - overridden_example_01.txt |
| 70 | + - replaced_example_01.txt |
0 commit comments