summaryrefslogtreecommitdiffstats
path: root/static/redfish/v1/JsonSchemas/UpdateService
diff options
context:
space:
mode:
authorMarri Devender Rao <devenrao@in.ibm.com>2019-01-21 10:11:34 -0600
committerEd Tanous <ed.tanous@intel.com>2019-02-02 01:11:52 +0000
commitd45d2d0f40413ca91af7fdc2f08b71f2bd828825 (patch)
treeea024d02ce6aeae285e2c2b34af0a55ac60d92af /static/redfish/v1/JsonSchemas/UpdateService
parentfe7e97d3108aa98b6bead4101694098b09adbafb (diff)
downloadbmcweb-d45d2d0f40413ca91af7fdc2f08b71f2bd828825.tar.gz
bmcweb-d45d2d0f40413ca91af7fdc2f08b71f2bd828825.zip
Redfish: Update schema files to 2018.3
Redfish schema 2018.3 was released on January 11th, 2019. While there aren't any plans to utilize any of the new services, it makes sense to keep up to date with the latest static data. This commit was largely done automatically using the update_schemas.py script. Change-Id: I74c6fac08d21629ca976ff8694fce011b5247e34 Signed-off-by: Marri Devender Rao <devenrao@in.ibm.com>
Diffstat (limited to 'static/redfish/v1/JsonSchemas/UpdateService')
-rw-r--r--static/redfish/v1/JsonSchemas/UpdateService/UpdateService.json148
1 files changed, 142 insertions, 6 deletions
diff --git a/static/redfish/v1/JsonSchemas/UpdateService/UpdateService.json b/static/redfish/v1/JsonSchemas/UpdateService/UpdateService.json
index 8dc6ab2..5726a4e 100644
--- a/static/redfish/v1/JsonSchemas/UpdateService/UpdateService.json
+++ b/static/redfish/v1/JsonSchemas/UpdateService/UpdateService.json
@@ -1,4 +1,5 @@
{
+ "$id": "http://redfish.dmtf.org/schemas/v1/UpdateService.v1_4_0.json",
"$ref": "#/definitions/UpdateService",
"$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
"copyright": "Copyright 2014-2018 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
@@ -33,6 +34,101 @@
},
"type": "object"
},
+ "ApplyTime": {
+ "enum": [
+ "Immediate",
+ "OnReset",
+ "AtMaintenanceWindowStart",
+ "InMaintenanceWindowOnReset"
+ ],
+ "enumDescriptions": {
+ "AtMaintenanceWindowStart": "Apply during a maintenance window as specified by an administrator.",
+ "Immediate": "Apply immediately.",
+ "InMaintenanceWindowOnReset": "Apply after a reset but within maintenance window as specified by an adminstrator.",
+ "OnReset": "Apply on a reset."
+ },
+ "enumLongDescriptions": {
+ "AtMaintenanceWindowStart": "This ApplyTime value shall be used to indicate the software provided via HttpPushUri is applied during the maintenance window specified by the MaintenanceWindowStartTime and MaintenanceWindowDurationInSeconds properties. A service may perform resets during this maintenance window.",
+ "Immediate": "This ApplyTime value shall be used to indicate the software provided via HttpPushUri is applied immediately.",
+ "InMaintenanceWindowOnReset": "This ApplyTime value shall be used to indicate the software provided via HttpPushUri is applied during the maintenance window specified by the MaintenanceWindowStartTime and MaintenanceWindowDurationInSeconds properties, and if a reset occurs within the maintenance window.",
+ "OnReset": "This ApplyTime value shall be used to indicate the software provided via HttpPushUri is applied when the system or service is reset."
+ },
+ "type": "string"
+ },
+ "HttpPushUriApplyTime": {
+ "additionalProperties": false,
+ "description": "This object contains settings for when software is to be applied when provided via HttpPushUri.",
+ "longDescription": "The properties in this object shall contain settings for when software is to be applied when provided via HttpPushUri.",
+ "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": {
+ "ApplyTime": {
+ "$ref": "#/definitions/ApplyTime",
+ "description": "This property indicates when the software update invoked via HttpPushUri should be applied.",
+ "longDescription": "The value of this property shall indicate the preference on to when to apply the software provided via HttpPushUri.",
+ "readonly": false,
+ "versionAdded": "v1_4_0"
+ },
+ "MaintenanceWindowDurationInSeconds": {
+ "description": "The value of this property as specified by client indicates the expiry time of maintenance window in seconds.",
+ "longDescription": "The value of this property shall indicate the end of the maintenance window as the number of seconds after the time specified by the HttpPushUriMaintenanceWindowStartTime property. This property shall be required if the HttpPushUriApplyTime property is specified as AtMaintenanceWindowStart or InMaintenanceWindowOnReset.",
+ "minimum": 0,
+ "readonly": false,
+ "type": "integer",
+ "units": "s",
+ "versionAdded": "v1_4_0"
+ },
+ "MaintenanceWindowStartTime": {
+ "description": "The value of this property as specified by client to indicate the start time of a maintenance window.",
+ "format": "date-time",
+ "longDescription": "The value of this property shall indicate the date and time as to when the service is allowed to start applying the software provided via HttpPushUri as part of a maintenance window. This property shall be required if the HttpPushUriApplyTime property is specified as AtMaintenanceWindowStart or InMaintenanceWindowOnReset.",
+ "readonly": false,
+ "type": "string",
+ "versionAdded": "v1_4_0"
+ }
+ },
+ "type": "object"
+ },
+ "HttpPushUriOptions": {
+ "additionalProperties": false,
+ "description": "This object contains settings for software update via HttpPushUri.",
+ "longDescription": "The properties in this object shall contain settings and requirements of the service for software update via HttpPushUri.",
+ "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": {
+ "HttpPushUriApplyTime": {
+ "$ref": "#/definitions/HttpPushUriApplyTime",
+ "description": "This property contains settings for when firmware is to be applied when provided via HttpPushUri.",
+ "longDescription": "The value of this property shall contain settings for when firmware is to be applied when provided via HttpPushUri.",
+ "versionAdded": "v1_4_0"
+ }
+ },
+ "type": "object"
+ },
"OemActions": {
"additionalProperties": true,
"description": "The available OEM specific actions for this resource.",
@@ -65,6 +161,12 @@
"requiredParameter": true,
"type": "string"
},
+ "Password": {
+ "description": "The password to be used when accessing the URI specified by the ImageURI parameter.",
+ "longDescription": "This parameter shall contain a string representing the password to be used when accessing the URI specified by the ImageURI parameter.",
+ "type": "string",
+ "versionAdded": "v1_4_0"
+ },
"Targets": {
"description": "The array of URIs indicating where the update image is to be applied.",
"format": "uri",
@@ -72,12 +174,19 @@
"type": "string"
},
"longDescription": "This array property shall contain zero or more URIs indicating where the update image is to be applied. These targets should correspond to SoftwareInventory instances or their RelatedItems. If this property is not present or contains zero targets, the Service shall apply the software image to all applicable targets (as determined by the Service).",
- "type": "array"
+ "type": "array",
+ "versionAdded": "v1_2_0"
},
"TransferProtocol": {
"$ref": "#/definitions/TransferProtocolType",
"description": "The network protocol used by the Update Service to retrieve the software image file located at the URI provided in ImageURI, if the URI does not contain a scheme.",
"longDescription": "This parameter shall contain the network protocol that the Update Service shall use to retreive the software image located at the ImageURI. If this parameter is not provided (or supported), and a transfer protocol is not specified by a scheme contained within ImageURI, the Update Service shall use HTTP to retrieve the image."
+ },
+ "Username": {
+ "description": "The username to be used when accessing the URI specified by the ImageURI parameter.",
+ "longDescription": "This parameter shall contain a string representing the username to be used when accessing the URI specified by the ImageURI parameter.",
+ "type": "string",
+ "versionAdded": "v1_4_0"
}
},
"patternProperties": {
@@ -135,6 +244,13 @@
"SFTP": "Secure File Transfer Protocol.",
"TFTP": "Trivial File Transfer Protocol."
},
+ "enumVersionAdded": {
+ "NFS": "v1_3_0",
+ "SFTP": "v1_1_0"
+ },
+ "enumVersionDeprecated": {
+ "NSF": "v1_3_0"
+ },
"type": "string"
},
"UpdateService": {
@@ -200,9 +316,26 @@
"HttpPushUri": {
"description": "The URI used to perform an HTTP or HTTPS push update to the Update Service.",
"format": "uri",
- "longDescription": "This property shall contain a URI at which the UpdateService supports an HTTP or HTTPS POST of a software image for the purpose of installing software contained within the image.",
+ "longDescription": "This property shall contain a URI at which the UpdateService supports an HTTP or HTTPS POST of a software image for the purpose of installing software contained within the image. Access to this URI shall require the same privilege as access to the Update Service.",
"readonly": true,
- "type": "string"
+ "type": "string",
+ "versionAdded": "v1_1_0"
+ },
+ "HttpPushUriOptions": {
+ "$ref": "#/definitions/HttpPushUriOptions",
+ "description": "This property contains options for software update via HttpPushUri.",
+ "longDescription": "The value of this property shall contain options and requirements of the service for software update via HttpPushUri.",
+ "versionAdded": "v1_4_0"
+ },
+ "HttpPushUriOptionsBusy": {
+ "description": "This represents if the properties of HttpPushUriOptions are reserved by any client.",
+ "longDescription": "This property shall be a boolean that determines when the properties within the HttpPushUriOptions object are being used by a client for software updates. A client should set this property to True when it is using any properties in HttpPushUriOptions for software update, and should set it to False when it is no longer using HttpPushUriOptions properties for updates. The property can provide multiple clients a way to negotiate ownership of HttpPushUriOptions. This will help clients to know if a firmware update using HttpPushUriOptions is used by another client. This property has no functional requirements for the Service.",
+ "readonly": false,
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "versionAdded": "v1_4_0"
},
"HttpPushUriTargets": {
"description": "The array of URIs indicating the target for applying the update image.",
@@ -215,7 +348,8 @@
},
"longDescription": "This property shall contain zero or more URIs indicating the targets for applying the update image when using HttpPushUri to push a software image. These targets should correspond to SoftwareInventory instances or their RelatedItems. If this property is not present or contains zero targets, the Service shall apply the software image to all applicable targets (as determined by the Service).",
"readonly": false,
- "type": "array"
+ "type": "array",
+ "versionAdded": "v1_2_0"
},
"HttpPushUriTargetsBusy": {
"description": "This represents if the HttpPushUriTargets property is reserved by any client.",
@@ -224,7 +358,8 @@
"type": [
"boolean",
"null"
- ]
+ ],
+ "versionAdded": "v1_2_0"
},
"Id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
@@ -277,5 +412,6 @@
}
},
"owningEntity": "DMTF",
- "title": "#UpdateService.v1_3_0.UpdateService"
+ "release": "2018.3",
+ "title": "#UpdateService.v1_4_0.UpdateService"
} \ No newline at end of file
OpenPOWER on IntegriCloud