1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-02-04 07:51:50 +00:00
community.general/plugins/modules/cloud_init_data_facts.py
patchback[bot] b769b0bc01
[PR #11400/236b9c0e backport][stable-12] Sort imports with ruff check --fix (#11409)
Sort imports with ruff check --fix (#11400)

Sort imports with ruff check --fix.

(cherry picked from commit 236b9c0e04)

Co-authored-by: Felix Fontein <felix@fontein.de>
2026-01-09 19:36:52 +01:00

127 lines
3.3 KiB
Python

#!/usr/bin/python
# Copyright (c) 2018, René Moser <mail@renemoser.net>
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
from __future__ import annotations
DOCUMENTATION = r"""
module: cloud_init_data_facts
short_description: Retrieve facts of cloud-init
description:
- Gathers facts by reading the C(status.json) and C(result.json) of cloud-init.
author: René Moser (@resmo)
extends_documentation_fragment:
- community.general.attributes
- community.general.attributes.facts
- community.general.attributes.facts_module
options:
filter:
description:
- Filter facts.
type: str
choices: [status, result]
notes:
- See http://cloudinit.readthedocs.io/ for more information about cloud-init.
"""
EXAMPLES = r"""
- name: Gather all facts of cloud init
community.general.cloud_init_data_facts:
register: result
- ansible.builtin.debug:
var: result
- name: Wait for cloud init to finish
community.general.cloud_init_data_facts:
filter: status
register: res
until: "res.cloud_init_data_facts.status.v1.stage is defined and not res.cloud_init_data_facts.status.v1.stage"
retries: 50
delay: 5
"""
RETURN = r"""
cloud_init_data_facts:
description: Facts of result and status.
returned: success
type: dict
sample:
{
"status": {
"v1": {
"datasource": "DataSourceCloudStack",
"errors": []
}
},
"result": {
"v1": {
"datasource": "DataSourceCloudStack",
"init": {
"errors": [],
"finished": 1522066377.0185432,
"start": 1522066375.2648022
},
"init-local": {
"errors": [],
"finished": 1522066373.70919,
"start": 1522066373.4726632
},
"modules-config": {
"errors": [],
"finished": 1522066380.9097016,
"start": 1522066379.0011985
},
"modules-final": {
"errors": [],
"finished": 1522066383.56594,
"start": 1522066382.3449218
},
"stage": null
}
}
}
"""
import os
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.common.text.converters import to_text
CLOUD_INIT_PATH = "/var/lib/cloud/data"
def gather_cloud_init_data_facts(module):
res = {"cloud_init_data_facts": dict()}
for i in ["result", "status"]:
filter = module.params.get("filter")
if filter is None or filter == i:
res["cloud_init_data_facts"][i] = dict()
json_file = os.path.join(CLOUD_INIT_PATH, f"{i}.json")
if os.path.exists(json_file):
with open(json_file, "rb") as f:
contents = to_text(f.read(), errors="surrogate_or_strict")
if contents:
res["cloud_init_data_facts"][i] = module.from_json(contents)
return res
def main():
module = AnsibleModule(
argument_spec=dict(
filter=dict(choices=["result", "status"]),
),
supports_check_mode=True,
)
facts = gather_cloud_init_data_facts(module)
result = dict(changed=False, ansible_facts=facts, **facts)
module.exit_json(**result)
if __name__ == "__main__":
main()