novdocx(en)5 June 2007
SMS and Backup Application Development
Novell SMS and Backup
Application Developmentwww.novell.com QUICK START SMS Recommendations
Introduction
Open Enterprise Server (OES) offers customers the flexibility to deploy services on NetWare® or SUSETM with common management experiences on both platforms. Open Enterprise Server consists of the following software components:
NetWare 6.5, Support Pack 3
SUSE LINUX Server 9, Enterprise Edition
Nterprise Linux Services 2.0
In order to provide a consistent backup interface, Storage Management Services (SMS) API framework is being made available on SUSE LINUX Enteprise Server (SLES). With the OES release, SMS has a single consistent interface to backup file systems on NetWare, OES Linux (including NSS on SLES) and other Novell applications. The API set has also been enhanced to include newer functionality.
This document provides an overview of the functionality, recommendations for their usage and limitations and is expected to help backup application development. The primary focus is to enable backup application developers to exploit these services in a consistent manner on OES NetWare and OES Linux.
PURPOSE
The primary objectives of this document are:
To provide a basis for planning and implementation to support backup of the NSS file system on OES Linux.
To provide, in a consolidated form, details of newer features that have been introduced in the past couple of years and how they can be better exploited.
AUDIENCE
The target audience for this document are backup application developers and corporations that already have experience with SMS in building applications for NetWare. The document is expected novdocx (en) 5 June 2007 has been updated unctionality already implemented rmation and on DE usage also a ovided with this release for both its features,howto go about developing orits a GroupWise. However, as it can be noted, all GroupWise. However, ated documentation” section that refersated documentation” this an be used as a reference to understand the an be used as a reference to understand ion already available in other locations. ). features on OES NetWare and OES Linux. It and OES Linux. features on OES NetWare provide an overview of recently introduced present in this version of the set. API comp/sms_docs/data/h6nkslcr.html) will not focus on existing f SMS Developer Components Documentation (http:// Documentation SMS Developer Components in conjunction with the following: The ing out current limitations. The demoengine.html provides info backup applications. “References” on page 2 A backup application sample (DE) is pr developer.novell.com/ndk/doc/sms with the latest information with this developer and release. ships Every subsection in this document has an “Rel document and sections within it. and OES Linux. This sample code c NetWare usage API. of SMS Sample Code: DE Documentation: This document focuses on file system TSA does not focus on TSAs for as applications such TSAs will comply with the API definition documentation: SMS API on what API is exercised in that operation.step by step detail This document provides pointers on how the sample code can be read. The focus of this document is to provide recommendations on how newer API can be better exploited. It will also br This and will instead, document will not refer describe to the SMS API API in detail, documentation (see and all NOTtutoriala on SMS This is document The document will also not duplicate informat Instead, it will refer to where everdocumentation necessary. This main objective of this document is to backup application. features and functionality only. It features only. and functionality by many commercial COPE References This is intended document to be read What the Document is NotWhatDocument is the to serve as a guide newer to features understand and functionality that have been recently implemented. S Focus Of the Document novdocx (en) 5 June 2007 . The ® of a particular backup of a particular or Novell iFolder actions used in the TM application development as it systems and applications. Thus, ansforms it to a continuous stream th the OES release, SMS is available on both provides abstractions provides e the target is located and uses file system or e the target across all file amework consume in that backup applications (TSA). SMDR defines the API framework and a its components and components provides a guide to read the its intended for developers who are already familiar as iFolder, GroupWise) or file systems (NSS, as iFolder, the same design philosophy of having a single make references in the rest of the document more . TSAs for other targets are likely to be built in the . TSAs for other targets ed in a standard format such as SIDF. TSAs exist format such as SIDF. ed in a standard provides the communication channel between the otocols and network abstr TM the API for a particular target. target. the API for a particular API can work with API can work NSS, GroupWise platforms. This will helpplatforms. backup RAMEWORK ed on the target) to extract data and tr to extract data ed on the target) API F ONSISTENT backup applications written to this NetWare as well as OES Linux and also carries NetWare consistent API framework for applications (such SMS has traditionally Wi been available on NetWare. VFS-compliant) across different VFS-compliant) across different would have a single view of all Novell backup targets. servers involved and abstracts details of the pr servers details involved and abstracts communication. C SMDR SMDR is the communication agent between the backup application and the service agent target and it defines the API framework. from one SMDR deals withserver the movement of data to It another while providing location transparency. TSA Service Agent (TSA) is a component that The Target rest of the document. Although is this document sectionprovides a brief survey this with SMS, to meaningful. SMS Management (SMS) Services is an API fr Storage and Open Enterprise Server (OES order to provide a complete backup NetWare solution on Linux). SMS exposes a single consistent interface The TSAresides typically target. on the server wher application interfaces(bas This stream is usually represent objects. of data for thefile system, GroupWise and eDirectory SMS: Components and Features and SMS: Components sectionThis provides a brief introduction to SMS, SMS framework is implemented by two main components - The Storage Management Data Management Data SMS framework is implemented by - The Storage two main components Service Agent Requestor (SMDR) and the Target TSA provides of an implementation future. novdocx (en) 5 June 2007 fferent formatters as fferent ailable consistently on ed by backup applications such as extended character ? he ability to provide di ibutes and data like rich ACLibutes and model, trustees, data liant file system, the interfaces are VFS ements and more recently, its availability on its and more recently, ements day. All features are av day. ection by providing a consistent API for file INUX ures that can be exploit able to backup and restoreto be NSS file system backup such as TAR, CPIO, etc. SMS CPIO, etc. SMS on OES backup such as TAR, ented and/or exposed several new features that s-platform support for SMS ands-platform hence from backup plemented. They havedescribed been in this he subsequent sections have dependencies on each OES L ON ons. These include functionality SMS NEED EATURES
WE
None of the features discussed in t DO
SMS F HY EW SMS has, over the last couple of years, implem can be used by backup applicati passwords, Unicodepasswords, streams, performance enhanc OES Linux. In this document, the focus is on these new feat toenhance the options provided to the customer to and OES Linux . OES NetWare NOTE: other. Each feature can be independently im other. applications would be the need most for customers today. important document order in no although cros particular N W OES Linux already has several applications for Linux is intended to add value to the existing coll systems and applications.future, In SMS may have t well which is likely to include TAR, and the current PAX standard, apart from SIDF. apart standard, and the current PAX well which is likely to include TAR, ability important a very SMS also brings to OES Although NSS will be exposed as a VFS-compdata. through SMS will expose the streams. data APImultiple all NSS ensuringdata complete backup protection of the file system on OES Linux for enterprises. inadequate to be able backup NSS to file system attr novdocx (en) 5 June 2007 . For to steps application itself, but application itself, application to locate during such a development. of the primary resources. On NetWare file of the primary resources. On NetWare are likely to arise ment. For advertisement, it is mandatory that work enables the backup ed on SPX/IPX protocol. DNS/hosts resolution is resolution ed on SPX/IPX protocol. DNS/hosts development of the backup service agent be running on the server where mechanism used is SLP. Currently, OpenSLP Currently, mechanism used is SLP. implementations on NetWare. Some information on NetWare. implementations r a detailed descriptionr a detailed of new binaries and their d be required in backup applications to work mechanisms used are SLP and SAP. SLP is widely SLP is mechanismsand SAP. are SLP used ices, all mount points are considered as a primary ices, all mount points SMS ReadmeSMS (http://forgeftp.novell.com/smscomp/ of the SMS components of the(TSA and SMDR) components SMS on OES of primary resources are volumes, File Server, Server Specific Server Specific of primary resources are volumes, File Server, CONCEPTS
“Appendix A - binaries SMS Linux” on OES on page 25 . IMPLEMENTATION This section describes the implementation This section describes the implementation Linux from their and how they behave differently in this be required section may not for coding and targets running the SMDR service. targets OnNetware, the discoveryand advertisement bas is SAP while on TCP/IP, based is it since used In SMS, the primary resources are those that are the highest level entities under service. a target The secondary resources can be viewed as the children services, examplessystem target Resources serv Linux file system target Info, etc. On OES also supported. On OES Linux, the discovery and advertisement any SLP (protocol version 1 or greater) compliant resolution is SMDR runs. DNS/hosts also supported. resource. Directories and files under the primary resources are referred to as secondary resources. Discovery and advertisement Discovery Discovery and advertisement of SMDRs in the net SMS libraries are used for both discovery and advertise Cross Platform SMS Cross Platform This section would focus on changes that woul seamlessly with SMS from the release.OES Fo referusage on OES Linux, install and verify if SMS is working, refer to install README.html) will be needed in order to troubleshoot problems that novdocx (en) 5 June 2007 spaces as supported spaces ce. On OES Linux each is used to distinguish access rights of the currentaccess rights connection. If a space separators that are associatedspace with ” on OES Linux. To work with the file system ” on OES Linux. To system target service for browsing resources: system target on OES Linux, all name e, hence mount points within mount points aree, hence mount within mount points points y given primary resour ent all names returned from the SMS interface. sh between resource nodes. This differs from the from nodes.sh between resource This differs that is supported natively by the platform. not distinguished from the secondary resource. ined to be “
B ng their existing back up software. ng their existing back up software. be able to support incremental/differential backups based backups be on able the supportto incremental/differential on using SMS would need to call “Option Functions” on page 8 FOR MODE
ckup applications vendors to enable
. HANGES “Backup Functions” on page 7 MULATION C E . ARE Functions” on pageFunctions” on 8 particular primary resource. particular described in NWSM_EXCLUDE_ARCHIVED_CHILDREN bit for non-NSS file systems. API can be used NWSMTSGetTargetResourceInfoEx Backup applications will need to now Backup applications that require VFS specific function NWSMTSGetTargetResourceInfoEx Backup applications will not used by the application. This would ensure th for onplatforms the same different name space. The TSA name returned by NWSMListTSAs needs name service TSAs target is defined to be “< forapplications that t Backup understand to need name. only the TheNFS backup application name space contain thewill also dataSetNames of scanInneed to recognize the interpretation Backup applications need to recognize that refer details For resources. page 9 Any cross-platform solution must use the NWSMTSListSupportedNameSpaces API to solutionAny cross-platform must use the NWSMTSListSupportedNameSpaces determine support for the name sp serviceto in various the target name spaces. applicatiAny cross-platform fi to get the NWSMTSGetNameSpaceTypeInfo Linux the file system TSAs service name is def supported although some of them will not hav This has been done the in order to maintain and OES Linux. On NetWare, SMSUT.IMP needs to be included in the import files and SMSUT.IMP and OES Linux. On NetWare, added to the auto load list. On SMSUT.NLM needs to link with libsmsut.so. W ET UGGESTED N S This solution is provided for ba system as NetWare file system usi system as NetWare novdocx (en) 5 June 2007 File System” as a target is expected that these limitations is expected that these limitations stem target service to validate stem target Storage Management Services not define the two special resources “Linux twothe not define S Linux requireS that the process accessing lications for NetWare can extend their backup lications for NetWare er name>.NetWare File System” as a target er name>.NetWare tWare TSAFS, when used in the NetWare mode. TSAFS, when used in the NetWare tWare ystem” and “NetWare File System” as target File System” as target ystem” and “NetWare a NetWare Server. Linux and NetWare modes are and NetWare Linux Server. a NetWare Linux, NetWare, and Dual. and Linux mode being the Linux, NetWare, ES Linux is treated analogous to moving data ion” as its NetWare counterpart. counterpart. NetWare ion” as its s are exposed as resources. dependent on the Target Service. dependent on the Target A A name>.Linuxexposes “ able nature of requests and caches data ahead ofable and caches data nature of requests es several terabytes of data and tape devices are es several and tape terabytes of data erred to the end-customer. This section contains This section contains erred to the end-customer. the primary resource followed by of backup applications’ usage of API doesSMS sample (TSATEST) in the developer kit. sample (TSATEST) BACKUP in nature. While this approach wa NWSMTSScanDataSetBegin for every directoryNWSMTSScanDataSetBegin should also that will help improve over TO client requests simultaneously. client requests with existing backup applicat ENHANCEMENTS CHANGES Performance and File system TSA avoid doing so. Instead the backup applicati Backup applications that call NWSMTSScanDa to call on NWSMTSScanDataSetBegin Backup applications that call Backup applications must adhere to reco chapter on under this resource. sets NWSMTSScanNextDataSet for data implementation is also provided as a implementation UGGESTED ERFORMANCE ACKGROUND Backup has traditionally beenBackup has traditionally serial S P Performance Model Performance B TSAFS was redesigned to deliver performance changing the API set definition in order without to provide backward compatibility accomplished by de-coupling the serial usage of t model, the TSA takes advantage of the predict advantage model, the TSA takes time, so that backup can be se application requests With these enhancements, TSAFS delivers TSAFSdramatic With these enhancements, peak performance is derived when the system is toparameters ensure maximum throughput. More better performance by recommended usage of the SM TSAFS. provide specific recommendations impact the extent to which this benefit is transf impact some of these recommendations. incorporate read-ahead caching and the new vers performancethe new model, asWith well). 4 6.0 SP wasTSAFS also made available on NetWare the manner However, improved dramatically. optimized for servicing multiple access of predictable advantage In order to take able to service several megabytes of data per second. per ableseveral megabytes of data to service certainly not effective as today’s backup involv as today’s not effective certainly novdocx (en) 5 June 2007 up application needs to umstances. Hence, the Hence, umstances. rded by the backup he course of the backup,he course of the if possible.The to be stopped, the caches destroyed and pact the average read service time for data the average read service time for data pact incorporated within the (Providing TSA. a of the read- ication reduces the effectiveness e TSA provided mechanisms for incremental/ opped, and the caches should be destroyed mitigated by either providingTSA with a the useful in certain circ useful in certain likely to degrade system performance as all open is used only during the backup and not e its resources and also prevent resource e its by TSAFS by TSAFS will be disca unavoidable and the back ING_MODE the to false using e the highest level resource to bee the highest level resource backed up in order to ons needs to filter data sets, the the sets, ons needs to filter data ial selection of data sets, it is recommended that the backup ialsets, selection of data differential backups. In cases where it is backups. differential It is recommended that backup applications us during a scan for any reason. open and read-ahead operations have to be st that were successfully It is recommended sets that Close is called immediately on all data us read. This allows TSAFS to effectively starvation in extreme cases. process the incremental/different application set the NWSM_USE_CACH API. NWSMTSConfigureTargetService It is recommended that NWSMTSScanDataSetEnd() can be used to terminate the job importance in the This assumes more current model. If this used, API is not prematurely. scan, open and read-ahead the overall system performance. continue impacting is In this model, NWSMTSReturnToParent() In the new model, the open operation such triggers a as open chain of events and read- aheads. Given this, it is recommended that and rebuilt. While this is the case, the API is NWSM_USE_CACHING_MODE the flag can be set to false using API to prevent a degrade performance. in the NWSMTSConfigureTargetService It is advisable not to change the open mode during t maximize the advantage of maximize the cachingthe advantage model Implementing selection in the backup appl lists application. These unnecessary read-aheads im that are actually backed up. Thissets can be to be backed up or using the sets TSA selection list. filtered list of data if the backup applicati Alternately, open mode provided is used to TSAFS to build a cache of open files. If the open mode is changed, all open and read-ahead operations have set average the request. data time to service a rebuilt. This will affect the primary resource followed under by NWSMTSScanNextDataSet sets for all other data this resource. Backup applications should provid single data set at a time (in single data point 2 provided above) the lowest level resource to back up thereby TSAFS limiting any optimization that the do.) can read sets ahead as a subset of the data should usage. be understood beforebenefits its novdocx (en) 5 June 2007 serial (RPC-like) interface of SMDR the rmance issues of software components like components rmance issues of software be found in the Target Services Functions be found in the Target get Services Functions Chapter of the API the TSATEST code provided with this the TSATEST refer to the demonstration engine dware is unable to demonstrate a reasonable entation that ships along with this developer that ships entation along with its source which can be treatedas the along with its target, and then discards them. This, in effect, is is and then discards them. This,target, in effect, te capacity and infinite speed tape sub-system. and infinite speed tape te capacity ark against a backup application. enecks due to setting up suboptimal hardware optimization of the all other sub-systems other than the tape- PERFORMANCE OCUMENTATION FOR D documentation and code. Also, refer to developer release. NWSMTSScanDataSetEnd For examples on how to use these API NWSMTSScanDataSetBegin NWSMTSScanNextDataSet NWSMTSReturnToParent definition can be found in the Target Services Functions Chapter definition can be found in the Target NWSMTSReturnToParent of the API Documentation definition can NWSMTSConfigureTargetService Chapter of the API Documentation Refer the Backup Functions section in the Tar TSATEST can thenbenchm be used to TSATEST When using SMDR for due remote to the backups, can only be utilized to determine perfo TSATEST would cannot be analyzed orcomponents overcome and TSATEST using optimal software show poor performance if the underlying har for theDocumentation following backup related API: TSATEST can be used to fine tune the software components to derive can be the used tomaximum components fine tune the software TSATEST performance rated by the hardware. performance would of be backups slower than local backups. the TSA or the file system. Any bottl measure scalability. of ELATED ESTING IMITATIONS Following references point to the SMS API docum release. R L T TSATEST is available as part of the developer kit of the developer is available as part TSATEST recommendedfor achieving high performance. implementation TSATEST is a utility that reads data sets from a sets is a utility that reads data TSATEST equivalent backup system that has to a an infini This allows configuration the can be used for purposes: two subsystem. TSATEST novdocx (en) 5 June 2007 sions may cause nversions are usually round-trip conver Unicode character to represent 0xDA esentations in additionesentations in to MBCS the of data. SMS now stores MBCS asof well data. as ple, nameSpaceType for DOS name for DOS space is ple, nameSpaceType up session using (from to the tape) the target such as scan, that accept path names, can such as scan, that accept path information in UTF-8. Importantly, this enables information in UTF-8. Importantly, DF stream and provides API to access the UTF-providesDF stream and API ons can now use the SMS API to provide a path a path to provide SMS API the can now use ons in Unicode. However, prior to NetWare 6.5 SP2, prior to NetWare in Unicode. However, up application. These co r in MBCS. Given this, thein MBCS. Given this,rapproach best would be ersions, which in turn is preserves path namesersions, which in turn is preserves path implements and exposes the UTF-8 enabled on and exposesthe UTF-8 API implements ich may not always result in an appropriate names or been enhanced file names have to accept s requireds Unicode and vice versa between MBCS and the NCP clients used MBCS representations for path names used for the MBCS representations path clients NCP e types that a TSA can support. e that even with a single locale, SMS l of Novell’s services in NetWare 6.5 SP2, including NCPs and SMS, services in NetWare l of Novell’s IN be mis-represented. For example, the SUPPORT both OES NetWare and OES Linux. both NetWare OES NICODE ACKGROUND The NSS file system stores path names nativelyThe NSS file stores path system most backup applications, SMS and implied that a conversion wa This internally. setfor every data was processed that by a back done using the servers’ locale as a basis wh it is possibl conversion. Further, certain characters to certain separato to a “/”in the converts MAC code page to ensure there are no conversions done during backup and restore. In order to accomplish this, al have been enabled to process UTF-8 representations UTF-8 of therepresentations names in path the SI that is freefrom the of conv file system to tape accurately in all environments. 8 representations names.of path Backup applicati U SMS has been enhanced to support storing UTF-8 repr now accept UTF-8 representations and also return backup applications to now process the entire back SIDF data. SMS interfaces that accept path SMS interfaces that acceptSIDF data. path ThisUTF-8 representations. means that operations UTF-8. Unicode support in SMS has been implemented in such a way so as to not change the API call It parameter. sequence. Instead, the behavior of the API can be controlled by the nameSpaceType are different. and the nameSpaceType that the nameSpace to understand is important the is represented. Currently, refers to the format in which the nameSpace nameSpaceType supported areformats MBCS and UTF-8. For exam Unicode Support B represented as DOSNameSpace to denote MBCS format and DOSNameSpaceUTF8Type for to denote MBCS format and DOSNameSpaceUTF8Type represented as DOSNameSpace has been added to UTF-8 format. NWSMTSGetSupportedNameTypes, An additional API determine the name spac different NOTE: a TSAFSThis developer that release contains novdocx (en) 5 June 2007 ERVICE S e in all the name lists e in all the name lists made as necessary. made as necessary. ent-child relationship NED_RESOURCE_TYPE, NED_RESOURCE_TYPE, TARGET 8 and then construct the new aSetBegin in the major resourceAPI, pass ories and files to the end-user. This needs filesand to the end-user. ories of supported target serviceof supported resources. target The name that is usually supplied by the user. name that is usually supplied by the user. interfaces to expose UTF-8 data. This effort interfaces This to expose UTF-8 effort data. return name types that is required by space ing backup, store the of UTF-8 representation ENABLED accept nameSpaceType as an argument and accept nameSpaceType es. Also, using a par the interface with the backup the interface with the application. It appropriate conversions store, use the forUTF-8 the representation rmation would be availabl for common customer problems. However, all problems.for common customer However, APPLICATIONS used the UTF-8 (where representations applicable, path names can be natively processed in UTF-8 path tion itself. It presupposes successful connection tion itself. TSA (even those that do not support UTF-8) ely resolved when backup provide a applications ways NWSM_TSA_DEFI ways includes the functionality to store UTF-8 UTF-8 A to convert this to UTF- tape using the exposed by SMS. API tape BACKUP TO USING CHANGES CANNING : S Use the NWSMTSListTSResources to get a list name space type for are al resources name space these are represented services. in MBCS for all target a scan using the WhileNWSMTSScanDat starting specify the 1. Additionally, as received in Step the backup application, in our current context this would be that parameter This would return the dataSetNames NWSM_ALL_NAME_SPACES_UTF8. set names encoded in UTF-8. data contains pathname. While storing name lists to tape dur While to tape storingpathname. name lists it is possible not to and rename every setbetween sets, data but, rename data parents only use the handles to restore children. parent to backup or sets Duringre selection of data It is recommended to store both MBCS and names on UTF-8 of the representations path in order to support restorestape to any Backup applications have a need to display direct Rename restores take additionalan initial path the same to overcome using MBCS on restor Backup applications need to review APIs that enhance it to handle UTF-8 name types. The recommended of working mode with a TSA is other the same to relevantTSA APIs. UTF-8namesand pass TSAtouse as returned by the APIs, this info to the TSA data same to pass that are returned by the TSA. to be considered independently of and SMS Backup applications would need 1 2 during restores) that served as a workaround beissues are expected to and effectiv fully of no conversion frompath disk to representations in the but did not haverepresentations SIDF data, removed conversions from the TSAFS except at also implementedintelligently that solutions XAMPLE UGGESTED without any conversions in the backup applica support of UTF-8 name service’s type and detection of the target establishment The following example is used to illustrate how E With NetWare 6.5 Support 6.5 Pack 2, TSAFS With NetWare S novdocx (en) 5 June 2007 can be most cases, avoided in found in the Target Services Functions found inthe Target et API s only return encoded data. SIDF rned is limited by the TSA in size to lume (which stores path nameslume natively (which stores path in rsively, use the UTF-8 names as received rsively, from limitations imposed by the conversion. from limitations If the backup both MBCS If the applicationrequests parameter support parameter the UTF-8 as space a name r to the and demonstration engine documentation as specified in the NWSM_SCAN_CONTROL ended for backups asended for well. the backups During backups acters to be mis-represented. acter conversion between and UTF-8 MBCS is likely to cause be mis-represented. While conversions OCUMENTATION D All interfaces that have a nameSpaceType All interfaces that have a nameSpaceType For further of scanning non-major resources recu 2 as the resourceName next to the parameter call to from the TSA in Step NWSMTSScanDataSetBegin. any instance requiring a conversion would suffer charMBCS) may cause certain whichbufferSize can store upto 65536 bytes. For examples on how to use this API refe code. NWSMTSGetSupportedNameTypes definition can be NWSMTSGetSupportedNameTypes certain characters to certain namesFor example, natively from a NSS volume (which in stores path backing up data traditional vo Unicode) and restoring to a NetWare structure as retu NWSM_DATA_SET_NAME_LIST set length of a data path names, this and UTF-8reduces the total of representations path at a time by least half. returned by the NWSM_DATA_SET_NAME_LIST Chapter of the API Documentation As stated earlier, any char earlier, As stated 3 ELATED IMITATIONS representation. The representation. above would steps be valid in all such cases. R L The above listed for scans can be ext steps NWSMTSOpenDataSetForBackup/NWSMTSReadDataS done names are The SIDF encoding of path structure specified in NWSMTSScanDataSetBegin. NOTE: Following references point to the API documentation developer along with this SMS that ships release. novdocx (en) 5 June 2007 ions can now provide SMS IN older (pre-NetWare 6.5) clients are used 6.5) clients older (pre-NetWare passwords be used always. This be work would passwords able in Unicode. With this implementation, all able in Unicode. With this implementation, re earlier represented in MBCS, there were has direct relevance to backup is the support of F-8 password option (as can happenF-8 password on older ation and processed. This was implemented by ed in UTF-8. SMS then uses this to authenticate to this uses then ed in UTF-8. SMS work. However, it is possible to have a mixed it is possible work. However, SUPPORT il. The backup application would then have to usewould then haveto il. The backup application APPLICATIONS d hence can older completely replace its e needed all clients and servers upgraded in ordere needed all clients the UTF-8 are and MBCS representations introduced a feature commonly called Universal with which backup applicat on OES Linux supports only on OES Linux supports BACKUP PASSWORD TO CHANGES CHARACTER If servicethe target does not support the UT fa API will TSAsto the or servers),the call the MBCS option to authenticate. NWSMTSConnectToTargetServiceEx optionFlag in this developer release. NWSM_AUTH_RAW_DATA NWSMTSConnectToTargetServiceEx needs to be used in place of NWSMTSConnectToTargetServiceEx This new both UTF-8 API supports as representation NWSMTSConnectToTargetService. well an as the older MBCS representation (NWSMTSConnectToTargetService). counterpart It is recommended of that UTF-8 representation in even transparently older scenarios as equivalent for the range ASCII of characters. contained non-ASCII charactersIf passwords and would fail. In such to usage of NWSMTSConnectToTargetserviceEx set the password, and set the itself situations,theMBCS password the best solution in suchcases is to try with optionFlag to NWSM_AUTH_RAW_DATA. XTENDED UGGESTED ACKGROUND IMITATIONS There has been a growing that have characters from to support need the beyond passwords definition. ASCII we Although,standard passwords 6.5, Novell several problems. With NetWare support.password One of the related features that network or servers of old and newer clients remain in ASCII range.if the the standard passwords passwords that can any contain character represent changes to both the client and server henc and to truly support international in passwords the net passwords arepasswords converted to their UTF-8 represent to eDirectory where supported. international characters in the represent password L E 6.5, SMS provides interfaces With NetWare S Extended Character Passwords Extended B novdocx (en) 5 June 2007 to the demonstration and engine documentation fer the Connection Functions sectionin the DOCUMENTATION NWSMTSConnectToTargetServiceEx NWSMTSConnectToTargerService Target Services Functions chapter of the API Documentation Target For examples on how to use these API refer code. For the following Connection API re related ELATED R Following references point to the API documentation along with this developer SMS that ships release. novdocx (en) 5 June 2007 nnection specific and on a per connection basis ation filters rather than using the target hange to any of the parameters impact all hange to impact any of the parameters rnal filters (those that do not use the TSAs scards several data sets that were read sets scards several data that can be controlled per connection which pecific options are co the backup features. application and its entation that ships along with this developer that ships entation SE_CACHING_MODE to false while doing he Backup Functions section in the Target he Backup Functions section in the Target onfiguration parameters NWSMTSConfigureTargetSerivce API has been API NWSMTSConfigureTargetSerivce etBegin or NWSMTSScanDataSetContinue call APPLICATIONS ents TSA read-ahead cachingents which can actually SM_USE_CACHING_MODE to false to prevent need to be different for each need toconnection.different be All SMS hat target service. However, in various scenarios, there a is service. However, hat target IN BACKUP he feasibility of defining these parameters for a particular for a particular he feasibility of defining these parameters tionality internalcontrolto features certain and are exposed FOR SUPPORT DOCUMENTATION NWSMTSScanDataSetBegin The configuration changes made for backup s For the backup related API refer following t Services Functions chapter of the API Documentation Backup applications that implement their own inte unnecessary read-aheads that would in turn degrade performance. The API several also supports other parameters can be used based on the design and need of Backup applications must set the NWSM_U degrade performance if the backup application di ahead. internal NW filters) should also set the incremental or differential backups based on applic backups or differential incremental service specific filters. This action prev ELATED ONFIGURATION ECOMMENDATION ACKGROUND rather than for the instance. entire TSA through command line options or through iManager. A c through options command line or through iManager. backup/restore operations done using t strongneed to control to have the ability these c Target servicesfunc the provide Target R C provide backup applications t To itself), connection (instead of the TSA instance R Connection Specific Configuration Specific Connection B provided. that This API exposes parameters parameters set via this API takes precedence over the options thattakes set via this API may haveparameters been set withthe command line or iManager. Following references point to the SMS API docum release. take effect from the next NWSMTSScanDataS effect take only. NOTE: NOTE: novdocx (en) 5 June 2007 be found in the Target Services Functions Services be found in the Target NWSMTSScanDataSetEnd NWSMTSConfigureTargetService definition can NWSMTSConfigureTargetService Chapter of the API Documentation novdocx (en) 5 June 2007 in addition to NetWare with the OES the OES with release. in addition to NetWare been enhanced to include newer in the recent past backup application development in parallel with backup development in parallel application ded an overview of the functionality, recommendations for their recommendations ded an overview offunctionality, the rface to backup file systems on OES NetWare and OES Linux and NetWare on OES rface to backup file systems concurrent development of SMS and NSS on Linux. OES usage and This is expected limitations. help to functionality. This document provi functionality. Conclusion The SMS API framework is available on OES Linux inte SMS has a single consistent Theotherset has also API applications. Novell novdocx (en) 5 June 2007 TSA with SMDR. Each will display all the smdrd command s been implemented that will help ared library that exports the SMS the ared library that exports ations of TSA and SMDR on OES Linux. daemon.The for daemon connection waits a worker threadspawns and in requests response to each connection request it receives from otherThe SMDRs in the load network. SMDR to ofTSA option smsconfig requests dynamically address space. load TSA into its smdrd --help options. target thatneed has a TSA willto register is target to it. service name to enable requests routing of Refer smsconfig a detailed for man page command description lineits options. of will display all the smsconfig --help smsconfig command options. tsafs -l smsconfig commandThis file registers the system service as “LinuxFile System” and identifies libtsafs.so correspondingas the shared object that providesservice.the register a particular register a particular APIs. The 32 bit applications working with SMS need to link with this library. APIs. The 64 bit applications on a 64 bit machineneed working SMS with to link with this library. smdrd /opt/novell/sms/binas a inruns SMDR user address space smsconfig /opt/novell/sms/bin A loader ha Appendix A - SMS binaries on OES Linux A - SMS binaries on Appendix This appendix introduces the binary implement Filename Developer Kit Location Description libsmdr.so libsmdr.so /opt/novell/lib This is a sh libsmdr.so /opt/novell/lib64SMS theisa shared This library that exports novdocx (en) 5 June 2007 ieval system, or system, ieval the definitions of allthe definitions of the definitions of allthe definitions of the Novell Trademark and Service Mark list (http:// list Mark and Service Trademark the Novell shared library shared contains is shared libraryis shared contains necessary functions service backup to a target. willusing have to be loaded service Every target smsconfig which will register the name of the libtsafs.so service provided by the library. implements the service functionsbackup to a file system. the utilitythesupported functions32 by SMS on bit machine. the utilitythe supported functions64 by SMS on bit machine. . All third-party trademarks are the property of their respective owners. A trademark trademark A owners. respective their of property the are trademarks third-party All . Legal Notice retr a on stored photocopied, reproduced, be may publication this of No part reserved. rights All Inc. Novell, © 2007 Copyright trademark. denotes third-party a (*) an asterisk trademark; a Novell denotes , TM, etc.) symbol (® Filename Developer Kit Locationlibtsafs.so Description /opt/novell/lib The TSA sharedall library the implements see trademarks, Novell For publisher. the of consent written express the without transmitted www.novell.com/company/legal/trademarks/tmlist.html) libsmsut.so /opt/novell/lib This libsmsut.so /opt/novell/lib64 Th