FileMgr

✏️ /usr/lib/python3.9/site-packages/ansible_collections/vultr/cloud/plugins/modules/user_info.py

✕ Tutup

# -*- 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: user_info
short_description: Get information about the Vultr users
version_added: "1.0.0"
description:
  - Get infos about users available.
author:
  - "Yanis Guenane (@Spredzy)"
  - "René Moser (@resmo)"
extends_documentation_fragment:
  - vultr.cloud.vultr_v2
"""

EXAMPLES = """
- name: Get Vultr user infos
  vultr.cloud.user_info:
  register: result

- name: Print the infos
  ansible.builtin.debug:
    var: result.vultr_user_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_user_info:
  description: Response from Vultr API as list.
  returned: available
  type: list
  contains:
    id:
      description: ID of the user.
      returned: success
      type: str
      sample: 7d726ffe-9be2-4f88-8cda-fa7eba1da2b5
    api_key:
      description: API key of the user.
      returned: only after resource was created
      type: str
      sample: 567E6K567E6K567E6K567E6K567E6K
    name:
      description: Name of the user.
      returned: success
      type: str
      sample: john
    email:
      description: Email of the user.
      returned: success
      type: str
      sample: "john@example.com"
    api_enabled:
      description: Whether the API is enabled or not.
      returned: success
      type: bool
      sample: true
    acls:
      description: List of ACLs of the user.
      returned: success
      type: list
      sample: [ manage_users, support, upgrade ]
"""

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_user_info",
        resource_path="/users",
        ressource_result_key_singular="user",
    )

vultr.get_result(vultr.query_list())

if __name__ == "__main__":
    main()

Batal

⬅ plugins 29 item

Nama	Tipe	Ukuran	Diubah	Perm	Aksi
📁 __pycache__	dir	—	16/09/24 06:47	0755	📂
🐍 __init__.py	py	0 B	08/11/23 12:12	0644	✏️ ⬇
🐍 account_info.py	py	2.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 block_storage.py	py	7.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 block_storage_info.py	py	3.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 dns_domain.py	py	3.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 dns_domain_info.py	py	2.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 dns_record.py	py	6.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 firewall_group.py	py	3.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 firewall_group_info.py	py	2.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 firewall_rule.py	py	7.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 firewall_rule_info.py	py	4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 instance.py	py	21.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 instance_info.py	py	6.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 os_info.py	py	2.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 plan_info.py	py	3.2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 plan_metal_info.py	py	3.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 region_info.py	py	2.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 reserved_ip.py	py	8.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 snapshot.py	py	5.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 snapshot_info.py	py	3.1 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ssh_key.py	py	3.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ssh_key_info.py	py	2.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 startup_script.py	py	5.1 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 startup_script_info.py	py	3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 user.py	py	5.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 user_info.py	py	2.9 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 vpc.py	py	4.3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 vpc_info.py	py	2.8 KB	08/11/23 12:12	0644	✏️ ⬇

✏️ Rename

🔑 Ubah Permission