# sushy.resources package

## Subpackages

- sushy.resources.certificateservice package
  - Submodules
  - sushy.resources.certificateservice.certificate module
    - `Certificate`
      - `Certificate.certificate_string`
      - `Certificate.certificate_type`
      - `Certificate.certificate_usage_type`
      - `Certificate.delete()`
      - `Certificate.description`
      - `Certificate.fingerprint`
      - `Certificate.fingerprint_hash_algorithm`
      - `Certificate.identity`
      - `Certificate.issuer`
      - `Certificate.key_usage`
      - `Certificate.name`
      - `Certificate.serial_number`
      - `Certificate.signature_algorithm`
      - `Certificate.subject`
      - `Certificate.uefi_signature_owner`
      - `Certificate.valid_not_after`
      - `Certificate.valid_not_before`
    - `CertificateCollection`
      - `CertificateCollection.create_member()`
    - `Identifier`
      - `Identifier.city`
      - `Identifier.common_name`
      - `Identifier.country`
      - `Identifier.email`
      - `Identifier.organization`
      - `Identifier.organizational_unit`
      - `Identifier.state`
  - sushy.resources.certificateservice.certificateservice module
    - `ActionsField`
      - `ActionsField.generate_csr`
      - `ActionsField.replace_certificate`
    - `CertificateLocations`
      - `CertificateLocations.members_identities`
      - `CertificateLocations.name`
    - `CertificateService`
      - `CertificateService.certificate_locations`
      - `CertificateService.identity`
      - `CertificateService.name`
      - `CertificateService.replace_certificate()`
  - sushy.resources.certificateservice.constants module
    - `CertificateType`
      - `CertificateType.PEM`
      - `CertificateType.PEM_CHAIN`
      - `CertificateType.PKCS7`
    - `CertificateUsageType`
      - `CertificateUsageType.BIOS`
      - `CertificateUsageType.DEVICE`
      - `CertificateUsageType.PLATFORM`
      - `CertificateUsageType.SSH`
      - `CertificateUsageType.USER`
      - `CertificateUsageType.WEB`
    - `KeyUsage`
      - `KeyUsage.CLIENT_AUTHENTICATION`
      - `KeyUsage.CODE_SIGNING`
      - `KeyUsage.CRL_SIGNING`
      - `KeyUsage.DATA_ENCIPHERMENT`
      - `KeyUsage.DECIPHER_ONLY`
      - `KeyUsage.DIGITAL_SIGNATURE`
      - `KeyUsage.EMAIL_PROTECTION`
      - `KeyUsage.ENCIPHER_ONLY`
      - `KeyUsage.KEY_AGREEMENT`
      - `KeyUsage.KEY_CERT_SIGN`
      - `KeyUsage.KEY_ENCIPHERMENT`
      - `KeyUsage.NON_REPUDIATION`
      - `KeyUsage.OCSP_SIGNING`
      - `KeyUsage.SERVER_AUTHENTICATION`
      - `KeyUsage.TIMESTAMPING`
  - Module contents
- sushy.resources.chassis package
  - Subpackages
    - sushy.resources.chassis.power package
      - Submodules
      - sushy.resources.chassis.power.constants module
      - sushy.resources.chassis.power.power module
      - Module contents
    - sushy.resources.chassis.thermal package
      - Submodules
      - sushy.resources.chassis.thermal.constants module
      - sushy.resources.chassis.thermal.thermal module
      - Module contents
  - Submodules
  - sushy.resources.chassis.chassis module
    - `ActionsField`
      - `ActionsField.reset`
    - `Chassis`
      - `Chassis.asset_tag`
      - `Chassis.chassis_type`
      - `Chassis.depth_mm`
      - `Chassis.description`
      - `Chassis.get_allowed_reset_chassis_values()`
      - `Chassis.height_mm`
      - `Chassis.identity`
      - `Chassis.indicator_led`
      - `Chassis.managers`
      - `Chassis.manufacturer`
      - `Chassis.model`
      - `Chassis.name`
      - `Chassis.network_adapters`
      - `Chassis.part_number`
      - `Chassis.physical_security`
      - `Chassis.power`
      - `Chassis.power_state`
      - `Chassis.reset_chassis()`
      - `Chassis.serial_number`
      - `Chassis.set_indicator_led()`
      - `Chassis.sku`
      - `Chassis.status`
      - `Chassis.systems`
      - `Chassis.thermal`
      - `Chassis.uuid`
      - `Chassis.weight_kg`
      - `Chassis.width_mm`
    - `ChassisCollection`
    - `PhysicalSecurity`
      - `PhysicalSecurity.intrusion_sensor`
      - `PhysicalSecurity.intrusion_sensor_number`
      - `PhysicalSecurity.intrusion_sensor_re_arm`
  - sushy.resources.chassis.constants module
    - `ChassisType`
      - `ChassisType.BLADE`
      - `ChassisType.CARD`
      - `ChassisType.CARTRIDGE`
      - `ChassisType.COMPONENT`
      - `ChassisType.DRAWER`
      - `ChassisType.ENCLOSURE`
      - `ChassisType.EXPANSION`
      - `ChassisType.IP_BASED_DRIVE`
      - `ChassisType.MODULE`
      - `ChassisType.OTHER`
      - `ChassisType.POD`
      - `ChassisType.RACK`
      - `ChassisType.RACK_GROUP`
      - `ChassisType.RACK_MOUNT`
      - `ChassisType.ROW`
      - `ChassisType.SHELF`
      - `ChassisType.SIDECAR`
      - `ChassisType.SLED`
      - `ChassisType.STAND_ALONE`
      - `ChassisType.STORAGE_ENCLOSURE`
      - `ChassisType.ZONE`
    - `IntrusionSensor`
      - `IntrusionSensor.HARDWARE_INTRUSION`
      - `IntrusionSensor.NORMAL`
      - `IntrusionSensor.TAMPERING_DETECTED`
    - `IntrusionSensorReArm`
      - `IntrusionSensorReArm.AUTOMATIC`
      - `IntrusionSensorReArm.MANUAL`
  - Module contents
