devopsarr.sonarr.sonarr_release_profile_info (1.1.1) — module

Get information about Sonarr release profile.

| "added in version" 0.0.3 of devopsarr.sonarr"

Authors: Fuochi (@Fuochi)

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

Get information about Sonarr release profile.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
---
# Gather information about all release profiles.
- name: Gather information about all release profiles
  devopsarr.sonarr.sonarr_release_profile_info:
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Gather information about a single release profile.
- name: Gather information about a single release profile
  devopsarr.sonarr.sonarr_release_profile_info:
    name: test

Inputs

    
name:
    description: Name.
    type: str

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

Outputs

release_profiles:
  contains:
    enabled:
      description: Enabled.
      returned: always
      sample: true
      type: bool
    id:
      description: Release Profile ID.
      returned: always
      sample: 1
      type: int
    ignored:
      description: Ignored terms. At least one of `required` and `ignored` must be
        set.
      elements: str
      returned: always
      sample:
      - proper
      - repack
      type: list
    indexer_id:
      description: Indexer ID. Set `0` for all."
      returned: always
      sample: 1
      type: int
    required:
      description: Required terms. At least one of `required` and `ignored` must be
        set.
      elements: str
      returned: always
      sample:
      - proper
      - repack
      type: list
    tags:
      description: Tag list.
      elements: int
      returned: always
      sample:
      - 1
      - 2
      type: list
  description: A list of release profiles.
  elements: dict
  returned: always
  type: list