
    Vh                     d    d dl mZmZmZ eZdZdZdZd dl	m
Z
 ddlmZmZ d Zed	k(  r e        y
y
)    )absolute_importdivisionprint_functionu0  
---
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
z
- name: Gather Vultr plans information
  vultr.cloud.plan_info:
  register: result

- name: Print the gathered information
  ansible.builtin.debug:
    var: result.vultr_plan_info
a8  
---
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"]
)AnsibleModule   )AnsibleVultrvultr_argument_specc                      t               } t        | d      }t        |ddd      }|j                  |j	                                y )NT)argument_specsupports_check_modevultr_plan_infoz/plansplan)module	namespaceresource_pathressource_result_key_singular)r	   r   r   
get_result
query_list)r   r   vultrs      i/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/vultr/cloud/plugins/modules/plan_info.pymainr   y   sK    ')M# F
 #&,	E 
U%%'(    __main__N)
__future__r   r   r   type__metaclass__DOCUMENTATIONEXAMPLESRETURNansible.module_utils.basicr   module_utils.vultr_v2r   r	   r   __name__ r   r   <module>r$      sK    A @M
^ 5 E)$ zF r   