- sushy.resources.compositionservice package
  - Submodules
  - sushy.resources.compositionservice.compositionservice module
    - `CompositionService`
      - `CompositionService.allow_overprovisioning`
      - `CompositionService.allow_zone_affinity`
      - `CompositionService.description`
      - `CompositionService.identity`
      - `CompositionService.name`
      - `CompositionService.resource_blocks`
      - `CompositionService.resource_zones`
      - `CompositionService.service_enabled`
      - `CompositionService.status`
  - sushy.resources.compositionservice.constants module
    - `CompositionState`
      - `CompositionState.COMPOSED`
      - `CompositionState.COMPOSED_AND_AVAILABLE`
      - `CompositionState.COMPOSING`
      - `CompositionState.FAILED`
      - `CompositionState.UNAVAILABLE`
      - `CompositionState.UNUSED`
    - `ResourceBlockType`
      - `ResourceBlockType.COMPUTE`
      - `ResourceBlockType.COMPUTER_SYSTEM`
      - `ResourceBlockType.EXPANSION`
      - `ResourceBlockType.MEMORY`
      - `ResourceBlockType.NETWORK`
      - `ResourceBlockType.PROCESSOR`
      - `ResourceBlockType.STORAGE`
  - sushy.resources.compositionservice.resourceblock module
    - `CompositionStatusField`
      - `CompositionStatusField.composition_state`
      - `CompositionStatusField.max_compositions`
      - `CompositionStatusField.number_of_compositions`
      - `CompositionStatusField.reserved_state`
      - `CompositionStatusField.sharing_capable`
      - `CompositionStatusField.sharing_enabled`
    - `ResourceBlock`
      - `ResourceBlock.composition_status`
      - `ResourceBlock.description`
      - `ResourceBlock.identity`
      - `ResourceBlock.name`
      - `ResourceBlock.resource_block_type`
      - `ResourceBlock.status`
    - `ResourceBlockCollection`
      - `ResourceBlockCollection.description`
      - `ResourceBlockCollection.name`
  - sushy.resources.compositionservice.resourcezone module
    - `LinksField`
      - `LinksField.endpoints`
      - `LinksField.involved_switches`
      - `LinksField.resource_blocks`
    - `ResourceZone`
      - `ResourceZone.description`
      - `ResourceZone.identity`
      - `ResourceZone.links`
      - `ResourceZone.name`
      - `ResourceZone.status`
    - `ResourceZoneCollection`
      - `ResourceZoneCollection.description`
      - `ResourceZoneCollection.name`
  - Module contents
- sushy.resources.eventservice package
  - Submodules
  - sushy.resources.eventservice.constants module
    - `EventType`
      - `EventType.ALERT`
      - `EventType.METRIC_REPORT`
      - `EventType.OTHER`
      - `EventType.RESOURCE_ADDED`
      - `EventType.RESOURCE_REMOVED`
      - `EventType.RESOURCE_UPDATED`
      - `EventType.STATUS_CHANGE`
  - sushy.resources.eventservice.eventdestination module
    - `EventDestination`
      - `EventDestination.context`
      - `EventDestination.delete()`
      - `EventDestination.description`
      - `EventDestination.destination`
      - `EventDestination.event_types`
      - `EventDestination.http_headers`
      - `EventDestination.identity`
      - `EventDestination.name`
      - `EventDestination.protocol`
    - `EventDestinationCollection`
      - `EventDestinationCollection.create()`
      - `EventDestinationCollection.description`
      - `EventDestinationCollection.name`
  - sushy.resources.eventservice.eventservice module
    - `ActionsField`
      - `ActionsField.submit_test_event`
    - `EventService`
      - `EventService.delivery_retry_attempts`
      - `EventService.delivery_retry_interval`
      - `EventService.event_types_for_subscription`
      - `EventService.get_event_types_for_subscription()`
      - `EventService.identity`
      - `EventService.name`
      - `EventService.service_enabled`
      - `EventService.status`
      - `EventService.submit_test_event()`
      - `EventService.subscriptions`
  - Module contents
- sushy.resources.fabric package
  - Submodules
  - sushy.resources.fabric.constants module
    - `EntityRole`
      - `EntityRole.BOTH`
      - `EntityRole.INITIATOR`
      - `EntityRole.TARGET`
    - `EntityType`
      - `EntityType.ACCELERATION_FUNCTION`
      - `EntityType.BRIDGE`
      - `EntityType.DISPLAY_CONTROLLER`
      - `EntityType.DRIVE`
      - `EntityType.FABRIC_BRIDGE`
      - `EntityType.MANAGER`
      - `EntityType.MEDIA_CONTROLLER`
      - `EntityType.MEMORY_CHUNK`
      - `EntityType.NETWORK_CONTROLLER`
      - `EntityType.PROCESSOR`
      - `EntityType.ROOT_COMPLEX`
      - `EntityType.STORAGE_EXPANDER`
      - `EntityType.STORAGE_INITIATOR`
      - `EntityType.STORAGE_SUBSYSTEM`
      - `EntityType.SWITCH`
      - `EntityType.VOLUME`
  - sushy.resources.fabric.endpoint module
    - `ConnectedEntitiesListField`
      - `ConnectedEntitiesListField.entity_pci_id`
      - `ConnectedEntitiesListField.entity_role`
      - `ConnectedEntitiesListField.entity_type`
      - `ConnectedEntitiesListField.identifiers`
      - `ConnectedEntitiesListField.pci_class_code`
      - `ConnectedEntitiesListField.pci_function_number`
    - `Endpoint`
      - `Endpoint.IP_transport_details`
      - `Endpoint.connected_entities`
      - `Endpoint.description`
      - `Endpoint.endpoint_protocol`
      - `Endpoint.host_reservation_memory_bytes`
      - `Endpoint.identity`
      - `Endpoint.name`
      - `Endpoint.pci_id`
      - `Endpoint.status`
    - `EndpointCollection`
    - `IPTransportDetailsListField`
      - `IPTransportDetailsListField.ipv4_address`
      - `IPTransportDetailsListField.ipv6_address`
      - `IPTransportDetailsListField.port`
      - `IPTransportDetailsListField.transport_protocol`
    - `IPv4AddressField`
      - `IPv4AddressField.address`
      - `IPv4AddressField.address_origin`
      - `IPv4AddressField.gateway`
      - `IPv4AddressField.subnet_mask`
    - `IPv6AddressField`
      - `IPv6AddressField.address`
      - `IPv6AddressField.address_origin`
      - `IPv6AddressField.address_state`
      - `IPv6AddressField.prefix_length`
    - `PciIdField`
      - `PciIdField.device_id`
      - `PciIdField.subsystem_id`
      - `PciIdField.subsystem_vendor_id`
      - `PciIdField.vendor_id`
  - sushy.resources.fabric.fabric module
    - `Fabric`
      - `Fabric.description`
      - `Fabric.endpoints`
      - `Fabric.fabric_type`
      - `Fabric.identity`
      - `Fabric.max_zones`
      - `Fabric.name`
      - `Fabric.status`
    - `FabricCollection`
  - Module contents
