devopsarr.radarr.radarr_movie module – Manages Radarr movie.

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_movie.

New in devopsarr.radarr 1.0.0

Synopsis

  • Manages Radarr movie.

Parameters

Parameter

Comments

minimum_availability

string

Minimum availability.

Choices:

  • "tba"

  • "announced"

  • "inCinemas"

  • "released"

  • "deleted"

monitored

boolean

Monitored flag.

Choices:

  • false ← (default)

  • true

path

string / required

Movie path.

quality_profile_id

integer

Quality profile ID.

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`)

root_folder_path

string

Root folder path.

state

string

Create or delete resource.

Choices:

  • "present" ← (default)

  • "absent"

tags

list / elements=integer

Tag list.

Default: []

title

string / required

Movie title.

tmdb_id

integer / required

TMDB ID.

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 movie
- name: Create a movie
  devopsarr.radarr.radarr_movie:
    title: "The Matrix"
    tmdb_id: 603
    monitored: true
    path: "/config/the-matrix"
    root_folder_path: "/config/"
    quality_profile_id: 1
    minimum_availability: "announced"
    tags: [1,2]

# Delete a movie
- name: Delete a movie
  devopsarr.radarr.radarr_movie:
    title: "The Matrix"
    tmdb_id: 603
    path: "/config/the-matrix"
    minimum_availability: "announced"
    state: absent

Return Values

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

Key

Description

id

integer

movie ID.

Returned: always

Sample: 1

minimum_availability

string

Minimum availability.

Returned: always

Sample: "tba"

monitored

boolean

Monitored flag.

Returned: always

Sample: false

path

string

Movie path.

Returned: always

Sample: "/movie/movie_title"

quality_profile_id

integer

Quality profile ID.

Returned: always

Sample: 1

root_folder_path

string

Root folder path.

Returned: always

Sample: "/movie"

tags

list / elements=integer

Tag list.

Returned: always

Sample: [1, 2]

title

string

Movie title.

Returned: always

Sample: "Movie Title"

tmdb_id

integer

TMDB ID.

Returned: always

Sample: 12345678

Authors

  • Fuochi (@Fuochi)