devopsarr.sonarr.sonarr_import_list_schema_info module – Get information about Sonarr import list schema.

Note

This module is part of the devopsarr.sonarr collection (version 1.3.1).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install devopsarr.sonarr.

To use it in a playbook, specify: devopsarr.sonarr.sonarr_import_list_schema_info.

New in devopsarr.sonarr 1.0.0

Synopsis

  • Get information about Sonarr import list schema.

Parameters

Parameter

Comments

name

string

Name.

sonarr_api_key

string / required

API key for Sonarr authentication.

sonarr_url

string / required

Full Sonarr URL with protocol and port (e.g. `https://test.sonarr.tv:8989`)

Notes

Note

  • for authentication, you can set service_account_file using the c(SONARR_URL) env variable.

  • for authentication, you can set service_account_contents using the c(SONARR_API_KEY) env variable.

Examples

---
# Gather information about all import lists schema.
- name: Gather information about all import lists schema
  devopsarr.sonarr.sonarr_import_list_schema_info:

# Gather information about a single import list schema.
- name: Gather information about a single import list schema
  devopsarr.sonarr.sonarr_import_list_schema_info:
    name: PlexImport

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

import_lists

list / elements=dictionary

A list of import list.

Returned: always

config_contract

string

Config contract.

Returned: always

Sample: "CustomSettings"

enable_automatic_add

boolean

Enable automatic add flag.

Returned: always

Sample: false

fields

list / elements=string

field list.

Returned: always

id

integer

import listID.

Returned: always

Sample: 1

implementation

string

Implementation.

Returned: always

Sample: "CustomImport"

name

string

Name.

Returned: always

Sample: "Example"

protocol

string

Protocol.

Returned: always

Sample: "torrent"

quality_profile_id

integer

Quality profile ID.

Returned: always

Sample: 1

root_folder_path

string

Root folder path.

Returned: always

Sample: "/path"

season_folder

boolean

Season folder flag.

Returned: always

Sample: false

series_type

string

Series type.

Returned: always

Sample: "standard"

should_monitor

string

Should monitor.

Returned: always

Sample: "unknown"

tags

list / elements=integer

Tag list.

Returned: always

Sample: [1, 2]

Authors

  • Fuochi (@Fuochi)