- sushy.resources.manager package
  - Submodules
  - sushy.resources.manager.constants module
    - `CommandConnectType`
      - `CommandConnectType.IPMI`
      - `CommandConnectType.OEM`
      - `CommandConnectType.SSH`
      - `CommandConnectType.TELNET`
    - `ConnectedVia`
      - `ConnectedVia.APPLET`
      - `ConnectedVia.NOT_CONNECTED`
      - `ConnectedVia.OEM`
      - `ConnectedVia.URI`
    - `GraphicalConnectType`
      - `GraphicalConnectType.KVMIP`
      - `GraphicalConnectType.OEM`
    - `ManagerType`
      - `ManagerType.AUXILIARY_CONTROLLER`
      - `ManagerType.BMC`
      - `ManagerType.ENCLOSURE_MANAGER`
      - `ManagerType.MANAGEMENT_CONTROLLER`
      - `ManagerType.RACK_MANAGER`
      - `ManagerType.SERVICE`
    - `RESET_MANAGER_FORCE_RESTART`
    - `RESET_MANAGER_GRACEFUL_RESTART`
    - `SerialConnectType`
      - `SerialConnectType.IPMI`
      - `SerialConnectType.OEM`
      - `SerialConnectType.SSH`
      - `SerialConnectType.TELNET`
    - `TransferMethod`
      - `TransferMethod.STREAM`
      - `TransferMethod.UPLOAD`
    - `VirtualMediaType`
      - `VirtualMediaType.CD`
      - `VirtualMediaType.DVD`
      - `VirtualMediaType.FLOPPY`
      - `VirtualMediaType.USB_STICK`
  - sushy.resources.manager.manager module
    - `ActionsField`
      - `ActionsField.reset`
    - `Manager`
      - `Manager.auto_dst_enabled`
      - `Manager.chassis`
      - `Manager.command_shell`
      - `Manager.description`
      - `Manager.firmware_version`
      - `Manager.get_allowed_reset_manager_values()`
      - `Manager.get_supported_command_shell_types()`
      - `Manager.get_supported_graphical_console_types()`
      - `Manager.get_supported_serial_console_types()`
      - `Manager.graphical_console`
      - `Manager.identity`
      - `Manager.manager_type`
      - `Manager.model`
      - `Manager.name`
      - `Manager.reset_manager()`
      - `Manager.serial_console`
      - `Manager.systems`
      - `Manager.uuid`
      - `Manager.virtual_media`
    - `ManagerCollection`
    - `RemoteAccessField`
      - `RemoteAccessField.connect_types_supported`
      - `RemoteAccessField.max_concurrent_sessions`
      - `RemoteAccessField.service_enabled`
  - sushy.resources.manager.virtual_media module
    - `ActionsField`
      - `ActionsField.eject_media`
      - `ActionsField.insert_media`
    - `VirtualMedia`
      - `VirtualMedia.certificates`
      - `VirtualMedia.connected_via`
      - `VirtualMedia.eject_media()`
      - `VirtualMedia.identity`
      - `VirtualMedia.image`
      - `VirtualMedia.image_name`
      - `VirtualMedia.insert_media()`
      - `VirtualMedia.inserted`
      - `VirtualMedia.is_transfer_method_required()`
      - `VirtualMedia.is_transfer_protocol_required()`
      - `VirtualMedia.media_types`
      - `VirtualMedia.name`
      - `VirtualMedia.set_verify_certificate()`
      - `VirtualMedia.status`
      - `VirtualMedia.transfer_method`
      - `VirtualMedia.user_name`
      - `VirtualMedia.verify_certificate`
      - `VirtualMedia.write_protected`
    - `VirtualMediaCollection`
  - Module contents
- sushy.resources.oem package
  - Submodules
  - sushy.resources.oem.base module
    - `OEMResourceBase`
      - `OEMResourceBase.set_parent_resource()`
  - sushy.resources.oem.common module
    - `get_resource_extension_by_vendor()`
  - sushy.resources.oem.fake module
    - `ContosoActionsField`
      - `ContosoActionsField.reset`
    - `FakeOEMSystemExtension`
      - `FakeOEMSystemExtension.data_type`
      - `FakeOEMSystemExtension.get_reset_system_path()`
      - `FakeOEMSystemExtension.name`
      - `FakeOEMSystemExtension.production_location`
    - `ProductionLocationField`
      - `ProductionLocationField.country`
      - `ProductionLocationField.facility_name`
    - `get_extension()`
  - Module contents
    - `get_resource_extension_by_vendor()`
- sushy.resources.registry package
  - Submodules
  - sushy.resources.registry.attribute_registry module
    - `AttributeListField`
      - `AttributeListField.allowable_values`
      - `AttributeListField.attribute_type`
      - `AttributeListField.default_value`
      - `AttributeListField.display_name`
      - `AttributeListField.immutable`
      - `AttributeListField.lower_bound`
      - `AttributeListField.max_length`
      - `AttributeListField.min_length`
      - `AttributeListField.name`
      - `AttributeListField.read_only`
      - `AttributeListField.reset_required`
      - `AttributeListField.unique`
      - `AttributeListField.upper_bound`
    - `AttributeRegistry`
      - `AttributeRegistry.description`
      - `AttributeRegistry.identity`
      - `AttributeRegistry.language`
      - `AttributeRegistry.name`
      - `AttributeRegistry.owning_entity`
      - `AttributeRegistry.registry_entries`
      - `AttributeRegistry.registry_version`
      - `AttributeRegistry.supported_systems`
    - `AttributeRegistryEntryField`
      - `AttributeRegistryEntryField.attributes`
  - sushy.resources.registry.constants module
    - `MessageParamType`
      - `MessageParamType.NUMBER`
      - `MessageParamType.STRING`
  - sushy.resources.registry.message_registry module
    - `MessageDictionaryField`
      - `MessageDictionaryField.description`
      - `MessageDictionaryField.message`
      - `MessageDictionaryField.number_of_args`
      - `MessageDictionaryField.param_types`
      - `MessageDictionaryField.resolution`
      - `MessageDictionaryField.severity`
    - `MessageRegistry`
      - `MessageRegistry.description`
      - `MessageRegistry.identity`
      - `MessageRegistry.language`
      - `MessageRegistry.messages`
      - `MessageRegistry.name`
      - `MessageRegistry.owning_entity`
      - `MessageRegistry.registry_prefix`
      - `MessageRegistry.registry_version`
    - `parse_message()`
  - sushy.resources.registry.message_registry_file module
    - `LocationListField`
      - `LocationListField.archive_file`
      - `LocationListField.archive_uri`
      - `LocationListField.language`
      - `LocationListField.publication_uri`
      - `LocationListField.uri`
    - `MessageRegistryFile`
      - `MessageRegistryFile.description`
      - `MessageRegistryFile.get_attribute_registry()`
      - `MessageRegistryFile.get_message_registry()`
      - `MessageRegistryFile.identity`
      - `MessageRegistryFile.languages`
      - `MessageRegistryFile.location`
      - `MessageRegistryFile.name`
      - `MessageRegistryFile.registry`
    - `MessageRegistryFileCollection`
    - `RegistryType`
  - Module contents
