summaryrefslogtreecommitdiff
path: root/redfish-core/schema/dmtf/json-schema/ConnectionMethod.v1_3_0.json
blob: 83270959467db934c4bbe0739766e0ad6bcd1717 (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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
{
    "$id": "http://redfish.dmtf.org/schemas/v1/ConnectionMethod.v1_3_0.json",
    "$ref": "#/definitions/ConnectionMethod",
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
    "copyright": "Copyright 2014-2026 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
    "definitions": {
        "Actions": {
            "additionalProperties": false,
            "description": "The available actions for this resource.",
            "longDescription": "This type shall contain the available actions for this resource.",
            "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": {
                "Oem": {
                    "$ref": "#/definitions/OemActions",
                    "description": "The available OEM-specific actions for this resource.",
                    "longDescription": "This property shall contain the available OEM-specific actions for this resource."
                }
            },
            "type": "object"
        },
        "ConnectionMethod": {
            "additionalProperties": false,
            "description": "The `ConnectionMethod` schema describes the protocol, provider, or other method used to communicate to a given access point for a Redfish aggregation service.",
            "longDescription": "This resource shall represent a connection method for a Redfish implementation.",
            "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": {
                "@odata.context": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
                },
                "@odata.etag": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
                },
                "@odata.id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
                },
                "@odata.type": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
                },
                "Actions": {
                    "$ref": "#/definitions/Actions",
                    "description": "The available actions for this resource.",
                    "longDescription": "This property shall contain the available actions for this resource."
                },
                "ConnectionMethodType": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/ConnectionMethodType"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The type of connection method.",
                    "longDescription": "This property shall contain an identifier of the connection method.",
                    "readonly": true
                },
                "ConnectionMethodVariant": {
                    "description": "The variant of connection method.",
                    "longDescription": "This property shall contain an additional identifier of the connection method.  This property shall be present if `ConnectionMethodType` is `OEM`.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "Description": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "readonly": true
                },
                "Id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
                    "readonly": true
                },
                "Links": {
                    "$ref": "#/definitions/Links",
                    "description": "The links to other resources that are related to this resource.",
                    "longDescription": "This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource."
                },
                "Name": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
                    "readonly": true
                },
                "Oem": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
                    "description": "The OEM extension property.",
                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
                },
                "TunnelingProtocol": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/TunnelingProtocolType"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The tunneling protocol used for this connection method.",
                    "longDescription": "This property shall contain the tunneling protocol used for this connection method.",
                    "readonly": true,
                    "versionAdded": "v1_1_0"
                }
            },
            "required": [
                "@odata.id",
                "@odata.type",
                "Id",
                "Name"
            ],
            "type": "object"
        },
        "ConnectionMethodType": {
            "enum": [
                "Redfish",
                "SNMP",
                "SNMPv1",
                "SNMPv2c",
                "SNMPv3",
                "IPMI15",
                "IPMI20",
                "NETCONF",
                "OEM",
                "ModbusSerial",
                "ModbusTCP"
            ],
            "enumDeprecated": {
                "SNMP": "This value has been deprecated in favor of `SNMPv1`, `SNMPv2c`, and `SNMPv3` to provide the specific SNMP protocol version used by this connection method."
            },
            "enumDescriptions": {
                "IPMI15": "IPMI 1.5 connection method.",
                "IPMI20": "IPMI 2.0 connection method.",
                "ModbusSerial": "Modbus serial connection method.",
                "ModbusTCP": "Modbus TCP connection method.",
                "NETCONF": "NETCONF connection method.",
                "OEM": "OEM connection method.",
                "Redfish": "Redfish connection method.",
                "SNMP": "SNMP connection method.",
                "SNMPv1": "SNMPv1 connection method.",
                "SNMPv2c": "SNMPv2c connection method.",
                "SNMPv3": "SNMPv3 connection method."
            },
            "enumLongDescriptions": {
                "IPMI15": "This value shall indicate the connection method is IPMI 1.5.",
                "IPMI20": "This value shall indicate the connection method is IPMI 2.0.",
                "ModbusSerial": "This value shall indicate the connection method is Modbus serial (RTU).",
                "ModbusTCP": "This value shall indicate the connection method is Modbus TCP.",
                "NETCONF": "This value shall indicate the connection method is NETCONF.",
                "OEM": "This value shall indicate the connection method is OEM.  The `ConnectionMethodVariant` property shall contain further identification information.",
                "Redfish": "This value shall indicate the connection method is Redfish.",
                "SNMP": "This value shall indicate the connection method is SNMP.",
                "SNMPv1": "This value shall indicate the connection method is SNMPv1.",
                "SNMPv2c": "This value shall indicate the connection method is SNMPv2c.",
                "SNMPv3": "This value shall indicate the connection method is SNMPv3."
            },
            "enumVersionAdded": {
                "ModbusSerial": "v1_2_0",
                "ModbusTCP": "v1_2_0",
                "SNMPv1": "v1_3_0",
                "SNMPv2c": "v1_3_0",
                "SNMPv3": "v1_3_0"
            },
            "enumVersionDeprecated": {
                "SNMP": "v1_3_0"
            },
            "type": "string"
        },
        "Links": {
            "additionalProperties": false,
            "description": "The links to other resources that are related to this resource.",
            "longDescription": "This Redfish Specification-described type shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.",
            "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": {
                "AggregationSources": {
                    "description": "An array of links to the access points using this connection method.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/AggregationSource.json#/definitions/AggregationSource"
                    },
                    "longDescription": "This property shall contain an array of links to resources of type `AggregationSource` that are using this connection method.",
                    "readonly": true,
                    "type": "array"
                },
                "AggregationSources@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
                },
                "Oem": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
                    "description": "The OEM extension property.",
                    "longDescription": "This property shall contain the OEM extensions.  All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
                },
                "SerialInterface": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/SerialInterface.json#/definitions/SerialInterface",
                    "description": "The link to the serial interface for this connection method.",
                    "longDescription": "This property shall contain a link to a resource of type `SerialInterface` that represents the serial interface for this connection method.",
                    "readonly": true,
                    "versionAdded": "v1_2_0"
                }
            },
            "type": "object"
        },
        "OemActions": {
            "additionalProperties": true,
            "description": "The available OEM-specific actions for this resource.",
            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
            "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": {},
            "type": "object"
        },
        "TunnelingProtocolType": {
            "enum": [
                "SSH",
                "OEM"
            ],
            "enumDescriptions": {
                "OEM": "OEM tunneling.",
                "SSH": "SSH tunneling."
            },
            "enumLongDescriptions": {
                "OEM": "This value shall indicate that the tunneling protocol is OEM-specific.",
                "SSH": "This value shall indicate that the tunneling protocol is SSH."
            },
            "type": "string"
        }
    },
    "language": "en",
    "owningEntity": "DMTF",
    "release": "2026.1",
    "title": "#ConnectionMethod.v1_3_0.ConnectionMethod"
}