zhmcclient
  • 1. Introduction
    • 1.1. What this package provides
      • 1.1.1. zhmc CLI
    • 1.2. Supported environments
    • 1.3. Installation
      • 1.3.1. Installation of latest released version
      • 1.3.2. Installation of latest development version
      • 1.3.3. Installation on a system without Internet access
      • 1.3.4. Alternative installation methods and sources
      • 1.3.5. Verification of the installation
      • 1.3.6. Considerations for Windows
    • 1.4. Setting up the HMC
    • 1.5. Setting up firewalls or proxies
    • 1.6. Examples
    • 1.7. HMC/SE version requirements
    • 1.8. Package Versioning
      • __version__
    • 1.9. Compatibility
    • 1.10. Deprecations
    • 1.11. Reporting issues
    • 1.12. License
  • 2. Tutorials
    • 2.1. Executing code in the tutorials
  • 3. Concepts
    • 3.1. Topology
    • 3.2. Multi-threading considerations
    • 3.3. Specifying multiple redundant HMCs
    • 3.4. Resource model concepts
    • 3.5. Error handling
    • 3.6. Filtering
    • 3.7. Auto-updating
    • 3.8. Feature enablement
      • 3.8.1. Firmware features
      • 3.8.2. API features
  • 4. Reference: General features
    • 4.1. Session
      • Session
        • Session.__repr__()
        • Session.host
        • Session.actual_host
        • Session.port
        • Session.userid
        • Session.verify_cert
        • Session.get_password
        • Session.retry_timeout_config
        • Session.base_url
        • Session.headers
        • Session.time_stats_keeper
        • Session.session_id
        • Session.session_credential
        • Session.session
        • Session.object_topic
        • Session.job_topic
        • Session.auto_updater
        • Session.logon()
        • Session.logoff()
        • Session.is_logon()
        • Session.get()
        • Session.post()
        • Session.delete()
        • Session.get_notification_topics()
        • Session.auto_update_subscribed()
        • Session.subscribe_auto_update()
        • Session.unsubscribe_auto_update()
      • Job
        • Job.session
        • Job.uri
        • Job.op_method
        • Job.op_uri
        • Job.query_status()
        • Job.delete()
        • Job.check_for_completion()
        • Job.wait_for_completion()
        • Job.cancel()
      • get_password_interface()
    • 4.2. Retry / timeout configuration
      • RetryTimeoutConfig
        • RetryTimeoutConfig.override_with()
    • 4.3. AutoUpdater
      • AutoUpdater
        • AutoUpdater.open()
        • AutoUpdater.close()
        • AutoUpdater.is_open()
        • AutoUpdater.register_object()
        • AutoUpdater.unregister_object()
        • AutoUpdater.registered_objects()
        • AutoUpdater.has_objects()
    • 4.4. Client
      • Client
        • Client.session
        • Client.cpcs
        • Client.consoles
        • Client.metrics_contexts
        • Client.version_info()
        • Client.query_api_version()
        • Client.get_inventory()
        • Client.wait_for_available()
        • Client.to_hmc_yaml()
        • Client.to_hmc_dict()
        • Client.dump()
    • 4.5. Time Statistics
      • TimeStatsKeeper
        • TimeStatsKeeper.enabled
        • TimeStatsKeeper.enable()
        • TimeStatsKeeper.disable()
        • TimeStatsKeeper.get_stats()
        • TimeStatsKeeper.snapshot()
        • TimeStatsKeeper.__str__()
      • TimeStats
        • TimeStats.name
        • TimeStats.keeper
        • TimeStats.count
        • TimeStats.avg_time
        • TimeStats.min_time
        • TimeStats.max_time
        • TimeStats.reset()
        • TimeStats.begin()
        • TimeStats.end()
        • TimeStats.__str__()
    • 4.6. Metrics
      • MetricsContextManager
        • MetricsContextManager.__repr__()
        • MetricsContextManager.client
        • MetricsContextManager.list()
        • MetricsContextManager.create()
      • MetricsContext
        • MetricsContext.metric_group_definitions
        • MetricsContext.get_metrics()
        • MetricsContext.delete()
      • MetricGroupDefinition
        • MetricGroupDefinition.__new__()
      • MetricDefinition
        • MetricDefinition.__new__()
      • MetricsResponse
        • MetricsResponse.metrics_context
        • MetricsResponse.metric_group_values
      • MetricGroupValues
        • MetricGroupValues.name
        • MetricGroupValues.object_values
      • MetricObjectValues
        • MetricObjectValues.client
        • MetricObjectValues.metric_group_definition
        • MetricObjectValues.resource_uri
        • MetricObjectValues.timestamp
        • MetricObjectValues.metrics
        • MetricObjectValues.resource
        • MetricObjectValues.dump()
    • 4.7. Logging
    • 4.8. Exceptions
      • Error
        • Error.str_def()
      • ConnectionError
        • ConnectionError.details
        • ConnectionError.__repr__()
        • ConnectionError.str_def()
      • ConnectTimeout
        • ConnectTimeout.connect_timeout
        • ConnectTimeout.connect_retries
        • ConnectTimeout.__repr__()
        • ConnectTimeout.str_def()
      • ReadTimeout
        • ReadTimeout.read_timeout
        • ReadTimeout.read_retries
        • ReadTimeout.__repr__()
        • ReadTimeout.str_def()
      • RetriesExceeded
        • RetriesExceeded.connect_retries
        • RetriesExceeded.__repr__()
        • RetriesExceeded.str_def()
      • AuthError
      • ClientAuthError
        • ClientAuthError.__repr__()
        • ClientAuthError.str_def()
      • ServerAuthError
        • ServerAuthError.details
        • ServerAuthError.__repr__()
        • ServerAuthError.str_def()
      • ParseError
        • ParseError.line
        • ParseError.column
        • ParseError.__repr__()
        • ParseError.str_def()
      • VersionError
        • VersionError.min_api_version
        • VersionError.api_version
        • VersionError.__repr__()
        • VersionError.str_def()
      • HTTPError
        • HTTPError.http_status
        • HTTPError.reason
        • HTTPError.message
        • HTTPError.request_method
        • HTTPError.request_uri
        • HTTPError.request_query_parms
        • HTTPError.request_headers
        • HTTPError.request_authenticated_as
        • HTTPError.request_body
        • HTTPError.request_body_as_string
        • HTTPError.request_body_as_string_partial
        • HTTPError.stack
        • HTTPError.error_details
        • HTTPError.__str__()
        • HTTPError.__repr__()
        • HTTPError.str_def()
      • OperationTimeout
        • OperationTimeout.operation_timeout
        • OperationTimeout.__repr__()
        • OperationTimeout.str_def()
      • StatusTimeout
        • StatusTimeout.actual_status
        • StatusTimeout.desired_statuses
        • StatusTimeout.status_timeout
        • StatusTimeout.__repr__()
        • StatusTimeout.str_def()
      • NotFound
        • NotFound.filter_args
        • NotFound.manager
        • NotFound.__repr__()
        • NotFound.str_def()
      • NoUniqueMatch
        • NoUniqueMatch.filter_args
        • NoUniqueMatch.manager
        • NoUniqueMatch.resources
        • NoUniqueMatch.resource_uris
        • NoUniqueMatch.__repr__()
        • NoUniqueMatch.str_def()
      • CeasedExistence
        • CeasedExistence.resource_uri
        • CeasedExistence.__repr__()
        • CeasedExistence.str_def()
      • OSConsoleError
        • OSConsoleError.__repr__()
        • OSConsoleError.str_def()
      • OSConsoleConnectedError
      • OSConsoleNotConnectedError
      • OSConsoleWebSocketError
      • OSConsoleAuthError
    • 4.9. Constants
      • DEFAULT_CONNECT_TIMEOUT
      • DEFAULT_CONNECT_RETRIES
      • DEFAULT_HMC_PORT
      • DEFAULT_READ_TIMEOUT
      • DEFAULT_READ_RETRIES
      • DEFAULT_STOMP_PORT
      • DEFAULT_MAX_REDIRECTS
      • DEFAULT_OPERATION_TIMEOUT
      • DEFAULT_STATUS_TIMEOUT
      • DEFAULT_NAME_URI_CACHE_TIMETOLIVE
      • DEFAULT_STOMP_CONNECT_TIMEOUT
      • DEFAULT_STOMP_CONNECT_RETRIES
      • DEFAULT_STOMP_RECONNECT_SLEEP_INITIAL
      • DEFAULT_STOMP_RECONNECT_SLEEP_INCREASE
      • DEFAULT_STOMP_RECONNECT_SLEEP_MAX
      • DEFAULT_STOMP_RECONNECT_SLEEP_JITTER
      • DEFAULT_STOMP_KEEPALIVE
      • DEFAULT_STOMP_HEARTBEAT_SEND_CYCLE
      • DEFAULT_STOMP_HEARTBEAT_RECEIVE_CYCLE
      • DEFAULT_STOMP_HEARTBEAT_RECEIVE_CHECK
      • HMC_LOGGER_NAME
      • JMS_LOGGER_NAME
      • API_LOGGER_NAME
      • OS_LOGGER_NAME
      • HTML_REASON_WEB_SERVICES_DISABLED
      • HTML_REASON_OTHER
      • STOMP_MIN_CONNECTION_CHECK_TIME
      • DEFAULT_WS_TIMEOUT
      • BLANKED_OUT_STRING
    • 4.10. Utilities
      • datetime_from_timestamp()
      • timestamp_from_datetime()
    • 4.11. Using WebSocket to access OS console
    • 4.12. OSConsole
      • OSConsole
        • OSConsole.is_connected()
        • OSConsole.connect()
        • OSConsole.disconnect()
        • OSConsole.recv_all()
        • OSConsole.recv_line()
        • OSConsole.send()
        • OSConsole.login_linux()
        • OSConsole.execute_command()
  • 5. Reference: Resources
    • 5.1. CPCs
      • CpcManager
        • CpcManager.client
        • CpcManager.console
        • CpcManager.list()
      • Cpc
        • Cpc.lpars
        • Cpc.partitions
        • Cpc.adapters
        • Cpc.virtual_switches
        • Cpc.capacity_groups
        • Cpc.vswitches
        • Cpc.reset_activation_profiles
        • Cpc.image_activation_profiles
        • Cpc.load_activation_profiles
        • Cpc.hw_messages
        • Cpc.dpm_enabled
        • Cpc.maximum_active_partitions
        • Cpc.dump()
        • Cpc.list_api_features()
        • Cpc.api_feature_enabled()
        • Cpc.list_firmware_features()
        • Cpc.firmware_feature_enabled()
        • Cpc.feature_enabled()
        • Cpc.feature_info()
        • Cpc.update_properties()
        • Cpc.start()
        • Cpc.stop()
        • Cpc.activate()
        • Cpc.deactivate()
        • Cpc.import_profiles()
        • Cpc.export_profiles()
        • Cpc.get_wwpns()
        • Cpc.get_free_crypto_domains()
        • Cpc.set_power_save()
        • Cpc.set_power_capping()
        • Cpc.get_energy_management_properties()
        • Cpc.list_associated_storage_groups()
        • Cpc.validate_lun_path()
        • Cpc.add_temporary_capacity()
        • Cpc.remove_temporary_capacity()
        • Cpc.set_auto_start_list()
        • Cpc.import_dpm_configuration()
        • Cpc.export_dpm_configuration()
        • Cpc.single_step_install()
        • Cpc.install_and_activate()
        • Cpc.delete_retrieved_internal_code()
        • Cpc.swap_current_time_server()
        • Cpc.set_stp_config()
        • Cpc.change_stp_id()
        • Cpc.join_ctn()
        • Cpc.leave_ctn()
        • Cpc.get_sustainability_data()
      • STPNode
        • STPNode.json()
    • 5.2. Unmanaged CPCs
      • UnmanagedCpcManager
        • UnmanagedCpcManager.console
        • UnmanagedCpcManager.list()
      • UnmanagedCpc
    • 5.3. Groups
      • GroupManager
        • GroupManager.console
        • GroupManager.list()
        • GroupManager.create()
      • Group
        • Group.dump()
        • Group.delete()
        • Group.add_member()
        • Group.remove_member()
        • Group.list_members()
    • 5.4. Activation profiles
      • ActivationProfileManager
        • ActivationProfileManager.cpc
        • ActivationProfileManager.profile_type
        • ActivationProfileManager.list()
        • ActivationProfileManager.create()
      • ActivationProfile
        • ActivationProfile.delete()
        • ActivationProfile.update_properties()
        • ActivationProfile.assign_certificate()
        • ActivationProfile.unassign_certificate()
    • 5.5. LPARs
      • LparManager
        • LparManager.cpc
        • LparManager.list()
      • Lpar
        • Lpar.update_properties()
        • Lpar.activate()
        • Lpar.deactivate()
        • Lpar.scsi_load()
        • Lpar.scsi_dump()
        • Lpar.nvme_load()
        • Lpar.nvme_dump()
        • Lpar.load()
        • Lpar.load_from_ftp()
        • Lpar.stop()
        • Lpar.start()
        • Lpar.reset_clear()
        • Lpar.reset_normal()
        • Lpar.open_os_message_channel()
        • Lpar.send_os_command()
        • Lpar.list_os_messages()
        • Lpar.psw_restart()
        • Lpar.wait_for_status()
        • Lpar.assign_certificate()
        • Lpar.unassign_certificate()
        • Lpar.get_sustainability_data()
    • 5.6. Partitions
      • PartitionManager
        • PartitionManager.cpc
        • PartitionManager.list()
        • PartitionManager.create()
      • Partition
        • Partition.nics
        • Partition.hbas
        • Partition.virtual_functions
        • Partition.list_firmware_features()
        • Partition.firmware_feature_enabled()
        • Partition.feature_enabled()
        • Partition.feature_info()
        • Partition.start()
        • Partition.stop()
        • Partition.delete()
        • Partition.update_properties()
        • Partition.dump_partition()
        • Partition.start_dump_program()
        • Partition.psw_restart()
        • Partition.mount_iso_image()
        • Partition.unmount_iso_image()
        • Partition.open_os_message_channel()
        • Partition.send_os_command()
        • Partition.list_os_messages()
        • Partition.create_os_websocket()
        • Partition.wait_for_status()
        • Partition.increase_crypto_config()
        • Partition.decrease_crypto_config()
        • Partition.change_crypto_domain_config()
        • Partition.zeroize_crypto_domain()
        • Partition.attach_storage_group()
        • Partition.detach_storage_group()
        • Partition.list_attached_storage_groups()
        • Partition.attach_network_link()
        • Partition.detach_network_link()
        • Partition.attach_ctc_link()
        • Partition.detach_ctc_link()
        • Partition.list_attached_partition_links()
        • Partition.assign_certificate()
        • Partition.unassign_certificate()
        • Partition.dump()
        • Partition.get_sustainability_data()
    • 5.7. Adapters
      • AdapterManager
        • AdapterManager.cpc
        • AdapterManager.list()
        • AdapterManager.create_hipersocket()
      • Adapter
        • Adapter.ports
        • Adapter.port_uris_prop
        • Adapter.port_uri_segment
        • Adapter.maximum_crypto_domains
        • Adapter.delete()
        • Adapter.update_properties()
        • Adapter.__repr__()
        • Adapter.change_crypto_type()
        • Adapter.change_adapter_type()
        • Adapter.dump()
        • Adapter.list_assigned_partitions()
        • Adapter.list_sibling_adapters()
    • 5.8. Ports
      • PortManager
        • PortManager.adapter
        • PortManager.port_type
        • PortManager.list()
      • Port
        • Port.update_properties()
        • Port.dump()
    • 5.9. NICs
      • NicManager
        • NicManager.partition
        • NicManager.list()
        • NicManager.create()
      • Nic
        • Nic.delete()
        • Nic.update_properties()
        • Nic.backing_port()
    • 5.10. HBAs
      • HbaManager
        • HbaManager.partition
        • HbaManager.list()
        • HbaManager.create()
      • Hba
        • Hba.delete()
        • Hba.update_properties()
        • Hba.reassign_port()
    • 5.11. Virtual Functions
      • VirtualFunctionManager
        • VirtualFunctionManager.partition
        • VirtualFunctionManager.list()
        • VirtualFunctionManager.create()
      • VirtualFunction
        • VirtualFunction.delete()
        • VirtualFunction.update_properties()
    • 5.12. Virtual Switches
      • VirtualSwitchManager
        • VirtualSwitchManager.cpc
        • VirtualSwitchManager.list()
      • VirtualSwitch
        • VirtualSwitch.get_connected_nics()
        • VirtualSwitch.update_properties()
    • 5.13. Storage Groups
      • StorageGroupManager
        • StorageGroupManager.console
        • StorageGroupManager.list()
        • StorageGroupManager.create()
      • StorageGroup
        • StorageGroup.storage_volumes
        • StorageGroup.virtual_storage_resources
        • StorageGroup.cpc
        • StorageGroup.list_attached_partitions()
        • StorageGroup.delete()
        • StorageGroup.update_properties()
        • StorageGroup.add_candidate_adapter_ports()
        • StorageGroup.remove_candidate_adapter_ports()
        • StorageGroup.list_candidate_adapter_ports()
        • StorageGroup.discover_fcp()
        • StorageGroup.get_connection_report()
        • StorageGroup.dump()
    • 5.14. Storage Volumes
      • StorageVolumeManager
        • StorageVolumeManager.storage_group
        • StorageVolumeManager.list()
        • StorageVolumeManager.create()
      • StorageVolume
        • StorageVolume.oid
        • StorageVolume.delete()
        • StorageVolume.update_properties()
        • StorageVolume.indicate_fulfillment_ficon()
        • StorageVolume.indicate_fulfillment_fcp()
    • 5.15. Virtual Storage Resources
      • VirtualStorageResourceManager
        • VirtualStorageResourceManager.storage_group
        • VirtualStorageResourceManager.list()
      • VirtualStorageResource
        • VirtualStorageResource.attached_partition
        • VirtualStorageResource.adapter_port
        • VirtualStorageResource.update_properties()
    • 5.16. Storage Group Templates
      • StorageGroupTemplateManager
        • StorageGroupTemplateManager.console
        • StorageGroupTemplateManager.list()
        • StorageGroupTemplateManager.create()
      • StorageGroupTemplate
        • StorageGroupTemplate.storage_volume_templates
        • StorageGroupTemplate.cpc
        • StorageGroupTemplate.delete()
        • StorageGroupTemplate.update_properties()
    • 5.17. Storage Volume Templates
      • StorageVolumeTemplateManager
        • StorageVolumeTemplateManager.storage_group_template
        • StorageVolumeTemplateManager.list()
        • StorageVolumeTemplateManager.create()
      • StorageVolumeTemplate
        • StorageVolumeTemplate.delete()
        • StorageVolumeTemplate.update_properties()
    • 5.18. Partition Links
      • PartitionLinkManager
        • PartitionLinkManager.console
        • PartitionLinkManager.list()
        • PartitionLinkManager.create()
      • PartitionLink
        • PartitionLink.cpc
        • PartitionLink.list_attached_partitions()
        • PartitionLink.wait_for_states()
        • PartitionLink.delete()
        • PartitionLink.update_properties()
        • PartitionLink.dump()
    • 5.19. Capacity Groups
      • CapacityGroupManager
        • CapacityGroupManager.cpc
        • CapacityGroupManager.list()
        • CapacityGroupManager.create()
      • CapacityGroup
        • CapacityGroup.delete()
        • CapacityGroup.update_properties()
        • CapacityGroup.add_partition()
        • CapacityGroup.remove_partition()
    • 5.20. Console
      • ConsoleManager
        • ConsoleManager.client
        • ConsoleManager.console
        • ConsoleManager.list()
      • Console
        • Console.storage_groups
        • Console.storage_group_templates
        • Console.partition_links
        • Console.users
        • Console.user_roles
        • Console.user_patterns
        • Console.password_rules
        • Console.tasks
        • Console.ldap_server_definitions
        • Console.mfa_server_definitions
        • Console.unmanaged_cpcs
        • Console.groups
        • Console.hw_messages
        • Console.restart()
        • Console.shutdown()
        • Console.make_primary()
        • Console.get_audit_log()
        • Console.get_security_log()
        • Console.list_unmanaged_cpcs()
        • Console.list_permitted_partitions()
        • Console.list_permitted_lpars()
        • Console.list_permitted_adapters()
        • Console.list_api_features()
        • Console.api_feature_enabled()
        • Console.certificates
        • Console.single_step_install()
        • Console.delete_uninstalled_firmware()
        • Console.dump()
    • 5.21. User
      • UserManager
        • UserManager.console
        • UserManager.list()
        • UserManager.create()
      • User
        • User.delete()
        • User.update_properties()
        • User.add_user_role()
        • User.remove_user_role()
    • 5.22. User Role
      • UserRoleManager
        • UserRoleManager.console
        • UserRoleManager.list()
        • UserRoleManager.create()
      • UserRole
        • UserRole.delete()
        • UserRole.update_properties()
        • UserRole.add_permission()
        • UserRole.remove_permission()
    • 5.23. User Pattern
      • UserPatternManager
        • UserPatternManager.console
        • UserPatternManager.list()
        • UserPatternManager.create()
        • UserPatternManager.reorder()
      • UserPattern
        • UserPattern.delete()
        • UserPattern.update_properties()
    • 5.24. Password Rule
      • PasswordRuleManager
        • PasswordRuleManager.console
        • PasswordRuleManager.list()
        • PasswordRuleManager.create()
      • PasswordRule
        • PasswordRule.delete()
        • PasswordRule.update_properties()
    • 5.25. Task
      • TaskManager
        • TaskManager.console
        • TaskManager.list()
      • Task
    • 5.26. LDAP Server Definition
      • LdapServerDefinitionManager
        • LdapServerDefinitionManager.console
        • LdapServerDefinitionManager.list()
        • LdapServerDefinitionManager.create()
      • LdapServerDefinition
        • LdapServerDefinition.delete()
        • LdapServerDefinition.update_properties()
    • 5.27. MFA Server Definition
      • MfaServerDefinitionManager
        • MfaServerDefinitionManager.console
        • MfaServerDefinitionManager.list()
        • MfaServerDefinitionManager.create()
      • MfaServerDefinition
        • MfaServerDefinition.delete()
        • MfaServerDefinition.update_properties()
    • 5.28. Certificates
      • CertificateManager
        • CertificateManager.console
        • CertificateManager.list()
        • CertificateManager.import_certificate()
      • Certificate
        • Certificate.cpc
        • Certificate.delete()
        • Certificate.update_properties()
        • Certificate.get_encoded()
        • Certificate.dump()
    • 5.29. Hardware Message
      • HwMessageManager
        • HwMessageManager.list()
      • HwMessage
        • HwMessage.dump()
        • HwMessage.delete()
        • HwMessage.request_service()
        • HwMessage.get_service_information()
        • HwMessage.decline_service()
  • 6. Notifications
    • NotificationReceiver
      • NotificationReceiver.connect()
      • NotificationReceiver.is_connected()
      • NotificationReceiver.subscribe()
      • NotificationReceiver.unsubscribe()
      • NotificationReceiver.is_subscribed()
      • NotificationReceiver.get_subscription()
      • NotificationReceiver.notifications()
      • NotificationReceiver.close()
    • StompRetryTimeoutConfig
      • StompRetryTimeoutConfig.override_with()
  • 7. Mock support
    • 7.1. Faked session
      • FakedSession
        • FakedSession.__repr__()
        • FakedSession.hmc
        • FakedSession.from_hmc_yaml_file()
        • FakedSession.from_hmc_yaml()
        • FakedSession.from_hmc_dict()
        • FakedSession.get()
        • FakedSession.post()
        • FakedSession.delete()
      • HmcDefinitionYamlError
      • HmcDefinitionSchemaError
    • 7.2. Faked HMC
      • InputError
      • FakedHmc
        • FakedHmc.__repr__()
        • FakedHmc.session
        • FakedHmc.metric_values
        • FakedHmc.metric_groups
        • FakedHmc.enabled
        • FakedHmc.enable()
        • FakedHmc.disable()
        • FakedHmc.validate_session_id()
        • FakedHmc.add_session_id()
        • FakedHmc.remove_session_id()
        • FakedHmc.lookup_by_uri()
        • FakedHmc.add_metric_values()
      • FakedActivationProfileManager
        • FakedActivationProfileManager.add()
        • FakedActivationProfileManager.profile_type
      • FakedActivationProfile
      • FakedAdapterManager
        • FakedAdapterManager.add()
      • FakedAdapter
        • FakedAdapter.__repr__()
        • FakedAdapter.ports
        • FakedAdapter.adapter_kind
      • FakedCapacityGroupManager
        • FakedCapacityGroupManager.add()
      • FakedCapacityGroup
        • FakedCapacityGroup.__repr__()
      • FakedConsoleManager
        • FakedConsoleManager.console
        • FakedConsoleManager.add()
      • FakedConsole
        • FakedConsole.__repr__()
        • FakedConsole.storage_groups
        • FakedConsole.storage_group_templates
        • FakedConsole.users
        • FakedConsole.user_roles
        • FakedConsole.user_patterns
        • FakedConsole.password_rules
        • FakedConsole.tasks
        • FakedConsole.ldap_server_definitions
        • FakedConsole.mfa_server_definitions
        • FakedConsole.unmanaged_cpcs
        • FakedConsole.groups
        • FakedConsole.hw_messages
      • FakedCpcManager
        • FakedCpcManager.add()
      • FakedCpc
        • FakedCpc.__repr__()
        • FakedCpc.dpm_enabled
        • FakedCpc.lpars
        • FakedCpc.partitions
        • FakedCpc.adapters
        • FakedCpc.virtual_switches
        • FakedCpc.capacity_groups
        • FakedCpc.reset_activation_profiles
        • FakedCpc.image_activation_profiles
        • FakedCpc.load_activation_profiles
        • FakedCpc.hw_messages
      • FakedHbaManager
        • FakedHbaManager.add()
        • FakedHbaManager.remove()
      • FakedHba
      • FakedLdapServerDefinitionManager
        • FakedLdapServerDefinitionManager.add()
      • FakedLdapServerDefinition
      • FakedLparManager
        • FakedLparManager.add()
      • FakedLpar
      • FakedNicManager
        • FakedNicManager.add()
        • FakedNicManager.remove()
      • FakedNic
      • FakedPartitionManager
        • FakedPartitionManager.add()
      • FakedPartition
        • FakedPartition.__repr__()
        • FakedPartition.nics
        • FakedPartition.hbas
        • FakedPartition.virtual_functions
        • FakedPartition.devno_alloc()
        • FakedPartition.devno_free()
        • FakedPartition.devno_free_if_allocated()
        • FakedPartition.wwpn_alloc()
        • FakedPartition.wwpn_free()
        • FakedPartition.wwpn_free_if_allocated()
      • FakedPasswordRuleManager
        • FakedPasswordRuleManager.add()
      • FakedPasswordRule
      • FakedPortManager
        • FakedPortManager.add()
        • FakedPortManager.remove()
      • FakedPort
      • FakedTaskManager
        • FakedTaskManager.add()
      • FakedTask
      • FakedUnmanagedCpcManager
        • FakedUnmanagedCpcManager.add()
      • FakedUnmanagedCpc
        • FakedUnmanagedCpc.__repr__()
      • FakedUserManager
        • FakedUserManager.add()
      • FakedUser
      • FakedUserPatternManager
        • FakedUserPatternManager.add()
      • FakedUserPattern
      • FakedUserRoleManager
        • FakedUserRoleManager.add()
      • FakedUserRole
      • FakedVirtualFunctionManager
        • FakedVirtualFunctionManager.add()
        • FakedVirtualFunctionManager.remove()
      • FakedVirtualFunction
      • FakedVirtualSwitchManager
        • FakedVirtualSwitchManager.add()
      • FakedVirtualSwitch
      • FakedMetricsContextManager
        • FakedMetricsContextManager.add()
      • FakedMetricsContext
        • FakedMetricsContext.get_metric_group_definitions()
        • FakedMetricsContext.get_metric_group_infos()
        • FakedMetricsContext.get_metric_values()
        • FakedMetricsContext.get_metric_values_response()
      • FakedMetricGroupDefinition
        • FakedMetricGroupDefinition.__repr__()
      • FakedMetricObjectValues
        • FakedMetricObjectValues.__repr__()
      • FakedBaseManager
        • FakedBaseManager.__repr__()
        • FakedBaseManager.hmc
        • FakedBaseManager.parent
        • FakedBaseManager.resource_class
        • FakedBaseManager.base_uri
        • FakedBaseManager.oid_prop
        • FakedBaseManager.uri_prop
        • FakedBaseManager.class_value
        • FakedBaseManager.add()
        • FakedBaseManager.remove()
        • FakedBaseManager.list()
        • FakedBaseManager.lookup_by_oid()
      • FakedBaseResource
        • FakedBaseResource.__repr__()
        • FakedBaseResource.manager
        • FakedBaseResource.properties
        • FakedBaseResource.oid
        • FakedBaseResource.uri
        • FakedBaseResource.name
        • FakedBaseResource.update()
        • FakedBaseResource.add_resources()
    • 7.3. URI handler
      • LparActivateHandler
        • LparActivateHandler.get_status()
        • LparActivateHandler.post()
      • LparDeactivateHandler
        • LparDeactivateHandler.get_status()
        • LparDeactivateHandler.post()
      • LparLoadHandler
        • LparLoadHandler.get_status()
        • LparLoadHandler.post()
  • 8. Development
    • 8.1. Code of Conduct
    • 8.2. Repository
    • 8.3. Setting up the development environment
    • 8.4. Building the documentation
    • 8.5. Testing
      • 8.5.1. Running unit tests
      • 8.5.2. Running end2end tests
      • 8.5.3. Running end2end tests against example mocked environments
      • 8.5.4. Enabling logging during end2end tests
      • 8.5.5. HMC inventory file
      • 8.5.6. HMC vault file
    • 8.6. Developing tests
      • 8.6.1. zhmcclient.testutils module
      • 8.6.2. Pytest fixtures
        • hmc_definition()
        • hmc_session()
        • all_cpcs()
        • dpm_mode_cpcs()
        • classic_mode_cpcs()
      • 8.6.3. Encapsulation of HMC inventory file
        • hmc_definitions()
        • print_hmc_definitions()
        • HMCDefinitions
        • HMCDefinition
        • HMCInventoryFile
      • 8.6.4. Encapsulation of HMC vault file
        • HMCVaultFile
      • 8.6.5. Helper functions for HMC session management
        • setup_hmc_session()
        • teardown_hmc_session()
        • teardown_hmc_session_id()
        • is_valid_hmc_session_id()
        • zhmcclient.testutils.LOG_FORMAT_STRING
        • zhmcclient.testutils.LOG_DATETIME_FORMAT
        • zhmcclient.testutils.LOG_DATETIME_TIMEZONE
      • 8.6.6. Exceptions
        • HMCInventoryFileError
        • HMCVaultFileError
        • HMCNoVaultError
        • HMCNotFound
    • 8.7. Contributing
    • 8.8. Making a change
    • 8.9. Format of commit messages
    • 8.10. Releasing a version
    • 8.11. Starting a new version
  • 9. Security
    • 9.1. HMC Web Services API
      • 9.1.1. SSL/TLS protocol version
      • 9.1.2. HMC certificate
      • 9.1.3. Cipher suites
    • 9.2. HMC Web Services API notifications
  • 10. Appendix
    • 10.1. Troubleshooting
      • 10.1.1. No connection to the HMC
      • 10.1.2. ConnectionError with SSLV3_ALERT_HANDSHAKE_FAILURE
      • 10.1.3. ConnectionError with CERTIFICATE_VERIFY_FAILED: self signed certificate
      • 10.1.4. ImportError urllib3 v2.0 only supports OpenSSL 1.1.1+ (macOS)
    • 10.2. Base classes for resources
      • BaseManager
        • BaseManager.__repr__()
        • BaseManager.invalidate_cache()
        • BaseManager.resource_class
        • BaseManager.class_name
        • BaseManager.name_prop
        • BaseManager.session
        • BaseManager.parent
        • BaseManager.uri
        • BaseManager.case_insensitive_names
        • BaseManager.supports_properties
        • BaseManager.auto_update_enabled()
        • BaseManager.auto_update_needs_pull()
        • BaseManager.enable_auto_update()
        • BaseManager.disable_auto_update()
        • BaseManager.auto_update_trigger_pull()
        • BaseManager.add_resources_local()
        • BaseManager.remove_resource_local()
        • BaseManager.list_resources_local()
        • BaseManager.resource_object()
        • BaseManager.findall()
        • BaseManager.find()
        • BaseManager.list()
        • BaseManager.find_by_name()
        • BaseManager.find_local()
        • BaseManager.flush()
        • BaseManager.dump()
      • BaseResource
        • BaseResource.properties
        • BaseResource.uri
        • BaseResource.name
        • BaseResource.manager
        • BaseResource.full_properties
        • BaseResource.properties_timestamp
        • BaseResource.ceased_existence
        • BaseResource.pull_full_properties()
        • BaseResource.pull_properties()
        • BaseResource.get_property()
        • BaseResource.prop()
        • BaseResource.get_properties_pulled()
        • BaseResource.get_properties_local()
        • BaseResource.update_properties_local()
        • BaseResource.cease_existence_local()
        • BaseResource.__str__()
        • BaseResource.__repr__()
        • BaseResource.auto_update_enabled()
        • BaseResource.enable_auto_update()
        • BaseResource.disable_auto_update()
        • BaseResource.dump()
    • 10.3. Glossary
    • 10.4. Special type names
    • 10.5. Resource model
      • 10.5.1. Resources scoped to the HMC
      • 10.5.2. Resources scoped to CPCs in any mode
      • 10.5.3. Resources scoped to CPCs in DPM mode
      • 10.5.4. Resources scoped to CPCs in classic (and ensemble) mode
    • 10.6. Bibliography
    • 10.7. Related projects
  • 11. Change log
    • 11.1. Version 1.21.0
    • 11.2. Version 1.20.0
    • 11.3. Version 1.19.0
    • 11.4. Version 1.18.0
    • 11.5. Version 1.17.0
    • 11.6. Version 1.16.0
    • 11.7. Version 1.15.0
    • 11.8. Version 1.14.0
    • 11.9. Version 1.13.0
    • 11.10. Version 1.12.0
    • 11.11. Version 1.11.0
    • 11.12. Version 1.10.0
    • 11.13. Version 1.9.0
    • 11.14. Version 1.8.0
    • 11.15. Version 1.7.0
    • 11.16. Version 1.6.0
    • 11.17. Version 1.5.0
    • 11.18. Version 1.4.0
    • 11.19. Version 1.3.0
    • 11.20. Version 1.2.0
    • 11.21. Version 1.1.0
    • 11.22. Version 1.0.0
    • 11.23. Version 0.32.0
    • 11.24. Version 0.31.0
    • 11.25. Version 0.30.0
    • 11.26. Version 0.29.0
    • 11.27. Version 0.28.0
    • 11.28. Version 0.27.0
    • 11.29. Version 0.26.0
    • 11.30. Version 0.25.0
    • 11.31. Version 0.24.0
    • 11.32. Version 0.23.0
    • 11.33. Version 0.22.0
    • 11.34. Version 0.21.0
    • 11.35. Version 0.20.0
    • 11.36. Version 0.19.11
    • 11.37. Version 0.19.0
    • 11.38. Version 0.18.0
    • 11.39. Version 0.17.0
    • 11.40. Version 0.16.0
    • 11.41. Version 0.15.0
    • 11.42. Version 0.14.0
    • 11.43. Version 0.13.0
    • 11.44. Version 0.12.0
    • 11.45. Version 0.11.0
    • 11.46. Version 0.10.0
    • 11.47. Version 0.9.0
    • 11.48. Version 0.8.0
    • 11.49. Version 0.7.0
    • 11.50. Version 0.6.0
    • 11.51. Version 0.5.0
    • 11.52. Version 0.4.0
