blob: 3cdd0a6f2b5c55163ed8173ff9964b128672d812 [file] [log] [blame]
{
"$id": "http://redfish.dmtf.org/schemas/v1/Aggregate.v1_0_1.json",
"$ref": "#/definitions/Aggregate",
"$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
"copyright": "Copyright 2014-2020 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
"definitions": {
"Actions": {
"additionalProperties": false,
"description": "The available actions for this resource.",
"longDescription": "This type shall contain the available actions for this resource.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"#Aggregate.AddElements": {
"$ref": "#/definitions/AddElements"
},
"#Aggregate.RemoveElements": {
"$ref": "#/definitions/RemoveElements"
},
"#Aggregate.Reset": {
"$ref": "#/definitions/Reset"
},
"#Aggregate.SetDefaultBootOrder": {
"$ref": "#/definitions/SetDefaultBootOrder"
},
"Oem": {
"$ref": "#/definitions/OemActions",
"description": "The available OEM-specific actions for this resource.",
"longDescription": "This property shall contain the available OEM-specific actions for this resource."
}
},
"type": "object"
},
"AddElements": {
"additionalProperties": false,
"description": "This action is used to add one or more resources to the aggregate.",
"longDescription": "This action shall add one or more resources to the aggregate, resulting in that the resources are included in the Elements array of the aggregate.",
"parameters": {
"Elements": {
"description": "An array of resource links to add to the Elements array.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Resource"
},
"longDescription": "This parameter shall contain an array of links to the specified resources to add to the aggregate's Elements array.",
"requiredParameter": true,
"type": "array"
}
},
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"target": {
"description": "Link to invoke action",
"format": "uri-reference",
"type": "string"
},
"title": {
"description": "Friendly action name",
"type": "string"
}
},
"type": "object"
},
"Aggregate": {
"additionalProperties": false,
"description": "The Aggregate schema describes a grouping method for an aggregation service. Aggregates are formal groups of resources that are more persistent than ad hoc groupings.",
"longDescription": "This resource shall represent an aggregation service grouping method for a Redfish implementation.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"@odata.context": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
},
"@odata.etag": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
},
"@odata.id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
},
"@odata.type": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
},
"Actions": {
"$ref": "#/definitions/Actions",
"description": "The available actions for this resource.",
"longDescription": "This property shall contain the available actions for this resource."
},
"Description": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
},
{
"type": "null"
}
],
"readonly": true
},
"Elements": {
"description": "The elements of this aggregate.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Resource"
},
"longDescription": "This property shall contain an array of links to the elements of this aggregate.",
"readonly": true,
"type": "array"
},
"Elements@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
},
"ElementsCount": {
"description": "The number of entries in the Elements array.",
"longDescription": "This property shall contain the number of entries in the Elements array.",
"minimum": 0,
"readonly": true,
"type": [
"integer",
"null"
]
},
"Id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
"readonly": true
},
"Name": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
"readonly": true
},
"Oem": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
"description": "The OEM extension property.",
"longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
}
},
"required": [
"Elements",
"@odata.id",
"@odata.type",
"Id",
"Name"
],
"requiredOnCreate": [
"Elements"
],
"type": "object"
},
"OemActions": {
"additionalProperties": true,
"description": "The available OEM-specific actions for this resource.",
"longDescription": "This type shall contain the available OEM-specific actions for this resource.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {},
"type": "object"
},
"RemoveElements": {
"additionalProperties": false,
"description": "This action is used to remove one or more resources from the aggregate.",
"longDescription": "This action shall remove one or more resources from the aggregate, resulting in that the resources are removed from the Elements array of the aggregate.",
"parameters": {
"Elements": {
"description": "An array of resource links to remove from the Elements array.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Resource"
},
"longDescription": "This parameter shall contain an array of links to the specified resources to remove from the aggregate's Elements array.",
"requiredParameter": true,
"type": "array"
}
},
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"target": {
"description": "Link to invoke action",
"format": "uri-reference",
"type": "string"
},
"title": {
"description": "Friendly action name",
"type": "string"
}
},
"type": "object"
},
"Reset": {
"additionalProperties": false,
"description": "This action is used to reset a collection of resources. For example, this could be an aggregate or a list of computer systems.",
"longDescription": "This action shall perform a reset of a collection of resources.",
"parameters": {
"BatchSize": {
"description": "The number of elements in each batch being reset.",
"longDescription": "This parameter shall contain the number of elements in each batch simultaneously being issued a reset.",
"minimum": 0,
"type": "integer"
},
"DelayBetweenBatchesInSeconds": {
"description": "The delay of the batches of elements being reset in seconds.",
"longDescription": "This parameter shall contain the delay of the batches of elements being reset in seconds.",
"minimum": 0,
"type": "integer",
"units": "s"
},
"ResetType": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/ResetType",
"description": "The type of reset.",
"longDescription": "This parameter shall contain the type of reset. The service can accept a request without the parameter and perform an implementation-specific default reset."
}
},
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"target": {
"description": "Link to invoke action",
"format": "uri-reference",
"type": "string"
},
"title": {
"description": "Friendly action name",
"type": "string"
}
},
"type": "object"
},
"SetDefaultBootOrder": {
"additionalProperties": false,
"description": "This action is used to restore the boot order to the default state for the computer systems that are members of this aggregate.",
"longDescription": "This action shall restore the boot order to the default state for the computer systems that are members of this aggregate.",
"parameters": {},
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"target": {
"description": "Link to invoke action",
"format": "uri-reference",
"type": "string"
},
"title": {
"description": "Friendly action name",
"type": "string"
}
},
"type": "object"
}
},
"owningEntity": "DMTF",
"release": "2020.2",
"title": "#Aggregate.v1_0_1.Aggregate"
}