1*f2a8e57eSGunnar Mills{
2*f2a8e57eSGunnar Mills    "$id": "http://redfish.dmtf.org/schemas/v1/EndpointGroup.v1_3_4.json",
3*f2a8e57eSGunnar Mills    "$ref": "#/definitions/EndpointGroup",
4*f2a8e57eSGunnar Mills    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
5*f2a8e57eSGunnar Mills    "copyright": "Copyright 2014-2024 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
6*f2a8e57eSGunnar Mills    "definitions": {
7*f2a8e57eSGunnar Mills        "Actions": {
8*f2a8e57eSGunnar Mills            "additionalProperties": false,
9*f2a8e57eSGunnar Mills            "description": "The available actions for this resource.",
10*f2a8e57eSGunnar Mills            "longDescription": "This type shall contain the available actions for this resource.",
11*f2a8e57eSGunnar Mills            "patternProperties": {
12*f2a8e57eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
13*f2a8e57eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
14*f2a8e57eSGunnar Mills                    "type": [
15*f2a8e57eSGunnar Mills                        "array",
16*f2a8e57eSGunnar Mills                        "boolean",
17*f2a8e57eSGunnar Mills                        "integer",
18*f2a8e57eSGunnar Mills                        "number",
19*f2a8e57eSGunnar Mills                        "null",
20*f2a8e57eSGunnar Mills                        "object",
21*f2a8e57eSGunnar Mills                        "string"
22*f2a8e57eSGunnar Mills                    ]
23*f2a8e57eSGunnar Mills                }
24*f2a8e57eSGunnar Mills            },
25*f2a8e57eSGunnar Mills            "properties": {
26*f2a8e57eSGunnar Mills                "Oem": {
27*f2a8e57eSGunnar Mills                    "$ref": "#/definitions/OemActions",
28*f2a8e57eSGunnar Mills                    "description": "The available OEM-specific actions for this resource.",
29*f2a8e57eSGunnar Mills                    "longDescription": "This property shall contain the available OEM-specific actions for this resource.",
30*f2a8e57eSGunnar Mills                    "versionAdded": "v1_1_0"
31*f2a8e57eSGunnar Mills                }
32*f2a8e57eSGunnar Mills            },
33*f2a8e57eSGunnar Mills            "type": "object"
34*f2a8e57eSGunnar Mills        },
35*f2a8e57eSGunnar Mills        "EndpointGroup": {
36*f2a8e57eSGunnar Mills            "additionalProperties": false,
37*f2a8e57eSGunnar Mills            "description": "The `EndpointGroup` schema describes a group of endpoints that are managed as a unit.",
38*f2a8e57eSGunnar Mills            "longDescription": "This resource shall represent a group of endpoints that are managed as a unit for a Redfish implementation.",
39*f2a8e57eSGunnar Mills            "patternProperties": {
40*f2a8e57eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
41*f2a8e57eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
42*f2a8e57eSGunnar Mills                    "type": [
43*f2a8e57eSGunnar Mills                        "array",
44*f2a8e57eSGunnar Mills                        "boolean",
45*f2a8e57eSGunnar Mills                        "integer",
46*f2a8e57eSGunnar Mills                        "number",
47*f2a8e57eSGunnar Mills                        "null",
48*f2a8e57eSGunnar Mills                        "object",
49*f2a8e57eSGunnar Mills                        "string"
50*f2a8e57eSGunnar Mills                    ]
51*f2a8e57eSGunnar Mills                }
52*f2a8e57eSGunnar Mills            },
53*f2a8e57eSGunnar Mills            "properties": {
54*f2a8e57eSGunnar Mills                "@odata.context": {
55*f2a8e57eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
56*f2a8e57eSGunnar Mills                },
57*f2a8e57eSGunnar Mills                "@odata.etag": {
58*f2a8e57eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
59*f2a8e57eSGunnar Mills                },
60*f2a8e57eSGunnar Mills                "@odata.id": {
61*f2a8e57eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
62*f2a8e57eSGunnar Mills                },
63*f2a8e57eSGunnar Mills                "@odata.type": {
64*f2a8e57eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
65*f2a8e57eSGunnar Mills                },
66*f2a8e57eSGunnar Mills                "AccessState": {
67*f2a8e57eSGunnar Mills                    "anyOf": [
68*f2a8e57eSGunnar Mills                        {
69*f2a8e57eSGunnar Mills                            "$ref": "http://redfish.dmtf.org/schemas/v1/EndpointGroup.json#/definitions/AccessState"
70*f2a8e57eSGunnar Mills                        },
71*f2a8e57eSGunnar Mills                        {
72*f2a8e57eSGunnar Mills                            "type": "null"
73*f2a8e57eSGunnar Mills                        }
74*f2a8e57eSGunnar Mills                    ],
75*f2a8e57eSGunnar Mills                    "deprecated": "This property has been deprecated in favor of the `AccessState` property in the connection resource.",
76*f2a8e57eSGunnar Mills                    "description": "The access state for this group.",
77*f2a8e57eSGunnar Mills                    "longDescription": "The value of this property shall contain the access state for all associated resources in this endpoint group.",
78*f2a8e57eSGunnar Mills                    "readonly": false,
79*f2a8e57eSGunnar Mills                    "versionDeprecated": "v1_3_0"
80*f2a8e57eSGunnar Mills                },
81*f2a8e57eSGunnar Mills                "Actions": {
82*f2a8e57eSGunnar Mills                    "$ref": "#/definitions/Actions",
83*f2a8e57eSGunnar Mills                    "description": "The available actions for this resource.",
84*f2a8e57eSGunnar Mills                    "longDescription": "This property shall contain the available actions for this resource.",
85*f2a8e57eSGunnar Mills                    "versionAdded": "v1_1_0"
86*f2a8e57eSGunnar Mills                },
87*f2a8e57eSGunnar Mills                "Description": {
88*f2a8e57eSGunnar Mills                    "anyOf": [
89*f2a8e57eSGunnar Mills                        {
90*f2a8e57eSGunnar Mills                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
91*f2a8e57eSGunnar Mills                        },
92*f2a8e57eSGunnar Mills                        {
93*f2a8e57eSGunnar Mills                            "type": "null"
94*f2a8e57eSGunnar Mills                        }
95*f2a8e57eSGunnar Mills                    ],
96*f2a8e57eSGunnar Mills                    "readonly": true
97*f2a8e57eSGunnar Mills                },
98*f2a8e57eSGunnar Mills                "Endpoints": {
99*f2a8e57eSGunnar Mills                    "deprecated": "This property has been deprecated in favor of the `Endpoints` property within `Links`.",
100*f2a8e57eSGunnar Mills                    "description": "The endpoints in this endpoint group.",
101*f2a8e57eSGunnar Mills                    "items": {
102*f2a8e57eSGunnar Mills                        "$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint"
103*f2a8e57eSGunnar Mills                    },
104*f2a8e57eSGunnar Mills                    "longDescription": "This property shall contain an array of links to resources of type `Endpoint` that represent the endpoints that are in this endpoint group.",
105*f2a8e57eSGunnar Mills                    "readonly": false,
106*f2a8e57eSGunnar Mills                    "type": "array",
107*f2a8e57eSGunnar Mills                    "versionDeprecated": "v1_3_0"
108*f2a8e57eSGunnar Mills                },
109*f2a8e57eSGunnar Mills                "Endpoints@odata.count": {
110*f2a8e57eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
111*f2a8e57eSGunnar Mills                },
112*f2a8e57eSGunnar Mills                "GroupType": {
113*f2a8e57eSGunnar Mills                    "anyOf": [
114*f2a8e57eSGunnar Mills                        {
115*f2a8e57eSGunnar Mills                            "$ref": "#/definitions/GroupType"
116*f2a8e57eSGunnar Mills                        },
117*f2a8e57eSGunnar Mills                        {
118*f2a8e57eSGunnar Mills                            "type": "null"
119*f2a8e57eSGunnar Mills                        }
120*f2a8e57eSGunnar Mills                    ],
121*f2a8e57eSGunnar Mills                    "description": "The endpoint group type.",
122*f2a8e57eSGunnar Mills                    "longDescription": "The value of this property shall contain the endpoint group type.  If this endpoint group represents a SCSI target group, the value of this property shall contain `Server` or `Target`.",
123*f2a8e57eSGunnar Mills                    "readonly": false
124*f2a8e57eSGunnar Mills                },
125*f2a8e57eSGunnar Mills                "Id": {
126*f2a8e57eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
127*f2a8e57eSGunnar Mills                    "readonly": true
128*f2a8e57eSGunnar Mills                },
129*f2a8e57eSGunnar Mills                "Identifier": {
130*f2a8e57eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Identifier",
131*f2a8e57eSGunnar Mills                    "description": "The durable name for the endpoint group.",
132*f2a8e57eSGunnar Mills                    "longDescription": "This property shall contain the durable name for the endpoint group."
133*f2a8e57eSGunnar Mills                },
134*f2a8e57eSGunnar Mills                "Links": {
135*f2a8e57eSGunnar Mills                    "$ref": "#/definitions/Links",
136*f2a8e57eSGunnar Mills                    "description": "The links to other resources that are related to this resource.",
137*f2a8e57eSGunnar Mills                    "longDescription": "This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource."
138*f2a8e57eSGunnar Mills                },
139*f2a8e57eSGunnar Mills                "Name": {
140*f2a8e57eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
141*f2a8e57eSGunnar Mills                    "readonly": true
142*f2a8e57eSGunnar Mills                },
143*f2a8e57eSGunnar Mills                "Oem": {
144*f2a8e57eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
145*f2a8e57eSGunnar Mills                    "description": "The OEM extension property.",
146*f2a8e57eSGunnar Mills                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
147*f2a8e57eSGunnar Mills                },
148*f2a8e57eSGunnar Mills                "Preferred": {
149*f2a8e57eSGunnar Mills                    "deprecated": "This property has been deprecated in favor of the `AccessState` property in the connection resource.",
150*f2a8e57eSGunnar Mills                    "description": "An indication if access to the resources through the endpoint group is preferred.",
151*f2a8e57eSGunnar Mills                    "longDescription": "The value of this property shall indicate if access to the resources through the endpoint group is preferred over access through other endpoints.  The default value for this property is `false`.",
152*f2a8e57eSGunnar Mills                    "readonly": false,
153*f2a8e57eSGunnar Mills                    "type": [
154*f2a8e57eSGunnar Mills                        "boolean",
155*f2a8e57eSGunnar Mills                        "null"
156*f2a8e57eSGunnar Mills                    ],
157*f2a8e57eSGunnar Mills                    "versionDeprecated": "v1_2_0"
158*f2a8e57eSGunnar Mills                },
159*f2a8e57eSGunnar Mills                "TargetEndpointGroupIdentifier": {
160*f2a8e57eSGunnar Mills                    "description": "The SCSI-defined identifier for this group.",
161*f2a8e57eSGunnar Mills                    "longDescription": "The value of this property shall contain a SCSI-defined identifier for this group that corresponds to the TARGET PORT GROUP field in the REPORT TARGET PORT GROUPS response and the TARGET PORT GROUP field in an INQUIRY VPD page 85 response, type 5h identifier.  See the INCITS SAM-5 specification.  This property may not be present if the endpoint group does not represent a SCSI target group.",
162*f2a8e57eSGunnar Mills                    "readonly": false,
163*f2a8e57eSGunnar Mills                    "type": [
164*f2a8e57eSGunnar Mills                        "integer",
165*f2a8e57eSGunnar Mills                        "null"
166*f2a8e57eSGunnar Mills                    ]
167*f2a8e57eSGunnar Mills                }
168*f2a8e57eSGunnar Mills            },
169*f2a8e57eSGunnar Mills            "required": [
170*f2a8e57eSGunnar Mills                "@odata.id",
171*f2a8e57eSGunnar Mills                "@odata.type",
172*f2a8e57eSGunnar Mills                "Id",
173*f2a8e57eSGunnar Mills                "Name"
174*f2a8e57eSGunnar Mills            ],
175*f2a8e57eSGunnar Mills            "type": "object"
176*f2a8e57eSGunnar Mills        },
177*f2a8e57eSGunnar Mills        "GroupType": {
178*f2a8e57eSGunnar Mills            "enum": [
179*f2a8e57eSGunnar Mills                "Client",
180*f2a8e57eSGunnar Mills                "Server",
181*f2a8e57eSGunnar Mills                "Initiator",
182*f2a8e57eSGunnar Mills                "Target"
183*f2a8e57eSGunnar Mills            ],
184*f2a8e57eSGunnar Mills            "enumDeprecated": {
185*f2a8e57eSGunnar Mills                "Client": "This value has been deprecated in favor of `Initiator`.",
186*f2a8e57eSGunnar Mills                "Server": "This value has been deprecated in favor of `Target`."
187*f2a8e57eSGunnar Mills            },
188*f2a8e57eSGunnar Mills            "enumDescriptions": {
189*f2a8e57eSGunnar Mills                "Client": "The group contains the client (initiator) endpoints.",
190*f2a8e57eSGunnar Mills                "Initiator": "The group contains the initiator endpoints.",
191*f2a8e57eSGunnar Mills                "Server": "The group contains the server (target) endpoints.",
192*f2a8e57eSGunnar Mills                "Target": "The group contains the target endpoints."
193*f2a8e57eSGunnar Mills            },
194*f2a8e57eSGunnar Mills            "enumLongDescriptions": {
195*f2a8e57eSGunnar Mills                "Client": "This value shall indicate that the endpoint group contains client (initiator) endpoints.  If the associated endpoints contain the `EntityRole` property, the `EntityRole` property shall contain the value `Initiator` or `Both`.",
196*f2a8e57eSGunnar Mills                "Initiator": "This value shall indicate that the endpoint group contains initiator endpoints.  If the associated endpoints contain the `EntityRole` property, the `EntityRole` property shall contain the value `Initiator` or `Both`.",
197*f2a8e57eSGunnar Mills                "Server": "This value shall indicate that the endpoint group contains server (target) endpoints.  If the associated endpoints contain the `EntityRole` property, the `EntityRole` property shall contain the value `Target` or `Both`.",
198*f2a8e57eSGunnar Mills                "Target": "This value shall indicate that the endpoint group contains target endpoints.  If the associated endpoints contain the `EntityRole` property, the `EntityRole` property shall contain the value `Target` or `Both`."
199*f2a8e57eSGunnar Mills            },
200*f2a8e57eSGunnar Mills            "enumVersionAdded": {
201*f2a8e57eSGunnar Mills                "Initiator": "v1_3_0",
202*f2a8e57eSGunnar Mills                "Target": "v1_3_0"
203*f2a8e57eSGunnar Mills            },
204*f2a8e57eSGunnar Mills            "enumVersionDeprecated": {
205*f2a8e57eSGunnar Mills                "Client": "v1_3_0",
206*f2a8e57eSGunnar Mills                "Server": "v1_3_0"
207*f2a8e57eSGunnar Mills            },
208*f2a8e57eSGunnar Mills            "type": "string"
209*f2a8e57eSGunnar Mills        },
210*f2a8e57eSGunnar Mills        "Links": {
211*f2a8e57eSGunnar Mills            "additionalProperties": false,
212*f2a8e57eSGunnar Mills            "description": "The links to other resources that are related to this resource.",
213*f2a8e57eSGunnar Mills            "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.",
214*f2a8e57eSGunnar Mills            "patternProperties": {
215*f2a8e57eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
216*f2a8e57eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
217*f2a8e57eSGunnar Mills                    "type": [
218*f2a8e57eSGunnar Mills                        "array",
219*f2a8e57eSGunnar Mills                        "boolean",
220*f2a8e57eSGunnar Mills                        "integer",
221*f2a8e57eSGunnar Mills                        "number",
222*f2a8e57eSGunnar Mills                        "null",
223*f2a8e57eSGunnar Mills                        "object",
224*f2a8e57eSGunnar Mills                        "string"
225*f2a8e57eSGunnar Mills                    ]
226*f2a8e57eSGunnar Mills                }
227*f2a8e57eSGunnar Mills            },
228*f2a8e57eSGunnar Mills            "properties": {
229*f2a8e57eSGunnar Mills                "Connections": {
230*f2a8e57eSGunnar Mills                    "description": "The connections to which this endpoint group belongs.",
231*f2a8e57eSGunnar Mills                    "items": {
232*f2a8e57eSGunnar Mills                        "$ref": "http://redfish.dmtf.org/schemas/v1/Connection.json#/definitions/Connection"
233*f2a8e57eSGunnar Mills                    },
234*f2a8e57eSGunnar Mills                    "longDescription": "This property shall contain an array of links to resources of type `Connection` that represent the connections to which this endpoint group belongs.",
235*f2a8e57eSGunnar Mills                    "readonly": true,
236*f2a8e57eSGunnar Mills                    "type": "array",
237*f2a8e57eSGunnar Mills                    "versionAdded": "v1_3_0"
238*f2a8e57eSGunnar Mills                },
239*f2a8e57eSGunnar Mills                "Connections@odata.count": {
240*f2a8e57eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
241*f2a8e57eSGunnar Mills                },
242*f2a8e57eSGunnar Mills                "Endpoints": {
243*f2a8e57eSGunnar Mills                    "description": "The endpoints in this endpoint group.",
244*f2a8e57eSGunnar Mills                    "items": {
245*f2a8e57eSGunnar Mills                        "$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint"
246*f2a8e57eSGunnar Mills                    },
247*f2a8e57eSGunnar Mills                    "longDescription": "This property shall contain an array of links to resources of type `Endpoint` that represent the endpoints that are in this endpoint group.",
248*f2a8e57eSGunnar Mills                    "readonly": false,
249*f2a8e57eSGunnar Mills                    "type": "array",
250*f2a8e57eSGunnar Mills                    "versionAdded": "v1_3_0"
251*f2a8e57eSGunnar Mills                },
252*f2a8e57eSGunnar Mills                "Endpoints@odata.count": {
253*f2a8e57eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
254*f2a8e57eSGunnar Mills                },
255*f2a8e57eSGunnar Mills                "Oem": {
256*f2a8e57eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
257*f2a8e57eSGunnar Mills                    "description": "The OEM extension property.",
258*f2a8e57eSGunnar Mills                    "longDescription": "This property shall contain the OEM extensions.  All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
259*f2a8e57eSGunnar Mills                }
260*f2a8e57eSGunnar Mills            },
261*f2a8e57eSGunnar Mills            "type": "object"
262*f2a8e57eSGunnar Mills        },
263*f2a8e57eSGunnar Mills        "OemActions": {
264*f2a8e57eSGunnar Mills            "additionalProperties": true,
265*f2a8e57eSGunnar Mills            "description": "The available OEM-specific actions for this resource.",
266*f2a8e57eSGunnar Mills            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
267*f2a8e57eSGunnar Mills            "patternProperties": {
268*f2a8e57eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
269*f2a8e57eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
270*f2a8e57eSGunnar Mills                    "type": [
271*f2a8e57eSGunnar Mills                        "array",
272*f2a8e57eSGunnar Mills                        "boolean",
273*f2a8e57eSGunnar Mills                        "integer",
274*f2a8e57eSGunnar Mills                        "number",
275*f2a8e57eSGunnar Mills                        "null",
276*f2a8e57eSGunnar Mills                        "object",
277*f2a8e57eSGunnar Mills                        "string"
278*f2a8e57eSGunnar Mills                    ]
279*f2a8e57eSGunnar Mills                }
280*f2a8e57eSGunnar Mills            },
281*f2a8e57eSGunnar Mills            "properties": {},
282*f2a8e57eSGunnar Mills            "type": "object"
283*f2a8e57eSGunnar Mills        }
284*f2a8e57eSGunnar Mills    },
285*f2a8e57eSGunnar Mills    "language": "en",
286*f2a8e57eSGunnar Mills    "owningEntity": "DMTF",
287*f2a8e57eSGunnar Mills    "release": "2020.3",
288*f2a8e57eSGunnar Mills    "title": "#EndpointGroup.v1_3_4.EndpointGroup"
289*f2a8e57eSGunnar Mills}