devopsarr.whisparr.whisparr_delay_profile module – Manages Whisparr delay profile.

Note

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

To use it in a playbook, specify: devopsarr.whisparr.whisparr_delay_profile.

New in devopsarr.whisparr 0.0.1

Synopsis 

Manages Whisparr delay profile.

Parameters 

Parameter	Comments
bypass_if_highest_quality boolean	Bypass if highest quality flag. Choices: `false` `true`
enable_torrent boolean	Enable Torrent. Choices: `false` `true`
enable_usenet boolean	Enable Usenet. Choices: `false` `true`
order integer	Order.
preferred_protocol string / required	Preferred protocol. Choices: `"torrent"` `"usenet"`
state string	Create or delete a delay profile. Choices: `"present"` ← (default) `"absent"`
tags list / elements=integer / required	Tag list.
torrent_delay integer	Torrent delay.
usenet_delay integer	Usenet delay.
whisparr_api_key string / required	API key for Whisparr authentication.
whisparr_url string / required	Full Whisparr URL with protocol and port (e.g. `https://test.whisparr.tv:7878`)

Notes 

Note

for authentication, you can set service_account_file using the c(WHISPARR_URL) env variable.
for authentication, you can set service_account_contents using the c(WHISPARR_API_KEY) env variable.

Examples 

---
# Create a delay profile
- name: Create a delay profile
  devopsarr.whisparr.delay_profile:
    preferred_protocol: torrent
    usenet_delay: 0
    torrent_delay: 0
    order: 100
    enable_usenet: true
    enable_torrent: true
    bypass_if_highest_quality: false
    tags: [1,2]

# Delete a delay profile
- name: Delete a delay_profile
  devopsarr.whisparr.delay_profile:
    preferred_protocol: torrent
    tags: [1,2]
    state: absent

Return Values 

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

Key	Description
bypass_if_highest_quality boolean	Bypass if highest quality flag. Returned: always Sample: `true`
enable_torrent boolean	Enable Torrent. Returned: always Sample: `true`
enable_usenet boolean	Enable Usenet. Returned: always Sample: `true`
id integer	Delay Profile ID. Returned: always Sample: `1`
order integer	Order. Returned: always Sample: `10`
preferred_protocol string	Preferred protocol. Returned: always Sample: `"torrent"`
tags list / elements=integer	Tag list. Returned: always Sample: `[1, 2]`
torrent_delay integer	Torrent delay. Returned: always Sample: `0`
usenet_delay integer	Usenet delay. Returned: always Sample: `0`

Authors

Fuochi (@Fuochi)

devopsarr.whisparr.whisparr_delay_profile module – Manages Whisparr delay profile.

Synopsis

Parameters

Notes

Examples

Return Values