1{
2    "$id": "http://redfish.dmtf.org/schemas/v1/Filter.v1_0_2.json",
3    "$ref": "#/definitions/Filter",
4    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
5    "copyright": "Copyright 2014-2024 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
6    "definitions": {
7        "Actions": {
8            "additionalProperties": false,
9            "description": "The available actions for this resource.",
10            "longDescription": "This type shall contain the available actions for this resource.",
11            "patternProperties": {
12                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
13                    "description": "This property shall specify a valid odata or Redfish property.",
14                    "type": [
15                        "array",
16                        "boolean",
17                        "integer",
18                        "number",
19                        "null",
20                        "object",
21                        "string"
22                    ]
23                }
24            },
25            "properties": {
26                "Oem": {
27                    "$ref": "#/definitions/OemActions",
28                    "description": "The available OEM-specific actions for this resource.",
29                    "longDescription": "This property shall contain the available OEM-specific actions for this resource."
30                }
31            },
32            "type": "object"
33        },
34        "Filter": {
35            "additionalProperties": false,
36            "description": "The `Filter` schema describes a filter unit for a cooling system or similar device.",
37            "longDescription": "This resource shall represent the management properties for monitoring and management of filters for a Redfish implementation.",
38            "patternProperties": {
39                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
40                    "description": "This property shall specify a valid odata or Redfish property.",
41                    "type": [
42                        "array",
43                        "boolean",
44                        "integer",
45                        "number",
46                        "null",
47                        "object",
48                        "string"
49                    ]
50                }
51            },
52            "properties": {
53                "@odata.context": {
54                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
55                },
56                "@odata.etag": {
57                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
58                },
59                "@odata.id": {
60                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
61                },
62                "@odata.type": {
63                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
64                },
65                "Actions": {
66                    "$ref": "#/definitions/Actions",
67                    "description": "The available actions for this resource.",
68                    "longDescription": "This property shall contain the available actions for this resource."
69                },
70                "Assembly": {
71                    "$ref": "http://redfish.dmtf.org/schemas/v1/Assembly.json#/definitions/Assembly",
72                    "description": "The link to the assembly associated with this filter.",
73                    "longDescription": "This property shall contain a link to a resource of type `Assembly`.",
74                    "readonly": true
75                },
76                "Description": {
77                    "anyOf": [
78                        {
79                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
80                        },
81                        {
82                            "type": "null"
83                        }
84                    ],
85                    "readonly": true
86                },
87                "HotPluggable": {
88                    "description": "An indication of whether this device can be inserted or removed while the equipment is in operation.",
89                    "longDescription": "This property shall indicate whether the device can be inserted or removed while the underlying equipment otherwise remains in its current operational state.  Devices indicated as hot-pluggable shall allow the device to become operable without altering the operational state of the underlying equipment.  Devices that cannot be inserted or removed from equipment in operation, or devices that cannot become operable without affecting the operational state of that equipment, shall be indicated as not hot-pluggable.",
90                    "readonly": true,
91                    "type": [
92                        "boolean",
93                        "null"
94                    ]
95                },
96                "Id": {
97                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
98                    "readonly": true
99                },
100                "Location": {
101                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location",
102                    "description": "The location of the filter.",
103                    "longDescription": "This property shall contain the location information of this filter."
104                },
105                "LocationIndicatorActive": {
106                    "description": "An indicator allowing an operator to physically locate this resource.",
107                    "longDescription": "This property shall contain the state of the indicator used to physically identify or locate this resource.",
108                    "readonly": false,
109                    "type": [
110                        "boolean",
111                        "null"
112                    ]
113                },
114                "Manufacturer": {
115                    "description": "The manufacturer of this filter.",
116                    "longDescription": "This property shall contain the name of the organization responsible for producing the filter.  This organization may be the entity from whom the filter is purchased, but this is not necessarily true.",
117                    "readonly": true,
118                    "type": [
119                        "string",
120                        "null"
121                    ]
122                },
123                "Model": {
124                    "description": "The model number for this filter.",
125                    "longDescription": "This property shall contain the model information as defined by the manufacturer for this filter.",
126                    "readonly": true,
127                    "type": [
128                        "string",
129                        "null"
130                    ]
131                },
132                "Name": {
133                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
134                    "readonly": true
135                },
136                "Oem": {
137                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
138                    "description": "The OEM extension property.",
139                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
140                },
141                "PartNumber": {
142                    "description": "The part number for this filter.",
143                    "longDescription": "This property shall contain the part number as defined by the manufacturer for this filter.",
144                    "readonly": true,
145                    "type": [
146                        "string",
147                        "null"
148                    ]
149                },
150                "PhysicalContext": {
151                    "$ref": "http://redfish.dmtf.org/schemas/v1/PhysicalContext.json#/definitions/PhysicalContext",
152                    "description": "The area or device associated with this filter.",
153                    "longDescription": "This property shall contain a description of the affected device or region within the chassis with which this filter is associated.",
154                    "readonly": true
155                },
156                "RatedServiceHours": {
157                    "description": "The rated hours of service life for this filter.",
158                    "longDescription": "This property shall contain the number of hours of service that the filter or filter media is rated to provide before servicing or replacement is necessary.",
159                    "readonly": true,
160                    "type": [
161                        "number",
162                        "null"
163                    ]
164                },
165                "Replaceable": {
166                    "description": "An indication of whether this component can be independently replaced as allowed by the vendor's replacement policy.",
167                    "longDescription": "This property shall indicate whether this component can be independently replaced as allowed by the vendor's replacement policy.  A value of `false` indicates the component needs to be replaced by policy as part of another component.  If the `LocationType` property of this component contains `Embedded`, this property shall contain `false`.",
168                    "readonly": true,
169                    "type": [
170                        "boolean",
171                        "null"
172                    ]
173                },
174                "SerialNumber": {
175                    "description": "The serial number for this filter.",
176                    "longDescription": "This property shall contain the serial number as defined by the manufacturer for this filter.",
177                    "readonly": true,
178                    "type": [
179                        "string",
180                        "null"
181                    ]
182                },
183                "ServiceHours": {
184                    "description": "The hours of service this filter has provided.",
185                    "longDescription": "This property shall contain the number of hours of service that the filter or filter media has provided.",
186                    "readonly": false,
187                    "type": [
188                        "number",
189                        "null"
190                    ]
191                },
192                "ServicedDate": {
193                    "description": "The date this filter was put into service.",
194                    "format": "date-time",
195                    "longDescription": "This property shall contain the date the filter or filter media was put into active service.",
196                    "readonly": false,
197                    "type": [
198                        "string",
199                        "null"
200                    ]
201                },
202                "SparePartNumber": {
203                    "description": "The spare part number for this filter.",
204                    "longDescription": "This property shall contain the spare or replacement part number as defined by the manufacturer for this filter.",
205                    "readonly": true,
206                    "type": [
207                        "string",
208                        "null"
209                    ]
210                },
211                "Status": {
212                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
213                    "description": "The status and health of the resource and its subordinate or dependent resources.",
214                    "longDescription": "This property shall contain any status or health properties of the resource."
215                },
216                "UserLabel": {
217                    "description": "A user-assigned label.",
218                    "longDescription": "This property shall contain a user-assigned label used to identify this resource.  If a value has not been assigned by a user, the value of this property shall be an empty string.",
219                    "readonly": false,
220                    "type": "string"
221                }
222            },
223            "required": [
224                "@odata.id",
225                "@odata.type",
226                "Id",
227                "Name"
228            ],
229            "type": "object"
230        },
231        "OemActions": {
232            "additionalProperties": true,
233            "description": "The available OEM-specific actions for this resource.",
234            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
235            "patternProperties": {
236                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
237                    "description": "This property shall specify a valid odata or Redfish property.",
238                    "type": [
239                        "array",
240                        "boolean",
241                        "integer",
242                        "number",
243                        "null",
244                        "object",
245                        "string"
246                    ]
247                }
248            },
249            "properties": {},
250            "type": "object"
251        }
252    },
253    "language": "en",
254    "owningEntity": "DMTF",
255    "release": "2023.1",
256    "title": "#Filter.v1_0_2.Filter"
257}