devopsarr.sonarr.sonarr_auto_tag (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 auto tag.

Usage examples

Scanned by Steampunk Spotter

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

---
# Create a auto tag
- name: Create a auto tag
  devopsarr.sonarr.sonarr_auto_tag:
    remove_tags_automatically: false
    name: "Type"
    tags: [1]
    specifications:
    - name: "anime"
      implementation: "SeriesTypeSpecification"
      negate: false
      required: true
      fields:
      - name: "value"
        value: 2

Scanned by Steampunk Spotter

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

# Delete a auto tag
- name: Delete a auto tag
  devopsarr.sonarr.sonarr_auto_tag:
    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

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

remove_tags_automatically:
    description: Remove tags automatically flag.
    type: bool

Outputs

id:
  description: auto tagID.
  returned: always
  sample: 1
  type: int
name:
  description: Name.
  returned: always
  sample: Example
  type: str
remove_tags_automatically:
  description: Remove tags automatically flag.
  returned: always
  sample: false
  type: bool
specifications:
  description: specification list.
  returned: always
  type: list
tags:
  description: Tag list.
  elements: int
  returned: always
  sample:
  - 1
  - 2
  type: list