blob: 639a10731b6e7d2aca5c83ce78b4590c90eb9de0 (
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
#
# Copyright (c) 2018, Yanis Guenane <yanis+ansible@guenane.org>
# Copyright (c) 2021, René Moser <mail@renemoser.net>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = """
---
module: plan_info
short_description: Gather information about the Vultr plans
description:
- Gather information about plans available to boot servers.
version_added: "1.0.0"
author:
- "Yanis Guenane (@Spredzy)"
- "René Moser (@resmo)"
extends_documentation_fragment:
- vultr.cloud.vultr_v2
"""
EXAMPLES = """
- name: Gather Vultr plans information
vultr.cloud.plan_info:
register: result
- name: Print the gathered information
ansible.builtin.debug:
var: result.vultr_plan_info
"""
RETURN = """
---
vultr_api:
description: Response from Vultr API with a few additions/modification.
returned: success
type: dict
contains:
api_timeout:
description: Timeout used for the API requests.
returned: success
type: int
sample: 60
api_retries:
description: Amount of max retries for the API requests.
returned: success
type: int
sample: 5
api_retry_max_delay:
description: Exponential backoff delay in seconds between retries up to this max delay value.
returned: success
type: int
sample: 12
api_endpoint:
description: Endpoint used for the API requests.
returned: success
type: str
sample: "https://api.vultr.com/v2"
vultr_plan_info:
description: Response from Vultr API as list.
returned: success
type: list
contains:
id:
description: ID of the plan.
returned: success
type: str
sample: vhf-8c-32gb
vcpu_count:
description: Amount of CPUs.
returned: success
type: int
sample: 8
ram:
description: Amount of RAM in MB.
returned: success
type: int
sample: 32768
disk:
description: Disk size in GB.
returned: success
type: int
sample: 512
disk_count:
description: Amount of disks.
returned: success
type: int
sample: 1
bandwidth:
description: Bandwidth in MB.
returned: success
type: int
sample: 6144
monthly_cost:
description: Monthly cost in $.
returned: success
type: int
sample: 192
type:
description: Type of plan.
returned: success
type: str
sample: vhf
locations:
description: List of locations the plan is available in.
returned: success
type: list
sample: ["ewr"]
"""
from ansible.module_utils.basic import AnsibleModule
from ..module_utils.vultr_v2 import AnsibleVultr, vultr_argument_spec
def main():
argument_spec = vultr_argument_spec()
module = AnsibleModule(
argument_spec=argument_spec,
supports_check_mode=True,
)
vultr = AnsibleVultr(
module=module,
namespace="vultr_plan_info",
resource_path="/plans",
ressource_result_key_singular="plan",
)
vultr.get_result(vultr.query_list())
if __name__ == "__main__":
main()
|
