# sushy.resources.compositionservice package

## Submodules

## sushy.resources.compositionservice.compositionservice module

class sushy.resources.compositionservice.compositionservice.CompositionService(connector, identity, redfish_version=None, registries=None, root=None)

  Bases: `ResourceBase`

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

    This indicates whether this service is allowed to overprovision

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

    This indicates whether a client is allowed to request that given composition request

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

    The composition service description

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

    The composition service identity string

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

    The composition service name

  property resource_blocks

    Property to reference ResourceBlockCollection instance

  property resource_zones

    Property to reference ResourceZoneCollection instance

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

    The status of composition service is enabled

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

    The status of composition service

## sushy.resources.compositionservice.constants module

class sushy.resources.compositionservice.constants.CompositionState(*values)

  Bases: `Enum`

  COMPOSED = 'Composed'

    Final successful state of a Resource Block which has participated in composition.

  COMPOSED_AND_AVAILABLE = 'ComposedAndAvailable'

    Indicates the Resource Block is currently participating in one or more compositions, and is available to be used in more compositions.

  COMPOSING = 'Composing'

    Intermediate state indicating composition is in progress.

  FAILED = 'Failed'

    The final composition resulted in failure and manual intervention may be required to fix it.

  UNAVAILABLE = 'Unavailable'

    Indicates the Resource Block has been made unavailable by the service, such as due to maintenance being performed on the Resource Block.

  UNUSED = 'Unused'

    Indicates the Resource Block is free and can participate in composition.

class sushy.resources.compositionservice.constants.ResourceBlockType(*values)

  Bases: `Enum`

  COMPUTE = 'Compute'

    This Resource Block contains both Processor and Memory resources in a manner that creates a compute complex.

  COMPUTER_SYSTEM = 'ComputerSystem'

    This Resource Block contains ComputerSystem resources.

  EXPANSION = 'Expansion'

    This Resource Block is capable of changing over time based on its configuration. Different types of devices within this Resource Block can be added and removed over time.

  MEMORY = 'Memory'

    This Resource Block contains Memory resources.

  NETWORK = 'Network'

    This Resource Block contains Network resources, such as Ethernet Interfaces.

  PROCESSOR = 'Processor'

    This Resource Block contains Processor resources.

  STORAGE = 'Storage'

    This Resource Block contains Storage resources, such as Storage and Simple Storage.

## sushy.resources.compositionservice.resourceblock module

class sushy.resources.compositionservice.resourceblock.CompositionStatusField(*args, **kwargs)

  Bases: `CompositeField`

  composition_state = <sushy.resources.base.MappedField object>

    Inform the client, state of the resource block

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

    The maximum number of compositions

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

    The number of compositions

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

    Inform the resource block has been identified by a client

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

    Indicates if this Resource Block is capable of participating in multiple compositions simultaneously

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

    Indicates if this Resource Block is allowed to participate in multiple compositions simultaneously

class sushy.resources.compositionservice.resourceblock.ResourceBlock(connector, identity, redfish_version=None, registries=None, root=None)

  Bases: `ResourceBase`

  composition_status = <sushy.resources.compositionservice.resourceblock.CompositionStatusField object>

    The composition state of resource block

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

    The resource block description

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

    The resource block identity string

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

    The resource block name

  resource_block_type = <sushy.resources.base.MappedField object>

    The type of resource block

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

    The status of resource block

class sushy.resources.compositionservice.resourceblock.ResourceBlockCollection(connector, identity, redfish_version=None, registries=None, root=None)

  Bases: `ResourceCollectionBase`

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

    The resource block collection description

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

    The resource block collection name

## sushy.resources.compositionservice.resourcezone module

class sushy.resources.compositionservice.resourcezone.LinksField(*args, **kwargs)

  Bases: `CompositeField`

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

    The references to the endpoints that are contained in this zone

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

    The references to the switches in this zone

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

    The references to the Resource Blocks that are used in this zone

class sushy.resources.compositionservice.resourcezone.ResourceZone(connector, identity, redfish_version=None, registries=None, root=None)

  Bases: `ResourceBase`

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

    The resources zone description

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

    The resource zone identity string

  links = <sushy.resources.compositionservice.resourcezone.LinksField object>

    The references to other resources that are related to this resource

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

    The resource zone name

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

    The resource zone status

class sushy.resources.compositionservice.resourcezone.ResourceZoneCollection(connector, identity, redfish_version=None, registries=None, root=None)

  Bases: `ResourceCollectionBase`

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

    The resource zone collection description

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

    The resource zone collection name

## Module contents

this page last updated: 2026-01-20 23:50:10

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