zhmcclient
0.28.0
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. Examples
1.6. Versioning
1.7. Compatibility
1.8. Deprecations
1.9. Reporting issues
1.10. License
2. Tutorials
2.1. Executing code in the tutorials
3. Concepts
3.1. Topology
3.2. Multi-threading considerations
3.3. Resource model concepts
3.4. Error handling
3.5. Filtering
4. Reference: General features
4.1. Session
4.2. Retry / timeout configuration
4.3. Client
4.4. Time Statistics
4.5. Metrics
4.6. Logging
4.7. Exceptions
4.8. Constants
4.9. Utilities
5. Reference: Resources
5.1. CPCs
5.2. Unmanaged CPCs
5.3. Activation profiles
5.4. LPARs
5.5. Partitions
5.6. Adapters
5.7. Ports
5.8. NICs
5.9. HBAs
5.10. Virtual Functions
5.11. Virtual Switches
5.12. Storage Groups
5.13. Storage Volumes
5.14. Virtual Storage Resources
5.15. Storage Group Templates
5.16. Storage Volume Templates
5.17. Console
5.18. User
5.19. User Role
5.20. User Pattern
5.21. Password Rule
5.22. Task
5.23. LDAP Server Definition
6. Notifications
7. Mock support
7.1. Faked session
7.2. Faked HMC
7.3. URI handler
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.6. Running function tests against a real HMC and CPC
8.7. Enabling logging for function tests
8.8. Format of the HMC credentials file
8.9. Contributing
8.10. Format of commit messages
8.11. Releasing a version
8.12. Starting a new version
9. Appendix
9.1. Base classes for resources
9.2. Glossary
9.3. Special type names
9.4. Resource model
9.4.1. Resources scoped to the HMC
9.4.2. Resources scoped to CPCs in any mode
9.4.3. Resources scoped to CPCs in DPM mode
9.4.4. Resources scoped to CPCs in classic (and ensemble) mode
9.5. Bibliography
9.6. Related projects
9.7. Change log
9.7.1. Version 0.28.0
9.7.2. Version 0.27.0
9.7.3. Version 0.26.0
9.7.4. Version 0.25.0
9.7.5. Version 0.24.0
9.7.6. Version 0.23.0
9.7.7. Version 0.22.0
9.7.8. Version 0.21.0
9.7.9. Version 0.20.0
9.7.10. Version 0.19.11
9.7.11. Version 0.19.0
9.7.12. Version 0.18.0
9.7.13. Version 0.17.0
9.7.14. Version 0.16.0
9.7.15. Version 0.15.0
9.7.16. Version 0.14.0
9.7.17. Version 0.13.0
9.7.18. Version 0.12.0
9.7.19. Version 0.11.0
9.7.20. Version 0.10.0
9.7.21. Version 0.9.0
9.7.22. Version 0.8.0
9.7.23. Version 0.7.0
9.7.24. Version 0.6.0
9.7.25. Version 0.5.0
9.7.26. Version 0.4.0
zhmcclient
»
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
X
|
Z
_
__new__() (zhmcclient.MetricDefinition static method)
(zhmcclient.MetricGroupDefinition static method)
__repr__() (zhmcclient.Adapter method)
(zhmcclient.BaseManager method)
(zhmcclient.BaseResource method)
(zhmcclient.ClientAuthError method)
(zhmcclient.ConnectTimeout method)
(zhmcclient.ConnectionError method)
(zhmcclient.HTTPError method)
(zhmcclient.MetricsContextManager method)
(zhmcclient.NoUniqueMatch method)
(zhmcclient.NotFound method)
(zhmcclient.OperationTimeout method)
(zhmcclient.ParseError method)
(zhmcclient.ReadTimeout method)
(zhmcclient.RetriesExceeded method)
(zhmcclient.ServerAuthError method)
(zhmcclient.Session method)
(zhmcclient.StatusTimeout method)
(zhmcclient.VersionError method)
(zhmcclient_mock.FakedAdapter method)
(zhmcclient_mock.FakedBaseManager method)
(zhmcclient_mock.FakedBaseResource method)
(zhmcclient_mock.FakedConsole method)
(zhmcclient_mock.FakedCpc method)
(zhmcclient_mock.FakedHmc method)
(zhmcclient_mock.FakedPartition method)
(zhmcclient_mock.FakedSession method)
(zhmcclient_mock.FakedUnmanagedCpc method)
__str__() (zhmcclient.BaseResource method)
(zhmcclient.HTTPError method)
(zhmcclient.TimeStats method)
(zhmcclient.TimeStatsKeeper method)
__version__ (in module zhmcclient._version)
A
Accelerator Adapter
activate() (zhmcclient.Lpar method)
Activation Profile
ActivationProfile (class in zhmcclient)
ActivationProfileManager (class in zhmcclient)
actual_status (zhmcclient.StatusTimeout attribute)
Adapter
(class in zhmcclient)
adapter (zhmcclient.PortManager attribute)
Adapter Port
adapter_kind (zhmcclient_mock.FakedAdapter attribute)
adapter_port (zhmcclient.VirtualStorageResource attribute)
AdapterManager (class in zhmcclient)
adapters (zhmcclient.Cpc attribute)
(zhmcclient_mock.FakedCpc attribute)
add() (zhmcclient_mock.FakedActivationProfileManager method)
(zhmcclient_mock.FakedAdapterManager method)
(zhmcclient_mock.FakedBaseManager method)
(zhmcclient_mock.FakedConsoleManager method)
(zhmcclient_mock.FakedCpcManager method)
(zhmcclient_mock.FakedHbaManager method)
(zhmcclient_mock.FakedLdapServerDefinitionManager method)
(zhmcclient_mock.FakedLparManager method)
(zhmcclient_mock.FakedMetricsContextManager method)
(zhmcclient_mock.FakedNicManager method)
(zhmcclient_mock.FakedPartitionManager method)
(zhmcclient_mock.FakedPasswordRuleManager method)
(zhmcclient_mock.FakedPortManager method)
(zhmcclient_mock.FakedTaskManager method)
(zhmcclient_mock.FakedUnmanagedCpcManager method)
(zhmcclient_mock.FakedUserManager method)
(zhmcclient_mock.FakedUserPatternManager method)
(zhmcclient_mock.FakedUserRoleManager method)
(zhmcclient_mock.FakedVirtualFunctionManager method)
(zhmcclient_mock.FakedVirtualSwitchManager method)
add_candidate_adapter_ports() (zhmcclient.StorageGroup method)
add_metric_group_definition() (zhmcclient_mock.FakedMetricsContextManager method)
add_metric_values() (zhmcclient_mock.FakedMetricsContextManager method)
add_permission() (zhmcclient.UserRole method)
add_resources() (zhmcclient_mock.FakedBaseResource method)
add_temporary_capacity() (zhmcclient.Cpc method)
add_user_role() (zhmcclient.User method)
API_LOGGER_NAME (in module zhmcclient._constants)
api_version (zhmcclient.VersionError attribute)
attach_storage_group() (zhmcclient.Partition method)
attached_partition (zhmcclient.VirtualStorageResource attribute)
AuthError (class in zhmcclient)
avg_time (zhmcclient.TimeStats attribute)
B
base_uri (zhmcclient_mock.FakedBaseManager attribute)
base_url (zhmcclient.Session attribute)
BaseManager (class in zhmcclient)
BaseResource (class in zhmcclient)
begin() (zhmcclient.TimeStats method)
byte string
C
callable
Capacity Group
Capacity Record
change_adapter_type() (zhmcclient.Adapter method)
change_crypto_domain_config() (zhmcclient.Partition method)
change_crypto_type() (zhmcclient.Adapter method)
check_for_completion() (zhmcclient.Job method)
class_name (zhmcclient.BaseManager attribute)
class_value (zhmcclient_mock.FakedBaseManager attribute)
Client (class in zhmcclient)
client (zhmcclient.ConsoleManager attribute)
(zhmcclient.CpcManager attribute)
(zhmcclient.MetricObjectValues attribute)
(zhmcclient.MetricsContextManager attribute)
ClientAuthError (class in zhmcclient)
close() (zhmcclient.NotificationReceiver method)
column (zhmcclient.ParseError attribute)
connect_retries (zhmcclient.ConnectTimeout attribute)
(zhmcclient.RetriesExceeded attribute)
connect_timeout (zhmcclient.ConnectTimeout attribute)
ConnectionError (class in zhmcclient)
ConnectTimeout (class in zhmcclient)
Console
(class in zhmcclient)
console (zhmcclient.ConsoleManager attribute)
(zhmcclient.CpcManager attribute)
(zhmcclient.LdapServerDefinitionManager attribute)
(zhmcclient.PasswordRuleManager attribute)
(zhmcclient.StorageGroupManager attribute)
(zhmcclient.StorageGroupTemplateManager attribute)
(zhmcclient.TaskManager attribute)
(zhmcclient.UnmanagedCpcManager attribute)
(zhmcclient.UserManager attribute)
(zhmcclient.UserPatternManager attribute)
(zhmcclient.UserRoleManager attribute)
(zhmcclient_mock.FakedConsoleManager attribute)
ConsoleManager (class in zhmcclient)
consoles (zhmcclient.Client attribute)
count (zhmcclient.TimeStats attribute)
CPC
Cpc (class in zhmcclient)
cpc (zhmcclient.ActivationProfileManager attribute)
(zhmcclient.AdapterManager attribute)
(zhmcclient.LparManager attribute)
(zhmcclient.PartitionManager attribute)
(zhmcclient.StorageGroup attribute)
(zhmcclient.StorageGroupTemplate attribute)
(zhmcclient.VirtualSwitchManager attribute)
CpcManager (class in zhmcclient)
cpcs (zhmcclient.Client attribute)
create() (zhmcclient.HbaManager method)
(zhmcclient.LdapServerDefinitionManager method)
(zhmcclient.MetricsContextManager method)
(zhmcclient.NicManager method)
(zhmcclient.PartitionManager method)
(zhmcclient.PasswordRuleManager method)
(zhmcclient.StorageGroupManager method)
(zhmcclient.StorageGroupTemplateManager method)
(zhmcclient.StorageVolumeManager method)
(zhmcclient.StorageVolumeTemplateManager method)
(zhmcclient.UserManager method)
(zhmcclient.UserPatternManager method)
(zhmcclient.UserRoleManager method)
(zhmcclient.VirtualFunctionManager method)
create_hipersocket() (zhmcclient.AdapterManager method)
Crypto Adapter
D
datetime_from_timestamp() (in module zhmcclient)
deactivate() (zhmcclient.Lpar method)
decrease_crypto_config() (zhmcclient.Partition method)
DEFAULT_CONNECT_RETRIES (in module zhmcclient._constants)
DEFAULT_CONNECT_TIMEOUT (in module zhmcclient._constants)
DEFAULT_HMC_PORT (in module zhmcclient._constants)
DEFAULT_MAX_REDIRECTS (in module zhmcclient._constants)
DEFAULT_NAME_URI_CACHE_TIMETOLIVE (in module zhmcclient._constants)
DEFAULT_OPERATION_TIMEOUT (in module zhmcclient._constants)
DEFAULT_READ_RETRIES (in module zhmcclient._constants)
DEFAULT_READ_TIMEOUT (in module zhmcclient._constants)
DEFAULT_STATUS_TIMEOUT (in module zhmcclient._constants)
DEFAULT_STOMP_PORT (in module zhmcclient._constants)
delete() (zhmcclient.Adapter method)
(zhmcclient.Hba method)
(zhmcclient.LdapServerDefinition method)
(zhmcclient.MetricsContext method)
(zhmcclient.Nic method)
(zhmcclient.Partition method)
(zhmcclient.PasswordRule method)
(zhmcclient.Session method)
(zhmcclient.StorageGroup method)
(zhmcclient.StorageGroupTemplate method)
(zhmcclient.StorageVolume method)
(zhmcclient.StorageVolumeTemplate method)
(zhmcclient.User method)
(zhmcclient.UserPattern method)
(zhmcclient.UserRole method)
(zhmcclient.VirtualFunction method)
(zhmcclient_mock.FakedSession method)
DeprecationWarning
desired_statuses (zhmcclient.StatusTimeout attribute)
detach_storage_group() (zhmcclient.Partition method)
details (zhmcclient.ConnectionError attribute)
(zhmcclient.ServerAuthError attribute)
devno_alloc() (zhmcclient_mock.FakedPartition method)
devno_free() (zhmcclient_mock.FakedPartition method)
devno_free_if_allocated() (zhmcclient_mock.FakedPartition method)
disable() (zhmcclient.TimeStatsKeeper method)
(zhmcclient_mock.FakedHmc method)
discover_fcp() (zhmcclient.StorageGroup method)
dpm_enabled (zhmcclient.Cpc attribute)
(zhmcclient_mock.FakedCpc attribute)
dump_partition() (zhmcclient.Partition method)
E
enable() (zhmcclient.TimeStatsKeeper method)
(zhmcclient_mock.FakedHmc method)
enabled (zhmcclient.TimeStatsKeeper attribute)
(zhmcclient_mock.FakedHmc attribute)
end() (zhmcclient.TimeStats method)
Error (class in zhmcclient)
error_details (zhmcclient.HTTPError attribute)
export_profiles() (zhmcclient.Cpc method)
F
FakedActivationProfile (class in zhmcclient_mock)
FakedActivationProfileManager (class in zhmcclient_mock)
FakedAdapter (class in zhmcclient_mock)
FakedAdapterManager (class in zhmcclient_mock)
FakedBaseManager (class in zhmcclient_mock)
FakedBaseResource (class in zhmcclient_mock)
FakedConsole (class in zhmcclient_mock)
FakedConsoleManager (class in zhmcclient_mock)
FakedCpc (class in zhmcclient_mock)
FakedCpcManager (class in zhmcclient_mock)
FakedHba (class in zhmcclient_mock)
FakedHbaManager (class in zhmcclient_mock)
FakedHmc (class in zhmcclient_mock)
FakedLdapServerDefinition (class in zhmcclient_mock)
FakedLdapServerDefinitionManager (class in zhmcclient_mock)
FakedLpar (class in zhmcclient_mock)
FakedLparManager (class in zhmcclient_mock)
FakedMetricsContext (class in zhmcclient_mock)
FakedMetricsContextManager (class in zhmcclient_mock)
FakedNic (class in zhmcclient_mock)
FakedNicManager (class in zhmcclient_mock)
FakedPartition (class in zhmcclient_mock)
FakedPartitionManager (class in zhmcclient_mock)
FakedPasswordRule (class in zhmcclient_mock)
FakedPasswordRuleManager (class in zhmcclient_mock)
FakedPort (class in zhmcclient_mock)
FakedPortManager (class in zhmcclient_mock)
FakedSession (class in zhmcclient_mock)
FakedTask (class in zhmcclient_mock)
FakedTaskManager (class in zhmcclient_mock)
FakedUnmanagedCpc (class in zhmcclient_mock)
FakedUnmanagedCpcManager (class in zhmcclient_mock)
FakedUser (class in zhmcclient_mock)
FakedUserManager (class in zhmcclient_mock)
FakedUserPattern (class in zhmcclient_mock)
FakedUserPatternManager (class in zhmcclient_mock)
FakedUserRole (class in zhmcclient_mock)
FakedUserRoleManager (class in zhmcclient_mock)
FakedVirtualFunction (class in zhmcclient_mock)
FakedVirtualFunctionManager (class in zhmcclient_mock)
FakedVirtualSwitch (class in zhmcclient_mock)
FakedVirtualSwitchManager (class in zhmcclient_mock)
FCP Adapter
FCP Port
feature_enabled() (zhmcclient.Cpc method)
(zhmcclient.Partition method)
feature_info() (zhmcclient.Cpc method)
(zhmcclient.Partition method)
filter_args (zhmcclient.NotFound attribute)
(zhmcclient.NoUniqueMatch attribute)
find() (zhmcclient.BaseManager method)
find_by_name() (zhmcclient.BaseManager method)
findall() (zhmcclient.BaseManager method)
flush() (zhmcclient.BaseManager method)
fulfillment
full_properties (zhmcclient.BaseResource attribute)
G
get() (zhmcclient.Session method)
(zhmcclient_mock.FakedSession method)
get_audit_log() (zhmcclient.Console method)
get_connected_nics() (zhmcclient.VirtualSwitch method)
get_connection_report() (zhmcclient.StorageGroup method)
get_energy_management_properties() (zhmcclient.Cpc method)
get_free_crypto_domains() (zhmcclient.Cpc method)
get_inventory() (zhmcclient.Client method)
get_metric_group_definition() (zhmcclient_mock.FakedMetricsContextManager method)
get_metric_group_definition_names() (zhmcclient_mock.FakedMetricsContextManager method)
get_metric_group_definitions() (zhmcclient_mock.FakedMetricsContext method)
get_metric_group_infos() (zhmcclient_mock.FakedMetricsContext method)
get_metric_values() (zhmcclient_mock.FakedMetricsContext method)
(zhmcclient_mock.FakedMetricsContextManager method)
get_metric_values_group_names() (zhmcclient_mock.FakedMetricsContextManager method)
get_metric_values_response() (zhmcclient_mock.FakedMetricsContext method)
get_metrics() (zhmcclient.MetricsContext method)
get_notification_topics() (zhmcclient.Session method)
get_password (zhmcclient.Session attribute)
get_password_interface() (in module zhmcclient)
get_property() (zhmcclient.BaseResource method)
get_security_log() (zhmcclient.Console method)
get_stats() (zhmcclient.TimeStatsKeeper method)
get_status() (zhmcclient_mock.LparActivateHandler static method)
(zhmcclient_mock.LparDeactivateHandler static method)
(zhmcclient_mock.LparLoadHandler static method)
get_wwpns() (zhmcclient.Cpc method)
Group
Group Profile
H
Hardware Message
HBA
Hba (class in zhmcclient)
HbaManager (class in zhmcclient)
hbas (zhmcclient.Partition attribute)
(zhmcclient_mock.FakedPartition attribute)
header dict
headers (zhmcclient.Session attribute)
HMC
hmc (zhmcclient_mock.FakedBaseManager attribute)
(zhmcclient_mock.FakedSession attribute)
HMC API
HMC API 2.11.1
HMC API 2.12.0
HMC API 2.12.1
HMC API 2.13.0
HMC API 2.13.1
HMC API 2.14.0
HMC API 2.14.1
HMC API 2.15.0
HMC API version
HMC Operations Guide
HMC Operations Guide 2.11.1
HMC Operations Guide 2.12.1
HMC Operations Guide 2.13.1
HMC Operations Guide 2.14.1
HMC Operations Guide 2.15.0
HMC_LOGGER_NAME (in module zhmcclient._constants)
host (zhmcclient.Session attribute)
HTML_REASON_OTHER (in module zhmcclient._constants)
HTML_REASON_WEB_SERVICES_DISABLED (in module zhmcclient._constants)
http_status (zhmcclient.HTTPError attribute)
HTTPError (class in zhmcclient)
I
Image Activation Profile
image_activation_profiles (zhmcclient.Cpc attribute)
(zhmcclient_mock.FakedCpc attribute)
import_profiles() (zhmcclient.Cpc method)
increase_crypto_config() (zhmcclient.Partition method)
indicate_fulfillment_fcp() (zhmcclient.StorageVolume method)
indicate_fulfillment_ficon() (zhmcclient.StorageVolume method)
InputError (class in zhmcclient_mock)
integer
invalidate_cache() (zhmcclient.BaseManager method)
is_logon() (zhmcclient.Session method)
J
Job
(class in zhmcclient)
json object
K
keeper (zhmcclient.TimeStats attribute)
L
LDAP Server Definition
ldap_server_definitions (zhmcclient.Console attribute)
(zhmcclient_mock.FakedConsole attribute)
LdapServerDefinition (class in zhmcclient)
LdapServerDefinitionManager (class in zhmcclient)
line (zhmcclient.ParseError attribute)
list() (zhmcclient.ActivationProfileManager method)
(zhmcclient.AdapterManager method)
(zhmcclient.BaseManager method)
(zhmcclient.ConsoleManager method)
(zhmcclient.CpcManager method)
(zhmcclient.HbaManager method)
(zhmcclient.LdapServerDefinitionManager method)
(zhmcclient.LparManager method)
(zhmcclient.MetricsContextManager method)
(zhmcclient.NicManager method)
(zhmcclient.PartitionManager method)
(zhmcclient.PasswordRuleManager method)
(zhmcclient.PortManager method)
(zhmcclient.StorageGroupManager method)
(zhmcclient.StorageGroupTemplateManager method)
(zhmcclient.StorageVolumeManager method)
(zhmcclient.StorageVolumeTemplateManager method)
(zhmcclient.TaskManager method)
(zhmcclient.UnmanagedCpcManager method)
(zhmcclient.UserManager method)
(zhmcclient.UserPatternManager method)
(zhmcclient.UserRoleManager method)
(zhmcclient.VirtualFunctionManager method)
(zhmcclient.VirtualStorageResourceManager method)
(zhmcclient.VirtualSwitchManager method)
(zhmcclient_mock.FakedBaseManager method)
list_associated_storage_groups() (zhmcclient.Cpc method)
list_attached_partitions() (zhmcclient.StorageGroup method)
list_attached_storage_groups() (zhmcclient.Partition method)
list_candidate_adapter_ports() (zhmcclient.StorageGroup method)
list_unmanaged_cpcs() (zhmcclient.Console method)
Load Activation Profile
load() (zhmcclient.Lpar method)
load_activation_profiles (zhmcclient.Cpc attribute)
(zhmcclient_mock.FakedCpc attribute)
Logical Partition
logoff() (zhmcclient.Session method)
logon() (zhmcclient.Session method)
lookup_by_oid() (zhmcclient_mock.FakedBaseManager method)
lookup_by_uri() (zhmcclient_mock.FakedHmc method)
LPAR
Lpar (class in zhmcclient)
LparActivateHandler (class in zhmcclient_mock)
LparDeactivateHandler (class in zhmcclient_mock)
LparLoadHandler (class in zhmcclient_mock)
LparManager (class in zhmcclient)
lpars (zhmcclient.Cpc attribute)
(zhmcclient_mock.FakedCpc attribute)
M
make_primary() (zhmcclient.Console method)
manager (zhmcclient.BaseResource attribute)
(zhmcclient.NoUniqueMatch attribute)
(zhmcclient.NotFound attribute)
(zhmcclient_mock.FakedBaseResource attribute)
max_time (zhmcclient.TimeStats attribute)
maximum_active_partitions (zhmcclient.Cpc attribute)
maximum_crypto_domains (zhmcclient.Adapter attribute)
message (zhmcclient.HTTPError attribute)
metric_group_definition (zhmcclient.MetricObjectValues attribute)
metric_group_definitions (zhmcclient.MetricsContext attribute)
metric_group_values (zhmcclient.MetricsResponse attribute)
MetricDefinition (class in zhmcclient)
MetricGroupDefinition (class in zhmcclient)
MetricGroupValues (class in zhmcclient)
MetricObjectValues (class in zhmcclient)
metrics (zhmcclient.MetricObjectValues attribute)
Metrics Context
metrics_context (zhmcclient.MetricsResponse attribute)
metrics_contexts (zhmcclient.Client attribute)
MetricsContext (class in zhmcclient)
MetricsContextManager (class in zhmcclient)
MetricsResponse (class in zhmcclient)
min_api_version (zhmcclient.VersionError attribute)
min_time (zhmcclient.TimeStats attribute)
mount_iso_image() (zhmcclient.Partition method)
N
name (zhmcclient.BaseResource attribute)
(zhmcclient.MetricGroupValues attribute)
(zhmcclient.TimeStats attribute)
(zhmcclient_mock.FakedBaseResource attribute)
Network Adapter
Network Port
NIC
Nic (class in zhmcclient)
NicManager (class in zhmcclient)
nics (zhmcclient.Partition attribute)
(zhmcclient_mock.FakedPartition attribute)
NotFound (class in zhmcclient)
NotificationReceiver (class in zhmcclient)
notifications() (zhmcclient.NotificationReceiver method)
NoUniqueMatch (class in zhmcclient)
number
O
object_values (zhmcclient.MetricGroupValues attribute)
oid (zhmcclient.StorageVolume attribute)
(zhmcclient_mock.FakedBaseResource attribute)
oid_prop (zhmcclient_mock.FakedBaseManager attribute)
op_method (zhmcclient.Job attribute)
op_uri (zhmcclient.Job attribute)
open_os_message_channel() (zhmcclient.Lpar method)
(zhmcclient.Partition method)
operation_timeout (zhmcclient.OperationTimeout attribute)
OperationTimeout (class in zhmcclient)
override_with() (zhmcclient.RetryTimeoutConfig method)
P
parent (zhmcclient.BaseManager attribute)
(zhmcclient_mock.FakedBaseManager attribute)
ParseError (class in zhmcclient)
Partition
(class in zhmcclient)
partition (zhmcclient.HbaManager attribute)
(zhmcclient.NicManager attribute)
(zhmcclient.VirtualFunctionManager attribute)
PartitionManager (class in zhmcclient)
partitions (zhmcclient.Cpc attribute)
(zhmcclient_mock.FakedCpc attribute)
Password Rule
password_rules (zhmcclient.Console attribute)
(zhmcclient_mock.FakedConsole attribute)
PasswordRule (class in zhmcclient)
PasswordRuleManager (class in zhmcclient)
Port
(class in zhmcclient)
port (zhmcclient.Session attribute)
port_type (zhmcclient.PortManager attribute)
port_uri_segment (zhmcclient.Adapter attribute)
port_uris_prop (zhmcclient.Adapter attribute)
PortManager (class in zhmcclient)
ports (zhmcclient.Adapter attribute)
(zhmcclient_mock.FakedAdapter attribute)
post() (zhmcclient.Session method)
(zhmcclient_mock.FakedSession method)
(zhmcclient_mock.LparActivateHandler static method)
(zhmcclient_mock.LparDeactivateHandler static method)
(zhmcclient_mock.LparLoadHandler static method)
profile_type (zhmcclient.ActivationProfileManager attribute)
(zhmcclient_mock.FakedActivationProfileManager attribute)
prop() (zhmcclient.BaseResource method)
properties (zhmcclient.BaseResource attribute)
(zhmcclient_mock.FakedBaseResource attribute)
properties_timestamp (zhmcclient.BaseResource attribute)
psw_restart() (zhmcclient.Lpar method)
(zhmcclient.Partition method)
pull_full_properties() (zhmcclient.BaseResource method)
Q
query_api_version() (zhmcclient.Client method)
R
read_retries (zhmcclient.ReadTimeout attribute)
read_timeout (zhmcclient.ReadTimeout attribute)
ReadTimeout (class in zhmcclient)
reason (zhmcclient.HTTPError attribute)
reassign_port() (zhmcclient.Hba method)
remove() (zhmcclient_mock.FakedBaseManager method)
(zhmcclient_mock.FakedHbaManager method)
(zhmcclient_mock.FakedNicManager method)
(zhmcclient_mock.FakedPortManager method)
(zhmcclient_mock.FakedVirtualFunctionManager method)
remove_candidate_adapter_ports() (zhmcclient.StorageGroup method)
remove_permission() (zhmcclient.UserRole method)
remove_temporary_capacity() (zhmcclient.Cpc method)
remove_user_role() (zhmcclient.User method)
reorder() (zhmcclient.UserPatternManager method)
request_authenticated_as (zhmcclient.HTTPError attribute)
request_body (zhmcclient.HTTPError attribute)
request_body_as_string (zhmcclient.HTTPError attribute)
request_body_as_string_partial (zhmcclient.HTTPError attribute)
request_headers (zhmcclient.HTTPError attribute)
request_method (zhmcclient.HTTPError attribute)
request_query_parms (zhmcclient.HTTPError attribute)
request_uri (zhmcclient.HTTPError attribute)
Reset Activation Profile
reset() (zhmcclient.TimeStats method)
reset_activation_profiles (zhmcclient.Cpc attribute)
(zhmcclient_mock.FakedCpc attribute)
reset_clear() (zhmcclient.Lpar method)
resource (zhmcclient.MetricObjectValues attribute)
resource_class (zhmcclient.BaseManager attribute)
(zhmcclient_mock.FakedBaseManager attribute)
resource_object() (zhmcclient.BaseManager method)
resource_uri (zhmcclient.MetricObjectValues attribute)
resource_uris (zhmcclient.NoUniqueMatch attribute)
resources (zhmcclient.NoUniqueMatch attribute)
restart() (zhmcclient.Console method)
RetriesExceeded (class in zhmcclient)
retry_timeout_config (zhmcclient.Session attribute)
RetryTimeoutConfig (class in zhmcclient)
RFC2616
RFC2617
RFC3986
RFC6874
S
scsi_dump() (zhmcclient.Lpar method)
scsi_load() (zhmcclient.Lpar method)
send_os_command() (zhmcclient.Lpar method)
(zhmcclient.Partition method)
ServerAuthError (class in zhmcclient)
Session
(class in zhmcclient)
session (zhmcclient.BaseManager attribute)
(zhmcclient.Client attribute)
(zhmcclient.Job attribute)
(zhmcclient.Session attribute)
session-id
session_id (zhmcclient.Session attribute)
set_power_capping() (zhmcclient.Cpc method)
set_power_save() (zhmcclient.Cpc method)
shutdown() (zhmcclient.Console method)
snapshot() (zhmcclient.TimeStatsKeeper method)
stack (zhmcclient.HTTPError attribute)
start() (zhmcclient.Cpc method)
(zhmcclient.Partition method)
status_timeout (zhmcclient.StatusTimeout attribute)
StatusTimeout (class in zhmcclient)
stop() (zhmcclient.Cpc method)
(zhmcclient.Lpar method)
(zhmcclient.Partition method)
Storage Adapter
Storage Group
Storage Group Template
Storage Port
Storage Volume
Storage Volume Template
storage_group (zhmcclient.StorageVolumeManager attribute)
(zhmcclient.VirtualStorageResourceManager attribute)
storage_group_template (zhmcclient.StorageVolumeTemplateManager attribute)
storage_group_templates (zhmcclient.Console attribute)
storage_groups (zhmcclient.Console attribute)
(zhmcclient_mock.FakedConsole attribute)
storage_volume_templates (zhmcclient.StorageGroupTemplate attribute)
storage_volumes (zhmcclient.StorageGroup attribute)
StorageGroup (class in zhmcclient)
StorageGroupManager (class in zhmcclient)
StorageGroupTemplate (class in zhmcclient)
StorageGroupTemplateManager (class in zhmcclient)
StorageVolume (class in zhmcclient)
StorageVolumeManager (class in zhmcclient)
StorageVolumeTemplate (class in zhmcclient)
StorageVolumeTemplateManager (class in zhmcclient)
str_def() (zhmcclient.ClientAuthError method)
(zhmcclient.ConnectTimeout method)
(zhmcclient.ConnectionError method)
(zhmcclient.Error method)
(zhmcclient.HTTPError method)
(zhmcclient.NoUniqueMatch method)
(zhmcclient.NotFound method)
(zhmcclient.OperationTimeout method)
(zhmcclient.ParseError method)
(zhmcclient.ReadTimeout method)
(zhmcclient.RetriesExceeded method)
(zhmcclient.ServerAuthError method)
(zhmcclient.StatusTimeout method)
(zhmcclient.VersionError method)
string
T
Task
(class in zhmcclient)
TaskManager (class in zhmcclient)
tasks (zhmcclient.Console attribute)
(zhmcclient_mock.FakedConsole attribute)
time_stats_keeper (zhmcclient.Session attribute)
timestamp
(zhmcclient.MetricObjectValues attribute)
timestamp_from_datetime() (in module zhmcclient)
TimeStats (class in zhmcclient)
TimeStatsKeeper (class in zhmcclient)
U
unicode string
unmanaged_cpcs (zhmcclient.Console attribute)
(zhmcclient_mock.FakedConsole attribute)
UnmanagedCpc (class in zhmcclient)
UnmanagedCpcManager (class in zhmcclient)
unmount_iso_image() (zhmcclient.Partition method)
update() (zhmcclient_mock.FakedBaseResource method)
update_properties() (zhmcclient.ActivationProfile method)
(zhmcclient.Adapter method)
(zhmcclient.Cpc method)
(zhmcclient.Hba method)
(zhmcclient.LdapServerDefinition method)
(zhmcclient.Lpar method)
(zhmcclient.Nic method)
(zhmcclient.Partition method)
(zhmcclient.PasswordRule method)
(zhmcclient.Port method)
(zhmcclient.StorageGroup method)
(zhmcclient.StorageGroupTemplate method)
(zhmcclient.StorageVolume method)
(zhmcclient.StorageVolumeTemplate method)
(zhmcclient.User method)
(zhmcclient.UserPattern method)
(zhmcclient.UserRole method)
(zhmcclient.VirtualFunction method)
(zhmcclient.VirtualStorageResource method)
(zhmcclient.VirtualSwitch method)
uri (zhmcclient.BaseResource attribute)
(zhmcclient.Job attribute)
(zhmcclient_mock.FakedBaseResource attribute)
uri_prop (zhmcclient_mock.FakedBaseManager attribute)
User
(class in zhmcclient)
User Pattern
User Role
user_patterns (zhmcclient.Console attribute)
(zhmcclient_mock.FakedConsole attribute)
user_roles (zhmcclient.Console attribute)
(zhmcclient_mock.FakedConsole attribute)
userid (zhmcclient.Session attribute)
UserManager (class in zhmcclient)
UserPattern (class in zhmcclient)
UserPatternManager (class in zhmcclient)
UserRole (class in zhmcclient)
UserRoleManager (class in zhmcclient)
users (zhmcclient.Console attribute)
(zhmcclient_mock.FakedConsole attribute)
V
validate_lun_path() (zhmcclient.Cpc method)
version_info() (zhmcclient.Client method)
VersionError (class in zhmcclient)
vHBA
Virtual Function
Virtual Storage Resource
Virtual Switch
virtual_functions (zhmcclient.Partition attribute)
(zhmcclient_mock.FakedPartition attribute)
virtual_storage_resources (zhmcclient.StorageGroup attribute)
virtual_switches (zhmcclient.Cpc attribute)
(zhmcclient_mock.FakedCpc attribute)
VirtualFunction (class in zhmcclient)
VirtualFunctionManager (class in zhmcclient)
VirtualStorageResource (class in zhmcclient)
VirtualStorageResourceManager (class in zhmcclient)
VirtualSwitch (class in zhmcclient)
VirtualSwitchManager (class in zhmcclient)
vNIC
vswitches (zhmcclient.Cpc attribute)
W
wait_for_available() (zhmcclient.Client method)
wait_for_completion() (zhmcclient.Job method)
wait_for_status() (zhmcclient.Lpar method)
(zhmcclient.Partition method)
wwpn_alloc() (zhmcclient_mock.FakedPartition method)
wwpn_free() (zhmcclient_mock.FakedPartition method)
wwpn_free_if_allocated() (zhmcclient_mock.FakedPartition method)
X
X.509
Z
zeroize_crypto_domain() (zhmcclient.Partition method)
zhmccli package
zhmccli project
zhmcclient._activation_profile (module)
zhmcclient._adapter (module)
zhmcclient._client (module)
zhmcclient._console (module)
zhmcclient._constants (module)
zhmcclient._cpc (module)
zhmcclient._exceptions (module)
zhmcclient._hba (module)
zhmcclient._ldap_server_definition (module)
zhmcclient._logging (module)
zhmcclient._lpar (module)
zhmcclient._manager (module)
zhmcclient._metrics (module)
zhmcclient._nic (module)
zhmcclient._notification (module)
zhmcclient._partition (module)
zhmcclient._password_rule (module)
zhmcclient._port (module)
zhmcclient._resource (module)
zhmcclient._session (module)
zhmcclient._storage_group (module)
zhmcclient._storage_group_template (module)
zhmcclient._storage_volume (module)
zhmcclient._storage_volume_template (module)
zhmcclient._task (module)
zhmcclient._timestats (module)
zhmcclient._unmanaged_cpc (module)
zhmcclient._user (module)
zhmcclient._user_pattern (module)
zhmcclient._user_role (module)
zhmcclient._utils (module)
zhmcclient._virtual_function (module)
zhmcclient._virtual_storage_resource (module)
zhmcclient._virtual_switch (module)
zhmcclient_mock._hmc (module)
zhmcclient_mock._session (module)
zhmcclient_mock._urihandler (module)
Read the Docs
v: 0.28.0
Versions
latest
stable
0.28.0
stable_0.27
stable_0.26
stable_0.25
stable_0.24
stable_0.23
stable_0.22
stable_0.21
stable_0.20
stable_0.19
Downloads
On Read the Docs
Project Home
Builds