devopsarr.sonarr.sonarr_import_list (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 import list.

Usage examples

Scanned by Steampunk Spotter

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

---
# Create a import list
- name: Create a import list
  devopsarr.sonarr.sonarr_import_list:
    enable_automatic_add: false
    should_monitor: "unknown"
    quality_profile_id: 1
    root_folder_path: "/config"
    season_folder: false
    fields:
    - name: "apiKey"
      value: "Key"
    - name: "baseUrl"
      value: "localhost"
    - name: "languageProfileIds"
      value: [1]
    name: "SonarrImport"
    series_type: "standard"
    config_contract: "SonarrSettings"
    implementation: "SonarrImport"
    tags: []

Scanned by Steampunk Spotter

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

# Delete a import list
- name: Delete a import list
  devopsarr.sonarr.sonarr_import_list:
    name: Example
    state: absent

Inputs

    
name:
    description: Name.
    required: true
    type: str

tags:
    default: []
    description: Tag list.
    elements: int
    type: list

state:
    choices:
    - present
    - absent
    default: present
    description: Create or delete resource.
    required: false
    type: str

fields:
    description: Configuration field list.
    elements: dict
    suboptions:
      name:
        description: Field name.
        type: str
      value:
        description: Field value.
        type: raw
    type: list

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

series_type:
    description: Series type.
    type: str

season_folder:
    description: Season folder flag.
    type: bool

implementation:
    description: Implementation.
    type: str

should_monitor:
    description: Should monitor.
    type: str

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

update_secrets:
    default: false
    description: Flag to force update of secret fields.
    type: bool

config_contract:
    description: Config contract.
    type: str

root_folder_path:
    description: Root folder path.
    type: str

quality_profile_id:
    description: Quality profile ID.
    type: int

enable_automatic_add:
    description: Enable autometic add flag.
    type: bool

Outputs

config_contract:
  description: Config contract.
  returned: always
  sample: CustomSettings
  type: str
enable_automatic_add:
  description: Enable automatic add flag.
  returned: always
  sample: false
  type: bool
fields:
  description: field list.
  returned: always
  type: list
id:
  description: import listID.
  returned: always
  sample: 1
  type: int
implementation:
  description: Implementation.
  returned: always
  sample: CustomImport
  type: str
name:
  description: Name.
  returned: always
  sample: Example
  type: str
protocol:
  description: Protocol.
  returned: always
  sample: torrent
  type: str
quality_profile_id:
  description: Quality profile ID.
  returned: always
  sample: 1
  type: int
root_folder_path:
  description: Root folder path.
  returned: always
  sample: /path
  type: str
season_folder:
  description: Season folder flag.
  returned: always
  sample: false
  type: bool
series_type:
  description: Series type.
  returned: always
  sample: standard
  type: str
should_monitor:
  description: Should monitor.
  returned: always
  sample: unknown
  type: str
tags:
  description: Tag list.
  elements: int
  returned: always
  sample:
  - 1
  - 2
  type: list