charlesrocket.essential.remote_vars module – Injects remote variables

Note

This module is part of the charlesrocket.essential collection (version 1.3.3).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install charlesrocket.essential.

To use it in a playbook, specify: charlesrocket.essential.remote_vars.

DEPRECATED

Removed in:

version 2.0.0

Why:

A new role was released with increased security.

Alternative:

Use charlesrocket.essential.fetch_vars instead.

Synopsis

  • Download variables file from remote hosts and inject it into ansible_facts.

Note

This module has a corresponding action plugin.

Parameters

Parameter

Comments

url

string / required

Location of a remote YAML file.

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode

facts

Support: full

Action returns an ansible_facts dictionary that will update existing host facts

platform

Platforms: all

Target OS/families that can be operated against

Examples

- name: Import user variables
  charlesrocket.essential.remote_vars:
    url: https://www.example.com/user_vars.yml

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

new_vars

dictionary

Downloaded variables

Returned: success

Sample: {"variable": "value"}

Status

  • This module will be removed in version 2.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

  • k (@charlesrocket)