community.general.vultr_user_facts (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

Gather facts about users available in Vultr.

Requirements

• python >= 2.6

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Gather Vultr user facts
  local_action:
    module: vultr_user_facts

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Print the gathered facts
  debug:
    var: ansible_facts.vultr_user_facts

Inputs

    
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

Outputs

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: community.general
    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_user_facts:
  description: Response from Vultr API
  returned: success
  sample:
    vultr_user_facts:
    - acls: []
      api_enabled: 'yes'
      email: mytestuser@example.com
      id: a235b4f45e87f
      name: mytestuser
  type: complex