community.general.to_milliseconds filter – Converts a duration string to milliseconds

Note

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

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

New in community.general 0.2.0

Synopsis

  • Parse a human readable time duration string and convert to milliseconds.

Input

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

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_milliseconds(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 milliseconds
  ansible.builtin.debug:
    msg: "{{ '30h 20m 10s 123ms' | community.general.to_milliseconds }}"

Return Value

Key

Description

Return value

float

Number of milliseconds.

Returned: success

Authors

  • René Moser (@resmo)