xref: /openbmc/bmcweb/features/redfish/schema/dmtf/json-schema-installed/UpdateService.v1_17_0.json

{
    "$id": "http://redfish.dmtf.org/schemas/v1/UpdateService.v1_17_0.json",
    "$ref": "#/definitions/UpdateService",
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
    "copyright": "Copyright 2014-2025 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": {
                "#UpdateService.Activate": {
                    "$ref": "#/definitions/Activate"
                },
                "#UpdateService.GenerateSSHIdentityKeyPair": {
                    "$ref": "#/definitions/GenerateSSHIdentityKeyPair"
                },
                "#UpdateService.RemoveSSHIdentityKeyPair": {
                    "$ref": "#/definitions/RemoveSSHIdentityKeyPair"
                },
                "#UpdateService.SimpleUpdate": {
                    "$ref": "#/definitions/SimpleUpdate"
                },
                "#UpdateService.StartUpdate": {
                    "$ref": "#/definitions/StartUpdate"
                },
                "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"
        },
        "Activate": {
            "additionalProperties": false,
            "description": "This action activates specified software inventory instance.",
            "longDescription": "This action shall activate specified software inventory instance.",
            "parameters": {
                "Targets": {
                    "description": "The target software inventory instances to activate on staged devices.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/SoftwareInventory.json#/definitions/SoftwareInventory"
                    },
                    "longDescription": "This parameter shall contain an array of target software inventory instances to activate on staged devices.  The service shall activate each software image on all applicable devices.",
                    "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",
            "versionAdded": "v1_16_0"
        },
        "ApplyTime": {
            "enum": [
                "Immediate",
                "OnReset",
                "AtMaintenanceWindowStart",
                "InMaintenanceWindowOnReset",
                "OnStartUpdateRequest",
                "OnTargetReset"
            ],
            "enumDescriptions": {
                "AtMaintenanceWindowStart": "Apply during an administrator-specified maintenance window.",
                "Immediate": "Apply immediately.",
                "InMaintenanceWindowOnReset": "Apply after a reset but within an administrator-specified maintenance window.",
                "OnReset": "Apply on a reset.",
                "OnStartUpdateRequest": "Apply when the `StartUpdate` action of the update service is invoked.",
                "OnTargetReset": "Apply when the target for the software update is reset.  Targets include devices, services, and systems."
            },
            "enumLongDescriptions": {
                "AtMaintenanceWindowStart": "This value shall indicate the `HttpPushUri`-provided software is applied during the maintenance window specified by the `MaintenanceWindowStartTime` and `MaintenanceWindowDurationInSeconds` properties.  A service may perform resets during this maintenance window.",
                "Immediate": "This value shall indicate the `HttpPushUri`-provided software is applied immediately.",
                "InMaintenanceWindowOnReset": "This value shall indicate the `HttpPushUri`-provided software is applied during the maintenance window specified by the `MaintenanceWindowStartTime` and `MaintenanceWindowDurationInSeconds` properties, and if a reset occurs within the maintenance window.",
                "OnReset": "This value shall indicate the `HttpPushUri`-provided software is applied when the system or service is reset.",
                "OnStartUpdateRequest": "This value shall indicate the `HttpPushUri`-provided software is applied when the `StartUpdate` action of the update service is invoked.",
                "OnTargetReset": "This value shall indicate the `HttpPushUri`-provided software is applied when the target is reset."
            },
            "enumVersionAdded": {
                "OnStartUpdateRequest": "v1_11_0",
                "OnTargetReset": "v1_14_0"
            },
            "type": "string"
        },
        "GenerateSSHIdentityKeyPair": {
            "additionalProperties": false,
            "description": "This action generates a new SSH identity key-pair to be used with the `UpdateService` resource.  The generated public key is stored in the `Key` resource referenced by the `PublicIdentitySSHKey` property.  Any existing key-pair is deleted and replaced by the new key-pair.",
            "longDescription": "This action shall generate a new SSH identity key-pair to be used with the `UpdateService` resource.  The service shall store the generated public key in the `Key` resource referenced by the `PublicIdentitySSHKey` property.  If the `UpdateService` resource already has an associated SSH identity key-pair, the service shall delete the key-pair and replace it with the new key-pair.",
            "parameters": {
                "Curve": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Key.json#/definitions/ECDSACurveType",
                    "description": "The curve to use with the SSH key if the `KeyType` parameter contains `ECDSA`.",
                    "longDescription": "This parameter shall contain the curve to use with the SSH key.  This parameter shall be required if the `KeyType` parameter contains `ECDSA` and shall be rejected for other values."
                },
                "KeyLength": {
                    "description": "The length of the SSH key, in bits, if the `KeyType` parameter contains `RSA`.",
                    "longDescription": "This parameter shall contain the length of the SSH key, in bits.  This parameter shall be required if the `KeyType` parameter contains `RSA` and shall be rejected for other values.",
                    "type": "integer"
                },
                "KeyType": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Key.json#/definitions/SSHKeyType",
                    "description": "The type of SSH key.",
                    "longDescription": "This parameter shall contain the type of SSH key.",
                    "requiredParameter": true
                }
            },
            "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",
            "versionAdded": "v1_13_0"
        },
        "HttpPushUriApplyTime": {
            "additionalProperties": false,
            "description": "The settings for when to apply `HttpPushUri`-provided software.",
            "longDescription": "The properties in this object shall contain settings for when to apply `HttpPushUri`-provided software.",
            "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": "The time when to apply the `HttpPushUri`-provided software update.",
                    "longDescription": "This property shall indicate the time when to apply the `HttpPushUri`-provided software update.",
                    "readonly": false,
                    "versionAdded": "v1_4_0"
                },
                "MaintenanceWindowDurationInSeconds": {
                    "description": "The expiry time, in seconds, of the maintenance window.",
                    "longDescription": "This property shall indicate the end of the maintenance window as the number of seconds after the time specified by the `MaintenanceWindowStartTime` property.  This property shall be required if the `HttpPushUriApplyTime` property value is `AtMaintenanceWindowStart` or `InMaintenanceWindowOnReset`.",
                    "minimum": 0,
                    "readonly": false,
                    "type": "integer",
                    "units": "s",
                    "versionAdded": "v1_4_0"
                },
                "MaintenanceWindowStartTime": {
                    "description": "The start time of a maintenance window.",
                    "format": "date-time",
                    "longDescription": "This property shall indicate the date and time when the service can start to apply the `HttpPushUri`-provided software as part of a maintenance window.  This property shall be required if the `HttpPushUriApplyTime` property value is `AtMaintenanceWindowStart` or `InMaintenanceWindowOnReset`.",
                    "readonly": false,
                    "type": "string",
                    "versionAdded": "v1_4_0"
                }
            },
            "type": "object"
        },
        "HttpPushUriOptions": {
            "additionalProperties": false,
            "description": "The settings for `HttpPushUri`-provided software updates.",
            "longDescription": "The properties in this object shall contain settings and requirements of the service for `HttpPushUri`-provided software updates.",
            "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": {
                "ForceUpdate": {
                    "description": "An indication of whether the service should bypass update policies when applying the `HttpPushUri`-provided image.",
                    "longDescription": "This property shall indicate whether the service should bypass update policies when applying the `HttpPushUri`-provided image, such as allowing a component to be downgraded.  Services may contain update policies that are never bypassed, such as minimum version enforcement.  If this property is not present, it shall be assumed to be `false`.",
                    "readonly": false,
                    "type": "boolean",
                    "versionAdded": "v1_11_0"
                },
                "HttpPushUriApplyTime": {
                    "$ref": "#/definitions/HttpPushUriApplyTime",
                    "description": "The settings for when to apply `HttpPushUri`-provided firmware.",
                    "longDescription": "This property shall contain settings for when to apply `HttpPushUri`-provided firmware.",
                    "versionAdded": "v1_4_0"
                }
            },
            "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"
        },
        "RemoveSSHIdentityKeyPair": {
            "additionalProperties": false,
            "description": "This action removes the SSH identity key-pair used with the `UpdateService` resource.",
            "longDescription": "This action shall remove the private SSH identity key-pair used with the `UpdateService` resource.",
            "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",
            "versionAdded": "v1_13_0"
        },
        "SimpleUpdate": {
            "additionalProperties": false,
            "description": "This action updates software components.",
            "longDescription": "This action shall update installed software components in a software image file located at an `ImageURI` parameter-specified URI.",
            "parameters": {
                "ExcludeTargets": {
                    "description": "An array of URIs that indicate where not to apply the update image.",
                    "format": "uri-reference",
                    "items": {
                        "type": "string"
                    },
                    "longDescription": "This parameter shall contain zero or more URIs that indicate where not to apply the update image.  This parameter shall be ignored if the `Targets` parameter is provided and contains at least one member.  These excluded targets should correspond to software inventory instances or their related items.  If this parameter is not present or contains no targets, the service shall apply the software image to all applicable targets, as determined by the service.  If an excluded target specifies a device resource, the software image file shall not be applied to that specified device.  If an excluded target specifies a resource collection, the software image shall not be applied to each applicable member of the specified collection.  If an excluded target resource specifies an `Aggregate` resource, the software image file shall not be applied to each applicable element of the specified aggregate.  If an excluded target resource specifies a `ComputerSystem` resource, the software image file shall not be applied to the applicable components within the specified computer system.",
                    "type": "array",
                    "versionAdded": "v1_17_0"
                },
                "ForceUpdate": {
                    "description": "An indication of whether the service should bypass update policies when applying the provided image.  The default is `false`.",
                    "longDescription": "This parameter shall indicate whether the service should bypass update policies when applying the provided image, such as allowing a component to be downgraded.  Services may contain update policies that are never bypassed, such as minimum version enforcement.  If the client does not provide this parameter, the service shall default this value to `false`.",
                    "type": "boolean",
                    "versionAdded": "v1_11_0"
                },
                "ImageURI": {
                    "description": "The URI of the software image to install.",
                    "format": "uri-reference",
                    "longDescription": "This parameter shall contain an RFC3986-defined URI that links to a software image that the update service retrieves to install software in that image.  This URI should contain a scheme that describes the transfer protocol.  If the `TransferProtocol` parameter is absent or not supported, and a transfer protocol is not specified by a scheme contained within this URI, the service shall use HTTP to get the image.",
                    "requiredParameter": true,
                    "type": "string"
                },
                "LocalImage": {
                    "description": "An indication of whether the service adds the image to the local image store.",
                    "longDescription": "This parameter shall indicate whether the service adds the image to the resource collection referenced by the `LocalImageStore` property.  If the client does not provide this parameter, the service shall default this value to `false`.",
                    "type": "boolean",
                    "versionAdded": "v1_17_0"
                },
                "Password": {
                    "description": "The password to access the URI specified by the `ImageURI` parameter.",
                    "longDescription": "This parameter shall contain the password to access the URI specified by the `ImageURI` parameter.",
                    "type": "string",
                    "versionAdded": "v1_4_0"
                },
                "Stage": {
                    "description": "An indication of whether the service stages the image on target devices for a client to activate at a later time.",
                    "longDescription": "This parameter shall indicate whether the service stages the image on target devices for a client to activate at a later time with the `Activate` action on the `SoftwareInventory` resource.  If the client does not provide this parameter, the service shall default this value to `false`.",
                    "type": "boolean",
                    "versionAdded": "v1_16_0"
                },
                "Targets": {
                    "description": "An array of URIs that indicate where to apply the update image.",
                    "format": "uri-reference",
                    "items": {
                        "type": "string"
                    },
                    "longDescription": "This parameter shall contain zero or more URIs that indicate where to apply the update image.  These targets should correspond to software inventory instances or their related items.  If this parameter is not present or contains no targets, the service shall apply the software image to all applicable targets, as determined by the service.  If the target specifies a device resource, the software image file shall be applied to the specified device.  If the target specifies a resource collection, the software image shall be applied to each applicable member of the specified collection.  If the target resource specifies an `Aggregate` resource, the software image file shall be applied to each applicable element of the specified aggregate.  If the target resource specifies a `ComputerSystem` resource, the software image file shall be applied to the applicable components within the specified computer system.",
                    "type": "array",
                    "versionAdded": "v1_2_0"
                },
                "TransferProtocol": {
                    "$ref": "#/definitions/TransferProtocolType",
                    "description": "The network protocol that the update service uses to retrieve the software image file located at the URI specified by the `ImageURI` parameter.  This parameter is ignored if the URI provided in `ImageURI` contains a scheme.",
                    "longDescription": "This parameter shall contain the network protocol that the update service shall use to retrieve the software image located at the URI specified by the `ImageURI` parameter.  Services should ignore this parameter if the URI specified by the `ImageURI` parameter contains a scheme.  If this parameter is not provided (or supported), and a transfer protocol is not specified by a scheme contained within this URI, the service shall use HTTP to retrieve the image."
                },
                "Username": {
                    "description": "The username to access the URI specified by the `ImageURI` parameter.",
                    "longDescription": "This parameter shall contain the username to access the URI specified by the `ImageURI` parameter.",
                    "type": "string",
                    "versionAdded": "v1_4_0"
                }
            },
            "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"
        },
        "StartUpdate": {
            "additionalProperties": false,
            "description": "This action starts updating all images that have been previously invoked using an `OperationApplyTime` value of `OnStartUpdateRequest`.",
            "longDescription": "This action shall start an update of software component that have been scheduled with the `OperationApplyTime` value of `OnStartUpdateRequest`.",
            "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",
            "versionAdded": "v1_7_0"
        },
        "SupportedUpdateImageFormatType": {
            "enum": [
                "PLDMv1_0",
                "PLDMv1_1",
                "PLDMv1_2",
                "PLDMv1_3",
                "UEFICapsule",
                "VendorDefined"
            ],
            "enumDescriptions": {
                "PLDMv1_0": "A PLDM for Firmware Update Specification v1.0 image.",
                "PLDMv1_1": "A PLDM for Firmware Update Specification v1.1 image.",
                "PLDMv1_2": "A PLDM for Firmware Update Specification v1.2 image.",
                "PLDMv1_3": "A PLDM for Firmware Update Specification v1.3 image.",
                "UEFICapsule": "The image conforms to the capsule format described in the UEFI Specification.",
                "VendorDefined": "A vendor-defined image."
            },
            "enumLongDescriptions": {
                "PLDMv1_0": "This value shall indicate an image that conforms to the v1.0 image format as defined in DMTF DSP0267.",
                "PLDMv1_1": "This value shall indicate an image that conforms to the v1.1 image format as defined in DMTF DSP0267.",
                "PLDMv1_2": "This value shall indicate an image that conforms to the v1.2 image format as defined in DMTF DSP0267.",
                "PLDMv1_3": "This value shall indicate an image that conforms to the v1.3 image format as defined in DMTF DSP0267.",
                "UEFICapsule": "This value shall indicate an image that conforms to the UEFI capsule format as defined in the UEFI Specification.",
                "VendorDefined": "This value shall indicate a vendor-defined format."
            },
            "type": "string"
        },
        "TransferProtocolType": {
            "enum": [
                "CIFS",
                "FTP",
                "SFTP",
                "HTTP",
                "HTTPS",
                "NSF",
                "SCP",
                "TFTP",
                "OEM",
                "NFS"
            ],
            "enumDeprecated": {
                "NSF": "This value has been deprecated in favor of NFS."
            },
            "enumDescriptions": {
                "CIFS": "Common Internet File System (CIFS).",
                "FTP": "File Transfer Protocol (FTP).",
                "HTTP": "Hypertext Transfer Protocol (HTTP).",
                "HTTPS": "Hypertext Transfer Protocol Secure (HTTPS).",
                "NFS": "Network File System (NFS).",
                "NSF": "Network File System (NFS).",
                "OEM": "A manufacturer-defined protocol.",
                "SCP": "Secure Copy Protocol (SCP).",
                "SFTP": "SSH File Transfer Protocol (SFTP).",
                "TFTP": "Trivial File Transfer Protocol (TFTP)."
            },
            "enumVersionAdded": {
                "NFS": "v1_3_0",
                "SFTP": "v1_1_0"
            },
            "enumVersionDeprecated": {
                "NSF": "v1_3_0"
            },
            "type": "string"
        },
        "UpdateParameters": {
            "additionalProperties": false,
            "description": "The update parameters used with `MultipartHttpPushUri` software update.",
            "longDescription": "This type shall contain the update parameters when passing the update image when using the URI specified by the `MultipartHttpPushUri` property to push a software image.",
            "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": {
                "ExcludeTargets": {
                    "description": "An array of URIs that indicate where not to apply the update image.",
                    "format": "uri-reference",
                    "items": {
                        "type": "string"
                    },
                    "longDescription": "This property shall contain zero or more URIs that indicate where not to apply the update image.  This property shall be ignored if the `Targets` property is provided and contains at least one member.  These excluded targets should correspond to software inventory instances or their related items.  If this parameter is not present or contains no targets, the service shall apply the software image to all applicable targets, as determined by the service.  If an excluded target specifies a device resource, the software image file shall not be applied to that specified device.  If an excluded target specifies a resource collection, the software image shall not be applied to each applicable member of the specified collection.  If an excluded target resource specifies an `Aggregate` resource, the software image file shall not be applied to each applicable element of the specified aggregate.  If an excluded target resource specifies a `ComputerSystem` resource, the software image file shall not be applied to the applicable components within the specified computer system.",
                    "readonly": false,
                    "type": "array",
                    "versionAdded": "v1_17_0"
                },
                "ForceUpdate": {
                    "description": "An indication of whether the service should bypass update policies when applying the provided image.  The default is `false`.",
                    "longDescription": "This property shall indicate whether the service should bypass update policies when applying the provided image, such as allowing a component to be downgraded.  Services may contain update policies that are never bypassed, such as minimum version enforcement.  If the client does not provide this parameter, the service shall default this value to `false`.",
                    "readonly": false,
                    "type": "boolean",
                    "versionAdded": "v1_11_0"
                },
                "LocalImage": {
                    "description": "An indication of whether the service adds the image to the local image store.",
                    "longDescription": "This property shall indicate whether the service adds the image to the resource collection referenced by the `LocalImageStore` property.  If the client does not provide this parameter, the service shall default this value to `false`.",
                    "readonly": false,
                    "type": "boolean",
                    "versionAdded": "v1_17_0"
                },
                "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 contained in this object shall conform to the Redfish Specification-described requirements.",
                    "versionAdded": "v1_8_0"
                },
                "Stage": {
                    "description": "An indication of whether the service stages the image on target devices for a client to activate at a later time.",
                    "longDescription": "This property shall indicate whether the service stages the image on target devices for a client to activate at a later time with the `Activate` action on the `SoftwareInventory` resource.  If the client does not provide this parameter, the service shall default this value to `false`.",
                    "readonly": false,
                    "type": "boolean",
                    "versionAdded": "v1_16_0"
                },
                "Targets": {
                    "description": "An array of URIs that indicate where to apply the update image.",
                    "format": "uri-reference",
                    "items": {
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "longDescription": "This property shall contain zero or more URIs that indicate where to apply the update image when using the URI specified by the `MultipartHttpPushUri` property to push a software image.  These targets should correspond to software inventory instances or their related items.  If this property is not present or contains no targets, the service shall apply the software image to all applicable targets, as determined by the service.  If the target specifies a device resource, the software image file shall be applied to the specified device.  If the target specifies a resource collection, the software image shall be applied to each applicable member of the specified collection.  If the target resource specifies an `Aggregate` resource, the software image file shall be applied to each applicable element of the specified aggregate.  If the target resource specifies a `ComputerSystem` resource, the software image file shall be applied to the applicable components within the specified computer system.",
                    "readonly": false,
                    "type": "array",
                    "versionAdded": "v1_6_0"
                }
            },
            "type": "object"
        },
        "UpdateService": {
            "additionalProperties": false,
            "description": "The `UpdateService` schema describes the update service and the properties for the service itself with links to collections of firmware and software inventory.  The update service also provides methods for updating software and firmware of the resources in a Redfish service.",
            "longDescription": "This resource shall represent an update service and the properties that affect the service itself 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."
                },
                "ClientCertificates": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/CertificateCollection.json#/definitions/CertificateCollection",
                    "description": "The link to a collection of client identity certificates provided to the server referenced by the `ImageURI` parameter in `SimpleUpdate`.",
                    "longDescription": "This property shall contain a link to a resource collection of type `CertificateCollection` that represents the client identity certificates that are provided to the server referenced by the `ImageURI` parameter in `SimpleUpdate` as part of TLS handshaking.",
                    "readonly": true,
                    "versionAdded": "v1_10_0"
                },
                "Description": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "readonly": true
                },
                "FirmwareInventory": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/SoftwareInventoryCollection.json#/definitions/SoftwareInventoryCollection",
                    "description": "An inventory of firmware.",
                    "longDescription": "This property shall contain a link to a resource collection of type `SoftwareInventoryCollection`.  The resource collection should contain the set of software components generally referred to as platform firmware or that does not execute within a host operating system.  Software in this collection is generally updated using platform-specific methods or utilities.",
                    "readonly": true
                },
                "HttpPushUri": {
                    "deprecated": "This property has been deprecated in favor of the `MultipartHttpPushUri` property.",
                    "description": "The URI used to perform an HTTP or HTTPS push update to the update service.  The format of the message is vendor-specific.",
                    "format": "uri-reference",
                    "longDescription": "This property shall contain a URI at which the update service 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.  If the service requires the `Content-Length` header for `POST` requests to this URI, the service should return HTTP `411 Length Required` status code if the client does not include this header in the `POST` request.  The value of this property should not contain a URI of a Redfish resource.  See the 'Redfish-defined URIs and relative reference rules' clause in the Redfish Specification.",
                    "readonly": true,
                    "type": "string",
                    "versionAdded": "v1_1_0",
                    "versionDeprecated": "v1_15_0"
                },
                "HttpPushUriOptions": {
                    "$ref": "#/definitions/HttpPushUriOptions",
                    "deprecated": "This property has been deprecated in favor of the update parameters used with `MultipartHttpPushUri`-provided software updates.",
                    "description": "The options for `HttpPushUri`-provided software updates.",
                    "longDescription": "This property shall contain options and requirements of the service for `HttpPushUri`-provided software updates.",
                    "versionAdded": "v1_4_0",
                    "versionDeprecated": "v1_15_0"
                },
                "HttpPushUriOptionsBusy": {
                    "deprecated": "This property has been deprecated in favor of `MultipartHttpPushUri`-provided software updates.",
                    "description": "An indication of whether a client has reserved the `HttpPushUriOptions` properties for software updates.",
                    "longDescription": "This property shall indicate whether a client uses the `HttpPushUriOptions` properties for software updates.  When a client uses any `HttpPushUriOptions` properties for software updates, it should set this property to `true`.  When a client no longer uses `HttpPushUriOptions` properties for software updates, it should set this property to `false`.  This property can provide multiple clients a way to negotiate ownership of `HttpPushUriOptions` properties.  Clients can use this property to determine whether another client uses `HttpPushUriOptions` properties for software updates.  This property has no functional requirements for the service.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ],
                    "versionAdded": "v1_4_0",
                    "versionDeprecated": "v1_15_0"
                },
                "HttpPushUriTargets": {
                    "deprecated": "This property has been deprecated in favor of the update parameters used with `MultipartHttpPushUri`-provided software updates.",
                    "description": "An array of URIs that indicate where to apply the update image.",
                    "format": "uri-reference",
                    "items": {
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "longDescription": "This property shall contain zero or more URIs that indicate where to apply the update image when using the URI specified by the `HttpPushUri` property to push a software image.  These targets should correspond to software inventory instances or their related items.  If this property is not present or contains no targets, the service shall apply the software image to all applicable targets, as determined by the service.  If the target specifies a device resource, the software image file shall be applied to the specified device.  If the target specifies a resource collection, the software image shall be applied to each applicable member of the specified collection.  If the target resource specifies an `Aggregate` resource, the software image file shall be applied to each applicable element of the specified aggregate.  If the target resource specifies a `ComputerSystem` resource, the software image file shall be applied to the applicable components within the specified computer system.",
                    "readonly": false,
                    "type": "array",
                    "versionAdded": "v1_2_0",
                    "versionDeprecated": "v1_15_0"
                },
                "HttpPushUriTargetsBusy": {
                    "deprecated": "This property has been deprecated in favor of `MultipartHttpPushUri`-provided software updates.",
                    "description": "An indication of whether any client has reserved the `HttpPushUriTargets` property.",
                    "longDescription": "This property shall indicate whether any client has reserved the `HttpPushUriTargets` property for firmware updates.  A client should set this property to `true` when it uses `HttpPushUriTargets` for firmware updates.  A client should set it to `false` when it no longer uses `HttpPushUriTargets` for updates.  The property can provide multiple clients a way to negotiate ownership of `HttpPushUriTargets` and helps clients determine whether another client is using `HttpPushUriTargets` to make firmware updates.  This property has no functional requirements for the service.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ],
                    "versionAdded": "v1_2_0",
                    "versionDeprecated": "v1_15_0"
                },
                "Id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
                    "readonly": true
                },
                "LocalImageStore": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/SoftwareInventoryCollection.json#/definitions/SoftwareInventoryCollection",
                    "description": "An inventory of locally stored images.",
                    "longDescription": "This property shall contain a link to a resource collection of type `SoftwareInventoryCollection`.  The resource collection shall contain the set of images that are stored locally by the service.  This may include operating system images, drivers, or other software components.  These images may be referenced by other features of the service, such as virtual media.",
                    "readonly": true,
                    "versionAdded": "v1_17_0"
                },
                "LocalImageStoreAvailableCapacityBytes": {
                    "description": "The number of bytes currently available in the local image store.",
                    "longDescription": "This property shall contain the number of bytes currently available in the local image store.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "versionAdded": "v1_17_0"
                },
                "LocalImageStoreTotalCapacityBytes": {
                    "description": "The total number of bytes available to the local image store.",
                    "longDescription": "This property shall contain the total number of bytes available to the local image store.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "versionAdded": "v1_17_0"
                },
                "MaxImageSizeBytes": {
                    "description": "The maximum size in bytes of the software update image that this service supports.",
                    "longDescription": "This property shall indicate the maximum size of the software update image that clients can send to this update service.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "By",
                    "versionAdded": "v1_5_0"
                },
                "MultipartHttpPushUri": {
                    "description": "The URI used to perform a Redfish Specification-defined multipart HTTP or HTTPS push update to the update service.",
                    "format": "uri-reference",
                    "longDescription": "This property shall contain a URI used to perform a Redfish Specification-defined multipart HTTP or HTTPS `POST` of a software image for the purpose of installing software contained within the image.  The value of this property should not contain a URI of a Redfish resource.  See the 'Redfish-defined URIs and relative reference rules' clause in the Redfish Specification.",
                    "readonly": true,
                    "type": "string",
                    "versionAdded": "v1_6_0"
                },
                "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."
                },
                "PublicIdentitySSHKey": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Key.json#/definitions/Key",
                    "description": "A link to the public key that is used with the `SimpleUpdate` action for the key-based authentication.  The GenerateSSHIdentityKeyPair and RemoveSSHIdentityKeyPair are used to update the key for the `SimpleUpdate` action.",
                    "longDescription": "This property shall contain a link to a resource of type `Key` that represents the public key that is used with the `SimpleUpdate` action for the key-based authentication.  This property shall not be present if a key-pair is not available.",
                    "readonly": true,
                    "versionAdded": "v1_13_0"
                },
                "RemoteServerCertificates": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/CertificateCollection.json#/definitions/CertificateCollection",
                    "description": "The link to a collection of server certificates for the server referenced by the `ImageURI` parameter in SimpleUpdate.",
                    "longDescription": "This property shall contain a link to a resource collection of type `CertificateCollection` that represents the server certificates for the server referenced by the `ImageURI` parameter in `SimpleUpdate`.  If `VerifyRemoteServerCertificate` is `true`, services shall compare the certificates in this collection with the certificate obtained during handshaking with the image server in order to verify the identity of the image server prior to transferring the image.  If the server cannot be verified, the service shall not send the transfer request.  If `VerifyRemoteServerCertificate` is `false`, the service shall not perform certificate verification with certificates in this collection.  Regardless of the contents of this collection, services may perform additional verification based on other factors, such as the configuration of the `SecurityPolicy` resource.",
                    "readonly": true,
                    "versionAdded": "v1_9_0"
                },
                "RemoteServerSSHKeys": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/KeyCollection.json#/definitions/KeyCollection",
                    "description": "The link to a collection of keys that can be used to authenticate the server referenced by the `ImageURI` parameter in `SimpleUpdate`.",
                    "longDescription": "This property shall contain a link to a resource collection of type `KeyCollection` that represents the server SSH keys for the server referenced by the `ImageURI` Parameter in `SimpleUpdate`.  If `VerifyRemoteServerSSHKey` is `true`, services shall compare the keys in this collection with the key obtained during handshaking with the image server in order to verify the identity of the image server prior to transferring the image.  If the server cannot be verified, the service shall not send the transfer request.  If `VerifyRemoteServerSSHKey` is `false`, the service shall not perform key verification with keys in this collection.",
                    "readonly": true,
                    "versionAdded": "v1_12_0"
                },
                "ServiceEnabled": {
                    "description": "An indication of whether this service is enabled.",
                    "longDescription": "This property shall indicate whether this service is enabled.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "SoftwareInventory": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/SoftwareInventoryCollection.json#/definitions/SoftwareInventoryCollection",
                    "description": "An inventory of software.",
                    "longDescription": "This property shall contain a link to a resource collection of type `SoftwareInventoryCollection`.  The resource collection should contain the set of software components executed in the context of a host operating system.  This can include device drivers, applications, or offload workloads.  Software in this collection is generally updated using operating system-centric methods.",
                    "readonly": true
                },
                "Status": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
                    "description": "The status and health of the resource and its subordinate or dependent resources.",
                    "longDescription": "This property shall contain any status or health properties of the resource."
                },
                "SupportedUpdateImageFormats": {
                    "description": "The image format types supported by the service.",
                    "items": {
                        "anyOf": [
                            {
                                "$ref": "#/definitions/SupportedUpdateImageFormatType"
                            },
                            {
                                "type": "null"
                            }
                        ]
                    },
                    "longDescription": "This property shall contain the image format types supported by the service.",
                    "readonly": true,
                    "type": "array",
                    "versionAdded": "v1_13_0"
                },
                "UpdateServiceCapabilities": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/UpdateServiceCapabilities.json#/definitions/UpdateServiceCapabilities",
                    "description": "A link to the capabilities of the update service.",
                    "longDescription": "This property shall contain a link to a resource of type `UpdateServiceCapabilities` that contains the capabilities of the update service.",
                    "readonly": true,
                    "versionAdded": "v1_16_0"
                },
                "VerifyRemoteServerCertificate": {
                    "description": "An indication of whether the service will verify the certificate of the server referenced by the `ImageURI` parameter in `SimpleUpdate` prior to sending the transfer request.",
                    "longDescription": "This property shall indicate whether the service will verify the certificate of the server referenced by the `ImageURI` parameter in `SimpleUpdate` prior to sending the transfer request with the certificates found in the collection referenced by the `RemoteServerCertificates` property.  If this property is not supported by the service, it shall be assumed to be `false`.  This property should default to `false` in order to maintain compatibility with older clients.  Regardless of the value of this property, services may perform additional verification based on other factors, such as the configuration of the `SecurityPolicy` resource.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ],
                    "versionAdded": "v1_9_0"
                },
                "VerifyRemoteServerSSHKey": {
                    "description": "An indication of whether the service will verify the SSH key of the server referenced by the `ImageURI` parameter in `SimpleUpdate` prior to sending the transfer request.",
                    "longDescription": "This property shall indicate whether the service will verify the SSH key of the server referenced by the `ImageURI` parameter in `SimpleUpdate` prior to sending the transfer request with the keys found in the collection referenced by the `RemoteServerSSHKeys` property.  If this property is not supported by the service, it shall be assumed to be `false`.  This property should default to `false` in order to maintain compatibility with older clients.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ],
                    "versionAdded": "v1_12_0"
                }
            },
            "required": [
                "@odata.id",
                "@odata.type",
                "Id",
                "Name"
            ],
            "type": "object"
        }
    },
    "language": "en",
    "owningEntity": "DMTF",
    "release": "2025.3",
    "title": "#UpdateService.v1_17_0.UpdateService"
}