Repository URL to install this package:
|
Version:
6.0.0 ▾
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright: (c) 2018, Ansible Project
# Copyright: (c) 2020, Tyler Auerbeck <tauerbec@redhat.com>
# 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 = r"""
---
module: digital_ocean_project_info
short_description: Gather information about DigitalOcean Projects
description:
- This module can be used to gather information about Projects.
author: "Tyler Auerbeck (@tylerauerbeck)"
version_added: 1.6.0
options:
id:
description:
- Project ID that can be used to identify and reference a project.
type: str
name:
description:
- Project name that can be used to identify and reference a project.
type: str
extends_documentation_fragment:
- community.digitalocean.digital_ocean
"""
EXAMPLES = r"""
# Get specific project by id
- community.digitalocean.digital_ocean_project_info:
id: cb1ef55e-3cd8-4c7c-aa5d-07c32bf41627
# Get specific project by name
- community.digitalocean.digital_ocean_project_info:
name: my-project-name
# Get all projects
- community.digitalocean.digital_ocean_project_info:
register: projects
"""
RETURN = r"""
data:
description: "DigitalOcean project information"
elements: dict
returned: success
type: list
sample:
- created_at: "2021-03-11T00:00:00Z"
description: "My project description"
environment: "Development"
id: "12345678-abcd-efgh-5678-10111213"
is_default: false
name: "my-test-project"
owner_id: 12345678
owner_uuid: "12345678-1234-4321-abcd-20212223"
purpose: ""
updated_at: "2021-03-11T00:00:00Z"
"""
from traceback import format_exc
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.digitalocean.plugins.module_utils.digital_ocean import (
DigitalOceanHelper,
)
def run(module):
rest = DigitalOceanHelper(module)
if module.params["id"]:
response = rest.get("projects/{0}".format(module.params["id"]))
if response.status_code != 200:
module.fail_json(
msg="Failed to fetch 'projects' information due to error: %s"
% response.json["message"]
)
else:
response = rest.get_paginated_data(
base_url="projects?", data_key_name="projects"
)
if module.params["id"]:
data = [response.json["project"]]
elif module.params["name"]:
data = [d for d in response if d["name"] == module.params["name"]]
if not data:
module.fail_json(
msg="Failed to fetch 'projects' information due to error: Unable to find project with name %s"
% module.params["name"]
)
else:
data = response
module.exit_json(changed=False, data=data)
def main():
argument_spec = DigitalOceanHelper.digital_ocean_argument_spec()
argument_spec.update(
name=dict(type="str", required=False, default=None),
id=dict(type="str", required=False, default=None),
)
module = AnsibleModule(
argument_spec=argument_spec,
supports_check_mode=True,
mutually_exclusive=[("id", "name")],
)
run(module)
if __name__ == "__main__":
main()