- sushy.resources.sessionservice package
  - Submodules
  - sushy.resources.sessionservice.session module
    - `Session`
      - `Session.delete()`
      - `Session.description`
      - `Session.identity`
      - `Session.name`
      - `Session.username`
    - `SessionCollection`
      - `SessionCollection.description`
      - `SessionCollection.name`
  - sushy.resources.sessionservice.sessionservice module
    - `SessionService`
      - `SessionService.close_session()`
      - `SessionService.create_session()`
      - `SessionService.description`
      - `SessionService.identity`
      - `SessionService.name`
      - `SessionService.service_enabled`
      - `SessionService.session_timeout`
      - `SessionService.sessions`
  - Module contents
- sushy.resources.system package
  - Subpackages
    - sushy.resources.system.network package
      - Submodules
      - sushy.resources.system.network.adapter module
      - sushy.resources.system.network.constants module
      - sushy.resources.system.network.device_function module
      - sushy.resources.system.network.port module
      - Module contents
    - sushy.resources.system.storage package
      - Submodules
      - sushy.resources.system.storage.constants module
      - sushy.resources.system.storage.controller module
      - sushy.resources.system.storage.drive module
      - sushy.resources.system.storage.storage module
      - sushy.resources.system.storage.volume module
      - Module contents
  - Submodules
  - sushy.resources.system.bios module
    - `ActionsField`
      - `ActionsField.change_password`
      - `ActionsField.reset_bios`
    - `Bios`
      - `Bios.apply_time_settings`
      - `Bios.attributes`
      - `Bios.change_password()`
      - `Bios.description`
      - `Bios.get_attribute_registry()`
      - `Bios.identity`
      - `Bios.maintenance_window`
      - `Bios.name`
      - `Bios.pending_attributes`
      - `Bios.reset_bios()`
      - `Bios.set_attribute()`
      - `Bios.set_attributes()`
      - `Bios.supported_apply_times`
      - `Bios.update_status`
  - sushy.resources.system.constants module
    - `BootProgressStates`
      - `BootProgressStates.BUS`
      - `BootProgressStates.HARDWARE_COMPLETE`
      - `BootProgressStates.MEMORY`
      - `BootProgressStates.NONE`
      - `BootProgressStates.OEM`
      - `BootProgressStates.OS_BOOT_STARTED`
      - `BootProgressStates.OS_RUNNING`
      - `BootProgressStates.PCI_RESOURCE_CONFIG`
      - `BootProgressStates.PRIMARY_PROCESSOR`
      - `BootProgressStates.SECONDARY_PROCESSOR`
      - `BootProgressStates.SETUP`
    - `BootSource`
      - `BootSource.BIOS_SETUP`
      - `BootSource.CD`
      - `BootSource.DIAGS`
      - `BootSource.FLOPPY`
      - `BootSource.HDD`
      - `BootSource.NONE`
      - `BootSource.PXE`
      - `BootSource.REMOTE_DRIVE`
      - `BootSource.SD_CARD`
      - `BootSource.UEFI_BOOT_NEXT`
      - `BootSource.UEFI_HTTP`
      - `BootSource.UEFI_SHELL`
      - `BootSource.UEFI_TARGET`
      - `BootSource.USB`
      - `BootSource.USB_CD`
      - `BootSource.UTILITIES`
    - `BootSourceOverrideEnabled`
      - `BootSourceOverrideEnabled.CONTINUOUS`
      - `BootSourceOverrideEnabled.DISABLED`
      - `BootSourceOverrideEnabled.ONCE`
    - `BootSourceOverrideMode`
      - `BootSourceOverrideMode.LEGACY`
      - `BootSourceOverrideMode.UEFI`
    - `InstructionSet`
      - `InstructionSet.ARM_A32`
      - `InstructionSet.ARM_A64`
      - `InstructionSet.IA_64`
      - `InstructionSet.MIPS32`
      - `InstructionSet.MIPS64`
      - `InstructionSet.OEM`
      - `InstructionSet.POWER_ISA`
      - `InstructionSet.X86`
      - `InstructionSet.X86_64`
    - `ProcessorArchitecture`
      - `ProcessorArchitecture.ARM`
      - `ProcessorArchitecture.IA_64`
      - `ProcessorArchitecture.MIPS`
      - `ProcessorArchitecture.OEM`
      - `ProcessorArchitecture.POWER`
      - `ProcessorArchitecture.X86`
    - `ProcessorType`
      - `ProcessorType.ACCELERATOR`
      - `ProcessorType.CORE`
      - `ProcessorType.CPU`
      - `ProcessorType.DSP`
      - `ProcessorType.FPGA`
      - `ProcessorType.GPU`
      - `ProcessorType.OEM`
      - `ProcessorType.THREAD`
    - `SYSTEM_POWER_STATE_OFF`
    - `SYSTEM_POWER_STATE_ON`
    - `SYSTEM_POWER_STATE_POWERING_OFF`
    - `SYSTEM_POWER_STATE_POWERING_ON`
    - `SecureBootCurrentBoot`
      - `SecureBootCurrentBoot.DISABLED`
      - `SecureBootCurrentBoot.ENABLED`
    - `SecureBootDatabaseId`
      - `SecureBootDatabaseId.ALLOWED_KEYS_DATABASE`
      - `SecureBootDatabaseId.DEFAULT_ALLOWED_KEYS_DATABASE`
      - `SecureBootDatabaseId.DEFAULT_DENIED_KEYS_DATABASE`
      - `SecureBootDatabaseId.DEFAULT_KEY_EXCHANGE_KEYS`
      - `SecureBootDatabaseId.DEFAULT_PLATFORM_KEY`
      - `SecureBootDatabaseId.DEFAULT_RECOVERY_KEYS_DATABASE`
      - `SecureBootDatabaseId.DEFAULT_TIMESTAMP_DATABASE`
      - `SecureBootDatabaseId.DENIED_KEYS_DATABASE`
      - `SecureBootDatabaseId.KEY_EXCHANGE_KEYS`
      - `SecureBootDatabaseId.PLATFORM_KEY`
      - `SecureBootDatabaseId.RECOVERY_KEYS_DATABASE`
      - `SecureBootDatabaseId.TIMESTAMP_DATABASE`
    - `SecureBootMode`
      - `SecureBootMode.AUDIT`
      - `SecureBootMode.DEPLOYED`
      - `SecureBootMode.SETUP`
      - `SecureBootMode.USER`
    - `SecureBootResetKeysType`
      - `SecureBootResetKeysType.DELETE_ALL_KEYS`
      - `SecureBootResetKeysType.DELETE_PK`
      - `SecureBootResetKeysType.RESET_ALL_KEYS_TO_DEFAULT`
    - `SystemType`
      - `SystemType.COMPOSED`
      - `SystemType.DPU`
      - `SystemType.OS`
      - `SystemType.PHYSICAL`
      - `SystemType.PHYSICALLY_PARTITIONED`
      - `SystemType.VIRTUAL`
      - `SystemType.VIRTUALLY_PARTITIONED`
  - sushy.resources.system.ethernet_interface module
    - `EthernetInterface`
      - `EthernetInterface.description`
      - `EthernetInterface.identity`
      - `EthernetInterface.mac_address`
      - `EthernetInterface.name`
      - `EthernetInterface.permanent_mac_address`
      - `EthernetInterface.speed_mbps`
      - `EthernetInterface.status`
    - `EthernetInterfaceCollection`
      - `EthernetInterfaceCollection.summary`
  - sushy.resources.system.processor module
    - `Processor`
      - `Processor.identity`
      - `Processor.instruction_set`
      - `Processor.manufacturer`
      - `Processor.max_speed_mhz`
      - `Processor.model`
      - `Processor.processor_architecture`
      - `Processor.processor_id`
      - `Processor.processor_type`
      - `Processor.socket`
      - `Processor.status`
      - `Processor.sub_processors`
      - `Processor.total_cores`
      - `Processor.total_threads`
    - `ProcessorCollection`
      - `ProcessorCollection.summary`
    - `ProcessorIdField`
      - `ProcessorIdField.effective_family`
      - `ProcessorIdField.effective_model`
      - `ProcessorIdField.identification_registers`
      - `ProcessorIdField.microcode_info`
      - `ProcessorIdField.step`
      - `ProcessorIdField.vendor_id`
    - `ProcessorSummary`
      - `ProcessorSummary.architecture`
      - `ProcessorSummary.count`
  - sushy.resources.system.secure_boot module
    - `ActionsField`
      - `ActionsField.reset_keys`
    - `ResetKeysActionField`
      - `ResetKeysActionField.allowed_values`
    - `SecureBoot`
      - `SecureBoot.current_boot`
      - `SecureBoot.databases`
      - `SecureBoot.description`
      - `SecureBoot.enabled`
      - `SecureBoot.get_allowed_reset_keys_values()`
      - `SecureBoot.identity`
      - `SecureBoot.mode`
      - `SecureBoot.name`
      - `SecureBoot.reset_keys()`
      - `SecureBoot.set_enabled()`
  - sushy.resources.system.secure_boot_database module
    - `ActionsField`
      - `ActionsField.reset_keys`
    - `ResetKeysActionField`
      - `ResetKeysActionField.allowed_values`
    - `SecureBootDatabase`
      - `SecureBootDatabase.database_id`
      - `SecureBootDatabase.description`
      - `SecureBootDatabase.get_allowed_reset_keys_values()`
      - `SecureBootDatabase.identity`
      - `SecureBootDatabase.name`
      - `SecureBootDatabase.reset_keys()`
    - `SecureBootDatabaseCollection`
  - sushy.resources.system.simple_storage module
    - `DeviceListField`
      - `DeviceListField.capacity_bytes`
      - `DeviceListField.name`
      - `DeviceListField.status`
    - `SimpleStorage`
      - `SimpleStorage.devices`
      - `SimpleStorage.identity`
      - `SimpleStorage.name`
    - `SimpleStorageCollection`
      - `SimpleStorageCollection.disks_sizes_bytes`
      - `SimpleStorageCollection.max_size_bytes`
  - sushy.resources.system.system module
    - `ActionsField`
      - `ActionsField.reset`
    - `BootField`
      - `BootField.allowed_values`
      - `BootField.enabled`
      - `BootField.http_boot_uri`
      - `BootField.mode`
      - `BootField.target`
    - `BootProgressField`
      - `BootProgressField.last_boot_seconds_count`
      - `BootProgressField.last_state`
      - `BootProgressField.last_state_updated_at`
      - `BootProgressField.oem_last_state`
    - `MemorySummaryField`
      - `MemorySummaryField.health`
      - `MemorySummaryField.size_gib`
    - `System`
      - `System.asset_tag`
      - `System.bios`
      - `System.bios_version`
      - `System.boot`
      - `System.boot_progress`
      - `System.chassis`
      - `System.description`
      - `System.ethernet_interfaces`
      - `System.get_allowed_reset_system_values()`
      - `System.get_allowed_system_boot_source_values()`
      - `System.hostname`
      - `System.identity`
      - `System.indicator_led`
      - `System.maintenance_window`
      - `System.managers`
      - `System.manufacturer`
      - `System.memory_summary`
      - `System.name`
      - `System.part_number`
      - `System.power_state`
      - `System.processors`
      - `System.reset_system()`
      - `System.secure_boot`
      - `System.serial_number`
      - `System.set_indicator_led()`
      - `System.set_system_boot_options()`
      - `System.set_system_boot_source()`
      - `System.simple_storage`
      - `System.sku`
      - `System.status`
      - `System.storage`
      - `System.system_type`
      - `System.uuid`
      - `System.virtual_media`
    - `SystemCollection`
  - Module contents
