W3cubDocs

/Ansible

community.general.to_time_unit filter – Converts a duration string to the given time unit

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_time_unit.

New in community.general 0.2.0

Synopsis

  • Parse a human readable time duration string and convert to the given time unit.

Input

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

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.

Positional parameters

This describes positional parameters of the filter. These are the values positional1, positional2 and so on in the following example: input | community.general.to_time_unit(positional1, positional2, ...)

Parameter

Comments

unit

string

Time unit to convert the duration to.

Choices:

  • "millisecond"
  • "milliseconds"
  • "ms" ← (default)
  • "msec"
  • "msecs"
  • "msecond"
  • "mseconds"
  • "s"
  • "sec"
  • "secs"
  • "second"
  • "seconds"
  • "h"
  • "hour"
  • "hours"
  • "hs"
  • "m"
  • "min"
  • "mins"
  • "minute"
  • "minutes"
  • "d"
  • "ds"
  • "day"
  • "days"
  • "w"
  • "ws"
  • "week"
  • "weeks"
  • "mo"
  • "mos"
  • "month"
  • "months"
  • "y"
  • "ys"
  • "year"
  • "years"

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_time_unit(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

Notes

Note

  • When keyword and positional parameters are used together, positional parameters must be listed before keyword parameters: input | community.general.to_time_unit(positional1, positional2, key1=value1, key2=value2)

Examples

- name: Convert a duration into seconds
  ansible.builtin.debug:
    msg: "{{ '1053d 17h 53m -10s 391ms' | community.general.to_time_unit('s') }}"

Return Value

Key

Description

Return value

float

Number of time units.

Returned: success

Authors

  • René Moser (@resmo)

© 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_time_unit_filter.html