devopsarr.radarr.radarr_movie_info module – Get information about Radarr movie.
Note
This module is part of the devopsarr.radarr collection (version 1.2.0).
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.radarr
.
To use it in a playbook, specify: devopsarr.radarr.radarr_movie_info
.
New in devopsarr.radarr 1.0.0
Synopsis
Get information about Radarr movie.
Parameters
Parameter |
Comments |
---|---|
API key for Radarr authentication. |
|
Full Radarr URL with protocol and port (e.g. `https://test.radarr.tv:7878`) |
|
TMDB ID. |
Notes
Note
for authentication, you can set service_account_file using the c(RADARR_URL) env variable.
for authentication, you can set service_account_contents using the c(RADARR_API_KEY) env variable.
Examples
---
# Gather information about all movie.
- name: Gather information about all movie
devopsarr.radarr.radarr_movie_info:
# Gather information about a single movie.
- name: Gather information about a single movie
devopsarr.radarr.radarr_movie_info:
tmdb_id: 12345678
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A list of movie. Returned: always |
|
movie ID. Returned: always Sample: |
|
Minimum availability. Returned: always Sample: |
|
Monitored flag. Returned: always Sample: |
|
Movie path. Returned: always Sample: |
|
Quality profile ID. Returned: always Sample: |
|
Root folder path. Returned: always Sample: |
|
Tag list. Returned: always Sample: |
|
Movie title. Returned: always Sample: |
|
TMDB ID. Returned: always Sample: |