W3cubDocs

/Ansible

community.general.to_years filter – Converts a duration string to years

Note

This filter plugin is part of the community.general collection (version 10.7.3).

You might already have this collection installed if you are using the ansible package. 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 community.general.

To use it in a playbook, specify: community.general.to_years.

New in community.general 0.2.0

Synopsis
Input
Keyword parameters
Examples
Return Value

Synopsis

Parse a human readable time duration string and convert to years.

Input

This describes the input of the filter, the value before | community.general.to_years.

Parameter	Comments
Input string / required	The time string to convert. Can use the units `y` and `year` for a year, `mo` and `month` for a month, `w` and `week` for a week, `d` and `day` for a day, `h` and `hour` for a hour, `m`, `min` and `minute` for minutes, `s`, `sec` and `second` for seconds, `ms`, `msec`, `msecond` and `millisecond` for milliseconds. The suffix `s` can be added to a unit as well, so `seconds` is the same as `second`. Valid strings are space separated combinations of an integer with an optional minus sign and a unit. Examples are `1h`, `-5m`, and `3h -5m 6s`.

Parameter

Comments

Input

string / required

The time string to convert.

Can use the units y and year for a year, mo and month for a month, w and week for a week, d and day for a day, h and hour for a hour, m, min and minute for minutes, s, sec and second for seconds, ms, msec, msecond and millisecond for milliseconds. The suffix s can be added to a unit as well, so seconds is the same as second.

Valid strings are space separated combinations of an integer with an optional minus sign and a unit.

Examples are 1h, -5m, and 3h -5m 6s.

Keyword parameters

This describes keyword parameters of the filter. These are the values key1=value1, key2=value2 and so on in the following example: input | community.general.to_years(key1=value1, key2=value2, ...)

Parameter	Comments
month float	Number of days per month. Default: `30.0`
year float	Number of days per year. Default: `365.0`

Examples

- name: Convert a duration into years
  ansible.builtin.debug:
    msg: "{{ '1053d 30h' | community.general.to_years }}"

Return Value

Key	Description
Return value float	Number of years. Returned: success

Authors

René Moser (@resmo)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/to_years_filter.html