# sushy.resources.updateservice package

## Submodules

## sushy.resources.updateservice.constants module

class sushy.resources.updateservice.constants.UpdateTransferProtocolType(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)

  Bases: `Enum`

  Transfer Protocol Type constants

  CIFS = 'CIFS'

    Common Internet File System (CIFS).

  FTP = 'FTP'

    File Transfer Protocol (FTP).

  HTTP = 'HTTP'

    Hypertext Transfer Protocol (HTTP).

  HTTPS = 'HTTPS'

    Hypertext Transfer Protocol Secure (HTTPS).

  NFS = 'NFS'

    Network File System (NFS).

  NSF = 'NFS'

    Network File System (NFS).

  OEM = 'OEM'

    A manufacturer-defined protocol.

  SCP = 'SCP'

    Secure Copy Protocol (SCP).

  SFTP = 'SFTP'

    Secure File Transfer Protocol (SFTP).

  TFTP = 'TFTP'

    Trivial File Transfer Protocol (TFTP).

## sushy.resources.updateservice.softwareinventory module

class sushy.resources.updateservice.softwareinventory.SoftwareInventory(connector, identity, redfish_version=None, registries=None, root=None)

  Bases: `ResourceBase`

  identity = <sushy.resources.base.Field object>

    The software inventory identity

  lowest_supported_version = <sushy.resources.base.Field object>

    The lowest supported version of the software

  manufacturer = <sushy.resources.base.Field object>

    The manufacturer of the software

  name = <sushy.resources.base.Field object>

    The software inventory name

  related_item = <sushy.resources.base.Field object>

    The ID(s) of the resources associated with the software inventory item

  release_date = <sushy.resources.base.Field object>

    Release date of the software

  software_id = <sushy.resources.base.Field object>

    The identity of the software

  status = <sushy.resources.common.StatusField object>

    The status of the software inventory

  uefi_device_paths = <sushy.resources.base.Field object>

    Represents the UEFI Device Path(s)

  updateable = <sushy.resources.base.Field object>

    Indicates whether this software can be updated by the update service

  version = <sushy.resources.base.Field object>

    The version of the software

class sushy.resources.updateservice.softwareinventory.SoftwareInventoryCollection(connector, identity, redfish_version=None, registries=None, root=None)

  Bases: `ResourceCollectionBase`

  description = <sushy.resources.base.Field object>

    The software inventory collection description

  name = <sushy.resources.base.Field object>

    The software inventory collection name

## sushy.resources.updateservice.updateservice module

class sushy.resources.updateservice.updateservice.ActionsField(*args, **kwargs)

  Bases: `CompositeField`

  simple_update = <sushy.resources.common.ActionField object>

class sushy.resources.updateservice.updateservice.UpdateService(connector, identity, redfish_version=None, registries=None, root=None)

  Bases: `ResourceBase`

  property firmware_inventory

    Property to reference FirmwareInventory collection instance

  get_allowed_transfer_protocols()

    Get the allowed values for transfer protocol.

    Returns:

      A set of allowed values.

    Raises:

      MissingAttributeError, if Actions/#UpdateService.SimpleUpdate attribute not present.

  get_task_monitor(task_monitor)

    Used to retrieve a TaskMonitor.

    Deprecated: Use sushy.Sushy.get_task_monitor :returns: A task monitor.

  http_push_uri = <sushy.resources.base.Field object>

    The URI used to perform an HTTP or HTTPS push update to the Update Service

  http_push_uri_targets = <sushy.resources.base.Field object>
  http_push_uri_targets_busy = <sushy.resources.base.Field object>
  identity = <sushy.resources.base.Field object>

    The update service identity

  name = <sushy.resources.base.Field object>

    The update service name

  service_enabled = <sushy.resources.base.Field object>

    The status of whether this service is enabled

  simple_update(image_uri, targets=None, transfer_protocol=UpdateTransferProtocolType.HTTP)

    Simple Update is used to update software components.

    Returns:

      A task monitor.

  property software_inventory

    Property to reference SoftwareInventory collection instance

  status = <sushy.resources.common.StatusField object>

    The status of the update service

## Module contents

this page last updated: 2024-01-23 14:01:57

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug