pluginconf.d/sim.conf 0000644 00000000040 14720727560 0010575 0 ustar 00 require-root-privilege = false;
lsmd.conf 0000644 00000000044 14720727560 0006362 0 ustar 00 allow-plugin-root-privilege = true;
__init__.py 0000644 00000002462 14757650541 0006677 0 ustar 00 # Copyright (C) 2011-2016 Red Hat, Inc.
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; If not, see .
from lsm.version import VERSION
from lsm._common import error, info, LsmError, ErrorNumber, \
JobStatus, uri_parse, md5, Proxy, size_bytes_2_size_human, \
common_urllib2_error_handler, size_human_2_size_bytes, int_div
from lsm._local_disk import LocalDisk
from lsm._data import (Disk, Volume, Pool, System, FileSystem, FsSnapshot,
NfsExport, BlockRange, AccessGroup, TargetPort,
Capabilities, Battery)
from lsm._iplugin import IPlugin, IStorageAreaNetwork, \
INetworkAttachedStorage, INfs
from lsm._client import Client
from lsm._pluginrunner import PluginRunner, search_property
__all__ = []
_common.pyc 0000644 00000042405 14757650541 0006733 0 ustar 00
-P`c @ s d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z y d d l m Z Wn! e k
r d d l m Z n Xd d l
Z
y* d d l m Z m
Z
d d l m Z Wn7 e k
r d d l m Z m
Z
d d l m Z n Xd d l Z d d l Z d d l Z d d l Z d d l Z e d d Z d Z d e f d YZ d Z e Z i d
d 6dR d 6dS d 6dT d 6dU d 6dV d 6dW d 6dX d 6dY d 6dZ d 6d[ d 6d\ d 6d] d 6d^ d 6d_ d" 6d` d# 6da d$ 6db d& 6dc d( 6dd d) 6de d* 6df d, 6dg d. 6dh d/ 6di d0 6Z d, d& d d d d g Z e d1 Z! d2 Z" d3 Z# d d d4 Z$ d5 Z% d6 Z& d7 Z' d8 Z( d9 Z) d: Z* d; Z+ d< e, f d= YZ- e d> d? d@ e dA d? dB e dC d? dD dE e, f dF Y Z. d d dG Z/ dH Z0 dI e f dJ YZ1 dK e f dL YZ2 dM Z3 dN Z4 dO e j5 f dP YZ6 e7 dQ k re j8 n d S(j iN( t Sequence( t URLErrort HTTPError( t urlparsec s_ d f d } f d } t | | r: | n d d | f d } | S( s
Creates the get/set properties for the given name. It assumes that the
actual attribute is '_' + name
TODO: Expand this with domain validation to ensure the values are correct.
t _c s
t | S( N( t getattr( t self( t attribute_name( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt getter9 s c s t | | d S( N( t setattr( R t value( R ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt setter< s c s t | | S( N( R ( t cls( t namet prop( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt decoratorA s N( t propertyt None( R
t allow_sett docR R R ( ( R R
R s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt default_property0 s
!c C s t | t r* t t j t | n t | t r t | } d | k r d | k rr t t j d n d | k r t t j d q n t d t
j t t j | n yA t
j r t | t
j r t t j d t | q n Wn t k
rn Xt j rGt | t rGt t j t | n t | t j rtt t j t | n t
j } t d | t t j d t t | | d S(
Ns
urlopen errors Errno 111s Connection refuseds Errno 113s Host is downs Unexpected network error:
s SSL Certificate error (%s)s Unexpected exception:
s Unexpected exception (TYPE= %s)( t
isinstanceR t LsmErrort ErrorNumbert PLUGIN_AUTH_FAILEDt strR t NETWORK_CONNREFUSEDt NETWORK_HOSTDOWNt errort tracebackt
format_exct
NETWORK_ERRORt sslt CertificateErrort AttributeErrort sixt PY3t ConnectionErrort sockett
PLUGIN_BUGt type( t expt desct stack_trace( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt common_urllib2_error_handlerH s:
t Proxyc B s, e Z d Z d d Z d Z d Z RS( sQ
Used to provide an unambiguous error when a feature is not implemented.
c C s
| | _ d S( s<
Constructor which takes an object to wrap.
N( t proxied_obj( R t obj( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt __init__{ s c C s; t | j | r% t j | j | St t j d d S( sJ
Called each time an attribute is requested of the object
s Unsupported operationN( t hasattrR. t functoolst partialt _presentR R t
NO_SUPPORT( R R
( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt __getattr__ s c O s t | j | | | S( sQ
Method which is called to invoke the actual method of interest.
( R R. ( R t _proxy_method_namet argst kwargs( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyR4 s N( t __name__t
__module__t __doc__R R0 R6 R4 ( ( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyR- s s
s /var/run/lsm/ipci t Bi i
t KiBi t KBt Kt ki t MiBi t MBt Mt mi t GiBi t GBt Gt gi( t TiBi t TBt Tt ti2 t PiBi t PBt Pt pi< t EiBi t EBt Et ec C sp d } | rh x< t D]4 } | t | k r | t t | :} | } Pq q W| sZ d } n d | | f S| Sd S( s
Convert size in bytes to human readable size
The return string will follow IEC binary prefixes, e.g. '1.9 KiB'
For size less than 1024, we do nothing but return the int we get.
TODO: Need a expect to handle when size is not a int. int() might do.
R= s %.2f %sN( R t SIZE_CONS_CHK_LSTt SIZE_CONSt float( t sizet humant unitst key_name( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt sh s
c C s
t | t S( s
Convert integer size in bytes to human readable size.
We are following rules of IEC binary prefixes on size:
http://en.wikipedia.org/wiki/Gibibyte
The biggest of unit this function supported is PiB.
The precision is 2 which means you will get '1.99 KiB'
( R] t True( RY ( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt size_bytes_2_size_human s c C s t j d t j } | j | } d } | r | j d } | j d } | s^ t | S| j } | j d d } | t k r t | t | } q n t | S( s
Convert human readable size string into integer size in bytes.
Following rules of IEC binary prefixes on size:
http://en.wikipedia.org/wiki/Gibibyte
Supported input size_human in these formats:
'1.9KiB' # int(1024*1.9)
'1 KiB' # 2**10
'1B' # 1
'2K' # 2*(2**10), treated as '2KiB'
'2k' # 2*(2**10), treated as '2KiB'
'2KB' # 2*(10**3)
s
^
([0-9\.]+) # 1: number
[ \t]* # might have space between number and unit
([a-zA-Z]*) # 2: units
$
i i i t IBt iB(
t ret compilet Xt matcht groupt intt uppert replaceRW RX ( t
size_humant regex_size_humant regex_matcht
size_bytest numberR[ ( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt size_human_2_size_bytes s
c C si y3i } t | } | j r. | j | d | j d D]- } t | r t j | | d | q q Wd S( s
If a message includes new lines we will create multiple syslog
entries so that the message is readable. Otherwise it isn't very readable.
Hopefully we won't be logging much :-)
s
s : N( R t lent syslog( t levelt prgt msgt l( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt post_msgz s c G s0 t t j t j j t j d t | d S( Ni ( R R t LOG_ERRt osR t basenamet syst argvR ( R ( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyR s c G s9 t r5 t t j t j j t j d t | n d S( Ni (
t LOG_VERBOSER R t LOG_INFOR R R R R R ( R ( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt info s t SocketEOFc B s e Z d Z RS( sL
Exception class to indicate when we read zero bytes from a socket.
( R: R; R< ( ( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyR s t codeR s
Error codeR s
Error messaget datas Optional error dataR c B s e Z d d Z d Z RS( c O s2 t j | | | | | _ | | _ | | _ d S( s,
Class represents an error.
N( t ExceptionR0 t _codet _msgt _data( R R t messageR R8 R9 ( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyR0 s c C sV t j | j } | j d k rA | j rA d | | j | j f Sd | | j f Sd S( Ns %s: %s Data: %ss %s: %s ( R t error_number_to_strR R R R ( R t error_no_str( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt __str__ s
N( R: R; R R0 R ( ( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyR s c C s' i | d 6| d 6| d 6| d 6| d 6S( sC
Used for gathering additional information about an error.
t domainR t exceptiont debugt
debug_data( ( R R R R R ( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt addl_error_data s c C s | j d } d j | d } t | ra t | } x? | d D] } t | | } qE Wn t d } t | | } | S( sn
Given a class name it returns the class, caller will then
need to run the constructor to create.
t .ii t __main__( R R R t
__import__R ( t
class_namet partst moduleRE t comp( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt get_class s R c B s" e Z d Z d Z d Z d Z d Z d Z d Z d Z d Z
d Z d
Z d Z
d Z d
Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z! d Z" d! Z# d" Z$ d# Z% d$ Z& d% Z' d& Z( d' Z) d( Z* d) Z+ d* Z, e- Z. e/ d+ Z0 RS(, i i i i i i i
i2 i4 ie i} i i i i i i i i i i i i i i i i i i i i, i- i3 i7 i^ i i i i i i i i c C sI x> t t j j D]' } t j | | k r d | | f Sq Wd | S( Ns %s(%d)s UNKNOWN_ERROR_NUMBER(%d)( t listR t _LOCALSt keys( t error_not error_str( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyR s (1 R: R; t OKt LIB_BUGR' t JOB_STARTEDt TIMEOUTt DAEMON_NOT_RUNNINGt PERMISSION_DENIEDt
NAME_CONFLICTt EXISTS_INITIATORRx t NO_STATE_CHANGER R R t NO_MEMORYR5 t IS_MASKEDt HAS_CHILD_DEPENDENCYt NOT_FOUND_ACCESS_GROUPt NOT_FOUND_FSt
NOT_FOUND_JOBt NOT_FOUND_POOLt NOT_FOUND_FS_SSt NOT_FOUND_VOLUMEt NOT_FOUND_NFS_EXPORTt NOT_FOUND_SYSTEMt NOT_FOUND_DISKt NOT_LICENSEDt NO_SUPPORT_ONLINE_CHANGEt NO_SUPPORT_OFFLINE_CHANGER t PLUGIN_IPC_FAILt PLUGIN_SOCKET_PERMISSIONt PLUGIN_NOT_EXISTt NOT_ENOUGH_SPACEt TRANSPORT_COMMUNICATIONt TRANSPORT_SERIALIZATIONt TRANSPORT_INVALID_ARGt LAST_INIT_IN_ACCESS_GROUPt UNSUPPORTED_SEARCH_KEYt EMPTY_ACCESS_GROUPt POOL_NOT_READYt
DISK_NOT_FREEt localsR t staticmethodR ( ( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyR sZ t JobStatusc B s e Z d Z d Z d Z RS( i i i ( R: R; t
INPROGRESSt COMPLETEt ERROR( ( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyR s c
C sQ t | t r t | t sC t d | t t | f n t | d k r} xU | D] } t | | d | q\ WqMx t | | D] \ } } t | | | q Wn | t | k rM| d k rMt | t j
r t | t j
r d St j | s t
t | | rMt d | t | t t | f qMn d S( Ns6 %s call is returning a %s, but is expecting a sequencei i s %s call expected: %s got: %s ( R R t TypeErrorR R( R t type_comparet zipR R# t string_typest inspectt isclasst
issubclass( t method_namet exp_typet act_valt avR) t act( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyR s$
c s f d } | S( s4
Decorator function that allows us to ensure that we are getting the
correct types back from a function/method call.
Note: This is normally frowned upon by the python community, but this API
needs to be language agnostic, so making sure we have the correct types
is quite important.
c s% t j f d } | S( Nc s | | } t d k rz t | t k rd t d j t t | f n t j | n, t d k r t j d | n | S( Ni s. %s call expected %d return values, actual = %di ( R R R: R ( R8 R9 R ( t funct types( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt innerH s %( R2 t wraps( R R ( R ( R s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt outerG s !( ( R R ( ( R s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt return_requires> s t
TestCommonc B s# e Z d Z d Z d Z RS( c C s d S( N( ( R ( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt setUp` s c C s y
t Wn) t k
r8 } | j t | t n Xy t d d d WnG t k
r } | j | j d k o | j d k o | j d k n Xt d d d d d } | j | d d k o| d d k o| d d k o| d d k o| d d k d S( Ni
t Messaget DataR R R R R ( R t
assertTrueR R R R R R ( R RU t ed( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt test_simplec s
$ &c C s d S( N( ( R ( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt tearDownw s ( R: R; R R R ( ( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyR _ s R i i i i i i@B i i i @i ʚ;i @i @I I I I I I Ƥ~ I I I I d
I I (9 R R t unittestRb R R t collections.abcR t ImportErrort collectionsR t urllib.errorR R t urllib.parseR t urllib2R2 R R# R R& R^ R R R, t objectR- t UDS_PATHR RW RV t FalseR] R_ Ro R Rw R R R R R R R R R R R R R R R t TestCaseR R: t main( ( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt s
+)
(1
Q ! lsmcli/data_display.pyc 0000644 00000073525 14757650541 0011234 0 ustar 00
/P`c @ s* d d l Z d d l m Z d d l m Z m Z m Z m Z m Z m Z m Z m
Z
m Z m Z m
Z
m Z m Z m Z y d d l m Z Wn! e k
r d d l m Z n Xd Z d Z d Z d Z d Z i d
e j 6d e j 6d e j 6d
e j 6d e j 6d e j 6Z d Z! i d e j" 6d e j# 6Z$ d Z% i
d
e j 6d e j 6d e j 6d
e j 6d e j 6d e j& 6d e j' 6d e j( 6d e j) 6d e j* 6Z+ d Z, i d e j- 6d e j. 6d e j/ 6d e j0 6d e j1 6d e j2 6d e j3 6Z4 i d! e j5 6d" e j6 6Z7 d# Z8 d$ Z9 i d% e
j: 6d& e
j; 6d' e
j< 6d( e
j= 6Z> d) Z? i d* e
j@ 6d+ e
jA 6ZB d, ZC i d- e
jD 6d. e
jE 6d/ e
jF 6d0 e
jG 6d( e
jH 6ZI d1 ZJ i
d( e jK 6d e jL 6d2 e jM 6d3 e jN 6d4 e jO 6d5 e jP 6d6 e jQ 6d7 e jR 6d8 e jS 6d9 e jT 6d: e jU 6d; e jV 6d< e jW 6ZX d= ZY i d
e j 6d e j 6d e j 6d e j 6d e j 6d> e jZ 6d? e j[ 6d@ e j\ 6d e j& 6d e j) 6dA e j] 6dB e j^ 6dC e j_ 6dD e j` 6Za dE Zb i d
e jc 6d e jd 6dF e je 6dG e jf 6dH e jg 6Zh dI Zi dJ Zj i d e jL 6d5 e jP 6dK e jk 6dG e jl 6Zm dL Zn dM Zo dN Zp dO Zq i d
e jK 6d e jL 6dP e jr 6dQ e js 6Zt dR Zu i d
e j 6d e j 6d e j 6dS e jv 6dT e jw 6dU e jx 6d
e j 6d e j 6Zy dV Zz i d
e j{ 6dW e j| 6dX e j} 6dY e j~ 6dZ e j 6d[ e j 6d\ e j 6Z d] Z d^ Z d_ e f d` YZ da e f db YZ dc e f dd YZ de e f df YZ dg e f dh YZ di e f dj YZ dk e f dl YZ d S(m iN( t datetime( t size_bytes_2_size_humant LsmErrort ErrorNumbert Batteryt Systemt Poolt Diskt Volumet AccessGroupt
FileSystemt
FsSnapshott NfsExportt
TargetPortt LocalDisk( t OrderedDictt ,c C s\ y7 t j j t | t j j d t j j Wn t k
rW t j d n Xd S( Ns
i ( t syst stdoutt writet strt flusht IOErrort exit( t msg( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt out' s
c C s g } t | } x8 t | j D]$ } | | @r% | j | | q% q% W| d k ry t | d k ry d t | St j | S( Ni s Unknown(%s)( t intt listt keyst appendt lent hext BIT_MAP_STRING_SPLITTERt join( t bit_mapt conv_dictt rct cur_enum( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt _bit_map_to_str0 s
c C s4 t | } | t | j k r, | | Sd | S( Ns Unknown(%d)( R R R ( t int_typeR# ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt _enum_type_to_str< s c C sw g t | j D]* \ } } | j | j k r | ^ q } t | d k r] | d St t j d | d S( Ni s Failed to convert %s to lsm type( R t itemst lowerR R R t INVALID_ARGUMENT( t type_strR# t kt vR ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt _str_to_enumD s $ t Unknownt OKt Errort Degradeds Predictive failuret Otherc C s
t | t S( N( R& t _SYSTEM_STATUS_CONV( t
system_status( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt system_status_to_strW s s HW RAIDt HBAc C s t j | d S( Nt ( t _SYSTEM_MODE_CONVt get( t system_mode( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt system_mode_to_stra s t Stoppedt Reconstructingt Verifyingt Initializingt Growingc C s
t | t S( N( R& t _POOL_STATUS_CONV( t pool_status( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt pool_status_to_strs s t POOLt VOLUMEt VOLUME_THINt VOLUME_FULLt FSt SYSTEM_RESERVEDt DELTAs Volume Grows
Volume Shrinkc C s
t | t S( N( R& t _POOL_ELEMENT_TYPE_CONV( t element_type( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt pool_element_type_to_str s c C s
t | t S( N( R& t _POOL_UNSUPPORTED_ACTION_CONV( t unsupported_actions( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt pool_unsupported_actions_to_str s t DEFAULTt FULLt THINt UNKNOWNc C s
t | t S( N( R/ t _VOL_PROVISION_CONV( t vol_provision_str( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt vol_provision_str_to_type s t Yest Noc C s
t | t S( N( R( t _VOL_ADMIN_STATE_CONV( t vol_admin_state( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt vol_admin_state_to_str s t CLONEt COPYt MIRROR_SYNCt MIRROR_ASYNCc C s
t | t S( N( R/ t _VOL_REP_TYPE_CONV( t vol_rep_type_str( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt vol_rep_type_str_to_type s t ATAt SATAt SASt FCs SCSI Over PCI-E(SSD)t SCSIt NL_SASt HDDt SSDt Hybrids
Remote LUNc C s
t | t S( N( R( t _DISK_TYPE_CONV( t disk_type( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt disk_type_to_str s t Removedt Startingt Stoppingt Maintenancet Sparet Reconstructt Freec C s
t | t S( N( R& t _DISK_STATUS_CONV( t disk_status( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt disk_status_to_str s t WWPNt iSCSIs iSCSI/WWPN Mixedc C s
t | t S( N( R( t _AG_INIT_TYPE_CONV( t init_type( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt ag_init_type_to_str s c C s
t | t S( N( R/ R~ ( t
init_type_str( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt ag_init_type_str_to_lsm s t FCoEc C s
t | t S( N( R( t _TGT_PORT_TYPE_CONV( t port_type( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt tgt_port_type_to_str s c C sf | d k r d S| t j k r# d S| t j k r6 d S| t j k rI d S| t j k r\ d St | S( NR9 s
No SupportR0 s Non-Rotating Mediums Rotating Medium Unknown Speed( R t RPM_NO_SUPPORTt RPM_UNKNOWNt RPM_NON_ROTATING_MEDIUMt RPM_ROTATING_UNKNOWN_SPEEDR ( t rpm( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt disk_rpm_to_str s c C s | d k r d St | t j S( NR9 s
No Support( R( t
LocalDiskInfot _LINK_TYPE_MAP( t link_type( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt disk_link_type_to_str s c C s` | d k r d S| t j k r# d S| t j k r6 d S| t j k rI d S| t j k r\ d Sd S( NR9 s
No SupportR0 t Failuret Warningt Good( R t HEALTH_STATUS_UNKNOWNt HEALTH_STATUS_FAILt HEALTH_STATUS_WARNt HEALTH_STATUS_GOOD( t
health_status( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt disk_health_status_to_str s t Chemicalt Capacitorc C s
t | t S( N( R( t _BATTERY_TYPE_CONV( t battery_type( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt battery_type_to_str# s t Dischargingt Chargingt Learningc C s
t | t S( N( R& t _BATTERY_STATUS_CONV( t battery_status( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt battery_status_to_str3 s t IDENT_ONt IDENT_OFFt
IDENT_UNKNOWNt FAULT_ONt FAULT_OFFt
FAULT_UNKNOWNc C s
t | t S( N( R& t _DISK_LED_STATUS_CONV( t
led_status( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt disk_led_status_to_strB s c C s% | t j k r d Sd t | d S( NR0 s %.1f Gbpsg @@( R t LINK_SPEED_UNKNOWNt float( t
link_speed( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt disk_link_speed_to_strF s t PlugDatac B s e Z d Z RS( c C s | | _ | | _ d S( N( t desct version( t selft descriptiont plugin_version( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt __init__M s ( t __name__t
__module__R ( ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyR L s t VolumeRAIDInfoc B s e Z i d e j 6d e j 6d e j 6d e j 6d e j 6d e j 6d e j 6d e j
6d e j 6d e j 6d
e j
6d e j 6d e j 6d
e j 6d e j 6d e j 6d e j 6Z d d d d d d d
g Z d Z e d Z e d Z RS( t RAID0t RAID1t RAID3t RAID4t RAID5t RAID6t RAID10t RAID15t RAID16t RAID50t RAID60t RAID51t RAID61t JBODt MIXEDt OTHERRV c C s: | | _ | | _ | | _ | | _ | | _ | | _ d S( N( t vol_idt raid_typet
strip_sizet
disk_countt min_io_sizet opt_io_size( R R R R R R R ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyR j s c C s t | t j S( N( R( R t _RAID_TYPE_MAP( R ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt raid_type_to_strs s c C s t | t j S( N( R/ R R ( t
raid_type_str( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt raid_type_str_to_lsmw s ( R R R t RAID_TYPE_RAID0t RAID_TYPE_RAID1t RAID_TYPE_RAID3t RAID_TYPE_RAID4t RAID_TYPE_RAID5t RAID_TYPE_RAID6t RAID_TYPE_RAID10t RAID_TYPE_RAID15t RAID_TYPE_RAID16t RAID_TYPE_RAID50t RAID_TYPE_RAID60t RAID_TYPE_RAID51t RAID_TYPE_RAID61t RAID_TYPE_JBODt RAID_TYPE_MIXEDt RAID_TYPE_OTHERt RAID_TYPE_UNKNOWNR t VOL_CREATE_RAID_TYPES_STRR t staticmethodR R ( ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyR R s,
t PoolRAIDInfoc B sN e Z i d e j 6d e j 6d e j 6d e j 6Z d Z e d Z
RS( R0 R R c C s( | | _ | | _ | | _ | | _ d S( N( t pool_idR t member_typet
member_ids( R R R R R ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyR s c C s t | t j S( N( R( R t _MEMBER_TYPE_MAP( R ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt member_type_to_str s ( R R R t MEMBER_TYPE_UNKNOWNt MEMBER_TYPE_OTHERt MEMBER_TYPE_POOLt MEMBER_TYPE_DISKR R R R ( ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyR | s
t VcrCapc B s e Z d Z RS( c C s | | _ | | _ | | _ d S( N( t system_idt
raid_typest strip_sizes( R R R R ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyR s ( R R R ( ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyR s R c B s e Z i
d e j 6d e j 6d e j 6d e j 6d e j 6d e j 6d e j 6d e j
6d e j 6d e j 6d
e j
6d e j 6d e j 6Z d
Z RS( s
No SupportR0 Ri t SSAt SBPt SRPR} Rh t ADTs PATA/SATAt USBs SCSI over PCIEs PCI-Ec C sL | | _ | | _ | | _ | | _ | | _ | | _ | | _ | | _ d S( N( t sd_patht vpd83R R t
serial_numR R R ( R R R R R R R R R ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyR s ( R R R t LINK_TYPE_NO_SUPPORTt LINK_TYPE_UNKNOWNt LINK_TYPE_FCt
LINK_TYPE_SSAt
LINK_TYPE_SBPt
LINK_TYPE_SRPt LINK_TYPE_ISCSIt
LINK_TYPE_SASt
LINK_TYPE_ADTt
LINK_TYPE_ATAt
LINK_TYPE_USBt
LINK_TYPE_SOPt LINK_TYPE_PCIER R ( ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyR s
t VolumeRAMCacheInfoc B s$ e Z i d e j 6d e j 6d e j 6d e j 6Z i d e j 6d e j 6d e j
6d e j 6Z i d e j
6d e j 6d e j 6Z i d e j 6d e j 6d e j 6Z i d e j 6d e j 6d e j 6Z d Z e d Z e d Z e d
Z e d Z e d Z RS(
s Use Disk Settingt Enabledt DisabledR0 s
Write Backt Autos
Write Throughc C s: | | _ | | _ | | _ | | _ | | _ | | _ d S( N( R t write_cache_policyt write_cache_statust read_cache_policyt read_cache_statust phy_disk_cache( R R R R R R R ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyR s c C s t | t j S( N( R( R t _PHY_DISK_CACHE_STATUS_MAP( R ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt phy_disk_cache_status_to_str s c C s t | t j S( N( R( R t _W_CACHE_POLICY_MAP( t w_cache_p( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt w_cache_policy_to_str s c C s t | t j S( N( R( R t _W_CACHE_STATUS_MAP( t w_cache_status( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt w_cache_status_to_str s c C s t | t j S( N( R( R t _R_CACHE_POLICY_MAP( t r_cache_p( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt r_cache_policy_to_str s c C s t | t j S( N( R( R t _R_CACHE_STATUS_MAP( t r_cache_status( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt r_cache_status_to_str s ( R R R t$ PHYSICAL_DISK_CACHE_USE_DISK_SETTINGt PHYSICAL_DISK_CACHE_ENABLEDt PHYSICAL_DISK_CACHE_DISABLEDt PHYSICAL_DISK_CACHE_UNKNOWNR t WRITE_CACHE_POLICY_UNKNOWNt WRITE_CACHE_POLICY_WRITE_BACKt WRITE_CACHE_POLICY_AUTOt WRITE_CACHE_POLICY_WRITE_THROUGHR t WRITE_CACHE_STATUS_UNKNOWNt WRITE_CACHE_STATUS_WRITE_BACKt WRITE_CACHE_STATUS_WRITE_THROUGHR t READ_CACHE_POLICY_UNKNOWNt READ_CACHE_POLICY_ENABLEDt READ_CACHE_POLICY_DISABLEDR t READ_CACHE_STATUS_UNKNOWNt READ_CACHE_STATUS_ENABLEDt READ_CACHE_STATUS_DISABLEDR R R R R R R R" ( ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyR s8
t DisplayDatac B s
e Z d Z d Z d Z e Z d Z i Z e Z d e d 6Z; g Z< i e7 d 6e8 d 6e; d 6e< d 6e e= d e> d d@ dB dD dF dH dJ dL dN dP d 6e? d 6e@ d 6eA d 6e eB 8 s t PathR s
Serial NumberR s
LED StatusR s
Link SpeedR s
Health StatusR t typeR9 s Write Cache PolicyR s Write CacheR s Read Cache PolicyR s
Read CacheR s Physical Disk CacheR c C s y t | | } Wn4 t k
rI } | j t j k r@ d } qJ | n X| s~ | t | j k r~ | | | } q~ n | r | | k r t | t k r t d | D } q t | } q n | S( NR9 c s s | ] } t | Vq d S( N( R ( t .0t s( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pys s ( t getattrR t codeR t
NO_SUPPORTR R Rg R ( t objt keyRC RD t
flag_humant flag_enumt valuet lsm_err( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt _get_man_pro_value s
c C s] d } xP t d t | D]9 } | | } t | | | k r t | | } q q W| S( Ni i ( t rangeR ( t
two_d_listt column_indext max_widtht row_indext row_data( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt _find_max_width s
c C sB t } t j t | } | d } | d } | d }
| rL t j } n g } | t j k r xa t | j D]& } | | d k rt | j | qt qt Wn$ | t j k r t | j } n | r x- | D]" }
|
| k r | j |
q q Wn x@ | D]8 } | | } t j | | | |
| | } | | | s$ ^
* E lsmcli/__init__.py 0000644 00000001416 14757650541 0010160 0 ustar 00 # Copyright (C) 2011-2016 Red Hat, Inc.
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; If not, see .
try:
from .cmdline import cmd_line_wrapper
except ImportError:
from cmdline import cmd_line_wrapper
lsmcli/__init__.pyc 0000644 00000000421 14757650541 0010316 0 ustar 00
/P`c @ s< y d d l m Z Wn! e k
r7 d d l m Z n Xd S( i ( t cmd_line_wrapperiN( t cmdlineR t ImportError( ( ( s7 /usr/lib/python2.7/site-packages/lsm/lsmcli/__init__.pyt s
lsmcli/data_display.pyo 0000644 00000073525 14757650541 0011250 0 ustar 00
/P`c @ s* d d l Z d d l m Z d d l m Z m Z m Z m Z m Z m Z m Z m
Z
m Z m Z m
Z
m Z m Z m Z y d d l m Z Wn! e k
r d d l m Z n Xd Z d Z d Z d Z d Z i d
e j 6d e j 6d e j 6d
e j 6d e j 6d e j 6Z d Z! i d e j" 6d e j# 6Z$ d Z% i
d
e j 6d e j 6d e j 6d
e j 6d e j 6d e j& 6d e j' 6d e j( 6d e j) 6d e j* 6Z+ d Z, i d e j- 6d e j. 6d e j/ 6d e j0 6d e j1 6d e j2 6d e j3 6Z4 i d! e j5 6d" e j6 6Z7 d# Z8 d$ Z9 i d% e
j: 6d& e
j; 6d' e
j< 6d( e
j= 6Z> d) Z? i d* e
j@ 6d+ e
jA 6ZB d, ZC i d- e
jD 6d. e
jE 6d/ e
jF 6d0 e
jG 6d( e
jH 6ZI d1 ZJ i
d( e jK 6d e jL 6d2 e jM 6d3 e jN 6d4 e jO 6d5 e jP 6d6 e jQ 6d7 e jR 6d8 e jS 6d9 e jT 6d: e jU 6d; e jV 6d< e jW 6ZX d= ZY i d
e j 6d e j 6d e j 6d e j 6d e j 6d> e jZ 6d? e j[ 6d@ e j\ 6d e j& 6d e j) 6dA e j] 6dB e j^ 6dC e j_ 6dD e j` 6Za dE Zb i d
e jc 6d e jd 6dF e je 6dG e jf 6dH e jg 6Zh dI Zi dJ Zj i d e jL 6d5 e jP 6dK e jk 6dG e jl 6Zm dL Zn dM Zo dN Zp dO Zq i d
e jK 6d e jL 6dP e jr 6dQ e js 6Zt dR Zu i d
e j 6d e j 6d e j 6dS e jv 6dT e jw 6dU e jx 6d
e j 6d e j 6Zy dV Zz i d
e j{ 6dW e j| 6dX e j} 6dY e j~ 6dZ e j 6d[ e j 6d\ e j 6Z d] Z d^ Z d_ e f d` YZ da e f db YZ dc e f dd YZ de e f df YZ dg e f dh YZ di e f dj YZ dk e f dl YZ d S(m iN( t datetime( t size_bytes_2_size_humant LsmErrort ErrorNumbert Batteryt Systemt Poolt Diskt Volumet AccessGroupt
FileSystemt
FsSnapshott NfsExportt
TargetPortt LocalDisk( t OrderedDictt ,c C s\ y7 t j j t | t j j d t j j Wn t k
rW t j d n Xd S( Ns
i ( t syst stdoutt writet strt flusht IOErrort exit( t msg( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt out' s
c C s g } t | } x8 t | j D]$ } | | @r% | j | | q% q% W| d k ry t | d k ry d t | St j | S( Ni s Unknown(%s)( t intt listt keyst appendt lent hext BIT_MAP_STRING_SPLITTERt join( t bit_mapt conv_dictt rct cur_enum( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt _bit_map_to_str0 s
c C s4 t | } | t | j k r, | | Sd | S( Ns Unknown(%d)( R R R ( t int_typeR# ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt _enum_type_to_str< s c C sw g t | j D]* \ } } | j | j k r | ^ q } t | d k r] | d St t j d | d S( Ni s Failed to convert %s to lsm type( R t itemst lowerR R R t INVALID_ARGUMENT( t type_strR# t kt vR ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt _str_to_enumD s $ t Unknownt OKt Errort Degradeds Predictive failuret Otherc C s
t | t S( N( R& t _SYSTEM_STATUS_CONV( t
system_status( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt system_status_to_strW s s HW RAIDt HBAc C s t j | d S( Nt ( t _SYSTEM_MODE_CONVt get( t system_mode( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt system_mode_to_stra s t Stoppedt Reconstructingt Verifyingt Initializingt Growingc C s
t | t S( N( R& t _POOL_STATUS_CONV( t pool_status( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt pool_status_to_strs s t POOLt VOLUMEt VOLUME_THINt VOLUME_FULLt FSt SYSTEM_RESERVEDt DELTAs Volume Grows
Volume Shrinkc C s
t | t S( N( R& t _POOL_ELEMENT_TYPE_CONV( t element_type( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt pool_element_type_to_str s c C s
t | t S( N( R& t _POOL_UNSUPPORTED_ACTION_CONV( t unsupported_actions( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt pool_unsupported_actions_to_str s t DEFAULTt FULLt THINt UNKNOWNc C s
t | t S( N( R/ t _VOL_PROVISION_CONV( t vol_provision_str( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt vol_provision_str_to_type s t Yest Noc C s
t | t S( N( R( t _VOL_ADMIN_STATE_CONV( t vol_admin_state( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt vol_admin_state_to_str s t CLONEt COPYt MIRROR_SYNCt MIRROR_ASYNCc C s
t | t S( N( R/ t _VOL_REP_TYPE_CONV( t vol_rep_type_str( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt vol_rep_type_str_to_type s t ATAt SATAt SASt FCs SCSI Over PCI-E(SSD)t SCSIt NL_SASt HDDt SSDt Hybrids
Remote LUNc C s
t | t S( N( R( t _DISK_TYPE_CONV( t disk_type( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt disk_type_to_str s t Removedt Startingt Stoppingt Maintenancet Sparet Reconstructt Freec C s
t | t S( N( R& t _DISK_STATUS_CONV( t disk_status( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt disk_status_to_str s t WWPNt iSCSIs iSCSI/WWPN Mixedc C s
t | t S( N( R( t _AG_INIT_TYPE_CONV( t init_type( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt ag_init_type_to_str s c C s
t | t S( N( R/ R~ ( t
init_type_str( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt ag_init_type_str_to_lsm s t FCoEc C s
t | t S( N( R( t _TGT_PORT_TYPE_CONV( t port_type( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt tgt_port_type_to_str s c C sf | d k r d S| t j k r# d S| t j k r6 d S| t j k rI d S| t j k r\ d St | S( NR9 s
No SupportR0 s Non-Rotating Mediums Rotating Medium Unknown Speed( R t RPM_NO_SUPPORTt RPM_UNKNOWNt RPM_NON_ROTATING_MEDIUMt RPM_ROTATING_UNKNOWN_SPEEDR ( t rpm( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt disk_rpm_to_str s c C s | d k r d St | t j S( NR9 s
No Support( R( t
LocalDiskInfot _LINK_TYPE_MAP( t link_type( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt disk_link_type_to_str s c C s` | d k r d S| t j k r# d S| t j k r6 d S| t j k rI d S| t j k r\ d Sd S( NR9 s
No SupportR0 t Failuret Warningt Good( R t HEALTH_STATUS_UNKNOWNt HEALTH_STATUS_FAILt HEALTH_STATUS_WARNt HEALTH_STATUS_GOOD( t
health_status( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt disk_health_status_to_str s t Chemicalt Capacitorc C s
t | t S( N( R( t _BATTERY_TYPE_CONV( t battery_type( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt battery_type_to_str# s t Dischargingt Chargingt Learningc C s
t | t S( N( R& t _BATTERY_STATUS_CONV( t battery_status( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt battery_status_to_str3 s t IDENT_ONt IDENT_OFFt
IDENT_UNKNOWNt FAULT_ONt FAULT_OFFt
FAULT_UNKNOWNc C s
t | t S( N( R& t _DISK_LED_STATUS_CONV( t
led_status( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt disk_led_status_to_strB s c C s% | t j k r d Sd t | d S( NR0 s %.1f Gbpsg @@( R t LINK_SPEED_UNKNOWNt float( t
link_speed( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt disk_link_speed_to_strF s t PlugDatac B s e Z d Z RS( c C s | | _ | | _ d S( N( t desct version( t selft descriptiont plugin_version( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt __init__M s ( t __name__t
__module__R ( ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyR L s t VolumeRAIDInfoc B s e Z i d e j 6d e j 6d e j 6d e j 6d e j 6d e j 6d e j 6d e j
6d e j 6d e j 6d
e j
6d e j 6d e j 6d
e j 6d e j 6d e j 6d e j 6Z d d d d d d d
g Z d Z e d Z e d Z RS( t RAID0t RAID1t RAID3t RAID4t RAID5t RAID6t RAID10t RAID15t RAID16t RAID50t RAID60t RAID51t RAID61t JBODt MIXEDt OTHERRV c C s: | | _ | | _ | | _ | | _ | | _ | | _ d S( N( t vol_idt raid_typet
strip_sizet
disk_countt min_io_sizet opt_io_size( R R R R R R R ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyR j s c C s t | t j S( N( R( R t _RAID_TYPE_MAP( R ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt raid_type_to_strs s c C s t | t j S( N( R/ R R ( t
raid_type_str( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt raid_type_str_to_lsmw s ( R R R t RAID_TYPE_RAID0t RAID_TYPE_RAID1t RAID_TYPE_RAID3t RAID_TYPE_RAID4t RAID_TYPE_RAID5t RAID_TYPE_RAID6t RAID_TYPE_RAID10t RAID_TYPE_RAID15t RAID_TYPE_RAID16t RAID_TYPE_RAID50t RAID_TYPE_RAID60t RAID_TYPE_RAID51t RAID_TYPE_RAID61t RAID_TYPE_JBODt RAID_TYPE_MIXEDt RAID_TYPE_OTHERt RAID_TYPE_UNKNOWNR t VOL_CREATE_RAID_TYPES_STRR t staticmethodR R ( ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyR R s,
t PoolRAIDInfoc B sN e Z i d e j 6d e j 6d e j 6d e j 6Z d Z e d Z
RS( R0 R R c C s( | | _ | | _ | | _ | | _ d S( N( t pool_idR t member_typet
member_ids( R R R R R ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyR s c C s t | t j S( N( R( R t _MEMBER_TYPE_MAP( R ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt member_type_to_str s ( R R R t MEMBER_TYPE_UNKNOWNt MEMBER_TYPE_OTHERt MEMBER_TYPE_POOLt MEMBER_TYPE_DISKR R R R ( ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyR | s
t VcrCapc B s e Z d Z RS( c C s | | _ | | _ | | _ d S( N( t system_idt
raid_typest strip_sizes( R R R R ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyR s ( R R R ( ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyR s R c B s e Z i
d e j 6d e j 6d e j 6d e j 6d e j 6d e j 6d e j 6d e j
6d e j 6d e j 6d
e j
6d e j 6d e j 6Z d
Z RS( s
No SupportR0 Ri t SSAt SBPt SRPR} Rh t ADTs PATA/SATAt USBs SCSI over PCIEs PCI-Ec C sL | | _ | | _ | | _ | | _ | | _ | | _ | | _ | | _ d S( N( t sd_patht vpd83R R t
serial_numR R R ( R R R R R R R R R ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyR s ( R R R t LINK_TYPE_NO_SUPPORTt LINK_TYPE_UNKNOWNt LINK_TYPE_FCt
LINK_TYPE_SSAt
LINK_TYPE_SBPt
LINK_TYPE_SRPt LINK_TYPE_ISCSIt
LINK_TYPE_SASt
LINK_TYPE_ADTt
LINK_TYPE_ATAt
LINK_TYPE_USBt
LINK_TYPE_SOPt LINK_TYPE_PCIER R ( ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyR s
t VolumeRAMCacheInfoc B s$ e Z i d e j 6d e j 6d e j 6d e j 6Z i d e j 6d e j 6d e j
6d e j 6Z i d e j
6d e j 6d e j 6Z i d e j 6d e j 6d e j 6Z i d e j 6d e j 6d e j 6Z d Z e d Z e d Z e d
Z e d Z e d Z RS(
s Use Disk Settingt Enabledt DisabledR0 s
Write Backt Autos
Write Throughc C s: | | _ | | _ | | _ | | _ | | _ | | _ d S( N( R t write_cache_policyt write_cache_statust read_cache_policyt read_cache_statust phy_disk_cache( R R R R R R R ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyR s c C s t | t j S( N( R( R t _PHY_DISK_CACHE_STATUS_MAP( R ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt phy_disk_cache_status_to_str s c C s t | t j S( N( R( R t _W_CACHE_POLICY_MAP( t w_cache_p( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt w_cache_policy_to_str s c C s t | t j S( N( R( R t _W_CACHE_STATUS_MAP( t w_cache_status( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt w_cache_status_to_str s c C s t | t j S( N( R( R t _R_CACHE_POLICY_MAP( t r_cache_p( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt r_cache_policy_to_str s c C s t | t j S( N( R( R t _R_CACHE_STATUS_MAP( t r_cache_status( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt r_cache_status_to_str s ( R R R t$ PHYSICAL_DISK_CACHE_USE_DISK_SETTINGt PHYSICAL_DISK_CACHE_ENABLEDt PHYSICAL_DISK_CACHE_DISABLEDt PHYSICAL_DISK_CACHE_UNKNOWNR t WRITE_CACHE_POLICY_UNKNOWNt WRITE_CACHE_POLICY_WRITE_BACKt WRITE_CACHE_POLICY_AUTOt WRITE_CACHE_POLICY_WRITE_THROUGHR t WRITE_CACHE_STATUS_UNKNOWNt WRITE_CACHE_STATUS_WRITE_BACKt WRITE_CACHE_STATUS_WRITE_THROUGHR t READ_CACHE_POLICY_UNKNOWNt READ_CACHE_POLICY_ENABLEDt READ_CACHE_POLICY_DISABLEDR t READ_CACHE_STATUS_UNKNOWNt READ_CACHE_STATUS_ENABLEDt READ_CACHE_STATUS_DISABLEDR R R R R R R R" ( ( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyR s8
t DisplayDatac B s
e Z d Z d Z d Z e Z d Z i Z e Z d e d 6Z; g Z< i e7 d 6e8 d 6e; d 6e< d 6e e= d e> d d@ dB dD dF dH dJ dL dN dP d 6e? d 6e@ d 6eA d 6e eB 8 s t PathR s
Serial NumberR s
LED StatusR s
Link SpeedR s
Health StatusR t typeR9 s Write Cache PolicyR s Write CacheR s Read Cache PolicyR s
Read CacheR s Physical Disk CacheR c C s y t | | } Wn4 t k
rI } | j t j k r@ d } qJ | n X| s~ | t | j k r~ | | | } q~ n | r | | k r t | t k r t d | D } q t | } q n | S( NR9 c s s | ] } t | Vq d S( N( R ( t .0t s( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pys s ( t getattrR t codeR t
NO_SUPPORTR R Rg R ( t objt keyRC RD t
flag_humant flag_enumt valuet lsm_err( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt _get_man_pro_value s
c C s] d } xP t d t | D]9 } | | } t | | | k r t | | } q q W| S( Ni i ( t rangeR ( t
two_d_listt column_indext max_widtht row_indext row_data( ( s; /usr/lib/python2.7/site-packages/lsm/lsmcli/data_display.pyt _find_max_width s
c C sB t } t j t | } | d } | d } | d }
| rL t j } n g } | t j k r xa t | j D]& } | | d k rt | j | qt qt Wn$ | t j k r t | j } n | r x- | D]" }
|
| k r | j |
q q Wn x@ | D]8 } | | } t j | | | |
| | } | | | s$ ^
* E lsmcli/data_display.py 0000644 00000110003 14757650541 0011050 0 ustar 00 # Copyright (C) 2014 Red Hat, Inc.
# (C) Copyright 2017 Hewlett Packard Enterprise Development LP
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; If not, see .
#
# Author: Gris Ge
import sys
from datetime import datetime
from lsm import (size_bytes_2_size_human, LsmError, ErrorNumber, Battery,
System, Pool, Disk, Volume, AccessGroup,
FileSystem, FsSnapshot, NfsExport, TargetPort, LocalDisk)
try:
from collections import OrderedDict
except ImportError:
# python 2.6 or earlier, use backport
from ordereddict import OrderedDict
BIT_MAP_STRING_SPLITTER = ','
# Users are reporting errors with broken pipe when piping output
# to another program. This appears to be related to this issue:
# http://bugs.python.org/issue11380
# Unable to reproduce, but hopefully this will address it.
# @param msg The message to be written to stdout
def out(msg):
try:
sys.stdout.write(str(msg))
sys.stdout.write("\n")
sys.stdout.flush()
except IOError:
sys.exit(1)
def _bit_map_to_str(bit_map, conv_dict):
rc = []
bit_map = int(bit_map)
for cur_enum in list(conv_dict.keys()):
if cur_enum & bit_map:
rc.append(conv_dict[cur_enum])
# If there are no bits set we really don't need a string
if bit_map != 0 and len(rc) == 0:
return 'Unknown(%s)' % hex(bit_map)
return BIT_MAP_STRING_SPLITTER.join(rc)
def _enum_type_to_str(int_type, conv_dict):
int_type = int(int_type)
if int_type in list(conv_dict.keys()):
return conv_dict[int_type]
return 'Unknown(%d)' % int_type
def _str_to_enum(type_str, conv_dict):
keys = [k for k, v in list(conv_dict.items())
if v.lower() == type_str.lower()]
if len(keys) > 0:
return keys[0]
raise LsmError(ErrorNumber.INVALID_ARGUMENT,
"Failed to convert %s to lsm type" % type_str)
_SYSTEM_STATUS_CONV = {
System.STATUS_UNKNOWN: 'Unknown',
System.STATUS_OK: 'OK',
System.STATUS_ERROR: 'Error',
System.STATUS_DEGRADED: 'Degraded',
System.STATUS_PREDICTIVE_FAILURE: 'Predictive failure',
System.STATUS_OTHER: 'Other',
}
def system_status_to_str(system_status):
return _bit_map_to_str(system_status, _SYSTEM_STATUS_CONV)
_SYSTEM_MODE_CONV = {
System.MODE_HARDWARE_RAID: "HW RAID",
System.MODE_HBA: "HBA",
}
def system_mode_to_str(system_mode):
return _SYSTEM_MODE_CONV.get(system_mode, "")
_POOL_STATUS_CONV = {
Pool.STATUS_UNKNOWN: 'Unknown',
Pool.STATUS_OK: 'OK',
Pool.STATUS_OTHER: 'Other',
Pool.STATUS_DEGRADED: 'Degraded',
Pool.STATUS_ERROR: 'Error',
Pool.STATUS_STOPPED: 'Stopped',
Pool.STATUS_RECONSTRUCTING: 'Reconstructing',
Pool.STATUS_VERIFYING: 'Verifying',
Pool.STATUS_INITIALIZING: 'Initializing',
Pool.STATUS_GROWING: 'Growing',
}
def pool_status_to_str(pool_status):
return _bit_map_to_str(pool_status, _POOL_STATUS_CONV)
_POOL_ELEMENT_TYPE_CONV = {
Pool.ELEMENT_TYPE_POOL: 'POOL',
Pool.ELEMENT_TYPE_VOLUME: 'VOLUME',
Pool.ELEMENT_TYPE_VOLUME_THIN: 'VOLUME_THIN',
Pool.ELEMENT_TYPE_VOLUME_FULL: 'VOLUME_FULL',
Pool.ELEMENT_TYPE_FS: 'FS',
Pool.ELEMENT_TYPE_SYS_RESERVED: 'SYSTEM_RESERVED',
Pool.ELEMENT_TYPE_DELTA: "DELTA",
}
_POOL_UNSUPPORTED_ACTION_CONV = {
Pool.UNSUPPORTED_VOLUME_GROW: "Volume Grow",
Pool.UNSUPPORTED_VOLUME_SHRINK: "Volume Shrink"
}
def pool_element_type_to_str(element_type):
return _bit_map_to_str(element_type, _POOL_ELEMENT_TYPE_CONV)
def pool_unsupported_actions_to_str(unsupported_actions):
return _bit_map_to_str(unsupported_actions, _POOL_UNSUPPORTED_ACTION_CONV)
_VOL_PROVISION_CONV = {
Volume.PROVISION_DEFAULT: 'DEFAULT',
Volume.PROVISION_FULL: 'FULL',
Volume.PROVISION_THIN: 'THIN',
Volume.PROVISION_UNKNOWN: 'UNKNOWN',
}
def vol_provision_str_to_type(vol_provision_str):
return _str_to_enum(vol_provision_str, _VOL_PROVISION_CONV)
_VOL_ADMIN_STATE_CONV = {
Volume.ADMIN_STATE_DISABLED: 'Yes',
Volume.ADMIN_STATE_ENABLED: 'No',
}
def vol_admin_state_to_str(vol_admin_state):
return _enum_type_to_str(vol_admin_state, _VOL_ADMIN_STATE_CONV)
_VOL_REP_TYPE_CONV = {
Volume.REPLICATE_CLONE: 'CLONE',
Volume.REPLICATE_COPY: 'COPY',
Volume.REPLICATE_MIRROR_SYNC: 'MIRROR_SYNC',
Volume.REPLICATE_MIRROR_ASYNC: 'MIRROR_ASYNC',
Volume.REPLICATE_UNKNOWN: 'UNKNOWN',
}
def vol_rep_type_str_to_type(vol_rep_type_str):
return _str_to_enum(vol_rep_type_str, _VOL_REP_TYPE_CONV)
_DISK_TYPE_CONV = {
Disk.TYPE_UNKNOWN: 'UNKNOWN',
Disk.TYPE_OTHER: 'Other',
Disk.TYPE_ATA: 'ATA',
Disk.TYPE_SATA: 'SATA',
Disk.TYPE_SAS: 'SAS',
Disk.TYPE_FC: 'FC',
Disk.TYPE_SOP: 'SCSI Over PCI-E(SSD)',
Disk.TYPE_SCSI: 'SCSI',
Disk.TYPE_NL_SAS: 'NL_SAS',
Disk.TYPE_HDD: 'HDD',
Disk.TYPE_SSD: 'SSD',
Disk.TYPE_HYBRID: 'Hybrid',
Disk.TYPE_LUN: 'Remote LUN',
}
def disk_type_to_str(disk_type):
return _enum_type_to_str(disk_type, _DISK_TYPE_CONV)
_DISK_STATUS_CONV = {
Disk.STATUS_UNKNOWN: 'Unknown',
Disk.STATUS_OK: 'OK',
Disk.STATUS_OTHER: 'Other',
Disk.STATUS_PREDICTIVE_FAILURE: 'Predictive failure',
Disk.STATUS_ERROR: 'Error',
Disk.STATUS_REMOVED: 'Removed',
Disk.STATUS_STARTING: 'Starting',
Disk.STATUS_STOPPING: 'Stopping',
Disk.STATUS_STOPPED: 'Stopped',
Disk.STATUS_INITIALIZING: 'Initializing',
Disk.STATUS_MAINTENANCE_MODE: 'Maintenance',
Disk.STATUS_SPARE_DISK: 'Spare',
Disk.STATUS_RECONSTRUCT: 'Reconstruct',
Disk.STATUS_FREE: 'Free',
}
def disk_status_to_str(disk_status):
return _bit_map_to_str(disk_status, _DISK_STATUS_CONV)
_AG_INIT_TYPE_CONV = {
AccessGroup.INIT_TYPE_UNKNOWN: 'Unknown',
AccessGroup.INIT_TYPE_OTHER: 'Other',
AccessGroup.INIT_TYPE_WWPN: 'WWPN',
AccessGroup.INIT_TYPE_ISCSI_IQN: 'iSCSI',
AccessGroup.INIT_TYPE_ISCSI_WWPN_MIXED: 'iSCSI/WWPN Mixed',
}
def ag_init_type_to_str(init_type):
return _enum_type_to_str(init_type, _AG_INIT_TYPE_CONV)
def ag_init_type_str_to_lsm(init_type_str):
return _str_to_enum(init_type_str, _AG_INIT_TYPE_CONV)
_TGT_PORT_TYPE_CONV = {
TargetPort.TYPE_OTHER: 'Other',
TargetPort.TYPE_FC: 'FC',
TargetPort.TYPE_FCOE: 'FCoE',
TargetPort.TYPE_ISCSI: 'iSCSI',
}
def tgt_port_type_to_str(port_type):
return _enum_type_to_str(port_type, _TGT_PORT_TYPE_CONV)
def disk_rpm_to_str(rpm):
if rpm == '':
return "No Support"
if rpm == Disk.RPM_NO_SUPPORT:
return "No Support"
if rpm == Disk.RPM_UNKNOWN:
return "Unknown"
if rpm == Disk.RPM_NON_ROTATING_MEDIUM:
return "Non-Rotating Medium"
if rpm == Disk.RPM_ROTATING_UNKNOWN_SPEED:
return "Rotating Medium Unknown Speed"
return str(rpm)
def disk_link_type_to_str(link_type):
if link_type == '':
return "No Support"
return _enum_type_to_str(link_type, LocalDiskInfo._LINK_TYPE_MAP)
def disk_health_status_to_str(health_status):
if health_status == '':
return "No Support"
if health_status == Disk.HEALTH_STATUS_UNKNOWN:
return "Unknown"
if health_status == Disk.HEALTH_STATUS_FAIL:
return "Failure"
if health_status == Disk.HEALTH_STATUS_WARN:
return "Warning"
if health_status == Disk.HEALTH_STATUS_GOOD:
return "Good"
_BATTERY_TYPE_CONV = {
Battery.TYPE_UNKNOWN: "Unknown",
Battery.TYPE_OTHER: "Other",
Battery.TYPE_CHEMICAL: "Chemical",
Battery.TYPE_CAPACITOR: "Capacitor",
}
def battery_type_to_str(battery_type):
return _enum_type_to_str(battery_type, _BATTERY_TYPE_CONV)
_BATTERY_STATUS_CONV = {
Battery.STATUS_UNKNOWN: "Unknown",
Battery.STATUS_OTHER: "Other",
Battery.STATUS_OK: "OK",
Battery.STATUS_DISCHARGING: "Discharging",
Battery.STATUS_CHARGING: "Charging",
Battery.STATUS_LEARNING: "Learning",
Battery.STATUS_DEGRADED: "Degraded",
Battery.STATUS_ERROR: "Error",
}
def battery_status_to_str(battery_status):
return _bit_map_to_str(battery_status, _BATTERY_STATUS_CONV)
_DISK_LED_STATUS_CONV = {
Disk.LED_STATUS_UNKNOWN: 'Unknown',
Disk.LED_STATUS_IDENT_ON: 'IDENT_ON',
Disk.LED_STATUS_IDENT_OFF: 'IDENT_OFF',
Disk.LED_STATUS_IDENT_UNKNOWN: 'IDENT_UNKNOWN',
Disk.LED_STATUS_FAULT_ON: 'FAULT_ON',
Disk.LED_STATUS_FAULT_OFF: 'FAULT_OFF',
Disk.LED_STATUS_FAULT_UNKNOWN: 'FAULT_UNKNOWN',
}
def disk_led_status_to_str(led_status):
return _bit_map_to_str(led_status, _DISK_LED_STATUS_CONV)
def disk_link_speed_to_str(link_speed):
if link_speed == Disk.LINK_SPEED_UNKNOWN:
return "Unknown"
return "%.1f Gbps" % float(link_speed / 1000.0)
class PlugData(object):
def __init__(self, description, plugin_version):
self.desc = description
self.version = plugin_version
class VolumeRAIDInfo(object):
_RAID_TYPE_MAP = {
Volume.RAID_TYPE_RAID0: 'RAID0',
Volume.RAID_TYPE_RAID1: 'RAID1',
Volume.RAID_TYPE_RAID3: 'RAID3',
Volume.RAID_TYPE_RAID4: 'RAID4',
Volume.RAID_TYPE_RAID5: 'RAID5',
Volume.RAID_TYPE_RAID6: 'RAID6',
Volume.RAID_TYPE_RAID10: 'RAID10',
Volume.RAID_TYPE_RAID15: 'RAID15',
Volume.RAID_TYPE_RAID16: 'RAID16',
Volume.RAID_TYPE_RAID50: 'RAID50',
Volume.RAID_TYPE_RAID60: 'RAID60',
Volume.RAID_TYPE_RAID51: 'RAID51',
Volume.RAID_TYPE_RAID61: 'RAID61',
Volume.RAID_TYPE_JBOD: 'JBOD',
Volume.RAID_TYPE_MIXED: 'MIXED',
Volume.RAID_TYPE_OTHER: 'OTHER',
Volume.RAID_TYPE_UNKNOWN: 'UNKNOWN',
}
VOL_CREATE_RAID_TYPES_STR = [
'RAID0', 'RAID1', 'RAID5', 'RAID6', 'RAID10', 'RAID50', 'RAID60']
def __init__(self, vol_id, raid_type, strip_size, disk_count,
min_io_size, opt_io_size):
self.vol_id = vol_id
self.raid_type = raid_type
self.strip_size = strip_size
self.disk_count = disk_count
self.min_io_size = min_io_size
self.opt_io_size = opt_io_size
@staticmethod
def raid_type_to_str(raid_type):
return _enum_type_to_str(raid_type, VolumeRAIDInfo._RAID_TYPE_MAP)
@staticmethod
def raid_type_str_to_lsm(raid_type_str):
return _str_to_enum(raid_type_str, VolumeRAIDInfo._RAID_TYPE_MAP)
class PoolRAIDInfo(object):
_MEMBER_TYPE_MAP = {
Pool.MEMBER_TYPE_UNKNOWN: 'Unknown',
Pool.MEMBER_TYPE_OTHER: 'Unknown',
Pool.MEMBER_TYPE_POOL: 'Pool',
Pool.MEMBER_TYPE_DISK: 'Disk',
}
def __init__(self, pool_id, raid_type, member_type, member_ids):
self.pool_id = pool_id
self.raid_type = raid_type
self.member_type = member_type
self.member_ids = member_ids
@staticmethod
def member_type_to_str(member_type):
return _enum_type_to_str(
member_type, PoolRAIDInfo._MEMBER_TYPE_MAP)
class VcrCap(object):
def __init__(self, system_id, raid_types, strip_sizes):
self.system_id = system_id
self.raid_types = raid_types
self.strip_sizes = strip_sizes
class LocalDiskInfo(object):
_LINK_TYPE_MAP = {
Disk.LINK_TYPE_NO_SUPPORT: "No Support",
Disk.LINK_TYPE_UNKNOWN: "Unknown",
Disk.LINK_TYPE_FC: "FC",
Disk.LINK_TYPE_SSA: "SSA",
Disk.LINK_TYPE_SBP: "SBP",
Disk.LINK_TYPE_SRP: "SRP",
Disk.LINK_TYPE_ISCSI: "iSCSI",
Disk.LINK_TYPE_SAS: "SAS",
Disk.LINK_TYPE_ADT: "ADT",
Disk.LINK_TYPE_ATA: "PATA/SATA",
Disk.LINK_TYPE_USB: "USB",
Disk.LINK_TYPE_SOP: "SCSI over PCIE",
Disk.LINK_TYPE_PCIE: "PCI-E",
}
def __init__(self, sd_path, vpd83, rpm, link_type, serial_num, led_status,
link_speed, health_status):
self.sd_path = sd_path
self.vpd83 = vpd83
self.rpm = rpm
self.link_type = link_type
self.serial_num = serial_num
self.led_status = led_status
self.link_speed = link_speed
self.health_status = health_status
class VolumeRAMCacheInfo(object):
_PHY_DISK_CACHE_STATUS_MAP = {
Volume.PHYSICAL_DISK_CACHE_USE_DISK_SETTING: "Use Disk Setting",
Volume.PHYSICAL_DISK_CACHE_ENABLED: "Enabled",
Volume.PHYSICAL_DISK_CACHE_DISABLED: "Disabled",
Volume.PHYSICAL_DISK_CACHE_UNKNOWN: "Unknown",
}
_W_CACHE_POLICY_MAP = {
Volume.WRITE_CACHE_POLICY_UNKNOWN: "Unknown",
Volume.WRITE_CACHE_POLICY_WRITE_BACK: "Write Back",
Volume.WRITE_CACHE_POLICY_AUTO: "Auto",
Volume.WRITE_CACHE_POLICY_WRITE_THROUGH: "Write Through",
}
_W_CACHE_STATUS_MAP = {
Volume.WRITE_CACHE_STATUS_UNKNOWN: "Unknown",
Volume.WRITE_CACHE_STATUS_WRITE_BACK: "Write Back",
Volume.WRITE_CACHE_STATUS_WRITE_THROUGH: "Write Through",
}
_R_CACHE_POLICY_MAP = {
Volume.READ_CACHE_POLICY_UNKNOWN: "Unknown",
Volume.READ_CACHE_POLICY_ENABLED: "Enabled",
Volume.READ_CACHE_POLICY_DISABLED: "Disabled",
}
_R_CACHE_STATUS_MAP = {
Volume.READ_CACHE_STATUS_UNKNOWN: "Unknown",
Volume.READ_CACHE_STATUS_ENABLED: "Enabled",
Volume.READ_CACHE_STATUS_DISABLED: "Disabled",
}
def __init__(self, vol_id, write_cache_policy, write_cache_status,
read_cache_policy, read_cache_status, phy_disk_cache):
self.vol_id = vol_id
self.write_cache_policy = write_cache_policy
self.write_cache_status = write_cache_status
self.read_cache_policy = read_cache_policy
self.read_cache_status = read_cache_status
self.phy_disk_cache = phy_disk_cache
@staticmethod
def phy_disk_cache_status_to_str(phy_disk_cache):
return _enum_type_to_str(
phy_disk_cache, VolumeRAMCacheInfo._PHY_DISK_CACHE_STATUS_MAP)
@staticmethod
def w_cache_policy_to_str(w_cache_p):
return _enum_type_to_str(
w_cache_p, VolumeRAMCacheInfo._W_CACHE_POLICY_MAP)
@staticmethod
def w_cache_status_to_str(w_cache_status):
return _enum_type_to_str(
w_cache_status, VolumeRAMCacheInfo._W_CACHE_STATUS_MAP)
@staticmethod
def r_cache_policy_to_str(r_cache_p):
return _enum_type_to_str(
r_cache_p, VolumeRAMCacheInfo._R_CACHE_POLICY_MAP)
@staticmethod
def r_cache_status_to_str(r_cache_status):
return _enum_type_to_str(
r_cache_status, VolumeRAMCacheInfo._R_CACHE_STATUS_MAP)
class DisplayData(object):
def __init__(self):
pass
DISPLAY_WAY_COLUMN = 0
DISPLAY_WAY_SCRIPT = 1
DISPLAY_WAY_DEFAULT = DISPLAY_WAY_COLUMN
DEFAULT_SPLITTER = ' | '
VALUE_CONVERT = {}
# lsm.System
SYSTEM_HEADER = OrderedDict()
SYSTEM_HEADER['id'] = 'ID'
SYSTEM_HEADER['name'] = 'Name'
SYSTEM_HEADER['status'] = 'Status'
SYSTEM_HEADER['status_info'] = 'Info'
SYSTEM_HEADER['fw_version'] = "FW Ver"
SYSTEM_HEADER['mode'] = "Mode"
SYSTEM_HEADER['read_cache_pct'] = "Read Cache Percentage"
SYSTEM_COLUMN_SKIP_KEYS = []
# XXX_COLUMN_SKIP_KEYS contain a list of property should be skipped when
# displaying in column way.
SYSTEM_VALUE_CONV_ENUM = {
'status': system_status_to_str,
'mode': system_mode_to_str,
}
SYSTEM_VALUE_CONV_HUMAN = []
VALUE_CONVERT[System] = {
'headers': SYSTEM_HEADER,
'column_skip_keys': SYSTEM_COLUMN_SKIP_KEYS,
'value_conv_enum': SYSTEM_VALUE_CONV_ENUM,
'value_conv_human': SYSTEM_VALUE_CONV_HUMAN,
}
PLUG_DATA_HEADER = OrderedDict()
PLUG_DATA_HEADER['desc'] = 'Description'
PLUG_DATA_HEADER['version'] = 'Version'
PLUG_DATA_COLUMN_SKIP_KEYS = []
PLUG_DATA_VALUE_CONV_ENUM = {}
PLUG_DATA_VALUE_CONV_HUMAN = []
VALUE_CONVERT[PlugData] = {
'headers': PLUG_DATA_HEADER,
'column_skip_keys': PLUG_DATA_COLUMN_SKIP_KEYS,
'value_conv_enum': PLUG_DATA_VALUE_CONV_ENUM,
'value_conv_human': PLUG_DATA_VALUE_CONV_HUMAN,
}
# lsm.Pool
POOL_HEADER = OrderedDict()
POOL_HEADER['id'] = 'ID'
POOL_HEADER['name'] = 'Name'
POOL_HEADER['element_type'] = 'Element Type'
POOL_HEADER['unsupported_actions'] = 'Does not support'
POOL_HEADER['total_space'] = 'Total Space'
POOL_HEADER['free_space'] = 'Free Space'
POOL_HEADER['status'] = 'Status'
POOL_HEADER['status_info'] = 'Info'
POOL_HEADER['system_id'] = 'System ID'
POOL_COLUMN_SKIP_KEYS = ['unsupported_actions']
POOL_VALUE_CONV_ENUM = {
'status': pool_status_to_str,
'element_type': pool_element_type_to_str,
'unsupported_actions': pool_unsupported_actions_to_str
}
POOL_VALUE_CONV_HUMAN = ['total_space', 'free_space']
VALUE_CONVERT[Pool] = {
'headers': POOL_HEADER,
'column_skip_keys': POOL_COLUMN_SKIP_KEYS,
'value_conv_enum': POOL_VALUE_CONV_ENUM,
'value_conv_human': POOL_VALUE_CONV_HUMAN,
}
# lsm.Volume
VOL_HEADER = OrderedDict()
VOL_HEADER['id'] = 'ID'
VOL_HEADER['name'] = 'Name'
VOL_HEADER['vpd83'] = 'SCSI VPD 0x83'
VOL_HEADER['block_size'] = 'Block Size'
VOL_HEADER['num_of_blocks'] = 'Block Count'
VOL_HEADER['size_bytes'] = 'Size'
VOL_HEADER['admin_state'] = 'Disabled'
VOL_HEADER['pool_id'] = 'Pool ID'
VOL_HEADER['system_id'] = 'System ID'
VOL_HEADER['sd_paths'] = 'Disk Paths' # This is appended by cmdline.py
VOL_COLUMN_SKIP_KEYS = ['block_size', 'num_of_blocks']
VOL_VALUE_CONV_ENUM = {
'admin_state': vol_admin_state_to_str
}
VOL_VALUE_CONV_HUMAN = ['size_bytes', 'block_size']
VALUE_CONVERT[Volume] = {
'headers': VOL_HEADER,
'column_skip_keys': VOL_COLUMN_SKIP_KEYS,
'value_conv_enum': VOL_VALUE_CONV_ENUM,
'value_conv_human': VOL_VALUE_CONV_HUMAN,
}
# lsm.Disk
DISK_HEADER = OrderedDict()
DISK_HEADER['id'] = 'ID'
DISK_HEADER['name'] = 'Name'
DISK_HEADER['disk_type'] = 'Type'
DISK_HEADER['block_size'] = 'Block Size'
DISK_HEADER['num_of_blocks'] = 'Block Count'
DISK_HEADER['size_bytes'] = 'Size'
DISK_HEADER['status'] = 'Status'
DISK_HEADER['system_id'] = 'System ID'
DISK_HEADER['vpd83'] = 'SCSI VPD 0x83'
DISK_HEADER['sd_paths'] = 'Disk Paths' # This is appended by cmdline.py
DISK_HEADER['rpm'] = 'Revolutions Per Minute'
DISK_HEADER['link_type'] = 'Link Type'
DISK_HEADER['location'] = 'Location'
DISK_COLUMN_SKIP_KEYS = ['block_size', 'num_of_blocks', 'location']
DISK_VALUE_CONV_ENUM = {
'status': disk_status_to_str,
'disk_type': disk_type_to_str,
'rpm': disk_rpm_to_str,
'link_type': disk_link_type_to_str,
}
DISK_VALUE_CONV_HUMAN = ['size_bytes', 'block_size']
VALUE_CONVERT[Disk] = {
'headers': DISK_HEADER,
'column_skip_keys': DISK_COLUMN_SKIP_KEYS,
'value_conv_enum': DISK_VALUE_CONV_ENUM,
'value_conv_human': DISK_VALUE_CONV_HUMAN,
}
# lsm.AccessGroup
AG_HEADER = OrderedDict()
AG_HEADER['id'] = 'ID'
AG_HEADER['name'] = 'Name'
AG_HEADER['init_ids'] = 'Initiator IDs'
AG_HEADER['init_type'] = 'Type'
AG_HEADER['system_id'] = 'System ID'
AG_COLUMN_SKIP_KEYS = ['init_type']
AG_VALUE_CONV_ENUM = {
'init_type': ag_init_type_to_str,
}
AG_VALUE_CONV_HUMAN = []
VALUE_CONVERT[AccessGroup] = {
'headers': AG_HEADER,
'column_skip_keys': AG_COLUMN_SKIP_KEYS,
'value_conv_enum': AG_VALUE_CONV_ENUM,
'value_conv_human': AG_VALUE_CONV_HUMAN,
}
# lsm.FileSystem
FS_HEADER = OrderedDict()
FS_HEADER['id'] = 'ID'
FS_HEADER['name'] = 'Name'
FS_HEADER['total_space'] = 'Total Space'
FS_HEADER['free_space'] = 'Free Space'
FS_HEADER['pool_id'] = 'Pool ID'
FS_HEADER['system_id'] = 'System ID'
FS_COLUMN_SKIP_KEYS = []
FS_VALUE_CONV_ENUM = {
}
FS_VALUE_CONV_HUMAN = ['total_space', 'free_space']
VALUE_CONVERT[FileSystem] = {
'headers': FS_HEADER,
'column_skip_keys': FS_COLUMN_SKIP_KEYS,
'value_conv_enum': FS_VALUE_CONV_ENUM,
'value_conv_human': FS_VALUE_CONV_HUMAN,
}
# lsm.FsSnapshot
FS_SNAP_HEADER = OrderedDict()
FS_SNAP_HEADER['id'] = 'ID'
FS_SNAP_HEADER['name'] = 'Name'
FS_SNAP_HEADER['ts'] = 'Time Stamp'
FS_SNAP_COLUMN_SKIP_KEYS = []
FS_SNAP_VALUE_CONV_ENUM = {
'ts': datetime.fromtimestamp
}
FS_SNAP_VALUE_CONV_HUMAN = []
VALUE_CONVERT[FsSnapshot] = {
'headers': FS_SNAP_HEADER,
'column_skip_keys': FS_SNAP_COLUMN_SKIP_KEYS,
'value_conv_enum': FS_SNAP_VALUE_CONV_ENUM,
'value_conv_human': FS_SNAP_VALUE_CONV_HUMAN,
}
# lsm.NfsExport
NFS_EXPORT_HEADER = OrderedDict()
NFS_EXPORT_HEADER['id'] = 'ID'
NFS_EXPORT_HEADER['fs_id'] = 'FileSystem ID'
NFS_EXPORT_HEADER['export_path'] = 'Export Path'
NFS_EXPORT_HEADER['auth'] = 'Auth Type'
NFS_EXPORT_HEADER['root'] = 'Root Hosts'
NFS_EXPORT_HEADER['rw'] = 'RW Hosts'
NFS_EXPORT_HEADER['ro'] = 'RO Hosts'
NFS_EXPORT_HEADER['anonuid'] = 'Anonymous UID'
NFS_EXPORT_HEADER['anongid'] = 'Anonymous GID'
NFS_EXPORT_HEADER['options'] = 'Options'
NFS_EXPORT_COLUMN_SKIP_KEYS = ['anonuid', 'anongid', 'auth']
NFS_EXPORT_VALUE_CONV_ENUM = {}
NFS_EXPORT_VALUE_CONV_HUMAN = []
VALUE_CONVERT[NfsExport] = {
'headers': NFS_EXPORT_HEADER,
'column_skip_keys': NFS_EXPORT_COLUMN_SKIP_KEYS,
'value_conv_enum': NFS_EXPORT_VALUE_CONV_ENUM,
'value_conv_human': NFS_EXPORT_VALUE_CONV_HUMAN,
}
# lsm.TargetPort
TGT_PORT_HEADER = OrderedDict()
TGT_PORT_HEADER['id'] = 'ID'
TGT_PORT_HEADER['port_type'] = 'Type'
TGT_PORT_HEADER['physical_name'] = 'Physical Name'
TGT_PORT_HEADER['service_address'] = 'Address'
TGT_PORT_HEADER['network_address'] = 'Network Address'
TGT_PORT_HEADER['physical_address'] = 'Physical Address'
TGT_PORT_HEADER['system_id'] = 'System ID'
TGT_PORT_COLUMN_SKIP_KEYS = ['physical_address', 'physical_name']
TGT_PORT_VALUE_CONV_ENUM = {
'port_type': tgt_port_type_to_str,
}
TGT_PORT_VALUE_CONV_HUMAN = []
VALUE_CONVERT[TargetPort] = {
'headers': TGT_PORT_HEADER,
'column_skip_keys': TGT_PORT_COLUMN_SKIP_KEYS,
'value_conv_enum': TGT_PORT_VALUE_CONV_ENUM,
'value_conv_human': TGT_PORT_VALUE_CONV_HUMAN,
}
VOL_RAID_INFO_HEADER = OrderedDict()
VOL_RAID_INFO_HEADER['vol_id'] = 'Volume ID'
VOL_RAID_INFO_HEADER['raid_type'] = 'RAID Type'
VOL_RAID_INFO_HEADER['strip_size'] = 'Strip Size'
VOL_RAID_INFO_HEADER['disk_count'] = 'Disk Count'
VOL_RAID_INFO_HEADER['min_io_size'] = 'Minimum I/O Size'
VOL_RAID_INFO_HEADER['opt_io_size'] = 'Optimal I/O Size'
VOL_RAID_INFO_COLUMN_SKIP_KEYS = []
VOL_RAID_INFO_VALUE_CONV_ENUM = {
'raid_type': VolumeRAIDInfo.raid_type_to_str,
}
VOL_RAID_INFO_VALUE_CONV_HUMAN = [
'strip_size', 'min_io_size', 'opt_io_size']
VALUE_CONVERT[VolumeRAIDInfo] = {
'headers': VOL_RAID_INFO_HEADER,
'column_skip_keys': VOL_RAID_INFO_COLUMN_SKIP_KEYS,
'value_conv_enum': VOL_RAID_INFO_VALUE_CONV_ENUM,
'value_conv_human': VOL_RAID_INFO_VALUE_CONV_HUMAN,
}
POOL_RAID_INFO_HEADER = OrderedDict()
POOL_RAID_INFO_HEADER['pool_id'] = 'Pool ID'
POOL_RAID_INFO_HEADER['raid_type'] = 'RAID Type'
POOL_RAID_INFO_HEADER['member_type'] = 'Member Type'
POOL_RAID_INFO_HEADER['member_ids'] = 'Member IDs'
POOL_RAID_INFO_COLUMN_SKIP_KEYS = []
POOL_RAID_INFO_VALUE_CONV_ENUM = {
'raid_type': VolumeRAIDInfo.raid_type_to_str,
'member_type': PoolRAIDInfo.member_type_to_str,
}
POOL_RAID_INFO_VALUE_CONV_HUMAN = []
VALUE_CONVERT[PoolRAIDInfo] = {
'headers': POOL_RAID_INFO_HEADER,
'column_skip_keys': POOL_RAID_INFO_COLUMN_SKIP_KEYS,
'value_conv_enum': POOL_RAID_INFO_VALUE_CONV_ENUM,
'value_conv_human': POOL_RAID_INFO_VALUE_CONV_HUMAN,
}
VCR_CAP_HEADER = OrderedDict()
VCR_CAP_HEADER['system_id'] = 'System ID'
VCR_CAP_HEADER['raid_types'] = 'Supported RAID Types'
VCR_CAP_HEADER['strip_sizes'] = 'Supported Strip Sizes'
VCR_CAP_COLUMN_SKIP_KEYS = []
VCR_CAP_VALUE_CONV_ENUM = {
'raid_types': lambda i: [VolumeRAIDInfo.raid_type_to_str(x) for x in i]
}
VCR_CAP_VALUE_CONV_HUMAN = ['strip_sizes']
VALUE_CONVERT[VcrCap] = {
'headers': VCR_CAP_HEADER,
'column_skip_keys': VCR_CAP_COLUMN_SKIP_KEYS,
'value_conv_enum': VCR_CAP_VALUE_CONV_ENUM,
'value_conv_human': VCR_CAP_VALUE_CONV_HUMAN,
}
LOCAL_DISK_HEADER = OrderedDict()
LOCAL_DISK_HEADER['sd_path'] = 'Path'
LOCAL_DISK_HEADER['vpd83'] = 'SCSI VPD 0x83'
LOCAL_DISK_HEADER['rpm'] = 'Revolutions Per Minute'
LOCAL_DISK_HEADER['link_type'] = 'Link Type'
LOCAL_DISK_HEADER['serial_num'] = 'Serial Number'
LOCAL_DISK_HEADER['led_status'] = 'LED Status'
LOCAL_DISK_HEADER['link_speed'] = 'Link Speed'
LOCAL_DISK_HEADER['health_status'] = 'Health Status'
LOCAL_DISK_COLUMN_SKIP_KEYS = ['rpm', 'led_status', 'link_speed']
LOCAL_DISK_VALUE_CONV_ENUM = {
'rpm': disk_rpm_to_str,
'link_type': disk_link_type_to_str,
'led_status': disk_led_status_to_str,
'link_speed': disk_link_speed_to_str,
'health_status': disk_health_status_to_str,
}
LOCAL_DISK_VALUE_CONV_HUMAN = []
VALUE_CONVERT[LocalDiskInfo] = {
'headers': LOCAL_DISK_HEADER,
'column_skip_keys': LOCAL_DISK_COLUMN_SKIP_KEYS,
'value_conv_enum': LOCAL_DISK_VALUE_CONV_ENUM,
'value_conv_human': LOCAL_DISK_VALUE_CONV_HUMAN,
}
BATTERY_HEADER = OrderedDict()
BATTERY_HEADER['id'] = 'ID'
BATTERY_HEADER['name'] = 'Name'
BATTERY_HEADER['type'] = 'Type'
BATTERY_HEADER['status'] = 'Status'
BATTERY_HEADER['system_id'] = 'System ID'
BATTERY_COLUMN_SKIP_KEYS = []
BATTERY_VALUE_CONV_ENUM = {
'type': battery_type_to_str,
'status': battery_status_to_str,
}
BATTERY_VALUE_CONV_HUMAN = ['']
VALUE_CONVERT[Battery] = {
'headers': BATTERY_HEADER,
'column_skip_keys': BATTERY_COLUMN_SKIP_KEYS,
'value_conv_enum': BATTERY_VALUE_CONV_ENUM,
'value_conv_human': BATTERY_VALUE_CONV_HUMAN,
}
VOL_CACHE_INFO_HEADER = OrderedDict()
VOL_CACHE_INFO_HEADER['vol_id'] = 'Volume ID'
VOL_CACHE_INFO_HEADER['write_cache_policy'] = 'Write Cache Policy'
VOL_CACHE_INFO_HEADER['write_cache_status'] = 'Write Cache'
VOL_CACHE_INFO_HEADER['read_cache_policy'] = 'Read Cache Policy'
VOL_CACHE_INFO_HEADER['read_cache_status'] = 'Read Cache'
VOL_CACHE_INFO_HEADER['phy_disk_cache'] = 'Physical Disk Cache'
VOL_CACHE_INFO_COLUMN_SKIP_KEYS = []
VOL_CACHE_INFO_VALUE_CONV_ENUM = {
'write_cache_policy': VolumeRAMCacheInfo.w_cache_policy_to_str,
'write_cache_status': VolumeRAMCacheInfo.w_cache_status_to_str,
'read_cache_policy': VolumeRAMCacheInfo.r_cache_policy_to_str,
'read_cache_status': VolumeRAMCacheInfo.r_cache_status_to_str,
'phy_disk_cache': VolumeRAMCacheInfo.phy_disk_cache_status_to_str,
}
VOL_CACHE_INFO_VALUE_CONV_HUMAN = []
VALUE_CONVERT[VolumeRAMCacheInfo] = {
'headers': VOL_CACHE_INFO_HEADER,
'column_skip_keys': VOL_CACHE_INFO_COLUMN_SKIP_KEYS,
'value_conv_enum': VOL_CACHE_INFO_VALUE_CONV_ENUM,
'value_conv_human': VOL_CACHE_INFO_VALUE_CONV_HUMAN,
}
@staticmethod
def _get_man_pro_value(obj, key, value_conv_enum, value_conv_human,
flag_human, flag_enum):
try:
value = getattr(obj, key)
except LsmError as lsm_err:
if lsm_err.code == ErrorNumber.NO_SUPPORT:
value = ''
else:
raise lsm_err
if not flag_enum:
if key in list(value_conv_enum.keys()):
value = value_conv_enum[key](value)
if flag_human:
if key in value_conv_human:
if type(value) is list:
value = list(size_bytes_2_size_human(s) for s in value)
else:
value = size_bytes_2_size_human(value)
return value
@staticmethod
def _find_max_width(two_d_list, column_index):
max_width = 1
for row_index in range(0, len(two_d_list)):
row_data = two_d_list[row_index]
if len(row_data[column_index]) > max_width:
max_width = len(row_data[column_index])
return max_width
@staticmethod
def _data_dict_gen(obj, flag_human, flag_enum, display_way,
extra_properties=None, flag_dsp_all_data=False):
data_dict = OrderedDict()
value_convert = DisplayData.VALUE_CONVERT[type(obj)]
headers = value_convert['headers']
value_conv_enum = value_convert['value_conv_enum']
value_conv_human = value_convert['value_conv_human']
if flag_dsp_all_data:
display_way = DisplayData.DISPLAY_WAY_SCRIPT
display_keys = []
if display_way == DisplayData.DISPLAY_WAY_COLUMN:
for key_name in list(headers.keys()):
if key_name not in value_convert['column_skip_keys']:
display_keys.append(key_name)
elif display_way == DisplayData.DISPLAY_WAY_SCRIPT:
display_keys = list(headers.keys())
if extra_properties:
for extra_key_name in extra_properties:
if extra_key_name not in display_keys:
display_keys.append(extra_key_name)
for key in display_keys:
key_str = headers[key]
value = DisplayData._get_man_pro_value(
obj, key, value_conv_enum, value_conv_human, flag_human,
flag_enum)
data_dict[key_str] = value
return data_dict
@staticmethod
def display_data(objs, display_way=None,
flag_human=True, flag_enum=False,
extra_properties=None,
splitter=None,
flag_with_header=True,
flag_dsp_all_data=False):
if len(objs) == 0:
return None
if display_way is None:
display_way = DisplayData.DISPLAY_WAY_DEFAULT
if splitter is None:
splitter = DisplayData.DEFAULT_SPLITTER
data_dict_list = []
if type(objs[0]) in list(DisplayData.VALUE_CONVERT.keys()):
for obj in objs:
data_dict = DisplayData._data_dict_gen(
obj, flag_human, flag_enum, display_way,
extra_properties, flag_dsp_all_data)
data_dict_list.extend([data_dict])
else:
return None
if display_way == DisplayData.DISPLAY_WAY_SCRIPT:
DisplayData.display_data_script_way(data_dict_list, splitter)
elif display_way == DisplayData.DISPLAY_WAY_COLUMN:
DisplayData._display_data_column_way(
data_dict_list, splitter, flag_with_header)
return True
@staticmethod
def display_data_script_way(data_dict_list, splitter):
key_column_width = 1
value_column_width = 1
for data_dict in data_dict_list:
for key_name in list(data_dict.keys()):
# find the max column width of key
cur_key_width = len(key_name)
if cur_key_width > key_column_width:
key_column_width = cur_key_width
# find the max column width of value
cur_value = data_dict[key_name]
if isinstance(cur_value, list):
if len(cur_value) == 0:
continue
cur_value_width = len(str(cur_value[0]))
else:
cur_value_width = len(str(cur_value))
if cur_value_width > value_column_width:
value_column_width = cur_value_width
row_format = '%%-%ds%s%%-%ds' % (key_column_width,
splitter,
value_column_width)
sub_row_format = '%s%s%%-%ds' % (' ' * key_column_width,
splitter,
value_column_width)
obj_splitter = '%s%s%s' % ('-' * key_column_width,
'-' * len(splitter),
'-' * value_column_width)
for data_dict in data_dict_list:
out(obj_splitter)
for key_name in data_dict:
value = data_dict[key_name]
if isinstance(value, list):
flag_first_data = True
for sub_value in value:
if flag_first_data:
out(row_format % (key_name, str(sub_value)))
flag_first_data = False
else:
out(sub_row_format % str(sub_value))
else:
out(row_format % (key_name, str(value)))
out(obj_splitter)
@staticmethod
def _display_data_column_way(data_dict_list, splitter, flag_with_header):
if len(data_dict_list) == 0:
return
two_d_list = []
item_count = len(list(data_dict_list[0].keys()))
# determine how many lines we will print
row_width = 0
for data_dict in data_dict_list:
cur_max_wd = 0
for key_name in list(data_dict.keys()):
if isinstance(data_dict[key_name], list):
cur_row_width = len(data_dict[key_name])
if cur_row_width > cur_max_wd:
cur_max_wd = cur_row_width
else:
pass
if cur_max_wd == 0:
cur_max_wd = 1
row_width += cur_max_wd
if flag_with_header:
# first line for header
row_width += 1
# init 2D list
for raw in range(0, row_width):
new = []
for column in range(0, item_count):
new.append('')
two_d_list.append(new)
# header
current_row_num = -1
if flag_with_header:
two_d_list[0] = list(data_dict_list[0].keys())
current_row_num = 0
# Fill the 2D list with data_dict_list
for data_dict in data_dict_list:
current_row_num += 1
save_row_num = current_row_num
values = list(data_dict.values())
for index in range(0, len(values)):
value = values[index]
if isinstance(value, list):
for sub_index in range(0, len(value)):
tmp_row_num = save_row_num + sub_index
two_d_list[tmp_row_num][index] = str(value[sub_index])
if save_row_num + len(value) > current_row_num:
current_row_num = save_row_num + len(value) - 1
else:
two_d_list[save_row_num][index] = str(value)
# display two_list
row_formats = []
header_splitter = ''
for column_index in range(0, len(two_d_list[0])):
max_width = DisplayData._find_max_width(two_d_list, column_index)
row_formats.extend(['%%-%ds' % max_width])
header_splitter += '-' * max_width
if column_index != (len(two_d_list[0]) - 1):
header_splitter += '-' * len(splitter)
row_format = splitter.join(row_formats)
for row_index in range(0, len(two_d_list)):
out(row_format % tuple(two_d_list[row_index]))
if row_index == 0 and flag_with_header:
out(header_splitter)
lsmcli/cmdline.py 0000644 00000216125 14757650541 0010041 0 ustar 00 # Copyright (C) 2012-2016 Red Hat, Inc.
# (C) Copyright 2017 Hewlett Packard Enterprise Development LP
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; If not, see .
#
# Author: tasleson
# Gris Ge
import os
import sys
import getpass
import re
import time
import tty
import termios
from argparse import ArgumentParser, ArgumentTypeError
from argparse import RawTextHelpFormatter
import six
from lsm import (Client, Pool, VERSION, LsmError, Disk,
Volume, JobStatus, ErrorNumber, BlockRange,
uri_parse, Proxy, size_human_2_size_bytes,
AccessGroup, FileSystem, NfsExport, TargetPort, LocalDisk,
Battery)
from lsm.lsmcli.data_display import (
DisplayData, PlugData, out,
vol_provision_str_to_type, vol_rep_type_str_to_type, VolumeRAIDInfo,
PoolRAIDInfo, VcrCap, LocalDiskInfo, VolumeRAMCacheInfo)
_CONNECTION_FREE_COMMANDS = ['local-disk-list',
'local-disk-ident-led-on',
'local-disk-ident-led-off',
'local-disk-fault-led-on',
'local-disk-fault-led-off']
if six.PY3:
long = int
try:
from collections import OrderedDict
except ImportError:
# python 2.6 or earlier, use backport
# noinspection PyUnresolvedReferences
from ordereddict import OrderedDict
# Wraps the invocation to the command line
# @param c Object to invoke calls on (optional)
def cmd_line_wrapper(c=None):
"""
Common command line code, called.
"""
err_exit = 0
cli = None
try:
cli = CmdLine()
cli.process(c)
except ArgError as ae:
sys.stderr.write(str(ae))
sys.stderr.flush()
err_exit = 2
except LsmError as le:
sys.stderr.write(str(le) + "\n")
sys.stderr.flush()
if le.code == ErrorNumber.PERMISSION_DENIED:
err_exit = 13 # common error code for EACCES
else:
err_exit = 4
except KeyboardInterrupt:
err_exit = 1
except SystemExit as se:
# argparse raises a SystemExit
err_exit = se.code
except:
import traceback
traceback.print_exc(file=sys.stdout)
# We get *any* other exception don't return a successful error code
err_exit = 2
finally:
# Regardless of what happens, we will try to close the connection if
# possible to allow the plugin to clean up gracefully.
if cli:
try:
# This will exit if are successful
cli.shutdown(err_exit)
except Exception:
pass
sys.exit(err_exit)
# Get a character from stdin without needing a return key pressed.
# Returns the character pressed
def getch():
fd = sys.stdin.fileno()
prev = termios.tcgetattr(fd)
try:
tty.setraw(sys.stdin.fileno())
ch = sys.stdin.read(1)
finally:
termios.tcsetattr(fd, termios.TCSADRAIN, prev)
return ch
def parse_convert_init(init_id):
"""
If init_id is a WWPN, convert it into LSM standard version:
(?:[0-9a-f]{2}:){7}[0-9a-f]{2}
Return (converted_init_id, lsm_init_type)
"""
valid, converted_init_type, converted_init_id = \
AccessGroup.initiator_id_verify(init_id)
if valid:
return converted_init_id, converted_init_type
raise ArgError("--init \"%s\" is not a valid WWPN or iSCSI IQN" % init_id)
def _check_init(init_id):
"""
Call back from validating an initiator
:param init_id: Initiator to validate
:return: Value of initiator or raises an exception
"""
valid, _, converted_init_id = \
AccessGroup.initiator_id_verify(init_id)
if valid:
return converted_init_id
raise ArgumentTypeError("\"%s\" is invalid WWPN or iSCSI IQN" % init_id)
def _check_positive_integer(num):
"""
Call back for validating a positive integer
:param num: Number string to check
:return: Numeric value, else exception
"""
try:
rc = long(num, 10)
if rc < 0:
raise ArgumentTypeError(
"invalid: require positive integer value '%d'" % rc)
return rc
except ValueError:
raise ArgumentTypeError(
"invalid: not a positive integer value '%s'" % num)
_CHILD_OPTION_DST_PREFIX = 'child_'
def _upper(s):
return s.upper()
def _valid_ip4_address(address):
"""
Check if a string represents a valid ip4 address
:param address: String representing address
:return: True if valid address, else false
"""
if not address:
return False
parts = address.split('.')
if len(parts) != 4:
return False
if '/' in address:
return False
for i in parts:
if not 0 < len(i) <= 3:
return False
if len(i) > 1 and i[0] == '0':
return False
try:
if int(i, 10) > 255:
return False
except ValueError:
return False
return True
def _valid_ip6_address(address):
"""
Check if a string represents a valid ipv6 address
:param address: String representing address
:return: True if valid address, else false
"""
allowed = 'ABCDEFabcdef0123456789:'
has_zeros = False
if not address:
return False
if '/' in address:
return False
if len(address.split("::")) > 2:
return False
parts = address.split(':')
if len(parts) < 3 or len(parts) > 9:
return False
# Check for ipv4 suffix, validate and remove while adding padding for
# addl. checks.
if '.' in parts[-1]:
if not _valid_ip4_address(parts.pop()):
print("Not valid ipv suffix")
return False
parts.extend(['0', '0'])
if '::' in address:
parts = [p for p in parts if p != '']
# Add one segment of zero to catch full address with extra ':'
parts.append('0')
has_zeros = True
if (has_zeros and len(parts) <= 8) or len(parts) == 8:
return all(len(x) <= 4 for x in parts) and \
all(x in allowed for x in "".join(parts))
return False
def _is_valid_network_name(ip_hn):
"""
Checks to see if the supplied string is a valid ip4/6 or hostname
:param ip_hn: String representing address user inputted
:return: True if valid IP address or hostname
"""
allowed = re.compile("(?!-)[A-Z0-9-]{1,63}(? 255:
return False
# A hostname cannot exist with only digits per spec. as that is confusing
# for distinguishing IP from hostname
if digits_only.match(ip_hn):
return False
if ip_hn[-1] == ".":
ip_hn = ip_hn[:-1] # Yes, absolute hostnames have a trailing dot!
return all(allowed.match(x) for x in ip_hn.split("."))
def _add_common_options(arg_parser, is_child=False):
"""
As https://bugs.python.org/issue23058 indicate, argument parser should
not have subparser sharing the same argument and destination.
For subparser, we add common options as 'child_xxx' destination.
For default value, False is the only allowed default value in root.
"""
prefix = ''
if is_child:
prefix = _CHILD_OPTION_DST_PREFIX
arg_parser.add_argument(
'-v', '--version', action='version',
version="%s %s" % (sys.argv[0], VERSION))
arg_parser.add_argument(
'-u', '--uri', action="store", type=str, metavar='',
dest="%suri" % prefix,
help='Uniform resource identifier (env LSMCLI_URI)')
arg_parser.add_argument(
'-P', '--prompt', action="store_true", dest="%sprompt" % prefix,
help='Prompt for password (env LSMCLI_PASSWORD)')
arg_parser.add_argument(
'-H', '--human', action="store_true", dest="%shuman" % prefix,
help='Print sizes in human readable format\n'
'(e.g., MiB, GiB, TiB)')
arg_parser.add_argument(
'-t', '--terse', action="store", dest="%ssep" % prefix,
metavar='',
help='Print output in terse form with "SEP" '
'as a record separator')
arg_parser.add_argument(
'-e', '--enum', action="store_true", dest="%senum" % prefix,
default=False,
help='Display enumerated types as numbers instead of text')
arg_parser.add_argument(
'-f', '--force', action="store_true", dest="%sforce" % prefix,
default=False,
help='Bypass confirmation prompt for data loss operations')
arg_parser.add_argument(
'-w', '--wait', action="store", dest="%swait" % prefix,
help="Command timeout value in ms (default = 30s)",
type=_check_positive_integer)
arg_parser.add_argument(
'--header', action="store_true", dest="%sheader" % prefix,
help='Include the header with terse')
arg_parser.add_argument(
'-b', action="store_true", dest="%s_async" % prefix, default=False,
help='Run the command async. Instead of waiting for completion.\n '
'Command will exit(7) and job id written to stdout.')
arg_parser.add_argument(
'-s', '--script', action="store_true", dest="%sscript" % prefix,
default=False,
help='Displaying data in script friendly way with '
'additional information(if exists)')
if is_child:
default_dict = dict()
default_dict['%swait' % prefix] = 30000
arg_parser.set_defaults(**default_dict)
def _add_sd_paths(lsm_obj):
lsm_obj.sd_paths = []
try:
if len(lsm_obj.vpd83) > 0:
lsm_obj.sd_paths = LocalDisk.vpd83_search(lsm_obj.vpd83)
except LsmError as lsm_err:
if lsm_err.code != ErrorNumber.NO_SUPPORT:
raise
return lsm_obj
# This class represents a command line argument error
class ArgError(Exception):
def __init__(self, message, *args, **kwargs):
"""
Class represents an error.
"""
Exception.__init__(self, *args, **kwargs)
self.msg = message
def __str__(self):
return "%s: error: %s\n" % (os.path.basename(sys.argv[0]), self.msg)
# Finds an item based on the id. Each list item requires a member "id"
# @param l list to search
# @param the_id the id to match
# @param friendly_name - name to put in the exception saying what we
# couldn't find
def _get_item(l, the_id, friendly_name='item', raise_error=True):
for item in l:
if item.id == the_id:
return item
if raise_error:
raise ArgError('%s with ID %s not found!' % (friendly_name, the_id))
else:
return None
def _check_network_host(addr):
"""
Custom value checker for hostname/IP address
:param addr:
:return:
"""
valid = _is_valid_network_name(addr)
if valid:
return addr
raise ArgumentTypeError("%s is invalid IP or hostname" % addr)
list_choices = ['VOLUMES', 'POOLS', 'FS', 'SNAPSHOTS',
'EXPORTS', "NFS_CLIENT_AUTH", 'ACCESS_GROUPS',
'SYSTEMS', 'DISKS', 'PLUGINS', 'TARGET_PORTS', 'BATTERIES']
provision_types = ('DEFAULT', 'THIN', 'FULL')
provision_help = "provisioning type: " + ", ".join(provision_types)
replicate_types = ('CLONE', 'COPY', 'MIRROR_ASYNC', 'MIRROR_SYNC')
replicate_help = "replication type: " + ", ".join(replicate_types)
policy_types = ['ENABLE', 'DISABLE']
policy_help = 'Policy: ' + ', '.join(policy_types)
policy_opt = dict(name="--policy", metavar='',
help=policy_help, choices=policy_types,
type=_upper)
write_cache_policy_types = ['WB', 'AUTO', 'WT']
write_cache_policy_help = 'Write cache polices: ' + \
', '.join(write_cache_policy_types) + \
' which stand for "write back", "auto", ' + \
'"write through"'
write_cache_policy_opt = dict(name="--policy", metavar='',
help=write_cache_policy_help,
choices=write_cache_policy_types,
type=_upper)
size_help = 'Can use B, KiB, MiB, GiB, TiB, PiB postfix (IEC sizing)'
sys_id_opt = dict(name='--sys', metavar='', help='System ID')
sys_id_filter_opt = sys_id_opt.copy()
sys_id_filter_opt['help'] = \
'Search by System ID. Only supported for: \n' \
'(VOLUMES, POOLS, FS, DISKS, ACCESS_GROUPS,\n' \
'TARGET_PORTS, BATTERIES)'
pool_id_opt = dict(name='--pool', metavar='', help='Pool ID')
pool_id_filter_opt = pool_id_opt.copy()
pool_id_filter_opt['help'] = \
'Search by Pool ID. Only supported for:\n' \
'(VOLUMES, POOLS, FS)'
vol_id_opt = dict(name='--vol', metavar='', help='Volume ID')
vol_id_filter_opt = vol_id_opt.copy()
vol_id_filter_opt['help'] = \
'Search by Volume ID. Only supported for:\n' \
'(VOLUMES, ACCESS_GROUPS)'
fs_id_opt = dict(name='--fs', metavar='', help='File System ID')
fs_id_filter_opt = fs_id_opt.copy()
fs_id_filter_opt['help'] = \
'Search by FS ID. Only supported for:\n' \
'(FS, SNAPSHOTS, EXPORTS)'
ag_id_opt = dict(name='--ag', metavar='', help='Access Group ID')
ag_id_filter_opt = ag_id_opt.copy()
ag_id_filter_opt['help'] = \
'Search by Access Group ID. Only supported for:\n' \
'(ACCESS_GROUPS, VOLUMES)'
init_id_opt = dict(name='--init', metavar='', help='Initiator ID',
type=_check_init)
snap_id_opt = dict(name='--snap', metavar='', help='Snapshot ID')
export_id_opt = dict(name='--export', metavar='', help='Export ID')
nfs_export_id_filter_opt = dict(
name='--nfs-export', metavar='',
help=
'Search by NFS Export ID. Only supported for:\n'
'(EXPORTS)')
disk_id_filter_opt = dict(name='--disk', metavar='',
help='Search by Disk ID. Only supported for:\n'
'(DISKS)')
size_opt = dict(name='--size', metavar='', help=size_help)
tgt_id_filter_opt = dict(name="--tgt", metavar='',
help="Search by target port ID. Only supported for:\n"
"(TARGET_PORTS)")
local_disk_path_opt = dict(name='--path', help="Local disk path",
metavar='')
cmds = (
dict(
name='list',
help="List records of different types",
args=[
dict(name='--type',
help="List records of type:\n " +
"\n ".join(list_choices) +
"\n\nWhen listing SNAPSHOTS, it requires --fs .",
metavar='',
choices=list_choices,
type=_upper),
],
optional=[
dict(sys_id_filter_opt),
dict(pool_id_filter_opt),
dict(vol_id_filter_opt),
dict(disk_id_filter_opt),
dict(ag_id_filter_opt),
dict(fs_id_filter_opt),
dict(nfs_export_id_filter_opt),
dict(tgt_id_filter_opt),
],
),
dict(
name='job-status',
help='Retrieve information about a job',
args=[
dict(name="--job", metavar="", help='job status id'),
],
),
dict(
name='capabilities',
help='Retrieves array capabilities',
args=[
dict(sys_id_opt),
],
),
dict(
name='plugin-info',
help='Retrieves plugin description and version',
),
dict(
name='volume-create',
help='Creates a volume (logical unit)',
args=[
dict(name="--name", help='volume name', metavar=''),
dict(size_opt),
dict(pool_id_opt),
],
optional=[
dict(name="--provisioning", help=provision_help,
default='DEFAULT',
choices=provision_types,
type=_upper),
],
),
dict(
name='volume-raid-create',
help='Creates a RAIDed volume on hardware RAID',
args=[
dict(name="--name", help='volume name', metavar=''),
dict(name="--disk", metavar='',
help='Free disks for new RAIDed volume.\n'
'This is repeatable argument.',
action='append'),
dict(name="--raid-type",
help="RAID type for the new RAID group. "
"Should be one of these:\n %s" %
"\n ".
join(VolumeRAIDInfo.VOL_CREATE_RAID_TYPES_STR),
choices=VolumeRAIDInfo.VOL_CREATE_RAID_TYPES_STR,
type=_upper),
],
optional=[
dict(name="--strip-size",
help="Strip size. " + size_help),
],
),
dict(
name='volume-raid-create-cap',
help='Query capability of creating a RAIDed volume on hardware RAID',
args=[
dict(sys_id_opt),
],
),
dict(
name='volume-delete',
help='Deletes a volume given its id',
args=[
dict(vol_id_opt),
],
),
dict(
name='volume-resize',
help='Re-sizes a volume',
args=[
dict(vol_id_opt),
dict(name='--size', metavar='',
help="New size. %s" % size_help),
],
),
dict(
name='volume-replicate',
help='Creates a new volume and replicates provided volume to it.',
args=[
dict(vol_id_opt),
dict(name="--name", metavar='',
help='The name for New replicated volume'),
dict(name="--rep-type", metavar='',
help=replicate_help, choices=replicate_types),
],
optional=[
dict(name="--pool",
help='Pool ID to contain the new volume.\nBy default, '
'new volume will be created in the same pool.'),
],
),
dict(
name='volume-replicate-range',
help='Replicates a portion of a volume to existing volume',
args=[
dict(name="--src-vol", metavar='',
help='Source volume id'),
dict(name="--dst-vol", metavar='',
help='Destination volume id'),
dict(name="--rep-type", metavar='',
help="Replication type: CLONE, COPY",
choices=["CLONE", "COPY"]),
dict(name="--src-start", metavar='',
help='Source volume start block number.\n'
'This is repeatable argument.',
action='append', type=_check_positive_integer),
dict(name="--dst-start", metavar='',
help='Destination volume start block number.\n'
'This is repeatable argument.',
action='append', type=_check_positive_integer),
dict(name="--count", metavar='',
help='Number of blocks to replicate.\n'
'This is repeatable argument.',
action='append', type=_check_positive_integer),
],
),
dict(
name='volume-replicate-range-block-size',
help='Size of each replicated block on a system in bytes',
args=[
dict(sys_id_opt),
],
),
dict(
name='volume-dependants',
help='Returns True if volume has a dependant child, like replication',
args=[
dict(vol_id_opt),
],
),
dict(
name='volume-dependants-rm',
help='Removes volume dependencies',
args=[
dict(vol_id_opt),
],
),
dict(
name='volume-access-group',
help='Lists the access group(s) that have access to volume',
args=[
dict(vol_id_opt),
],
),
dict(
name='volume-mask',
help='Grants access to an access group to a volume, '
'like LUN Masking',
args=[
dict(vol_id_opt),
dict(ag_id_opt),
],
),
dict(
name='volume-unmask',
help='Revoke the access of specified access group to a volume',
args=[
dict(ag_id_opt),
dict(vol_id_opt),
],
),
dict(
name='volume-enable',
help='Enable block access of a volume',
args=[
dict(vol_id_opt),
],
),
dict(
name='volume-disable',
help='Disable block access of a volume',
args=[
dict(vol_id_opt),
],
),
dict(
name='volume-raid-info',
help='Query volume RAID information',
args=[
dict(vol_id_opt),
],
),
dict(
name='volume-ident-led-on',
help='Enable the IDENT LED for a volume',
args=[
dict(name="--vol", metavar='',
help='Targeted volume.\n'),
],
),
dict(
name='volume-ident-led-off',
help='Disable the IDENT LED for a volume',
args=[
dict(name="--vol", metavar='',
help='Targeted volume.\n'),
],
),
dict(
name='system-read-cache-pct-update',
help='Change the read cache percentage of a system',
args=[
dict(name="--sys", metavar='',
help='Targeted system.\n'),
dict(name="--read-pct",
help="Read cache percentage.\n",
type=_check_positive_integer),
],
),
dict(
name='pool-member-info',
help='Query Pool membership information',
args=[
dict(pool_id_opt),
],
),
dict(
name='access-group-create',
help='Create an access group',
args=[
dict(name='--name', metavar='',
help="Human readable name for access group"),
# TODO: _client.py access_group_create should support multiple
# initiators when creating.
dict(init_id_opt),
dict(sys_id_opt),
],
),
dict(
name='access-group-add',
help='Add an initiator into existing access group',
args=[
dict(ag_id_opt),
dict(init_id_opt),
],
),
dict(
name='access-group-remove',
help='Remove an initiator from existing access group',
args=[
dict(ag_id_opt),
dict(init_id_opt),
],
),
dict(
name='access-group-delete',
help='Deletes an access group',
args=[
dict(ag_id_opt),
],
),
dict(
name='access-group-volumes',
help='Lists the volumes that the access group has'
' been granted access to',
args=[
dict(ag_id_opt),
],
),
dict(
name='iscsi-chap',
help='Configures iSCSI inbound/outbound CHAP authentication',
args=[
dict(init_id_opt),
],
optional=[
dict(name="--in-user", metavar='',
help='Inbound chap user name'),
dict(name="--in-pass", metavar='',
help='Inbound chap password'),
dict(name="--out-user", metavar='',
help='Outbound chap user name'),
dict(name="--out-pass", metavar='',
help='Outbound chap password'),
],
),
dict(
name='fs-create',
help='Creates a file system',
args=[
dict(name="--name", metavar='',
help='name of the file system'),
dict(size_opt),
dict(pool_id_opt),
],
),
dict(
name='fs-delete',
help='Delete a filesystem',
args=[
dict(fs_id_opt)
],
),
dict(
name='fs-resize',
help='Re-sizes a filesystem',
args=[
dict(fs_id_opt),
dict(name="--size", metavar="",
help="New size. %s" % size_help),
],
),
dict(
name='fs-export',
help='Export a filesystem via NFS.',
args=[
dict(fs_id_opt),
],
optional=[
dict(name="--exportpath", metavar='',
help="NFS server export path. e.g. '/foo/bar'."),
dict(name="--anonuid", metavar='',
help='UID(User ID) to map to anonymous user',
default=NfsExport.ANON_UID_GID_NA,
type=_check_positive_integer),
dict(name="--anongid", metavar='',
help='GID(Group ID) to map to anonymous user',
default=NfsExport.ANON_UID_GID_NA,
type=_check_positive_integer),
dict(name="--auth-type", metavar='',
help='NFS client authentication type'),
dict(name="--root-host", metavar='',
help="The host/IP has root access.\n"
"This is repeatable argument.",
action='append',
default=[], type=_check_network_host),
dict(name="--ro-host", metavar='',
help="The host/IP has readonly access.\n"
"This is repeatable argument.\n"
"At least one '--ro-host' or '--rw-host' is required.",
action='append', default=[], type=_check_network_host),
dict(name="--rw-host", metavar='',
help="The host/IP has readwrite access.\n"
"This is repeatable argument.\n"
"At least one '--ro-host' or '--rw-host' is required.",
action='append', default=[], type=_check_network_host),
],
),
dict(
name='fs-unexport',
help='Remove an NFS export',
args=[
dict(export_id_opt),
],
),
dict(
name='fs-clone',
help='Creates a file system clone',
args=[
dict(name="--src-fs", metavar='',
help='The ID of existing source file system.'),
dict(name="--dst-name", metavar='',
help='The name for newly created destination file system.'),
],
optional=[
dict(name="--backing-snapshot", metavar='',
help='backing snapshot id'),
],
),
dict(
name='fs-snap-create',
help='Creates a snapshot',
args=[
dict(name="--name", metavar="",
help='The human friendly name of new snapshot'),
dict(fs_id_opt),
],
),
dict(
name='fs-snap-delete',
help='Deletes a snapshot',
args=[
dict(snap_id_opt),
dict(fs_id_opt), # TODO: why we need filesystem ID?
],
),
dict(
name='fs-snap-restore',
help='Restores a FS or specified files to '
'previous snapshot state',
args=[
dict(snap_id_opt),
dict(fs_id_opt),
],
optional=[
dict(name="--file", metavar="",
help="Only restore provided file\n"
"Without this argument, all files will be restored\n"
"This is a repeatable argument.",
action='append', default=[]),
dict(name="--fileas", metavar="",
help="store restore file name to another name.\n"
"This is a repeatable argument.",
action='append',
default=[]),
],
),
dict(
name='fs-dependants',
help='Returns True if filesystem has a child '
'dependency(clone/snapshot) exists',
args=[
dict(fs_id_opt),
],
optional=[
dict(name="--file", metavar="",
action="append", default=[],
help="For file check\nThis is a repeatable argument."),
],
),
dict(
name='fs-dependants-rm',
help='Removes file system dependencies',
args=[
dict(fs_id_opt),
],
optional=[
dict(name="--file", action='append', default=[],
help='File or files to remove dependencies for.\n'
"This is a repeatable argument.",),
],
),
dict(
name='file-clone',
help='Creates a clone of a file (thin provisioned)',
args=[
dict(fs_id_opt),
dict(name="--src", metavar="",
help='source file to clone (relative path)\n'
"This is a repeatable argument.",),
dict(name="--dst", metavar="",
help='Destination file (relative path)'
", this is a repeatable argument."),
],
optional=[
dict(name="--backing-snapshot", help='backing snapshot id'),
],
),
dict(
name='local-disk-list',
help='Query local disk information',
args=[
],
optional=[
],
),
dict(
name='volume-cache-info',
help='Query volume RAM cache information',
args=[
dict(vol_id_opt),
],
),
dict(
name='volume-phy-disk-cache-update',
help='Update volume physical disk cache setting',
args=[
dict(vol_id_opt),
dict(policy_opt),
],
),
dict(
name='volume-read-cache-policy-update',
help='Update volume read cache policy',
args=[
dict(vol_id_opt),
dict(policy_opt),
],
),
dict(
name='volume-write-cache-policy-update',
help='Update volume write cache policy',
args=[
dict(vol_id_opt),
dict(write_cache_policy_opt),
],
),
dict(
name='local-disk-ident-led-on',
help='Turn on the identification LED for a local disk',
args=[
dict(local_disk_path_opt),
],
),
dict(
name='local-disk-ident-led-off',
help='Turn off the identification LED for a local disk',
args=[
dict(local_disk_path_opt),
],
),
dict(
name='local-disk-fault-led-on',
help='Turn on the fault LED for a local disk',
args=[
dict(local_disk_path_opt),
],
),
dict(
name='local-disk-fault-led-off',
help='Turn off the fault LED for a local disk',
args=[
dict(local_disk_path_opt),
],
),
)
aliases = dict(
ls='list --type systems',
lp='list --type pools',
lv='list --type volumes',
ld='list --type disks',
la='list --type access_groups',
lf='list --type fs',
lt='list --type target_ports',
c='capabilities',
p='plugin-info',
vc='volume-create',
vrc='volume-raid-create',
vrcc='volume-raid-create-cap',
vd='volume-delete',
vr='volume-resize',
vm='volume-mask',
vu='volume-unmask',
ve='volume-enable',
vi='volume-disable',
ac='access-group-create',
aa='access-group-add',
ar='access-group-remove',
ad='access-group-delete',
vri='volume-raid-info',
vilon='volume-ident-led-on',
viloff='volume-ident-led-off',
srcpu='system-read-cache-pct-update',
pmi='pool-member-info',
ldl='local-disk-list',
lb='list --type batteries',
vci='volume-cache-info',
vpdcu='volume-phy-disk-cache-update',
vrcpu='volume-read-cache-policy-update',
vwcpu='volume-write-cache-policy-update',
ldilon='local-disk-ident-led-on',
ldiloff='local-disk-ident-led-off',
ldflon='local-disk-fault-led-on',
ldfloff='local-disk-fault-led-off',
)
# Class that encapsulates the command line arguments for lsmcli
# Note: This class is used by lsmcli and any python plug-ins.
class CmdLine(object):
"""
Command line interface class.
"""
##
# Warn of imminent data loss
# @param deleting Indicate data will be lost vs. may be lost
# (re-size)
# @return True if operation confirmed, else False
def confirm_prompt(self, deleting):
"""
Give the user a chance to bail.
"""
if not self.args.force:
msg = "will" if deleting else "may"
out("Warning: You are about to do an operation that %s cause data "
"to be lost!\nPress [Y|y] to continue, any other key to abort"
% msg)
pressed = getch()
if pressed.upper() == 'Y':
return True
else:
out('Operation aborted!')
return False
else:
return True
##
# Tries to make the output better when it varies considerably from
# plug-in to plug-in.
# @param objects Data, first row is header all other data.
def display_data(self, objects):
display_all = False
if len(objects) == 0:
return
display_way = DisplayData.DISPLAY_WAY_DEFAULT
flag_with_header = True
if self.args.sep:
flag_with_header = False
if self.args.header:
flag_with_header = True
if self.args.script:
display_way = DisplayData.DISPLAY_WAY_SCRIPT
DisplayData.display_data(
objects, display_way=display_way, flag_human=self.args.human,
flag_enum=self.args.enum,
splitter=self.args.sep, flag_with_header=flag_with_header,
flag_dsp_all_data=display_all)
def display_available_plugins(self):
d = []
sep = '<}{>'
plugins = Client.available_plugins(sep)
for p in plugins:
desc, version = p.split(sep)
d.append(PlugData(desc, version))
self.display_data(d)
@staticmethod
def handle_alias():
"""
Walk the command line argument list and build up a new command line
with the appropriate substitutions which is then passed to argparse, so
that we can avoid adding more sub parsers and do all argument parsing
before the need to talk to the library
:return copy of command line args with alias expansion:
"""
rc = []
for i in sys.argv[1:]:
if i in aliases:
rc.extend(aliases[i].split(" "))
else:
rc.append(i)
return rc
@staticmethod
def alias_help_text():
rc = "command aliases:\n"
for k, v in sorted(aliases.items()):
rc += " {0:<18} Alias of '{1}'\n".format(k, v)
return rc
# All the command line arguments and options are created in this method
def cli(self):
"""
Command line interface parameters
"""
parent_parser = ArgumentParser(add_help=False)
_add_common_options(parent_parser, is_child=True)
parser = ArgumentParser(
description='The libStorageMgmt command line interface.'
' Run %(prog)s -h for more on each command.',
epilog=CmdLine.alias_help_text() +
'\n\nCopyright 2012-2018 Red Hat, Inc.\n'
'Please report bugs to '
'\n',
formatter_class=RawTextHelpFormatter)
_add_common_options(parser, is_child=False)
subparsers = parser.add_subparsers(metavar="command")
# Walk the command list and add all of them to the parser
for cmd in cmds:
sub_parser = subparsers.add_parser(
cmd['name'], help=cmd['help'], parents=[parent_parser],
formatter_class=RawTextHelpFormatter)
group = sub_parser.add_argument_group("cmd required arguments")
for arg in cmd.get('args', []):
name = arg['name']
del arg['name']
group.add_argument(name, required=True, **arg)
group = sub_parser.add_argument_group("cmd optional arguments")
for arg in cmd.get('optional', []):
flags = arg['name']
del arg['name']
if not isinstance(flags, tuple):
flags = (flags,)
group.add_argument(*flags, **arg)
sub_parser.set_defaults(
func=getattr(self, cmd['name'].replace("-", "_")))
if len(sys.argv) == 1:
parser.print_usage()
exit(1)
self.parser = parser
known_args = parser.parse_args(args=CmdLine.handle_alias())
# Copy child value to root.
for k, v in vars(known_args).items():
if k.startswith(_CHILD_OPTION_DST_PREFIX):
root_k = k[len(_CHILD_OPTION_DST_PREFIX):]
if getattr(known_args, root_k) is None or \
getattr(known_args, root_k) is False:
setattr(known_args, root_k, v)
return known_args
# Display the types of nfs client authentication that are supported.
# @return None
def display_nfs_client_authentication(self):
"""
Dump the supported nfs client authentication types
"""
if self.args.sep:
out(self.args.sep.join(self.c.export_auth()))
else:
out(", ".join(self.c.export_auth()))
# Determine what the search key and search value are for listing
# @param args Argparse argument object
# @return (key, value) tuple
@staticmethod
def _get_search_key_value(args):
search_key = None
search_value = None
search_args = ((args.sys, 'system_id'),
(args.pool, 'pool_id'),
(args.vol, 'volume_id'),
(args.disk, 'disk_id'),
(args.ag, 'access_group_id'),
(args.fs, 'fs_id'),
(args.nfs_export, 'nfs_export_id'),
(args.tgt, 'tgt_port_id'))
for sa in search_args:
if sa[0]:
if search_key:
raise ArgError(
"Search key specified more than once (%s, %s)" %
(search_key, sa[1]))
else:
(search_value, search_key) = sa
return search_key, search_value
# Method that calls the appropriate method based on what the list type is
# @param args Argparse argument object
def list(self, args):
(search_key, search_value) = CmdLine._get_search_key_value(args)
if args.type == 'VOLUMES':
lsm_vols = []
if search_key == 'volume_id':
search_key = 'id'
if search_key == 'access_group_id':
lsm_ag = _get_item(self.c.access_groups(), args.ag,
"Access Group", raise_error=False)
if lsm_ag:
lsm_vols = self.c.volumes_accessible_by_access_group(
lsm_ag)
elif search_key and search_key not in Volume.SUPPORTED_SEARCH_KEYS:
raise ArgError("Search key '%s' is not supported by "
"volume listing." % search_key)
else:
lsm_vols = self.c.volumes(search_key, search_value)
self.display_data(list(_add_sd_paths(v) for v in lsm_vols))
elif args.type == 'POOLS':
if search_key == 'pool_id':
search_key = 'id'
if search_key and search_key not in Pool.SUPPORTED_SEARCH_KEYS:
raise ArgError("Search key '%s' is not supported by "
"pool listing." % search_key)
self.display_data(
self.c.pools(search_key, search_value))
elif args.type == 'FS':
if search_key == 'fs_id':
search_key = 'id'
if search_key and \
search_key not in FileSystem.SUPPORTED_SEARCH_KEYS:
raise ArgError("Search key '%s' is not supported by "
"volume listing." % search_key)
self.display_data(self.c.fs(search_key, search_value))
elif args.type == 'SNAPSHOTS':
if args.fs is None:
raise ArgError("--fs required")
if search_key and search_key != "fs_id":
raise ArgError("Search key '%s' is not supported by "
"snapshot listing." % search_key)
fs = _get_item(self.c.fs(), args.fs, 'File System')
self.display_data(self.c.fs_snapshots(fs))
elif args.type == 'EXPORTS':
if search_key == 'nfs_export_id':
search_key = 'id'
if search_key and \
search_key not in NfsExport.SUPPORTED_SEARCH_KEYS:
raise ArgError("Search key '%s' is not supported by "
"NFS Export listing" % search_key)
self.display_data(self.c.exports(search_key, search_value))
elif args.type == 'NFS_CLIENT_AUTH':
if search_key:
raise ArgError("NFS client authentication type listing with "
"search is not supported")
self.display_nfs_client_authentication()
elif args.type == 'ACCESS_GROUPS':
if search_key == 'access_group_id':
search_key = 'id'
if search_key == 'volume_id':
lsm_vol = _get_item(self.c.volumes(), args.vol,
"Volume", raise_error=False)
if lsm_vol:
return self.display_data(
self.c.access_groups_granted_to_volume(lsm_vol))
else:
return self.display_data([])
elif (search_key and
search_key not in AccessGroup.SUPPORTED_SEARCH_KEYS):
raise ArgError("Search key '%s' is not supported by "
"Access Group listing" % search_key)
self.display_data(
self.c.access_groups(search_key, search_value))
elif args.type == 'SYSTEMS':
if search_key:
raise ArgError("System listing with search is not supported")
self.display_data(self.c.systems())
elif args.type == 'DISKS':
if search_key == 'disk_id':
search_key = 'id'
if search_key and search_key not in Disk.SUPPORTED_SEARCH_KEYS:
raise ArgError("Search key '%s' is not supported by "
"disk listing" % search_key)
self.display_data(
list(_add_sd_paths(d)
for d in self.c.disks(search_key, search_value)))
elif args.type == 'TARGET_PORTS':
if search_key == 'tgt_port_id':
search_key = 'id'
if search_key and \
search_key not in TargetPort.SUPPORTED_SEARCH_KEYS:
raise ArgError("Search key '%s' is not supported by "
"target port listing" % search_key)
self.display_data(
self.c.target_ports(search_key, search_value))
elif args.type == 'PLUGINS':
if search_key:
raise ArgError("Plugins listing with search is not supported")
self.display_available_plugins()
elif args.type == 'BATTERIES':
if search_key and \
search_key not in Battery.SUPPORTED_SEARCH_KEYS:
raise ArgError("Search key '%s' is not supported by "
"battery listing" % search_key)
self.display_data(
self.c.batteries(search_key, search_value))
else:
raise ArgError("unsupported listing type=%s" % args.type)
# Creates an access group.
def access_group_create(self, args):
system = _get_item(self.c.systems(), args.sys, "System")
(init_id, init_type) = parse_convert_init(args.init)
access_group = self.c.access_group_create(args.name, init_id,
init_type, system)
self.display_data([access_group])
def _add_rm_access_grp_init(self, args, op):
lsm_ag = _get_item(self.c.access_groups(), args.ag, "Access Group")
(init_id, init_type) = parse_convert_init(args.init)
if op:
return self.c.access_group_initiator_add(lsm_ag, init_id,
init_type)
else:
return self.c.access_group_initiator_delete(lsm_ag, init_id,
init_type)
# Adds an initiator from an access group
def access_group_add(self, args):
self.display_data([self._add_rm_access_grp_init(args, True)])
# Removes an initiator from an access group
def access_group_remove(self, args):
self.display_data([self._add_rm_access_grp_init(args, False)])
def access_group_volumes(self, args):
agl = self.c.access_groups()
group = _get_item(agl, args.ag, "Access Group")
vols = self.c.volumes_accessible_by_access_group(group)
self.display_data(list(_add_sd_paths(v) for v in vols))
def iscsi_chap(self, args):
(init_id, init_type) = parse_convert_init(args.init)
if init_type != AccessGroup.INIT_TYPE_ISCSI_IQN:
raise ArgError("--init \"%s\" is not a valid iSCSI IQN" % args.init)
if self.args.in_user and not self.args.in_pass:
raise ArgError("--in-user requires --in-pass")
if self.args.in_pass and not self.args.in_user:
raise ArgError("--in-pass requires --in-user")
if self.args.out_user and not self.args.out_pass:
raise ArgError("--out-user requires --out-pass")
if self.args.out_pass and not self.args.out_user:
raise ArgError("--out-pass requires --out-user")
# Enforce consistency across all
if self.args.out_user and self.args.out_pass and not \
(self.args.in_user and self.args.in_pass):
raise ArgError("out-user and out-password only supported if "
"inbound is supplied")
self.c.iscsi_chap_auth(init_id, args.in_user,
self.args.in_pass,
self.args.out_user,
self.args.out_pass)
def volume_access_group(self, args):
vol = _get_item(self.c.volumes(), args.vol, "Volume")
groups = self.c.access_groups_granted_to_volume(vol)
self.display_data(groups)
# Used to delete access group
def access_group_delete(self, args):
agl = self.c.access_groups()
group = _get_item(agl, args.ag, "Access Group")
return self.c.access_group_delete(group)
# Used to delete a file system
def fs_delete(self, args):
fs = _get_item(self.c.fs(), args.fs, "File System")
if self.confirm_prompt(True):
self._wait_for_it("fs-delete", self.c.fs_delete(fs), None)
# Used to create a file system
def fs_create(self, args):
p = _get_item(self.c.pools(), args.pool, "Pool")
fs = self._wait_for_it("fs-create",
*self.c.fs_create(p, args.name,
self._size(args.size)))
self.display_data([fs])
# Used to resize a file system
def fs_resize(self, args):
fs = _get_item(self.c.fs(), args.fs, "File System")
size = self._size(args.size)
if size == fs.total_space:
raise LsmError(
ErrorNumber.NO_STATE_CHANGE, "Specified size same as current")
if self.confirm_prompt(False):
fs = self._wait_for_it("fs-resize",
*self.c.fs_resize(fs, size))
self.display_data([fs])
# Used to clone a file system
def fs_clone(self, args):
src_fs = _get_item(
self.c.fs(), args.src_fs, "Source File System")
ss = None
if args.backing_snapshot:
# go get the snapshot
ss = _get_item(self.c.fs_snapshots(src_fs),
args.backing_snapshot, "Snapshot")
fs = self._wait_for_it(
"fs_clone", *self.c.fs_clone(src_fs, args.dst_name, ss))
self.display_data([fs])
# Used to clone a file(s)
def file_clone(self, args):
fs = _get_item(self.c.fs(), args.fs, "File System")
if self.args.backing_snapshot:
# go get the snapshot
ss = _get_item(self.c.fs_snapshots(fs),
args.backing_snapshot, "Snapshot")
else:
ss = None
self._wait_for_it(
"fs_file_clone", self.c.fs_file_clone(fs, args.src, args.dst, ss),
None)
# Converts a size parameter into the appropriate number of bytes
# @param s Size to convert to bytes handles B, K, M, G, T, P postfix
# @return Size in bytes
@staticmethod
def _size(s):
size_bytes = size_human_2_size_bytes(s)
if size_bytes <= 0:
raise ArgError("Incorrect size argument format: '%s'" % s)
return size_bytes
def _cp(self, cap, val):
if self.args.sep is not None:
s = self.args.sep
else:
s = ':'
if val:
v = "SUPPORTED"
else:
v = "UNSUPPORTED"
out("%s%s%s" % (cap, s, v))
def capabilities(self, args):
s = _get_item(self.c.systems(), args.sys, "System")
cap = self.c.capabilities(s)
sup_caps = sorted(cap.get_supported().values())
all_caps = sorted(cap.get_supported(True).values())
sep = DisplayData.DEFAULT_SPLITTER
if self.args.sep is not None:
sep = self.args.sep
cap_data = OrderedDict()
# Show support capabilities first
for v in sup_caps:
cap_data[v] = 'SUPPORTED'
for v in all_caps:
if v not in sup_caps:
cap_data[v] = 'UNSUPPORTED'
DisplayData.display_data_script_way([cap_data], sep)
def plugin_info(self, args):
desc, version = self.c.plugin_info()
if args.sep:
out("%s%s%s" % (desc, args.sep, version))
else:
out("Description: %s Version: %s" % (desc, version))
# Creates a volume
def volume_create(self, args):
# Get pool
p = _get_item(self.c.pools(), args.pool, "Pool")
vol = self._wait_for_it(
"volume-create",
*self.c.volume_create(
p,
args.name,
self._size(args.size),
vol_provision_str_to_type(args.provisioning)))
self.display_data([_add_sd_paths(vol)])
# Creates a snapshot
def fs_snap_create(self, args):
# Get fs
fs = _get_item(self.c.fs(), args.fs, "File System")
ss = self._wait_for_it("snapshot-create",
*self.c.fs_snapshot_create(
fs,
args.name))
self.display_data([ss])
# Restores a snap shot
def fs_snap_restore(self, args):
# Get snapshot
fs = _get_item(self.c.fs(), args.fs, "File System")
ss = _get_item(self.c.fs_snapshots(fs), args.snap, "Snapshot")
files = self.args.file
if len(files) == 0:
files = None
flag_all_files = True
if self.args.file:
flag_all_files = False
if self.args.fileas:
if len(self.args.file) != len(self.args.fileas):
raise ArgError(
"number of --file not equal to --fileas")
if self.confirm_prompt(True):
self._wait_for_it(
'fs-snap-restore',
self.c.fs_snapshot_restore(
fs, ss, files, self.args.fileas, flag_all_files),
None)
# Deletes a volume
def volume_delete(self, args):
v = _get_item(self.c.volumes(), args.vol, "Volume")
if self.confirm_prompt(True):
self._wait_for_it("volume-delete", self.c.volume_delete(v),
None)
# Deletes a snap shot
def fs_snap_delete(self, args):
fs = _get_item(self.c.fs(), args.fs, "File System")
ss = _get_item(self.c.fs_snapshots(fs), args.snap, "Snapshot")
if self.confirm_prompt(True):
self._wait_for_it("fs_snap_delete",
self.c.fs_snapshot_delete(fs, ss), None)
# Waits for an operation to complete by polling for the status of the
# operations.
# @param msg Message to display if this job fails
# @param job The job id to wait on
# @param item The item that could be available now if there is no job
def _wait_for_it(self, msg, job, item):
if not job:
return item
else:
# If a user doesn't want to wait, return the job id to stdout
# and exit with job in progress
if self.args._async:
out(job)
self.shutdown(ErrorNumber.JOB_STARTED)
while True:
(s, percent, item) = self.c.job_status(job)
if s == JobStatus.INPROGRESS:
# Add an option to spit out progress?
# print "%s - Percent %s complete" % (job, percent)
time.sleep(0.25)
elif s == JobStatus.COMPLETE:
self.c.job_free(job)
return item
else:
# Something better to do here?
raise ArgError(msg + " job error code= " + str(s))
# Retrieves the status of the specified job
def job_status(self, args):
(s, percent, item) = self.c.job_status(args.job)
if s == JobStatus.COMPLETE:
if item:
self.display_data([_add_sd_paths(item)])
self.c.job_free(args.job)
else:
out(str(percent))
self.shutdown(ErrorNumber.JOB_STARTED)
# Replicates a volume
def volume_replicate(self, args):
p = None
if args.pool:
p = _get_item(self.c.pools(), args.pool, "Pool")
v = _get_item(self.c.volumes(), args.vol, "Volume")
rep_type = vol_rep_type_str_to_type(args.rep_type)
if rep_type == Volume.REPLICATE_UNKNOWN:
raise ArgError("invalid replication type= %s" % rep_type)
vol = self._wait_for_it(
"replicate volume",
*self.c.volume_replicate(p, rep_type, v, args.name))
self.display_data([_add_sd_paths(vol)])
# Check to see if block ranges are overlapping
@staticmethod
def _check_overlap(ranges):
def _overlap(r, member):
for i in range(1, len(r)):
ps = getattr(r[i - 1], member) # Previous start
pc = r[i - 1].block_count # Previous count
cs = getattr(r[i], member) # Current start
cc = r[i].block_count # Current count
if ps + pc > cs:
raise ArgError("Overlapping %s replication "
"range %d..%d overlaps with %d..%d" %
(member, ps, ps + pc - 1, cs, cs + cc - 1))
# Sort the src ranges
ranges.sort(key=lambda x: x.src_block)
_overlap(ranges, "src_block")
ranges.sort(key=lambda x: x.dest_block)
_overlap(ranges, "dest_block")
# Replicates a range of a volume
def volume_replicate_range(self, args):
src = _get_item(self.c.volumes(), args.src_vol, "Source Volume")
dst = _get_item(self.c.volumes(), args.dst_vol,
"Destination Volume")
rep_type = vol_rep_type_str_to_type(args.rep_type)
if rep_type == Volume.REPLICATE_UNKNOWN:
raise ArgError("invalid replication type= %s" % rep_type)
src_starts = args.src_start
dst_starts = args.dst_start
counts = args.count
if not len(src_starts) \
or not (len(src_starts) == len(dst_starts) == len(counts)):
raise ArgError("Differing numbers of src_start, dest_start, "
"and count parameters")
ranges = []
for b in range(len(src_starts)):
# Validate some assumptions for source & count
count = long(counts[b])
src_start = long(src_starts[b])
dst_start = long(dst_starts[b])
if count < 0:
raise ArgError("--count: value < 0")
if src_start < 0:
raise ArgError("--src-start: value < 0")
if dst_start < 0:
raise ArgError("--dst_start: value < 0")
if src_start + count > src.num_of_blocks:
raise ArgError("--src-start + --count > source size")
if dst_start + count > dst.num_of_blocks:
raise ArgError("--dst-start + --count > destination size")
ranges.append(BlockRange(src_start, dst_start, count))
CmdLine._check_overlap(ranges)
if self.confirm_prompt(False):
self.c.volume_replicate_range(rep_type, src, dst, ranges)
#
# Returns the block size in bytes for each block represented in
# volume_replicate_range
def volume_replicate_range_block_size(self, args):
s = _get_item(self.c.systems(), args.sys, "System")
out(self.c.volume_replicate_range_block_size(s))
def volume_mask(self, args):
vol = _get_item(self.c.volumes(), args.vol, 'Volume')
ag = _get_item(self.c.access_groups(), args.ag, 'Access Group')
self.c.volume_mask(ag, vol)
def volume_unmask(self, args):
ag = _get_item(self.c.access_groups(), args.ag, "Access Group")
vol = _get_item(self.c.volumes(), args.vol, "Volume")
return self.c.volume_unmask(ag, vol)
# Re-sizes a volume
def volume_resize(self, args):
v = _get_item(self.c.volumes(), args.vol, "Volume")
size = self._size(args.size)
if size == v.block_size * v.num_of_blocks:
raise LsmError(
ErrorNumber.NO_STATE_CHANGE, "Specified size same as current")
if self.confirm_prompt(False):
vol = self._wait_for_it("resize",
*self.c.volume_resize(v, size))
self.display_data([_add_sd_paths(vol)])
# Enable a volume
def volume_enable(self, args):
v = _get_item(self.c.volumes(), args.vol, "Volume")
self.c.volume_enable(v)
# Disable a volume
def volume_disable(self, args):
v = _get_item(self.c.volumes(), args.vol, "Volume")
self.c.volume_disable(v)
# Removes a nfs export
def fs_unexport(self, args):
export = _get_item(self.c.exports(), args.export, "NFS Export")
self.c.export_remove(export)
# Exports a file system as a NFS export
def fs_export(self, args):
fs = _get_item(self.c.fs(), args.fs, "File System")
# Check to see if we have some type of access specified
if len(args.rw_host) == 0 \
and len(args.ro_host) == 0:
raise ArgError(" please specify --ro-host or --rw-host")
export = self.c.export_fs(
fs.id,
args.exportpath,
args.root_host,
args.rw_host,
args.ro_host,
args.anonuid,
args.anongid,
args.auth_type,
None)
self.display_data([export])
# Displays volume dependants.
def volume_dependants(self, args):
v = _get_item(self.c.volumes(), args.vol, "Volume")
rc = self.c.volume_child_dependency(v)
out(rc)
# Removes volume dependants.
def volume_dependants_rm(self, args):
v = _get_item(self.c.volumes(), args.vol, "Volume")
self._wait_for_it("volume-dependant-rm",
self.c.volume_child_dependency_rm(v), None)
def volume_raid_info(self, args):
lsm_vol = _get_item(self.c.volumes(), args.vol, "Volume")
self.display_data(
[
VolumeRAIDInfo(
lsm_vol.id, *self.c.volume_raid_info(lsm_vol))])
def pool_member_info(self, args):
lsm_pool = _get_item(self.c.pools(), args.pool, "Pool")
self.display_data(
[
PoolRAIDInfo(
lsm_pool.id, *self.c.pool_member_info(lsm_pool))])
def volume_raid_create(self, args):
raid_type = VolumeRAIDInfo.raid_type_str_to_lsm(args.raid_type)
all_lsm_disks = self.c.disks()
lsm_disks = [d for d in all_lsm_disks if d.id in args.disk]
if len(lsm_disks) != len(args.disk):
raise LsmError(
ErrorNumber.NOT_FOUND_DISK,
"Disk ID %s not found" %
', '.join(set(args.disk) - set(d.id for d in all_lsm_disks)))
busy_disks = [d.id for d in lsm_disks
if not d.status & Disk.STATUS_FREE]
if len(busy_disks) >= 1:
raise LsmError(
ErrorNumber.DISK_NOT_FREE,
"Disk %s is not free" % ", ".join(busy_disks))
if args.strip_size:
strip_size = size_human_2_size_bytes(args.strip_size)
else:
strip_size = Volume.VCR_STRIP_SIZE_DEFAULT
self.display_data([
_add_sd_paths(
self.c.volume_raid_create(
args.name, raid_type, lsm_disks, strip_size))])
def volume_raid_create_cap(self, args):
lsm_sys = _get_item(self.c.systems(), args.sys, "System")
self.display_data([
VcrCap(lsm_sys.id, *self.c.volume_raid_create_cap_get(lsm_sys))])
def volume_ident_led_on(self, args):
lsm_volume = _get_item(self.c.volumes(), args.vol, "Volume")
self.c.volume_ident_led_on(lsm_volume)
def volume_ident_led_off(self, args):
lsm_volume = _get_item(self.c.volumes(), args.vol, "Volume")
self.c.volume_ident_led_off(lsm_volume)
def system_read_cache_pct_update(self, args):
lsm_system = _get_item(self.c.systems(), args.sys, "System")
try:
read_pct = int(args.read_pct)
except ValueError as ve:
raise LsmError(ErrorNumber.INVALID_ARGUMENT, str(ve))
self.c.system_read_cache_pct_update(lsm_system, read_pct)
lsm_system = _get_item(self.c.systems(), args.sys, "System")
self.display_data([lsm_system])
# Displays file system dependants
def fs_dependants(self, args):
fs = _get_item(self.c.fs(), args.fs, "File System")
rc = self.c.fs_child_dependency(fs, args.file)
out(rc)
# Removes file system dependants
def fs_dependants_rm(self, args):
fs = _get_item(self.c.fs(), args.fs, "File System")
self._wait_for_it("fs-dependants-rm",
self.c.fs_child_dependency_rm(fs,
args.file),
None)
def _read_configfile(self):
"""
Set uri from config file. Will be overridden by cmdline option or
env var if present.
"""
allowed_config_options = ("uri",)
config_path = os.path.expanduser("~") + "/.lsmcli"
if not os.path.exists(config_path):
return
with open(config_path) as f:
for line in f:
if line.lstrip().startswith("#"):
continue
try:
name, val = [x.strip() for x in line.split("=", 1)]
if name in allowed_config_options:
setattr(self, name, val)
except ValueError:
pass
def is_connection_free_cmd(self):
"""
Return True if current command is one of _CONNECTION_FREE_COMMANDS.
"""
if self.args.func.__name__.replace("_", "-") in \
_CONNECTION_FREE_COMMANDS:
return True
return False
# Class constructor.
def __init__(self):
self.uri = None
self.c = None
self.parser = None
self.unknown_args = None
self.args = self.cli()
self.cleanup = None
self.tmo = int(self.args.wait)
if not self.tmo or self.tmo < 0:
raise ArgError("[-w|--wait] requires a non-zero positive integer")
if self.is_connection_free_cmd():
return
self._read_configfile()
if os.getenv('LSMCLI_URI') is not None:
self.uri = os.getenv('LSMCLI_URI')
self.password = os.getenv('LSMCLI_PASSWORD')
if self.args.uri is not None:
self.uri = self.args.uri
if self.uri is None:
# We need a valid plug-in to instantiate even if all we are trying
# to do is list the plug-ins at the moment to keep that code
# the same in all cases, even though it isn't technically
# required for the client library (static method)
# TODO: Make this not necessary.
if 'type' in self.args and self.args.type == "PLUGINS":
self.uri = "sim://"
self.password = None
else:
raise ArgError("--uri missing or export LSMCLI_URI")
# Lastly get the password if requested.
if self.args.prompt:
self.password = getpass.getpass()
if self.password is not None:
# Check for username
u = uri_parse(self.uri)
if u['username'] is None:
raise ArgError("password specified with no user name in uri")
# Does appropriate clean-up
# @param ec The exit code
def shutdown(self, ec=None):
if self.cleanup:
self.cleanup()
if ec:
sys.exit(ec)
# Process the specified command
# @param cli The object instance to invoke methods on.
def process(self, cli=None):
"""
Process the parsed command.
"""
if self.is_connection_free_cmd():
self.args.func(self.args)
else:
if cli:
# Directly invoking code though a wrapper to catch unsupported
# operations.
self.c = Proxy(cli())
self.c.plugin_register(self.uri, self.password, self.tmo)
self.cleanup = self.c.plugin_unregister
else:
# Going across the ipc pipe
self.c = Proxy(Client(self.uri, self.password, self.tmo))
if os.getenv('LSM_DEBUG_PLUGIN'):
input("Attach debugger to plug-in, "
"press when ready...")
self.cleanup = self.c.close
self.args.func(self.args)
self.shutdown()
def local_disk_list(self, args):
local_disks = []
func_dict = {
"vpd83": LocalDisk.vpd83_get,
"rpm": LocalDisk.rpm_get,
"link_type": LocalDisk.link_type_get,
"serial_num": LocalDisk.serial_num_get,
"led_status": LocalDisk.led_status_get,
"link_speed": LocalDisk.link_speed_get,
"health_status": LocalDisk.health_status_get,
}
for disk_path in LocalDisk.list():
info_dict = {
"vpd83": "",
"rpm": Disk.RPM_NO_SUPPORT,
"link_type": Disk.LINK_TYPE_NO_SUPPORT,
"serial_num": "",
"led_status": Disk.LED_STATUS_UNKNOWN,
"link_speed": Disk.LINK_SPEED_UNKNOWN,
"health_status": Disk.HEALTH_STATUS_UNKNOWN,
}
for key in info_dict.keys():
try:
info_dict[key] = func_dict[key](disk_path)
except LsmError as lsm_err:
if lsm_err.code != ErrorNumber.NO_SUPPORT:
sys.stderr.write("WARN: %s('%s'): %d %s\n" %
(func_dict[key].__name__, disk_path,
lsm_err.code, lsm_err.msg))
local_disks.append(
LocalDiskInfo(disk_path,
info_dict["vpd83"],
info_dict["rpm"],
info_dict["link_type"],
info_dict["serial_num"],
info_dict["led_status"],
info_dict["link_speed"],
info_dict["health_status"]))
self.display_data(local_disks)
def volume_cache_info(self, args):
lsm_vol = _get_item(self.c.volumes(), args.vol, "Volume")
self.display_data(
[
VolumeRAMCacheInfo(
lsm_vol.id, *self.c.volume_cache_info(lsm_vol))])
def volume_phy_disk_cache_update(self, args):
lsm_vol = _get_item(self.c.volumes(), args.vol, "Volume")
if args.policy == "ENABLE":
policy = Volume.READ_CACHE_POLICY_ENABLED
else:
policy = Volume.READ_CACHE_POLICY_DISABLED
self.c.volume_physical_disk_cache_update(lsm_vol, policy)
self.display_data(
[
VolumeRAMCacheInfo(
lsm_vol.id, *self.c.volume_cache_info(lsm_vol))])
def volume_read_cache_policy_update(self, args):
lsm_vol = _get_item(self.c.volumes(), args.vol, "Volume")
if args.policy == "ENABLE":
policy = Volume.PHYSICAL_DISK_CACHE_ENABLED
else:
policy = Volume.PHYSICAL_DISK_CACHE_DISABLED
self.c.volume_read_cache_policy_update(lsm_vol, policy)
self.display_data(
[
VolumeRAMCacheInfo(
lsm_vol.id, *self.c.volume_cache_info(lsm_vol))])
def volume_write_cache_policy_update(self, args):
lsm_vol = _get_item(self.c.volumes(), args.vol, "Volume")
if args.policy == 'WB':
policy = Volume.WRITE_CACHE_POLICY_WRITE_BACK
elif args.policy == 'AUTO':
policy = Volume.WRITE_CACHE_POLICY_AUTO
else:
policy = Volume.WRITE_CACHE_POLICY_WRITE_THROUGH
self.c.volume_write_cache_policy_update(lsm_vol, policy)
self.display_data(
[
VolumeRAMCacheInfo(
lsm_vol.id, *self.c.volume_cache_info(lsm_vol))])
def local_disk_ident_led_on(self, args):
LocalDisk.ident_led_on(args.path)
def local_disk_ident_led_off(self, args):
LocalDisk.ident_led_off(args.path)
def local_disk_fault_led_on(self, args):
LocalDisk.fault_led_on(args.path)
def local_disk_fault_led_off(self, args):
LocalDisk.fault_led_off(args.path)
lsmcli/__init__.pyo 0000644 00000000421 14757650541 0010332 0 ustar 00
/P`c @ s< y d d l m Z Wn! e k
r7 d d l m Z n Xd S( i ( t cmd_line_wrapperiN( t cmdlineR t ImportError( ( ( s7 /usr/lib/python2.7/site-packages/lsm/lsmcli/__init__.pyt s
lsmcli/cmdline.pyc 0000644 00000170163 14757650541 0010205 0 ustar 00
/P`c K @ s d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l m Z m Z d d l m
Z
d d l Z d d l m
Z
m Z m Z m Z m Z m Z m Z m Z m Z m Z m Z m Z m Z m Z m Z m Z m Z m Z d d l m Z m! Z! m" Z" m# Z# m$ Z$ m% Z% m& Z& m' Z' m( Z( m) Z) d d d d d
g Z* e j+ rie, Z- n y d d l. m/ Z/ Wn! e0 k
rd d l1 m/ Z/ n Xd d Z3 d
Z4 d Z5 d Z6 d Z7 d Z8 d Z9 d Z: d Z; d Z< e= d Z> d Z? d e@ f d YZA d eB d ZC d ZD d d d d d! d" d# d$ d% d& d' d( g ZE dpZF d, d- jG eF ZH dqZI d2 d- jG eI ZJ d3 d4 g ZK d5 d- jG eK ZL eM d6 d7 d8 d9 d: eL d; eK d< e9 ZN d= d> d? g ZO d@ d- jG eO dA dB ZP eM d6 d7 d8 d9 d: eP d; eO d< e9 ZQ dC ZR eM d6 dD d8 dE d: dF ZS eS jT ZU dG eU d: dq eM ee g eM d6 d d: d?dq eM ee g eM d6 d
d: d@dq eM ee g f3 Zh eM dAdBdCdDdEdFdGdHdIdJdKdLdMdNdOd} dPd dQd dRd dSd dTd dUd dVd dWd dXd dYd dZd d[d d\d d]d d^d d_d d`d dad dbd dcd dddedfd5dgd7dhd9did;djd dkd dld dmd
%Zi dnej f do YZk d S(r iN( t ArgumentParsert ArgumentTypeError( t RawTextHelpFormatter( t Clientt Poolt VERSIONt LsmErrort Diskt Volumet JobStatust ErrorNumbert
BlockRanget uri_parset Proxyt size_human_2_size_bytest AccessGroupt
FileSystemt NfsExportt
TargetPortt LocalDiskt Battery(
t DisplayDatat PlugDatat outt vol_provision_str_to_typet vol_rep_type_str_to_typet VolumeRAIDInfot PoolRAIDInfot VcrCapt
LocalDiskInfot VolumeRAMCacheInfos local-disk-lists local-disk-ident-led-ons local-disk-ident-led-offs local-disk-fault-led-ons local-disk-fault-led-off( t OrderedDictc C sb d } d } zy t } | j | Wn t k
rg } t j j t | t j j d } n t k
r } t j j t | d t j j | j
t j k r d } q d } n] t
k
r d } nG t k
r } | j
} n, d d l } | j d t j d } n XWd | rPy | j | WqPt k
rLqPXn t j | Xd S(
s+
Common command line code, called.
i i s
i
i i iNt file( t Nonet CmdLinet processt ArgErrort syst stderrt writet strt flushR t codeR
t PERMISSION_DENIEDt KeyboardInterruptt
SystemExitt tracebackt print_exct stdoutt shutdownt Exceptiont exit( t ct err_exitt clit aet let seR. ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt cmd_line_wrapper; s<
c C sh t j j } t j | } z, t j t j j t j j d } Wd t j | t j | X| S( Ni (
R% t stdint filenot termiost tcgetattrt ttyt setrawt readt tcsetattrt TCSADRAIN( t fdt prevt ch( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt getchh s c C s< t j | \ } } } | r( | | f St d | d S( s
If init_id is a WWPN, convert it into LSM standard version:
(?:[0-9a-f]{2}:){7}[0-9a-f]{2}
Return (converted_init_id, lsm_init_type)
s, --init "%s" is not a valid WWPN or iSCSI IQNN( R t initiator_id_verifyR$ ( t init_idt validt converted_init_typet converted_init_id( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt parse_convert_inits s
c C s6 t j | \ } } } | r" | St d | d S( s
Call back from validating an initiator
:param init_id: Initiator to validate
:return: Value of initiator or raises an exception
s! "%s" is invalid WWPN or iSCSI IQNN( R RH R ( RI RJ t _RL ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt _check_init s c C s^ y6 t | d } | d k r1 t d | n | SWn! t k
rY t d | n Xd S( s
Call back for validating a positive integer
:param num: Number string to check
:return: Numeric value, else exception
i
i s, invalid: require positive integer value '%d's* invalid: not a positive integer value '%s'N( t longR t
ValueError( t numt rc( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt _check_positive_integer s
t child_c C s
| j S( N( t upper( t s( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt _upper s c C s | s
t S| j d } t | d k r/ t Sd | k r? t Sx | D] } d t | k oi d k n sr t St | d k r | d d k r t Sy t | d d k r t SWqF t k
r t SXqF Wt S(
s
Check if a string represents a valid ip4 address
:param address: String representing address
:return: True if valid address, else false
t .i t /i i i t 0i
i ( t Falset splitt lent intRQ t True( t addresst partst i( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt _valid_ip4_address s$
""
c sk d t } | s t Sd | k r& t St | j d d k rE t S| j d } t | d k sx t | d k r| t Sd | d k r t | j s d
GHt S| j d d g n d | k rg | D] } | d k r | ^ q } | j d t } n | r t | d
k s.t | d
k rgt d | D oft f d d j | D St S( s
Check if a string represents a valid ipv6 address
:param address: String representing address
:return: True if valid address, else false
s ABCDEFabcdef0123456789:RZ s ::i t :i i RY is Not valid ipv suffixR[ t i c s s! | ] } t | d k Vq d S( i N( R^ ( t .0t x( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pys s c 3 s | ] } | k Vq d S( N( ( Rg Rh ( t allowed( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pys s (
R\ R^ R] Rd t popt extendt appendR` t allt join( Ra t has_zerosRb t p( ( Ri s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt _valid_ip6_address s0 $ %
*#c s t j d t j t j d } t | r4 t St | rD t St | d k rZ t S| j | rm t S| d d k r | d } n t f d | j
d D S( s
Checks to see if the supplied string is a valid ip4/6 or hostname
:param ip_hn: String representing address user inputted
:return: True if valid IP address or hostname
s (?!-)[A-Z0-9-]{1,63}(? s ( t ret compilet
IGNORECASERd R` Rq R^ R\ Rr Rm R] ( t ip_hnt digits_only( ( Ri s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt _is_valid_network_name s
c
C s d } | r t } n | j d d d d d d t j d t f | j d d d d
d t d d
d d | d d | j d d d d d d | d d | j d d d d d d | d d | j d d d d
d d | d d d d | j d d! d d d d" | d# t d d$ | j d% d& d d d d' | d# t d d( | j d) d* d d
d d+ | d d, d t | j d- d d d d. | d d/ | j d0 d d d d1 | d# t d d2 | j d3 d4 d d d d5 | d# t d d6 | rt } d7 | d+ | <| j | n d8 S(9 s
As https://bugs.python.org/issue23058 indicate, argument parser should
not have subparser sharing the same argument and destination.
For subparser, we add common options as 'child_xxx' destination.
For default value, False is the only allowed default value in root.
Rf s -vs --versiont actiont versions %s %si s -us --urit storet typet metavars t dests %surit helps, Uniform resource identifier (env LSMCLI_URI)s -Ps --promptt
store_trues %sprompts) Prompt for password (env LSMCLI_PASSWORD)s -Hs --humans %shumans: Print sizes in human readable format
(e.g., MiB, GiB, TiB)s -ts --terses %sseps s; Print output in terse form with "SEP" as a record separators -es --enums %senumt defaults3 Display enumerated types as numbers instead of texts -fs --forces %sforces3 Bypass confirmation prompt for data loss operationss -ws --waits %swaits+ Command timeout value in ms (default = 30s)s --headers %sheaders Include the header with terses -bs %s_asyncsm Run the command async. Instead of waiting for completion.
Command will exit(7) and job id written to stdout.s -ss --scripts %sscriptsM Displaying data in script friendly way with additional information(if exists)i0u N(
t _CHILD_OPTION_DST_PREFIXt add_argumentR% t argvR R( R\ RT t dictt set_defaults( t
arg_parsert is_childt prefixt default_dict( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt _add_common_options s\
c C sl g | _ y1 t | j d k r9 t j | j | _ n Wn+ t k
rg } | j t j k rh qh n X| S( Ni ( t sd_pathsR^ t vpd83R t vpd83_searchR R* R
t
NO_SUPPORT( t lsm_objt lsm_err( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt
_add_sd_pathsX s
R$ c B s e Z d Z d Z RS( c O s t j | | | | | _ d S( s,
Class represents an error.
N( R2 t __init__t msg( t selft messaget argst kwargs( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR e s c C s$ d t j j t j d | j f S( Ns %s: error: %s
i ( t ost patht basenameR% R R ( R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt __str__l s ( t __name__t
__module__R R ( ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR$ d s t itemc C sK x! | D] } | j | k r | Sq W| rC t d | | f n d Sd S( Ns %s with ID %s not found!( t idR$ R! ( t lt the_idt
friendly_namet raise_errorR ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt _get_itemu s
c C s* t | } | r | St d | d S( sT
Custom value checker for hostname/IP address
:param addr:
:return:
s %s is invalid IP or hostnameN( Rx R ( t addrRJ ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt _check_network_host s t VOLUMESt POOLSt FSt SNAPSHOTSt EXPORTSt NFS_CLIENT_AUTHt
ACCESS_GROUPSt SYSTEMSt DISKSt PLUGINSt TARGET_PORTSt BATTERIESt DEFAULTt THINt FULLs provisioning type: s , t CLONEt COPYt MIRROR_ASYNCt MIRROR_SYNCs replication type: t ENABLEt DISABLEs Policy: t names --policyR} s R t choicesR| t WBt AUTOt WTs Write cache polices: s' which stand for "write back", "auto", s "write through"s7 Can use B, KiB, MiB, GiB, TiB, PiB postfix (IEC sizing)s --syss s System IDsm Search by System ID. Only supported for:
(VOLUMES, POOLS, FS, DISKS, ACCESS_GROUPS,
TARGET_PORTS, BATTERIES)s --pools s Pool IDs; Search by Pool ID. Only supported for:
(VOLUMES, POOLS, FS)s --vols s Volume IDsA Search by Volume ID. Only supported for:
(VOLUMES, ACCESS_GROUPS)s --fss s File System IDs= Search by FS ID. Only supported for:
(FS, SNAPSHOTS, EXPORTS)s --ags s Access Group IDsG Search by Access Group ID. Only supported for:
(ACCESS_GROUPS, VOLUMES)s --inits s Initiator IDs --snaps s Snapshot IDs --exports s Export IDs --nfs-exports s6 Search by NFS Export ID. Only supported for:
(EXPORTS)s --disks s. Search by Disk ID. Only supported for:
(DISKS)s --sizes s --tgts s= Search by target port ID. Only supported for:
(TARGET_PORTS)s --paths Local disk paths t lists List records of different typesR s --types List records of type:
s
s3
When listing SNAPSHOTS, it requires --fs .s t optionals
job-statuss Retrieve information about a jobs --jobs s
job status idt capabilitiess Retrieves array capabilitiess plugin-infos( Retrieves plugin description and versions
volume-creates Creates a volume (logical unit)s --names volume names s --provisioningR s volume-raid-creates( Creates a RAIDed volume on hardware RAIDs s> Free disks for new RAIDed volume.
This is repeatable argument.Ry Rl s --raid-types@ RAID type for the new RAID group. Should be one of these:
%ss --strip-sizes Strip size. s volume-raid-create-caps= Query capability of creating a RAIDed volume on hardware RAIDs
volume-deletes Deletes a volume given its ids
volume-resizes Re-sizes a volumes
s New size. %ss volume-replicates: Creates a new volume and replicates provided volume to it.s s" The name for New replicated volumes
--rep-types s[ Pool ID to contain the new volume.
By default, new volume will be created in the same pool.s volume-replicate-ranges3 Replicates a portion of a volume to existing volumes --src-vols s Source volume ids --dst-vols s Destination volume ids
s Replication type: CLONE, COPYs --src-starts s> Source volume start block number.
This is repeatable argument.s --dst-starts sC Destination volume start block number.
This is repeatable argument.s --counts s; Number of blocks to replicate.
This is repeatable argument.s! volume-replicate-range-block-sizes2 Size of each replicated block on a system in bytess volume-dependantss> Returns True if volume has a dependant child, like replications volume-dependants-rms Removes volume dependenciess volume-access-groups4 Lists the access group(s) that have access to volumes volume-masks> Grants access to an access group to a volume, like LUN Maskings
volume-unmasks7 Revoke the access of specified access group to a volumes
volume-enables Enable block access of a volumes volume-disables Disable block access of a volumes volume-raid-infos Query volume RAID informations volume-ident-led-ons! Enable the IDENT LED for a volumes Targeted volume.
s volume-ident-led-offs" Disable the IDENT LED for a volumes system-read-cache-pct-updates, Change the read cache percentage of a systems Targeted system.
s
--read-pcts Read cache percentage.
s pool-member-infos! Query Pool membership informations access-group-creates Create an access groups s$ Human readable name for access groups access-group-adds+ Add an initiator into existing access groups access-group-removes. Remove an initiator from existing access groups access-group-deletes Deletes an access groups access-group-volumessB Lists the volumes that the access group has been granted access tos
iscsi-chaps5 Configures iSCSI inbound/outbound CHAP authentications --in-users s Inbound chap user names --in-passs s Inbound chap passwords
--out-users
s Outbound chap user names
--out-passs
s Outbound chap passwords fs-creates Creates a file systems s name of the file systems fs-deletes Delete a filesystems fs-resizes Re-sizes a filesystems fs-exports Export a filesystem via NFS.s --exportpaths
s( NFS server export path. e.g. '/foo/bar'.s --anonuids
s% UID(User ID) to map to anonymous users --anongids
s& GID(Group ID) to map to anonymous users --auth-types s NFS client authentication types --root-hosts s9 The host/IP has root access.
This is repeatable argument.s --ro-hosts sr The host/IP has readonly access.
This is repeatable argument.
At least one '--ro-host' or '--rw-host' is required.s --rw-hosts ss The host/IP has readwrite access.
This is repeatable argument.
At least one '--ro-host' or '--rw-host' is required.s fs-unexports Remove an NFS exports fs-clones Creates a file system clones --src-fss s& The ID of existing source file system.s
--dst-names
s3 The name for newly created destination file system.s --backing-snapshots
s backing snapshot ids fs-snap-creates Creates a snapshots s' The human friendly name of new snapshots fs-snap-deletes Deletes a snapshots fs-snap-restores; Restores a FS or specified files to previous snapshot states --files sk Only restore provided file
Without this argument, all files will be restored
This is a repeatable argument.s --fileass sG store restore file name to another name.
This is a repeatable argument.s
fs-dependantssH Returns True if filesystem has a child dependency(clone/snapshot) existss- For file check
This is a repeatable argument.s fs-dependants-rms Removes file system dependenciessH File or files to remove dependencies for.
This is a repeatable argument.s
file-clones, Creates a clone of a file (thin provisioned)s --srcs sC source file to clone (relative path)
This is a repeatable argument.s --dsts s@ Destination file (relative path), this is a repeatable argument.s Query local disk informations volume-cache-infos" Query volume RAM cache informations volume-phy-disk-cache-updates) Update volume physical disk cache settings volume-read-cache-policy-updates Update volume read cache policys volume-write-cache-policy-updates Update volume write cache policys/ Turn on the identification LED for a local disks0 Turn off the identification LED for a local disks& Turn on the fault LED for a local disks' Turn off the fault LED for a local diskt lss list --type systemst lps list --type poolst lvs list --type volumest lds list --type diskst las list --type access_groupst lfs list --type fst lts list --type target_portsR4 Rp t vct vrct vrcct vdt vrt vmt vut vet vit act aat art adt vrit vilont vilofft srcput pmit ldlt lbs list --type batteriest vcit vpdcut vrcput vwcput ldilont ldilofft ldflont ldfloffR" c B s e Z d Z d Z d Z d Z e d Z e d Z d Z d Z
e d Z d Z d
Z
d Z d Z d
Z d Z d Z d Z d Z d Z d Z d Z d Z d Z e d Z d Z d Z d Z d Z d Z d Z d Z! d Z" d Z# d! Z$ d" Z% e d# Z& d$ Z' d% Z( d& Z) d' Z* d( Z+ d) Z, d* Z- d+ Z. d, Z/ d- Z0 d. Z1 d/ Z2 d0 Z3 d1 Z4 d2 Z5 d3 Z6 d4 Z7 d5 Z8 d6 Z9 d7 Z: d8 Z; d9 Z< d: Z= dF d; Z? dF d< Z@ d= ZA d> ZB d? ZC d@ ZD dA ZE dB ZF dC ZG dD ZH dE ZI RS(G s'
Command line interface class.
c C sd | j j s\ | r d n d } t d | t } | j d k rK t St d t Sn t Sd S( s1
Give the user a chance to bail.
t willt maysx Warning: You are about to do an operation that %s cause data to be lost!
Press [Y|y] to continue, any other key to abortt Ys Operation aborted!N( R t forceR RG RV R` R\ ( R t deletingR t pressed( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt confirm_promptT s
c C s t } t | d k r d St j } t } | j j r@ t } n | j j rU t } n | j j rm t j } n t j
| d | d | j j d | j j d | j j d | d | d S( Ni t display_wayt
flag_humant flag_enumt splittert flag_with_headert flag_dsp_all_data(
R\ R^ R t DISPLAY_WAY_DEFAULTR` R t sept headert scriptt DISPLAY_WAY_SCRIPTt display_datat humant enum( R t objectst display_allR R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR k s c C sh g } d } t j | } x9 | D]1 } | j | \ } } | j t | | q" W| j | d S( Ns <}{>( R t available_pluginsR] Rl R R ( R t dR t pluginsRp t descRz ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt display_available_plugins s
c C sX g } xK t j d D]< } | t k rC | j t | j d q | j | q W| S( sb
Walk the command line argument list and build up a new command line
with the appropriate substitutions which is then passed to argparse, so
that we can avoid adding more sub parsers and do all argument parsing
before the need to talk to the library
:return copy of command line args with alias expansion:
i t ( R% R t aliasesRk R] Rl ( RS Rc ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt handle_alias s c C sC d } x6 t t j D]" \ } } | d j | | 7} q W| S( Ns command aliases:
s {0:<18} Alias of '{1}'
( t sortedR t itemst format( RS t kt v( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt alias_help_text s c C sZ t d t } t | d t t d d d t j d d t } t | d t | j d d } x t D]} | j | d
d | d d | g d t } | j
d
} xA | j d g D]- } | d
} | d
=| j | d t | q W| j
d } xV | j d g D]B } | d
} | d
=t
| t sF| f } n | j | | qW| j d t | | d
j d d qm Wt t j d k r| j t d n | | _ | j d t j }
x t |
j D]k \ } } | j t r| t t }
t |
|
d k s<t |
|
t k rRt |
|
| qRqqW|
S( s3
Command line interface parameters
t add_helpR t descriptions^ The libStorageMgmt command line interface. Run %(prog)s -h for more on each command.t epilogsh
Copyright 2012-2018 Red Hat, Inc.
Please report bugs to
t formatter_classR} t commandR R t parentss cmd required argumentsR t requireds cmd optional argumentsR t funct -RN i N( R R\ R R` R" R R t add_subparserst cmdst
add_parsert add_argument_groupt getR t
isinstancet tupleR t getattrt replaceR^ R% R t print_usageR3 t parsert
parse_argsR t varsR t
startswithR R! t setattr( R t
parent_parserR t
subparserst cmdt
sub_parsert groupt argR t flagst
known_argsR
R t root_k( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR6 sN
$
c C sQ | j j r1 t | j j j | j j n t d j | j j d S( sD
Dump the supported nfs client authentication types
s , N( R R R Rn R4 t export_auth( R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt! display_nfs_client_authentication s %c C s d } d } | j d f | j d f | j d f | j d f | j d f | j d f | j d f | j d f f } xJ | D]B } | d ry | r t d
| | d f q | \ } } qy qy W| | f S( Nt system_idt pool_idt volume_idt disk_idt access_group_idt fs_idt
nfs_export_idt tgt_port_idi s, Search key specified more than once (%s, %s)i (
R! R% t poolt volt diskt agt fst
nfs_exportt tgtR$ ( R t
search_keyt search_valuet search_argst sa( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt _get_search_key_value s$
c C ss t j | \ } } | j d k r g } | d k r? d } n | d k r t | j j | j d d t } | r | j j | } q n= | r | t j
k r t d | n | j j | | } | j
t d | D n| j d k rU| d
k rd } n | r6| t j
k r6t d | n | j
| j j | | n| j d k r| d
k ryd } n | r| t j
k rt d | n | j
| j j | | n| j d k rL| j d k rt d n | r| d
k rt d | n t | j j | j d } | j
| j j | n#| j d k r| d k rpd } n | r| t j
k rt d | n | j
| j j | | n| j d k r| rt d n | j n| j d k r| d k r d } n | d k rkt | j j | j d d t } | r[| j
| j j | S| j
g Sn( | r| t j
k rt d | n | j
| j j | | n| j d k r| rt d n | j
| j j n| j d k rj| d k rd } n | r;| t j
k r;t d | n | j
t d | j j | | D n| j d k r| d! k rd } n | r| t j
k rt d" | n | j
| j j | | n | j d# k r| rt d$ n | j ni | j d% k r\| r=| t! j
k r=t d& | n | j
| j j" | | n t d' | j d S(( NR R2 R R4 s Access GroupR s3 Search key '%s' is not supported by volume listing.c s s | ] } t | Vq d S( N( R ( Rg R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pys s R R1 s1 Search key '%s' is not supported by pool listing.R R5 R s --fs requireds5 Search key '%s' is not supported by snapshot listing.s File SystemR R6 s6 Search key '%s' is not supported by NFS Export listingR sC NFS client authentication type listing with search is not supportedR R s8 Search key '%s' is not supported by Access Group listingR s+ System listing with search is not supportedR R3 s0 Search key '%s' is not supported by disk listingc s s | ] } t | Vq d S( N( R ( Rg R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pys b s R R7 s7 Search key '%s' is not supported by target port listingR s, Plugins listing with search is not supportedR s3 Search key '%s' is not supported by battery listings unsupported listing type=%s(# R" RC R| R R4 t
access_groupsR; R\ t" volumes_accessible_by_access_groupR t SUPPORTED_SEARCH_KEYSR$ t volumesR R R t poolsR R< R! t fs_snapshotsR t exportsR/ R9 t access_groups_granted_to_volumeR t systemsR t disksR t target_portsR R t batteries( R R R? R@ t lsm_volst lsm_agR< t lsm_vol( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR s
c C se t | j j | j d } t | j \ } } | j j | j | | | } | j | g d S( Nt System( R R4 RL R% RM t initt access_group_createR R ( R R t systemRI t init_typet access_group( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyRU | s
c C si t | j j | j d } t | j \ } } | rO | j j | | | S| j j | | | Sd S( Ns Access Group( R R4 RD R; RM RT t access_group_initiator_addt access_group_initiator_delete( R R t opRQ RI RW ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt _add_rm_access_grp_init s c C s | j | j | t g d S( N( R R\ R` ( R R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt access_group_add s c C s | j | j | t g d S( N( R R\ R\ ( R R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt access_group_remove s c C sW | j j } t | | j d } | j j | } | j t d | D d S( Ns Access Groupc s s | ] } t | Vq d S( N( R ( Rg R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pys s ( R4 RD R R; RE R R ( R R t aglR) t vols( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt access_group_volumes s c
C sO t | j \ } } | t j k r: t d | j n | j j rb | j j rb t d n | j j r | j j r t d n | j j r | j j r t d n | j j r | j j r t d n | j j r| j j r| j j o| j j rt d n | j
j | | j | j j | j j | j j d S( Ns$ --init "%s" is not a valid iSCSI IQNs --in-user requires --in-passs --in-pass requires --in-users --out-user requires --out-passs --out-pass requires --out-users? out-user and out-password only supported if inbound is supplied( RM RT R t INIT_TYPE_ISCSI_IQNR$ R t in_usert in_passt out_usert out_passR4 t iscsi_chap_auth( R R RI RW ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt
iscsi_chap s$ c C sA t | j j | j d } | j j | } | j | d S( NR ( R R4 RG R9 RK R ( R R R9 t groups( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt volume_access_group s c C s4 | j j } t | | j d } | j j | S( Ns Access Group( R4 RD R R; t access_group_delete( R R R_ R) ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyRk s c C sS t | j j | j d } | j t rO | j d | j j | d n d S( Ns File Systems fs-delete( R R4 R< R R` t _wait_for_itt fs_deleteR! ( R R R< ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyRm s c C se t | j j | j d } | j d | j j | | j | j | j } | j | g d S( NR s fs-create(
R R4 RH R8 Rl t fs_createR t _sizet sizeR ( R R Rp R< ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyRn s
c C s t | j j | j d } | j | j } | | j k rT t t j d n | j t
r | j d | j j | | } | j
| g n d S( Ns File Systems Specified size same as currents fs-resize( R R4 R< Ro Rp t total_spaceR R
t NO_STATE_CHANGER R\ Rl t fs_resizeR ( R R R< Rp ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyRs s c C s t | j j | j d } d } | j rQ t | j j | | j d } n | j d | j j | | j | } | j
| g d S( Ns Source File Systemt Snapshott fs_clone( R R4 R< t src_fsR! t backing_snapshotRI Rl Ru t dst_nameR ( R R Rv t ssR< ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyRu s !c C s t | j j | j d } | j j rN t | j j | | j d } n d } | j d | j j | | j | j
| d d S( Ns File SystemRt t
fs_file_clone( R R4 R< R Rw RI R! Rl Rz t srct dst( R R R< Ry ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt
file_clone s !c C s/ t | } | d k r+ t d | n | S( Ni s$ Incorrect size argument format: '%s'( R R$ ( RW t
size_bytes( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyRo s c C sW | j j d k r! | j j } n d } | r6 d } n d } t d | | | f d S( NRe t SUPPORTEDt UNSUPPORTEDs %s%s%s( R R R! R ( R t capt valRW R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt _cp s c C s t | j j | j d } | j j | } t | j j } t | j t j } t j
} | j j d k r | j j } n t } x | D] } d | | s R c S s | j S( N( t
dest_block( Rh ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR s R ( t sort( t rangesR ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt _check_overlap s
c
C s t | j j | j d } t | j j | j d } t | j } | t j k rm t d | n | j
} | j } | j } t
| s t
| t
| k o t
| k n r t d n g } x t t
| D] } t | | }
t | | } t | | } |
d k r=t d n | d k rXt d n | d k rst d n | |
| j k rt d n | |
| j k rt d
n | j t | | |
q Wt j | | j t r | j j | | | | n d S( Ns
Source Volumes Destination Volumes invalid replication type= %ss@ Differing numbers of src_start, dest_start, and count parametersi s --count: value < 0s --src-start: value < 0s --dst_start: value < 0s# --src-start + --count > source sizes( --dst-start + --count > destination size( R R4 RG t src_volt dst_volR R R R R$ t src_startt dst_startt countR^ R RP t
num_of_blocksRl R R" R R R\ t volume_replicate_range(
R R R{ R| R t
src_startst
dst_startst countsR t bR R R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR s>
/
c C s8 t | j j | j d } t | j j | d S( NRS ( R R4 RL R% R t! volume_replicate_range_block_size( R R RW ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR s c C sS t | j j | j d } t | j j | j d } | j j | | d S( NR s Access Group( R R4 RG R9 RD R; t volume_mask( R R R9 R; ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR s c C sO t | j j | j d } t | j j | j d } | j j | | S( Ns Access GroupR ( R R4 RD R; RG R9 t
volume_unmask( R R R; R9 ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR s c C s t | j j | j d } | j | j } | | j | j k r[ t t j
d n | j t r | j
d | j j | | } | j t | g n d S( NR s Specified size same as currentt resize( R R4 RG R9 Ro Rp t
block_sizeR R R
Rr R R\ Rl t
volume_resizeR R ( R R R Rp R9 ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR s c C s2 t | j j | j d } | j j | d S( NR ( R R4 RG R9 t
volume_enable( R R R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR s c C s2 t | j j | j d } | j j | d S( NR ( R R4 RG R9 t volume_disable( R R R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR s c C s2 t | j j | j d } | j j | d S( Ns
NFS Export( R R4 RJ t exportt
export_remove( R R R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt fs_unexport s c C s t | j j | j d } t | j d k rW t | j d k rW t d n | j j | j | j | j
| j | j | j | j | j
d } | j | g d S( Ns File Systemi s& please specify --ro-host or --rw-host( R R4 R< R^ t rw_hostt ro_hostR$ t export_fsR t
exportpatht root_hostt anonuidt anongidt auth_typeR! R ( R R R< R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt fs_export! s c C s> t | j j | j d } | j j | } t | d S( NR ( R R4 RG R9 t volume_child_dependencyR ( R R R RS ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt volume_dependants6 s c C sA t | j j | j d } | j d | j j | d d S( NR s volume-dependant-rm( R R4 RG R9 Rl t volume_child_dependency_rmR! ( R R R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt volume_dependants_rm< s c C sJ t | j j | j d } | j t | j | j j | g d S( NR ( R R4 RG R9 R R R t volume_raid_info( R R RR ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR A s c C sJ t | j j | j d } | j t | j | j j | g d S( NR ( R R4 RH R8 R R R t pool_member_info( R R t lsm_pool( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR H s c C s\ t j | j } | j j } g | D] } | j | j k r( | ^ q( } t | t | j k r t t j
d d j t | j t d | D n g | D] } | j
t j @s | j ^ q } t | d k rt t j d d j | n | j r!t | j } n t j } | j t | j j | j | | | g d S( Ns Disk ID %s not founds , c s s | ] } | j Vq d S( N( R ( Rg R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pys X s i s Disk %s is not free( R t raid_type_str_to_lsmt raid_typeR4 RM R R: R^ R R
t NOT_FOUND_DISKRn t sett statusR t STATUS_FREEt
DISK_NOT_FREEt
strip_sizeR R t VCR_STRIP_SIZE_DEFAULTR R t volume_raid_createR ( R R R t
all_lsm_disksR t lsm_diskst
busy_disksR ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR O s* +3
c C sJ t | j j | j d } | j t | j | j j | g d S( NRS ( R R4 RL R% R R R t volume_raid_create_cap_get( R R t lsm_sys( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt volume_raid_create_capl s c C s2 t | j j | j d } | j j | d S( NR ( R R4 RG R9 t volume_ident_led_on( R R t
lsm_volume( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR q s c C s2 t | j j | j d } | j j | d S( NR ( R R4 RG R9 t volume_ident_led_off( R R R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR v s c C s t | j j | j d } y t | j } Wn+ t k
r^ } t t j t
| n X| j j | | t | j j | j d } | j | g d S( NRS (
R R4 RL R% R_ t read_pctRQ R R
t INVALID_ARGUMENTR( t system_read_cache_pct_updateR ( R R t
lsm_systemR R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR { s c C sD t | j j | j d } | j j | | j } t | d S( Ns File System( R R4 R< t fs_child_dependencyR R ( R R R< RS ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt
fs_dependants s c C sG t | j j | j d } | j d | j j | | j d d S( Ns File Systems fs-dependants-rm( R R4 R< Rl t fs_child_dependency_rmR R! ( R R R< ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt fs_dependants_rm s
c
C s d } t j j d d } t j j | s2 d St | } x | D] } | j j d ri qH n yT g | j d d D] } | j ^ q \ } } | | k r t | | | n WqH t
k
r qH XqH WWd QXd S( so
Set uri from config file. Will be overridden by cmdline option or
env var if present.
t urit ~s /.lsmcliNt #t =i ( s uri( R R t
expandusert existst opent lstripR# R] t stripR$ RQ ( R t allowed_config_optionst config_patht ft lineRh R R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt _read_configfile s
1
c C s) | j j j j d d t k r% t St S( sU
Return True if current command is one of _CONNECTION_FREE_COMMANDS.
RN R ( R R R R t _CONNECTION_FREE_COMMANDSR` R\ ( R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt is_connection_free_cmd s c C s d | _ d | _ d | _ d | _ | j | _ d | _ t | j j | _
| j
sj | j
d k ry t d n | j r d S| j
t j d d k r t j d | _ n t j d | _ | j j d k r | j j | _ n | j d k rGd | j k r8| j j d k r8d | _ d | _ qGt d n | j j ret j | _ n | j d k rt | j } | d d k rt d
qn d S( Ni s0 [-w|--wait] requires a non-zero positive integert
LSMCLI_URIt LSMCLI_PASSWORDR| R s sim://s" --uri missing or export LSMCLI_URIt usernames+ password specified with no user name in uri( R! R R4 R t unknown_argsR6 R t cleanupR_ t waitt tmoR$ R R R t getenvt passwordR| t promptt getpassR ( R t u( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR s8
! c C s0 | j r | j n | r, t j | n d S( N( R R% R3 ( R t ec( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR1 s
c C s | j r" | j j | j n | rk t | | _ | j j | j | j | j | j j | _
nO t t | j | j | j | _ t j
d r t d n | j j | _
| j j | j | j d S( s-
Process the parsed command.
t LSM_DEBUG_PLUGINs8 Attach debugger to plug-in, press when ready...N( R R R R
R4 t plugin_registerR R R
t plugin_unregisterR R R R t inputt closeR1 ( R R6 ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR# s $
c C s g } i t j d 6t j d 6t j d 6t j d 6t j d 6t j d 6t j d 6} x%t j D]} i d d 6t j
d 6t j d 6d d 6t j d 6t j
d 6t j d 6} x | j D]v } y | | | | | p
2
/ * ( R R R ( R R R R (l R R% R Rs R R? R= t argparseR R R t sixt lsmR R R R R R R R
R R R
R R R R R R R t lsm.lsmcli.data_displayR R R R R R R R R R R t PY3R_ RP t collectionsR t ImportErrort ordereddictR! R: RG RM RO RT R RX Rd Rq Rx R\ R R R2 R$ R` R R t list_choicest provision_typesRn t provision_helpt replicate_typest replicate_helpt policy_typest policy_helpR t
policy_optt write_cache_policy_typest write_cache_policy_helpt write_cache_policy_optt size_helpt
sys_id_optt copyt sys_id_filter_optt pool_id_optt pool_id_filter_optt
vol_id_optt vol_id_filter_optt fs_id_optt fs_id_filter_optt ag_id_optt ag_id_filter_optt init_id_optt snap_id_optt
export_id_optt nfs_export_id_filter_optt disk_id_filter_optt size_optt tgt_id_filter_optt local_disk_path_optt VOL_CREATE_RAID_TYPES_STRt ANON_UID_GID_NAR R t objectR" ( ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt s vF
- * G
lsmcli/cmdline.pyo 0000644 00000170163 14757650541 0010221 0 ustar 00
/P`c K @ s d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l m Z m Z d d l m
Z
d d l Z d d l m
Z
m Z m Z m Z m Z m Z m Z m Z m Z m Z m Z m Z m Z m Z m Z m Z m Z m Z d d l m Z m! Z! m" Z" m# Z# m$ Z$ m% Z% m& Z& m' Z' m( Z( m) Z) d d d d d
g Z* e j+ rie, Z- n y d d l. m/ Z/ Wn! e0 k
rd d l1 m/ Z/ n Xd d Z3 d
Z4 d Z5 d Z6 d Z7 d Z8 d Z9 d Z: d Z; d Z< e= d Z> d Z? d e@ f d YZA d eB d ZC d ZD d d d d d! d" d# d$ d% d& d' d( g ZE dpZF d, d- jG eF ZH dqZI d2 d- jG eI ZJ d3 d4 g ZK d5 d- jG eK ZL eM d6 d7 d8 d9 d: eL d; eK d< e9 ZN d= d> d? g ZO d@ d- jG eO dA dB ZP eM d6 d7 d8 d9 d: eP d; eO d< e9 ZQ dC ZR eM d6 dD d8 dE d: dF ZS eS jT ZU dG eU d: dq eM ee g eM d6 d d: d?dq eM ee g eM d6 d
d: d@dq eM ee g f3 Zh eM dAdBdCdDdEdFdGdHdIdJdKdLdMdNdOd} dPd dQd dRd dSd dTd dUd dVd dWd dXd dYd dZd d[d d\d d]d d^d d_d d`d dad dbd dcd dddedfd5dgd7dhd9did;djd dkd dld dmd
%Zi dnej f do YZk d S(r iN( t ArgumentParsert ArgumentTypeError( t RawTextHelpFormatter( t Clientt Poolt VERSIONt LsmErrort Diskt Volumet JobStatust ErrorNumbert
BlockRanget uri_parset Proxyt size_human_2_size_bytest AccessGroupt
FileSystemt NfsExportt
TargetPortt LocalDiskt Battery(
t DisplayDatat PlugDatat outt vol_provision_str_to_typet vol_rep_type_str_to_typet VolumeRAIDInfot PoolRAIDInfot VcrCapt
LocalDiskInfot VolumeRAMCacheInfos local-disk-lists local-disk-ident-led-ons local-disk-ident-led-offs local-disk-fault-led-ons local-disk-fault-led-off( t OrderedDictc C sb d } d } zy t } | j | Wn t k
rg } t j j t | t j j d } n t k
r } t j j t | d t j j | j
t j k r d } q d } n] t
k
r d } nG t k
r } | j
} n, d d l } | j d t j d } n XWd | rPy | j | WqPt k
rLqPXn t j | Xd S(
s+
Common command line code, called.
i i s
i
i i iNt file( t Nonet CmdLinet processt ArgErrort syst stderrt writet strt flushR t codeR
t PERMISSION_DENIEDt KeyboardInterruptt
SystemExitt tracebackt print_exct stdoutt shutdownt Exceptiont exit( t ct err_exitt clit aet let seR. ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt cmd_line_wrapper; s<
c C sh t j j } t j | } z, t j t j j t j j d } Wd t j | t j | X| S( Ni (
R% t stdint filenot termiost tcgetattrt ttyt setrawt readt tcsetattrt TCSADRAIN( t fdt prevt ch( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt getchh s c C s< t j | \ } } } | r( | | f St d | d S( s
If init_id is a WWPN, convert it into LSM standard version:
(?:[0-9a-f]{2}:){7}[0-9a-f]{2}
Return (converted_init_id, lsm_init_type)
s, --init "%s" is not a valid WWPN or iSCSI IQNN( R t initiator_id_verifyR$ ( t init_idt validt converted_init_typet converted_init_id( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt parse_convert_inits s
c C s6 t j | \ } } } | r" | St d | d S( s
Call back from validating an initiator
:param init_id: Initiator to validate
:return: Value of initiator or raises an exception
s! "%s" is invalid WWPN or iSCSI IQNN( R RH R ( RI RJ t _RL ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt _check_init s c C s^ y6 t | d } | d k r1 t d | n | SWn! t k
rY t d | n Xd S( s
Call back for validating a positive integer
:param num: Number string to check
:return: Numeric value, else exception
i
i s, invalid: require positive integer value '%d's* invalid: not a positive integer value '%s'N( t longR t
ValueError( t numt rc( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt _check_positive_integer s
t child_c C s
| j S( N( t upper( t s( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt _upper s c C s | s
t S| j d } t | d k r/ t Sd | k r? t Sx | D] } d t | k oi d k n sr t St | d k r | d d k r t Sy t | d d k r t SWqF t k
r t SXqF Wt S(
s
Check if a string represents a valid ip4 address
:param address: String representing address
:return: True if valid address, else false
t .i t /i i i t 0i
i ( t Falset splitt lent intRQ t True( t addresst partst i( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt _valid_ip4_address s$
""
c sk d t } | s t Sd | k r& t St | j d d k rE t S| j d } t | d k sx t | d k r| t Sd | d k r t | j s d
GHt S| j d d g n d | k rg | D] } | d k r | ^ q } | j d t } n | r t | d
k s.t | d
k rgt d | D oft f d d j | D St S( s
Check if a string represents a valid ipv6 address
:param address: String representing address
:return: True if valid address, else false
s ABCDEFabcdef0123456789:RZ s ::i t :i i RY is Not valid ipv suffixR[ t i c s s! | ] } t | d k Vq d S( i N( R^ ( t .0t x( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pys s c 3 s | ] } | k Vq d S( N( ( Rg Rh ( t allowed( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pys s (
R\ R^ R] Rd t popt extendt appendR` t allt join( Ra t has_zerosRb t p( ( Ri s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt _valid_ip6_address s0 $ %
*#c s t j d t j t j d } t | r4 t St | rD t St | d k rZ t S| j | rm t S| d d k r | d } n t f d | j
d D S( s
Checks to see if the supplied string is a valid ip4/6 or hostname
:param ip_hn: String representing address user inputted
:return: True if valid IP address or hostname
s (?!-)[A-Z0-9-]{1,63}(? s ( t ret compilet
IGNORECASERd R` Rq R^ R\ Rr Rm R] ( t ip_hnt digits_only( ( Ri s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt _is_valid_network_name s
c
C s d } | r t } n | j d d d d d d t j d t f | j d d d d
d t d d
d d | d d | j d d d d d d | d d | j d d d d d d | d d | j d d d d
d d | d d d d | j d d! d d d d" | d# t d d$ | j d% d& d d d d' | d# t d d( | j d) d* d d
d d+ | d d, d t | j d- d d d d. | d d/ | j d0 d d d d1 | d# t d d2 | j d3 d4 d d d d5 | d# t d d6 | rt } d7 | d+ | <| j | n d8 S(9 s
As https://bugs.python.org/issue23058 indicate, argument parser should
not have subparser sharing the same argument and destination.
For subparser, we add common options as 'child_xxx' destination.
For default value, False is the only allowed default value in root.
Rf s -vs --versiont actiont versions %s %si s -us --urit storet typet metavars t dests %surit helps, Uniform resource identifier (env LSMCLI_URI)s -Ps --promptt
store_trues %sprompts) Prompt for password (env LSMCLI_PASSWORD)s -Hs --humans %shumans: Print sizes in human readable format
(e.g., MiB, GiB, TiB)s -ts --terses %sseps s; Print output in terse form with "SEP" as a record separators -es --enums %senumt defaults3 Display enumerated types as numbers instead of texts -fs --forces %sforces3 Bypass confirmation prompt for data loss operationss -ws --waits %swaits+ Command timeout value in ms (default = 30s)s --headers %sheaders Include the header with terses -bs %s_asyncsm Run the command async. Instead of waiting for completion.
Command will exit(7) and job id written to stdout.s -ss --scripts %sscriptsM Displaying data in script friendly way with additional information(if exists)i0u N(
t _CHILD_OPTION_DST_PREFIXt add_argumentR% t argvR R( R\ RT t dictt set_defaults( t
arg_parsert is_childt prefixt default_dict( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt _add_common_options s\
c C sl g | _ y1 t | j d k r9 t j | j | _ n Wn+ t k
rg } | j t j k rh qh n X| S( Ni ( t sd_pathsR^ t vpd83R t vpd83_searchR R* R
t
NO_SUPPORT( t lsm_objt lsm_err( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt
_add_sd_pathsX s
R$ c B s e Z d Z d Z RS( c O s t j | | | | | _ d S( s,
Class represents an error.
N( R2 t __init__t msg( t selft messaget argst kwargs( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR e s c C s$ d t j j t j d | j f S( Ns %s: error: %s
i ( t ost patht basenameR% R R ( R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt __str__l s ( t __name__t
__module__R R ( ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR$ d s t itemc C sK x! | D] } | j | k r | Sq W| rC t d | | f n d Sd S( Ns %s with ID %s not found!( t idR$ R! ( t lt the_idt
friendly_namet raise_errorR ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt _get_itemu s
c C s* t | } | r | St d | d S( sT
Custom value checker for hostname/IP address
:param addr:
:return:
s %s is invalid IP or hostnameN( Rx R ( t addrRJ ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt _check_network_host s t VOLUMESt POOLSt FSt SNAPSHOTSt EXPORTSt NFS_CLIENT_AUTHt
ACCESS_GROUPSt SYSTEMSt DISKSt PLUGINSt TARGET_PORTSt BATTERIESt DEFAULTt THINt FULLs provisioning type: s , t CLONEt COPYt MIRROR_ASYNCt MIRROR_SYNCs replication type: t ENABLEt DISABLEs Policy: t names --policyR} s R t choicesR| t WBt AUTOt WTs Write cache polices: s' which stand for "write back", "auto", s "write through"s7 Can use B, KiB, MiB, GiB, TiB, PiB postfix (IEC sizing)s --syss s System IDsm Search by System ID. Only supported for:
(VOLUMES, POOLS, FS, DISKS, ACCESS_GROUPS,
TARGET_PORTS, BATTERIES)s --pools s Pool IDs; Search by Pool ID. Only supported for:
(VOLUMES, POOLS, FS)s --vols s Volume IDsA Search by Volume ID. Only supported for:
(VOLUMES, ACCESS_GROUPS)s --fss s File System IDs= Search by FS ID. Only supported for:
(FS, SNAPSHOTS, EXPORTS)s --ags s Access Group IDsG Search by Access Group ID. Only supported for:
(ACCESS_GROUPS, VOLUMES)s --inits s Initiator IDs --snaps s Snapshot IDs --exports s Export IDs --nfs-exports s6 Search by NFS Export ID. Only supported for:
(EXPORTS)s --disks s. Search by Disk ID. Only supported for:
(DISKS)s --sizes s --tgts s= Search by target port ID. Only supported for:
(TARGET_PORTS)s --paths Local disk paths t lists List records of different typesR s --types List records of type:
s
s3
When listing SNAPSHOTS, it requires --fs .s t optionals
job-statuss Retrieve information about a jobs --jobs s
job status idt capabilitiess Retrieves array capabilitiess plugin-infos( Retrieves plugin description and versions
volume-creates Creates a volume (logical unit)s --names volume names s --provisioningR s volume-raid-creates( Creates a RAIDed volume on hardware RAIDs s> Free disks for new RAIDed volume.
This is repeatable argument.Ry Rl s --raid-types@ RAID type for the new RAID group. Should be one of these:
%ss --strip-sizes Strip size. s volume-raid-create-caps= Query capability of creating a RAIDed volume on hardware RAIDs
volume-deletes Deletes a volume given its ids
volume-resizes Re-sizes a volumes
s New size. %ss volume-replicates: Creates a new volume and replicates provided volume to it.s s" The name for New replicated volumes
--rep-types s[ Pool ID to contain the new volume.
By default, new volume will be created in the same pool.s volume-replicate-ranges3 Replicates a portion of a volume to existing volumes --src-vols s Source volume ids --dst-vols s Destination volume ids
s Replication type: CLONE, COPYs --src-starts s> Source volume start block number.
This is repeatable argument.s --dst-starts sC Destination volume start block number.
This is repeatable argument.s --counts s; Number of blocks to replicate.
This is repeatable argument.s! volume-replicate-range-block-sizes2 Size of each replicated block on a system in bytess volume-dependantss> Returns True if volume has a dependant child, like replications volume-dependants-rms Removes volume dependenciess volume-access-groups4 Lists the access group(s) that have access to volumes volume-masks> Grants access to an access group to a volume, like LUN Maskings
volume-unmasks7 Revoke the access of specified access group to a volumes
volume-enables Enable block access of a volumes volume-disables Disable block access of a volumes volume-raid-infos Query volume RAID informations volume-ident-led-ons! Enable the IDENT LED for a volumes Targeted volume.
s volume-ident-led-offs" Disable the IDENT LED for a volumes system-read-cache-pct-updates, Change the read cache percentage of a systems Targeted system.
s
--read-pcts Read cache percentage.
s pool-member-infos! Query Pool membership informations access-group-creates Create an access groups s$ Human readable name for access groups access-group-adds+ Add an initiator into existing access groups access-group-removes. Remove an initiator from existing access groups access-group-deletes Deletes an access groups access-group-volumessB Lists the volumes that the access group has been granted access tos
iscsi-chaps5 Configures iSCSI inbound/outbound CHAP authentications --in-users s Inbound chap user names --in-passs s Inbound chap passwords
--out-users
s Outbound chap user names
--out-passs
s Outbound chap passwords fs-creates Creates a file systems s name of the file systems fs-deletes Delete a filesystems fs-resizes Re-sizes a filesystems fs-exports Export a filesystem via NFS.s --exportpaths
s( NFS server export path. e.g. '/foo/bar'.s --anonuids
s% UID(User ID) to map to anonymous users --anongids
s& GID(Group ID) to map to anonymous users --auth-types s NFS client authentication types --root-hosts s9 The host/IP has root access.
This is repeatable argument.s --ro-hosts sr The host/IP has readonly access.
This is repeatable argument.
At least one '--ro-host' or '--rw-host' is required.s --rw-hosts ss The host/IP has readwrite access.
This is repeatable argument.
At least one '--ro-host' or '--rw-host' is required.s fs-unexports Remove an NFS exports fs-clones Creates a file system clones --src-fss s& The ID of existing source file system.s
--dst-names
s3 The name for newly created destination file system.s --backing-snapshots
s backing snapshot ids fs-snap-creates Creates a snapshots s' The human friendly name of new snapshots fs-snap-deletes Deletes a snapshots fs-snap-restores; Restores a FS or specified files to previous snapshot states --files sk Only restore provided file
Without this argument, all files will be restored
This is a repeatable argument.s --fileass sG store restore file name to another name.
This is a repeatable argument.s
fs-dependantssH Returns True if filesystem has a child dependency(clone/snapshot) existss- For file check
This is a repeatable argument.s fs-dependants-rms Removes file system dependenciessH File or files to remove dependencies for.
This is a repeatable argument.s
file-clones, Creates a clone of a file (thin provisioned)s --srcs sC source file to clone (relative path)
This is a repeatable argument.s --dsts s@ Destination file (relative path), this is a repeatable argument.s Query local disk informations volume-cache-infos" Query volume RAM cache informations volume-phy-disk-cache-updates) Update volume physical disk cache settings volume-read-cache-policy-updates Update volume read cache policys volume-write-cache-policy-updates Update volume write cache policys/ Turn on the identification LED for a local disks0 Turn off the identification LED for a local disks& Turn on the fault LED for a local disks' Turn off the fault LED for a local diskt lss list --type systemst lps list --type poolst lvs list --type volumest lds list --type diskst las list --type access_groupst lfs list --type fst lts list --type target_portsR4 Rp t vct vrct vrcct vdt vrt vmt vut vet vit act aat art adt vrit vilont vilofft srcput pmit ldlt lbs list --type batteriest vcit vpdcut vrcput vwcput ldilont ldilofft ldflont ldfloffR" c B s e Z d Z d Z d Z d Z e d Z e d Z d Z d Z
e d Z d Z d
Z
d Z d Z d
Z d Z d Z d Z d Z d Z d Z d Z d Z d Z e d Z d Z d Z d Z d Z d Z d Z d Z! d Z" d Z# d! Z$ d" Z% e d# Z& d$ Z' d% Z( d& Z) d' Z* d( Z+ d) Z, d* Z- d+ Z. d, Z/ d- Z0 d. Z1 d/ Z2 d0 Z3 d1 Z4 d2 Z5 d3 Z6 d4 Z7 d5 Z8 d6 Z9 d7 Z: d8 Z; d9 Z< d: Z= dF d; Z? dF d< Z@ d= ZA d> ZB d? ZC d@ ZD dA ZE dB ZF dC ZG dD ZH dE ZI RS(G s'
Command line interface class.
c C sd | j j s\ | r d n d } t d | t } | j d k rK t St d t Sn t Sd S( s1
Give the user a chance to bail.
t willt maysx Warning: You are about to do an operation that %s cause data to be lost!
Press [Y|y] to continue, any other key to abortt Ys Operation aborted!N( R t forceR RG RV R` R\ ( R t deletingR t pressed( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt confirm_promptT s
c C s t } t | d k r d St j } t } | j j r@ t } n | j j rU t } n | j j rm t j } n t j
| d | d | j j d | j j d | j j d | d | d S( Ni t display_wayt
flag_humant flag_enumt splittert flag_with_headert flag_dsp_all_data(
R\ R^ R t DISPLAY_WAY_DEFAULTR` R t sept headert scriptt DISPLAY_WAY_SCRIPTt display_datat humant enum( R t objectst display_allR R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR k s c C sh g } d } t j | } x9 | D]1 } | j | \ } } | j t | | q" W| j | d S( Ns <}{>( R t available_pluginsR] Rl R R ( R t dR t pluginsRp t descRz ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt display_available_plugins s
c C sX g } xK t j d D]< } | t k rC | j t | j d q | j | q W| S( sb
Walk the command line argument list and build up a new command line
with the appropriate substitutions which is then passed to argparse, so
that we can avoid adding more sub parsers and do all argument parsing
before the need to talk to the library
:return copy of command line args with alias expansion:
i t ( R% R t aliasesRk R] Rl ( RS Rc ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt handle_alias s c C sC d } x6 t t j D]" \ } } | d j | | 7} q W| S( Ns command aliases:
s {0:<18} Alias of '{1}'
( t sortedR t itemst format( RS t kt v( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt alias_help_text s c C sZ t d t } t | d t t d d d t j d d t } t | d t | j d d } x t D]} | j | d
d | d d | g d t } | j
d
} xA | j d g D]- } | d
} | d
=| j | d t | q W| j
d } xV | j d g D]B } | d
} | d
=t
| t sF| f } n | j | | qW| j d t | | d
j d d qm Wt t j d k r| j t d n | | _ | j d t j }
x t |
j D]k \ } } | j t r| t t }
t |
|
d k s<t |
|
t k rRt |
|
| qRqqW|
S( s3
Command line interface parameters
t add_helpR t descriptions^ The libStorageMgmt command line interface. Run %(prog)s -h for more on each command.t epilogsh
Copyright 2012-2018 Red Hat, Inc.
Please report bugs to
t formatter_classR} t commandR R t parentss cmd required argumentsR t requireds cmd optional argumentsR t funct -RN i N( R R\ R R` R" R R t add_subparserst cmdst
add_parsert add_argument_groupt getR t
isinstancet tupleR t getattrt replaceR^ R% R t print_usageR3 t parsert
parse_argsR t varsR t
startswithR R! t setattr( R t
parent_parserR t
subparserst cmdt
sub_parsert groupt argR t flagst
known_argsR
R t root_k( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR6 sN
$
c C sQ | j j r1 t | j j j | j j n t d j | j j d S( sD
Dump the supported nfs client authentication types
s , N( R R R Rn R4 t export_auth( R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt! display_nfs_client_authentication s %c C s d } d } | j d f | j d f | j d f | j d f | j d f | j d f | j d f | j d f f } xJ | D]B } | d ry | r t d
| | d f q | \ } } qy qy W| | f S( Nt system_idt pool_idt volume_idt disk_idt access_group_idt fs_idt
nfs_export_idt tgt_port_idi s, Search key specified more than once (%s, %s)i (
R! R% t poolt volt diskt agt fst
nfs_exportt tgtR$ ( R t
search_keyt search_valuet search_argst sa( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt _get_search_key_value s$
c C ss t j | \ } } | j d k r g } | d k r? d } n | d k r t | j j | j d d t } | r | j j | } q n= | r | t j
k r t d | n | j j | | } | j
t d | D n| j d k rU| d
k rd } n | r6| t j
k r6t d | n | j
| j j | | n| j d k r| d
k ryd } n | r| t j
k rt d | n | j
| j j | | n| j d k rL| j d k rt d n | r| d
k rt d | n t | j j | j d } | j
| j j | n#| j d k r| d k rpd } n | r| t j
k rt d | n | j
| j j | | n| j d k r| rt d n | j n| j d k r| d k r d } n | d k rkt | j j | j d d t } | r[| j
| j j | S| j
g Sn( | r| t j
k rt d | n | j
| j j | | n| j d k r| rt d n | j
| j j n| j d k rj| d k rd } n | r;| t j
k r;t d | n | j
t d | j j | | D n| j d k r| d! k rd } n | r| t j
k rt d" | n | j
| j j | | n | j d# k r| rt d$ n | j ni | j d% k r\| r=| t! j
k r=t d& | n | j
| j j" | | n t d' | j d S(( NR R2 R R4 s Access GroupR s3 Search key '%s' is not supported by volume listing.c s s | ] } t | Vq d S( N( R ( Rg R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pys s R R1 s1 Search key '%s' is not supported by pool listing.R R5 R s --fs requireds5 Search key '%s' is not supported by snapshot listing.s File SystemR R6 s6 Search key '%s' is not supported by NFS Export listingR sC NFS client authentication type listing with search is not supportedR R s8 Search key '%s' is not supported by Access Group listingR s+ System listing with search is not supportedR R3 s0 Search key '%s' is not supported by disk listingc s s | ] } t | Vq d S( N( R ( Rg R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pys b s R R7 s7 Search key '%s' is not supported by target port listingR s, Plugins listing with search is not supportedR s3 Search key '%s' is not supported by battery listings unsupported listing type=%s(# R" RC R| R R4 t
access_groupsR; R\ t" volumes_accessible_by_access_groupR t SUPPORTED_SEARCH_KEYSR$ t volumesR R R t poolsR R< R! t fs_snapshotsR t exportsR/ R9 t access_groups_granted_to_volumeR t systemsR t disksR t target_portsR R t batteries( R R R? R@ t lsm_volst lsm_agR< t lsm_vol( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR s
c C se t | j j | j d } t | j \ } } | j j | j | | | } | j | g d S( Nt System( R R4 RL R% RM t initt access_group_createR R ( R R t systemRI t init_typet access_group( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyRU | s
c C si t | j j | j d } t | j \ } } | rO | j j | | | S| j j | | | Sd S( Ns Access Group( R R4 RD R; RM RT t access_group_initiator_addt access_group_initiator_delete( R R t opRQ RI RW ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt _add_rm_access_grp_init s c C s | j | j | t g d S( N( R R\ R` ( R R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt access_group_add s c C s | j | j | t g d S( N( R R\ R\ ( R R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt access_group_remove s c C sW | j j } t | | j d } | j j | } | j t d | D d S( Ns Access Groupc s s | ] } t | Vq d S( N( R ( Rg R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pys s ( R4 RD R R; RE R R ( R R t aglR) t vols( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt access_group_volumes s c
C sO t | j \ } } | t j k r: t d | j n | j j rb | j j rb t d n | j j r | j j r t d n | j j r | j j r t d n | j j r | j j r t d n | j j r| j j r| j j o| j j rt d n | j
j | | j | j j | j j | j j d S( Ns$ --init "%s" is not a valid iSCSI IQNs --in-user requires --in-passs --in-pass requires --in-users --out-user requires --out-passs --out-pass requires --out-users? out-user and out-password only supported if inbound is supplied( RM RT R t INIT_TYPE_ISCSI_IQNR$ R t in_usert in_passt out_usert out_passR4 t iscsi_chap_auth( R R RI RW ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt
iscsi_chap s$ c C sA t | j j | j d } | j j | } | j | d S( NR ( R R4 RG R9 RK R ( R R R9 t groups( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt volume_access_group s c C s4 | j j } t | | j d } | j j | S( Ns Access Group( R4 RD R R; t access_group_delete( R R R_ R) ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyRk s c C sS t | j j | j d } | j t rO | j d | j j | d n d S( Ns File Systems fs-delete( R R4 R< R R` t _wait_for_itt fs_deleteR! ( R R R< ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyRm s c C se t | j j | j d } | j d | j j | | j | j | j } | j | g d S( NR s fs-create(
R R4 RH R8 Rl t fs_createR t _sizet sizeR ( R R Rp R< ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyRn s
c C s t | j j | j d } | j | j } | | j k rT t t j d n | j t
r | j d | j j | | } | j
| g n d S( Ns File Systems Specified size same as currents fs-resize( R R4 R< Ro Rp t total_spaceR R
t NO_STATE_CHANGER R\ Rl t fs_resizeR ( R R R< Rp ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyRs s c C s t | j j | j d } d } | j rQ t | j j | | j d } n | j d | j j | | j | } | j
| g d S( Ns Source File Systemt Snapshott fs_clone( R R4 R< t src_fsR! t backing_snapshotRI Rl Ru t dst_nameR ( R R Rv t ssR< ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyRu s !c C s t | j j | j d } | j j rN t | j j | | j d } n d } | j d | j j | | j | j
| d d S( Ns File SystemRt t
fs_file_clone( R R4 R< R Rw RI R! Rl Rz t srct dst( R R R< Ry ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt
file_clone s !c C s/ t | } | d k r+ t d | n | S( Ni s$ Incorrect size argument format: '%s'( R R$ ( RW t
size_bytes( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyRo s c C sW | j j d k r! | j j } n d } | r6 d } n d } t d | | | f d S( NRe t SUPPORTEDt UNSUPPORTEDs %s%s%s( R R R! R ( R t capt valRW R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt _cp s c C s t | j j | j d } | j j | } t | j j } t | j t j } t j
} | j j d k r | j j } n t } x | D] } d | | s R c S s | j S( N( t
dest_block( Rh ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR s R ( t sort( t rangesR ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt _check_overlap s
c
C s t | j j | j d } t | j j | j d } t | j } | t j k rm t d | n | j
} | j } | j } t
| s t
| t
| k o t
| k n r t d n g } x t t
| D] } t | | }
t | | } t | | } |
d k r=t d n | d k rXt d n | d k rst d n | |
| j k rt d n | |
| j k rt d
n | j t | | |
q Wt j | | j t r | j j | | | | n d S( Ns
Source Volumes Destination Volumes invalid replication type= %ss@ Differing numbers of src_start, dest_start, and count parametersi s --count: value < 0s --src-start: value < 0s --dst_start: value < 0s# --src-start + --count > source sizes( --dst-start + --count > destination size( R R4 RG t src_volt dst_volR R R R R$ t src_startt dst_startt countR^ R RP t
num_of_blocksRl R R" R R R\ t volume_replicate_range(
R R R{ R| R t
src_startst
dst_startst countsR t bR R R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR s>
/
c C s8 t | j j | j d } t | j j | d S( NRS ( R R4 RL R% R t! volume_replicate_range_block_size( R R RW ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR s c C sS t | j j | j d } t | j j | j d } | j j | | d S( NR s Access Group( R R4 RG R9 RD R; t volume_mask( R R R9 R; ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR s c C sO t | j j | j d } t | j j | j d } | j j | | S( Ns Access GroupR ( R R4 RD R; RG R9 t
volume_unmask( R R R; R9 ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR s c C s t | j j | j d } | j | j } | | j | j k r[ t t j
d n | j t r | j
d | j j | | } | j t | g n d S( NR s Specified size same as currentt resize( R R4 RG R9 Ro Rp t
block_sizeR R R
Rr R R\ Rl t
volume_resizeR R ( R R R Rp R9 ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR s c C s2 t | j j | j d } | j j | d S( NR ( R R4 RG R9 t
volume_enable( R R R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR s c C s2 t | j j | j d } | j j | d S( NR ( R R4 RG R9 t volume_disable( R R R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR s c C s2 t | j j | j d } | j j | d S( Ns
NFS Export( R R4 RJ t exportt
export_remove( R R R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt fs_unexport s c C s t | j j | j d } t | j d k rW t | j d k rW t d n | j j | j | j | j
| j | j | j | j | j
d } | j | g d S( Ns File Systemi s& please specify --ro-host or --rw-host( R R4 R< R^ t rw_hostt ro_hostR$ t export_fsR t
exportpatht root_hostt anonuidt anongidt auth_typeR! R ( R R R< R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt fs_export! s c C s> t | j j | j d } | j j | } t | d S( NR ( R R4 RG R9 t volume_child_dependencyR ( R R R RS ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt volume_dependants6 s c C sA t | j j | j d } | j d | j j | d d S( NR s volume-dependant-rm( R R4 RG R9 Rl t volume_child_dependency_rmR! ( R R R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt volume_dependants_rm< s c C sJ t | j j | j d } | j t | j | j j | g d S( NR ( R R4 RG R9 R R R t volume_raid_info( R R RR ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR A s c C sJ t | j j | j d } | j t | j | j j | g d S( NR ( R R4 RH R8 R R R t pool_member_info( R R t lsm_pool( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR H s c C s\ t j | j } | j j } g | D] } | j | j k r( | ^ q( } t | t | j k r t t j
d d j t | j t d | D n g | D] } | j
t j @s | j ^ q } t | d k rt t j d d j | n | j r!t | j } n t j } | j t | j j | j | | | g d S( Ns Disk ID %s not founds , c s s | ] } | j Vq d S( N( R ( Rg R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pys X s i s Disk %s is not free( R t raid_type_str_to_lsmt raid_typeR4 RM R R: R^ R R
t NOT_FOUND_DISKRn t sett statusR t STATUS_FREEt
DISK_NOT_FREEt
strip_sizeR R t VCR_STRIP_SIZE_DEFAULTR R t volume_raid_createR ( R R R t
all_lsm_disksR t lsm_diskst
busy_disksR ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR O s* +3
c C sJ t | j j | j d } | j t | j | j j | g d S( NRS ( R R4 RL R% R R R t volume_raid_create_cap_get( R R t lsm_sys( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt volume_raid_create_capl s c C s2 t | j j | j d } | j j | d S( NR ( R R4 RG R9 t volume_ident_led_on( R R t
lsm_volume( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR q s c C s2 t | j j | j d } | j j | d S( NR ( R R4 RG R9 t volume_ident_led_off( R R R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR v s c C s t | j j | j d } y t | j } Wn+ t k
r^ } t t j t
| n X| j j | | t | j j | j d } | j | g d S( NRS (
R R4 RL R% R_ t read_pctRQ R R
t INVALID_ARGUMENTR( t system_read_cache_pct_updateR ( R R t
lsm_systemR R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR { s c C sD t | j j | j d } | j j | | j } t | d S( Ns File System( R R4 R< t fs_child_dependencyR R ( R R R< RS ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt
fs_dependants s c C sG t | j j | j d } | j d | j j | | j d d S( Ns File Systems fs-dependants-rm( R R4 R< Rl t fs_child_dependency_rmR R! ( R R R< ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt fs_dependants_rm s
c
C s d } t j j d d } t j j | s2 d St | } x | D] } | j j d ri qH n yT g | j d d D] } | j ^ q \ } } | | k r t | | | n WqH t
k
r qH XqH WWd QXd S( so
Set uri from config file. Will be overridden by cmdline option or
env var if present.
t urit ~s /.lsmcliNt #t =i ( s uri( R R t
expandusert existst opent lstripR# R] t stripR$ RQ ( R t allowed_config_optionst config_patht ft lineRh R R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt _read_configfile s
1
c C s) | j j j j d d t k r% t St S( sU
Return True if current command is one of _CONNECTION_FREE_COMMANDS.
RN R ( R R R R t _CONNECTION_FREE_COMMANDSR` R\ ( R ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt is_connection_free_cmd s c C s d | _ d | _ d | _ d | _ | j | _ d | _ t | j j | _
| j
sj | j
d k ry t d n | j r d S| j
t j d d k r t j d | _ n t j d | _ | j j d k r | j j | _ n | j d k rGd | j k r8| j j d k r8d | _ d | _ qGt d n | j j ret j | _ n | j d k rt | j } | d d k rt d
qn d S( Ni s0 [-w|--wait] requires a non-zero positive integert
LSMCLI_URIt LSMCLI_PASSWORDR| R s sim://s" --uri missing or export LSMCLI_URIt usernames+ password specified with no user name in uri( R! R R4 R t unknown_argsR6 R t cleanupR_ t waitt tmoR$ R R R t getenvt passwordR| t promptt getpassR ( R t u( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR s8
! c C s0 | j r | j n | r, t j | n d S( N( R R% R3 ( R t ec( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR1 s
c C s | j r" | j j | j n | rk t | | _ | j j | j | j | j | j j | _
nO t t | j | j | j | _ t j
d r t d n | j j | _
| j j | j | j d S( s-
Process the parsed command.
t LSM_DEBUG_PLUGINs8 Attach debugger to plug-in, press when ready...N( R R R R
R4 t plugin_registerR R R
t plugin_unregisterR R R R t inputt closeR1 ( R R6 ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyR# s $
c C s g } i t j d 6t j d 6t j d 6t j d 6t j d 6t j d 6t j d 6} x%t j D]} i d d 6t j
d 6t j d 6d d 6t j d 6t j
d 6t j d 6} x | j D]v } y | | | | | p
2
/ * ( R R R ( R R R R (l R R% R Rs R R? R= t argparseR R R t sixt lsmR R R R R R R R
R R R
R R R R R R R t lsm.lsmcli.data_displayR R R R R R R R R R R t PY3R_ RP t collectionsR t ImportErrort ordereddictR! R: RG RM RO RT R RX Rd Rq Rx R\ R R R2 R$ R` R R t list_choicest provision_typesRn t provision_helpt replicate_typest replicate_helpt policy_typest policy_helpR t
policy_optt write_cache_policy_typest write_cache_policy_helpt write_cache_policy_optt size_helpt
sys_id_optt copyt sys_id_filter_optt pool_id_optt pool_id_filter_optt
vol_id_optt vol_id_filter_optt fs_id_optt fs_id_filter_optt ag_id_optt ag_id_filter_optt init_id_optt snap_id_optt
export_id_optt nfs_export_id_filter_optt disk_id_filter_optt size_optt tgt_id_filter_optt local_disk_path_optt VOL_CREATE_RAID_TYPES_STRt ANON_UID_GID_NAR R t objectR" ( ( ( s6 /usr/lib/python2.7/site-packages/lsm/lsmcli/cmdline.pyt s vF
- * G
_local_disk.py 0000644 00000043474 14757650541 0007413 0 ustar 00 # Copyright (C) 2016 Red Hat, Inc.
# (C) Copyright 2017 Hewlett Packard Enterprise Development LP
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; If not, see .
#
# Author: Gris Ge
import six
from lsm import LsmError, ErrorNumber
from lsm._clib import (_local_disk_vpd83_search, _local_disk_vpd83_get,
_local_disk_health_status_get,
_local_disk_rpm_get, _local_disk_list,
_local_disk_link_type_get, _local_disk_ident_led_on,
_local_disk_ident_led_off, _local_disk_fault_led_on,
_local_disk_fault_led_off, _local_disk_serial_num_get,
_local_disk_led_status_get, _local_disk_link_speed_get)
def _use_c_lib_function(func_ref, arg):
(data, err_no, err_msg) = func_ref(arg)
if err_no != ErrorNumber.OK:
raise LsmError(err_no, err_msg)
return data
class LocalDisk(object):
@staticmethod
def vpd83_search(vpd83):
"""
lsm.LocalDisk.vpd83_search(vpd83)
Version:
1.3
Usage:
Find out the disk paths for given SCSI VPD page 0x83 NAA type
ID. Considering multipath, certain VPD83 might have multiple disks
associated.
Parameters:
vpd83 (string)
The VPD83 NAA type ID.
Returns:
[disk_path]
List of string. Empty list if not disk found.
The disk_path string format is '/dev/sd[a-z]+' for SCSI and
ATA disks.
SpecialExceptions:
LsmError
ErrorNumber.LIB_BUG
Internal bug.
Capability:
N/A
No capability required as this is a library level method.
"""
return _use_c_lib_function(_local_disk_vpd83_search, vpd83)
@staticmethod
def serial_num_get(disk_path):
"""
lsm.LocalDisk.serial_num_get(disk_path)
Version:
1.4
Usage:
Query the SCSI VPD80 serial number of given disk path.
Parameters:
disk_path (string)
The disk path, example '/dev/sdb'.
Returns:
serial_num (string)
String of VPD80 serial number. Empty string if not supported.
The string format regex is:
SpecialExceptions:
LsmError
ErrorNumber.LIB_BUG
Internal bug.
ErrorNumber.INVALID_ARGUMENT
Invalid disk_path. Should be like '/dev/sdb'
ErrorNumber.NOT_FOUND_DISK
Provided disk is not found.
Capability:
N/A
No capability required as this is a library level method.
"""
return _use_c_lib_function(_local_disk_serial_num_get, disk_path)
@staticmethod
def vpd83_get(disk_path):
"""
lsm.LocalDisk.vpd83_get(disk_path)
Version:
1.3
Usage:
Query the SCSI VPD83 NAA ID of given disk path.
Parameters:
disk_path (string)
The disk path, example '/dev/sdb'.
Returns:
vpd83 (string)
String of VPD83 NAA ID. Empty string if not supported.
The string format regex is:
(?:^6[0-9a-f]{31})|(?:^[235][0-9a-f]{15})$
SpecialExceptions:
LsmError
ErrorNumber.LIB_BUG
Internal bug.
ErrorNumber.INVALID_ARGUMENT
Invalid disk_path. Should be like '/dev/sdb'
ErrorNumber.NOT_FOUND_DISK
Provided disk is not found.
Capability:
N/A
No capability required as this is a library level method.
"""
return _use_c_lib_function(_local_disk_vpd83_get, disk_path)
@staticmethod
def health_status_get(disk_path):
"""
lsm.LocalDisk.health_status_get(disk_path)
Version:
1.5
Usage:
Retrieve the health status of given disk path.
Parameters:
disk_path (string)
The disk path, example '/dev/sdb'.
Returns:
health_status (integer)
Disk health status:
-1 (lsm.Disk.HEALTH_STATUS_UNKNOWN):
Unknown health status
0 (lsm.Disk.HEALTH_STATUS_FAIL):
health status indicates failure
1 (lsm.Disk.HEALTH_STATUS_WARN):
health status warns of near failure
2 (lsm.Disk.HEALTH_STATUS_GOOD):
health status indicates good health
SpecialExceptions:
LsmError
ErrorNumber.LIB_BUG
Internal bug.
ErrorNumber.INVALID_ARGUMENT
Invalid disk_path. Should be like '/dev/sdb'
ErrorNumber.NOT_FOUND_DISK
Provided disk is not found.
ErrorNumber.NO_SUPPORT
Not supported.
Capability:
N/A
No capability required as this is a library level method.
"""
return _use_c_lib_function(_local_disk_health_status_get, disk_path)
@staticmethod
def rpm_get(disk_path):
"""
Version:
1.3
Usage:
Query the disk rotation speed - revolutions per minute (RPM) of
given disk path.
Require permission to open disk path as read-only and non-block,
normally it's root or disk group privilege.
Parameters:
disk_path (string)
The disk path, example '/dev/sdb', '/dev/nvme0n1'.
Returns:
rpm (integer)
Disk rotation speed:
-1 (lsm.Disk.RPM_UNKNOWN):
Unknown RPM
0 (lsm.Disk.RPM_NON_ROTATING_MEDIUM):
Non-rotating medium (e.g., SSD)
1 (lsm.Disk.RPM_ROTATING_UNKNOWN_SPEED):
Rotational disk with unknown speed
>1:
Normal rotational disk (e.g., HDD)
SpecialExceptions:
LsmError
ErrorNumber.LIB_BUG
Internal bug.
ErrorNumber.INVALID_ARGUMENT
Invalid disk_path. Should be like '/dev/sdb'.
ErrorNumber.NOT_FOUND_DISK
Provided disk is not found.
ErrorNumber.NO_SUPPORT
Not supported.
Capability:
N/A
No capability required as this is a library level method.
"""
return _use_c_lib_function(_local_disk_rpm_get, disk_path)
@staticmethod
def list():
"""
Version:
1.3
Usage:
Query local disk paths. Currently, only SCSI, ATA and NVMe disks
will be included.
Parameters:
N/A
Returns:
[disk_path]
List of string. Empty list if not disk found.
The disk_path string format is '/dev/sd[a-z]+' for SCSI and
ATA disks, '/dev/nvme[0-9]+n[0-9]+' for NVMe disks.
SpecialExceptions:
LsmError
ErrorNumber.LIB_BUG
Internal bug.
ErrorNumber.INVALID_ARGUMENT
Invalid disk_path. Should be like '/dev/sdb'.
ErrorNumber.NOT_FOUND_DISK
Provided disk is not found.
Capability:
N/A
No capability required as this is a library level method.
"""
(disk_paths, err_no, err_msg) = _local_disk_list()
if err_no != ErrorNumber.OK:
raise LsmError(err_no, err_msg)
return disk_paths
@staticmethod
def link_type_get(disk_path):
"""
Version:
1.3
Usage:
Query the disk link type of given disk path.
For SATA disks connected to SAS enclosure, will return
lsm.Disk.LINK_TYPE_ATA.
Require permission to open disk_path(root user or disk group).
Parameters:
disk_path (string)
The disk path, example '/dev/sdb'.
Returns:
link_type (integer)
Link type, possible values are:
lsm.Disk.LINK_TYPE_UNKNOWN
Failed to detect link type
lsm.Disk.LINK_TYPE_FC
Fibre Channel
lsm.Disk.LINK_TYPE_SSA
Serial Storage Architecture, Old IBM tech.
lsm.Disk.LINK_TYPE_SBP
Serial Bus Protocol, used by IEEE 1394.
lsm.Disk.LINK_TYPE_SRP
SCSI RDMA Protocol
lsm.Disk.LINK_TYPE_ISCSI
Internet Small Computer System Interface
lsm.Disk.LINK_TYPE_SAS
Serial Attached SCSI
lsm.Disk.LINK_TYPE_ADT
Automation/Drive Interface Transport
Protocol, often used by Tape.
lsm.Disk.LINK_TYPE_ATA
PATA/IDE or SATA.
lsm.Disk.LINK_TYPE_USB
USB disk.
lsm.Disk.LINK_TYPE_SOP
SCSI over PCI-E
lsm.Disk.LINK_TYPE_PCIE
PCI-E, e.g. NVMe
SpecialExceptions:
LsmError
ErrorNumber.LIB_BUG
Internal bug.
ErrorNumber.INVALID_ARGUMENT
Invalid disk_path. Should be like '/dev/sdb'.
ErrorNumber.NOT_FOUND_DISK
Provided disk is not found.
ErrorNumber.NO_SUPPORT
Provided disk does not support SCSI SPC.
ErrorNumber.PERMISSION_DENIED
Insufficient permission to access provided disk path.
Capability:
N/A
No capability required as this is a library level method.
"""
return _use_c_lib_function(_local_disk_link_type_get, disk_path)
@staticmethod
def ident_led_on(disk_path):
"""
Version:
1.3
Usage:
Turn on the identification LED for specified disk.
Parameters:
disk_path (string)
The disk path, example '/dev/sdb'.
Returns:
None
SpecialExceptions:
LsmError
ErrorNumber.LIB_BUG
Internal bug.
ErrorNumber.NOT_FOUND_DISK
Provided disk is not found.
ErrorNumber.NO_SUPPORT
Provided disk does not support SCSI SPC.
ErrorNumber.PERMISSION_DENIED
No sufficient permission to access provided disk path.
Capability:
N/A
No capability required as this is a library level method.
"""
return _use_c_lib_function(_local_disk_ident_led_on, disk_path)
@staticmethod
def ident_led_off(disk_path):
"""
Version:
1.3
Usage:
Turn off the identification LED for specified disk.
Parameters:
disk_path (string)
The disk path, example '/dev/sdb'.
Returns:
None
SpecialExceptions:
LsmError
ErrorNumber.LIB_BUG
Internal bug.
ErrorNumber.NOT_FOUND_DISK
Provided disk is not found.
ErrorNumber.NO_SUPPORT
Provided disk does not support SCSI SPC.
ErrorNumber.PERMISSION_DENIED
No sufficient permission to access provided disk path.
Capability:
N/A
No capability required as this is a library level method.
"""
return _use_c_lib_function(_local_disk_ident_led_off, disk_path)
@staticmethod
def fault_led_on(disk_path):
"""
Version:
1.3
Usage:
Turn on the fault LED for specified disk.
Parameters:
disk_path (string)
The disk path, example '/dev/sdb'.
Returns:
None
SpecialExceptions:
LsmError
ErrorNumber.LIB_BUG
Internal bug.
ErrorNumber.NOT_FOUND_DISK
Provided disk is not found.
ErrorNumber.NO_SUPPORT
Provided disk does not support SCSI SPC.
ErrorNumber.PERMISSION_DENIED
No sufficient permission to access provided disk path.
Capability:
N/A
No capability required as this is a library level method.
"""
return _use_c_lib_function(_local_disk_fault_led_on, disk_path)
@staticmethod
def fault_led_off(disk_path):
"""
Version:
1.3
Usage:
Turn off the fault LED for specified disk.
Parameters:
disk_path (string)
The disk path, example '/dev/sdb'.
Returns:
None
SpecialExceptions:
LsmError
ErrorNumber.LIB_BUG
Internal bug.
ErrorNumber.INVALID_ARGUMENT
Invalid disk_path. Should be like '/dev/sdb'.
ErrorNumber.NOT_FOUND_DISK
Provided disk is not found.
ErrorNumber.NO_SUPPORT
Provided disk does not support SCSI SPC.
ErrorNumber.PERMISSION_DENIED
No sufficient permission to access provided disk path.
Capability:
N/A
No capability required as this is a library level method.
"""
return _use_c_lib_function(_local_disk_fault_led_off, disk_path)
@staticmethod
def led_status_get(disk_path):
"""
Version:
1.3
Usage:
Get LED status for specified disk.
Parameters:
disk_path (string)
The disk path, example '/dev/sdb'.
Returns:
led_status (integer, bit map)
Could be combination of these values:
lsm.Disk.LED_STATUS_UNKNOWN
lsm.Disk.LED_STATUS_IDENT_ON
lsm.Disk.LED_STATUS_IDENT_OFF
lsm.Disk.LED_STATUS_IDENT_UNKNOWN
Has identification LED, but status is unknown.
If certain disk has no identification LED,
'led_status' should not contain
'lsm.Disk.LED_STATUS_IDENT_ON' or
'lsm.Disk.LED_STATUS_IDENT_OFF' or
'lsm.Disk.LED_STATUS_IDENT_UNKNOWN'
lsm.Disk.LED_STATUS_FAULT_ON
lsm.Disk.LED_STATUS_FAULT_OFF
lsm.Disk.LED_STATUS_FAULT_UNKNOWN
Has fault LED, but status is unknown.
If certain disk has no fault LED,
'led_status' should not contain
'lsm.Disk.LED_STATUS_FAULT_ON' or
'lsm.Disk.LED_STATUS_FAULT_OFF' or
'lsm.Disk.LED_STATUS_FAULT_UNKNOWN'
SpecialExceptions:
LsmError
ErrorNumber.LIB_BUG
Internal bug.
ErrorNumber.INVALID_ARGUMENT
Invalid disk_path. Should be like '/dev/sdb'.
ErrorNumber.NOT_FOUND_DISK
Provided disk is not found.
ErrorNumber.NO_SUPPORT
Provided disk does not support SCSI SPC.
ErrorNumber.PERMISSION_DENIED
No sufficient permission to access provided disk path.
Capability:
N/A
No capability required as this is a library level method.
"""
return _use_c_lib_function(_local_disk_led_status_get, disk_path)
@staticmethod
def link_speed_get(disk_path):
"""
Version:
1.4
Usage:
Get current negotiated logical link speed for specified disk.
Parameters:
disk_path (string)
The disk path, example '/dev/sdb'.
Returns:
link_speed
Integer for link speed in Mbps. For example, '3.0 Gbps' will
get 3000.
SpecialExceptions:
LsmError
ErrorNumber.LIB_BUG
Internal bug.
ErrorNumber.INVALID_ARGUMENT
Invalid disk_path. Should be like '/dev/sdb'.
ErrorNumber.NOT_FOUND_DISK
Provided disk is not found.
ErrorNumber.NO_SUPPORT
Provided disk is not supported yet.
ErrorNumber.PERMISSION_DENIED
No sufficient permission to access provided disk path.
Capability:
N/A
No capability required as this is a library level method.
"""
return _use_c_lib_function(_local_disk_link_speed_get, disk_path)
_pluginrunner.pyo 0000644 00000010103 14757650541 0010175 0 ustar 00
-P`c @ s d d l Z d d l Z d d l Z d d l m Z m Z m Z d d l m Z d d l Z d d l
Z
d d l m Z
d d l m Z d Z d e f d YZ d S( iN( t LsmErrort errort ErrorNumber( t cmd_line_wrapper( t SocketEOF( t TransPortc s- d k r | St f d | D S( s{
This method does not check whether lsm_obj contain requested property.
The method caller should do the check.
c 3 s* | ] } t | k r | Vq d S( N( t getattr( t .0t lsm_obj( t
search_keyt search_value( s5 /usr/lib/python2.7/site-packages/lsm/_pluginrunner.pys # s N( t Nonet list( t lsm_objsR R
( ( R R
s5 /usr/lib/python2.7/site-packages/lsm/_pluginrunner.pyt search_property s t PluginRunnerc B s/ e Z d Z e d Z d Z d Z RS( s]
Plug-in side common code which uses the passed in plugin to do meaningful
work.
c C s+ y t | t SWn t k
r& t SXd S( s4
Returns True if val is an integer.
N( t intt Truet
ValueErrort False( t val( ( s5 /usr/lib/python2.7/site-packages/lsm/_pluginrunner.pyt
_is_number- s
c C s t | _ t | d k rt j | d ry t | d } t t j | t j t j
| _ y | | _ WnN t
k
r } t j } | j j d d d t | t j | n XWqt
k
rt t j t d t j d qXn t | _ t | d S( Ni i i is Error instantiating plug-in s Plug-in exiting.( R t cmdlinet lenR R R R t sockett fromfdt AF_UNIXt SOCK_STREAMt tpt plugint Exceptiont syst exc_infot
send_errort strt sixt reraiseR t tracebackt
format_exct exitR R ( t selfR t argst fdt et ec_info( ( s5 /usr/lib/python2.7/site-packages/lsm/_pluginrunner.pyt __init__8 s& %!
c C s | j r
d St } d } z|yxt ry | j j } | d } | d } | d } t | j | r | d k r t | j | } q t | j | | d } n t t
j d | j j | | d k r t } n | d k rt } | j j
Pn Wq" t k
rI} t t j | j j | d t | q" t k
r} t t j | j j | d t | q" t k
r} | j j | | j | j | j q" Xq" WWn t k
r| rt d
qn t j k
r/}
|
j t j k rt d
qt d t j ne t k
rt d t j y, | j j | t
j d t t j Wqt k
rqXn XWd | r| j j t j d
n Xd S( Ni t methodt idt paramss Unsupported operationt plugin_registert plugin_unregisteriDis! Client went away, exiting plug-ins Unhandled exception in plug-in!
s Unhandled exception in plug-ini (! R R R R t read_reqt hasattrR R R R R t
NO_SUPPORTt send_respt closeR R R% R& R! R" t AttributeErrort codet msgt datat
_SocketEOFR t errnot EPIPER t
PLUGIN_BUGR2 R R' ( R( t
need_shutdownt msg_idR: R. R0 t resultt vet aet lsm_errt se( ( s5 /usr/lib/python2.7/site-packages/lsm/_pluginrunner.pyt runT sl
( t __name__t
__module__t __doc__t staticmethodR R- RG ( ( ( s5 /usr/lib/python2.7/site-packages/lsm/_pluginrunner.pyR ' s ( R R% R t lsmR R R t
lsm.lsmcliR R# R= t lsm._commonR R< t lsm._transportR R t objectR ( ( ( s5 /usr/lib/python2.7/site-packages/lsm/_pluginrunner.pyt s _pluginrunner.pyc 0000644 00000010103 14757650541 0010161 0 ustar 00
-P`c @ s d d l Z d d l Z d d l Z d d l m Z m Z m Z d d l m Z d d l Z d d l
Z
d d l m Z
d d l m Z d Z d e f d YZ d S( iN( t LsmErrort errort ErrorNumber( t cmd_line_wrapper( t SocketEOF( t TransPortc s- d k r | St f d | D S( s{
This method does not check whether lsm_obj contain requested property.
The method caller should do the check.
c 3 s* | ] } t | k r | Vq d S( N( t getattr( t .0t lsm_obj( t
search_keyt search_value( s5 /usr/lib/python2.7/site-packages/lsm/_pluginrunner.pys # s N( t Nonet list( t lsm_objsR R
( ( R R
s5 /usr/lib/python2.7/site-packages/lsm/_pluginrunner.pyt search_property s t PluginRunnerc B s/ e Z d Z e d Z d Z d Z RS( s]
Plug-in side common code which uses the passed in plugin to do meaningful
work.
c C s+ y t | t SWn t k
r& t SXd S( s4
Returns True if val is an integer.
N( t intt Truet
ValueErrort False( t val( ( s5 /usr/lib/python2.7/site-packages/lsm/_pluginrunner.pyt
_is_number- s
c C s t | _ t | d k rt j | d ry t | d } t t j | t j t j
| _ y | | _ WnN t
k
r } t j } | j j d d d t | t j | n XWqt
k
rt t j t d t j d qXn t | _ t | d S( Ni i i is Error instantiating plug-in s Plug-in exiting.( R t cmdlinet lenR R R R t sockett fromfdt AF_UNIXt SOCK_STREAMt tpt plugint Exceptiont syst exc_infot
send_errort strt sixt reraiseR t tracebackt
format_exct exitR R ( t selfR t argst fdt et ec_info( ( s5 /usr/lib/python2.7/site-packages/lsm/_pluginrunner.pyt __init__8 s& %!
c C s | j r
d St } d } z|yxt ry | j j } | d } | d } | d } t | j | r | d k r t | j | } q t | j | | d } n t t
j d | j j | | d k r t } n | d k rt } | j j
Pn Wq" t k
rI} t t j | j j | d t | q" t k
r} t t j | j j | d t | q" t k
r} | j j | | j | j | j q" Xq" WWn t k
r| rt d
qn t j k
r/}
|
j t j k rt d
qt d t j ne t k
rt d t j y, | j j | t
j d t t j Wqt k
rqXn XWd | r| j j t j d
n Xd S( Ni t methodt idt paramss Unsupported operationt plugin_registert plugin_unregisteriDis! Client went away, exiting plug-ins Unhandled exception in plug-in!
s Unhandled exception in plug-ini (! R R R R t read_reqt hasattrR R R R R t
NO_SUPPORTt send_respt closeR R R% R& R! R" t AttributeErrort codet msgt datat
_SocketEOFR t errnot EPIPER t
PLUGIN_BUGR2 R R' ( R( t
need_shutdownt msg_idR: R. R0 t resultt vet aet lsm_errt se( ( s5 /usr/lib/python2.7/site-packages/lsm/_pluginrunner.pyt runT sl
( t __name__t
__module__t __doc__t staticmethodR R- RG ( ( ( s5 /usr/lib/python2.7/site-packages/lsm/_pluginrunner.pyR ' s ( R R% R t lsmR R R t
lsm.lsmcliR R# R= t lsm._commonR R< t lsm._transportR R t objectR ( ( ( s5 /usr/lib/python2.7/site-packages/lsm/_pluginrunner.pyt s version.pyo 0000644 00000000242 14757650541 0006776 0 ustar 00
-P`c @ s
d Z d S( s 1.8.1N( t VERSION( ( ( s/ /usr/lib/python2.7/site-packages/lsm/version.pyt s _client.pyc 0000644 00000167523 14757650541 0006732 0 ustar 00
-P`c @ s d d l Z d d l Z d d l m Z m Z m Z m Z m Z m Z m Z m
Z
m Z m Z m
Z
m Z m Z m Z m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l Z d Z d Z d Z d
e f d YZ! d S( iN( t Volumet NfsExportt Capabilitiest Poolt Systemt Batteryt Diskt AccessGroupt
FileSystemt
FsSnapshott uri_parset LsmErrort ErrorNumbert INetworkAttachedStoraget
TargetPort( t return_requires( t UDS_PATH( t TransPort( t IDatac C s | d =| S( s
Used to remove the self key from the dict d. Self is included when calling
the function locals() in a class method.
t self( ( t d( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyt _del_self" s c C s/ | r+ | | k r+ t t j d | n d S( Ns Unsupported search_key: '%s'( R R t UNSUPPORTED_SEARCH_KEY( t
search_keyt supported_keys( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyt _check_search_key+ s c C s t t j d d S( Ns` The libStorageMgmt daemon is not running (process name lsmd), try 'service libstoragemgmt start'( R R t DAEMON_NOT_RUNNING( ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyt _raise_no_daemon3 s t Clientc B s e Z d Z dI Z dJ Z dK Z dL Z d d Z d d Z e d Z
e d Z dM d d d Z
e dM e d
Z e dM e d Z e e e j d g d e d
Z e dM e d Z e e e d Z e e e e e d Z e dM e d Z e e e d Z e e j d e j d e d Z e e g dM dM e d Z e e g e d Z e dM e d Z! e dM e d Z" e e# g dM dM e d Z$ e e j d e# e d Z% e e j d e# e d Z& e e j d e# e d Z' e e e d Z( e e j d e d Z) e e j d e d Z* e dM e d Z+ e dM e d Z, e e- g dM dM e d! Z. e dM e d" Z/ e dM e d# Z0 e e1 g dM dM e d$ Z2 e e1 e d% Z3 e dM e d& Z4 e e1 e d' Z5 e e1 e d( Z6 e e# g e d) Z7 e e1 g e d* Z8 e e9 e d+ Z: e e j d e d, Z; e e< g dM dM e d- Z= e e j d e d. Z> e e j d e< e d/ Z? e e j d e< e d0 Z@ e e j d e< dM e d1 ZA e e j d dM e d2 ZB e eC g e d3 ZD e e j d eC e d4 ZE e e j d e d5 ZF e e j d eG e d6 ZH e e9 e d7 ZI e e j d e d8 ZJ e e j d g e d9 ZK e eL g dM dM e d: ZM e eL eL jN eL jN dM dM e d; ZO e dM e d< ZP e eQ g dM dM e d= ZR e e e e e e g e d> ZS e e e e j d g g e d? ZT e e g e g g e d@ ZU e e# e dA ZV e dM e dB ZW e dM e dC ZX e eY g dM dM e dD ZZ e e e e e e g e dE Z[ e dM e dF Z\ e dM e dG Z] e dM e dH Z^ RS(N i i i i c C s t d d S( Ns Do not call directly!( t RuntimeError( R t urit plain_text_passwordt
timeout_mst flags( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyt plugin_registerQ s c C s | j j d t t d S( s3
Instruct the plug-in to get ready
R" N( t _tpt rpcR t locals( R R t passwordt timeoutR! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyt __start[ s c C s t j } t j j | r x~ t j | D]j \ } } } xX | D]P } t j j | | } y! t j | } | j t
SWqD t k
r qD XqD Wq. Wn t S( N(
R t _plugin_uds_patht ost patht existst walkt joint
_TransPortt
get_sockett closet TrueR t False( t uds_patht roott sub_folderst filest filenamet udst s( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyt _check_daemon_existse s
c C s) t } d t j k r% t j d } n | S( Nt LSM_UDS_PATH( t _UDS_PATHR* t environ( t rc( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR) y s i0u c C s | | _ | | _ | | _ t j | _ t | d g } | d } d | k rp | j d \ } } | } n t j j
| j | | _ t j j | j r t
t
j | j | _ n/ t j r t t j d | j n t | j | | | | d S( Nt schemet +s Plug-in %s not found!( t _urit _passwordt _timeoutR R) t _uds_pathR
t splitR* R+ R. t plugin_pathR, R/ R0 R# R; R R t PLUGIN_NOT_EXISTR t _Client__start( R R R R R! t uR@ t plugt proto( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyt __init__ s"
c C s | j | d S( s$
Synonym for close.
N( R1 ( R R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyt plugin_unregister s c C s6 | j j d t t | j j d | _ d S( sB
Does an orderly plugin_unregister of the plug-in
RN N( R# R$ R R% R1 t None( R R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR1 s
t :c C s g } t j s t n t j } x t j | D] \ } } } x} | D]u } t j j | | } t t j | } | j
d t d | \ }
} | j d |
| | f | j
qN Wq8 W| S( s
Retrieves all the available plug-ins
Return list of strings of available plug-ins with the
"descversion"
t plugin_infoR! s %s%s%s( R R; R R) R* R- R+ R. R/ R0 R$ t dictt appendR1 ( t field_sepR! R? R4 R5 R6 R7 R8 R9 t tpt it v( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyt available_plugins s
!c C s | j j d t t S( sr
Sets any time-outs for the plug-in (ms)
Return None on success, else LsmError exception
t time_out_set( R# R$ R R% ( R t msR! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyRY s c C s | j j d t t S( sd
Retrieves the current time-out
Return time-out in ms, else raise LsmError
t time_out_get( R# R$ R R% ( R R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR[ s c C s | j j d t t S( s
Returns the stats of the given job.
Returns a tuple ( status (enumeration), percent_complete,
completed item).
else LsmError exception.
t
job_status( R# R$ R R% ( R t job_idR! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR\ s c C s | j j d t t S( ss
Frees resources for a given job number.
Returns None on success, else raises an LsmError
t job_free( R# R$ R R% ( R R] R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR^ s c C s | j j d t t S( sv
Fetches the capabilities of the array
Returns a capability object, see data,py for details.
t capabilities( R# R$ R R% ( R t systemR! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR_ s c C s | j j d t t S( s>
Returns a description and version of plug-in
RQ ( R# R$ R R% ( R R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyRQ " s c C s, t | t j | j j d t t S( s
Returns an array of pool objects. Pools are used in both block and
file system interfaces, thus the reason they are in the base class.
t pools( R R t SUPPORTED_SEARCH_KEYSR# R$ R R% ( R R t search_valueR! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyRa / s c C s | j j d t t S( s
Returns an array of system objects. System information is used to
distinguish resources from on storage array to another when the plug=in
supports the ability to have more than one array managed by it
t systems( R# R$ R R% ( R R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyRd < s c C s t j d d k r@ t | t t f sd t t j d qd n$ t | t sd t t j d n | d k s| | d k r t t j d n | j j d t
t S( s
lsm.Client.system_read_cache_pct_update(self, system, read_pct,
flags=lsm.Client.FLAG_RSVD)
Version:
1.3
Usage:
This method updates the read cache percentage on a system if
supported
Parameters:
system(lsm.System)
an lsm.System object.
read_pct(int)
the desired read cache percentage.
flags (int)
Optional. Reserved for future use.
Should be set as lsm.Client.FLAG_RSVD.
Returns:
returns None on success, else raises LsmError on errors.
SpecialExceptions:
i i s& Invalid read_pct, should be an integerid s, Invalid read_pct, should be in range 0 - 100t system_read_cache_pct_update( t syst version_infot
isinstancet intt longR R t INVALID_ARGUMENTR# R$ R R% ( R R` t read_pctR! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyRe K s c C s5 t j | t j d t | j j d t t S( sg
Register a user/password for the specified initiator for CHAP
authentication.
t raise_exceptiont iscsi_chap_auth( R t initiator_id_verifyt INIT_TYPE_ISCSI_IQNR2 R# R$ R R% ( R t init_idt in_usert in_passwordt out_usert out_passwordR! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyRn } s c C s, t | t j | j j d t t S( s4
Returns an array of volume objects
t volumes( R R Rb R# R$ R R% ( R R Rc R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyRv s c C s | j j d t t S( s
Creates a volume, given a pool, volume name, size and provisioning
returns a tuple (job_id, new volume)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
t
volume_create( R# R$ R R% ( R t poolt volume_namet
size_bytest provisioningR! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyRw s
c C s | j j d t t S( s
Re-sizes a volume.
Returns a tuple (job_id, re-sized_volume)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
t
volume_resize( R# R$ R R% ( R t volumet new_size_bytesR! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR| s c C s | j j d t t S( s
Replicates a volume from the specified pool.
Returns a tuple (job_id, replicated volume)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
t volume_replicate( R# R$ R R% ( R Rx t rep_typet
volume_srct nameR! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s
c C s | j j d t t S( sB
Returns the size of a replicated block in bytes.
t! volume_replicate_range_block_size( R# R$ R R% ( R R` R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s c C s | j j d t t S( s-
Replicates a portion of a volume to itself or another volume. The src,
dest and number of blocks values change with vendor, call
volume_replicate_range_block_size to get block unit size.
Returns Job id or None when completed, else raises LsmError on errors.
t volume_replicate_range( R# R$ R R% ( R R R t volume_destt rangesR! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s
c C s | j j d t t S( sQ
Deletes a volume.
Returns None on success, else job id
t
volume_delete( R# R$ R R% ( R R} R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s c C s | j j d t t S( sx
Makes a volume available to the host
returns None on success, else raises LsmError on errors.
t
volume_enable( R# R$ R R% ( R R} R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR
s c C s | j j d t t S( sz
Makes a volume unavailable to the host
returns None on success, else raises LsmError on errors.
t volume_disable( R# R$ R R% ( R R} R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s c C s, t | t j | j j d t t S( s2
Returns an array of disk objects
t disks( R R Rb R# R$ R R% ( R R Rc R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR * s c C s | j j d t t S( s<
Allows an access group to access a volume.
t volume_mask( R# R$ R R% ( R t access_groupR} R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR 8 s c C s | j j d t t S( sA
Revokes access for an access group for a volume
t
volume_unmask( R# R$ R R% ( R R R} R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR E s c C s, t | t j | j j d t t S( s1
Returns a list of access groups
t
access_groups( R R Rb R# R$ R R% ( R R Rc R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR R s c C s> t j | | d t d \ } } | j j d t t S( ss
Creates an access group and add the specified initiator id,
init_type and desired access.
Rm i t access_group_create( R Ro R2 R# R$ R R% ( R R Rq t init_typeR` R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR c s c C s | j j d t t S( s)
Deletes an access group
t access_group_delete( R# R$ R R% ( R R R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s s c C s> t j | | d t d \ } } | j j d t t S( s6
Adds an initiator to an access group
Rm i t access_group_initiator_add( R Ro R2 R# R$ R R% ( R R Rq R R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s c C s8 t j | d d t d } | j j d t t S( s;
Deletes an initiator from an access group
Rm i t access_group_initiator_deleteN( R Ro RO R2 R# R$ R R% ( R R Rq R R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s
c C s | j j d t t S( sN
Returns the list of volumes that access group has access to.
t" volumes_accessible_by_access_group( R# R$ R R% ( R R R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s c C s | j j d t t S( se
Returns the list of access groups that have access to the specified
volume.
t access_groups_granted_to_volume( R# R$ R R% ( R R} R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s c C s | j j d t t S( s
Returns True if this volume has other volumes which are dependant on
it. Implies that this volume cannot be deleted or possibly modified
because it would affect its children.
t volume_child_dependency( R# R$ R R% ( R R} R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s c C s | j j d t t S( s
If this volume has child dependency, this method call will fully
replicate the blocks removing the relationship between them. This
should return None (success) if volume_child_dependency would return
False.
Note: This operation could take a very long time depending on the size
of the volume and the number of child dependencies.
Returns None if complete else job id, raises LsmError on errors.
t volume_child_dependency_rm( R# R$ R R% ( R R} R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s
c C s, t | t j | j j d t t S( sC
Returns a list of file systems on the controller.
t fs( R R Rb R# R$ R R% ( R R Rc R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s c C s | j j d t t S( s
WARNING: Destructive
Deletes a file system and everything it contains
Returns None on success, else job id
t fs_delete( R# R$ R R% ( R R R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s c C s | j j d t t S( s
Re-size a file system
Returns a tuple (job_id, re-sized file system)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
t fs_resize( R# R$ R R% ( R R R~ R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s c C s | j j d t t S( s
Creates a file system given a pool, name and size.
Note: size is limited to 2**64 bytes
Returns a tuple (job_id, file system)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
t fs_create( R# R$ R R% ( R Rx R Rz R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s
c C s | j j d t t S( s#
Creates a thin, point in time read/writable copy of src to dest.
Optionally uses snapshot as backing of src_fs
Returns a tuple (job_id, file system)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
t fs_clone( R# R$ R R% ( R t src_fst dest_fs_namet snapshotR! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR & s
c C s | j j d t t S( s
Creates a thinly provisioned clone of src to dest.
Note: Source and Destination are required to be on same filesystem and
all directories in destination path need to exist.
Returns None on success, else job id
t
fs_file_clone( R# R$ R R% ( R R t
src_file_namet dest_file_nameR R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR ; s
c C s | j j d t t S( sO
Returns a list of snapshot names for the supplied file system
t fs_snapshots( R# R$ R R% ( R R R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR L s c C s | j j d t t S( s|
Snapshot is a point in time read-only copy
Create a snapshot on the chosen file system.
Returns a tuple (job_id, snapshot)
Notes:
- Snapshot name may not match what was passed in
(depends on array implementation)
- Tuple return values are mutually exclusive, when one
is None the other must be valid.
t fs_snapshot_create( R# R$ R R% ( R R t
snapshot_nameR! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR Y s c C s | j j d t t S( s
Frees the re-sources for the given snapshot on the supplied filesystem.
Returns None on success else job id, LsmError exception on error
t fs_snapshot_delete( R# R$ R R% ( R R R R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR o s c C s | j j d t t S( s6
WARNING: Destructive!
Reverts a file-system or just the specified files from the snapshot.
If a list of files is supplied but the array cannot restore just them
then the operation will fail with an LsmError raised. If files == None
and all_files = True then all files on the file-system are restored.
Restore_file if None none must be the same length as files with each
index in each list referring to the associated file.
Returns None on success, else job id, LsmError exception on error
t fs_snapshot_restore( R# R$ R R% ( R R R R7 t
restore_filest all_filesR! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s c C s | j j d t t S( s&
Returns True if the specified filesystem or specified file on this
file system has child dependencies. This implies that this filesystem
or specified file on this file system cannot be deleted or possibly
modified because it would affect its children.
t fs_child_dependency( R# R$ R R% ( R R R7 R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s c C s | j j d t t S( s
If this filesystem or specified file on this filesystem has child
dependency this method will fully replicate the blocks removing the
relationship between them. This should return None(success) if
fs_child_dependency would return False.
Note: This operation could take a very long time depending on the size
of the filesystem and the number of child dependencies.
Returns None if completed, else job id. Raises LsmError on errors.
t fs_child_dependency_rm( R# R$ R R% ( R R R7 R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s
c C s | j j d t t S( sH
What types of NFS client authentication are supported.
t export_auth( R# R$ R R% ( R R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s c C s, t | t j | j j d t t S( sL
Get a list of all exported file systems on the controller.
t exports( R R Rb R# R$ R R% ( R R Rc R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s c C sQ t | t | t | r5 t t j d n | j j d t t S( sD
Exports a filesystem as specified in the arguments
s( Host cannot both in rw_list and ro_list.t export_fs( t setR R Rk R# R$ R R% ( R t fs_idt export_patht root_listt rw_listt ro_listt anon_uidt anon_gidt auth_typet optionsR! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s c C s | j j d t t S( s.
Removes the specified export
t
export_remove( R# R$ R R% ( R t exportR! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s c C s, t | t j | j j d t t S( s0
Returns a list of target ports
t target_ports( R R Rb R# R$ R R% ( R R Rc R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s c C s | j j d t t S( s Query the RAID information of certain volume.
New in version 1.2.
Query the RAID type, strip size, extents count, minimum I/O size,
optimal I/O size of given volume.
This method requires this capability:
lsm.Capabilities.VOLUME_RAID_INFO
Args:
volume (Volume object): Volume to query
flags (int): Reserved for future use. Should be set as
lsm.Client.FLAG_RSVD
Returns:
[raid_type, strip_size, disk_count, min_io_size, opt_io_size]
raid_type (int): RAID Type of requested volume.
Could be one of these values:
Volume.RAID_TYPE_RAID0
Stripe
Volume.RAID_TYPE_RAID1
Two disks Mirror
Volume.RAID_TYPE_RAID3
Byte-level striping with dedicated parity
Volume.RAID_TYPE_RAID4
Block-level striping with dedicated parity
Volume.RAID_TYPE_RAID5
Block-level striping with distributed parity
Volume.RAID_TYPE_RAID6
Block-level striping with two distributed parities,
aka, RAID-DP
Volume.RAID_TYPE_RAID10
Stripe of mirrors
Volume.RAID_TYPE_RAID15
Parity of mirrors
Volume.RAID_TYPE_RAID16
Dual parity of mirrors
Volume.RAID_TYPE_RAID50
Stripe of parities
Volume.RAID_TYPE_RAID60
Stripe of dual parities
Volume.RAID_TYPE_RAID51
Mirror of parities
Volume.RAID_TYPE_RAID61
Mirror of dual parities
Volume.RAID_TYPE_JBOD
Just bunch of disks, no parity, no striping.
Volume.RAID_TYPE_UNKNOWN
The plugin failed to detect the volume's RAID type.
Volume.RAID_TYPE_MIXED
This volume contains multiple RAID settings.
Volume.RAID_TYPE_OTHER
Vendor specific RAID type
strip_size(int): The size of strip on each disk or other storage
extent.
For RAID1/JBOD, it should be set as sector size.
If plugin failed to detect strip size, it should be set
as Volume.STRIP_SIZE_UNKNOWN(0).
disk_count(int): The count of disks used for assembling the RAID
group(s) where this volume allocated from.
For any RAID system using the slice of disk, this value
indicate how many disk slices are used for the RAID.
For example, on LVM RAID, the 'disk_count' here indicate the
count of PVs used for certain volume.
Another example, on EMC VMAX, the 'disk_count' here indicate
how many hyper volumes are used for this volume.
For any RAID system using remote LUN for data storing, each
remote LUN should be count as a disk.
If the plugin failed to detect disk_count, it should be set
as Volume.DISK_COUNT_UNKNOWN(0).
min_io_size(int): The minimum I/O size, device preferred I/O
size for random I/O. Any I/O size not equal to a multiple
of this value may get significant speed penalty.
Normally it refers to strip size of each disk(extent).
If plugin failed to detect min_io_size, it should try these
values in the sequence of:
logical sector size -> physical sector size ->
Volume.MIN_IO_SIZE_UNKNOWN(0).
opt_io_size(int): The optimal I/O size, device preferred I/O
size for sequential I/O. Normally it refers to RAID group
stripe size.
If plugin failed to detect opt_io_size, it should be set
to Volume.OPT_IO_SIZE_UNKNOWN(0).
Raises:
LsmError:
ErrorNumber.NO_SUPPORT
No support.
t volume_raid_info( R# R$ R R% ( R R} R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s [c C s | j j d t t S( s?
lsm.Client.pool_member_info(self, pool, flags=lsm.Client.FLAG_RSVD)
Version:
1.2
Usage:
Query the membership information of certain pool:
RAID type, member type and member ids.
Currently, LibStorageMgmt supports two types of pool:
* Sub-pool -- Pool.MEMBER_TYPE_POOL
Pool space is allocated from parent pool.
Example:
* NetApp ONTAP volume
* Disk RAID pool -- Pool.MEMBER_TYPE_DISK
Pool is a RAID group assembled by disks.
Example:
* LSI MegaRAID disk group
* EMC VNX pool
* NetApp ONTAP aggregate
Parameters:
pool (lsm.Pool object)
Pool to query
flags (int)
Optional. Reserved for future use.
Should be set as lsm.Client.FLAG_RSVD.
Returns:
[raid_type, member_type, member_ids]
raid_type (int)
RAID Type of requested pool.
Could be one of these values:
Volume.RAID_TYPE_RAID0
Stripe
Volume.RAID_TYPE_RAID1
Two disks Mirror
Volume.RAID_TYPE_RAID3
Byte-level striping with dedicated parity
Volume.RAID_TYPE_RAID4
Block-level striping with dedicated parity
Volume.RAID_TYPE_RAID5
Block-level striping with distributed parity
Volume.RAID_TYPE_RAID6
Block-level striping with two distributed parities,
aka, RAID-DP
Volume.RAID_TYPE_RAID10
Stripe of mirrors
Volume.RAID_TYPE_RAID15
Parity of mirrors
Volume.RAID_TYPE_RAID16
Dual parity of mirrors
Volume.RAID_TYPE_RAID50
Stripe of parities Volume.RAID_TYPE_RAID60
Stripe of dual parities
Volume.RAID_TYPE_RAID51
Mirror of parities
Volume.RAID_TYPE_RAID61
Mirror of dual parities
Volume.RAID_TYPE_JBOD
Just bunch of disks, no parity, no striping.
Volume.RAID_TYPE_UNKNOWN
The plugin failed to detect the volume's RAID type.
Volume.RAID_TYPE_MIXED
This pool contains multiple RAID settings.
Volume.RAID_TYPE_OTHER
Vendor specific RAID type
member_type (int)
Could be one of these values:
Pool.MEMBER_TYPE_POOL
Current pool(also known as sub-pool) is allocated from
other pool(parent pool). The 'raid_type' will set to
RAID_TYPE_OTHER unless certain RAID system support RAID
using space of parent pools.
Pool.MEMBER_TYPE_DISK
Pool is created from RAID group using whole disks.
Pool.MEMBER_TYPE_OTHER
Vendor specific RAID member type.
Pool.MEMBER_TYPE_UNKNOWN
Plugin failed to detect the RAID member type.
member_ids (list of strings)
When 'member_type' is Pool.MEMBER_TYPE_POOL,
the 'member_ids' will contain a list of parent Pool IDs.
When 'member_type' is Pool.MEMBER_TYPE_DISK,
the 'member_ids' will contain a list of disk IDs.
When 'member_type' is Pool.MEMBER_TYPE_OTHER or
Pool.MEMBER_TYPE_UNKNOWN, the member_ids should be an empty
list.
SpecialExceptions:
LsmError
ErrorNumber.NO_SUPPORT
ErrorNumber.NOT_FOUND_POOL
Capability:
lsm.Capabilities.POOL_MEMBER_INFO
t pool_member_info( R# R$ R R% ( R Rx R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR n s `c C s | j j d t t S( s
lsm.Client.volume_raid_create_cap_get(
self, system, flags=lsm.Client.FLAG_RSVD)
Version:
1.2
Usage:
This method is dedicated to local hardware RAID cards.
Query out all supported RAID types and strip sizes which could
be used by lsm.Client.volume_raid_create() method.
Parameters:
system (lsm.System)
Instance of lsm.System
flags (int)
Optional. Reserved for future use.
Should be set as lsm.Client.FLAG_RSVD.
Returns:
[raid_types, strip_sizes]
raid_types ([int])
List of integer, possible values are:
Volume.RAID_TYPE_RAID0
Volume.RAID_TYPE_RAID1
Volume.RAID_TYPE_RAID5
Volume.RAID_TYPE_RAID6
Volume.RAID_TYPE_RAID10
Volume.RAID_TYPE_RAID50
Volume.RAID_TYPE_RAID60
strip_sizes ([int])
List of integer. Stripe size in bytes.
SpecialExceptions:
LsmError
lsm.ErrorNumber.NO_SUPPORT
Method not supported.
Sample:
lsm_client = lsm.Client('sim://')
lsm_sys = lsm_client.systems()[0]
disks = lsm_client.disks(
search_key='system_id', search_value=lsm_sys.id)
free_disks = [d for d in disks if d.status == Disk.STATUS_FREE]
supported_raid_types, supported_strip_sizes = lsm_client.volume_raid_create_cap_get(lsm_sys)
new_vol = lsm_client.volume_raid_create(
'test_volume_raid_create', supported_raid_types[0],
free_disks, supported_strip_sizes[0])
Capability:
lsm.Capabilities.VOLUME_CREATE_RAID
This method is mandatory when volume_raid_create() is
supported.
t volume_raid_create_cap_get( R# R$ R R% ( R R` R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s 5c
C s t | d k r' t t j d n | t j k r] t | d k r] t t j d n | t j k r t | d k r t t j d n | t j k r t | d k r t t j d n | t j k rt | d s t | d k rt t j d qn | t j k r[t | d sCt | d
k r[t t j d q[n | t j
k rt | d st | d k rt t j d
qn | j j d t
t S( s
lsm.Client.volume_raid_create(self, name, raid_type, disks,
strip_size, flags=lsm.Client.FLAG_RSVD)
Version:
1.2
Usage:
This method is dedicated to local hardware RAID cards.
Create a disk RAID pool and allocate entire storage space to
new volume using requested volume name.
When dealing with RAID10, 50 or 60, the first half part of
'disks' will be located in one bottom layer RAID group.
The new volume and new pool will created within the same system
of provided disks.
This method does not allow duplicate call, when duplicate call
was issued, LsmError with ErrorNumber.DISK_NOT_FREE will be raise.
User should check disk.status for Disk.STATUS_FREE before
invoking this method.
Parameters:
name (string)
The name for new volume.
The requested volume name might be ignored due to restriction
of hardware RAID vendors.
The pool name will be automatically chosen by plugin.
raid_type (int)
The RAID type for the RAID group, possible values are:
Volume.RAID_TYPE_RAID0
Volume.RAID_TYPE_RAID1
Volume.RAID_TYPE_RAID5
Volume.RAID_TYPE_RAID6
Volume.RAID_TYPE_RAID10
Volume.RAID_TYPE_RAID15
Volume.RAID_TYPE_RAID16
Volume.RAID_TYPE_RAID50
Please check volume_raid_create_cap_get() returns to get
supported all raid types of current hardware RAID card.
disks ([lsm.Disks,])
A list of lsm.Disk objects. Free disks used for new RAID group.
strip_size (int)
The size in bytes of strip.
When setting strip_size to Volume.VCR_STRIP_SIZE_DEFAULT, it
allow hardware RAID cards to choose their default value.
Please use volume_raid_create_cap_get() method to get all
supported strip size of current hardware RAID card.
The Volume.VCR_STRIP_SIZE_DEFAULT is always supported when
lsm.Capabilities.VOLUME_CREATE_RAID is supported.
flags (int)
Optional. Reserved for future use.
Should be set as lsm.Client.FLAG_RSVD.
Returns:
lsm.Volume
The lsm.Volume object for newly created volume.
SpecialExceptions:
LsmError
lsm.ErrorNumber.NO_SUPPORT
Method not supported or RAID type not supported.
lsm.ErrorNumber.DISK_NOT_FREE
Disk is not in Disk.STATUS_FREE status.
lsm.ErrorNumber.NOT_FOUND_DISK
Disk not found
lsm.ErrorNumber.INVALID_ARGUMENT
1. Invalid input argument data.
2. Disks are not from the same system.
3. Disks are not from the same enclosure.
4. Invalid strip_size.
5. Disk count are meet the minimum requirement:
RAID1: len(disks) == 2
RAID5: len(disks) >= 3
RAID6: len(disks) >= 4
RAID10: len(disks) % 2 == 0 and len(disks) >= 4
RAID50: len(disks) % 2 == 0 and len(disks) >= 6
RAID60: len(disks) % 2 == 0 and len(disks) >= 8
lsm.ErrorNumber.NAME_CONFLICT
Requested name is already be used by other volume.
Sample:
lsm_client = lsm.Client('sim://')
disks = lsm_client.disks()
free_disks = [d for d in disks if d.status == Disk.STATUS_FREE]
new_vol = lsm_client.volume_raid_create(
'raid0_vol1', Volume.RAID_TYPE_RAID0, free_disks)
Capability:
lsm.Capabilities.VOLUME_CREATE_RAID
Indicate current system support volume_raid_create() method.
At least one RAID type should be supported.
The strip_size == Volume.VCR_STRIP_SIZE_DEFAULT is supported.
i s. Illegal input disks argument: no disk includedi s7 Illegal input disks argument: RAID 1 only allow 2 disksi s< Illegal input disks argument: RAID 5 require 3 or more disksi s< Illegal input disks argument: RAID 6 require 4 or more diskssR Illegal input disks argument: RAID 10 require even disks count and 4 or more disksi sR Illegal input disks argument: RAID 50 require even disks count and 6 or more disksi sR Illegal input disks argument: RAID 60 require even disks count and 8 or more diskst volume_raid_create( t lenR R Rk R t RAID_TYPE_RAID1t RAID_TYPE_RAID5t RAID_TYPE_RAID6t RAID_TYPE_RAID10t RAID_TYPE_RAID50t RAID_TYPE_RAID60R# R$ R R% ( R R t raid_typeR t
strip_sizeR! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s@ Y ! ! ! """c C s | j j d t t S( sF
lsm.Client.volume_ident_led_on(self, volume,
flags=lsm.Client.FLAG_RSVD)
Version:
1.3
Usage:
This method enables the IDENT LED on a volume if supported
Parameters:
volume (lsm.Volume)
An lsm.Volume object.
flags (int)
Optional. Reserved for future use.
Should be set as lsm.Client.FLAG_RSVD.
Returns:
returns None on success, else raises LsmError on errors.
SpecialExceptions:
t volume_ident_led_on( R# R$ R R% ( R R} R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s c C s | j j d t t S( sK
lsm.Client.volume_ident_led_off(self, volume,
flags=lsm.Client.FLAG_RSVD)
Version:
1.3
Usage:
This method disables the IDENT LED on a volume if supported
Parameters:
volume (lsm.Volume)
An lsm.Volume object.
flags (int)
Optional. Reserved for future use.
Should be set as lsm.Client.FLAG_RSVD.
Returns:
returns None on success, else raises LsmError on errors.
SpecialExceptions:
t volume_ident_led_off( R# R$ R R% ( R R} R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s c C s, t | t j | j j d t t S( s~
lsm.Client.batteries(self, search_key=None, search_value=None,
flags=lsm.Client.FLAG_RSVD)
Version:
1.3
Usage:
Query batteries. When present, super capacitors will also be
included.
Parameters:
search_key (string, optional)
The key name for the search. Valid search keys are stored in
lsm.Battery.SUPPORTED_SEARCH_KEYS
search_value (string, optional)
The value of search_key to match.
flags (int, optional):
Reserved for future use. Should be set as lsm.Client.FLAG_RSVD
Returns:
[lsm.Battery]
lsm.Battery (object)
lsm.Battery.id (string)
Unique ID for this cache hardware.
lsm.Battery.name (string)
Human friendly name, might include physical location, model
name and etc.
lsm.Battery.type (int)
The hardware type of cache. Could be one of these values:
lsm.Battery.TYPE_CHEMICAL
Chemical battery.
lsm.Battery.TYPE_CAPACITOR
Supper capacitor.
lsm.Battery.TYPE_OTHER
Vendor specific battery type.
lsm.Battery.TYPE_UNKNOWN
Unknown type.
lsm.Battery.status (int, bitmap)
Could be any combination of these values:
lsm.Battery.STATUS_OK
Battery is fully charged, health and not in use
currently.
lsm.Battery.STATUS_DISCHARGING
Battery is in use.
lsm.Battery.STATUS_CHARGING
Battery is charging.
lsm.Battery.STATUS_LEARNING
Battery is calibrating itself by discharging
battery and recharging again.
lsm.Battery.STATUS_DEGRADED
Battery is in degraded mode, need attention.
For example, battery is near end of life.
lsm.Battery.STATUS_ERROR
Battery is having hardware error or end of life.
lsm.Battery.STATUS_OTHER
Vendor specific status.
lsm.Battery.STATUS_UNKNOWN
Unknown.
lsm.Battery.system_id (string)
The id of system which current battery belong to.
SpecialExceptions:
LsmError
ErrorNumber.NO_SUPPORT
Capability:
lsm.Capabilities.BATTERIES
t batteries( R R Rb R# R$ R R% ( R R Rc R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s Bc C s | j j d t t S( s
lsm.Client.volume_cache_info(self, volume,
flags=lsm.Client.FLAG_RSVD)
Version:
1.3
Usage:
Query RAM cache setting and status of specified volume on read
and write I/O.
Parameters:
volume (Lsm.Volume)
The lsm.Volume instance.
flags (int, optional):
Reserved for future use. Should be set as lsm.Client.FLAG_RSVD
Returns:
[int, int, int, int, int]
write_cache_policy (int)
The write cache policy. Valid values are:
* lsm.Volume.WRITE_CACHE_POLICY_WRITE_BACK
The storage system will use write back mode if cache
hardware found.
* lsm.Volume.WRITE_CACHE_POLICY_AUTO
The controller will use write back mode when
battery/capacitor is in good health, otherwise,
write through mode.
* lsm.Volume.WRITE_CACHE_POLICY_WRITE_THROUGH
The storage system will use write through mode.
* lsm.Volume.WRITE_CACHE_POLICY_UNKNOWN
Plugin failed to detect this setting.
write_cache_status (int)
The status of write cache. Valid values are:
* lsm.Volume.WRITE_CACHE_STATUS_WRITE_THROUGH
* lsm.Volume.WRITE_CACHE_STATUS_WRITE_BACK
* lsm.Volume.WRITE_CACHE_STATUS_UNKNOWN
read_cache_policy (int)
The policy for read cache. Valid values are:
* lsm.Volume.READ_CACHE_POLICY_ENABLED
Read cache is enabled, when reading I/O on previous
unchanged written I/O or read I/O in cache will be
returned to I/O initiator immediately without checking
backing store(normally disk).
* lsm.Volume.READ_CACHE_POLICY_DISABLED
Read cache is disabled.
* lsm.Volume.READ_CACHE_POLICY_UNKNOWN
Plugin failed to detect the read cache policy.
read_cache_status (int)
The status of read cache. Valid values are:
* lsm.Volume.READ_CACHE_STATUS_ENABLED
* lsm.Volume.READ_CACHE_STATUS_DISABLED
* lsm.Volume.READ_CACHE_STATUS_UNKNOWN
physical_disk_cache (int)
Whether physical disk's cache is enabled or not.
Please be advised, HDD's physical disk ram cache might be not
protected by storage system's battery or capacitor on sudden
power loss, you could lose data if a power failure occurs
during a write process.
For SSD's physical disk cache, please check with the vendor of
your hardware RAID card and SSD disk.
Valid values are:
* lsm.Volume.PHYSICAL_DISK_CACHE_ENABLED
Physical disk cache enabled.
* lsm.Volume.PHYSICAL_DISK_CACHE_DISABLED
Physical disk cache disabled.
* lsm.Volume.PHYSICAL_DISK_CACHE_USE_DISK_SETTING
Physical disk cache is determined by the disk vendor
via physical disks' SCSI caching mode page(0x08 page).
It is strongly suggested to change this value to
lsm.Volume.PHYSICAL_DISK_CACHE_ENABLED or
lsm.Volume.PHYSICAL_DISK_CACHE_DISABLED
* lsm.Volume.PHYSICAL_DISK_CACHE_UNKNOWN
Plugin failed to detect the physical disk status.
SpecialExceptions:
LsmError
ErrorNumber.NO_SUPPORT
ErrorNumber.NOT_FOUND_VOLUME
Capability:
lsm.Capabilities.VOLUME_CACHE_INFO
t volume_cache_info( R# R$ R R% ( R R} R! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s Rc C sO | t j k r3 | t j k r3 t t j d n | j j d t t S( s
lsm.Client.volume_physical_disk_cache_update(self, volume, pdc,
flags=lsm.Client.FLAG_RSVD)
Version:
1.3
Usage:
Change the setting of RAM physical disk cache of specified volume.
On some product(like HPE SmartArray), this action will be effective
at system level which means that even you are requesting a change
on a specified volume, this change will apply to all other volumes
on the same controller(system).
Parameters:
volume (Lsm.Volume)
The lsm.Volume instance.
pdc (int)
lsm.Volume.PHYSICAL_DISK_CACHE_ENABLED
Enable physical disk cache.
lsm.Volume.PHYSICAL_DISK_CACHE_DISABLED
Disable physical disk cache
flags (int, optional):
Reserved for future use. Should be set as lsm.Client.FLAG_RSVD
Returns:
N/A
SpecialExceptions:
LsmError
ErrorNumber.NO_SUPPORT
You might also get NO_SUPPORT error when trying
to change SSD physical disk cache on MegaRAID.
ErrorNumber.NOT_FOUND_VOLUME
Capability:
lsm.Capabilities.VOLUME_PHYSICAL_DISK_CACHE_SET
Allow changing physical disk cache.
lsm.Capabilities.VOLUME_PHYSICAL_DISK_CACHE_SET_SYSTEM_LEVEL
Indicate that this action will change system settings which
are effective on all volumes in this storage system.
For example, on HPE SmartArray, the physical disk cache
setting is a controller level setting.
s` Argument pdc should be Volume.PHYSICAL_DISK_CACHE_ENABLED or Volume.PHYSICAL_DISK_CACHE_DISABLEDt! volume_physical_disk_cache_update(
R t PHYSICAL_DISK_CACHE_ENABLEDt PHYSICAL_DISK_CACHE_DISABLEDR R Rk R# R$ R R% ( R R} t pdcR! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR h s ) c C s^ | t j k rB | t j k rB | t j k rB t t j d n | j j d t t
S( s
lsm.Client.volume_write_cache_policy_update(self, volume, wcp,
flags=lsm.Client.FLAG_RSVD)
Version:
1.3
Usage:
Change the RAM write cache policy on specified volume.
If lsm.Capabilities.VOLUME_WRITE_CACHE_POLICY_SET_IMPACT_READ
is supported(e.g. HPE SmartArray), the changes on write cache
policy might also impact read cache policy.
If lsm.Capabilities.VOLUME_WRITE_CACHE_POLICY_SET_WB_IMPACT_OTHER
is supported(e.g. HPE SmartArray), changing write cache policy
to write back mode might impact other volumes in the same system.
Parameters:
volume (Lsm.Volume)
The lsm.Volume instance.
wcp (int)
Could be one of these value:
* lsm.Volume.WRITE_CACHE_POLICY_WRITE_BACK
Change to write back mode.
* lsm.Volume.WRITE_CACHE_POLICY_AUTO
Change to auto mode: use write back mode when
battery/capacitor is healthy, otherwise use write
through.
* lsm.Volume.WRITE_CACHE_POLICY_WRITE_THROUGH
Change to write through mode.
flags (int, optional):
Reserved for future use. Should be set as lsm.Client.FLAG_RSVD
Returns:
N/A
SpecialExceptions:
LsmError
ErrorNumber.NO_SUPPORT
ErrorNumber.NOT_FOUND_VOLUME
Capability:
lsm.Capabilities.VOLUME_WRITE_CACHE_POLICY_SET_WRITE_BACK
Allow changing to always mode.
lsm.Capabilities.VOLUME_WRITE_CACHE_POLICY_SET_AUTO
Allow changing to auto mode.
lsm.Capabilities.VOLUME_WRITE_CACHE_POLICY_SET_WRITE_THROUGH
Allow changing to disable mode.
lsm.Capabilities.VOLUME_WRITE_CACHE_POLICY_SET_IMPACT_READ
Indicate this action might impact read cache policy.
lsm.Capabilities.VOLUME_WRITE_CACHE_POLICY_SET_WB_IMPACT_OTHER
Indicate that changing to write back mode might impact other
volumes. For example, on HPE SmartArray, changing to write back
mode will change all other volumes with auto write cache policy
to write back mode.
s Argument wcp should be Volume.WRITE_CACHE_POLICY_WRITE_BACK or Volume.WRITE_CACHE_POLICY_AUTO or Volume.WRITE_CACHE_POLICY_WRITE_THROUGHt volume_write_cache_policy_update( R t WRITE_CACHE_POLICY_WRITE_BACKt WRITE_CACHE_POLICY_AUTOt WRITE_CACHE_POLICY_WRITE_THROUGHR R Rk R# R$ R R% ( R R} t wcpR! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s 4 c C sO | t j k r3 | t j k r3 t t j d n | j j d t t S( s
lsm.Client.volume_read_cache_policy_update(self, volume, rcp,
flags=lsm.Client.FLAG_RSVD)
Version:
1.3
Usage:
Change the RAM read cache policy of specified volume.
If lsm.Capabilities.VOLUME_READ_CACHE_POLICY_SET_IMPACT_WRITE
is supported(like HPE SmartArray), the change on write cache policy
might also impact read cache policy.
Parameters:
volume (Lsm.Volume)
The lsm.Volume instance.
rcp (int)
Could be one of these value:
* lsm.Volume.READ_CACHE_POLICY_ENABLED
Enable read cache.
* lsm.Volume.READ_CACHE_POLICY_DISABLED
Disable read cache.
flags (int, optional):
Reserved for future use. Should be set as lsm.Client.FLAG_RSVD
Returns:
N/A
SpecialExceptions:
LsmError
ErrorNumber.NO_SUPPORT
ErrorNumber.NOT_FOUND_VOLUME
Capability:
lsm.Capabilities.VOLUME_READ_CACHE_POLICY_SET
Allow enabling or disabling read cache policy.
lsm.Capabilities.VOLUME_READ_CACHE_POLICY_SET_IMPACT_WRITE
Indicate that changing read cache policy might impact write
cache policy. For example, on HPE SmartArray, disabling read
cache will also change write cache policy to write through.
s\ Argument rcp should be Volume.READ_CACHE_POLICY_ENABLED or Volume.READ_CACHE_POLICY_DISABLEDt volume_read_cache_policy_update(
R t READ_CACHE_POLICY_ENABLEDt READ_CACHE_POLICY_DISABLEDR R Rk R# R$ R R% ( R R} t rcpR! ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR s & i i i i N(_ t __name__t
__module__t FLAG_RSVDt# FLAG_VOLUME_CREATE_USE_SYSTEM_CACHEt% FLAG_VOLUME_CREATE_USE_IO_PASSTHROUGHt' FLAG_VOLUME_CREATE_DISABLE_SYSTEM_CACHEt) FLAG_VOLUME_CREATE_DISABLE_IO_PASSTHROUGHR" RI t staticmethodR; R) RO RM t _return_requiresRN R1 t sixt string_typesRX RY Ri R[ t _IDataR\ R^ R R_ RQ R Ra R Rd Re Rn R Rv Rw R| R R R R R R R R R R R R R R R R R R t boolR R R R R R R R R R R R R R3 R R R R R R t ANON_UID_GID_NAR R R R R R R R R R R R R R R R ( ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyR @ s
1
a g> DS 2 > (" R* Rf t lsmR R R R R R R R R R R
R R R
R t lsm._commonR R R R= t lsm._transportR R/ t lsm._dataR R R R R R R ( ( ( s/ /usr/lib/python2.7/site-packages/lsm/_client.pyt s d
_iplugin.pyo 0000644 00000052122 14757650541 0007123 0 ustar 00
-P`c @ s d d l m Z d d l m Z d d l m Z m Z d d l m Z d e e e
f d YZ d e f d YZ d e f d
YZ
d e
f d YZ d
S( i( t ABCMeta( t abstractmethod( t LsmErrort ErrorNumber( t with_metaclasst IPluginc B s e Z d Z e d d Z e d d Z e d d Z e d d Z e d d Z e d d Z e d d Z
e d d Z e d d d d
Z
e d d Z RS(
sU
Plug-in interface that all plug-ins must implement for basic
operation.
i c C s d S( s
Method first called to setup the plug-in (except for plugin_info)
This would be the place to make a connection to the array.
Returns None on success, else LsmError exception
N( ( t selft urit passwordt timeoutt flags( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt plugin_register s c C s d S( ss
Sets any time-outs for the plug-in (ms)
Returns None on success, else LsmError exception
N( ( R t msR
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt time_out_set( s c C s d S( se
Retrieves the current time-out
Returns time-out in ms, else raise LsmError
N( ( R R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt time_out_get1 s c C s d S( sZ
Called when the client wants to finish up or the socket goes eof.
Plug-in should clean up all resources. Note: In the case where
the socket goes EOF and the plugin_unregister runs into errors the
exception(s) will not be delivered to the client!
Returns None on success, else LsmError exception
N( ( R R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt plugin_unregister: s
c C s d S( s
Returns the stats of the given job.
Returns a tuple ( status (enumeration), percent_complete,
completed item).
else LsmError exception.
N( ( R t job_idR
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt
job_statusF s c C s d S( sl
Frees resources for a given job.
Returns None on success, else raises an LsmError
N( ( R R R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt job_freeQ s c C s d S( sS
Returns the capabilities for the selected system, raises LsmError
N( ( R t systemR
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt capabilitiesZ s c C s d S( s
Returns the description and version for plug-in, raises LsmError
Note: Make sure plugin can handle this call before plugin_register is
called.
N( ( R R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt plugin_infoa s c C s d S( s
Returns an array of pool objects. Pools are used in both block and
file system interfaces, thus the reason they are in the base class.
Raises LsmError on error
N( ( R t
search_keyt search_valueR
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt poolsk s c C s d S( s
Returns an array of system objects. System information is used to
distinguish resources from on storage array to another when the plug=in
supports the ability to have more than one array managed by it
Raises LsmError on error
N( ( R R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt systemsu s N( t __name__t
__module__t __doc__t _abstractmethodR R
R R R R R R t NoneR R ( ( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyR s*
t IStorageAreaNetworkc B s e Z d d d d Z d d Z d d Z d d Z d d Z d d Z d d Z d d Z
d d Z d
Z d d Z
d d Z d d d d
Z d d Z d d Z d d Z d d Z d d Z d d Z d d Z d d Z d d d d Z RS( i c C s t t j d d S( sV
Returns an array of volume objects
Raises LsmError on error
s
Not supportedN( R R t
NO_SUPPORT( R R R R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt volumes s c C s t t j d d S( s
Creates a volume, given a pool, volume name, size and provisioning
Returns a tuple (job_id, new volume)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
s
Not supportedN( R R R ( R t poolt volume_namet
size_bytest provisioningR
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt
volume_create s c C s t t j d d S( sq
Deletes a volume.
Returns Job id or None if completed, else raises LsmError on errors.
s
Not supportedN( R R R ( R t volumeR
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt
volume_delete s c C s t t j d d S( s
Re-sizes a volume.
Returns a tuple (job_id, re-sized_volume)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
s
Not supportedN( R R R ( R R' t new_size_bytesR
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt
volume_resize s c C s t t j d d S( sB
Replicates a volume from the specified pool. In this library, to
replicate means to create a new volume which is a copy of the source.
Returns a tuple (job_id, replicated volume)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
s
Not supportedN( R R R ( R R" t rep_typet
volume_srct nameR
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt volume_replicate s c C s t t j d d S( s@
Returns the number of bytes per block for volume_replicate_range
call. Callers of volume_replicate_range need to use this when
calculating start and block lengths.
Note: bytes per block may not match volume blocksize.
Returns bytes per block, Raises LsmError on error
s
Not supportedN( R R R ( R R R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt! volume_replicate_range_block_size s
c C s t t j d d S( s+
Replicates a portion of a volume to itself or another volume. The src,
dest and number of blocks values change with vendor, call
volume_replicate_range_block_size to get block unit size.
Returns Job id or None if completed, else raises LsmError on errors.
s
Not supportedN( R R R ( R R+ R, t volume_destt rangesR
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt volume_replicate_range s c C s t t j d d S( sx
Makes a volume available to the host
Returns None on success, else raises LsmError on errors.
s
Not supportedN( R R R ( R R' R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt
volume_enable s c C s t t j d d S( sz
Makes a volume unavailable to the host
Returns None on success, else raises LsmError on errors.
s
Not supportedN( R R R ( R R' R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt volume_disable s c C s t t j d d S( s`
Register a user/password for the specified initiator for CHAP
authentication. in_user & in_password are for inbound CHAP, out_user &
out_password are for outbound CHAP.
Note: Setting in_user, in_password or out_user, out_password to None
will disable authentication.
Raises LsmError on error
s
Not supportedN( R R R ( R t init_idt in_usert in_passwordt out_usert out_passwordR
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt iscsi_chap_auth s c C s t t j d d S( s~
Allows an access group to access a volume.
Returns None on success, else raises LsmError on errors.
s
Not supportedN( R R R ( R t access_groupR' R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt volume_mask s c C s t t j d d S( s
Revokes access for an access group for a volume
Returns None on success, else raises LsmError on errors.
s
Not supportedN( R R R ( R R; R' R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt
volume_unmask s c C s t t j d d S( sM
Returns a list of access groups, raises LsmError on errors.
s
Not supportedN( R R R ( R R R R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt
access_groups s c C s t t j d d S( sM
Returns a list of access groups, raises LsmError on errors.
s
Not supportedN( R R R ( R R- R5 t init_typeR R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt access_group_create s c C s t t j d d S( sC
Deletes an access group, Raises LsmError on error
s
Not supportedN( R R R ( R R; R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt access_group_delete s c C s t t j d d S( sP
Adds an initiator to an access group, Raises LsmError on error
s
Not supportedN( R R R ( R R; R5 R? R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt access_group_initiator_add s c C s t t j d d S( sU
Deletes an initiator from an access group, Raises LsmError on error
s
Not supportedN( R R R ( R R; R5 R? R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt access_group_initiator_delete s c C s t t j d d S( so
Returns the list of volumes that access group has access to.
Raises LsmError on error
s
Not supportedN( R R R ( R R; R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt" volumes_accessible_by_access_group s c C s t t j d d S( sw
Returns the list of access groups that have access to the specified,
Raises LsmError on error
s
Not supportedN( R R R ( R R' R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt access_groups_granted_to_volume s c C s t t j d d S( s
Returns True if this volume has other volumes which are dependant on
it. Implies that this volume cannot be deleted or possibly modified
because it would affect its children.
s
Not supportedN( R R R ( R R' R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt volume_child_dependency' s c C s t t j d d S( s
If this volume has child dependency, this method call will fully
replicate the blocks removing the relationship between them. This
should return None (success) if volume_child_dependency would return
False.
Note: This operation could take a very long time depending on the size
of the volume and the number of child dependencies.
Returns None if complete else job id, raises LsmError on errors.
s
Not supportedN( R R R ( R R' R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt volume_child_dependency_rm/ s c C s t t j d d S( Ns
Not supported( R R R ( R R R R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt target_ports= s N( R R R R! R& R( R* R. R/ R2 R3 R4 R: R< R= R> R@ RA RB RC RD RE RF RG RH ( ( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyR s,
t INetworkAttachedStoragec B s e Z d Z d d d d Z d d Z d d Z d d Z d d d Z d d d Z d d Z
d d Z d d
Z e
d d Z d d Z d d
Z RS( sT
Class the represents Network attached storage (Common NFS/CIFS operations)
i c C s d S( sf
Returns a list of file systems on the controller. Raises LsmError on
errors.
N( ( R R R R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt fsE s c C s t t j d d S( s
WARNING: Destructive
Deletes a file system and everything it contains
Returns None on success, else job id
s
Not supportedN( R R R ( R RJ R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt fs_deleteL s c C s t t j d d S( s
Re-size a file system
Returns a tuple (job_id, re-sized file system)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
s
Not supportedN( R R R ( R RJ R) R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt fs_resizeU s c C s t t j d d S( sO
Creates a file system given a pool, name and size.
Note: size is limited to 2**64 bytes so max size of a single volume
at this time is 16 Exabytes
Returns a tuple (job_id, file system)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
s
Not supportedN( R R R ( R R" R- R$ R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt fs_create_ s
c C s t t j d d S( s#
Creates a thin, point in time read/writable copy of src to dest.
Optionally uses snapshot as backing of src_fs
Returns a tuple (job_id, file system)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
s
Not supportedN( R R R ( R t src_fst dest_fs_namet snapshotR
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt fs_clonek s c C s t t j d d S( s
Creates a thinly provisioned clone of src to dest.
Note: Source and Destination are required to be on same filesystem
Returns Job id or None if completed, else raises LsmError on errors.
s
Not supportedN( R R R ( R RJ t
src_file_namet dest_file_nameRP R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt
fs_file_clonev s c C s t t j d d S( sl
Returns a list of snapshots for the supplied file system,
Raises LsmError on error
s
Not supportedN( R R R ( R RJ R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt fs_snapshots s c C s t t j d d S( s{
Snapshot is a point in time read-only copy
Create a snapshot on the chosen file system
Returns a tuple (job_id, snap shot created)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
Note: Snapshot name may not match
what was passed in (depends on array implementation)
s
Not supportedN( R R R ( R RJ t
snapshot_nameR
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt fs_snapshot_create s
c C s t t j d d S( s
Frees the re-sources for the given snapshot on the supplied filesystem.
Returns Job id or None if completed, else raises LsmError on errors.
s
Not supportedN( R R R ( R RJ RP R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt fs_snapshot_delete s c C s t t j d d S( s<
WARNING: Destructive!
Reverts a file-system or just the specified files from the snapshot.
If a list of files is supplied but the array cannot restore just them
then the operation will fail with an LsmError raised.
If files == None and all_files = True then all files on the
file-system are restored.
Restore_file if not None must be the same length as files with each
index in each list referring to the associated file.
Returns None on success, else job id, LsmError exception on error
s
Not supportedN( R R R ( R RJ RP t filest
restore_filest all_filesR
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt fs_snapshot_restore s c C s t t j d d S( s&
Returns True if the specified filesystem or specified file on this
file system has child dependencies. This implies that this filesystem
or specified file on this file system cannot be deleted or possibly
modified because it would affect its children.
s
Not supportedN( R R R ( R RJ RY R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt fs_child_dependency s c C s t t j d d S( s
If this filesystem or specified file on this filesystem has child
dependency this method will fully replicate the blocks removing the
relationship between them. This should return None(success) if
fs_child_dependency would return False.
Note: This operation could take a very long time depending on the size
of the filesystem and the number of child dependencies.
Returns Job id or None if completed, else raises LsmError on errors.
s
Not supportedN( R R R ( R RJ RY R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt fs_child_dependency_rm s N( R R R R RJ RK RL RM RQ RT RU RW RX t FalseR\ R] R^ ( ( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyRI A s
t INfsc B s> e Z d d Z d d d d Z d d Z d d Z RS( i c C s t t j d d S( sP
Returns the types of authentication that are available for NFS
s
Not supportedN( R R R ( R R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt export_auth s c C s t t j d d S( sL
Get a list of all exported file systems on the controller.
s
Not supportedN( R R R ( R R R R
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt exports s c C s t t j d d S( sA
Exports a filesystem as specified in the export
s
Not supportedN( R R R ( R t fs_idt export_patht root_listt rw_listt ro_listt anon_uidt anon_gidt auth_typet optionsR
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt export_fs s c C s t t j d d S( s.
Removes the specified export
s
Not supportedN( R R R ( R t exportR
( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt
export_remove s N( R R Ra R Rb Rl Rn ( ( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyR` s N( t abcR t _ABCMetaR R t lsmR R t sixR t objectR R RI R` ( ( ( s0 /usr/lib/python2.7/site-packages/lsm/_iplugin.pyt s j _client.py 0000644 00000235003 14757650541 0006554 0 ustar 00 # Copyright (C) 2011-2014 Red Hat, Inc.
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; If not, see .
#
# Author: tasleson
import os
import sys
from lsm import (Volume, NfsExport, Capabilities, Pool, System, Battery,
Disk, AccessGroup, FileSystem, FsSnapshot,
uri_parse, LsmError, ErrorNumber,
INetworkAttachedStorage, TargetPort)
from lsm._common import return_requires as _return_requires
from lsm._common import UDS_PATH as _UDS_PATH
from lsm._transport import TransPort as _TransPort
from lsm._data import IData as _IData
import six
# Removes self for the hash d
# @param d Hash to remove self from
# @returns d with hash removed.
def _del_self(d):
"""
Used to remove the self key from the dict d. Self is included when calling
the function locals() in a class method.
"""
del d['self']
return d
def _check_search_key(search_key, supported_keys):
if search_key and search_key not in supported_keys:
raise LsmError(ErrorNumber.UNSUPPORTED_SEARCH_KEY,
"Unsupported search_key: '%s'" % search_key)
return
# Descriptive exception about daemon not running.
def _raise_no_daemon():
raise LsmError(ErrorNumber.DAEMON_NOT_RUNNING,
"The libStorageMgmt daemon is not running (process "
"name lsmd), try 'service libstoragemgmt start'")
# Main client class for library.
# ** IMPORTANT **
# Theory of operation for methods in this class.
# We are using the name of the method and the name of the parameters and
# using python introspection abilities to translate them to the method and
# parameter names. Makes the code compact, but you will break things if the
# IPlugin class does not match the method names and parameters here!
class Client(INetworkAttachedStorage):
#
# Used for default flag value
#
FLAG_RSVD = 0
FLAG_VOLUME_CREATE_USE_SYSTEM_CACHE = 1 << 0
FLAG_VOLUME_CREATE_USE_IO_PASSTHROUGH = 1 << 1
FLAG_VOLUME_CREATE_DISABLE_SYSTEM_CACHE = 1 << 2
FLAG_VOLUME_CREATE_DISABLE_IO_PASSTHROUGH = 1 << 3
"""
Client side class used for managing storage that utilises RPC mechanism.
"""
# Method added so that the interface for the client RPC and the plug-in
# itself match.
def plugin_register(self, uri, plain_text_password, timeout_ms, flags=0):
raise RuntimeError("Do not call directly!")
# Called when we are ready to initialize the plug-in.
# @param self The this pointer
# @param uri The uniform resource identifier
# @param plain_text_password Password as plain text
# @param timeout_ms The timeout in ms
# @param flags Reserved for future use, must be zero.
# @returns None
def __start(self, uri, password, timeout, flags=0):
"""
Instruct the plug-in to get ready
"""
self._tp.rpc('plugin_register', _del_self(locals()))
# Checks to see if any unix domain sockets exist in the base directory
# and opens a socket to one to see if the server is actually there.
# @param self The this pointer
# @returns True if daemon appears to be present, else false.
@staticmethod
def _check_daemon_exists():
uds_path = Client._plugin_uds_path()
if os.path.exists(uds_path):
for root, sub_folders, files in os.walk(uds_path):
for filename in files:
uds = os.path.join(root, filename)
try:
# This operation will work if the daemon is available
s = _TransPort.get_socket(uds)
s.close()
return True
except LsmError:
pass
else:
# Base directory is not present?
pass
return False
@staticmethod
def _plugin_uds_path():
rc = _UDS_PATH
if 'LSM_UDS_PATH' in os.environ:
rc = os.environ['LSM_UDS_PATH']
return rc
# Class constructor
# @param self The this pointer
# @param uri The uniform resource identifier
# @param plain_text_password Password as plain text (Optional)
# @param timeout_ms The timeout in ms
# @param flags Reserved for future use, must be zero.
# @returns None
def __init__(self, uri, plain_text_password=None, timeout_ms=30000,
flags=0):
self._uri = uri
self._password = plain_text_password
self._timeout = timeout_ms
self._uds_path = Client._plugin_uds_path()
u = uri_parse(uri, ['scheme'])
scheme = u['scheme']
if "+" in scheme:
(plug, proto) = scheme.split("+")
scheme = plug
self.plugin_path = os.path.join(self._uds_path, scheme)
if os.path.exists(self.plugin_path):
self._tp = _TransPort(_TransPort.get_socket(self.plugin_path))
else:
# At this point we don't know if the user specified an incorrect
# plug-in in the URI or the daemon isn't started. We will check
# the directory for other unix domain sockets.
if Client._check_daemon_exists():
raise LsmError(ErrorNumber.PLUGIN_NOT_EXIST,
"Plug-in %s not found!" % self.plugin_path)
else:
_raise_no_daemon()
self.__start(uri, plain_text_password, timeout_ms, flags)
# Synonym for close.
@_return_requires(None)
def plugin_unregister(self, flags=FLAG_RSVD):
"""
Synonym for close.
"""
self.close(flags)
# Does an orderly plugin_unregister of the plug-in
# @param self The this pointer
# @param flags Reserved for future use, must be zero.
@_return_requires(None)
def close(self, flags=FLAG_RSVD):
"""
Does an orderly plugin_unregister of the plug-in
"""
self._tp.rpc('plugin_unregister', _del_self(locals()))
self._tp.close()
self._tp = None
# Retrieves all the available plug-ins
# @param field_sep Field separator
# @param flags: Reserved for future use
@staticmethod
@_return_requires([six.string_types[0]])
def available_plugins(field_sep=':', flags=FLAG_RSVD):
"""
Retrieves all the available plug-ins
Return list of strings of available plug-ins with the
"descversion"
"""
rc = []
if not Client._check_daemon_exists():
_raise_no_daemon()
uds_path = Client._plugin_uds_path()
for root, sub_folders, files in os.walk(uds_path):
for filename in files:
uds = os.path.join(root, filename)
tp = _TransPort(_TransPort.get_socket(uds))
i, v = tp.rpc('plugin_info', dict(flags=flags))
rc.append("%s%s%s" % (i, field_sep, v))
tp.close()
return rc
# Sets the timeout for the plug-in
# @param self The this pointer
# @param ms Time-out in ms
# @param flags Reserved for future use, must be zero.
@_return_requires(None)
def time_out_set(self, ms, flags=FLAG_RSVD):
"""
Sets any time-outs for the plug-in (ms)
Return None on success, else LsmError exception
"""
return self._tp.rpc('time_out_set', _del_self(locals()))
# Retrieves the current time-out value.
# @param self The this pointer
# @param flags Reserved for future use, must be zero.
# @returns Time-out value
@_return_requires(int)
def time_out_get(self, flags=FLAG_RSVD):
"""
Retrieves the current time-out
Return time-out in ms, else raise LsmError
"""
return self._tp.rpc('time_out_get', _del_self(locals()))
# Retrieves the status of the specified job id.
# @param self The this pointer
# @param job_id The job identifier
# @param flags Reserved for future use, must be zero.
# @returns A tuple ( status (enumeration), percent_complete,
# completed item)
@_return_requires(int, int, _IData)
def job_status(self, job_id, flags=FLAG_RSVD):
"""
Returns the stats of the given job.
Returns a tuple ( status (enumeration), percent_complete,
completed item).
else LsmError exception.
"""
return self._tp.rpc('job_status', _del_self(locals()))
# Frees the resources for the specified job id.
# @param self The this pointer
# @param job_id Job id in which to release resource for
# @param flags Reserved for future use, must be zero.
@_return_requires(None)
def job_free(self, job_id, flags=FLAG_RSVD):
"""
Frees resources for a given job number.
Returns None on success, else raises an LsmError
"""
return self._tp.rpc('job_free', _del_self(locals()))
# Gets the capabilities of the array.
# @param self The this pointer
# @param system The system of interest
# @param flags Reserved for future use, must be zero.
# @returns Capability object
@_return_requires(Capabilities)
def capabilities(self, system, flags=FLAG_RSVD):
"""
Fetches the capabilities of the array
Returns a capability object, see data,py for details.
"""
return self._tp.rpc('capabilities', _del_self(locals()))
# Gets information about the plug-in
# @param self The this pointer
# @param flags Reserved for future use
# @returns Tuple (description, version)
@_return_requires(six.string_types[0], six.string_types[0])
def plugin_info(self, flags=FLAG_RSVD):
"""
Returns a description and version of plug-in
"""
return self._tp.rpc('plugin_info', _del_self(locals()))
# Returns an array of pool objects.
# @param self The this pointer
# @param search_key Search key
# @param search_value Search value
# @param flags Reserved for future use, must be zero.
# @returns An array of pool objects.
@_return_requires([Pool])
def pools(self, search_key=None, search_value=None, flags=FLAG_RSVD):
"""
Returns an array of pool objects. Pools are used in both block and
file system interfaces, thus the reason they are in the base class.
"""
_check_search_key(search_key, Pool.SUPPORTED_SEARCH_KEYS)
return self._tp.rpc('pools', _del_self(locals()))
# Returns an array of system objects.
# @param self The this pointer
# @param flags Reserved for future use, must be zero.
# @returns An array of system objects.
@_return_requires([System])
def systems(self, flags=FLAG_RSVD):
"""
Returns an array of system objects. System information is used to
distinguish resources from on storage array to another when the plug=in
supports the ability to have more than one array managed by it
"""
return self._tp.rpc('systems', _del_self(locals()))
# Changes the read cache percentage for a system.
# @param self The this pointer
# @param system System object to target
# @param read_pct Desired read cache percentage
# @param flags Flags
# @returns None on success, else raises LsmError
@_return_requires(None)
def system_read_cache_pct_update(self, system, read_pct, flags=FLAG_RSVD):
"""
lsm.Client.system_read_cache_pct_update(self, system, read_pct,
flags=lsm.Client.FLAG_RSVD)
Version:
1.3
Usage:
This method updates the read cache percentage on a system if
supported
Parameters:
system(lsm.System)
an lsm.System object.
read_pct(int)
the desired read cache percentage.
flags (int)
Optional. Reserved for future use.
Should be set as lsm.Client.FLAG_RSVD.
Returns:
returns None on success, else raises LsmError on errors.
SpecialExceptions:
"""
if sys.version_info[0] == 2:
if not isinstance(read_pct, (int, long)):
raise LsmError(ErrorNumber.INVALID_ARGUMENT,
"Invalid read_pct, should be an integer")
else:
if not isinstance(read_pct, int):
raise LsmError(ErrorNumber.INVALID_ARGUMENT,
"Invalid read_pct, should be an integer")
if read_pct > 100 or read_pct < 0:
raise LsmError(ErrorNumber.INVALID_ARGUMENT,
"Invalid read_pct, should be in range 0 - 100")
return self._tp.rpc('system_read_cache_pct_update',
_del_self(locals()))
# Register a user/password for the specified initiator for CHAP
# authentication.
# Note: If you pass an empty user and password the expected behavior is to
# remove any authentication for the specified initiator.
# @param self The this pointer
# @param init_id The initiator ID
# @param in_user User for inbound CHAP
# @param in_password Password for inbound CHAP
# @param out_user Outbound username
# @param out_password Outbound password
# @param flags Reserved for future use, must be zero.
# @returns None on success, throws LsmError on errors.
@_return_requires(None)
def iscsi_chap_auth(self, init_id, in_user, in_password,
out_user, out_password, flags=FLAG_RSVD):
"""
Register a user/password for the specified initiator for CHAP
authentication.
"""
AccessGroup.initiator_id_verify(init_id,
AccessGroup.INIT_TYPE_ISCSI_IQN,
raise_exception=True)
return self._tp.rpc('iscsi_chap_auth', _del_self(locals()))
# Returns an array of volume objects
# @param self The this pointer
# @param search_key Search key to use
# @param search_value Search value
# @param flags Reserved for future use, must be zero.
# @returns An array of volume objects.
@_return_requires([Volume])
def volumes(self, search_key=None, search_value=None, flags=FLAG_RSVD):
"""
Returns an array of volume objects
"""
_check_search_key(search_key, Volume.SUPPORTED_SEARCH_KEYS)
return self._tp.rpc('volumes', _del_self(locals()))
# Creates a volume
# @param self The this pointer
# @param pool The pool object to allocate storage from
# @param volume_name The human text name for the volume
# @param size_bytes Size of the volume in bytes
# @param provisioning How the volume is to be provisioned
# @param flags Reserved for future use, must be zero.
# @returns A tuple (job_id, new volume), when one is None the other is
# valid.
@_return_requires(six.string_types[0], Volume)
def volume_create(self, pool, volume_name, size_bytes, provisioning,
flags=FLAG_RSVD):
"""
Creates a volume, given a pool, volume name, size and provisioning
returns a tuple (job_id, new volume)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
"""
return self._tp.rpc('volume_create', _del_self(locals()))
# Re-sizes a volume
# @param self The this pointer
# @param volume The volume object to re-size
# @param new_size_bytes Size of the volume in bytes
# @param flags Reserved for future use, must be zero.
# @returns A tuple (job_id, new re-sized volume), when one is
# None the other is valid.
@_return_requires(six.string_types[0], Volume)
def volume_resize(self, volume, new_size_bytes, flags=FLAG_RSVD):
"""
Re-sizes a volume.
Returns a tuple (job_id, re-sized_volume)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
"""
return self._tp.rpc('volume_resize', _del_self(locals()))
# Replicates a volume from the specified pool.
# @param self The this pointer
# @param pool The pool to re-size from
# @param rep_type Replication type
# (enumeration,see common.data.Volume)
# @param volume_src The volume to replicate
# @param name Human readable name of replicated volume
# @param flags Reserved for future use, must be zero.
# @returns A tuple (job_id, new replicated volume), when one is
# None the other is valid.
@_return_requires(six.string_types[0], Volume)
def volume_replicate(self, pool, rep_type, volume_src, name,
flags=FLAG_RSVD):
"""
Replicates a volume from the specified pool.
Returns a tuple (job_id, replicated volume)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
"""
return self._tp.rpc('volume_replicate', _del_self(locals()))
# Size of a replicated block.
# @param self The this pointer
# @param system The system to request the rep. block range size from
# @param flags Reserved for future use, must be zero
# @returns Size of the replicated block in bytes
@_return_requires(int)
def volume_replicate_range_block_size(self, system, flags=FLAG_RSVD):
"""
Returns the size of a replicated block in bytes.
"""
return self._tp.rpc('volume_replicate_range_block_size',
_del_self(locals()))
# Replicates a portion of a volume to itself or another volume.
# @param self The this pointer
# @param rep_type Replication type
# (enumeration, see common.data.Volume)
# @param volume_src The volume src to replicate from
# @param volume_dest The volume dest to replicate to
# @param ranges An array of Block range objects
# @see lsm.common.data.BlockRange
# @param flags Reserved for future use, must be zero.
# @returns Job id or None when completed, else raises LsmError on errors.
@_return_requires(six.string_types[0])
def volume_replicate_range(self, rep_type, volume_src, volume_dest, ranges,
flags=FLAG_RSVD):
"""
Replicates a portion of a volume to itself or another volume. The src,
dest and number of blocks values change with vendor, call
volume_replicate_range_block_size to get block unit size.
Returns Job id or None when completed, else raises LsmError on errors.
"""
return self._tp.rpc('volume_replicate_range', _del_self(locals()))
# Deletes a volume
# @param self The this pointer
# @param volume The volume object which represents the volume to delete
# @param flags Reserved for future use, must be zero.
# @returns None on success, else job id. Raises LsmError on errors.
@_return_requires(six.string_types[0])
def volume_delete(self, volume, flags=FLAG_RSVD):
"""
Deletes a volume.
Returns None on success, else job id
"""
return self._tp.rpc('volume_delete', _del_self(locals()))
# Makes a volume online and available to the host.
# @param self The this pointer
# @param volume The volume to place online
# @param flags Reserved for future use, must be zero.
# @returns None on success, else raises LsmError
@_return_requires(None)
def volume_enable(self, volume, flags=FLAG_RSVD):
"""
Makes a volume available to the host
returns None on success, else raises LsmError on errors.
"""
return self._tp.rpc('volume_enable', _del_self(locals()))
# Takes a volume offline
# @param self The this pointer
# @param volume The volume object
# @param flags Reserved for future use, must be zero.
# @returns None on success, else raises LsmError on errors.
@_return_requires(None)
def volume_disable(self, volume, flags=FLAG_RSVD):
"""
Makes a volume unavailable to the host
returns None on success, else raises LsmError on errors.
"""
return self._tp.rpc('volume_disable', _del_self(locals()))
# Returns an array of disk objects
# @param self The this pointer
# @param search_key Search Key
# @param search_value Search value
# @param flags When equal to DISK.FLAG_RETRIEVE_FULL_INFO
# returned objects will contain optional data.
# If not defined, only the mandatory properties will
# be returned.
# @returns An array of disk objects.
@_return_requires([Disk])
def disks(self, search_key=None, search_value=None, flags=FLAG_RSVD):
"""
Returns an array of disk objects
"""
_check_search_key(search_key, Disk.SUPPORTED_SEARCH_KEYS)
return self._tp.rpc('disks', _del_self(locals()))
# Access control for allowing an access group to access a volume
# @param self The this pointer
# @param access_group The access group
# @param volume The volume to grant access to
# @param flags Reserved for future use, must be zero.
# @returns None on success, throws LsmError on errors.
@_return_requires(None)
def volume_mask(self, access_group, volume, flags=FLAG_RSVD):
"""
Allows an access group to access a volume.
"""
return self._tp.rpc('volume_mask', _del_self(locals()))
# Revokes access to a volume to initiators in an access group
# @param self The this pointer
# @param access_group The access group
# @param volume The volume to grant access to
# @param flags Reserved for future use, must be zero.
# @returns None on success, throws LsmError on errors.
@_return_requires(None)
def volume_unmask(self, access_group, volume, flags=FLAG_RSVD):
"""
Revokes access for an access group for a volume
"""
return self._tp.rpc('volume_unmask', _del_self(locals()))
# Returns a list of access group objects
# @param self The this pointer
# @param search_key Search Key
# @param search_value Search value
# @param flags Reserved for future use, must be zero.
# @returns List of access groups
@_return_requires([AccessGroup])
def access_groups(self, search_key=None, search_value=None,
flags=FLAG_RSVD):
"""
Returns a list of access groups
"""
_check_search_key(search_key, AccessGroup.SUPPORTED_SEARCH_KEYS)
return self._tp.rpc('access_groups', _del_self(locals()))
# Creates an access a group with the specified initiator in it.
# @param self The this pointer
# @param name The initiator group name
# @param init_id Initiator id
# @param init_type Type of initiator (Enumeration)
# @param system Which system to create this group on
# @param flags Reserved for future use, must be zero.
# @returns AccessGroup on success, else raises LsmError
@_return_requires(AccessGroup)
def access_group_create(self, name, init_id, init_type, system,
flags=FLAG_RSVD):
"""
Creates an access group and add the specified initiator id,
init_type and desired access.
"""
init_type, init_id = AccessGroup.initiator_id_verify(
init_id, init_type, raise_exception=True)[1:]
return self._tp.rpc('access_group_create', _del_self(locals()))
# Deletes an access group.
# @param self The this pointer
# @param access_group The access group to delete
# @param flags Reserved for future use, must be zero.
# @returns None on success, throws LsmError on errors.
@_return_requires(None)
def access_group_delete(self, access_group, flags=FLAG_RSVD):
"""
Deletes an access group
"""
return self._tp.rpc('access_group_delete', _del_self(locals()))
# Adds an initiator to an access group
# @param self The this pointer
# @param access_group Group to add initiator to
# @param init_id Initiators id
# @param init_type Initiator id type (enumeration)
# @param flags Reserved for future use, must be zero.
# @returns None on success, throws LsmError on errors.
@_return_requires(AccessGroup)
def access_group_initiator_add(self, access_group, init_id, init_type,
flags=FLAG_RSVD):
"""
Adds an initiator to an access group
"""
init_type, init_id = AccessGroup.initiator_id_verify(
init_id, init_type, raise_exception=True)[1:]
return self._tp.rpc('access_group_initiator_add', _del_self(locals()))
# Deletes an initiator from an access group
# @param self The this pointer
# @param access_group The access group to remove initiator from
# @param init_id The initiator to remove from the group
# @param init_type Initiator id type (enumeration)
# @param flags Reserved for future use, must be zero.
# @returns None on success, throws LsmError on errors.
@_return_requires(AccessGroup)
def access_group_initiator_delete(self, access_group, init_id, init_type,
flags=FLAG_RSVD):
"""
Deletes an initiator from an access group
"""
init_id = AccessGroup.initiator_id_verify(init_id, None,
raise_exception=True)[2]
return self._tp.rpc('access_group_initiator_delete',
_del_self(locals()))
# Returns the list of volumes that access group has access to.
# @param self The this pointer
# @param access_group The access group to list volumes for
# @param flags Reserved for future use, must be zero.
# @returns list of volumes
@_return_requires([Volume])
def volumes_accessible_by_access_group(self, access_group,
flags=FLAG_RSVD):
"""
Returns the list of volumes that access group has access to.
"""
return self._tp.rpc('volumes_accessible_by_access_group',
_del_self(locals()))
# Returns the list of access groups that have access to the specified
# volume.
# @param self The this pointer
# @param volume The volume to list access groups for
# @param flags Reserved for future use, must be zero.
# @returns list of access groups
@_return_requires([AccessGroup])
def access_groups_granted_to_volume(self, volume, flags=FLAG_RSVD):
"""
Returns the list of access groups that have access to the specified
volume.
"""
return self._tp.rpc('access_groups_granted_to_volume',
_del_self(locals()))
# Checks to see if a volume has child dependencies.
# @param self The this pointer
# @param volume The volume to check
# @param flags Reserved for future use, must be zero.
# @returns True or False
@_return_requires(bool)
def volume_child_dependency(self, volume, flags=FLAG_RSVD):
"""
Returns True if this volume has other volumes which are dependant on
it. Implies that this volume cannot be deleted or possibly modified
because it would affect its children.
"""
return self._tp.rpc('volume_child_dependency', _del_self(locals()))
# Removes any child dependency.
# @param self The this pointer
# @param volume The volume to remove dependencies for
# @param flags Reserved for future use, must be zero.
# @returns None if complete, else job id.
@_return_requires(six.string_types[0])
def volume_child_dependency_rm(self, volume, flags=FLAG_RSVD):
"""
If this volume has child dependency, this method call will fully
replicate the blocks removing the relationship between them. This
should return None (success) if volume_child_dependency would return
False.
Note: This operation could take a very long time depending on the size
of the volume and the number of child dependencies.
Returns None if complete else job id, raises LsmError on errors.
"""
return self._tp.rpc('volume_child_dependency_rm', _del_self(locals()))
# Returns a list of file system objects.
# @param self The this pointer
# @param search_key Search Key
# @param search_value Search value
# @param flags Reserved for future use, must be zero.
# @returns A list of FS objects.
@_return_requires([FileSystem])
def fs(self, search_key=None, search_value=None, flags=FLAG_RSVD):
"""
Returns a list of file systems on the controller.
"""
_check_search_key(search_key, FileSystem.SUPPORTED_SEARCH_KEYS)
return self._tp.rpc('fs', _del_self(locals()))
# Deletes a file system
# @param self The this pointer
# @param fs The file system to delete
# @param flags Reserved for future use, must be zero.
# @returns None on success, else job id
@_return_requires(six.string_types[0])
def fs_delete(self, fs, flags=FLAG_RSVD):
"""
WARNING: Destructive
Deletes a file system and everything it contains
Returns None on success, else job id
"""
return self._tp.rpc('fs_delete', _del_self(locals()))
# Re-sizes a file system
# @param self The this pointer
# @param fs The file system to re-size
# @param new_size_bytes The new size of the file system in bytes
# @param flags Reserved for future use, must be zero.
# @returns tuple (job_id, re-sized file system),
# When one is None the other is valid
@_return_requires(six.string_types[0], FileSystem)
def fs_resize(self, fs, new_size_bytes, flags=FLAG_RSVD):
"""
Re-size a file system
Returns a tuple (job_id, re-sized file system)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
"""
return self._tp.rpc('fs_resize', _del_self(locals()))
# Creates a file system.
# @param self The this pointer
# @param pool The pool object to allocate space from
# @param name The human text name for the file system
# @param size_bytes The size of the file system in bytes
# @param flags Reserved for future use, must be zero.
# @returns tuple (job_id, file system),
# When one is None the other is valid
@_return_requires(six.string_types[0], FileSystem)
def fs_create(self, pool, name, size_bytes, flags=FLAG_RSVD):
"""
Creates a file system given a pool, name and size.
Note: size is limited to 2**64 bytes
Returns a tuple (job_id, file system)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
"""
return self._tp.rpc('fs_create', _del_self(locals()))
# Clones a file system
# @param self The this pointer
# @param src_fs The source file system to clone
# @param dest_fs_name The destination file system clone name
# @param snapshot Optional, create clone from previous snapshot
# @param flags Reserved for future use, must be zero.
# @returns tuple (job_id, file system)
@_return_requires(six.string_types[0], FileSystem)
def fs_clone(self, src_fs, dest_fs_name, snapshot=None, flags=FLAG_RSVD):
"""
Creates a thin, point in time read/writable copy of src to dest.
Optionally uses snapshot as backing of src_fs
Returns a tuple (job_id, file system)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
"""
return self._tp.rpc('fs_clone', _del_self(locals()))
# Clones an individual file or files on the specified file system
# @param self The this pointer
# @param fs The file system the files are on
# @param src_file_name The source file name
# @param dest_file_name The dest. file name
# @param snapshot Optional, the snapshot to base clone source
# file from
# @param flags Reserved for future use, must be zero.
# @returns None on success, else job id
@_return_requires(six.string_types[0])
def fs_file_clone(self, fs, src_file_name, dest_file_name, snapshot=None,
flags=FLAG_RSVD):
"""
Creates a thinly provisioned clone of src to dest.
Note: Source and Destination are required to be on same filesystem and
all directories in destination path need to exist.
Returns None on success, else job id
"""
return self._tp.rpc('fs_file_clone', _del_self(locals()))
# Returns a list of snapshots
# @param self The this pointer
# @param fs The file system
# @param flags Reserved for future use, must be zero.
# @returns a list of snapshot objects.
@_return_requires([FsSnapshot])
def fs_snapshots(self, fs, flags=FLAG_RSVD):
"""
Returns a list of snapshot names for the supplied file system
"""
return self._tp.rpc('fs_snapshots', _del_self(locals()))
# Creates a snapshot (Point in time read only copy)
# @param self The this pointer
# @param fs The file system to snapshot
# @param snapshot_name The human readable snapshot name
# @param flags Reserved for future use, must be zero.
# @returns tuple (job_id, snapshot)
@_return_requires(six.string_types[0], FsSnapshot)
def fs_snapshot_create(self, fs, snapshot_name, flags=FLAG_RSVD):
"""
Snapshot is a point in time read-only copy
Create a snapshot on the chosen file system.
Returns a tuple (job_id, snapshot)
Notes:
- Snapshot name may not match what was passed in
(depends on array implementation)
- Tuple return values are mutually exclusive, when one
is None the other must be valid.
"""
return self._tp.rpc('fs_snapshot_create', _del_self(locals()))
# Deletes a snapshot
# @param self The this pointer
# @param fs The filesystem the snapshot it for
# @param snapshot The specific snap shot to delete
# @param flags Reserved for future use, must be zero.
# @returns None on success, else job id
@_return_requires(six.string_types[0])
def fs_snapshot_delete(self, fs, snapshot, flags=FLAG_RSVD):
"""
Frees the re-sources for the given snapshot on the supplied filesystem.
Returns None on success else job id, LsmError exception on error
"""
return self._tp.rpc('fs_snapshot_delete', _del_self(locals()))
# Reverts a snapshot
# @param self The this pointer
# @param fs The file system object to restore snapshot for
# @param snapshot The snapshot file to restore back too
# @param files The specific files to restore
# @param restore_files Individual files to restore
# @param all_files Set to True if all files should be restored
# back
# @param flags Reserved for future use, must be zero.
# @return None on success, else job id
@_return_requires(six.string_types[0])
def fs_snapshot_restore(self, fs, snapshot, files, restore_files,
all_files=False, flags=FLAG_RSVD):
"""
WARNING: Destructive!
Reverts a file-system or just the specified files from the snapshot.
If a list of files is supplied but the array cannot restore just them
then the operation will fail with an LsmError raised. If files == None
and all_files = True then all files on the file-system are restored.
Restore_file if None none must be the same length as files with each
index in each list referring to the associated file.
Returns None on success, else job id, LsmError exception on error
"""
return self._tp.rpc('fs_snapshot_restore', _del_self(locals()))
# Checks to see if a file system has child dependencies.
# @param fs The file system to check
# @param files The files to check (optional)
# @param flags Reserved for future use, must be zero.
# @returns True or False
@_return_requires(bool)
def fs_child_dependency(self, fs, files, flags=FLAG_RSVD):
"""
Returns True if the specified filesystem or specified file on this
file system has child dependencies. This implies that this filesystem
or specified file on this file system cannot be deleted or possibly
modified because it would affect its children.
"""
return self._tp.rpc('fs_child_dependency', _del_self(locals()))
# Removes child dependencies from a FS or specific file.
# @param self The this pointer
# @param fs The file system to remove child dependencies for
# @param files The list of files to remove child dependencies (opt.)
# @param flags Reserved for future use, must be zero.
# @returns None if complete, else job id.
@_return_requires(six.string_types[0])
def fs_child_dependency_rm(self, fs, files, flags=FLAG_RSVD):
"""
If this filesystem or specified file on this filesystem has child
dependency this method will fully replicate the blocks removing the
relationship between them. This should return None(success) if
fs_child_dependency would return False.
Note: This operation could take a very long time depending on the size
of the filesystem and the number of child dependencies.
Returns None if completed, else job id. Raises LsmError on errors.
"""
return self._tp.rpc('fs_child_dependency_rm', _del_self(locals()))
# Returns a list of all the NFS client authentication types.
# @param self The this pointer
# @param flags Reserved for future use, must be zero.
# @returns An array of client authentication types.
@_return_requires([six.string_types[0]])
def export_auth(self, flags=FLAG_RSVD):
"""
What types of NFS client authentication are supported.
"""
return self._tp.rpc('export_auth', _del_self(locals()))
# Returns a list of all the exported file systems
# @param self The this pointer
# @param search_key Search Key
# @param search_value Search value
# @param flags Reserved for future use, must be zero.
# @returns An array of export objects
@_return_requires([NfsExport])
def exports(self, search_key=None, search_value=None, flags=FLAG_RSVD):
"""
Get a list of all exported file systems on the controller.
"""
_check_search_key(search_key, NfsExport.SUPPORTED_SEARCH_KEYS)
return self._tp.rpc('exports', _del_self(locals()))
# Exports a FS as specified in the export.
# @param self The this pointer
# @param fs_id The FS ID to export
# @param export_path The export path (Set to None for array to pick)
# @param root_list List of hosts with root access
# @param rw_list List of hosts with read/write access
# @param ro_list List of hosts with read only access
# @param anon_uid UID to map to anonymous
# @param anon_gid GID to map to anonymous
# @param auth_type NFS client authentication type
# @param options Options to pass to plug-in
# @param flags Reserved for future use, must be zero.
# @returns NfsExport on success, else raises LsmError
@_return_requires(NfsExport)
def export_fs(self, fs_id, export_path, root_list, rw_list, ro_list,
anon_uid=NfsExport.ANON_UID_GID_NA,
anon_gid=NfsExport.ANON_UID_GID_NA,
auth_type=None, options=None, flags=FLAG_RSVD):
"""
Exports a filesystem as specified in the arguments
"""
if set(rw_list) - (set(rw_list) - set(ro_list)):
raise LsmError(ErrorNumber.INVALID_ARGUMENT,
"Host cannot both in rw_list and ro_list.")
return self._tp.rpc('export_fs', _del_self(locals()))
# Removes the specified export
# @param self The this pointer
# @param export The export to remove
# @param flags Reserved for future use, must be zero.
# @returns None on success, else raises LsmError
@_return_requires(None)
def export_remove(self, export, flags=FLAG_RSVD):
"""
Removes the specified export
"""
return self._tp.rpc('export_remove', _del_self(locals()))
# Returns a list of target ports
# @param self The this pointer
# @param search_key The key to search against
# @param search_value The value to search for
# @param flags Reserved for future use, must be zero
# @returns List of target ports, else raises LsmError
@_return_requires([TargetPort])
def target_ports(self, search_key=None, search_value=None,
flags=FLAG_RSVD):
"""
Returns a list of target ports
"""
_check_search_key(search_key, TargetPort.SUPPORTED_SEARCH_KEYS)
return self._tp.rpc('target_ports', _del_self(locals()))
# Returns the RAID information of certain volume
# @param self The this pointer
# @param volume The volume to retrieve RAID information for
# @param flags Reserved for future use, must be zero
# @returns [raid_type, strip_size, disk_count, min_io_size, opt_io_size],
# else raises LsmError
@_return_requires([int, int, int, int, int])
def volume_raid_info(self, volume, flags=FLAG_RSVD):
"""Query the RAID information of certain volume.
New in version 1.2.
Query the RAID type, strip size, extents count, minimum I/O size,
optimal I/O size of given volume.
This method requires this capability:
lsm.Capabilities.VOLUME_RAID_INFO
Args:
volume (Volume object): Volume to query
flags (int): Reserved for future use. Should be set as
lsm.Client.FLAG_RSVD
Returns:
[raid_type, strip_size, disk_count, min_io_size, opt_io_size]
raid_type (int): RAID Type of requested volume.
Could be one of these values:
Volume.RAID_TYPE_RAID0
Stripe
Volume.RAID_TYPE_RAID1
Two disks Mirror
Volume.RAID_TYPE_RAID3
Byte-level striping with dedicated parity
Volume.RAID_TYPE_RAID4
Block-level striping with dedicated parity
Volume.RAID_TYPE_RAID5
Block-level striping with distributed parity
Volume.RAID_TYPE_RAID6
Block-level striping with two distributed parities,
aka, RAID-DP
Volume.RAID_TYPE_RAID10
Stripe of mirrors
Volume.RAID_TYPE_RAID15
Parity of mirrors
Volume.RAID_TYPE_RAID16
Dual parity of mirrors
Volume.RAID_TYPE_RAID50
Stripe of parities
Volume.RAID_TYPE_RAID60
Stripe of dual parities
Volume.RAID_TYPE_RAID51
Mirror of parities
Volume.RAID_TYPE_RAID61
Mirror of dual parities
Volume.RAID_TYPE_JBOD
Just bunch of disks, no parity, no striping.
Volume.RAID_TYPE_UNKNOWN
The plugin failed to detect the volume's RAID type.
Volume.RAID_TYPE_MIXED
This volume contains multiple RAID settings.
Volume.RAID_TYPE_OTHER
Vendor specific RAID type
strip_size(int): The size of strip on each disk or other storage
extent.
For RAID1/JBOD, it should be set as sector size.
If plugin failed to detect strip size, it should be set
as Volume.STRIP_SIZE_UNKNOWN(0).
disk_count(int): The count of disks used for assembling the RAID
group(s) where this volume allocated from.
For any RAID system using the slice of disk, this value
indicate how many disk slices are used for the RAID.
For example, on LVM RAID, the 'disk_count' here indicate the
count of PVs used for certain volume.
Another example, on EMC VMAX, the 'disk_count' here indicate
how many hyper volumes are used for this volume.
For any RAID system using remote LUN for data storing, each
remote LUN should be count as a disk.
If the plugin failed to detect disk_count, it should be set
as Volume.DISK_COUNT_UNKNOWN(0).
min_io_size(int): The minimum I/O size, device preferred I/O
size for random I/O. Any I/O size not equal to a multiple
of this value may get significant speed penalty.
Normally it refers to strip size of each disk(extent).
If plugin failed to detect min_io_size, it should try these
values in the sequence of:
logical sector size -> physical sector size ->
Volume.MIN_IO_SIZE_UNKNOWN(0).
opt_io_size(int): The optimal I/O size, device preferred I/O
size for sequential I/O. Normally it refers to RAID group
stripe size.
If plugin failed to detect opt_io_size, it should be set
to Volume.OPT_IO_SIZE_UNKNOWN(0).
Raises:
LsmError:
ErrorNumber.NO_SUPPORT
No support.
"""
return self._tp.rpc('volume_raid_info', _del_self(locals()))
# Query the membership information of specified pool
# @param self The this pointer
# @param pool The pool to query
# @param flags Reserved for future use, must be zero
# @returns [raid_type, member_type, [member_ids]], lsmError on error
@_return_requires([int, int, [six.string_types[0]]])
def pool_member_info(self, pool, flags=FLAG_RSVD):
"""
lsm.Client.pool_member_info(self, pool, flags=lsm.Client.FLAG_RSVD)
Version:
1.2
Usage:
Query the membership information of certain pool:
RAID type, member type and member ids.
Currently, LibStorageMgmt supports two types of pool:
* Sub-pool -- Pool.MEMBER_TYPE_POOL
Pool space is allocated from parent pool.
Example:
* NetApp ONTAP volume
* Disk RAID pool -- Pool.MEMBER_TYPE_DISK
Pool is a RAID group assembled by disks.
Example:
* LSI MegaRAID disk group
* EMC VNX pool
* NetApp ONTAP aggregate
Parameters:
pool (lsm.Pool object)
Pool to query
flags (int)
Optional. Reserved for future use.
Should be set as lsm.Client.FLAG_RSVD.
Returns:
[raid_type, member_type, member_ids]
raid_type (int)
RAID Type of requested pool.
Could be one of these values:
Volume.RAID_TYPE_RAID0
Stripe
Volume.RAID_TYPE_RAID1
Two disks Mirror
Volume.RAID_TYPE_RAID3
Byte-level striping with dedicated parity
Volume.RAID_TYPE_RAID4
Block-level striping with dedicated parity
Volume.RAID_TYPE_RAID5
Block-level striping with distributed parity
Volume.RAID_TYPE_RAID6
Block-level striping with two distributed parities,
aka, RAID-DP
Volume.RAID_TYPE_RAID10
Stripe of mirrors
Volume.RAID_TYPE_RAID15
Parity of mirrors
Volume.RAID_TYPE_RAID16
Dual parity of mirrors
Volume.RAID_TYPE_RAID50
Stripe of parities Volume.RAID_TYPE_RAID60
Stripe of dual parities
Volume.RAID_TYPE_RAID51
Mirror of parities
Volume.RAID_TYPE_RAID61
Mirror of dual parities
Volume.RAID_TYPE_JBOD
Just bunch of disks, no parity, no striping.
Volume.RAID_TYPE_UNKNOWN
The plugin failed to detect the volume's RAID type.
Volume.RAID_TYPE_MIXED
This pool contains multiple RAID settings.
Volume.RAID_TYPE_OTHER
Vendor specific RAID type
member_type (int)
Could be one of these values:
Pool.MEMBER_TYPE_POOL
Current pool(also known as sub-pool) is allocated from
other pool(parent pool). The 'raid_type' will set to
RAID_TYPE_OTHER unless certain RAID system support RAID
using space of parent pools.
Pool.MEMBER_TYPE_DISK
Pool is created from RAID group using whole disks.
Pool.MEMBER_TYPE_OTHER
Vendor specific RAID member type.
Pool.MEMBER_TYPE_UNKNOWN
Plugin failed to detect the RAID member type.
member_ids (list of strings)
When 'member_type' is Pool.MEMBER_TYPE_POOL,
the 'member_ids' will contain a list of parent Pool IDs.
When 'member_type' is Pool.MEMBER_TYPE_DISK,
the 'member_ids' will contain a list of disk IDs.
When 'member_type' is Pool.MEMBER_TYPE_OTHER or
Pool.MEMBER_TYPE_UNKNOWN, the member_ids should be an empty
list.
SpecialExceptions:
LsmError
ErrorNumber.NO_SUPPORT
ErrorNumber.NOT_FOUND_POOL
Capability:
lsm.Capabilities.POOL_MEMBER_INFO
"""
return self._tp.rpc('pool_member_info', _del_self(locals()))
# Queries all the supported RAID types and stripe sizes which could be
# used for input into volume_raid_create
# @param self The this pointer
# @param system System (raid) card to query
# @param flags Reserved for future use, must be zero
# @returns [raid_types, strip_sizes], lsmError on error
@_return_requires([[int], [int]])
def volume_raid_create_cap_get(self, system, flags=FLAG_RSVD):
"""
lsm.Client.volume_raid_create_cap_get(
self, system, flags=lsm.Client.FLAG_RSVD)
Version:
1.2
Usage:
This method is dedicated to local hardware RAID cards.
Query out all supported RAID types and strip sizes which could
be used by lsm.Client.volume_raid_create() method.
Parameters:
system (lsm.System)
Instance of lsm.System
flags (int)
Optional. Reserved for future use.
Should be set as lsm.Client.FLAG_RSVD.
Returns:
[raid_types, strip_sizes]
raid_types ([int])
List of integer, possible values are:
Volume.RAID_TYPE_RAID0
Volume.RAID_TYPE_RAID1
Volume.RAID_TYPE_RAID5
Volume.RAID_TYPE_RAID6
Volume.RAID_TYPE_RAID10
Volume.RAID_TYPE_RAID50
Volume.RAID_TYPE_RAID60
strip_sizes ([int])
List of integer. Stripe size in bytes.
SpecialExceptions:
LsmError
lsm.ErrorNumber.NO_SUPPORT
Method not supported.
Sample:
lsm_client = lsm.Client('sim://')
lsm_sys = lsm_client.systems()[0]
disks = lsm_client.disks(
search_key='system_id', search_value=lsm_sys.id)
free_disks = [d for d in disks if d.status == Disk.STATUS_FREE]
supported_raid_types, supported_strip_sizes = \
lsm_client.volume_raid_create_cap_get(lsm_sys)
new_vol = lsm_client.volume_raid_create(
'test_volume_raid_create', supported_raid_types[0],
free_disks, supported_strip_sizes[0])
Capability:
lsm.Capabilities.VOLUME_CREATE_RAID
This method is mandatory when volume_raid_create() is
supported.
"""
return self._tp.rpc('volume_raid_create_cap_get', _del_self(locals()))
# Create a disk RAID pool and allocate entire storage space to new volume
# @param self The this pointer
# @param name Name of the raid to be created
# @param raid_type The raid type (enumerated) of the raid group
# @param disks List of disk objects to use
# @param strip_size Strip size in bytes
# @param flags Flags
# @returns the newly created volume, lsmError on errors
@_return_requires(Volume)
def volume_raid_create(self, name, raid_type, disks, strip_size,
flags=FLAG_RSVD):
"""
lsm.Client.volume_raid_create(self, name, raid_type, disks,
strip_size, flags=lsm.Client.FLAG_RSVD)
Version:
1.2
Usage:
This method is dedicated to local hardware RAID cards.
Create a disk RAID pool and allocate entire storage space to
new volume using requested volume name.
When dealing with RAID10, 50 or 60, the first half part of
'disks' will be located in one bottom layer RAID group.
The new volume and new pool will created within the same system
of provided disks.
This method does not allow duplicate call, when duplicate call
was issued, LsmError with ErrorNumber.DISK_NOT_FREE will be raise.
User should check disk.status for Disk.STATUS_FREE before
invoking this method.
Parameters:
name (string)
The name for new volume.
The requested volume name might be ignored due to restriction
of hardware RAID vendors.
The pool name will be automatically chosen by plugin.
raid_type (int)
The RAID type for the RAID group, possible values are:
Volume.RAID_TYPE_RAID0
Volume.RAID_TYPE_RAID1
Volume.RAID_TYPE_RAID5
Volume.RAID_TYPE_RAID6
Volume.RAID_TYPE_RAID10
Volume.RAID_TYPE_RAID15
Volume.RAID_TYPE_RAID16
Volume.RAID_TYPE_RAID50
Please check volume_raid_create_cap_get() returns to get
supported all raid types of current hardware RAID card.
disks ([lsm.Disks,])
A list of lsm.Disk objects. Free disks used for new RAID group.
strip_size (int)
The size in bytes of strip.
When setting strip_size to Volume.VCR_STRIP_SIZE_DEFAULT, it
allow hardware RAID cards to choose their default value.
Please use volume_raid_create_cap_get() method to get all
supported strip size of current hardware RAID card.
The Volume.VCR_STRIP_SIZE_DEFAULT is always supported when
lsm.Capabilities.VOLUME_CREATE_RAID is supported.
flags (int)
Optional. Reserved for future use.
Should be set as lsm.Client.FLAG_RSVD.
Returns:
lsm.Volume
The lsm.Volume object for newly created volume.
SpecialExceptions:
LsmError
lsm.ErrorNumber.NO_SUPPORT
Method not supported or RAID type not supported.
lsm.ErrorNumber.DISK_NOT_FREE
Disk is not in Disk.STATUS_FREE status.
lsm.ErrorNumber.NOT_FOUND_DISK
Disk not found
lsm.ErrorNumber.INVALID_ARGUMENT
1. Invalid input argument data.
2. Disks are not from the same system.
3. Disks are not from the same enclosure.
4. Invalid strip_size.
5. Disk count are meet the minimum requirement:
RAID1: len(disks) == 2
RAID5: len(disks) >= 3
RAID6: len(disks) >= 4
RAID10: len(disks) % 2 == 0 and len(disks) >= 4
RAID50: len(disks) % 2 == 0 and len(disks) >= 6
RAID60: len(disks) % 2 == 0 and len(disks) >= 8
lsm.ErrorNumber.NAME_CONFLICT
Requested name is already be used by other volume.
Sample:
lsm_client = lsm.Client('sim://')
disks = lsm_client.disks()
free_disks = [d for d in disks if d.status == Disk.STATUS_FREE]
new_vol = lsm_client.volume_raid_create(
'raid0_vol1', Volume.RAID_TYPE_RAID0, free_disks)
Capability:
lsm.Capabilities.VOLUME_CREATE_RAID
Indicate current system support volume_raid_create() method.
At least one RAID type should be supported.
The strip_size == Volume.VCR_STRIP_SIZE_DEFAULT is supported.
"""
if len(disks) == 0:
raise LsmError(
ErrorNumber.INVALID_ARGUMENT,
"Illegal input disks argument: no disk included")
if raid_type == Volume.RAID_TYPE_RAID1 and len(disks) != 2:
raise LsmError(
ErrorNumber.INVALID_ARGUMENT,
"Illegal input disks argument: RAID 1 only allow 2 disks")
if raid_type == Volume.RAID_TYPE_RAID5 and len(disks) < 3:
raise LsmError(
ErrorNumber.INVALID_ARGUMENT,
"Illegal input disks argument: RAID 5 require 3 or more disks")
if raid_type == Volume.RAID_TYPE_RAID6 and len(disks) < 4:
raise LsmError(
ErrorNumber.INVALID_ARGUMENT,
"Illegal input disks argument: RAID 6 require 4 or more disks")
if raid_type == Volume.RAID_TYPE_RAID10:
if len(disks) % 2 or len(disks) < 4:
raise LsmError(
ErrorNumber.INVALID_ARGUMENT,
"Illegal input disks argument: "
"RAID 10 require even disks count and 4 or more disks")
if raid_type == Volume.RAID_TYPE_RAID50:
if len(disks) % 2 or len(disks) < 6:
raise LsmError(
ErrorNumber.INVALID_ARGUMENT,
"Illegal input disks argument: "
"RAID 50 require even disks count and 6 or more disks")
if raid_type == Volume.RAID_TYPE_RAID60:
if len(disks) % 2 or len(disks) < 8:
raise LsmError(
ErrorNumber.INVALID_ARGUMENT,
"Illegal input disks argument: "
"RAID 60 require even disks count and 8 or more disks")
return self._tp.rpc('volume_raid_create', _del_self(locals()))
# Enable the IDENT LED for a volume.
# @param self The this pointer
# @param volume Volume object to target
# @param flags Flags
# @returns None on success, else raises LsmError
@_return_requires(None)
def volume_ident_led_on(self, volume, flags=FLAG_RSVD):
"""
lsm.Client.volume_ident_led_on(self, volume,
flags=lsm.Client.FLAG_RSVD)
Version:
1.3
Usage:
This method enables the IDENT LED on a volume if supported
Parameters:
volume (lsm.Volume)
An lsm.Volume object.
flags (int)
Optional. Reserved for future use.
Should be set as lsm.Client.FLAG_RSVD.
Returns:
returns None on success, else raises LsmError on errors.
SpecialExceptions:
"""
return self._tp.rpc('volume_ident_led_on', _del_self(locals()))
# Disable the IDENT LED for a volume.
# @param self The this pointer
# @param volume Volume object to target
# @param flags Flags
# @returns None on success, else raises LsmError
@_return_requires(None)
def volume_ident_led_off(self, volume, flags=FLAG_RSVD):
"""
lsm.Client.volume_ident_led_off(self, volume,
flags=lsm.Client.FLAG_RSVD)
Version:
1.3
Usage:
This method disables the IDENT LED on a volume if supported
Parameters:
volume (lsm.Volume)
An lsm.Volume object.
flags (int)
Optional. Reserved for future use.
Should be set as lsm.Client.FLAG_RSVD.
Returns:
returns None on success, else raises LsmError on errors.
SpecialExceptions:
"""
return self._tp.rpc('volume_ident_led_off', _del_self(locals()))
@_return_requires([Battery])
def batteries(self, search_key=None, search_value=None, flags=FLAG_RSVD):
"""
lsm.Client.batteries(self, search_key=None, search_value=None,
flags=lsm.Client.FLAG_RSVD)
Version:
1.3
Usage:
Query batteries. When present, super capacitors will also be
included.
Parameters:
search_key (string, optional)
The key name for the search. Valid search keys are stored in
lsm.Battery.SUPPORTED_SEARCH_KEYS
search_value (string, optional)
The value of search_key to match.
flags (int, optional):
Reserved for future use. Should be set as lsm.Client.FLAG_RSVD
Returns:
[lsm.Battery]
lsm.Battery (object)
lsm.Battery.id (string)
Unique ID for this cache hardware.
lsm.Battery.name (string)
Human friendly name, might include physical location, model
name and etc.
lsm.Battery.type (int)
The hardware type of cache. Could be one of these values:
lsm.Battery.TYPE_CHEMICAL
Chemical battery.
lsm.Battery.TYPE_CAPACITOR
Supper capacitor.
lsm.Battery.TYPE_OTHER
Vendor specific battery type.
lsm.Battery.TYPE_UNKNOWN
Unknown type.
lsm.Battery.status (int, bitmap)
Could be any combination of these values:
lsm.Battery.STATUS_OK
Battery is fully charged, health and not in use
currently.
lsm.Battery.STATUS_DISCHARGING
Battery is in use.
lsm.Battery.STATUS_CHARGING
Battery is charging.
lsm.Battery.STATUS_LEARNING
Battery is calibrating itself by discharging
battery and recharging again.
lsm.Battery.STATUS_DEGRADED
Battery is in degraded mode, need attention.
For example, battery is near end of life.
lsm.Battery.STATUS_ERROR
Battery is having hardware error or end of life.
lsm.Battery.STATUS_OTHER
Vendor specific status.
lsm.Battery.STATUS_UNKNOWN
Unknown.
lsm.Battery.system_id (string)
The id of system which current battery belong to.
SpecialExceptions:
LsmError
ErrorNumber.NO_SUPPORT
Capability:
lsm.Capabilities.BATTERIES
"""
_check_search_key(search_key, Battery.SUPPORTED_SEARCH_KEYS)
return self._tp.rpc('batteries', _del_self(locals()))
@_return_requires([int, int, int, int, int])
def volume_cache_info(self, volume, flags=FLAG_RSVD):
"""
lsm.Client.volume_cache_info(self, volume,
flags=lsm.Client.FLAG_RSVD)
Version:
1.3
Usage:
Query RAM cache setting and status of specified volume on read
and write I/O.
Parameters:
volume (Lsm.Volume)
The lsm.Volume instance.
flags (int, optional):
Reserved for future use. Should be set as lsm.Client.FLAG_RSVD
Returns:
[int, int, int, int, int]
write_cache_policy (int)
The write cache policy. Valid values are:
* lsm.Volume.WRITE_CACHE_POLICY_WRITE_BACK
The storage system will use write back mode if cache
hardware found.
* lsm.Volume.WRITE_CACHE_POLICY_AUTO
The controller will use write back mode when
battery/capacitor is in good health, otherwise,
write through mode.
* lsm.Volume.WRITE_CACHE_POLICY_WRITE_THROUGH
The storage system will use write through mode.
* lsm.Volume.WRITE_CACHE_POLICY_UNKNOWN
Plugin failed to detect this setting.
write_cache_status (int)
The status of write cache. Valid values are:
* lsm.Volume.WRITE_CACHE_STATUS_WRITE_THROUGH
* lsm.Volume.WRITE_CACHE_STATUS_WRITE_BACK
* lsm.Volume.WRITE_CACHE_STATUS_UNKNOWN
read_cache_policy (int)
The policy for read cache. Valid values are:
* lsm.Volume.READ_CACHE_POLICY_ENABLED
Read cache is enabled, when reading I/O on previous
unchanged written I/O or read I/O in cache will be
returned to I/O initiator immediately without checking
backing store(normally disk).
* lsm.Volume.READ_CACHE_POLICY_DISABLED
Read cache is disabled.
* lsm.Volume.READ_CACHE_POLICY_UNKNOWN
Plugin failed to detect the read cache policy.
read_cache_status (int)
The status of read cache. Valid values are:
* lsm.Volume.READ_CACHE_STATUS_ENABLED
* lsm.Volume.READ_CACHE_STATUS_DISABLED
* lsm.Volume.READ_CACHE_STATUS_UNKNOWN
physical_disk_cache (int)
Whether physical disk's cache is enabled or not.
Please be advised, HDD's physical disk ram cache might be not
protected by storage system's battery or capacitor on sudden
power loss, you could lose data if a power failure occurs
during a write process.
For SSD's physical disk cache, please check with the vendor of
your hardware RAID card and SSD disk.
Valid values are:
* lsm.Volume.PHYSICAL_DISK_CACHE_ENABLED
Physical disk cache enabled.
* lsm.Volume.PHYSICAL_DISK_CACHE_DISABLED
Physical disk cache disabled.
* lsm.Volume.PHYSICAL_DISK_CACHE_USE_DISK_SETTING
Physical disk cache is determined by the disk vendor
via physical disks' SCSI caching mode page(0x08 page).
It is strongly suggested to change this value to
lsm.Volume.PHYSICAL_DISK_CACHE_ENABLED or
lsm.Volume.PHYSICAL_DISK_CACHE_DISABLED
* lsm.Volume.PHYSICAL_DISK_CACHE_UNKNOWN
Plugin failed to detect the physical disk status.
SpecialExceptions:
LsmError
ErrorNumber.NO_SUPPORT
ErrorNumber.NOT_FOUND_VOLUME
Capability:
lsm.Capabilities.VOLUME_CACHE_INFO
"""
return self._tp.rpc('volume_cache_info', _del_self(locals()))
@_return_requires(None)
def volume_physical_disk_cache_update(self, volume, pdc, flags=FLAG_RSVD):
"""
lsm.Client.volume_physical_disk_cache_update(self, volume, pdc,
flags=lsm.Client.FLAG_RSVD)
Version:
1.3
Usage:
Change the setting of RAM physical disk cache of specified volume.
On some product(like HPE SmartArray), this action will be effective
at system level which means that even you are requesting a change
on a specified volume, this change will apply to all other volumes
on the same controller(system).
Parameters:
volume (Lsm.Volume)
The lsm.Volume instance.
pdc (int)
lsm.Volume.PHYSICAL_DISK_CACHE_ENABLED
Enable physical disk cache.
lsm.Volume.PHYSICAL_DISK_CACHE_DISABLED
Disable physical disk cache
flags (int, optional):
Reserved for future use. Should be set as lsm.Client.FLAG_RSVD
Returns:
N/A
SpecialExceptions:
LsmError
ErrorNumber.NO_SUPPORT
You might also get NO_SUPPORT error when trying
to change SSD physical disk cache on MegaRAID.
ErrorNumber.NOT_FOUND_VOLUME
Capability:
lsm.Capabilities.VOLUME_PHYSICAL_DISK_CACHE_SET
Allow changing physical disk cache.
lsm.Capabilities.VOLUME_PHYSICAL_DISK_CACHE_SET_SYSTEM_LEVEL
Indicate that this action will change system settings which
are effective on all volumes in this storage system.
For example, on HPE SmartArray, the physical disk cache
setting is a controller level setting.
"""
if (pdc != Volume.PHYSICAL_DISK_CACHE_ENABLED) and \
(pdc != Volume.PHYSICAL_DISK_CACHE_DISABLED):
raise LsmError(ErrorNumber.INVALID_ARGUMENT,
"Argument pdc should be "
"Volume.PHYSICAL_DISK_CACHE_ENABLED or "
"Volume.PHYSICAL_DISK_CACHE_DISABLED")
return self._tp.rpc('volume_physical_disk_cache_update',
_del_self(locals()))
@_return_requires(None)
def volume_write_cache_policy_update(self, volume, wcp, flags=FLAG_RSVD):
"""
lsm.Client.volume_write_cache_policy_update(self, volume, wcp,
flags=lsm.Client.FLAG_RSVD)
Version:
1.3
Usage:
Change the RAM write cache policy on specified volume.
If lsm.Capabilities.VOLUME_WRITE_CACHE_POLICY_SET_IMPACT_READ
is supported(e.g. HPE SmartArray), the changes on write cache
policy might also impact read cache policy.
If lsm.Capabilities.VOLUME_WRITE_CACHE_POLICY_SET_WB_IMPACT_OTHER
is supported(e.g. HPE SmartArray), changing write cache policy
to write back mode might impact other volumes in the same system.
Parameters:
volume (Lsm.Volume)
The lsm.Volume instance.
wcp (int)
Could be one of these value:
* lsm.Volume.WRITE_CACHE_POLICY_WRITE_BACK
Change to write back mode.
* lsm.Volume.WRITE_CACHE_POLICY_AUTO
Change to auto mode: use write back mode when
battery/capacitor is healthy, otherwise use write
through.
* lsm.Volume.WRITE_CACHE_POLICY_WRITE_THROUGH
Change to write through mode.
flags (int, optional):
Reserved for future use. Should be set as lsm.Client.FLAG_RSVD
Returns:
N/A
SpecialExceptions:
LsmError
ErrorNumber.NO_SUPPORT
ErrorNumber.NOT_FOUND_VOLUME
Capability:
lsm.Capabilities.VOLUME_WRITE_CACHE_POLICY_SET_WRITE_BACK
Allow changing to always mode.
lsm.Capabilities.VOLUME_WRITE_CACHE_POLICY_SET_AUTO
Allow changing to auto mode.
lsm.Capabilities.VOLUME_WRITE_CACHE_POLICY_SET_WRITE_THROUGH
Allow changing to disable mode.
lsm.Capabilities.VOLUME_WRITE_CACHE_POLICY_SET_IMPACT_READ
Indicate this action might impact read cache policy.
lsm.Capabilities.VOLUME_WRITE_CACHE_POLICY_SET_WB_IMPACT_OTHER
Indicate that changing to write back mode might impact other
volumes. For example, on HPE SmartArray, changing to write back
mode will change all other volumes with auto write cache policy
to write back mode.
"""
if wcp != Volume.WRITE_CACHE_POLICY_WRITE_BACK and \
wcp != Volume.WRITE_CACHE_POLICY_AUTO and \
wcp != Volume.WRITE_CACHE_POLICY_WRITE_THROUGH:
raise LsmError(ErrorNumber.INVALID_ARGUMENT,
"Argument wcp should be "
"Volume.WRITE_CACHE_POLICY_WRITE_BACK or "
"Volume.WRITE_CACHE_POLICY_AUTO or "
"Volume.WRITE_CACHE_POLICY_WRITE_THROUGH")
return self._tp.rpc('volume_write_cache_policy_update',
_del_self(locals()))
@_return_requires(None)
def volume_read_cache_policy_update(self, volume, rcp, flags=FLAG_RSVD):
"""
lsm.Client.volume_read_cache_policy_update(self, volume, rcp,
flags=lsm.Client.FLAG_RSVD)
Version:
1.3
Usage:
Change the RAM read cache policy of specified volume.
If lsm.Capabilities.VOLUME_READ_CACHE_POLICY_SET_IMPACT_WRITE
is supported(like HPE SmartArray), the change on write cache policy
might also impact read cache policy.
Parameters:
volume (Lsm.Volume)
The lsm.Volume instance.
rcp (int)
Could be one of these value:
* lsm.Volume.READ_CACHE_POLICY_ENABLED
Enable read cache.
* lsm.Volume.READ_CACHE_POLICY_DISABLED
Disable read cache.
flags (int, optional):
Reserved for future use. Should be set as lsm.Client.FLAG_RSVD
Returns:
N/A
SpecialExceptions:
LsmError
ErrorNumber.NO_SUPPORT
ErrorNumber.NOT_FOUND_VOLUME
Capability:
lsm.Capabilities.VOLUME_READ_CACHE_POLICY_SET
Allow enabling or disabling read cache policy.
lsm.Capabilities.VOLUME_READ_CACHE_POLICY_SET_IMPACT_WRITE
Indicate that changing read cache policy might impact write
cache policy. For example, on HPE SmartArray, disabling read
cache will also change write cache policy to write through.
"""
if rcp != Volume.READ_CACHE_POLICY_ENABLED and \
rcp != Volume.READ_CACHE_POLICY_DISABLED:
raise LsmError(ErrorNumber.INVALID_ARGUMENT,
"Argument rcp should be "
"Volume.READ_CACHE_POLICY_ENABLED or "
"Volume.READ_CACHE_POLICY_DISABLED")
return self._tp.rpc('volume_read_cache_policy_update',
_del_self(locals()))
__init__.pyc 0000644 00000002356 14757650541 0007044 0 ustar 00
-P`c @ s d d l m Z d d l m Z m Z m Z m Z m Z m Z m Z m
Z
m Z m Z m
Z
m Z d d l m Z d d l m Z m Z m Z m Z m Z m Z m Z m Z m Z m Z m Z m Z d d l m Z m Z m! Z! m" Z" d d l# m$ Z$ d d l% m& Z& m' Z' g Z( d S( i( t VERSION( t errort infot LsmErrort ErrorNumbert JobStatust uri_parset md5t Proxyt size_bytes_2_size_humant common_urllib2_error_handlert size_human_2_size_bytest int_div( t LocalDisk( t Diskt Volumet Poolt Systemt
FileSystemt
FsSnapshott NfsExportt
BlockRanget AccessGroupt
TargetPortt Capabilitiest Battery( t IPlugint IStorageAreaNetworkt INetworkAttachedStoraget INfs( t Client( t PluginRunnert search_propertyN() t lsm.versionR t lsm._commonR R R R R R R R R R
R R t lsm._local_diskR
t lsm._dataR R R R R R R R R R R R t lsm._ipluginR R R R t lsm._clientR t lsm._pluginrunnerR R t __all__( ( ( s0 /usr/lib/python2.7/site-packages/lsm/__init__.pyt s RR" external/__init__.py 0000644 00000000000 14757650541 0010503 0 ustar 00 external/__init__.pyc 0000644 00000000220 14757650541 0010652 0 ustar 00
-P`c @ s d S( N( ( ( ( s9 /usr/lib/python2.7/site-packages/lsm/external/__init__.pyt s external/xmltodict.py 0000644 00000010566 14757650541 0010775 0 ustar 00 # This code taken from recipe
# http://code.activestate.com/recipes/
# 573463-converting-xml-to-dictionary-and-back/
# Modified slightly to remove namespace and number of other small details
# Licensed: PSF
from xml.etree import ElementTree
def _ns(tag):
return tag[tag.find('}') + 1:]
class XmlDictObject(dict):
"""
Adds object like functionality to the standard dictionary.
"""
def __init__(self, initdict=None):
if initdict is None:
initdict = {}
dict.__init__(self, initdict)
def __getattr__(self, item):
return self.__getitem__(item)
def __setattr__(self, item, value):
self.__setitem__(item, value)
def __str__(self):
if '_text' in self:
return self.__getitem__('_text')
else:
return ''
@staticmethod
def wrap(x):
"""
Static method to wrap a dictionary recursively as an XmlDictObject
"""
if isinstance(x, dict):
return XmlDictObject(
(k, XmlDictObject.wrap(v)) for (k, v) in x.items())
elif isinstance(x, list):
return [XmlDictObject.wrap(v) for v in x]
else:
return x
@staticmethod
def _un_wrap(x):
if isinstance(x, dict):
return dict(
(k, XmlDictObject._un_wrap(v)) for (k, v) in x.items())
elif isinstance(x, list):
return [XmlDictObject._un_wrap(v) for v in x]
else:
return x
def un_wrap(self):
"""
Recursively converts an XmlDictObject to a standard dictionary and
returns the result.
"""
return XmlDictObject._un_wrap(self)
def _convert_dict_to_xml_recurse(parent, dictitem):
assert isinstance(dictitem, dict)
if isinstance(dictitem, dict):
for (tag, child) in dictitem.items():
if str(tag) == '_text':
parent.text = str(child)
elif isinstance(child, list):
# iterate through the array and convert
for listchild in child:
elem = ElementTree.Element(tag)
parent.append(elem)
_convert_dict_to_xml_recurse(elem, listchild)
else:
elem = ElementTree.Element(tag)
parent.append(elem)
_convert_dict_to_xml_recurse(elem, child)
else:
parent.text = str(dictitem)
def convert_dict_to_xml(xmldict):
"""
Converts a dictionary to an XML ElementTree Element
"""
roottag = list(xmldict.keys())[0]
root = ElementTree.Element(roottag)
_convert_dict_to_xml_recurse(root, xmldict[roottag])
return root
def _convert_xml_to_dict_recurse(node, dictclass):
nodedict = dictclass()
if len(list(node.items())) > 0:
# if we have attributes, set them
if'attrib' in nodedict:
nodedict['attrib'].update(dict(list(node.items())))
else:
nodedict['attrib'] = {}
nodedict['attrib'].update(dict(list(node.items())))
# We get a collision so attributes get their own hash!
# nodedict.update(dict(node.items()))
for child in node:
# recursively add the element's children
newitem = _convert_xml_to_dict_recurse(child, dictclass)
if _ns(child.tag) in nodedict:
# found duplicate tag, force a list
if isinstance(nodedict[_ns(child.tag)], list):
# append to existing list
nodedict[_ns(child.tag)].append(newitem)
else:
# convert to list
nodedict[_ns(child.tag)] = [nodedict[_ns(child.tag)], newitem]
else:
# only one, directly set the dictionary
nodedict[_ns(child.tag)] = newitem
if node.text is None:
text = None
else:
text = node.text.strip()
if len(nodedict) > 0:
# if we have a dictionary add the text as a dictionary value
# (if there is any)
if text is not None and len(text) > 0:
nodedict['_text'] = text
else:
# if we don't have child nodes or attributes, just set the text
nodedict = text
return nodedict
def convert_xml_to_dict(root, dictclass=XmlDictObject):
"""
Converts an ElementTree Element to a dictionary
"""
return dictclass(
{_ns(root.tag): _convert_xml_to_dict_recurse(root, dictclass)})
external/xmltodict.pyc 0000644 00000011653 14757650541 0011136 0 ustar 00
-P`c @ sZ d d l m Z d Z d e f d YZ d Z d Z d Z e d Z d S(
i( t ElementTreec C s | | j d d S( Nt }i ( t find( t tag( ( s: /usr/lib/python2.7/site-packages/lsm/external/xmltodict.pyt _ns
s t
XmlDictObjectc B s\ e Z d Z d d Z d Z d Z d Z e d Z e d Z
d Z RS( sD
Adds object like functionality to the standard dictionary.
c C s) | d k r i } n t j | | d S( N( t Nonet dictt __init__( t selft initdict( ( s: /usr/lib/python2.7/site-packages/lsm/external/xmltodict.pyR s c C s
| j | S( N( t __getitem__( R t item( ( s: /usr/lib/python2.7/site-packages/lsm/external/xmltodict.pyt __getattr__ s c C s | j | | d S( N( t __setitem__( R R t value( ( s: /usr/lib/python2.7/site-packages/lsm/external/xmltodict.pyt __setattr__ s c C s! d | k r | j d Sd Sd S( Nt _textt ( R ( R ( ( s: /usr/lib/python2.7/site-packages/lsm/external/xmltodict.pyt __str__ s
c C s` t | t r) t d | j D St | t rX g | D] } t j | ^ q? S| Sd S( sT
Static method to wrap a dictionary recursively as an XmlDictObject
c s s* | ] \ } } | t j | f Vq d S( N( R t wrap( t .0t kt v( ( s: /usr/lib/python2.7/site-packages/lsm/external/xmltodict.pys * s N( t
isinstanceR R t itemst listR ( t xR ( ( s: /usr/lib/python2.7/site-packages/lsm/external/xmltodict.pyR # s c C s` t | t r) t d | j D St | t rX g | D] } t j | ^ q? S| Sd S( Nc s s* | ] \ } } | t j | f Vq d S( N( R t _un_wrap( R R R ( ( s: /usr/lib/python2.7/site-packages/lsm/external/xmltodict.pys 4 s ( R R R R R R ( R R ( ( s: /usr/lib/python2.7/site-packages/lsm/external/xmltodict.pyR 0 s c C s
t j | S( sp
Recursively converts an XmlDictObject to a standard dictionary and
returns the result.
( R R ( R ( ( s: /usr/lib/python2.7/site-packages/lsm/external/xmltodict.pyt un_wrap: s N( t __name__t
__module__t __doc__R R R
R R t staticmethodR R R ( ( ( s: /usr/lib/python2.7/site-packages/lsm/external/xmltodict.pyR s
c C s t | t s t t | t r x | j D] \ } } t | d k ra t | | _ q1 t | t r xc | D]/ } t j | } | j | t
| | qw Wq1 t j | } | j | t
| | q1 Wn t | | _ d S( NR ( R R t AssertionErrorR t strt textR R t Elementt appendt _convert_dict_to_xml_recurse( t parentt dictitemR t childt listchildt elem( ( s: /usr/lib/python2.7/site-packages/lsm/external/xmltodict.pyR' B s
c C s: t | j d } t j | } t | | | | S( s=
Converts a dictionary to an XML ElementTree Element
i ( R t keysR R% R' ( t xmldictt roottagt root( ( s: /usr/lib/python2.7/site-packages/lsm/external/xmltodict.pyt convert_dict_to_xmlW s c C s | } t t | j d k r d | k rY | d j t t | j q i | d <| d j t t | j n x | D] } t | | } t | j | k r t | t | j t r | t | j j | q/| t | j | g | t | j s 4
- external/__init__.pyo 0000644 00000000220 14757650541 0010666 0 ustar 00
-P`c @ s d S( N( ( ( ( s9 /usr/lib/python2.7/site-packages/lsm/external/__init__.pyt s external/xmltodict.pyo 0000644 00000011601 14757650541 0011143 0 ustar 00
-P`c @ sZ d d l m Z d Z d e f d YZ d Z d Z d Z e d Z d S(
i( t ElementTreec C s | | j d d S( Nt }i ( t find( t tag( ( s: /usr/lib/python2.7/site-packages/lsm/external/xmltodict.pyt _ns
s t
XmlDictObjectc B s\ e Z d Z d d Z d Z d Z d Z e d Z e d Z
d Z RS( sD
Adds object like functionality to the standard dictionary.
c C s) | d k r i } n t j | | d S( N( t Nonet dictt __init__( t selft initdict( ( s: /usr/lib/python2.7/site-packages/lsm/external/xmltodict.pyR s c C s
| j | S( N( t __getitem__( R t item( ( s: /usr/lib/python2.7/site-packages/lsm/external/xmltodict.pyt __getattr__ s c C s | j | | d S( N( t __setitem__( R R t value( ( s: /usr/lib/python2.7/site-packages/lsm/external/xmltodict.pyt __setattr__ s c C s! d | k r | j d Sd Sd S( Nt _textt ( R ( R ( ( s: /usr/lib/python2.7/site-packages/lsm/external/xmltodict.pyt __str__ s
c C s` t | t r) t d | j D St | t rX g | D] } t j | ^ q? S| Sd S( sT
Static method to wrap a dictionary recursively as an XmlDictObject
c s s* | ] \ } } | t j | f Vq d S( N( R t wrap( t .0t kt v( ( s: /usr/lib/python2.7/site-packages/lsm/external/xmltodict.pys * s N( t
isinstanceR R t itemst listR ( t xR ( ( s: /usr/lib/python2.7/site-packages/lsm/external/xmltodict.pyR # s c C s` t | t r) t d | j D St | t rX g | D] } t j | ^ q? S| Sd S( Nc s s* | ] \ } } | t j | f Vq d S( N( R t _un_wrap( R R R ( ( s: /usr/lib/python2.7/site-packages/lsm/external/xmltodict.pys 4 s ( R R R R R R ( R R ( ( s: /usr/lib/python2.7/site-packages/lsm/external/xmltodict.pyR 0 s c C s
t j | S( sp
Recursively converts an XmlDictObject to a standard dictionary and
returns the result.
( R R ( R ( ( s: /usr/lib/python2.7/site-packages/lsm/external/xmltodict.pyt un_wrap: s N( t __name__t
__module__t __doc__R R R
R R t staticmethodR R R ( ( ( s: /usr/lib/python2.7/site-packages/lsm/external/xmltodict.pyR s
c C s t | t r x | j D] \ } } t | d k rL t | | _ q t | t r xc | D]/ } t j | } | j | t | | qb Wq t j | } | j | t | | q Wn t | | _ d S( NR (
R R R t strt textR R t Elementt appendt _convert_dict_to_xml_recurse( t parentt dictitemR t childt listchildt elem( ( s: /usr/lib/python2.7/site-packages/lsm/external/xmltodict.pyR& B s
c C s: t | j d } t j | } t | | | | S( s=
Converts a dictionary to an XML ElementTree Element
i ( R t keysR R$ R& ( t xmldictt roottagt root( ( s: /usr/lib/python2.7/site-packages/lsm/external/xmltodict.pyt convert_dict_to_xmlW s c C s | } t t | j d k r d | k rY | d j t t | j q i | d <| d j t t | j n x | D] } t | | } t | j | k r t | t | j t r | t | j j | q/| t | j | g | t | j s 4
- _data.pyo 0000644 00000103375 14757650541 0006374 0 ustar 00
-P`c @ s d d l m Z d d l Z d d l Z d d l m Z y d d l Z Wn e k
rg d d l Z n Xd d l
m Z d d l m
Z
m Z m Z m Z d d l Z d e j f d YZ d e j f d YZ d
e e e f d YZ e d d
d e d d
d e d d
d e d d
d e d d
d e d d
d e d d
d e d d
d d e f d Y Z e j d Z e d d
d e d d
d e d! d
d" e d d
d# e d d
d$ e d% d
d& e d d
d e d' d
d( e d d
d d) e f d* Y Z e d d
d e d d
d+ e d d
d, e d- d
d. e d d
d d/ e f d0 Y Z e d d
d e d d
d1 e d2 d
d3 e d4 d
d5 e d d
d e d- d
d6 e d d
d e d d
d7 e d8 d
d9 e d: d
d; d< e f d= Y Z e d d
d e d d
d> e d2 d
d3 e d4 d
d? e d' d
d@ e d d
dA e d d
d dB e f dC Y Z e d d
d e d d
dD e dE d
dF e d d
d dG e f dH Y Z e d d
d e dI d
dJ e dK d
dL e dM d
dN e dO d
dP e dQ d
dR e dS d
dT e dU d
dV e dW d
dX e dY d
dZ e d d
d[ d\ e f d] Y Z e d^ d
d_ e d` d
da e db d
d$ dc e f dd Y Z e d d
de e d d
df e dg d
dh e di d
dj e d d
d e d d
d[ dk e f dl Y Z! e d d
de e dm d
dn e do d
dp e dq d
dr e ds d
dt e du d
dv e d d
d e d d
d[ dw e f dx Y Z" dy e f dz YZ# e d d
d e d d
d e d{ d
d| e d d
d} e d d
d e d d
d d~ e f d Y Z$ e% d k rn d S( i( t ABCMetaN( t with_metaclass( t
WHITESPACE( t get_classt default_propertyt ErrorNumbert LsmErrort DataEncoderc B s e Z d Z d Z RS( s?
Custom json encoder for objects derived form ILsmData
c C s< t | t s. t d t t | n
| j Sd S( Ns incorrect class type:( t
isinstancet IDatat
ValueErrort strt typet _to_dict( t selft my_class( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyt default* s ( t __name__t
__module__t __doc__R ( ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyR % s t DataDecoderc B sJ e Z d Z e d Z e d Z e d Z e j d Z RS( s?
Custom json decoder for objects derived from ILsmData
c C sX i } d | k r$ t j | } n0 x- | j D] \ } } t j | | | t j | S| Sd S( s)
Decodes the parsed json
N( R R" R R# R R! ( t e( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyt __decodeT s
c C s t j t j | S( N( R R t jsont loads( R t json_stringt _w( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyt decode` s (
R R R t staticmethodR# R! R R t matchR. ( ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyR 1 s
R c B s/ e Z d Z d Z e d Z d Z RS( s?
Base class functionality of serializable
classes.
c C sq i | j j d 6} xW t | j j D]@ \ } } t | t r[ | j | | d ( R ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyt
size_bytes s c C s+ | j d k r$ t t j d n | j S( s
String. SCSI VPD83 ID. New in version 1.3.
Only available for DAS(direct attached storage) systems.
The VPD83 ID could be used in 'lsm.SCSI.disk_paths_of_vpd83()'
when physical disk is exposed to OS directly.
RC s5 Disk.vpd83 is not supported by current disk or plugin( RO R R t
NO_SUPPORT( R ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyt vpd83 s
c C s+ | j d k r$ t t j d n | j S( sP
String. Disk location in storage topology. New in version 1.3.
RC s: Disk.location property is not supported by this plugin yet( RP R R RU ( R ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyt location& s c C s. | j t j k r' t t j d n | j S( s
Integer. New in version 1.3.
Disk rotation speed - revolutions per minute(RPM):
-1 (LSM_DISK_RPM_UNKNOWN):
Unknown RPM
0 (LSM_DISK_RPM_NON_ROTATING_MEDIUM):
Non-rotating medium (e.g., SSD)
1 (LSM_DISK_RPM_ROTATING_UNKNOWN_SPEED):
Rotational disk with unknown speed
>1:
Normal rotational disk (e.g., HDD)
s, Disk.rpm is not supported by this plugin yet( RQ RB t RPM_NO_SUPPORTR R RU ( R ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyt rpm1 s c C s. | j t j k r' t t j d n | j S( s
Integer. New in version 1.3.
Link type, possible values are:
lsm.Disk.LINK_TYPE_UNKNOWN
Failed to detect link type
lsm.Disk.LINK_TYPE_FC
Fibre Channel
lsm.Disk.LINK_TYPE_SSA
Serial Storage Architecture, Old IBM tech.
lsm.Disk.LINK_TYPE_SBP
Serial Bus Protocol, used by IEEE 1394.
lsm.Disk.LINK_TYPE_SRP
SCSI RDMA Protocol
lsm.Disk.LINK_TYPE_ISCSI
Internet Small Computer System Interface
lsm.Disk.LINK_TYPE_SAS
Serial Attached SCSI
lsm.Disk.LINK_TYPE_ADT
Automation/Drive Interface Transport
Protocol, often used by Tape.
lsm.Disk.LINK_TYPE_ATA
PATA/IDE or SATA.
lsm.Disk.LINK_TYPE_USB
USB disk.
lsm.Disk.LINK_TYPE_SOP
SCSI over PCI-E
lsm.Disk.LINK_TYPE_PCIE
PCI-E, e.g. NVMe
s2 Disk.link_type is not supported by this plugin yet( RR RB t LINK_TYPE_NO_SUPPORTR R RU ( R ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyt link_typeD s c C s | j S( N( R; ( R ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyR8 i s i i i i i i i@ i i i i i i i i i i i i i i@ N(G R R R t SUPPORTED_SEARCH_KEYSt BLOCK_COUNT_NOT_FOUNDt BLOCK_SIZE_NOT_FOUNDt TYPE_UNKNOWNt
TYPE_OTHERt TYPE_ATAt TYPE_SATAt TYPE_SASt TYPE_FCt TYPE_SOPt TYPE_SCSIt TYPE_LUNt TYPE_NL_SASt TYPE_HDDt TYPE_SSDt TYPE_HYBRIDt STATUS_UNKNOWNt STATUS_OKt STATUS_OTHERt STATUS_PREDICTIVE_FAILUREt STATUS_ERRORt STATUS_REMOVEDt STATUS_STARTINGt STATUS_STOPPINGt STATUS_STOPPEDt STATUS_INITIALIZINGt STATUS_MAINTENANCE_MODEt STATUS_SPARE_DISKt STATUS_RECONSTRUCTt STATUS_FREERX t RPM_UNKNOWNt RPM_NON_ROTATING_MEDIUMt RPM_ROTATING_UNKNOWN_SPEEDRZ t LINK_TYPE_UNKNOWNt LINK_TYPE_FCt
LINK_TYPE_SSAt
LINK_TYPE_SBPt
LINK_TYPE_SRPt LINK_TYPE_ISCSIt
LINK_TYPE_SASt
LINK_TYPE_ADTt
LINK_TYPE_ATAt
LINK_TYPE_USBt
LINK_TYPE_SOPt LINK_TYPE_PCIEt LED_STATUS_UNKNOWNt LED_STATUS_IDENT_ONt LED_STATUS_IDENT_OFFt LED_STATUS_IDENT_UNKNOWNt LED_STATUS_FAULT_ONt LED_STATUS_FAULT_OFFt LED_STATUS_FAULT_UNKNOWNt LINK_SPEED_UNKNOWNt HEALTH_STATUS_UNKNOWNt HEALTH_STATUS_FAILt HEALTH_STATUS_WARNt HEALTH_STATUS_GOODt NoneRS t propertyRT RV RW RY R[ R8 ( ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyRB s %s* (?:^6[0-9a-f]{31})|(?:^[235][0-9a-f]{15})$s User given nameRV s" Vital product page 0x83 identifiers Volume block sizes Number of blockst admin_states$ Enabled or disabled by administratort pool_ids Pool identifierRL c B s| e Z d Z d d d g Z d Z d Z d Z d Z d Z d Z d Z
d Z d Z d
Z
d Z d Z d
Z d Z d Z d Z d Z d Z d Z d
Z d Z d Z d Z d Z d Z d Z d Z d Z d
Z d
Z! d
Z" d
Z# d
Z$ d Z% d Z& d Z' d Z( d Z) d Z* d Z+ d Z, d Z- d Z. d Z/ d Z0 d Z1 d Z2 d Z3 d Z4 d Z5 d d Z7 e8 d Z9 d Z: e; d Z< RS( s
Represents a volume.
R9 R@ R ii i i i i i i i
i i i2 i< i3 i= i i i c
C s | | _ | | _ | rA t j | rA t t j d | n | | _ | | _ | | _ | | _
| | _ | | _ | | _
d S( Ns^ Incorrect format of VPD 0x83 NAA(3) string: '%s', expecting 32 or 16 lower case hex characters( RD RE RL RM R R RN RO RG RH t _admin_stateRJ t _pool_idRK (
R RD RE RO RG RH R RJ R RK ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyRS s
c C s | j | j S( s'
Volume size in bytes.
( R= R> ( R ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyRT s c C s | j S( N( R; ( R ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyR8 s c C s | r t j | r t St S( sI
Returns True if string is valid vpd 0x83 representation
( t _vol_regex_vpd83R0 t Truet False( t vpd( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyRM s N(= R R R R\ t REPLICATE_UNKNOWNt REPLICATE_CLONEt REPLICATE_COPYt REPLICATE_MIRROR_SYNCt REPLICATE_MIRROR_ASYNCt PROVISION_UNKNOWNt PROVISION_THINt PROVISION_FULLt PROVISION_DEFAULTt ADMIN_STATE_DISABLEDt ADMIN_STATE_ENABLEDt RAID_TYPE_UNKNOWNt RAID_TYPE_RAID0t RAID_TYPE_RAID1t RAID_TYPE_RAID3t RAID_TYPE_RAID4t RAID_TYPE_RAID5t RAID_TYPE_RAID6t RAID_TYPE_RAID10t RAID_TYPE_RAID15t RAID_TYPE_RAID16t RAID_TYPE_RAID50t RAID_TYPE_RAID60t RAID_TYPE_RAID51t RAID_TYPE_RAID61t RAID_TYPE_JBODt RAID_TYPE_MIXEDt RAID_TYPE_OTHERt STRIP_SIZE_UNKNOWNt DISK_COUNT_UNKNOWNt MIN_IO_SIZE_UNKNOWNt OPT_IO_SIZE_UNKNOWNt VCR_STRIP_SIZE_DEFAULTt WRITE_CACHE_POLICY_UNKNOWNt WRITE_CACHE_POLICY_WRITE_BACKt WRITE_CACHE_POLICY_AUTOt WRITE_CACHE_POLICY_WRITE_THROUGHt WRITE_CACHE_STATUS_UNKNOWNt WRITE_CACHE_STATUS_WRITE_BACKt WRITE_CACHE_STATUS_WRITE_THROUGHt READ_CACHE_POLICY_UNKNOWNt READ_CACHE_POLICY_ENABLEDt READ_CACHE_POLICY_DISABLEDt READ_CACHE_STATUS_UNKNOWNt READ_CACHE_STATUS_ENABLEDt READ_CACHE_STATUS_DISABLEDt PHYSICAL_DISK_CACHE_UNKNOWNt PHYSICAL_DISK_CACHE_ENABLEDt PHYSICAL_DISK_CACHE_DISABLEDt$ PHYSICAL_DISK_CACHE_USE_DISK_SETTINGR RS R RT R8 R/ RM ( ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyRL r sp s User defined system names Enumerated status of systemt status_infos# Detail status information of systemt Systemc B s e Z d
Z d Z d Z d Z d Z d Z d Z d Z d Z
d Z d Z d Z
d d d d d Z e d
Z e d Z e d Z RS( i i i i i i iiRC c C s | | _ | | _ | | _ | | _ | | _ | | _ | d k rQ t j | _ n | | _ | d k ru t j
| _ n | | _ d S( N( RD RE RI t _status_infoRK t _fw_versionR R t READ_CACHE_PCT_NO_SUPPORTt _read_cache_pctt MODE_NO_SUPPORTt _mode( R RD RE RI R RK R R R ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyRS s c C s+ | j d k r$ t t j d n | j S( s
String. Firmware version string. New in version 1.3.
On some system, it might contain multiple version strings, example:
"Package: 23.32.0-0009, FW: 3.440.05-3712"
RC s7 System.fw_version() is not supported by this plugin yet( R R R RU ( R ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyt
fw_version s c C s. | j t j k r' t t j d n | j S( sQ
Integer(enumerated value). System mode. New in version 1.3.
Only available for HW RAID systems at this time.
Possible values:
* lsm.System.MODE_HARDWARE_RAID
The logical volume(aka, RAIDed virtual disk) can be exposed
to OS while hardware RAID card is handling the RAID
algorithm. Physical disk can not be exposed to OS directly.
* lsm.System.MODE_HBA
The physical disks can be exposed to OS directly.
SCSI enclosure service might be exposed to OS also.
s/ System.mode is not supported by this plugin yet( R R R R R RU ( R ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyt mode) s c C s. | j t j k r' t t j d n | j S( s
Integer. Read cache percentage. New in version 1.3.
Possible values:
* 0-100
The read cache percentage. The write cache percentage will
then be 100 - read_cache_pct
s9 System.read_cache_pct is not supported by this plugin yet( R R R R R RU ( R ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyt read_cache_pct= s i i i i i i N( R R Rl Rm Rp t STATUS_DEGRADEDRo Rn R t MODE_UNKNOWNt MODE_HARDWARE_RAIDt MODE_HBAR t READ_CACHE_PCT_UNKNOWNR RS R R R R ( ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyR s"
s User supplied namet total_spaces Total space in bytest
free_spaces Free space in bytess Text explaining statuss Plug-in private datat element_types What pool can be used fort unsupported_actionss" What cannot be done with this poolt Poolc B s e Z d Z d d g Z d Z d Z d Z d Z d Z d Z d Z
d Z d Z d Z
d Z d Z d Z d Z d Z d Z d Z d! Z d" Z d# Z d$ Z d Z d Z d Z d Z d% d Z RS(& s#
Pool specific information
R9 R@ ii i i i i i i
i i i i
i i c C s^ | | _ | | _ | | _ | | _ | | _ | | _ | | _ | | _ | | _ |
| _ d S( N(
RD RE t
_element_typet _unsupported_actionst _total_spacet _free_spaceRI R RJ RK ( R RD RE R R R R RI R RJ RK ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyRS s i i i i i i@ i i i i i i i i i i i i @ i N( R R R R\ t TOTAL_SPACE_NOT_FOUNDt FREE_SPACE_NOT_FOUNDt ELEMENT_TYPE_POOLt ELEMENT_TYPE_VOLUMEt ELEMENT_TYPE_FSt ELEMENT_TYPE_DELTAt ELEMENT_TYPE_VOLUME_FULLt ELEMENT_TYPE_VOLUME_THINt ELEMENT_TYPE_SYS_RESERVEDt UNSUPPORTED_VOLUME_GROWt UNSUPPORTED_VOLUME_SHRINKRl Rm Rn R Rp Rt t STATUS_RECONSTRUCTINGt STATUS_VERIFYINGRu t STATUS_GROWINGt MEMBER_TYPE_UNKNOWNt MEMBER_TYPE_OTHERt MEMBER_TYPE_DISKt MEMBER_TYPE_POOLR RS ( ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyR M s8 s File system names Free space availables$ What pool the file system resides ons System IDt
FileSystemc B s# e Z d d d g Z d d Z RS( R9 R@ R c C sC | | _ | | _ | | _ | | _ | | _ | | _ | | _ d S( N( RD RE R R R RJ RK ( R RD RE R R R RJ RK ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyRS s N( R R R\ R RS ( ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyR s s
Snapshot namet tss# Time stamp the snapshot was createdt
FsSnapshotc B s e Z d d Z RS( c C s. | | _ | | _ t | | _ | | _ d S( N( RD RE t intt _tsRK ( R RD RE R RK ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyRS s N( R R R RS ( ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyR s t fs_ids Filesystem that is exportedt export_paths Export patht auths Authentication typet roots! List of hosts with no_root_squasht rws* List of hosts with Read & Write privilegest ros' List of hosts with Read only privilegest anonuids UID for anonymous user idt anongids GID for anonymous group idt optionss" String containing advanced optionss Plugin private datat NfsExportc B s, e Z d d g Z d Z d Z d d Z RS( R9 R iic C sg | | _ | | _ | | _ | | _ | | _ | | _ | | _ | | _ | | _ |
| _ | | _
d S( N( RD t _fs_idt _export_patht _autht _roott _rwt _rot _anonuidt _anongidt _optionsRK ( R RD R R R
R R R R R R RK ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyRS s N( R R R\ t ANON_UID_GID_NAt ANON_UID_GID_ERRORR RS ( ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyR
s t src_blocks Source logical block addresst
dest_blocks! Destination logical block addresst block_countt
BlockRangec B s e Z d Z RS( c C s | | _ | | _ | | _ d S( N( t
_src_blockt _dest_blockt _block_count( R R R R ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyRS s ( R R RS ( ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyR s s Unique instance identifiers Access group namet init_idss List of initiator IDst init_types Initiator typet AccessGroupc B s e Z d d g Z d Z d Z d Z d Z d Z d d Z e
d Z e j
d e j Z e
d e d
Z e
e d Z RS(
R9 R@ i i i i i c C sC | | _ | | _ t j | | _ | | _ | | _ | | _ d S( N( RD RE R t _standardize_init_listt _init_idst
_init_typeRJ RK ( R RD RE R! R" RJ RK ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyRS s c C s_ g } xR | D]J } t j | \ } } } | rA | j | q
t t j d | q
W| S( Ns Invalid initiator ID %s( R t initiator_id_verifyR R R RN ( R R t it validR t init_id( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyR s
sR
^(0x|0X)?([0-9A-Fa-f]{2})
(([\.:\-])?[0-9A-Fa-f]{2}){7}$
c C s | j d s- | j d s- | j d r[ | d k sH | t j k r[ t t j | f Sn t j j t | r | d k s | t j k r t t j t j | f Sn | r t
t j d | n t
d d f S( s
Public method which can be used to verify an initiator id
:param init_id:
:param init_type:
:param raise_exception: Will throw a LsmError INVALID_ARGUMENT if
not a valid initiator address
:return:(Bool, init_type, init_id) Note: init_id will be returned in
normalized format if it's a WWPN
t iqnt euit naas Initiator id '%s' is invalidN( t
startswithR R t INIT_TYPE_ISCSI_IQNR t _regex_wwpnR0 R t INIT_TYPE_WWPNt _wwpn_to_lsm_typeR R RN R ( R& R t raise_exception( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyR# s c C s t j j t | ry t | } | j } t j d d | } t j d d | } d j t j d | } | S| r t t
j d | n d S( s
Convert provided WWPN string into LSM standard one:
LSM WWPN format:
^(?:[0-9a-f]{2}:){7}[0-9a-f]{2}$
LSM WWPN Example:
10:00:00:00:c9:95:2f:de
Acceptable WWPN format is:
^[0x|0X]{0,1}(:?[0-9A-Fa-f]{2}[\.\-:]{0,1}){7}[0-9A-Fa-f]{2}$
Acceptable WWPN example:
10:00:00:00:c9:95:2f:de
10:00:00:00:C9:95:2F:DE
10-00-00-00-C9-95-2F-DE
10-00-00-00-c9-95-2f-de
10.00.00.00.C9.95.2F.DE
10.00.00.00.c9.95.2f.de
0x10000000c9952fde
0X10000000C9952FDE
10000000c9952fde
10000000C9952FDE
Return the LSM WWPN
Return None if raise_error is False and not a valid WWPN.
t 0xRC s [^0-9a-f]t :s ..s Invalid WWPN Initiator: %sN(
R R, R0 R t lowert ret subt joint findallR R RN R ( t wwpnt raise_errort s( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyR. + s N( R R R\ t INIT_TYPE_UNKNOWNt INIT_TYPE_OTHERR- R+ t INIT_TYPE_ISCSI_WWPN_MIXEDR RS R/ R R3 t compilet XR, R R# R R. ( ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyR s
t port_types Target port typet service_addresss Target port service addresst network_addresss Target port network addresst physical_addresss Target port physical addresst
physical_names Target port physical port namet
TargetPortc B s8 e Z d d g Z d Z d Z d Z d Z d d Z RS( R9 R@ i i i i c C sL | | _ | | _ | | _ | | _ | | _ | | _ | | _ | | _ d S( N( RD t
_port_typet _service_addresst _network_addresst _physical_addresst _physical_nameRJ RK ( R RD RE RF RG RH RI RJ RK ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyRS b s N( R R R\ R` Rd t TYPE_FCOEt
TYPE_ISCSIR RS ( ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyRD R s t Capabilitiesc B s] e Z d Z d Z d Z d Z d Z d Z d Z d Z d Z
d Z d Z d
Z
d Z d Z d
Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z! d Z" d Z# d! Z$ d" Z% d# Z& d$ Z' d% Z( d& Z) d' Z* d( Z+ d) Z, d* Z- d+ Z. d, Z/ d- Z0 d. Z1 d/ Z2 d0 Z3 d1 Z4 d2 Z5 d3 Z6 d4 Z7 d5 Z8 d6 Z9 d7 Z: d8 Z; d9 Z< d: Z= d; Z> d< Z? d= Z@ d> ZA d? ZB d@ ZC dA ZD dB ZE dC ZF dD ZG dE ZH dF ZI dG ZJ dH ZK dI ZL dJ ZM dK ZN dL ZO dM ZP dN ZQ dO ZR dP ZS dQ ZT dR ZU dS ZV dT ZW d\ dU ZY dV ZZ dW Z[ e\ dX Z] e^ dY Z_ e dZ Z` d[ Za RS(] i i i i i i i i i i i i i i i i! i" i# i$ i% i& i' i( i) i* i+ i, i- i. i/ i0 i5 i6 i7 i8 i9 i: i; i< i= i> i? i@ iA iB id ie if ig ih ii ij ik im in io ip iq ir ix iy iz i{ i| i i i i i i i i i i i i i i i i i i i i c C s; i | j j d 6d j g | j D] } d | ^ q d 6S( NR RC s %02xt cap( R1 R R5 t _cap( R t b( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyR
s c C s= | d k r' t t j | | _ n t t j | _ d S( N( R t bytearrayt binasciit unhexlifyRN RL t _NUM( R RN ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyRS s c C s | j | t j k S( N( t getRL t SUPPORTED( R t
capability( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyt supported s c C s' | t | j k r t j S| j | S( N( t lenRN RL t UNSUPPORTED( R RV ( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyRT s c C s t } x t t j j D]o \ } } t | t j r t | t k r | d d k r t j
| k o| t j k n r | | | string name
i R4 ( R" R RL R2 R R t sixt string_typesR R t _CAP_NUM_BEGINRS ( t lsm_cap_to_str_convt c_strt c_int( ( s- /usr/lib/python2.7/site-packages/lsm/_data.pyt _lsm_cap_to_str_dict s "$"c C ss t j } | r | Si } xP t | j D]< } | j | t j k r/ | | k rk | | | | s
" 3 1+.{"R 1<( 4 %j+*% _common.pyo 0000644 00000042405 14757650541 0006747 0 ustar 00
-P`c @ s d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z y d d l m Z Wn! e k
r d d l m Z n Xd d l
Z
y* d d l m Z m
Z
d d l m Z Wn7 e k
r d d l m Z m
Z
d d l m Z n Xd d l Z d d l Z d d l Z d d l Z d d l Z e d d Z d Z d e f d YZ d Z e Z i d
d 6dR d 6dS d 6dT d 6dU d 6dV d 6dW d 6dX d 6dY d 6dZ d 6d[ d 6d\ d 6d] d 6d^ d 6d_ d" 6d` d# 6da d$ 6db d& 6dc d( 6dd d) 6de d* 6df d, 6dg d. 6dh d/ 6di d0 6Z d, d& d d d d g Z e d1 Z! d2 Z" d3 Z# d d d4 Z$ d5 Z% d6 Z& d7 Z' d8 Z( d9 Z) d: Z* d; Z+ d< e, f d= YZ- e d> d? d@ e dA d? dB e dC d? dD dE e, f dF Y Z. d d dG Z/ dH Z0 dI e f dJ YZ1 dK e f dL YZ2 dM Z3 dN Z4 dO e j5 f dP YZ6 e7 dQ k re j8 n d S(j iN( t Sequence( t URLErrort HTTPError( t urlparsec s_ d f d } f d } t | | r: | n d d | f d } | S( s
Creates the get/set properties for the given name. It assumes that the
actual attribute is '_' + name
TODO: Expand this with domain validation to ensure the values are correct.
t _c s
t | S( N( t getattr( t self( t attribute_name( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt getter9 s c s t | | d S( N( t setattr( R t value( R ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt setter< s c s t | | S( N( R ( t cls( t namet prop( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt decoratorA s N( t propertyt None( R
t allow_sett docR R R ( ( R R
R s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt default_property0 s
!c C s t | t r* t t j t | n t | t r t | } d | k r d | k rr t t j d n d | k r t t j d q n t d t
j t t j | n yA t
j r t | t
j r t t j d t | q n Wn t k
rn Xt j rGt | t rGt t j t | n t | t j rtt t j t | n t
j } t d | t t j d t t | | d S(
Ns
urlopen errors Errno 111s Connection refuseds Errno 113s Host is downs Unexpected network error:
s SSL Certificate error (%s)s Unexpected exception:
s Unexpected exception (TYPE= %s)( t
isinstanceR t LsmErrort ErrorNumbert PLUGIN_AUTH_FAILEDt strR t NETWORK_CONNREFUSEDt NETWORK_HOSTDOWNt errort tracebackt
format_exct
NETWORK_ERRORt sslt CertificateErrort AttributeErrort sixt PY3t ConnectionErrort sockett
PLUGIN_BUGt type( t expt desct stack_trace( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt common_urllib2_error_handlerH s:
t Proxyc B s, e Z d Z d d Z d Z d Z RS( sQ
Used to provide an unambiguous error when a feature is not implemented.
c C s
| | _ d S( s<
Constructor which takes an object to wrap.
N( t proxied_obj( R t obj( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt __init__{ s c C s; t | j | r% t j | j | St t j d d S( sJ
Called each time an attribute is requested of the object
s Unsupported operationN( t hasattrR. t functoolst partialt _presentR R t
NO_SUPPORT( R R
( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt __getattr__ s c O s t | j | | | S( sQ
Method which is called to invoke the actual method of interest.
( R R. ( R t _proxy_method_namet argst kwargs( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyR4 s N( t __name__t
__module__t __doc__R R0 R6 R4 ( ( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyR- s s
s /var/run/lsm/ipci t Bi i
t KiBi t KBt Kt ki t MiBi t MBt Mt mi t GiBi t GBt Gt gi( t TiBi t TBt Tt ti2 t PiBi t PBt Pt pi< t EiBi t EBt Et ec C sp d } | rh x< t D]4 } | t | k r | t t | :} | } Pq q W| sZ d } n d | | f S| Sd S( s
Convert size in bytes to human readable size
The return string will follow IEC binary prefixes, e.g. '1.9 KiB'
For size less than 1024, we do nothing but return the int we get.
TODO: Need a expect to handle when size is not a int. int() might do.
R= s %.2f %sN( R t SIZE_CONS_CHK_LSTt SIZE_CONSt float( t sizet humant unitst key_name( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt sh s
c C s
t | t S( s
Convert integer size in bytes to human readable size.
We are following rules of IEC binary prefixes on size:
http://en.wikipedia.org/wiki/Gibibyte
The biggest of unit this function supported is PiB.
The precision is 2 which means you will get '1.99 KiB'
( R] t True( RY ( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt size_bytes_2_size_human s c C s t j d t j } | j | } d } | r | j d } | j d } | s^ t | S| j } | j d d } | t k r t | t | } q n t | S( s
Convert human readable size string into integer size in bytes.
Following rules of IEC binary prefixes on size:
http://en.wikipedia.org/wiki/Gibibyte
Supported input size_human in these formats:
'1.9KiB' # int(1024*1.9)
'1 KiB' # 2**10
'1B' # 1
'2K' # 2*(2**10), treated as '2KiB'
'2k' # 2*(2**10), treated as '2KiB'
'2KB' # 2*(10**3)
s
^
([0-9\.]+) # 1: number
[ \t]* # might have space between number and unit
([a-zA-Z]*) # 2: units
$
i i i t IBt iB(
t ret compilet Xt matcht groupt intt uppert replaceRW RX ( t
size_humant regex_size_humant regex_matcht
size_bytest numberR[ ( ( s/ /usr/lib/python2.7/site-packages/lsm/_common.pyt size_human_2_size_bytes s
c C si y3i } t | } | j r. | j | d