devopsarr.sonarr.sonarr_custom_format (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 custom format.

Usage examples

Scanned by Steampunk Spotter

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

---
# Create a custom format
- name: Create a custom format
  devopsarr.sonarr.sonarr_custom_format:
    include_custom_format_when_renaming: false
    name: "Language"
    specifications:
    - name: "arabic"
      implementation: "LanguageSpecification"
      negate: false
      required: true
      fields:
      - name: "value"
        value: 26

Scanned by Steampunk Spotter

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

# Delete a custom format
- name: Delete a custom format
  devopsarr.sonarr.sonarr_custom_format:
    name: Example
    state: absent

Inputs

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

state:
    choices:
    - present
    - absent
    default: present
    description: Create or delete resource.
    required: false
    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

specifications:
    description: Specification list.
    elements: dict
    suboptions:
      fields:
        description: Configuration field list.
        elements: dict
        suboptions:
          name:
            description: Field name.
            type: str
          value:
            description: Field value.
            type: raw
        type: list
      implementation:
        description: Implementation.
        type: str
      name:
        description: Specification name.
        type: str
      negate:
        description: Negate flag.
        type: bool
      required:
        description: Required flag.
        type: bool
    type: list

include_custom_format_when_renaming:
    description: Include custom format when renaming flag.
    type: bool

Outputs

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