devopsarr.sonarr.sonarr_media_management module – Manages Sonarr media management.

Note

This module is part of the devopsarr.sonarr collection (version 1.3.1).

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

To use it in a playbook, specify: devopsarr.sonarr.sonarr_media_management.

New in devopsarr.sonarr 0.0.5

Synopsis 

Manages Sonarr media management.

Parameters 

Parameter	Comments
auto_unmonitor_previously_downloaded_episodes boolean / required	Auto unmonitor previously downloaded episodes. Choices: `false` `true`
chmod_folder string / required	Permission in linux format.
chown_group string / required	Linux group.
copy_using_hardlinks boolean / required	Copy using hardlinks. Choices: `false` `true`
create_empty_series_folders boolean / required	Create empty series folder. Choices: `false` `true`
delete_empty_folders boolean / required	Delete empty folders. Choices: `false` `true`
download_propers_and_repacks string / required	Download propers and repack. Choices: `"preferAndUpgrade"` `"doNotUpgrade"` `"doNotPrefer"`
enable_media_info boolean / required	Enable media info flag. Choices: `false` `true`
episode_title_required string / required	Episode title required. Choices: `"always"` `"bulkSeasonReleases"` `"never"`
extra_file_extensions string / required	Comma separated list of extra files extension to be imported.
file_date string / required	File date modification. Choices: `"none"` `"localAirDate"` `"utcAirDate"`
import_extra_files boolean / required	Import extra files flag. Choices: `false` `true`
minimum_free_space_when_importing integer / required	Minimum free space when importing.
recycle_bin string / required	Bin path.
recycle_bin_cleanup_days integer / required	Recycle bin days.
rescan_after_refresh string / required	Rescan after refresh. Choices: `"always"` `"afterManual"` `"never"`
script_import_path string	Import sctipt path. Default: `""`
set_permissions_linux boolean / required	Set linux permission flag. Choices: `false` `true`
skip_free_space_check_when_importing boolean / required	Skip free space check when importing. Choices: `false` `true`
sonarr_api_key string / required	API key for Sonarr authentication.
sonarr_url string / required	Full Sonarr URL with protocol and port (e.g. `https://test.sonarr.tv:8989`)
use_script_import boolean	Use import script flag. Choices: `false` ← (default) `true`

Notes 

Note

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

Examples 

---
# update media management
- name: Update media management
  devopsarr.sonarr.sonarr_media_management:
    chmod_folder: "755"
    rescan_after_refresh: "always"
    recycle_bin: ""
    file_date: "localAirDate"
    extra_file_extensions: "srt,info"
    episode_title_required: "always"
    download_propers_and_repacks: "doNotPrefer"
    chown_group: "arrs"
    minimum_free_space_when_importing: 100
    recycle_bin_cleanup_days: 7
    auto_unmonitor_previously_downloaded_episodes: true
    skip_free_space_check_when_importing: true
    set_permissions_linux: true
    import_extra_files: true
    enable_media_info: true
    delete_empty_folders: true
    create_empty_series_folders: true
    copy_using_hardlinks: true

Return Values 

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

Key	Description
auto_unmonitor_previously_downloaded_episodes boolean	Auto unmonitor previously downloaded episodes. Returned: always Sample: `true`
chmod_folder string	Permission in linux format. Returned: always Sample: `"755"`
chown_group string	Linux group. Returned: always Sample: `"arrs"`
copy_using_hardlinks boolean	Copy using hardlinks. Returned: always Sample: `true`
create_empty_series_folders boolean	Create empty series folder. Returned: always Sample: `true`
delete_empty_folders boolean	Delete empty folders. Returned: always Sample: `true`
download_propers_and_repacks string	Download propers and repack. Returned: always Sample: `"preferAndUpgrade"`
enable_media_info boolean	Enable media info flag. Returned: always Sample: `true`
episode_title_required string	Episode title required. Returned: always Sample: `"bulkSeasonReleases"`
extra_file_extensions string	Comma separated list of extra files extension to be imported. Returned: always Sample: `"srt,info"`
file_date string	File date modification. Returned: always Sample: `"localAirDate"`
id integer	Media management ID. Returned: always Sample: `1`
import_extra_files boolean	Import extra files flag. Returned: always Sample: `true`
minimum_free_space_when_importing integer	Minimum free space when importing. Returned: always Sample: `100`
recycle_bin string	Bin path. Returned: always Sample: `"/tmp"`
recycle_bin_cleanup_days integer	Recycle bin days. Returned: always Sample: `7`
rescan_after_refresh string	Rescan after refresh. Returned: always Sample: `"afterManual"`
script_import_path string	Import sctipt path. Returned: always Sample: `""`
set_permissions_linux boolean	Set linux permission flag. Returned: always Sample: `true`
skip_free_space_check_when_importing boolean	Skip free space check when importing. Returned: always Sample: `true`
use_script_import boolean	Use import script flag. Returned: always Sample: `false`

Authors

Fuochi (@Fuochi)

devopsarr.sonarr.sonarr_media_management module – Manages Sonarr media management.

Synopsis

Parameters

Notes

Examples

Return Values