- sushy.resources.taskservice package
  - Submodules
  - sushy.resources.taskservice.constants module
    - `OverWritePolicy`
      - `OverWritePolicy.MANUAL`
      - `OverWritePolicy.OLDEST`
    - `TaskState`
      - `TaskState.CANCELLED`
      - `TaskState.CANCELLING`
      - `TaskState.COMPLETED`
      - `TaskState.EXCEPTION`
      - `TaskState.INTERRUPTED`
      - `TaskState.KILLED`
      - `TaskState.NEW`
      - `TaskState.PENDING`
      - `TaskState.RUNNING`
      - `TaskState.SERVICE`
      - `TaskState.STARTING`
      - `TaskState.STOPPING`
      - `TaskState.SUSPENDED`
  - sushy.resources.taskservice.task module
    - `Task`
      - `Task.description`
      - `Task.end_time`
      - `Task.identity`
      - `Task.is_processing`
      - `Task.messages`
      - `Task.name`
      - `Task.parse_messages()`
      - `Task.percent_complete`
      - `Task.start_time`
      - `Task.task_monitor`
      - `Task.task_state`
      - `Task.task_status`
    - `TaskCollection`
      - `TaskCollection.summary`
  - sushy.resources.taskservice.taskservice module
    - `TaskService`
      - `TaskService.event_on_task_state_change`
      - `TaskService.identity`
      - `TaskService.name`
      - `TaskService.overwrite_policy`
      - `TaskService.service_enabled`
      - `TaskService.status`
      - `TaskService.tasks`
  - Module contents
