sushy.resources.fabric package
updated: 2023-02-24 14:19
sushy.resources.fabric package
sushy.resources.fabric.constants module
-
class sushy.resources.fabric.constants.EntityRole(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases: Enum
Entity role constants
-
BOTH = 'Both'
The entity can both send and receive commands, messages, and other
requests to or from other entities on the fabric.
-
INITIATOR = 'Initiator'
The entity sends commands, messages, or other types of requests to
other entities on the fabric, but cannot receive commands from other
entities.
-
TARGET = 'Target'
The entity receives commands, messages, or other types of requests
from other entities on the fabric, but cannot send commands to other
entities.
-
class sushy.resources.fabric.constants.EntityType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases: Enum
Entity type constants
-
ACCELERATION_FUNCTION = 'AccelerationFunction'
The entity is an acceleration function realized through a device,
such as an FPGA.
-
BRIDGE = 'Bridge'
The entity is a PCI(e) bridge.
-
DISPLAY_CONTROLLER = 'DisplayController'
The entity is a display controller.
-
DRIVE = 'Drive'
The entity is a drive.
-
FABRIC_BRIDGE = 'FabricBridge'
The entity is a fabric bridge.
-
MANAGER = 'Manager'
The entity is a manager.
-
MEDIA_CONTROLLER = 'MediaController'
The entity is a media controller.
-
MEMORY_CHUNK = 'MemoryChunk'
The entity is a memory chunk.
-
NETWORK_CONTROLLER = 'NetworkController'
The entity is a network controller.
-
PROCESSOR = 'Processor'
The entity is a processor.
-
ROOT_COMPLEX = 'RootComplex'
The entity is a PCI(e) root complex.
-
STORAGE_EXPANDER = 'StorageExpander'
The entity is a storage expander.
-
STORAGE_INITIATOR = 'StorageInitiator'
The entity is a storage initiator.
-
STORAGE_SUBSYSTEM = 'StorageSubsystem'
The entity is a storage subsystem.
-
SWITCH = 'Switch'
The entity is a switch, not an expander. Use Expander for
expanders.
-
VOLUME = 'Volume'
The entity is a volume.
sushy.resources.fabric.endpoint module
-
class sushy.resources.fabric.endpoint.ConnectedEntitiesListField(*args, **kwargs)
Bases: ListField
All the entities connected to this endpoint.
-
entity_pci_id = <sushy.resources.fabric.endpoint.PciIdField object>
The PCI ID of the connected entity.
-
entity_role = <sushy.resources.base.MappedField object>
The role of the connected entity.
-
entity_type = <sushy.resources.base.MappedField object>
The type of the connected entity.
-
identifiers = <sushy.resources.common.IdentifiersListField object>
Identifiers for the remote entity.
-
pci_class_code = <sushy.resources.base.Field object>
The Class Code, Subclass code, and Programming Interface code of
this PCIe function.
-
pci_function_number = <sushy.resources.base.Field object>
The PCI ID of the connected entity.
-
class sushy.resources.fabric.endpoint.Endpoint(connector, path='', redfish_version=None, registries=None, reader=None, json_doc=None, root=None)
Bases: ResourceBase
This class represents a fabric endpoint.
It represents the properties of an entity that sends or receives protocol
defined messages over a transport.
-
IP_transport_details = <sushy.resources.fabric.endpoint.IPTransportDetailsListField object>
This array contains details for each IP transport supported by this
endpoint. The array structure can be used to model multiple IP addresses
for this endpoint.
-
connected_entities = <sushy.resources.fabric.endpoint.ConnectedEntitiesListField object>
All entities connected to this endpoint.
-
description = <sushy.resources.base.Field object>
The endpoint description
-
endpoint_protocol = <sushy.resources.base.MappedField object>
The protocol supported by this endpoint.
-
host_reservation_memory_bytes = <sushy.resources.base.Field object>
The amount of memory in Bytes that the Host should allocate to connect
to this endpoint.
-
identity = <sushy.resources.base.Field object>
Identifier for the endpoint
-
name = <sushy.resources.base.Field object>
The endpoint name
-
pci_id = <sushy.resources.fabric.endpoint.PciIdField object>
The PCI ID of the endpoint.
-
status = <sushy.resources.common.StatusField object>
The endpoint status
-
class sushy.resources.fabric.endpoint.EndpointCollection(connector, path, redfish_version=None, registries=None, root=None)
Bases: ResourceCollectionBase
Represents a collection of endpoints associated with the fabric.
-
class sushy.resources.fabric.endpoint.IPTransportDetailsListField(*args, **kwargs)
Bases: ListField
IP transport details
This array contains details for each IP transport supported by this
endpoint. The array structure can be used to model multiple IP addresses
for this endpoint.
-
ipv4_address = <sushy.resources.fabric.endpoint.IPv4AddressField object>
The IPv4 address object.
-
ipv6_address = <sushy.resources.fabric.endpoint.IPv6AddressField object>
The IPv6 address object.
-
port = <sushy.resources.base.Field object>
The UDP or TCP port number used by the Endpoint.
-
transport_protocol = <sushy.resources.base.MappedField object>
The protocol used by the connection entity.
-
class sushy.resources.fabric.endpoint.IPv4AddressField(*args, **kwargs)
Bases: CompositeField
-
address = <sushy.resources.base.Field object>
This is the IPv4 Address.
-
address_origin = <sushy.resources.base.MappedField object>
This indicates how the address was determined.
-
gateway = <sushy.resources.base.Field object>
This is the IPv4 gateway for this address.
-
subnet_mask = <sushy.resources.base.Field object>
This is the IPv4 Subnet mask.
-
class sushy.resources.fabric.endpoint.IPv6AddressField(*args, **kwargs)
Bases: CompositeField
-
address = <sushy.resources.base.Field object>
This is the IPv6 Address.
-
address_origin = <sushy.resources.base.MappedField object>
This indicates how the address was determined.
-
address_state = <sushy.resources.base.MappedField object>
The current state of this address as defined in RFC 4862.
-
prefix_length = <sushy.resources.base.Field object>
This is the IPv6 Address Prefix Length.
-
class sushy.resources.fabric.endpoint.PciIdField(*args, **kwargs)
Bases: CompositeField
-
device_id = <sushy.resources.base.Field object>
The Device ID of this PCIe function.
-
subsystem_id = <sushy.resources.base.Field object>
The Subsystem ID of this PCIefunction.
-
subsystem_vendor_id = <sushy.resources.base.Field object>
The Subsystem Vendor ID of thisPCIe function.
-
vendor_id = <sushy.resources.base.Field object>
The Vendor ID of this PCIe function.
sushy.resources.fabric.fabric module
-
class sushy.resources.fabric.fabric.Fabric(connector, identity, redfish_version=None, registries=None, root=None)
Bases: ResourceBase
Fabric resource
The Fabric represents a simple fabric consisting of one or more
switches, zero or more endpoints, and zero or more zones.
-
description = <sushy.resources.base.Field object>
The fabric description
-
property endpoints
-
fabric_type = <sushy.resources.base.MappedField object>
The protocol being sent over this fabric
-
identity = <sushy.resources.base.Field object>
Identifier for the fabric
-
max_zones = <sushy.resources.base.Field object>
The maximum number of zones the switch can currently configure
-
name = <sushy.resources.base.Field object>
The fabric name
-
status = <sushy.resources.common.StatusField object>
The fabric status
-
class sushy.resources.fabric.fabric.FabricCollection(connector, path, redfish_version=None, registries=None, root=None)
Bases: ResourceCollectionBase
updated: 2023-02-24 14:19