devopsarr.sonarr.sonarr_indexer (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 indexer.

Usage examples

Scanned by Steampunk Spotter

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

---
# Create a indexer
- name: Create a indexer
  devopsarr.sonarr.sonarr_indexer:
    name: "Example"
    enable_automatic_search: false
    enable_interactive_search: false
    enable_rss: false
    priority: 10
    config_contract: "FanzubSettings"
    implementation: "Fanzub"
    protocol: "usenet"
    fields:
    - name: "baseUrl"
      value: "http://fanzub.com/rss/"
    - name: "animeStandardFormatSearch"
      value: true
    tags: [1,2]

Scanned by Steampunk Spotter

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

# Delete a indexer
- name: Delete a indexer
  devopsarr.sonarr.sonarr_indexer:
    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

priority:
    description: Priority.
    type: int

protocol:
    choices:
    - torrent
    - usenet
    description: Protocol.
    type: str

enable_rss:
    description: Enable RSS flag.
    type: bool

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

implementation:
    description: Implementation.
    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

download_client_id:
    default: 0
    description: Download client ID.
    type: int

enable_automatic_search:
    description: Enable automatic search flag.
    type: bool

enable_interactive_search:
    description: Enable interactive search flag.
    type: bool

Outputs

config_contract:
  description: Config contract.
  returned: always
  sample: BroadcastheNetSettings
  type: str
download_client_id:
  description: Download client ID.
  returned: always
  sample: 0
  type: int
enable_automatic_search:
  description: Enable automatic search flag.
  returned: always
  sample: true
  type: bool
enable_interactive_search:
  description: Enable interactive search flag.
  returned: always
  sample: false
  type: bool
enable_rss:
  description: Enable RSS flag.
  returned: always
  sample: true
  type: bool
fields:
  description: field list.
  returned: always
  type: list
id:
  description: indexer ID.
  returned: always
  sample: 1
  type: int
implementation:
  description: Implementation.
  returned: always
  sample: BroadcastheNet
  type: str
name:
  description: Name.
  returned: always
  sample: Example
  type: str
priority:
  description: Priority.
  returned: always
  sample: 1
  type: int
protocol:
  description: Protocol.
  returned: always
  sample: torrent
  type: str
tags:
  description: Tag list.
  elements: int
  returned: always
  sample:
  - 1
  - 2
  type: list