# Copyright 2016-2017 IBM Corp. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
Session class: A session to the HMC, optionally in context of an HMC user.
"""
from __future__ import absolute_import
import json
import time
import re
import collections
import six
from copy import copy
try:
from collections import OrderedDict
except ImportError:
from ordereddict import OrderedDict
import requests
from requests.packages import urllib3
from ._exceptions import HTTPError, ServerAuthError, ClientAuthError, \
ConnectionError, ParseError, ConnectTimeout, ReadTimeout, \
RetriesExceeded, OperationTimeout
from ._timestats import TimeStatsKeeper
from ._logging import get_logger, logged_api_call
from ._constants import DEFAULT_CONNECT_TIMEOUT, DEFAULT_CONNECT_RETRIES, \
DEFAULT_READ_TIMEOUT, DEFAULT_READ_RETRIES, DEFAULT_MAX_REDIRECTS, \
DEFAULT_OPERATION_TIMEOUT, DEFAULT_STATUS_TIMEOUT, \
DEFAULT_NAME_URI_CACHE_TIMETOLIVE, HMC_LOGGER_NAME, \
HTML_REASON_WEB_SERVICES_DISABLED, HTML_REASON_OTHER, \
DEFAULT_HMC_PORT
__all__ = ['Session', 'Job', 'RetryTimeoutConfig', 'get_password_interface']
LOG = get_logger(__name__)
HMC_LOG = get_logger(HMC_LOGGER_NAME)
_HMC_SCHEME = "https"
_STD_HEADERS = {
'Content-type': 'application/json',
'Accept': '*/*'
}
def _handle_request_exc(exc, retry_timeout_config):
"""
Handle a :exc:`request.exceptions.RequestException` exception that was
raised.
"""
if isinstance(exc, requests.exceptions.ConnectTimeout):
raise ConnectTimeout(_request_exc_message(exc), exc,
retry_timeout_config.connect_timeout,
retry_timeout_config.connect_retries)
elif isinstance(exc, requests.exceptions.ReadTimeout):
raise ReadTimeout(_request_exc_message(exc), exc,
retry_timeout_config.read_timeout,
retry_timeout_config.read_retries)
elif isinstance(exc, requests.exceptions.RetryError):
raise RetriesExceeded(_request_exc_message(exc), exc,
retry_timeout_config.connect_retries)
else:
raise ConnectionError(_request_exc_message(exc), exc)
def _request_exc_message(exc):
"""
Return a reasonable exception message from a
:exc:`request.exceptions.RequestException` exception.
The approach is to dig deep to the original reason, if the original
exception is present, skipping irrelevant exceptions such as
`urllib3.exceptions.MaxRetryError`, and eliminating useless object
representations such as the connection pool object in
`urllib3.exceptions.NewConnectionError`.
Parameters:
exc (:exc:`~request.exceptions.RequestException`): Exception
Returns:
string: A reasonable exception message from the specified exception.
"""
if exc.args:
if isinstance(exc.args[0], Exception):
org_exc = exc.args[0]
if isinstance(org_exc, urllib3.exceptions.MaxRetryError):
reason_exc = org_exc.reason
message = str(reason_exc)
else:
message = str(org_exc.args[0])
else:
message = str(exc.args[0])
# Eliminate useless object repr at begin of the message
m = re.match(r'^(\(<[^>]+>, \'(.*)\'\)|<[^>]+>: (.*))$', message)
if m:
message = m.group(2) or m.group(3)
else:
message = ""
return message
[docs]class RetryTimeoutConfig(object):
"""
A configuration setting that specifies verious retry counts and timeout
durations.
"""
def __init__(self, connect_timeout=None, connect_retries=None,
read_timeout=None, read_retries=None, max_redirects=None,
operation_timeout=None, status_timeout=None,
name_uri_cache_timetolive=None):
"""
For all parameters, `None` means that this object does not specify a
value for the parameter, and that a default value should be used
(see :ref:`Constants`).
All parameters are available as instance attributes.
Parameters:
connect_timeout (:term:`number`): Connect timeout in seconds.
This timeout applies to making a connection at the socket level.
The same socket connection is used for sending an HTTP request to
the HMC and for receiving its HTTP response.
The special value 0 means that no timeout is set.
connect_retries (:term:`integer`): Number of retries (after the
initial attempt) for connection-related issues. These retries are
performed for failed DNS lookups, failed socket connections, and
socket connection timeouts.
read_timeout (:term:`number`): Read timeout in seconds.
This timeout applies to reading at the socket level, when receiving
an HTTP response.
The special value 0 means that no timeout is set.
read_retries (:term:`integer`): Number of retries (after the
initial attempt) for read-related issues. These retries are
performed for failed socket reads and socket read timeouts.
A retry consists of resending the original HTTP request. The
zhmcclient restricts these retries to just the HTTP GET method.
For other HTTP methods, no retry will be performed.
max_redirects (:term:`integer`): Maximum number of HTTP redirects.
operation_timeout (:term:`number`): Asynchronous operation timeout in
seconds. This timeout applies when waiting for the completion of
asynchronous HMC operations. The special value 0 means that no
timeout is set.
status_timeout (:term:`number`): Resource status timeout in seconds.
This timeout applies when waiting for the transition of the status
of a resource to a desired status. The special value 0 means that
no timeout is set.
name_uri_cache_timetolive (:term:`number`): Time to the next
automatic invalidation of the Name-URI cache of manager objects, in
seconds since the last invalidation. The special value 0 means
that no Name-URI cache is maintained (i.e. the caching is
disabled).
"""
self.connect_timeout = connect_timeout
self.connect_retries = connect_retries
self.read_timeout = read_timeout
self.read_retries = read_retries
self.max_redirects = max_redirects
self.operation_timeout = operation_timeout
self.status_timeout = status_timeout
self.name_uri_cache_timetolive = name_uri_cache_timetolive
# Read retries only for these HTTP methods:
self.method_whitelist = {'GET'}
_attrs = ('connect_timeout', 'connect_retries', 'read_timeout',
'read_retries', 'max_redirects', 'operation_timeout',
'status_timeout', 'name_uri_cache_timetolive',
'method_whitelist')
[docs] def override_with(self, override_config):
"""
Return a new configuration object that represents the configuration
from this configuration object acting as a default, and the specified
configuration object overriding that default.
Parameters:
override_config (:class:`~zhmcclient.RetryTimeoutConfig`):
The configuration object overriding the defaults defined in this
configuration object.
Returns:
:class:`~zhmcclient.RetryTimeoutConfig`:
A new configuration object representing this configuration object,
overridden by the specified configuration object.
"""
ret = RetryTimeoutConfig()
for attr in RetryTimeoutConfig._attrs:
value = getattr(self, attr)
if override_config and getattr(override_config, attr) is not None:
value = getattr(override_config, attr)
setattr(ret, attr, value)
return ret
[docs]def get_password_interface(host, userid):
"""
Interface to the password retrieval function that is invoked by
:class:`~zhmcclient.Session` if no password is provided.
Parameters:
host (string): Hostname or IP address of the HMC
userid (string): Userid on the HMC
Returns:
string: Password of the userid on the HMC
"""
raise NotImplementedError
[docs]class Session(object):
"""
A session to the HMC, optionally in context of an HMC user.
The session supports operations that require to be authenticated, as well
as operations that don't (e.g. obtaining the API version).
The session can keep statistics about the elapsed time for issuing HTTP
requests against the HMC API. Instance variable
:attr:`~zhmcclient.Session.time_stats_keeper` is used to enable/disable the
measurements, and to print the statistics.
"""
default_rt_config = RetryTimeoutConfig(
connect_timeout=DEFAULT_CONNECT_TIMEOUT,
connect_retries=DEFAULT_CONNECT_RETRIES,
read_timeout=DEFAULT_READ_TIMEOUT,
read_retries=DEFAULT_READ_RETRIES,
max_redirects=DEFAULT_MAX_REDIRECTS,
operation_timeout=DEFAULT_OPERATION_TIMEOUT,
status_timeout=DEFAULT_STATUS_TIMEOUT,
name_uri_cache_timetolive=DEFAULT_NAME_URI_CACHE_TIMETOLIVE,
)
def __init__(self, host, userid=None, password=None, session_id=None,
get_password=None, retry_timeout_config=None,
port=DEFAULT_HMC_PORT):
"""
Creating a session object will not immediately cause a logon to be
attempted; the logon is deferred until needed.
There are several alternatives for specifying the authentication
related parameters:
* `userid`/`password` only: The session is initially in a logged-off
state and subsequent operations that require logon will use the
specified userid and password to automatically log on. The returned
session-id will be stored in this session object. Subsequent
operations that require logon will use that session-id. Once the HMC
expires that session-id, subsequent operations that require logon
will cause a re-logon with the specified userid and password.
* `userid`/`password` and `session_id`: The specified session-id will
be stored in this session object, so that the session is initially in
a logged-on state. Subsequent operations that require logon will use
that session-id. Once the HMC expires that session-id, subsequent
operations that require logon will cause a re-logon with the
specified userid/password.
* `session_id` only: The specified session-id will be stored in this
session object, so that the session is initially in a logged-on
state. Subsequent operations that require logon will use the stored
session-id. Once the HMC expires the session-id, subsequent
operations that require logon will cause an
:exc:`~zhmcclient.ServerAuthError` to be raised (because
userid/password have not been specified, so an automatic re-logon is
not possible).
* Neither `userid`/`password` nor `session_id`: Only operations that do
not require logon, are possible.
Parameters:
host (:term:`string`):
HMC host. For valid formats, see the
:attr:`~zhmcclient.Session.host` property.
Must not be `None`.
userid (:term:`string`):
Userid of the HMC user to be used, or `None`.
password (:term:`string`):
Password of the HMC user to be used, if `userid` was specified.
session_id (:term:`string`):
Session-id to be used for this session, or `None`.
get_password (:term:`callable`):
A password retrieval function, or `None`.
If provided, this function will be called if a password is needed
but not provided. This mechanism can be used for example by command
line interfaces for prompting for the password.
The password retrieval function must follow the interface
defined in :func:`~zhmcclient.get_password_interface`.
retry_timeout_config (:class:`~zhmcclient.RetryTimeoutConfig`):
The retry/timeout configuration for this session for use by any of
its HMC operations, overriding any defaults.
`None` for an attribute in that configuration object means that the
default value will be used for that attribute.
`None` for the entire `retry_timeout_config` parameter means that a
default configuration will be used with the default values for all
of its attributes.
See :ref:`Constants` for the default values.
port (:term:`integer`):
HMC TCP port. Defaults to
:attr:`~zhmcclient._constants.DEFAULT_HMC_PORT`.
For details, see the :attr:`~zhmcclient.Session.port` property.
"""
self._host = host
self._port = port
self._userid = userid
self._password = password
self._get_password = get_password
self._retry_timeout_config = self.default_rt_config.override_with(
retry_timeout_config)
self._base_url = "{scheme}://{host}:{port}".format(
scheme=_HMC_SCHEME,
host=self._host,
port=self._port)
self._headers = copy(_STD_HEADERS) # dict with standard HTTP headers
if session_id is not None:
# Create a logged-on state (same state as in _do_logon())
self._session_id = session_id
self._session = self._new_session(self.retry_timeout_config)
self._headers['X-API-Session'] = session_id
else:
# Create a logged-off state (same state as in _do_logoff())
self._session_id = None
self._session = None
self._time_stats_keeper = TimeStatsKeeper()
[docs] def __repr__(self):
"""
Return a string with the state of this session, for debug purposes.
"""
ret = (
"{classname} at 0x{id:08x} (\n"
" _host = {s._host!r}\n"
" _userid = {s._userid!r}\n"
" _password = '...'\n"
" _get_password = {s._get_password!r}\n"
" _retry_timeout_config = {s._retry_timeout_config!r}\n"
" _base_url = {s._base_url!r}\n"
" _headers = {s._headers!r}\n"
" _session_id = {s._session_id!r}\n"
" _session = {s._session!r}\n"
")".format(classname=self.__class__.__name__, id=id(self), s=self))
return ret
@property
def host(self):
"""
:term:`string`: HMC host, in one of the following formats:
* a short or fully qualified DNS hostname
* a literal (= dotted) IPv4 address
* a literal IPv6 address, formatted as defined in :term:`RFC3986`
with the extensions for zone identifiers as defined in
:term:`RFC6874`, supporting ``-`` (minus) for the delimiter
before the zone ID string, as an additional choice to ``%25``
"""
return self._host
@property
def port(self):
"""
:term:`integer`: HMC TCP port to be used.
"""
return self._port
@property
def userid(self):
"""
:term:`string`: Userid of the HMC user to be used.
If `None`, only operations that do not require authentication, can be
performed.
"""
return self._userid
@property
def get_password(self):
"""
The password retrieval function, or `None`.
The password retrieval function must follow the interface defined in
:func:`~zhmcclient.get_password_interface`.
"""
return self._get_password
@property
def retry_timeout_config(self):
"""
:class:`~zhmcclient.RetryTimeoutConfig`: The effective retry/timeout
configuration for this session for use by any of its HMC operations,
taking into account the defaults and the session-specific overrides.
"""
return self._retry_timeout_config
@property
def base_url(self):
"""
:term:`string`: Base URL of the HMC in this session.
Example:
.. code-block:: text
https://myhmc.acme.com:6794
"""
return self._base_url
@property
def headers(self):
"""
:term:`header dict`: HTTP headers to be used in each request.
Initially, this is the following set of headers:
.. code-block:: text
Content-type: application/json
Accept: */*
When the session is logged on to the HMC, the session token is added
to these headers:
.. code-block:: text
X-API-Session: ...
"""
return self._headers
@property
def time_stats_keeper(self):
"""
The time statistics keeper (for a usage example, see section
:ref:`Time Statistics`).
"""
return self._time_stats_keeper
@property
def session_id(self):
"""
:term:`string`: Session ID for this session, returned by the HMC.
"""
return self._session_id
@property
def session(self):
"""
:term:`string`: :class:`requests.Session` object for this session.
"""
return self._session
[docs] @logged_api_call
def logon(self, verify=False):
"""
Make sure the session is logged on to the HMC.
By default, this method checks whether there is a session-id set
and considers that sufficient for determining that the session is
logged on. The `verify` parameter can be used to verify the validity
of a session-id that is already set, by issuing a dummy operation
("Get Console Properties") to the HMC.
After successful logon to the HMC, the following is stored in this
session object for reuse in subsequent operations:
* the HMC session-id, in order to avoid extra userid authentications,
* a :class:`requests.Session` object, in order to enable connection
pooling. Connection pooling avoids repetitive SSL/TLS handshakes.
Parameters:
verify (bool): If a session-id is already set, verify its validity.
Raises:
:exc:`~zhmcclient.HTTPError`
:exc:`~zhmcclient.ParseError`
:exc:`~zhmcclient.ClientAuthError`
:exc:`~zhmcclient.ServerAuthError`
:exc:`~zhmcclient.ConnectionError`
"""
if not self.is_logon(verify):
self._do_logon()
[docs] @logged_api_call
def logoff(self, verify=False):
"""
Make sure the session is logged off from the HMC.
After successful logoff, the HMC session-id and
:class:`requests.Session` object stored in this object are reset.
Parameters:
verify (bool): If a session-id is already set, verify its validity.
Raises:
:exc:`~zhmcclient.HTTPError`
:exc:`~zhmcclient.ParseError`
:exc:`~zhmcclient.ServerAuthError`
:exc:`~zhmcclient.ConnectionError`
"""
if self.is_logon(verify):
self._do_logoff()
[docs] @logged_api_call
def is_logon(self, verify=False):
"""
Return a boolean indicating whether the session is currently logged on
to the HMC.
By default, this method checks whether there is a session-id set
and considers that sufficient for determining that the session is
logged on. The `verify` parameter can be used to verify the validity
of a session-id that is already set, by issuing a dummy operation
("Get Console Properties") to the HMC.
Parameters:
verify (bool): If a session-id is already set, verify its validity.
"""
if self._session_id is None:
return False
if verify:
try:
self.get('/api/console', logon_required=True)
except ServerAuthError:
return False
return True
def _do_logon(self):
"""
Log on, unconditionally. This can be used to re-logon.
This requires credentials to be provided.
Raises:
:exc:`~zhmcclient.ClientAuthError`
:exc:`~zhmcclient.ServerAuthError`
:exc:`~zhmcclient.ConnectionError`
:exc:`~zhmcclient.ParseError`
:exc:`~zhmcclient.HTTPError`
"""
if self._userid is None:
raise ClientAuthError("Userid is not provided.")
if self._password is None:
if self._get_password:
self._password = self._get_password(self._host, self._userid)
else:
raise ClientAuthError("Password is not provided.")
logon_uri = '/api/sessions'
logon_body = {
'userid': self._userid,
'password': self._password
}
self._headers.pop('X-API-Session', None) # Just in case
self._session = self._new_session(self.retry_timeout_config)
logon_res = self.post(logon_uri, logon_body, logon_required=False)
self._session_id = logon_res['api-session']
self._headers['X-API-Session'] = self._session_id
@staticmethod
def _new_session(retry_timeout_config):
"""
Return a new `requests.Session` object.
"""
retry = requests.packages.urllib3.Retry(
total=None,
connect=retry_timeout_config.connect_retries,
read=retry_timeout_config.read_retries,
method_whitelist=retry_timeout_config.method_whitelist,
redirect=retry_timeout_config.max_redirects)
session = requests.Session()
session.mount('https://',
requests.adapters.HTTPAdapter(max_retries=retry))
session.mount('http://',
requests.adapters.HTTPAdapter(max_retries=retry))
return session
def _do_logoff(self):
"""
Log off, unconditionally.
Raises:
:exc:`~zhmcclient.ServerAuthError`
:exc:`~zhmcclient.ConnectionError`
:exc:`~zhmcclient.ParseError`
:exc:`~zhmcclient.HTTPError`
"""
session_uri = '/api/sessions/this-session'
self.delete(session_uri, logon_required=False)
self._session_id = None
self._session = None
self._headers.pop('X-API-Session', None)
@staticmethod
def _log_http_request(method, url, headers=None, content=None):
"""
Log the HTTP request of an HMC REST API call, at the debug level.
Parameters:
method (:term:`string`): HTTP method name in upper case, e.g. 'GET'
url (:term:`string`): HTTP URL (base URL and operation URI)
headers (iterable): HTTP headers used for the request
content (:term:`string`): HTTP body (aka content) used for the
request
"""
if method == 'POST' and url.endswith('/api/sessions'):
content_dict = json.loads(content)
content_dict['password'] = '********'
content = json.dumps(content)
HMC_LOG.debug("HMC request: %s %s, headers: %r, "
"content(max.1000): %.1000r",
method, url, headers, content)
@staticmethod
def _log_http_response(method, url, status, headers=None, content=None):
"""
Log the HTTP response of an HMC REST API call, at the debug level.
Parameters:
method (:term:`string`): HTTP method name in upper case, e.g. 'GET'
url (:term:`string`): HTTP URL (base URL and operation URI)
status (integer): HTTP status code
headers (iterable): HTTP headers returned in the response
content (:term:`string`): HTTP body (aka content) returned in the
response
"""
HMC_LOG.debug("HMC response: %s %s, status: %s, headers: %r, "
"content(max.1000): %.1000r",
method, url, status, headers, content)
[docs] @logged_api_call
def get(self, uri, logon_required=True):
"""
Perform the HTTP GET method against the resource identified by a URI.
A set of standard HTTP headers is automatically part of the request.
If the HMC session token is expired, this method re-logs on and retries
the operation.
Parameters:
uri (:term:`string`):
Relative URI path of the resource, e.g. "/api/session".
This URI is relative to the base URL of the session (see
the :attr:`~zhmcclient.Session.base_url` property).
Must not be `None`.
logon_required (bool):
Boolean indicating whether the operation requires that the session
is logged on to the HMC. For example, the API version retrieval
operation does not require that.
Returns:
:term:`json object` with the operation result.
Raises:
:exc:`~zhmcclient.HTTPError`
:exc:`~zhmcclient.ParseError`
:exc:`~zhmcclient.ClientAuthError`
:exc:`~zhmcclient.ServerAuthError`
:exc:`~zhmcclient.ConnectionError`
"""
if logon_required:
self.logon()
url = self.base_url + uri
self._log_http_request('GET', url, headers=self.headers)
stats = self.time_stats_keeper.get_stats('get ' + uri)
stats.begin()
req = self._session or requests
req_timeout = (self.retry_timeout_config.connect_timeout,
self.retry_timeout_config.read_timeout)
try:
result = req.get(url, headers=self.headers, verify=False,
timeout=req_timeout)
except requests.exceptions.RequestException as exc:
_handle_request_exc(exc, self.retry_timeout_config)
finally:
stats.end()
self._log_http_response('GET', url,
status=result.status_code,
headers=result.headers,
content=result.content)
if result.status_code == 200:
return _result_object(result)
elif result.status_code == 403:
result_object = _result_object(result)
reason = result_object.get('reason', None)
if reason == 5:
# API session token expired: re-logon and retry
self._do_logon()
return self.get(uri, logon_required)
else:
msg = result_object.get('message', None)
raise ServerAuthError("HTTP authentication failed: {}".
format(msg), HTTPError(result_object))
else:
result_object = _result_object(result)
raise HTTPError(result_object)
[docs] @logged_api_call
def post(self, uri, body=None, logon_required=True,
wait_for_completion=False, operation_timeout=None):
"""
Perform the HTTP POST method against the resource identified by a URI,
using a provided request body.
A set of standard HTTP headers is automatically part of the request.
HMC operations using HTTP POST are either synchronous or asynchronous.
Asynchronous operations return the URI of an asynchronously executing
job that can be queried for status and result.
Examples for synchronous operations:
* With no result: "Logon", "Update CPC Properties"
* With a result: "Create Partition"
Examples for asynchronous operations:
* With no result: "Start Partition"
The `wait_for_completion` parameter of this method can be used to deal
with asynchronous HMC operations in a synchronous way.
If executing the operation reveals that the HMC session token is
expired, this method re-logs on and retries the operation.
The timeout and retry
Parameters:
uri (:term:`string`):
Relative URI path of the resource, e.g. "/api/session".
This URI is relative to the base URL of the session (see the
:attr:`~zhmcclient.Session.base_url` property).
Must not be `None`.
body (:term:`json object`):
JSON object to be used as the HTTP request body (payload).
`None` means the same as an empty dictionary, namely that no HTTP
body is included in the request.
logon_required (bool):
Boolean indicating whether the operation requires that the session
is logged on to the HMC. For example, the "Logon" operation does
not require that.
wait_for_completion (bool):
Boolean controlling whether this method should wait for completion
of the requested asynchronous HMC operation.
A value of `True` will cause an additional entry in the time
statistics to be created that represents the entire asynchronous
operation including the waiting for its completion.
That time statistics entry will have a URI that is the targeted
URI, appended with "+completion".
For synchronous HMC operations, this parameter has no effect on
the operation execution or on the return value of this method, but
it should still be set (or defaulted) to `False` in order to avoid
the additional entry in the time statistics.
operation_timeout (:term:`number`):
Timeout in seconds, when waiting for completion of an asynchronous
operation. The special value 0 means that no timeout is set. `None`
means that the default async operation timeout of the session is
used.
For `wait_for_completion=True`, a
:exc:`~zhmcclient.OperationTimeout` is raised when the timeout
expires.
For `wait_for_completion=False`, this parameter has no effect.
Returns:
: A :term:`json object` or `None` or a :class:`~zhmcclient.Job`
object, as follows:
* For synchronous HMC operations, and for asynchronous HMC
operations with `wait_for_completion=True`:
If this method returns, the HMC operation has completed
successfully (otherwise, an exception is raised).
For asynchronous HMC operations, the associated job has been
deleted.
The return value is the result of the HMC operation as a
:term:`json object`, or `None` if the operation has no result.
See the section in the :term:`HMC API` book about the specific
HMC operation for a description of the members of the returned
JSON object.
* For asynchronous HMC operations with `wait_for_completion=False`:
If this method returns, the asynchronous execution of the HMC
operation has been started successfully as a job on the HMC (if
the operation could not be started, an exception is raised).
The return value is a :class:`~zhmcclient.Job` object
representing the job on the HMC.
Raises:
:exc:`~zhmcclient.HTTPError`
:exc:`~zhmcclient.ParseError`
:exc:`~zhmcclient.ClientAuthError`
:exc:`~zhmcclient.ServerAuthError`
:exc:`~zhmcclient.ConnectionError`
:exc:`~zhmcclient.OperationTimeout`: The timeout expired while
waiting for completion of the asynchronous operation.
:exc:`TypeError`: Body has invalid type.
"""
if logon_required:
self.logon()
url = self.base_url + uri
headers = self.headers.copy() # Standard headers
if body is None:
data = None
elif isinstance(body, dict):
data = json.dumps(body)
# Content-type is already set in standard headers.
elif isinstance(body, six.text_type):
data = body.encode('utf-8')
headers['Content-type'] = 'application/octet-stream'
elif isinstance(body, six.binary_type):
data = body
headers['Content-type'] = 'application/octet-stream'
elif isinstance(body, collections.Iterable):
# For example, open files: open(), io.open()
data = body
headers['Content-type'] = 'application/octet-stream'
else:
raise TypeError("Body has invalid type: {}".format(type(body)))
self._log_http_request('POST', url, headers=headers, content=data)
req = self._session or requests
req_timeout = (self.retry_timeout_config.connect_timeout,
self.retry_timeout_config.read_timeout)
if wait_for_completion:
stats_total = self.time_stats_keeper.get_stats(
'post ' + uri + '+completion')
stats_total.begin()
try:
stats = self.time_stats_keeper.get_stats('post ' + uri)
stats.begin()
try:
if data is None:
result = req.post(url, headers=headers,
verify=False, timeout=req_timeout)
else:
result = req.post(url, data=data, headers=headers,
verify=False, timeout=req_timeout)
except requests.exceptions.RequestException as exc:
_handle_request_exc(exc, self.retry_timeout_config)
finally:
stats.end()
self._log_http_response('POST', url,
status=result.status_code,
headers=result.headers,
content=result.content)
if result.status_code in (200, 201):
return _result_object(result)
elif result.status_code == 204:
# No content
return None
elif result.status_code == 202:
if result.content == '':
# Some operations (e.g. "Restart Console",
# "Shutdown Console" or "Mount Virtual Media") return 202
# with no response content.
return None
else:
# This is the most common case to return 202: An
# asynchronous job has been started.
result_object = _result_object(result)
job_uri = result_object['job-uri']
job = Job(self, job_uri, 'POST', uri)
if wait_for_completion:
return job.wait_for_completion(operation_timeout)
else:
return job
elif result.status_code == 403:
result_object = _result_object(result)
reason = result_object.get('reason', None)
if reason == 5:
# API session token expired: re-logon and retry
self._do_logon()
return self.post(uri, body, logon_required)
else:
msg = result_object.get('message', None)
raise ServerAuthError("HTTP authentication failed: {}".
format(msg),
HTTPError(result_object))
else:
result_object = _result_object(result)
raise HTTPError(result_object)
finally:
if wait_for_completion:
stats_total.end()
[docs] @logged_api_call
def delete(self, uri, logon_required=True):
"""
Perform the HTTP DELETE method against the resource identified by a
URI.
A set of standard HTTP headers is automatically part of the request.
If the HMC session token is expired, this method re-logs on and retries
the operation.
Parameters:
uri (:term:`string`):
Relative URI path of the resource, e.g.
"/api/session/{session-id}".
This URI is relative to the base URL of the session (see
the :attr:`~zhmcclient.Session.base_url` property).
Must not be `None`.
logon_required (bool):
Boolean indicating whether the operation requires that the session
is logged on to the HMC. For example, for the logoff operation, it
does not make sense to first log on.
Raises:
:exc:`~zhmcclient.HTTPError`
:exc:`~zhmcclient.ParseError`
:exc:`~zhmcclient.ClientAuthError`
:exc:`~zhmcclient.ServerAuthError`
:exc:`~zhmcclient.ConnectionError`
"""
if logon_required:
self.logon()
url = self.base_url + uri
self._log_http_request('DELETE', url, headers=self.headers)
stats = self.time_stats_keeper.get_stats('delete ' + uri)
stats.begin()
req = self._session or requests
req_timeout = (self.retry_timeout_config.connect_timeout,
self.retry_timeout_config.read_timeout)
try:
result = req.delete(url, headers=self.headers, verify=False,
timeout=req_timeout)
except requests.exceptions.RequestException as exc:
_handle_request_exc(exc, self.retry_timeout_config)
finally:
stats.end()
self._log_http_response('DELETE', url,
status=result.status_code,
headers=result.headers,
content=result.content)
if result.status_code in (200, 204):
return
elif result.status_code == 403:
result_object = _result_object(result)
reason = result_object.get('reason', None)
if reason == 5:
# API session token expired: re-logon and retry
self._do_logon()
self.delete(uri, logon_required)
return
else:
msg = result_object.get('message', None)
raise ServerAuthError("HTTP authentication failed: {}".
format(msg), HTTPError(result_object))
else:
result_object = _result_object(result)
raise HTTPError(result_object)
[docs] @logged_api_call
def get_notification_topics(self):
"""
The 'Get Notification Topics' operation returns a structure that
describes the JMS notification topics associated with the
API session.
Returns:
: A list with one item for each notification topic. Each item is a
dictionary with the following keys:
* ``"topic-type"`` (string): Topic type, e.g. "job-notification".
* ``"topic-name"`` (string): Topic name; can be used for
subscriptions.
* ``"object-uri"`` (string): When topic-type is
"os-message-notification", this item is the canonical URI path
of the Partition for which this topic exists.
This field does not exist for the other topic types.
* ``"include-refresh-messages"`` (bool): When the topic-type is
"os-message-notification", this item indicates whether refresh
operating system messages will be sent on this topic.
"""
topics_uri = '/api/sessions/operations/get-notification-topics'
response = self.get(topics_uri)
return response['topics']
[docs]class Job(object):
"""
A job on the HMC that performs an asynchronous HMC operation.
This class supports checking the job for completion, and waiting for job
completion.
"""
def __init__(self, session, uri, op_method, op_uri):
"""
Parameters:
session (:class:`~zhmcclient.Session`):
Session with the HMC.
Must not be `None`.
uri (:term:`string`):
Canonical URI of the job on the HMC.
Must not be `None`.
Example: ``"/api/jobs/{job-id}"``
op_method (:term:`string`):
Name of the HTTP method of the operation that is executing
asynchronously on the HMC.
Must not be `None`.
Example: ``"POST"``
op_uri (:term:`string`):
Canonical URI of the operation that is executing asynchronously on
the HMC.
Must not be `None`.
Example: ``"/api/partitions/{partition-id}/stop"``
"""
self._session = session
self._uri = uri
self._op_method = op_method
self._op_uri = op_uri
@property
def session(self):
"""
:class:`~zhmcclient.Session`: Session with the HMC.
"""
return self._session
@property
def uri(self):
"""
:term:`string`: Canonical URI of the job on the HMC.
Example: ``"/api/jobs/{job-id}"``
"""
return self._uri
@property
def op_method(self):
"""
:term:`string`: Name of the HTTP method of the operation that is
executing asynchronously on the HMC.
Example: ``"POST"``
"""
return self._op_method
@property
def op_uri(self):
"""
:term:`string`: Canonical URI of the operation that is executing
asynchronously on the HMC.
Example: ``"/api/partitions/{partition-id}/stop"``
"""
return self._op_uri
[docs] @logged_api_call
def check_for_completion(self):
"""
Check once for completion of the job and return completion status and
result if it has completed.
If the job completed in error, an :exc:`~zhmcclient.HTTPError`
exception is raised.
Returns:
: A tuple (status, result) with:
* status (:term:`string`): Completion status of the job, as
returned in the ``status`` field of the response body of the
"Query Job Status" HMC operation, as follows:
* ``"complete"``: Job completed (successfully).
* any other value: Job is not yet complete.
* result (:term:`json object` or `None`): `None` for incomplete
jobs. For completed jobs, the result of the original asynchronous
operation that was performed by the job, from the ``job-results``
field of the response body of the "Query Job Status" HMC
operation. That result is a :term:`json object` as described
for the asynchronous operation, or `None` if the operation has no
result.
Raises:
:exc:`~zhmcclient.HTTPError`: The job completed in error, or the job
status cannot be retrieved, or the job cannot be deleted.
:exc:`~zhmcclient.ParseError`
:exc:`~zhmcclient.ClientAuthError`
:exc:`~zhmcclient.ServerAuthError`
:exc:`~zhmcclient.ConnectionError`
"""
job_result_obj = self.session.get(self.uri)
job_status = job_result_obj['status']
if job_status == 'complete':
self.session.delete(self.uri)
op_status_code = job_result_obj['job-status-code']
if op_status_code in (200, 201):
op_result_obj = job_result_obj.get('job-results', None)
elif op_status_code == 204:
# No content
op_result_obj = None
else:
error_result_obj = job_result_obj.get('job-results', None)
if not error_result_obj:
message = None
elif 'message' in error_result_obj:
message = error_result_obj['message']
elif 'error' in error_result_obj:
message = error_result_obj['error']
else:
message = None
error_obj = {
'http-status': op_status_code,
'reason': job_result_obj['job-reason-code'],
'message': message,
'request-method': self.op_method,
'request-uri': self.op_uri,
}
raise HTTPError(error_obj)
else:
op_result_obj = None
return job_status, op_result_obj
[docs] @logged_api_call
def wait_for_completion(self, operation_timeout=None):
"""
Wait for completion of the job, then delete the job on the HMC and
return the result of the original asynchronous HMC operation, if it
completed successfully.
If the job completed in error, an :exc:`~zhmcclient.HTTPError`
exception is raised.
Parameters:
operation_timeout (:term:`number`):
Timeout in seconds, when waiting for completion of the job. The
special value 0 means that no timeout is set. `None` means that the
default async operation timeout of the session is used.
If the timeout expires, a :exc:`~zhmcclient.OperationTimeout`
is raised.
This method gives completion of the job priority over strictly
achieving the timeout. This may cause a slightly longer duration of
the method than prescribed by the timeout.
Returns:
:term:`json object` or `None`:
The result of the original asynchronous operation that was
performed by the job, from the ``job-results`` field of the
response body of the "Query Job Status" HMC operation. That result
is a :term:`json object` as described for the asynchronous
operation, or `None` if the operation has no result.
Raises:
:exc:`~zhmcclient.HTTPError`: The job completed in error, or the job
status cannot be retrieved, or the job cannot be deleted.
:exc:`~zhmcclient.ParseError`
:exc:`~zhmcclient.ClientAuthError`
:exc:`~zhmcclient.ServerAuthError`
:exc:`~zhmcclient.ConnectionError`
:exc:`~zhmcclient.OperationTimeout`: The timeout expired while
waiting for job completion.
"""
if operation_timeout is None:
operation_timeout = \
self.session.retry_timeout_config.operation_timeout
if operation_timeout > 0:
start_time = time.time()
while True:
job_status, op_result_obj = self.check_for_completion()
# We give completion of status priority over strictly achieving
# the timeout, so we check status first. This may cause a longer
# duration of the method than prescribed by the timeout.
if job_status == 'complete':
return op_result_obj
if operation_timeout > 0:
current_time = time.time()
if current_time > start_time + operation_timeout:
raise OperationTimeout(
"Waiting for completion of job {} timed out "
"(operation timeout: {} s)".
format(self.uri, operation_timeout),
operation_timeout)
time.sleep(1) # Avoid hot spin loop
def _text_repr(text, max_len=1000):
"""
Return the input text as a Python string representation (i.e. using repr())
that is limited to a maximum length.
"""
if text is None:
text_repr = 'None'
elif len(text) > max_len:
text_repr = repr(text[0:max_len]) + '...'
else:
text_repr = repr(text)
return text_repr
def _result_object(result):
"""
Return the JSON payload in the HTTP response as a Python dict.
Parameters:
result (requests.Response): HTTP response object.
Raises:
zhmcclient.ParseError: Error parsing the returned JSON.
"""
content_type = result.headers.get('content-type', None)
if content_type is None or content_type.startswith('application/json'):
# This function is only called when there is content expected.
# Therefore, a response without content will result in a ParseError.
try:
return result.json(object_pairs_hook=OrderedDict)
except ValueError as exc:
raise ParseError(
"JSON parse error in HTTP response: {}. "
"HTTP request: {} {}. "
"Response status {}. "
"Response content-type: {!r}. "
"Content (max.1000, decoded using {}): {}".
format(exc.args[0],
result.request.method, result.request.url,
result.status_code, content_type, result.encoding,
_text_repr(result.text, 1000)))
elif content_type.startswith('text/html'):
# We are in some error situation. The HMC returns HTML content
# for some 5xx status codes. We try to deal with it somehow,
# but we are not going as far as real HTML parsing.
m = re.search(r'charset=([^;,]+)', content_type)
if m:
encoding = m.group(1) # e.g. RFC "ISO-8859-1"
else:
encoding = 'utf-8'
try:
html_uni = result.content.decode(encoding)
except LookupError:
html_uni = result.content.decode()
# We convert to one line to be regexp-friendly.
html_oneline = html_uni.replace('\r\n', '\\n').replace('\r', '\\n').\
replace('\n', '\\n')
# Check for some well-known errors:
if re.search(r'javax\.servlet\.ServletException: '
r'Web Services are not enabled\.', html_oneline):
html_title = "Console Configuration Error"
html_details = "Web Services API is not enabled on the HMC."
html_reason = HTML_REASON_WEB_SERVICES_DISABLED
else:
m = re.search(
r'<title>([^<]*)</title>.*'
r'<h2>Details:</h2>(.*)(<hr size="1" noshade>)?</body>',
html_oneline)
if m:
html_title = m.group(1)
# Spend a reasonable effort to make the HTML readable:
html_details = m.group(2).replace('<p>', '\\n').\
replace('<br>', '\\n').replace('\\n\\n', '\\n').strip()
else:
html_title = "Console Internal Error"
html_details = "Response body: {!r}".format(html_uni)
html_reason = HTML_REASON_OTHER
message = "{}: {}".format(html_title, html_details)
# We create a minimal JSON error object (to the extent we use it
# when processing it):
result_obj = {
'http-status': result.status_code,
'reason': html_reason,
'message': message,
'request-uri': result.request.url,
'request-method': result.request.method,
}
return result_obj
elif content_type.startswith('application/vnd.ibm-z-zmanager-metrics'):
content_bytes = result.content
assert isinstance(content_bytes, six.binary_type)
return content_bytes.decode('utf-8') # as a unicode object
else:
raise ParseError(
"Unknown content type in HTTP response: {}. "
"HTTP request: {} {}. "
"Response status {}. "
"Response content-type: {!r}. "
"Content (max.1000, decoded using {}): {}".
format(content_type,
result.request.method, result.request.url,
result.status_code, content_type, result.encoding,
_text_repr(result.text, 1000)))