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