- sushy.resources.updateservice package
  - Submodules
  - sushy.resources.updateservice.constants module
    - `UpdateTransferProtocolType`
      - `UpdateTransferProtocolType.CIFS`
      - `UpdateTransferProtocolType.FTP`
      - `UpdateTransferProtocolType.HTTP`
      - `UpdateTransferProtocolType.HTTPS`
      - `UpdateTransferProtocolType.NFS`
      - `UpdateTransferProtocolType.NSF`
      - `UpdateTransferProtocolType.OEM`
      - `UpdateTransferProtocolType.SCP`
      - `UpdateTransferProtocolType.SFTP`
      - `UpdateTransferProtocolType.TFTP`
  - sushy.resources.updateservice.softwareinventory module
    - `SoftwareInventory`
      - `SoftwareInventory.identity`
      - `SoftwareInventory.lowest_supported_version`
      - `SoftwareInventory.manufacturer`
      - `SoftwareInventory.name`
      - `SoftwareInventory.related_item`
      - `SoftwareInventory.release_date`
      - `SoftwareInventory.software_id`
      - `SoftwareInventory.status`
      - `SoftwareInventory.uefi_device_paths`
      - `SoftwareInventory.updateable`
      - `SoftwareInventory.version`
    - `SoftwareInventoryCollection`
      - `SoftwareInventoryCollection.description`
      - `SoftwareInventoryCollection.name`
  - sushy.resources.updateservice.updateservice module
    - `ActionsField`
      - `ActionsField.simple_update`
    - `UpdateService`
      - `UpdateService.firmware_inventory`
      - `UpdateService.get_allowed_transfer_protocols()`
      - `UpdateService.get_task_monitor()`
      - `UpdateService.http_push_uri`
      - `UpdateService.http_push_uri_targets`
      - `UpdateService.http_push_uri_targets_busy`
      - `UpdateService.identity`
      - `UpdateService.name`
      - `UpdateService.service_enabled`
      - `UpdateService.simple_update()`
      - `UpdateService.software_inventory`
      - `UpdateService.status`
  - Module contents

## Submodules

## sushy.resources.base module

class sushy.resources.base.AbstractDataReader

  Bases: `object`

  abstract get_data()

    Based on data source get data and parse to JSON

  set_connection(connector, path)

    Sets mandatory connection parameters

    Parameters:

      - connector – A Connector instance

      - path – path of the resource

class sushy.resources.base.CompositeField(*args, **kwargs)

  Bases: `Mapping`, `Field`

  Base class for fields consisting of several sub-fields.

class sushy.resources.base.DictionaryField(*args, **kwargs)

  Bases: `Field`

  Base class for fields consisting of dictionary of several sub-fields.

class sushy.resources.base.Field(path, required=False, default=None, adapter=<function Field.<lambda>>)

  Bases: `object`

  Definition for fields fetched from JSON.

class sushy.resources.base.FieldData(status_code, headers, json_doc)

  Bases: `object`

  Contains data to be used when constructing Fields

  property headers

    The headers

  property json_doc

    The parsed JSON body

  property status_code

    The status code

class sushy.resources.base.JsonArchiveReader(archive_file)

  Bases: `AbstractDataReader`

  Gets the data from JSON file in archive

  get_data()

    Gets JSON file from archive. Currently supporting ZIP only

class sushy.resources.base.JsonDataReader

  Bases: `AbstractDataReader`

  Gets the data from HTTP response given by path

  get_data()

    Gets JSON file from URI directly

class sushy.resources.base.JsonPackagedFileReader(resource_package_name)

  Bases: `AbstractDataReader`

  Gets the data from packaged file given by path

  get_data()

    Gets JSON file from packaged file denoted by path

class sushy.resources.base.JsonPublicFileReader

  Bases: `AbstractDataReader`

  Loads the data from the Internet

  get_data()

    Get JSON file from full URI

class sushy.resources.base.LinksField(*args, **kwargs)

  Bases: `CompositeField`

  Reference to linked resources.

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

class sushy.resources.base.ListField(*args, **kwargs)

  Bases: `Field`

  Base class for fields consisting of a list of several sub-fields.

class sushy.resources.base.MappedField(field, mapping, required=False, default=None)

  Bases: `Field`

  Field taking real value from a mapping.

class sushy.resources.base.MappedListField(field, mapping, required=False, default=None)

  Bases: `Field`

  Field taking a list of values with a mapping for the values

  Given JSON {‘field’:[‘xxx’, ‘yyy’]}, a sushy resource definition and mapping {‘xxx’:’a’, ‘yyy’:’b’}, the sushy object to come out will be like resource.field = [‘a’, ‘b’]

class sushy.resources.base.MessageListField(*args, **kwargs)

  Bases: `ListField`

  List of messages with details of settings update status

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

    Human readable message, if provided

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

    List of message substitution arguments for the message referenced by message_id from the message registry

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

    The key for this message which can be used to look up the message in a message registry

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

    Used to provide suggestions on how to resolve the situation that caused the error

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

    Severity of the error

class sushy.resources.base.MutableResourceCollectionBase(connector, path, redfish_version=None, registries=None, root=None)

  Bases: `ResourceCollectionBase`

  delete_member(identity)

    Delete the given member of the collection.

class sushy.resources.base.ResourceBase(connector, path='', redfish_version=None, registries=None, reader=None, json_doc=None, root=None)

  Bases: `object`

  clone_resource(new_resource, path='')

    Instantiate given resource using existing BMC connection context

  get_oem_extension(vendor)

    Get the OEM extension instance for this resource by OEM vendor

    Parameters:

      vendor – the OEM vendor string which is the vendor-specific extensibility identifier. Examples are ‘Contoso’, ‘Hpe’. Possible value can be got from `oem_vendors` attribute.

    Returns:

      the Redfish resource OEM extension instance.

    Raises:

      OEMExtensionNotFoundError

  invalidate(force_refresh=False)

    Mark the resource as stale, prompting refresh() before getting used.

    If `force_refresh` is set to True, then it invokes `refresh()` on the resource.

    Parameters:

      force_refresh – will invoke refresh on the resource, if set to True.

    Raises:

      ResourceNotFoundError

    Raises:

      ConnectionError

    Raises:

      HTTPError

  property json
  links = <sushy.resources.base.LinksField object>
  property oem_vendors
  property path
  redfish_version = None

    The Redfish version

  refresh(force=True, json_doc=None)

    Refresh the resource

    Freshly retrieves/fetches the resource attributes and invokes `_parse_attributes()` method on successful retrieval. It is recommended not to override this method in concrete ResourceBase classes. Resource classes can place their refresh specific operations in `_do_refresh()` method, if needed. This method represents the template method in the paradigm of Template design pattern.

    Parameters:

      - force – if set to False, will only refresh if the resource is marked as stale, otherwise neither it nor its subresources will be refreshed.

      - json_doc – parsed JSON document in form of Python types.

    Raises:

      ResourceNotFoundError

    Raises:

      ConnectionError

    Raises:

      HTTPError

  property registries
  property resource_name
  property root

class sushy.resources.base.ResourceCollectionBase(connector, path, redfish_version=None, registries=None, root=None)

  Bases: `ResourceLinksBase`

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

    A tuple with the members identities

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

    The name of the collection

class sushy.resources.base.ResourceLinksBase(connector, path, redfish_version=None, registries=None, root=None)

  Bases: `ResourceBase`

  get_member(identity)

    Given the identity return a `_resource_type` object

    Parameters:

      identity – The identity of the `_resource_type`

    Returns:

      The `_resource_type` object

    Raises:

      ResourceNotFoundError

  get_members()

    Return a list of `_resource_type` objects present in collection

    Returns:

      A list of `_resource_type` objects

  abstract property members_identities

    A sequence with members identities

