devopsarr.sonarr.sonarr_media_management_info module – Get information about 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_info.

New in devopsarr.sonarr 0.5.0

Synopsis

  • Get information about Sonarr media management.

Parameters

Parameter

Comments

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

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

---
# fetch media management
- name: fetch media management info
  devopsarr.sonarr.sonarr_media_management_info:

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"

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"

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

Authors

  • Fuochi (@Fuochi)