components:
  schemas:
    UpdateService_v1_3_13_Actions:
      additionalProperties: false
      description: The available actions for this resource.
      properties:
        '#UpdateService.SimpleUpdate':
          $ref: '#/components/schemas/UpdateService_v1_3_13_SimpleUpdate'
        Oem:
          $ref: '#/components/schemas/UpdateService_v1_3_13_OemActions'
          description: The available OEM-specific actions for this resource.
          x-longDescription: This property shall contain the available OEM-specific
            actions for this resource.
      type: object
      x-longDescription: This type shall contain the available actions for this resource.
      x-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.
    UpdateService_v1_3_13_OemActions:
      additionalProperties: true
      description: The available OEM-specific actions for this resource.
      properties: {}
      type: object
      x-longDescription: This type shall contain the available OEM-specific actions
        for this resource.
      x-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.
    UpdateService_v1_3_13_SimpleUpdate:
      additionalProperties: false
      description: This action updates software components.
      properties:
        target:
          description: Link to invoke action
          format: uri-reference
          type: string
        title:
          description: Friendly action name
          type: string
      type: object
      x-longDescription: This action shall update installed software components in
        a software image file located at an `ImageURI` parameter-specified URI.
      x-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.
    UpdateService_v1_3_13_SimpleUpdateRequestBody:
      additionalProperties: false
      description: This action updates software components.
      properties:
        ImageURI:
          description: The URI of the software image to install.
          format: uri-reference
          type: string
          x-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.  The software image may contain multiple images
            if supported by the image format.  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.
        Targets:
          description: An array of URIs that indicate where to apply the update image.
          format: uri-reference
          items:
            type: string
          type: array
          x-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.  If the provided software image
            is a bundle of multiple images, the service shall apply each software
            image as specified by this parameter.
          x-versionAdded: v1_2_0
        TransferProtocol:
          $ref: '#/components/schemas/UpdateService_v1_3_13_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.
          x-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.
      required:
      - ImageURI
      type: object
      x-longDescription: This action shall update installed software components in
        a software image file located at an `ImageURI` parameter-specified URI.
      x-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.
    UpdateService_v1_3_13_TransferProtocolType:
      enum:
      - CIFS
      - FTP
      - SFTP
      - HTTP
      - HTTPS
      - NSF
      - SCP
      - TFTP
      - OEM
      - NFS
      type: string
      x-enumDeprecated:
        NSF: This value has been deprecated in favor of NFS.
      x-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).
      x-enumVersionAdded:
        NFS: v1_3_0
        SFTP: v1_1_0
      x-enumVersionDeprecated:
        NSF: v1_3_0
    UpdateService_v1_3_13_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.
      properties:
        '@odata.context':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_context
        '@odata.etag':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_etag
        '@odata.id':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_id
        '@odata.type':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_type
        Actions:
          $ref: '#/components/schemas/UpdateService_v1_3_13_Actions'
          description: The available actions for this resource.
          x-longDescription: This property shall contain the available actions for
            this resource.
        Description:
          oneOf:
          - $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Description
          - enum:
            - null
          readOnly: true
        FirmwareInventory:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: An inventory of firmware.
          readOnly: true
          x-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.
        HttpPushUri:
          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
          readOnly: true
          type: string
          x-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.
          x-versionAdded: v1_1_0
        HttpPushUriTargets:
          description: An array of URIs that indicate where to apply the update image.
          format: uri-reference
          items:
            nullable: true
            type: string
          readOnly: false
          type: array
          x-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.  If the provided software image
            is a bundle of multiple images, the service shall apply each software
            image as specified by this parameter.
          x-versionAdded: v1_2_0
        HttpPushUriTargetsBusy:
          description: An indication of whether any client has reserved the `HttpPushUriTargets`
            property.
          nullable: true
          readOnly: false
          type: boolean
          x-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.
          x-versionAdded: v1_2_0
        Id:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Id
          readOnly: true
        Name:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Name
          readOnly: true
        Oem:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Oem
          description: The OEM extension property.
          x-longDescription: This property shall contain the OEM extensions.  All
            values for properties that this object contains shall conform to the Redfish
            Specification-described requirements.
        ServiceEnabled:
          description: An indication of whether this service is enabled.
          nullable: true
          readOnly: false
          type: boolean
          x-longDescription: This property shall indicate whether this service is
            enabled.
        SoftwareInventory:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: An inventory of software.
          readOnly: true
          x-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.
        Status:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Status
          description: The status and health of the resource and its subordinate or
            dependent resources.
          x-longDescription: This property shall contain any status or health properties
            of the resource.
      required:
      - '@odata.id'
      - '@odata.type'
      - Id
      - Name
      type: object
      x-longDescription: This resource shall represent an update service and the properties
        that affect the service itself for a Redfish implementation.
      x-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.
title: '#UpdateService.v1_3_13.UpdateService'
x-copyright: Copyright 2014-2026 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright
x-language: en
x-owningEntity: DMTF
x-release: '2018.2'