sushy.resources.base.get_reader(connector, path, reader=None)

  Create and configure the reader.

  Parameters:

    - connector – A Connector instance

    - path – sub-URI path to the resource.

    - reader – Reader to use to fetch JSON data.

  Returns:

    the reader

## sushy.resources.common module

class sushy.resources.common.ActionField(*args, **kwargs)

  Bases: `CompositeField`

  operation_apply_time_support = <sushy.resources.common.OperationApplyTimeSupportField object>
  target_uri = <sushy.resources.base.Field object>

class sushy.resources.common.IdRefField(*args, **kwargs)

  Bases: `CompositeField`

  Reference to the resource odata identity field.

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

    The unique identifier for a resource

class sushy.resources.common.IdentifiersListField(*args, **kwargs)

  Bases: `ListField`

  This type describes any additional identifiers for a resource.

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

    This indicates the world wide, persistent name of the resource.

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

    This represents the format of the DurableName property.

class sushy.resources.common.InitializeActionField(*args, **kwargs)

  Bases: `ActionField`

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

class sushy.resources.common.OperationApplyTimeSupportField

  Bases: `CompositeField`

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

    The expiry time of maintenance window in seconds

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

    The start time of a maintenance window

  mapped_supported_values = <sushy.resources.base.MappedListField object>

    The types of apply times that the client is allowed request when performing a create, delete, or action operation returned as a mapped list

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

    The types of apply times that the client is allowed request when performing a create, delete, or action operation returned as an unmapped list

    Deprecated: Use mapped_supported_values.

class sushy.resources.common.ResetActionField(*args, **kwargs)

  Bases: `ActionField`

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

class sushy.resources.common.StatusField(*args, **kwargs)

  Bases: `CompositeField`

  This Field describes the status of a resource and its children.

  This field shall contain any state or health properties of a resource.

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

    Represents health of resource w/o considering its dependent resources

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

    Represents health state of resource and its dependent resources

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

    Indicates the known state of the resource, such as if it is enabled.

## sushy.resources.constants module

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

  Bases: `Enum`

  Apply time constants

  AT_MAINTENANCE_WINDOW_START = 'AtMaintenanceWindowStart'

    Apply during a maintenance window as specified by an administrator.

  IMMEDIATE = 'Immediate'

    Apply immediately.

  IN_MAINTENANCE_WINDOW_ON_RESET = 'InMaintenanceWindowOnReset'

    Apply after a reset but within maintenance window as specified by an administrator.

  ON_RESET = 'OnReset'

    Apply on a reset.

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

  Bases: `Enum`

  Durable name format constants

  EUI = 'EUI'

    The IEEE-defined 64-bit Extended Unique Identifier (EUI).

  FC_WWN = 'FC_WWN'

    The Fibre Channel (FC) World Wide Name (WWN).

  NAA = 'NAA'

    The Name Address Authority (NAA) format.

  NGUID = 'NGUID'

    The Namespace Globally Unique Identifier (NGUID).

  NQN = 'NQN'

    The NVMe Qualified Name (NQN).

  NSID = 'NSID'

    The NVM Namespace Identifier (NSID).

  UUID = 'UUID'

    The Universally Unique Identifier (UUID).

  iQN = 'iQN'

    The iSCSI Qualified Name (iQN).

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

  Bases: `Enum`

  Health related constants.

  CRITICAL = 'Critical'

    A critical condition requires immediate attention.

  OK = 'OK'

    Normal.

  WARNING = 'Warning'

    A condition requires attention.

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

  Bases: `Enum`

  Indicator LED Constants

  BLINKING = 'Blinking'

    The Indicator LED is blinking

  LIT = 'Lit'

    The Indicator LED is lit

  OFF = 'Off'

    The Indicator LED is off

  UNKNOWN = 'Unknown'

    The state of the Indicator LED cannot be determine

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

  Bases: `Enum`

  System PowerState constants

  OFF = 'Off'

    The resource is powered off, although some components may continue to have AUX power such as management controller

  ON = 'On'

    The resource is powered on

  PAUSED = 'Paused'

    The resource is paused.

  POWERING_OFF = 'PoweringOff'

    A temporary state between On and Off. The power off action can take time while the OS is in the shutdown process

  POWERING_ON = 'PoweringOn'

    A temporary state between Off and On. This temporary state can be very short

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

  Bases: `Enum`

  Protocol type constants

  AHCI = 'AHCI'

    Advanced Host Controller Interface (AHCI).

  DISPLAY_PORT = 'DisplayPort'

    DisplayPort.

  DVI = 'DVI'
  ETHERNET = 'Ethernet'

    Ethernet.

  FC = 'FC'

    Fibre Channel.

  FCP = 'FCP'

    Fibre Channel Protocol for SCSI.

  FCoE = 'FCoE'

    Fibre Channel over Ethernet (FCoE).

  FICON = 'FICON'

    FIbre CONnection (FICON).

  FTP = 'FTP'

    File Transfer Protocol (FTP).

  GEN_Z = 'GenZ'

    GenZ.

  HDMI = 'HDMI'

    HDMI.

  HTTP = 'HTTP'

    Hypertext Transport Protocol (HTTP).

  HTTPS = 'HTTPS'

    Hypertext Transfer Protocol Secure (HTTPS).

  I2C = 'I2C'

    Inter-Integrated Circuit Bus.

  INFINI_BAND = 'InfiniBand'

    InfiniBand.

  MULTI_PROTOCOL = 'MultiProtocol'

    Multiple Protocols.

  NFSv3 = 'NFSv3'

    Network File System (NFS) version 3.

  NFSv4 = 'NFSv4'

    Network File System (NFS) version 4.

  NVLINK = 'NVLink'

    NVLink.

  NVMe = 'NVMe'

    Non-Volatile Memory Express (NVMe).

  NVMe_OVER_FABRICS = 'NVMeOverFabrics'

    NVMe over Fabrics.

  OEM = 'OEM'

    OEM-specific.

  PCIe = 'PCIe'

    PCI Express.

  RoCE = 'RoCE'

    RDMA over Converged Ethernet Protocol.

  RoCEv2 = 'RoCEv2'

    RDMA over Converged Ethernet Protocol Version 2.

  SAS = 'SAS'

    Serial Attached SCSI.

  SATA = 'SATA'

    Serial AT Attachment.

  SFTP = 'SFTP'

    SSH File Transfer Protocol (SFTP).

  SMB = 'SMB'

    Server Message Block (SMB). Also known as the Common Internet File System (CIFS).

  TCP = 'TCP'

    Transmission Control Protocol (TCP).

  TFTP = 'TFTP'

    Trivial File Transfer Protocol (TFTP).

  UDP = 'UDP'

    User Datagram Protocol (UDP).

  UHCI = 'UHCI'

    Universal Host Controller Interface (UHCI).

  USB = 'USB'

    Universal Serial Bus (USB).

  VGA = 'VGA'

    VGA.

  iSCSI = 'iSCSI'

    Internet SCSI.

  iWARP = 'iWARP'

    Internet Wide Area RDMA Protocol (iWARP).

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

  Bases: `Enum`

  Reset action constants

  FORCE_OFF = 'ForceOff'

    Turn off the unit immediately (non-graceful shutdown).

  FORCE_ON = 'ForceOn'

    Turn on the unit immediately.

  FORCE_RESTART = 'ForceRestart'

    Shut down immediately and non-gracefully and restart the system.

  GRACEFUL_RESTART = 'GracefulRestart'

    Shut down gracefully and restart the system.

  GRACEFUL_SHUTDOWN = 'GracefulShutdown'

    Shut down gracefully and power off.

  NMI = 'Nmi'

    Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal operations, complete diagnostic actions, and, typically, halt the system.

  ON = 'On'

    Turn on the unit.

  PAUSE = 'Pause'

    Pause execution on the unit but do not remove power. This is typically a feature of virtual machine hypervisors.

  POWER_CYCLE = 'PowerCycle'

    Power cycle the unit. Behaves like a full power removal, followed by a power restore to the resource.

  PUSH_POWER_BUTTON = 'PushPowerButton'

    Simulate the pressing of the physical power button on this unit.

  RESUME = 'Resume'

    Resume execution on the paused unit. This is typically a feature of virtual machine hypervisors.

  SUSPEND = 'Suspend'

    Write the state of the unit to disk before powering off. This allows for the state to be restored when powered back on.

