devopsarr.readarr.readarr_system_info module – Readarr system info module

Note

This module is part of the devopsarr.readarr collection (version 0.1.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.readarr.

To use it in a playbook, specify: devopsarr.readarr.readarr_system_info.

New in devopsarr.readarr 0.0.1

Synopsis

  • Provide Readarr system info

Parameters

Parameter

Comments

readarr_api_key

string / required

API key for Readarr authentication.

readarr_url

string / required

Full Readarr URL with protocol and port (e.g. `https://test.readarr.tv:8787`)

Notes

Note

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

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

Examples

# It will fetch the system info
- name: Test with a message
  devopsarr.readarr.readarr_system_info:

Return Values

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

Key

Description

app_data

string

Configuration path.

Returned: always

Sample: "/config"

app_name

string

It should be Readarr.

Returned: always

Sample: "Readarr"

authentication

string

Authentication type.

Returned: always

Sample: "none"

branch

string

Readarr branch.

Returned: always

Sample: "master"

build_time

string

Build time.

Returned: always

Sample: "2022-04-23T21:40:53Z"

is_admin

boolean

Admin flag.

Returned: always

Sample: false

is_debug

boolean

Debug flag.

Returned: always

Sample: false

is_linux

boolean

Linux flag.

Returned: always

Sample: false

is_mono

boolean

Mono flag.

Returned: always

Sample: true

is_mono_runtime

boolean

Mono runtime flag.

Returned: always

Sample: true

is_osx

boolean

OSX flag.

Returned: always

Sample: false

is_production

boolean

Production flag.

Returned: always

Sample: false

is_user_interactive

boolean

User interactive flag.

Returned: always

Sample: false

is_windows

string

Windows flag.

Returned: always

Sample: "false"

mode

string

Mode.

Returned: always

Sample: "console"

os_name

string

Host OS.

Returned: always

Sample: "ubuntu"

os_version

string

Host OS version.

Returned: always

Sample: "20.04"

package_author

string

Package author.

Returned: always

Sample: "[linuxserver.io](https://linuxserver.io)"

package_update_mechanism

string

Package update mechanism.

Returned: always

Sample: "docker"

package_version

string

Package version.

Returned: always

Sample: "3.0.8.1507-ls148"

runtime_name

string

Runtime name.

Returned: always

Sample: "mono"

runtime_version

string

Runtime version.

Returned: always

Sample: "6.12.0.122"

sqlite_version

string

SQLite version.

Returned: always

Sample: "3.31.1"

start_time

string

Start time.

Returned: always

Sample: "2022-06-09T08:21:23.970798Z"

startup_path

string

Startup path.

Returned: always

Sample: "/app/readarr/bin"

url_base

string

URI prefix for installation.

Returned: always

Sample: "/readarr"

version

string

Binary version.

Returned: always

Sample: "3.0.8.1507"

Authors

  • Fuochi (@Fuochi)