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

Usage examples

Scanned by Steampunk Spotter

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

---
# Create a metadata
- name: Create a metadata
  devopsarr.sonarr.sonarr_metadata:
    name: "Example"
    enable: true
    config_contract: "WdtvMetadataSettings"
    implementation: "WdtvMetadata"
    fields:
    - name: "seasonImages"
      value: true
    tags: [1,2]

Scanned by Steampunk Spotter

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

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

enable:
    default: false
    description: enable flag.
    type: bool

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

implementation:
    description: Implementation.
    type: str

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

config_contract:
    description: Config contract.
    type: str

Outputs

config_contract:
  description: Config contract.
  returned: always
  sample: WebhookSettings
  type: str
enable:
  description: On grab flag.
  returned: always
  sample: true
  type: bool
fields:
  description: field list.
  returned: always
  type: list
id:
  description: metadata ID.
  returned: always
  sample: 1
  type: int
implementation:
  description: Implementation.
  returned: always
  sample: Webhook
  type: str
name:
  description: Name.
  returned: always
  sample: Example
  type: str
tags:
  description: Tag list.
  elements: int
  returned: always
  sample:
  - 1
  - 2
  type: list