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