Ansible Role: rclone_rc_remotes

Ansible role to create & remove Rclone remotes via Rclone's rc API.

Install the role: ansible-galaxy role install tigattack.rclone_rc_remotes

Requirements

None.

Dependencies

None.

Role Variables

• rclone_host: Rclone rc hostname or IP address. Defaults to {{ ansible_fqdn }}.
• rclone_port: Rclone rc port. Defaults to 5572, rc's default port.
• rclone_username: Rclone rc username.
• rclone_password: Rclone rc password.
• rclone_remotes: List (array) of Rclone remotes.
• remove_undefined_remotes: If true, any Rclone remotes that are not defined in the rclone_remotes variable will be removed. Defaults to false.

rclone_remotes example, based on a simple Google Drive remote configuration:

rclone_remotes:
  - name: my-remote
    type: drive
    parameters:
      scope: drive
      client_id: "01234"
      client_secret: "56789"
      root_folder_id: "abcde"

Rclone Remote Authentication

Some backend (remote) types, such as those which require OAuth, require interactive authentication and as such cannot be entirely automated.

In such cases, Ansible will prompt you with some instructions, pause execution, and ensure the remote can be connected once interactive authentication has been completed and you have resumed execution.

Example Playbook

- hosts: all
  roles:
    - role: tigattack.rclone_rc_remotes
      vars:
        rclone_remotes:
          - name: my-remote
              type: drive
              parameters:
              scope: drive
              client_id: "01234"
              client_secret: "56789"
              root_folder_id: "abcde"

Usage for authenticating remotes without rclone rc

While it's not the primary point of this role, one of the task files can be used to authenticate existing remotes if authentication is needed, like so:

- name: Configure rclone remote
  ansible.builtin.include_role:
    name: tigattack.rclone_rc_remotes
    tasks_from: rclone-authenticate-remote.yml
  vars:
    remote_name: my-remote

Note on testing

This role is not tested automatically as it would require defining a usable remote for Rclone.

Please feel free to suggest a way this could be done without relying on a real-world service if you have any ideas.