mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
1ab2a5f1bc
* Add default license header to files which have no copyright or license header yet. * yml extension should have been xml...
89 lines
2.3 KiB
YAML
89 lines
2.3 KiB
YAML
---
|
|
# Copyright (c) Ansible Project
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
DOCUMENTATION:
|
|
name: to_time_unit
|
|
short_description: Converte a duration string to the given time unit
|
|
version_added: 0.2.0
|
|
description:
|
|
- Parse a human readable time duration string and convert to the given time unit.
|
|
positional: unit
|
|
options:
|
|
_input:
|
|
description:
|
|
- The time string to convert.
|
|
- Can use the units C(y) and C(year) for a year, C(mo) and C(month) for a month, C(w) and C(week) for a week,
|
|
C(d) and C(day) for a day, C(h) and C(hour) for a hour, C(m), C(min) and C(minute) for minutes, C(s), C(sec)
|
|
and C(second) for seconds, C(ms), C(msec), C(msecond) and C(millisecond) for milliseconds. The suffix C(s)
|
|
can be added to a unit as well, so C(seconds) is the same as C(second).
|
|
- Valid strings are space separated combinations of an integer with an optional minus sign and a unit.
|
|
- Examples are C(1h), C(-5m), and C(3h -5m 6s).
|
|
type: string
|
|
required: true
|
|
unit:
|
|
description:
|
|
- Time unit to convert the duration to.
|
|
default: ms
|
|
choices:
|
|
- millisecond
|
|
- milliseconds
|
|
- ms
|
|
- 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
|
|
type: string
|
|
year:
|
|
description:
|
|
- Number of days per year.
|
|
default: 365
|
|
type: float
|
|
month:
|
|
description:
|
|
- Number of days per month.
|
|
default: 30
|
|
type: float
|
|
author:
|
|
- René Moser (@resmo)
|
|
|
|
EXAMPLES: |
|
|
- name: Convert a duration into seconds
|
|
ansible.builtin.debug:
|
|
msg: "{{ '1053d 17h 53m -10s 391ms' | community.general.to_time_unit('s') }}"
|
|
|
|
RETURN:
|
|
_value:
|
|
description: Number of time units.
|
|
type: float
|