devopsarr.sonarr.sonarr_naming (1.1.1) — module

Install collection

Install with ansible-galaxy collection install devopsarr.sonarr:==1.1.1

Add to requirements.yml

  collections:
    - name: devopsarr.sonarr
      version: 1.1.1

Description

Manages Sonarr naming.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

---
# update naming
- name: Update naming
  devopsarr.sonarr.sonarr_naming:
    rename_episodes: true
    replace_illegal_characters: true
    multi_episode_style: 0
    colon_replacement_format: 0
    daily_episode_format: '{Series Title} - {Air-Date} - {Episode Title} {Quality Full}'
    anime_episode_format: '{Series Title} - S{season:00}E{episode:00} - {Episode Title} {Quality Full}'
    series_folder_format: '{Series Title}'
    season_folder_format: 'Season {season}'
    specials_folder_format: 'S0'
    standard_episode_format: '{Series Title} - S{season:00}E{episode:00} - {Episode Title} {Quality Full}'

Inputs

    
sonarr_url:
    description: Full Sonarr URL with protocol and port (e.g. `https://test.sonarr.tv:8989`)
    required: true
    type: str

sonarr_api_key:
    description: API key for Sonarr authentication.
    required: true
    type: str

rename_episodes:
    description: Rename episodes.
    required: true
    type: bool

multi_episode_style:
    choices:
    - 0
    - 1
    - 2
    - 3
    - 4
    - 5
    description: Multi episode style. 0 - 'Extend' 1 - 'Duplicate' 2 - 'Repeat' 3 - 'Scene'
      4 - 'Range' 5 - 'Prefixed Range'.
    required: true
    type: int

anime_episode_format:
    description: Anime episode format.
    required: true
    type: str

daily_episode_format:
    description: Daily episode format.
    required: true
    type: str

season_folder_format:
    description: Series folder format.
    required: true
    type: str

series_folder_format:
    description: Series folder format.
    required: true
    type: str

specials_folder_format:
    description: Series folder format.
    required: true
    type: str

standard_episode_format:
    description: Standard episode format.
    required: true
    type: str

colon_replacement_format:
    choices:
    - 0
    - 1
    - 2
    - 3
    - 4
    description: 'Colon replacement format. 0 - ''Delete'' 1 - ''Replace with Dash'' 2
      - ''Replace with Space Dash'' 3 - ''Replace with Space Dash Space'' 4 - ''Smart
      Replace''.

      '
    required: true
    type: int

replace_illegal_characters:
    description: Replace illegal characters.
    required: true
    type: bool

Outputs

anime_episode_format:
  description: Anime episode format.
  returned: always
  sample: '{Series Title} - S{season:00}E{episode:00} - {Episode Title} {Quality Full}'
  type: str
colon_replacement_format:
  description: 'Colon replacement format. 0 - ''Delete'' 1 - ''Replace with Dash''
    2 - ''Replace with Space Dash'' 3 - ''Replace with Space Dash Space'' 4 - ''Smart
    Replace''.

    '
  returned: always
  sample: 2
  type: int
daily_episode_format:
  description: Daily episode format.
  returned: always
  sample: '{Series Title} - {Air-Date} - {Episode Title} {Quality Full}'
  type: str
id:
  description: Naming ID.
  returned: always
  sample: '1'
  type: int
multi_episode_style:
  description: Multi episode style. 0 - 'Extend' 1 - 'Duplicate' 2 - 'Repeat' 3 -
    'Scene' 4 - 'Range' 5 - 'Prefixed Range'.
  returned: always
  sample: 2
  type: int
rename_episodes:
  description: Rename episodes.
  returned: always
  sample: true
  type: bool
replace_illegal_characters:
  description: Replace illegal characters.
  returned: always
  sample: true
  type: bool
season_folder_format:
  description: Series folder format.
  returned: always
  sample: Season {season}
  type: str
series_folder_format:
  description: Series folder format.
  returned: always
  sample: '{Series Title}'
  type: str
specials_folder_format:
  description: Series folder format.
  returned: always
  sample: S0
  type: str
standard_episode_format:
  description: Standard episode format.
  returned: always
  sample: '{Series Title} - S{season:00}E{episode:00} - {Episode Title} {Quality Full}'
  type: str