grthtrhthjhtyjytjytkergtrhtrjytjerhrfh4:24 29/09/2026a ( fQ@sdZddlZddlZddlZddlZddlZddlZddlmZddl m Z ddl m Z ddl mZmZmZddlmZmZmZmZdd lmZmZdd lmZmZdd lmZd ZGd ddeZddZedkredS)a Implements the RTSRoot class. This file is part of RTSLib. Copyright (c) 2011-2013 by Datera, Inc Copyright (c) 2011-2014 by Red Hat, Inc. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. N)CFSNode)Target) FabricModule) so_mappingbs_cache StorageObject) RTSLibErrorRTSLibALUANotSupportedmodprobemount_configfs) dict_removeset_attributes)freadfwrite)ALUATargetPortGroupz/etc/target/saveconfig.jsoncseZdZdZdZdZfddZddZdd Zd d Z d d Z ddZ ddZ ddZ ddZddZddZddZddZddZd d!Zd"d#Zd$d%Zfd&d'ZdCd*d+ZdDd,d-ZdEd.d/ZdFd1d2Zd3d4Zeed5d6Zee d7d6Zee d8d6Z ee d9d6Z!ee d:d6Z"eed;d6Z#eedd6Z&eed?d6Z'eed@d6Z(ee dAd6Z)eedBd6Z*Z+S)GRTSRoota` This is an interface to the root of the configFS object tree. Is allows one to start browsing Target and StorageObjects, as well as helper methods to return arbitrary objects from the configFS tree. >>> import rtslib.root as root >>> rtsroot = root.RTSRoot() >>> rtsroot.path '/sys/kernel/config/target' >>> rtsroot.exists True >>> rtsroot.targets # doctest: +ELLIPSIS [...] >>> rtsroot.tpgs # doctest: +ELLIPSIS [...] >>> rtsroot.storage_objects # doctest: +ELLIPSIS [...] >>> rtsroot.network_portals # doctest: +ELLIPSIS [...] z /var/targetz /etc/targetcsztt|z tWn ty8tdtYn0z|dWn$tyltd|dYn0|dS)zz Instantiate an RTSRoot object. Basically checks for configfs setup and base kernel modules (tcm) ZconfigfsanyZtarget_core_modN)superr__init__r r r Z_create_in_cfs_ine _set_dbrootself __class__//usr/lib/python3.9/site-packages/rtslib/root.pyrFs    zRTSRoot.__init__ccs*||jD]}|jD] }|VqqdSN) _check_selffabric_modulestargets)rZ fabric_moduletargetrrr _list_targetsZs  zRTSRoot._list_targetsccs |tD] }|VqdSr)rrall)rsorrr_list_storage_objects`s zRTSRoot._list_storage_objectsccs*||jD]}|jD] }|VqqdSr)rstorage_objects alua_tpgs)rr$arrr_list_alua_tpgses  zRTSRoot._list_alua_tpgsccs*||jD]}|jD] }|VqqdSr)rr tpgs)rtZtpgrrr _list_tpgsks  zRTSRoot._list_tpgsccs*||jD]}|jD] }|VqqdSr)rr* node_acls)rr+Znode_aclrrr_list_node_aclsqs  zRTSRoot._list_node_aclsccs*||jD]}|jD] }|VqqdSr)rr*node_acl_groups)rr+nagrrr_list_node_acl_groupsws  zRTSRoot._list_node_acl_groupsccs*||jD]}|jD] }|VqqdSr)rr- mapped_luns)rnaZmlunrrr_list_mapped_luns}s  zRTSRoot._list_mapped_lunsccs*||jD]}|jD] }|VqqdSr)rr/mapped_lun_groups)rr0Zmlgrrr_list_mapped_lun_groupss  zRTSRoot._list_mapped_lun_groupsccs*||jD]}|jD] }|VqqdSr)rr*network_portals)rr+prrr_list_network_portalss  zRTSRoot._list_network_portalsccs*||jD]}|jD] }|VqqdSr)rr*luns)rr+lunrrr _list_lunss  zRTSRoot._list_lunsccs&||jD]}|jr|jVqdSr)rr-Zsession)rr3rrr_list_sessionss zRTSRoot._list_sessionsccs |tD] }|VqdSr)rrr#)rmodrrr_list_fabric_moduless zRTSRoot._list_fabric_modulescCsdS)NZrtslibrrrrr__str__szRTSRoot.__str__cCs|jd}tj|s"|j|_dSt||_|j|jkrzt||jdWnNtj|jsttd |jn"ddl m }|d |jYdSYn0t||_dS)Nz/dbroot z?Cannot set dbroot to {}. Please check if this directory exists.r)warnzECannot set dbroot to {}. Target devices have already been registered.) pathosexists_default_dbroot_dbrootrrisdirr formatwarningsrB)rZ dbroot_pathrBrrrrs&      zRTSRoot._set_dbrootcCs|jSr)rGrrrr _get_dbrootszRTSRoot._get_dbrootc Cs|}zz RTSRoot.dump..r&cSsg|] }|qSrrf)rgr+rrrrhrir cSs$g|]}|dr|jr|qS)discovery_auth) has_featureZdiscovery_enable_authrRrgrbrrrrhs r)rrrRr&r r)rdrrrrRs z RTSRoot.dumpNFcCs|s td|jD]*}|s|r,|r|j|kr||rq>qdd|jDD] }|qN|jD]*}|sn|r||rb|j|krb||rbqqb|s|std|j D]}t |qdS)z6 Remove entire current configuration. z-As a precaution, confirm=True needs to be setcss|]}|dr|VqdS)rjN)rkrlrrr 3riz)RTSRoot.clear_existing..z %s/core/*_*N) r r wwndeleterZclear_discovery_auth_settingsr&rPglobZ configfs_dirrDrmdir)rr!rQconfirmr+fmr$Zhba_dirrrrclear_existings"   zRTSRoot.clear_existingc s|r|j||ddnt|js*t|jrt|jr|dgD]@}|jD]4}|d|jkrJ|d|jkrJtd|j|jfqJq@t|jr|dgD],}|jD] } |d| jkrtd | jqqg|rd d n fd d t |dgD]n\} dvrd | q|s"|r2|rd|krzt d} Wn6t yxdd|rpYqfYqYn0 } t | dz| fi| } Wn\ty}zBdd|f|rWYd}~qfWYd}~qWYd}~n d}~00fdd}t| di|diD].}zt| |WntyTYn0q*|rqfqt |dgD]T\} }d|vrd| qv|jD](}|d|jkr||qvqqvt |dgD]\} }d|vrd| q|s |r|r|d|krd|vrHd|d|rqq|ddd|jDvrd|d|rqqt|d}t|||rqq܈S)a Takes a dict generated by dump() and reconfigures the target to match. Returns list of non-fatal errors that were encountered. Will refuse to restore over an existing configuration unless clear_existing is True. T)rsr&rPrNz)storageobject '%s:%s' exist not restoringr roz'target with wwn %s exist, not restoringcSs t|dSr)r Zerr_strrrrerr_funcdsz!RTSRoot.restore..err_funccs|ddS)Nz , skipped)r^rv)errorsrrrwgsz''name' not defined in storage object %dz3'plugin' not defined or invalid in storageobject %s)rE attributesrNZ buffered_moder'z%Could not create StorageObject %s: %sNcsddd|fS)NzStorage Object %s/%s: %srNrPr)x)rwr$rr so_err_funcsz$RTSRoot.restore..so_err_funcryr'rz%'name' not defined in fabricmodule %dz'wwn' not defined in target %dfabricz target %s missing 'fabric' fieldcss|] }|jVqdSr)rPrlrrrrnriz"RTSRoot.restore..zUnknown fabric '%s')rurr&r r\rPrNr ror[rKeyErrorcopyr ExceptionrrZsetupr rrr)rconfigr!rQruabort_on_errorZ config_soZ loaded_soZ config_tgZ loaded_tgindexZso_clskwargsZso_objrdr{Zalua_tpgrtZfm_objr+r)rwrxr$rrestoreHs             "           zRTSRoot.restorec Cs:|st}|r|||}n|}|d}tjtjB}d|A}zt|Wnty^Yn0t |}z t |tj tj Btj B|}Wntytd|Yn0t|dN} | tj|ddd| d| t| | Wd n1s 0Yt||t |t|d S) z Write the configuration in json format to a file. Save file defaults to '/etc/target/saveconfig.json'. z.tempirMwT)Z sort_keysindentrAN)default_save_filererRstatS_IRUSRS_IWUSRrDr]OSErrorumaskrSO_WRONLYO_CREATO_EXCLrZfdopenwriterTdumpsflushfsyncfilenocloseshutilr~) rr`r_rcZtmp_filemoderZumask_originalZfdescrbrrr save_to_files4      (  zRTSRoot.save_to_fileTcCsX|st}t|d2}t|}|j|||||dWdS1sJ0YdS)a  Restore the configuration from a file in json format. Restore file defaults to '/etc/target/saveconfig.json'. Returns a list of non-fatal errors. If abort_on_error is set, it will raise the exception instead of continuing. rL)rurN)rrSrTrUrVr)rZ restore_filerur!rQrrbrrrrrestore_from_files   zRTSRoot.restore_from_filecCs tdS)zE Invalidate any caches used throughout the hierarchy N)rclearrrrrinvalidate_cachesszRTSRoot.invalidate_cacheszGet the list of Target objects.)docz-Get the list of all the existing TPG objects.z1Get the list of all the existing NodeACL objects.z6Get the list of all the existing NodeACLGroup objects.z3Get the list of all the existing MappedLUN objects.z8Get the list of all the existing MappedLUNGroup objects.z*Get the list of all the existing sessions.z8Get the list of all the existing Network Portal objects.z1Get the list of all the existing Storage objects.z)Get the list of all existing LUN objects.z)Get the list of all FabricModule objects.z%Get the list of all ALUA TPG objects.zGet the target database root)NNF)NNFF)NN)NTNNF),__name__ __module__ __qualname____doc__rFZ_preferred_dbrootrr"r%r)r,r.r1r4r6r9r<r=r?r@rrKrerRrurrrrpropertyr r*r-r/r2r5Zsessionsr7r&r:rr'Zdbroot __classcell__rrrrr's T  ) y - rcCsddl}|dS)zRun the doctests.rN)doctestZtestmod)rrrr_test!sr__main__) rrDrrTrqrXrZnoderr!rr|rZtcmrrrZutilsr r r r r rrrZaluarrrrrrrrrs,    }