summaryrefslogtreecommitdiff
path: root/static/redfish/v1/JsonSchemas/Schedule/Schedule.json
blob: 81fee7a0c4904a051d433f100f443c6e7c67b689 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
{
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
    "copyright": "Copyright 2014-2018 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
    "definitions": {
        "DayOfWeek": {
            "description": "Days of the Week.",
            "enum": [
                "Monday",
                "Tuesday",
                "Wednesday",
                "Thursday",
                "Friday",
                "Saturday",
                "Sunday",
                "Every"
            ],
            "enumDescriptions": {
                "Every": "Every day of the week.",
                "Friday": "Friday.",
                "Monday": "Monday.",
                "Saturday": "Saturday.",
                "Sunday": "Sunday.",
                "Thursday": "Thursday.",
                "Tuesday": "Tuesday.",
                "Wednesday": "Wednesday."
            },
            "enumLongDescriptions": {
                "Every": "This value indicates that every day of the week has been selected. When used in array properties (such as for enabling a function on certain days) it shall be the only member in the array."
            },
            "longDescription": "Days of the Week.",
            "type": "string"
        },
        "MonthOfYear": {
            "description": "Months of the year.",
            "enum": [
                "January",
                "February",
                "March",
                "April",
                "May",
                "June",
                "July",
                "August",
                "September",
                "October",
                "November",
                "December",
                "Every"
            ],
            "enumDescriptions": {
                "April": "April.",
                "August": "August.",
                "December": "December.",
                "Every": "Every month of the year.",
                "February": "February.",
                "January": "January.",
                "July": "July.",
                "June": "June.",
                "March": "March.",
                "May": "May.",
                "November": "November.",
                "October": "October.",
                "September": "September."
            },
            "enumLongDescriptions": {
                "Every": "This value indicates that every month of the year has been selected. When used in array properties (such as for enabling a function for certain months) it shall be the only member in the array."
            },
            "longDescription": "Months of the year.",
            "type": "string"
        },
        "Schedule": {
            "additionalProperties": false,
            "description": "Schedule a series of occurrences.",
            "longDescription": "The properties of this type shall be used to Schedule a series of occurrences.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "EnabledDaysOfMonth": {
                    "description": "Days of month when scheduled occurrences are enabled. Zero indicates that every day of the month is enabled.",
                    "items": {
                        "type": [
                            "integer",
                            "null"
                        ]
                    },
                    "longDescription": "Days of month when scheduled occurrences are enabled, for enabled days of week and months of year. If the array contains a single value of zero, or if the property is not present, all days of the month shall be enabled.",
                    "maximum": 31,
                    "minimum": 0,
                    "readonly": false,
                    "type": "array"
                },
                "EnabledDaysOfWeek": {
                    "description": "Days of the week when scheduled occurrences are enabled, for enabled days of month and months of year.",
                    "items": {
                        "anyOf": [
                            {
                                "$ref": "#/definitions/DayOfWeek"
                            },
                            {
                                "type": "null"
                            }
                        ]
                    },
                    "longDescription": "Days of the week when scheduled occurrences are enabled. If not present, all days of the week shall be enabled.",
                    "readonly": false,
                    "type": "array"
                },
                "EnabledIntervals": {
                    "description": "Intervals when scheduled occurrences are enabled.",
                    "items": {
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "longDescription": "Each value shall be an ISO 8601 conformant interval specifying when occurences are enabled.",
                    "readonly": false,
                    "type": "array"
                },
                "EnabledMonthsOfYear": {
                    "description": "Months of year when scheduled occurrences are enabled.",
                    "items": {
                        "anyOf": [
                            {
                                "$ref": "#/definitions/MonthOfYear"
                            },
                            {
                                "type": "null"
                            }
                        ]
                    },
                    "longDescription": "Months of year when scheduled occurrences are enabled, for enabled days of week and days of month. If not present, all months of the year shall be enabled.",
                    "readonly": false,
                    "type": "array"
                },
                "InitialStartTime": {
                    "description": "Time for initial occurrence.",
                    "format": "date-time",
                    "longDescription": "The value shall be a date and time of day on which the initial occurrence is scheduled to occur.",
                    "readonly": false,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "Lifetime": {
                    "description": "The time after provisioning when the schedule as a whole expires.",
                    "longDescription": "The value shall be a Redfish Duration describing the time after provisioning when the schedule expires.",
                    "pattern": "-?P(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(.\\d+)?S)?)?",
                    "readonly": false,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "MaxOccurrences": {
                    "description": "Maximum number of scheduled occurrences.",
                    "longDescription": "Maximum number of scheduled occurrences.",
                    "readonly": false,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "Name": {
                    "description": "The Schedule name.",
                    "longDescription": "The name of the Schedule. It should be constructed as OrgID:ScheduleName. Examples: ACME:Daily, ACME:Weekly, ACME:FirstTuesday.",
                    "readonly": false,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "RecurrenceInterval": {
                    "description": "Distance until the next occurrences.",
                    "longDescription": "The value shall be a Redfish Duration describing the time until the next occurrence.",
                    "pattern": "-?P(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(.\\d+)?S)?)?",
                    "readonly": false,
                    "type": [
                        "string",
                        "null"
                    ]
                }
            },
            "type": "object"
        }
    },
    "owningEntity": "DMTF",
    "title": "#Schedule.v1_2_0"
}