1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
# 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.
import ast
import six
from oslo_log import log as logging
import pypowervm.const as c
from pypowervm import exceptions as pexc
from pypowervm.wrappers import job
from pypowervm.wrappers.virtual_io_server import VIOS
LOG = logging.getLogger(__name__)
_JOB_NAME = "ISCSIDiscovery"
_ISCSI_REMOVE = "ISCSIRemove"
class ISCSIStatus(object):
"""ISCSI status codes."""
ISCSI_SUCCESS = '0'
ISCSI_ERR = '1'
ISCSI_ERR_SESS_NOT_FOUND = '3'
ISCSI_ERR_LOGIN = '5'
ISCSI_ERR_INVAL = '7'
ISCSI_ERR_TRANS_TIMEOUT = '8'
ISCSI_ERR_INTERNAL = '9'
ISCSI_ERR_LOGOUT = '10'
ISCSI_ERR_SESS_EXISTS = '15'
ISCSI_ERR_NO_OBJS_FOUND = '21'
ISCSI_ERR_HOST_NOT_FOUND = '23'
ISCSI_ERR_LOGIN_AUTH_FAILED = '24'
ISCSI_COMMAND_NOT_FOUND = '127'
_GOOD_DISCOVERY_STATUSES = [ISCSIStatus.ISCSI_SUCCESS,
ISCSIStatus.ISCSI_ERR_SESS_EXISTS]
_GOOD_REMOVE_STATUSES = [ISCSIStatus.ISCSI_SUCCESS,
ISCSIStatus.ISCSI_ERR_NO_OBJS_FOUND]
def _find_dev_by_iqn(cmd_output, iqn, host_ip):
"""Find device name and udid corresponding to an IQN
The iqn parameter can be a singular iqn or a list of iqns. If a list of
iqns is given, we can return the device name and udid for any of the iqns,
since this implies a multipath device which would have the same return
values for all iqns.
:param cmd_output: A list of "iqn device_name udid"
:param host_ip: The portal or list of portals for the iscsi target. A
portal looks like ip:port.
:param iqn: The IQN (iSCSI Qualified Name) or list of IQNs for the created
volume on the target (e.g. iqn.2016-06.world.srv:target00).
:return: The device name of the created volume.
:return: The UniqueDeviceId of the create volume.
"""
for dev in cmd_output:
try:
outiqn, outname, udid = dev.split()
if ((isinstance(iqn, six.string_types) and outiqn == iqn) or
outiqn in iqn):
return outname, udid
except ValueError:
LOG.warning("Invalid device output: %(dev)s" % {'dev': dev})
continue
LOG.error("Expected IQN %(IQN)s not found on iscsi target %(host_ip)s" %
{'IQN': iqn, 'host_ip': host_ip})
return None, None
def _add_parameter(job_parms, name, value):
"""Adds key/value to job parameter list
Checks for null value and does any conversion needed for value to be a
string
:param job_parms: List of parameters for the job which will be updated by
this method.
:param key: Parameter name
:param value: Parameter value
"""
if value or value == 0 or value is False:
if isinstance(value, (six.string_types, int, bool)):
value = six.text_type(value)
else:
value = '[' + ','.join([str(val) for val in value]) + ']'
job_parms.append(job.Job.create_job_parameter(name, value))
def discover_iscsi(adapter, host_ip, user, password, iqn, vios_uuid,
transport_type=None, lunid=None, iface_name=None, auth=None,
discovery_auth=None, discovery_username=None,
discovery_password=None, multipath=False):
"""Runs iscsi discovery and login job
:param adapter: pypowervm adapter
:param host_ip: The portal or list of portals for the iscsi target. A
portal looks like ip:port.
:param user: The username needed for authentication.
:param password: The password needed for authentication.
:param iqn: The IQN (iSCSI Qualified Name) or list of IQNs for the created
volume on the target (e.g. iqn.2016-06.world.srv:target00).
:param vios_uuid: The uuid of the VIOS (VIOS must be a Novalink VIOS type).
:param transport_type: (Deprecated) Transport type of the volume to be
connected. Use iface_name instead.
:param lunid: Target LUN ID or list of LUN IDs for the volume.
:param iface_name: Iscsi iface name to use for the connection.
:param auth: Authentication type
:param discovery_auth: Discovery authentication type.
:param discovery_username: The username needed for discovery
authentication.
:param discovery_password: The password needed for discovery
authentication.
:param multipath: Whether the connection is multipath or not.
:return: The device name of the created volume.
:return: The UniqueDeviceId of the create volume.
:raise: ISCSIDiscoveryFailed in case of bad return code.
:raise: JobRequestFailed in case of failure.
"""
resp = adapter.read(VIOS.schema_type, vios_uuid,
suffix_type=c.SUFFIX_TYPE_DO, suffix_parm=(_JOB_NAME))
job_wrapper = job.Job.wrap(resp)
# Create job parameters
job_parms = []
_add_parameter(job_parms, 'auth', auth)
_add_parameter(job_parms, 'user', user)
_add_parameter(job_parms, 'password', password)
_add_parameter(job_parms, 'ifaceName', iface_name or transport_type)
_add_parameter(job_parms, 'targetIQN', iqn)
_add_parameter(job_parms, 'hostIP', host_ip)
_add_parameter(job_parms, 'targetLUN', lunid)
_add_parameter(job_parms, 'multipath', multipath)
if multipath:
_add_parameter(job_parms, 'discoveryAuth', discovery_auth)
_add_parameter(job_parms, 'discoveryUser',
discovery_username)
_add_parameter(job_parms, 'discoveryPassword',
discovery_password)
try:
job_wrapper.run_job(vios_uuid, job_parms=job_parms, timeout=120)
except pexc.JobRequestFailed:
results = job_wrapper.get_job_results_as_dict()
# Ignore if the command is performed on NotSupported AIX VIOS
if results.get('RETURN_CODE') != ISCSIStatus.ISCSI_COMMAND_NOT_FOUND:
raise
return None, None
results = job_wrapper.get_job_results_as_dict()
# RETURN_CODE: for iscsiadm status
status = results.get('RETURN_CODE')
if status not in _GOOD_DISCOVERY_STATUSES:
raise pexc.ISCSIDiscoveryFailed(vios_uuid=vios_uuid, status=status)
# DEV_OUTPUT: ["IQN1 dev1 udid", "IQN2 dev2 udid"]
output = ast.literal_eval(results.get('DEV_OUTPUT'))
# Find dev corresponding to given IQN
return _find_dev_by_iqn(output, iqn, host_ip)
def discover_iscsi_initiator(adapter, vios_uuid):
"""Discovers the initiator name.
:param adapter: pypowervm adapter
:param vios_uuid: The uuid of the VIOS (VIOS must be a Novalink VIOS type).
:return: The iscsi initiator name.
:raise: ISCSIDiscoveryFailed in case of failure.
"""
resp = adapter.read(VIOS.schema_type, vios_uuid,
suffix_type=c.SUFFIX_TYPE_DO, suffix_parm=(_JOB_NAME))
job_wrapper = job.Job.wrap(resp)
job_wrapper.run_job(vios_uuid, timeout=120)
results = job_wrapper.get_job_results_as_dict()
# process iscsi return code.
status = results.get('RETURN_CODE')
if status not in _GOOD_DISCOVERY_STATUSES:
raise pexc.ISCSIDiscoveryFailed(vios_uuid=vios_uuid, status=status)
# InitiatorName: iqn.2010-10.org.openstack:volume-4a75e9f7-dfa3
return results.get('InitiatorName')
def remove_iscsi(adapter, targetIQN, vios_uuid, iface_name=None, lun=None,
portal=None, multipath=False):
"""Remove an iSCSI lun from a session.
If the last lun was removed from the session, also logout of the session.
The iSCSI volume with the given targetIQN must not have any mappings from
the VIOS to a client when this is called.
:param adapter: pypowervm adapter
:param targetIQN: The IQN (iSCSI Qualified Name) or list of IQNs for the
created volume on the target.
(e.g. iqn.2016-06.world.srv:target00)
:param vios_uuid: The uuid of the VIOS (VIOS must be a Novalink VIOS type).
:param iface_name: Name of the iface used for the connection.
:param lun: The lun or list of luns to be removed.
:param portal: The portal or list of portals associated with the created
volume (ip:port).
:param multipath: Whether the connection is multipath or not.
:raise: ISCSIRemoveFailed in case of bad return code.
:raise: JobRequestFailed in case of failure.
"""
resp = adapter.read(VIOS.schema_type, vios_uuid,
suffix_type=c.SUFFIX_TYPE_DO,
suffix_parm=(_ISCSI_REMOVE))
job_wrapper = job.Job.wrap(resp)
job_parms = []
_add_parameter(job_parms, 'ifaceName', iface_name)
_add_parameter(job_parms, 'targetIQN', targetIQN)
_add_parameter(job_parms, 'targetPORTAL', portal)
_add_parameter(job_parms, 'targetLUN', lun)
_add_parameter(job_parms, 'multipath', multipath)
try:
job_wrapper.run_job(vios_uuid, job_parms=job_parms, timeout=120)
except pexc.JobRequestFailed:
results = job_wrapper.get_job_results_as_dict()
# Ignore if the command is performed on NotSupported AIX VIOS
if results.get('RETURN_CODE') != ISCSIStatus.ISCSI_COMMAND_NOT_FOUND:
raise
return
results = job_wrapper.get_job_results_as_dict()
status = results.get('RETURN_CODE')
if status not in _GOOD_REMOVE_STATUSES:
raise pexc.ISCSIRemoveFailed(vios_uuid=vios_uuid, status=status)
|