sushy.resources.constants.Severity

  alias of `Health`

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

  Bases: `Enum`

  State related constants.

  ABSENT = 'Absent'

    This function or resource is either not present or detected.

  DEFERRING = 'Deferring'

    The element does not process any commands but queues new requests.

  DISABLED = 'Disabled'

    This function or resource is disabled.

  ENABLED = 'Enabled'

    This function or resource is enabled.

  IN_TEST = 'InTest'

    This function or resource is undergoing testing, or is in the process of capturing information for debugging.

  QUALIFIED = 'Qualified'

    The element quality is within the acceptable range of operation.

  QUIESCED = 'Quiesced'

    The element is enabled but only processes a restricted set of commands.

  STANDBY_OFFLINE = 'StandbyOffline'

    This function or resource is enabled but awaits an external action to activate it.

  STANDBY_SPARE = 'StandbySpare'

    This function or resource is part of a redundancy set and awaits a failover or other external action to activate it.

  STARTING = 'Starting'

    This function or resource is starting.

  UNAVAILABLE_OFFLINE = 'UnavailableOffline'

    This function or resource is present but cannot be used.

  UPDATING = 'Updating'

    The element is updating and might be unavailable or degraded.

## sushy.resources.ipaddresses module

class sushy.resources.ipaddresses.AddressState(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)

  Bases: `Enum`

  DEPRECATED = 'Deprecated'

    This address is currently within its valid lifetime but is now outside its RFC4862-defined preferred lifetime.

  FAILED = 'Failed'

    This address has failed Duplicate Address Detection (DAD) testing, as defined in RFC4862, section 5.4, and is not currently in use.

  PREFERRED = 'Preferred'

    This address is currently within both its RFC4862-defined valid and preferred lifetimes.

  TENTATIVE = 'Tentative'

    This address is currently undergoing Duplicate Address Detection (DAD) testing, as defined in RFC4862, section 5.4.

class sushy.resources.ipaddresses.IPv4AddressOrigin(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)

  Bases: `Enum`

  BOOTP = 'BOOTP'

    A BOOTP service-provided address.

  DHCP = 'DHCP'

    A DHCPv4 service-provided address.

  LINK_LOCAL = 'IPv4LinkLocal'

    The address is valid for only this network segment, or link.

  STATIC = 'Static'

    A user-configured static address.

class sushy.resources.ipaddresses.IPv6AddressOrigin(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)

  Bases: `Enum`

  DHCP = 'DHCPv6'

    A DHCPv6 service-provided address.

  LINK_LOCAL = 'LinkLocal'

    The address is valid for only this network segment, or link.

  SLAAC = 'SLAAC'

    A stateless autoconfiguration (SLAAC) service-provided address.

  STATIC = 'Static'

    A static user-configured address.

## sushy.resources.settings module

class sushy.resources.settings.MaintenanceWindowField(*args, **kwargs)

  Bases: `CompositeField`

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

    The expiry time of maintenance window in seconds

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

    The start time of a maintenance window

sushy.resources.settings.NO_UPDATES = 4

  No updates made

class sushy.resources.settings.SettingsApplyTimeField

  Bases: `CompositeField`

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

    When the future configuration should be applied

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

    The list of allowable ApplyTime values

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

    The expiry time of maintenance window in seconds

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

    The start time of a maintenance window

class sushy.resources.settings.SettingsField

  Bases: `CompositeField`

  The settings of a resource

  Represents the future state and configuration of the resource. The field is added to resources that support future state and configuration.

  This field includes several properties to help clients monitor when the resource is consumed by the service and determine the results of applying the values, which may or may not have been successful.

  commit(connector, value)

    Commits new settings values

    The new values will be applied when the system or a service restarts.

    Parameters:

      - connector – A Connector instance

      - value – Value representing JSON whose structure is specific to each resource and the caller must format it correctly

    Returns:

      Response object

  get_status(registries)

    Determines the status of last update based

    Uses message id-s and severity to determine the status.

    Parameters:

      registries – registries to use to parse message

    Returns:

      `SettingsUpdate` object containing status and any messages

  property maintenance_window

    MaintenanceWindow field

    Indicates if a given resource has a maintenance window assignment for applying settings or operations

  messages = <sushy.resources.base.MessageListField object>

    Represents the results of the last time the values of the Settings resource were applied to the server

  property operation_apply_time_support

    OperationApplyTimeSupport field

    Indicates if a client is allowed to request for a specific apply time of a create, delete, or action operation of a given resource

  property resource_uri
  time = <sushy.resources.base.Field object>

    Indicates the time the settings were applied to the server

class sushy.resources.settings.SettingsUpdate(status, messages)

  Bases: `object`

  Contains Settings update status and details of the update

  property messages

    List of `MessageListField` with messages from the update

  property status

    The status of the update

sushy.resources.settings.UPDATE_FAILURE = 2

  Update encountered errors

sushy.resources.settings.UPDATE_PENDING = 3

  Update waiting for being applied

sushy.resources.settings.UPDATE_SUCCESS = 1

  Update was successful

sushy.resources.settings.UPDATE_UNKNOWN = 0

  Update status unknown

## 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