addTimeZoneObject

The addTimeZoneObject operation handles configuration related to TimeZoneObject model.

Description

This API call is not allowed on the standby unit in an HA pair.

Data Parameters

Parameter	Required	Type	Description
name	True	string	The name of the object.
description	False	string	An optional description of the object. Field level constraints: length must be between 0 and 200 (inclusive), must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
timeZoneId	False	string	Mandatory Field. Id from global time zone list api. Represent the timeZone ID Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
timeZone	False	string	Optional Field. Represents the full timezone string consisting of UTC offset and timezone ID. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
dstDateRange	False	object	(Optional). Section that defines DayLightSavingDateRecurrence object. Use this attribute if you want to define daylight saving time based on DATE. Required details to provide are startDateTime, endDateTime and type.
dstDayRecurrence	False	object	(Optional). Section that defines DayLightSavingDayRecurrence object. Use this attribute if you want to define daylight saving time based on DAY. Required details to provide are startMonth,startWeek, startDayOfWeek, startTime, endMonth, endWeek, endDayOfWeek, endTime and type.
type	True	string	A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Example

- name: Execute 'addTimeZoneObject' operation
  ftd_configuration:
    operation: "addTimeZoneObject"
    data:
        name: "{{ name }}"
        description: "{{ description }}"
        timeZoneId: "{{ time_zone_id }}"
        timeZone: "{{ time_zone }}"
        dstDateRange: "{{ dst_date_range }}"
        dstDayRecurrence: "{{ dst_day_recurrence }}"
        type: "{{ type }}"