zhmcclient
  • Overview: module code

All modules for which code is available

  • zhmcclient._activation_profile
  • zhmcclient._adapter
  • zhmcclient._auto_updater
  • zhmcclient._capacity_group
  • zhmcclient._certificates
  • zhmcclient._client
  • zhmcclient._console
  • zhmcclient._cpc
  • zhmcclient._exceptions
  • zhmcclient._group
  • zhmcclient._hba
  • zhmcclient._hw_message
  • zhmcclient._ldap_server_definition
  • zhmcclient._lpar
  • zhmcclient._manager
  • zhmcclient._metrics
  • zhmcclient._mfa_server_definition
  • zhmcclient._nic
  • zhmcclient._notification
  • zhmcclient._os_console
  • zhmcclient._partition
  • zhmcclient._partition_link
  • zhmcclient._password_rule
  • zhmcclient._port
  • zhmcclient._resource
  • zhmcclient._session
  • zhmcclient._storage_group
  • zhmcclient._storage_group_template
  • zhmcclient._storage_volume
  • zhmcclient._storage_volume_template
  • zhmcclient._task
  • zhmcclient._timestats
  • zhmcclient._unmanaged_cpc
  • zhmcclient._user
  • zhmcclient._user_pattern
  • zhmcclient._user_role
  • zhmcclient._utils
  • zhmcclient._virtual_function
  • zhmcclient._virtual_storage_resource
  • zhmcclient._virtual_switch
  • zhmcclient.testutils._cpc_fixtures
  • zhmcclient.testutils._hmc_definition
  • zhmcclient.testutils._hmc_definition_fixtures
  • zhmcclient.testutils._hmc_definitions
  • zhmcclient.testutils._hmc_inventory_file
  • zhmcclient.testutils._hmc_session_functions
  • zhmcclient.testutils._hmc_vault_file
  • zhmcclient_mock._hmc
  • zhmcclient_mock._session
  • zhmcclient_mock._urihandler

© Copyright IBM.

Built with Sphinx using a theme provided by Read the Docs.