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

Get information about Sonarr custom format.

Usage examples

Scanned by Steampunk Spotter

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

---
# Gather information about all custom formats
- name: Gather information about all custom formats
  devopsarr.sonarr.sonarr_custom_format_info:

Scanned by Steampunk Spotter

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

# Gather information about a single custom format
- name: Gather information about a single custom format
  devopsarr.sonarr.sonarr_custom_format_info:
    name: Example

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

custom_formats:
  contains:
    id:
      description: custom formatID.
      returned: always
      sample: 1
      type: int
    include_custom_format_when_renaming:
      description: Include custom format when renaming flag.
      returned: always
      sample: false
      type: bool
    name:
      description: Name.
      returned: always
      sample: Example
      type: str
    specifications:
      description: specification list.
      returned: always
      type: list
  description: A list of custom format.
  elements: dict
  returned: always
  type: list