devopsarr.radarr.radarr_naming module – Manages Radarr naming.

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

New in devopsarr.radarr 1.0.0

Synopsis

  • Manages Radarr naming.

Parameters

Parameter

Comments

colon_replacement_format

string / required

Colon replacement format.

Choices:

  • "smart"

  • "delete"

  • "dash"

  • "spaceDash"

  • "spaceDashSpace"

movie_folder_format

string / required

Movie folder format.

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

rename_movies

boolean / required

Rename movies.

Choices:

  • false

  • true

replace_illegal_characters

boolean / required

Replace illegal characters.

Choices:

  • false

  • true

standard_movie_format

string / required

Standard movie format.

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

---
# update naming
- name: Update naming
  devopsarr.radarr.radarr_naming:
    rename_movies: true
    replace_illegal_characters: true
    colon_replacement_format: 'dash'
    movie_folder_format: '{Movie Title} ({Release Year})'
    standard_movie_format: '{Movie Title} ({Release Year}) {Quality Full}'

Return Values

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

Key

Description

colon_replacement_format

string

Colon replacement format.

Returned: always

Sample: "dash"

id

integer

Naming ID.

Returned: always

Sample: 1

movie_folder_format

string

Movie folder format.

Returned: always

Sample: "{Movie Title} ({Release Year})"

rename_movies

boolean

Rename movies.

Returned: always

Sample: true

replace_illegal_characters

boolean

Replace illegal characters.

Returned: always

Sample: true

standard_movie_format

string

Standard movie format.

Returned: always

Sample: "{Movie Title} ({Release Year}) {Quality Full}"

Authors

  • Fuochi (@Fuochi)