Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 262d7d4ba6b43ede7edde97765f7d710f29c862f / . / static / redfish / v1 / JsonSchemas / ConnectionMethod / ConnectionMethod.json
blob: 4c6fc51ca1d63b2267ee2f49fc24f871a1675019 [file] [log] [blame]
Gunnar Mills844b4152020-06-22 12:44:09 -0500[diff] [blame]1{
2 "$id": "http://redfish.dmtf.org/schemas/v1/ConnectionMethod.v1_0_0.json",
3 "$ref": "#/definitions/ConnectionMethod",
4 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
5 "copyright": "Copyright 2014-2020 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 "ConnectionMethod": {
35 "additionalProperties": false,
36 "description": "The ConnectionMethod schema describes the protocol, provider, or other method used to communicate to a given access point for a Redfish aggregation service.",
37 "longDescription": "This resource shall represent a connection method 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 "ConnectionMethodType": {
71 "anyOf": [
72 {
73 "$ref": "#/definitions/ConnectionMethodType"
74 },
75 {
76 "type": "null"
77 }
78 ],
79 "description": "The type of connection method.",
80 "longDescription": "This property shall contain an identifier of the connection method.",
81 "readonly": true
82 },
83 "ConnectionMethodVariant": {
84 "description": "The variant of connection method.",
85 "longDescription": "This property shall contain an additional identifier of the connection method. This property shall be present if ConnectionMethodType is `OEM`.",
86 "readonly": true,
87 "type": [
88 "string",
89 "null"
90 ]
91 },
92 "Description": {
93 "anyOf": [
94 {
95 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
96 },
97 {
98 "type": "null"
99 }
100 ],
101 "readonly": true
102 },
103 "Id": {
104 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
105 "readonly": true
106 },
107 "Links": {
108 "$ref": "#/definitions/Links",
109 "description": "The links to other resources that are related to this resource.",
110 "longDescription": "This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource."
111 },
112 "Name": {
113 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
114 "readonly": true
115 },
116 "Oem": {
117 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
118 "description": "The OEM extension property.",
119 "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
120 }
121 },
122 "required": [
123 "@odata.id",
124 "@odata.type",
125 "Id",
126 "Name"
127 ],
128 "type": "object"
129 },
130 "ConnectionMethodType": {
131 "enum": [
132 "Redfish",
133 "SNMP",
134 "IPMI15",
135 "IPMI20",
136 "NETCONF",
137 "OEM"
138 ],
139 "enumDescriptions": {
140 "IPMI15": "IPMI 1.5 connection method.",
141 "IPMI20": "IPMI 2.0 connection method.",
142 "NETCONF": "NETCONF connection method.",
143 "OEM": "OEM connection method.",
144 "Redfish": "Redfish connection method.",
145 "SNMP": "SNMP connection method."
146 },
147 "enumLongDescriptions": {
148 "IPMI15": "This value shall indicate the connection method is IPMI 1.5.",
149 "IPMI20": "This value shall indicate the connection method is IPMI 2.0.",
150 "NETCONF": "This value shall indicate the connection method is NETCONF.",
151 "OEM": "This value shall indicate the connection method is OEM. The ConnectionMethodVariant property shall contain further identification information.",
152 "Redfish": "This value shall indicate the connection method is Redfish.",
153 "SNMP": "This value shall indicate the connection method is SNMP."
154 },
155 "type": "string"
156 },
157 "Links": {
158 "additionalProperties": false,
159 "description": "The links to other resources that are related to this resource.",
160 "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.",
161 "patternProperties": {
162 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
163 "description": "This property shall specify a valid odata or Redfish property.",
164 "type": [
165 "array",
166 "boolean",
167 "integer",
168 "number",
169 "null",
170 "object",
171 "string"
172 ]
173 }
174 },
175 "properties": {
176 "AggregationSources": {
177 "description": "An array of links to the access points using this connection method.",
178 "items": {
179 "$ref": "http://redfish.dmtf.org/schemas/v1/AggregationSource.json#/definitions/AggregationSource"
180 },
181 "longDescription": "This property shall contain an array of links to resources of type AggregationSource that are using this connection method.",
182 "readonly": true,
183 "type": "array"
184 },
185 "AggregationSources@odata.count": {
186 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
187 },
188 "Oem": {
189 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
190 "description": "The OEM extension property.",
191 "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
192 }
193 },
194 "type": "object"
195 },
196 "OemActions": {
197 "additionalProperties": true,
198 "description": "The available OEM-specific actions for this resource.",
199 "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
200 "patternProperties": {
201 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
202 "description": "This property shall specify a valid odata or Redfish property.",
203 "type": [
204 "array",
205 "boolean",
206 "integer",
207 "number",
208 "null",
209 "object",
210 "string"
211 ]
212 }
213 },
214 "properties": {},
215 "type": "object"
216 }
217 },
218 "owningEntity": "DMTF",
219 "release": "2020.2",
220 "title": "#ConnectionMethod.v1_0_0.ConnectionMethod"
221}