devopsarr.radarr.radarr_root_folder module – Manages Radarr root folder.

Note

This module is part of the devopsarr.radarr collection (version 1.2.0).

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 devopsarr.radarr.

To use it in a playbook, specify: devopsarr.radarr.radarr_root_folder.

New in devopsarr.radarr 0.0.2

Synopsis

  • Manages Radarr root folder.

Parameters

Parameter

Comments

path

string / required

Actual root folder.

radarr_api_key

string / required

API key for Radarr authentication.

radarr_url

string / required

Full Radarr URL with protocol and port (e.g. `https://test.radarr.tv:7878`)

state

string

Create or delete resource.

Choices:

  • "present" ← (default)

  • "absent"

Notes

Note

  • for authentication, you can set service_account_file using the c(RADARR_URL) env variable.

  • for authentication, you can set service_account_contents using the c(RADARR_API_KEY) env variable.

Examples

---
# Create a root folder
- name: Create a root folder
  devopsarr.radarr.radarr_root_folder:
    path: '/series'

# Delete a root folder
- name: Delete a root_folder
  devopsarr.radarr.radarr_root_folder:
    path: '/series'
    state: absent

Return Values

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

Key

Description

accessible

string

Access flag.

Returned: on create/update

Sample: "true"

id

integer

root folder ID.

Returned: always

Sample: 1

path

string

The root folder path.

Returned: on create/update

Sample: "/series"

unmapped_folders

dictionary

List of unmapped folders

Returned: always

Sample: "[]"

Authors

  • Fuochi (@Fuochi)