1{ 2 "$id": "http://redfish.dmtf.org/schemas/v1/Container.v1_0_1.json", 3 "$ref": "#/definitions/Container", 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 "#Container.Reset": { 27 "$ref": "#/definitions/Reset" 28 }, 29 "Oem": { 30 "$ref": "#/definitions/OemActions", 31 "description": "The available OEM-specific actions for this resource.", 32 "longDescription": "This property shall contain the available OEM-specific actions for this resource." 33 } 34 }, 35 "type": "object" 36 }, 37 "Container": { 38 "additionalProperties": false, 39 "description": "The `Container` schema represents an instance of a container that is running on a computer system.", 40 "longDescription": "This resource shall represent an instance of a container that is running on a computer system.", 41 "patternProperties": { 42 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 43 "description": "This property shall specify a valid odata or Redfish property.", 44 "type": [ 45 "array", 46 "boolean", 47 "integer", 48 "number", 49 "null", 50 "object", 51 "string" 52 ] 53 } 54 }, 55 "properties": { 56 "@odata.context": { 57 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" 58 }, 59 "@odata.etag": { 60 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" 61 }, 62 "@odata.id": { 63 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" 64 }, 65 "@odata.type": { 66 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" 67 }, 68 "Actions": { 69 "$ref": "#/definitions/Actions", 70 "description": "The available actions for this resource.", 71 "longDescription": "This property shall contain the available actions for this resource." 72 }, 73 "Description": { 74 "anyOf": [ 75 { 76 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" 77 }, 78 { 79 "type": "null" 80 } 81 ], 82 "readonly": true 83 }, 84 "EthernetInterfaces": { 85 "$ref": "http://redfish.dmtf.org/schemas/v1/EthernetInterfaceCollection.json#/definitions/EthernetInterfaceCollection", 86 "description": "The link to the collection of Ethernet interfaces associated with this container.", 87 "longDescription": "This property shall contain a link to a resource collection of type `EthernetInterfaceCollection`.", 88 "readonly": true 89 }, 90 "Id": { 91 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", 92 "readonly": true 93 }, 94 "Limits": { 95 "$ref": "#/definitions/Limits", 96 "description": "The resource limits allocated to this container.", 97 "longDescription": "This property shall contain the resource limits allocated to this container." 98 }, 99 "Links": { 100 "$ref": "#/definitions/Links", 101 "description": "The links to other resources that are related to this resource.", 102 "longDescription": "This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource." 103 }, 104 "MountPoints": { 105 "description": "The file system mount points configured for this container.", 106 "items": { 107 "anyOf": [ 108 { 109 "$ref": "#/definitions/MountPoint" 110 }, 111 { 112 "type": "null" 113 } 114 ] 115 }, 116 "longDescription": "This property shall contain the file system mount points configured for this container.", 117 "type": "array" 118 }, 119 "Name": { 120 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", 121 "readonly": true 122 }, 123 "Oem": { 124 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", 125 "description": "The OEM extension property.", 126 "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements." 127 }, 128 "ProgrammaticId": { 129 "description": "The programmatic identifier for this container.", 130 "longDescription": "This property shall contain the programmatic identifier for this container. This is typically a hash string that represents the running instance of this container.", 131 "readonly": true, 132 "type": [ 133 "string", 134 "null" 135 ] 136 }, 137 "StartTime": { 138 "description": "The date and time when the container started running.", 139 "format": "date-time", 140 "longDescription": "This property shall indicate the date and time when the container started running.", 141 "readonly": true, 142 "type": [ 143 "string", 144 "null" 145 ] 146 }, 147 "Status": { 148 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", 149 "description": "The status and health of the resource and its subordinate or dependent resources.", 150 "longDescription": "This property shall contain any status or health properties of the resource." 151 } 152 }, 153 "required": [ 154 "@odata.id", 155 "@odata.type", 156 "Id", 157 "Name" 158 ], 159 "type": "object" 160 }, 161 "Limits": { 162 "additionalProperties": false, 163 "description": "The resource limits allocated to a container.", 164 "longDescription": "This type shall contain the resource limits allocated to a container.", 165 "patternProperties": { 166 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 167 "description": "This property shall specify a valid odata or Redfish property.", 168 "type": [ 169 "array", 170 "boolean", 171 "integer", 172 "number", 173 "null", 174 "object", 175 "string" 176 ] 177 } 178 }, 179 "properties": { 180 "CPUCount": { 181 "description": "The number of processors available to this container.", 182 "longDescription": "This property shall contain the number of processors available to this container.", 183 "readonly": true, 184 "type": [ 185 "number", 186 "null" 187 ] 188 }, 189 "MemoryBytes": { 190 "description": "The amount of memory available to this container in bytes.", 191 "longDescription": "This property shall contain the amount of memory available to this container in bytes.", 192 "readonly": true, 193 "type": [ 194 "integer", 195 "null" 196 ], 197 "units": "By" 198 } 199 }, 200 "type": "object" 201 }, 202 "Links": { 203 "additionalProperties": false, 204 "description": "The links to other resources that are related to this resource.", 205 "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.", 206 "patternProperties": { 207 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 208 "description": "This property shall specify a valid odata or Redfish property.", 209 "type": [ 210 "array", 211 "boolean", 212 "integer", 213 "number", 214 "null", 215 "object", 216 "string" 217 ] 218 } 219 }, 220 "properties": { 221 "ContainerImage": { 222 "$ref": "http://redfish.dmtf.org/schemas/v1/ContainerImage.json#/definitions/ContainerImage", 223 "description": "The link to the container image for this container.", 224 "longDescription": "This property shall contain a link to a resource of type `ContainerImage` that represents the container image for this container.", 225 "readonly": true 226 }, 227 "Oem": { 228 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", 229 "description": "The OEM extension property.", 230 "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements." 231 } 232 }, 233 "type": "object" 234 }, 235 "MountPoint": { 236 "additionalProperties": false, 237 "description": "A file system mount point configured for a container.", 238 "longDescription": "This type shall contain a file system mount point configured for a container.", 239 "patternProperties": { 240 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 241 "description": "This property shall specify a valid odata or Redfish property.", 242 "type": [ 243 "array", 244 "boolean", 245 "integer", 246 "number", 247 "null", 248 "object", 249 "string" 250 ] 251 } 252 }, 253 "properties": { 254 "Destination": { 255 "description": "The file system path in the container that is provided as the mount point to access the files and folders contained in the source path.", 256 "longDescription": "This property shall contain the file system path in the container that is provided as the mount point to access the files and folders specified by the `Source` property.", 257 "readonly": true, 258 "type": [ 259 "string", 260 "null" 261 ] 262 }, 263 "Source": { 264 "description": "The file system path from the hosting system that is provided to this container.", 265 "longDescription": "This property shall contain the file system path from the hosting system that is provided to this container.", 266 "readonly": true, 267 "type": [ 268 "string", 269 "null" 270 ] 271 } 272 }, 273 "type": "object" 274 }, 275 "OemActions": { 276 "additionalProperties": true, 277 "description": "The available OEM-specific actions for this resource.", 278 "longDescription": "This type shall contain the available OEM-specific actions for this resource.", 279 "patternProperties": { 280 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 281 "description": "This property shall specify a valid odata or Redfish property.", 282 "type": [ 283 "array", 284 "boolean", 285 "integer", 286 "number", 287 "null", 288 "object", 289 "string" 290 ] 291 } 292 }, 293 "properties": {}, 294 "type": "object" 295 }, 296 "Reset": { 297 "additionalProperties": false, 298 "description": "This action resets the container.", 299 "longDescription": "This action shall reset the container.", 300 "parameters": { 301 "ResetType": { 302 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/ResetType", 303 "description": "The type of reset.", 304 "longDescription": "This parameter shall contain the type of reset. `GracefulRestart` and `ForceRestart` shall indicate requests to restart the container. `GracefulShutdown` and `ForceOff` shall indicate requests to stop or disable the container. `On` and `ForceOn` shall indicate requests to start or enable the container. The service can accept a request without the parameter and shall perform a `GracefulRestart`." 305 } 306 }, 307 "patternProperties": { 308 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 309 "description": "This property shall specify a valid odata or Redfish property.", 310 "type": [ 311 "array", 312 "boolean", 313 "integer", 314 "number", 315 "null", 316 "object", 317 "string" 318 ] 319 } 320 }, 321 "properties": { 322 "target": { 323 "description": "Link to invoke action", 324 "format": "uri-reference", 325 "type": "string" 326 }, 327 "title": { 328 "description": "Friendly action name", 329 "type": "string" 330 } 331 }, 332 "type": "object" 333 } 334 }, 335 "language": "en", 336 "owningEntity": "DMTF", 337 "release": "2023.2", 338 "title": "#Container.v1_0_1.Container" 339}