--- search: boost: 3 --- # Sonarr Attributes Configuring [Sonarr](https://sonarr.tv/) is optional but will allow you to send shows to a Sonarr instance when they're found missing while updating a library's collections. Sonarr V2 may work, but it is not supported please upgrade to V3 if you can. Items in your List Exclusions will be ignored by PMM. A `sonarr` mapping can be either in the root of the config file as global mapping for all libraries, or you can specify the `sonarr` mapping individually per library. At the library level, only those settings which are different to the global settings need to be specified; there is an example of this at the end of the page. Below is a `sonarr` mapping example and the full set of attributes: ```YAML sonarr: url: http://192.168.1.12:32789 token: ################################ add_missing: false add_existing: false root_folder_path: S:/Shows monitor: all quality_profile: HD-1080p language_profile: English series_type: standard season_folder: true tag: pmm search: false cutoff_search: false sonarr_path: /media plex_path: /share/CACHEDEV1_DATA/Multimedia ``` | Attribute | Allowed Values | Default | Required | |:-------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:--------:| | `url` | Sonarr URL (Including URL Base if set).
**Example:** http://192.168.1.12:32788 | N/A | ✅ | | `token` | Sonarr API Token. | N/A | ✅ | | `add_missing` | Adds all missing shows found from all collections to Sonarr.
Use the `sonarr_add_missing` [Sonarr Details](../builders/details/arr.md#sonarr-definition-settings) in the collection definition to add missing per collection.
**boolean:** true or false | false | ❌ | | `add_existing` | Adds all existing shows in collections to Sonarr.
Use the `sonarr_add_existing` [Sonarr Details](../builders/details/arr.md#sonarr-definition-settings) in the collection definition to add existing per collection.
**boolean:** true or false | false | ❌ | | `upgrade_existing` | Upgrades all existing shows in collections to match the Quality Profile of the collection.
Use the `sonarr_upgrade_existing` [Sonarr Details](../builders/details/arr.md#sonarr-definition-settings) in the collection definition to upgrade the Quality Profile per collection.
**boolean:** true or false | false | ❌ | | `ignore_cache` | Ignores PMM's cache when adding items to Sonarr.
Use the `sonarr_ignore_cache` [Sonarr Details](../builders/details/arr.md#sonarr-definition-settings) in the collection definition to ignore per collection.
**boolean:** true or false | false | ❌ | | `root_folder_path` | Default Root Folder Path to use when adding new shows.
Use the `sonarr_folder` [Sonarr Details](../builders/details/arr.md#sonarr-definition-settings) in the collection definition to set the Root Folder per collection. | N/A | ✅ | | `monitor` | Default Monitor to use when adding new shows.
Use the `sonarr_monitor` [Sonarr Details](../builders/details/arr.md#sonarr-definition-settings) in the collection definition to set the Monitor value per collection.
**Values:**
`all`All episodes except specials
`future`Episodes that have not aired yet
`missing`Episodes that do not have files or have not aired yet
`existing`Episodes that have files or have not aired yet
`pilot`The first episode, all others will be ignored
`first`All episodes of the first season, all others will be ignored
`latest`All episodes of the latest season and future seasons
`none`No episodes
| `all` | ❌ | | `quality_profile` | Default Quality Profile to use when adding new shows.
Use the `sonarr_quality` [Sonarr Details](../builders/details/arr.md#sonarr-definition-settings) in the collection definition to set the Quality Profile per collection. | N/A | ✅ | | `language_profile` | Default Language Profile to use when adding new shows.
Use the `sonarr_language` [Sonarr Details](../builders/details/arr.md#sonarr-definition-settings) in the collection definition to set the Language Profile per collection. | First Profile | ❌ | | `series_type` | Default Series Type to use when adding new shows.
Use the `sonarr_series` [Sonarr Details](../builders/details/arr.md#sonarr-definition-settings) in the collection definition to set the Series Type per collection.
**Values:**
`standard`Episodes released with SxxEyy pattern
`daily`Episodes released daily that use year-month-day pattern (2017-05-25)
`anime`Episodes released using an absolute episode number
`standard`: Episodes released with SxxEyy pattern
`daily`: Episodes released daily or less frequently that use year-month-day (2017-05-25)
`anime`: Episodes released using an absolute episode number | `standard` | ❌ | | `season_folder` | Use the Season Folder Option when adding new shows.
Use the `sonarr_season` [Sonarr Details](../builders/details/arr.md#sonarr-definition-settings) in the collection definition to set the season folder value per collection.
**boolean:** true or false | true | ❌ | | `tag` | Default list or comma-separated string of tags to use when adding new shows.
Use the `sonarr_tag` [Sonarr Details](../builders/details/arr.md#sonarr-definition-settings) in the collection definition to set the tags per collection. | ` ` | ❌ | | `search` | Start search for missing episodes when adding new shows.
Use the `sonarr_search` [Sonarr Details](../builders/details/arr.md#sonarr-definition-settings) in the collection definition to set the search value per collection.
**boolean:** true or false | false | ❌ | | `cutoff_search` | Start search for cutoff unmet episodes when adding new shows.
Use the `sonarr_cutoff_search` [Sonarr Details](../builders/details/arr.md#sonarr-definition-settings) in the collection definition to set the cutoff search value per collection.
**boolean:** true or false | false | ❌ | | `plex_path` | When using `add_existing` or `sonarr_add_all` Convert this part of the path to `sonarr_path`. | ` ` | ❌ | | `sonarr_path` | When using `add_existing` or `sonarr_add_all` Convert the `plex_path` part of the path to this. | ` ` | ❌ | * The `token` can be found by going to `Sonarr > Settings > General > Security > API Key` * The `quality_profile` and `language_profile` must be the exact name of the desired quality profile, including all spaces and capitalization. * You can set most attributes per collection by using the [Sonarr Details](../builders/details/arr.md#sonarr-definition-settings) in the collection definition. ![Sonarr Details](sonarr.png) Based on that UI, the settings would be [settings not based on things in this image are shown as `#`; url and token are of course required they are not shown here to focus on the settings that are shown above]: ```YAML sonarr: url: # token: # add_missing: # add_existing: # root_folder_path: /share monitor: all quality_profile: Any language_profile: English series_type: standard season_folder: true tag: search: false cutoff_search: false sonarr_path: # plex_path: # ``` # Other examples: Specifying a second Sonarr instance for a specific library: In this example we have two Sonarr instances, standard and 4K, with five libraries that override various details. Also, shows are being added to the "Library05" library outside Sonarr via a custom script and I want those new shows added to Sonarr for tracking. ``` libraries: Library01: # this library uses the default sonarr config metadata_path: - file: config/TV.yml Library02: # this library overrides sonarr root path and profile metadata_path: - file: config/TV.yml sonarr: root_folder_path: /data/media/shows/tony quality_profile: Better Library03: # this library overrides sonarr quality profile metadata_path: - file: config/TV.yml sonarr: quality_profile: Best Library04: # this library uses the 4K sonarr instance metadata_path: - file: config/TV.yml sonarr: url: https://sonarr-4k.bing.bang token: SOME_OTHER_TOKEN root_folder_path: /data/media/shows/geezer quality_profile: Bestest Library05: # shows get added by a custom script so they should get added to sonarr-4k metadata_path: - file: config/TV.yml sonarr: url: https://sonarr-4k.bing.bang token: SOME_OTHER_TOKEN root_folder_path: /data/media/shows/bill quality_profile: Bestest add_existing: true sonarr_path: /data/media/shows/bill plex_path: /mnt/unionfs/shows/bill ... sonarr: url: https://sonarr.bing.bang token: SOME_TOKEN add_missing: false add_existing: false upgrade_existing: false root_folder_path: /data/media/shows/ozzy monitor: all quality_profile: Good language_profile: English series_type: standard season_folder: true tag: search: false cutoff_search: false sonarr_path: plex_path: ... ```