devopsarr.prowlarr.prowlarr_application module – Manages Prowlarr application.

Note

This module is part of the devopsarr.prowlarr collection (version 1.0.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.prowlarr.

To use it in a playbook, specify: devopsarr.prowlarr.prowlarr_application.

New in devopsarr.prowlarr 1.0.0

Synopsis

  • Manages Prowlarr application.

Parameters

Parameter

Comments

config_contract

string

Config contract.

fields

list / elements=dictionary

Configuration field list.

name

string

Field name.

value

any

Field value.

implementation

string

Implementation.

name

string / required

Name.

prowlarr_api_key

string / required

API key for Prowlarr authentication.

prowlarr_url

string / required

Full Prowlarr URL with protocol and port (e.g. `https://test.prowlarr.tv:9696`)

state

string

Create or delete resource.

Choices:

  • "present" ← (default)

  • "absent"

sync_level

string

Sync level.

Choices:

  • "fullSync" ← (default)

  • "addOnly"

  • "disabled"

tags

list / elements=integer

Tag list.

Default: []

update_secrets

boolean

Flag to force update of secret fields.

Choices:

  • false ← (default)

  • true

Notes

Note

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

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

Examples

---
# Create a application
- name: Create a application
  devopsarr.prowlarr.prowlarr_application:
    name: Example
    sync_level: disabled
    config_contract: RadarrSettings
    implementation: Radarr
    fields:
      - name: prowlarrUrl
        value: http://localhost:9696
      - name: baseUrl
        value: http://localhost:967878
      - name: apiKey
        value: apiKey123
      - name: syncCategories
        value:
          - 2000
          - 2010
          - 2030
      - name: syncRejectBlocklistedTorrentHashesWhileGrabbing
        value: false
    tags: [1,2]

# Delete a application
- name: Delete a application
  devopsarr.prowlarr.prowlarr_application:
    name: Example
    state: absent

Return Values

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

Key

Description

config_contract

string

Config contract.

Returned: always

Sample: "WebhookSettings"

fields

list / elements=string

field list.

Returned: always

id

integer

application ID.

Returned: always

Sample: 1

implementation

string

Implementation.

Returned: always

Sample: "Webhook"

name

string

Name.

Returned: always

Sample: "Example"

sync_level

string

Sync level.

Returned: always

Sample: "disabled"

tags

list / elements=integer

Tag list.

Returned: always

Sample: [1, 2]

Authors

  • Fuochi (@Fuochi)