devopsarr.prowlarr.prowlarr_indexer_proxy module – Manages Prowlarr indexer proxy.

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

New in devopsarr.prowlarr 1.0.0

Synopsis

  • Manages Prowlarr indexer proxy.

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"

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 indexer proxy
- name: Create a indexer proxy
  devopsarr.prowlarr.prowlarr_indexer_proxy:
    name: Example
    config_contract: FlareSolverrSettings
    implementation: FlareSolverr
    fields:
      - name: host
        value: http://localhost:8191
      - name: requestTimeout
        value: 60
    tags: [1,2]

# Delete a indexer proxy
- name: Delete a indexer proxy
  devopsarr.prowlarr.prowlarr_indexer_proxy:
    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

Indexer proxy ID.

Returned: always

Sample: 1

implementation

string

Implementation.

Returned: always

Sample: "Webhook"

name

string

Name.

Returned: always

Sample: "Example"

tags

list / elements=integer

Tag list.

Returned: always

Sample: [1, 2]

Authors

  • Fuochi (@Fuochi)