devopsarr.radarr.radarr_custom_format module – Manages Radarr custom format.

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

New in devopsarr.radarr 1.0.0

Synopsis

  • Manages Radarr custom format.

Parameters

Parameter

Comments

include_custom_format_when_renaming

boolean

Include custom format when renaming flag.

Choices:

  • false

  • true

name

string / required

Name.

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

specifications

list / elements=dictionary

Specification list.

fields

list / elements=dictionary

Configuration field list.

name

string

Field name.

value

any

Field value.

implementation

string

Implementation.

name

string

Specification name.

negate

boolean

Negate flag.

Choices:

  • false

  • true

required

boolean

Required flag.

Choices:

  • false

  • true

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 custom format
- name: Create a custom format
  devopsarr.radarr.radarr_custom_format:
    include_custom_format_when_renaming: false
    name: "Language"
    specifications:
    - name: "arabic"
      implementation: "LanguageSpecification"
      negate: false
      required: true
      fields:
      - name: "value"
        value: 26

# Delete a custom format
- name: Delete a custom format
  devopsarr.radarr.radarr_custom_format:
    name: Example
    state: absent

Return Values

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

Key

Description

id

integer

custom formatID.

Returned: always

Sample: 1

include_custom_format_when_renaming

boolean

Include custom format when renaming flag.

Returned: always

Sample: false

name

string

Name.

Returned: always

Sample: "Example"

specifications

list / elements=string

specification list.

Returned: always

Authors

  • Fuochi (@Fuochi)