devopsarr.prowlarr.prowlarr_sync_profile module – Manages Prowlarr sync profile.

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

New in devopsarr.prowlarr 1.0.0

Synopsis

  • Manages Prowlarr sync profile.

Parameters

Parameter

Comments

boolean

Enable automatic search.

Choices:

  • false

  • true

boolean

Enable interactive search.

Choices:

  • false

  • true

enable_rss

boolean

Enable RSS.

Choices:

  • false

  • true

minimum_seeders

integer

Minimum seeders.

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"

tags

list / elements=integer

Tag list.

Default: []

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 sync profile
- name: Create a sync profile
  devopsarr.prowlarr.prowlarr_sync_profile:
    name: "Example"
    enable_rss: true
    enable_interactive_search: false
    enable_automatic_search: true
    minimum_seeders: 1
    tags: [1,2]

# Delete a sync profile
- name: Delete a sync_profile
  devopsarr.prowlarr.prowlarr_sync_profile:
    name: Example
    state: absent

Return Values

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

Key

Description

boolean

Enable automatic search.

Returned: always

Sample: true

boolean

Enable interactive search.

Returned: always

Sample: true

enable_rss

boolean

Enable rss.

Returned: always

Sample: true

id

integer

Sync Profile ID.

Returned: always

Sample: 1

minimum_seeders

integer

Indexer ID. Set `0` for all.”

Returned: always

Sample: 1

tags

list / elements=integer

Tag list.

Returned: always

Sample: [1, 2]

Authors

  • Fuochi (@Fuochi)