ansible / ansible.builtin / v2.9.18 / module / vultr_server_info Gather information about the Vultr servers available. | "added in version" 2.9 of ansible.builtin" Authors: Yanis Guenane (@Spredzy) preview | supported by communityansible.builtin.vultr_server_info (v2.9.18) — module
pip
Install with pip install ansible==2.9.18
Gather information about servers available.
- name: Gather Vultr servers information local_action: module: vultr_server_info register: result
- name: Print the gathered information debug: var: result.vultr_server_info
api_key: description: - API key of the Vultr API. - The ENV variable C(VULTR_API_KEY) is used as default, when defined. type: str api_account: default: default description: - Name of the ini section in the C(vultr.ini) file. - The ENV variable C(VULTR_API_ACCOUNT) is used as default, when defined. type: str api_retries: description: - Amount of retries in case of the Vultr API retuns an HTTP 503 code. - The ENV variable C(VULTR_API_RETRIES) is used as default, when defined. - Fallback value is 5 retries if not specified. type: int api_timeout: description: - HTTP timeout to Vultr API. - The ENV variable C(VULTR_API_TIMEOUT) is used as default, when defined. - Fallback value is 60 seconds if not specified. type: int api_endpoint: description: - URL to API endpint (without trailing slash). - The ENV variable C(VULTR_API_ENDPOINT) is used as default, when defined. - Fallback value is U(https://api.vultr.com) if not specified. type: str validate_certs: default: true description: - Validate SSL certs of the Vultr API. type: bool api_retry_max_delay: description: - Retry backoff delay in seconds is exponential up to this max. value, in seconds. - The ENV variable C(VULTR_API_RETRY_MAX_DELAY) is used as default, when defined. - Fallback value is 12 seconds. type: int
vultr_api: contains: api_account: description: Account used in the ini file to select the key returned: success sample: default type: str api_endpoint: description: Endpoint used for the API requests returned: success sample: https://api.vultr.com type: str api_retries: description: Amount of max retries for the API requests returned: success sample: 5 type: int api_retry_max_delay: description: Exponential backoff delay in seconds between retries up to this max delay value. returned: success sample: 12 type: int version_added: '2.9' version_added_collection: ansible.builtin api_timeout: description: Timeout used for the API requests returned: success sample: 60 type: int description: Response from Vultr API with a few additions/modification returned: success type: complex vultr_server_info: description: Response from Vultr API returned: success sample: vultr_server_info: - allowed_bandwidth_gb: 1000 application: null auto_backup_enabled: false cost_per_month: 5.0 current_bandwidth_gb: 0 date_created: '2018-07-19 08:23:03' default_password: p4ssw0rd! disk: Virtual 25 GB firewallgroup: null id: 17241096 internal_ip: '' kvm_url: https://my.vultr.com/subs/vps/novnc/api.php?data=OFB... name: ansibletest os: CentOS 7 x64 pending_charges: 0.01 plan: 1024 MB RAM,25 GB SSD,1.00 TB BW power_status: running ram: 1024 MB region: Amsterdam server_state: ok status: active tag: '' v4_gateway: 105.178.158.1 v4_main_ip: 105.178.158.181 v4_netmask: 255.255.254.0 v6_main_ip: '' v6_network: '' v6_network_size: '' v6_networks: [] vcpu_count: 1 type: complex