devopsarr.prowlarr.prowlarr_indexer_proxy_schema_info module – Get information about Prowlarr indexer proxy schema.

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

New in devopsarr.prowlarr 1.0.0

Synopsis

  • Get information about Prowlarr indexer proxy schema.

Parameters

Parameter

Comments

name

string

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

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

---
# Gather information about all indexer proxies schema.
- name: Gather information about all indexer proxies schema
  devopsarr.prowlarr.prowlarr_indexer_proxy_schema_info:

# Gather information about a single indexer proxy schema.
- name: Gather information about a single indexer proxy schema
  devopsarr.prowlarr.prowlarr_indexer_proxy_schema_info:
    name: test

Return Values

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

Key

Description

indexer_proxies

list / elements=dictionary

A list of indexer proxy.

Returned: always

config_contract

string

Config contract.

Returned: always

Sample: "BroadcastheNetSettings"

enable

boolean

Enable flag.

Returned: always

Sample: true

fields

list / elements=string

field list.

Returned: always

id

integer

indexer proxyID.

Returned: always

Sample: 1

implementation

string

Implementation.

Returned: always

Sample: "BroadcastheNet"

name

string

Name.

Returned: always

Sample: "Example"

priority

integer

Priority.

Returned: always

Sample: 1

protocol

string

Protocol.

Returned: always

Sample: "torrent"

remove_completed_downloads

boolean

Remove completed downloads flag.

Returned: always

Sample: true

remove_failed_downloads

boolean

Remove failed downloads flag.

Returned: always

Sample: false

tags

list / elements=integer

Tag list.

Returned: always

Sample: [1, 2]

Authors

  • Fuochi (@Fuochi)