Using the Application Program Interface


Index

A B C D E F H I L M N O P Q R S T U V W X
A
  • access to objects
  • by user (879), (1257)
  • accessing across nodes (881)
  • accessing across owners (882)
  • accessing objects (876)
  • active copies of objects (931), (1212)
  • administrator options (809), (1161)
  • API
  • options list used by dsmInitEx (811)
  • configuration file used by dsmInitEx (813)
  • sample application, using (817)
  • API configuration file
  • used by dsmInitEx (849), (851)
  • API options list
  • used by dsmInitEx (850)
  • application design considerations (1179)
  • application type (848), (1088), (1094)
  • archive copy group (894), (1188) See also copy group, copy group
  • archiving objects (933), (1214)
  • AS/400 platform
  • using the sample application (828)
  • B
  • backing up objects (929), (1210)
  • backup and archive objects, understanding (927)
  • backup copy group (895), (1189) See also copy group, copy group
  • BSABeginTxn
  • flow chart, in (1215)
  • general description (1198)
  • BSACreateObject
  • flow chart, in (1218)
  • general description (1193)
  • include-exclude list, and (1195)
  • BSADeleteObject
  • flow chart, in (1238)
  • general description (1237)
  • BSAEndData
  • flow chart, in (1234)
  • general description (1209), (1229)
  • BSAEndTxn
  • flow chart, in (1216)
  • general description (1199), (1230)
  • BSAGetData
  • flow chart, in (1233)
  • general description (1228)
  • BSAGetEnvironment
  • general description (1184)
  • BSAGetNextQueryObject
  • flow chart, in (1205)
  • general description (1203)
  • BSAGetObject
  • flow chart, in (1232)
  • general description (1227)
  • BSAInit
  • general description (1171)
  • session owner, set (1255)
  • BSAMarkObjectInactive
  • flow chart, in (1239)
  • BSAQueryApiVersion
  • general description (1167)
  • BSAQueryObject
  • example, use in (1206)
  • flow chart, in (1204), (1231)
  • general description (1202), (1224)
  • receiving data, use in (1225)
  • BSAResolveLifecycleGroup
  • flow chart, in (1217)
  • general description (1194)
  • include-exclude list, and (1196)
  • object name, and (1249)
  • BSASendData
  • flow chart, in (1219)
  • general description (1208)
  • BSATerminate
  • general description (1177)
  • C
  • closed registration (1176)
  • compatibility
  • between different versions of API (838), (1170)
  • compression (934)
  • configuration file, API (812) See also API configuration file
  • copy group
  • defined (893), (1187)
  • D
  • data structures
  • size limits (834)
  • version control (840)
  • deactivating objects on the server (1236)
  • deleting objects from the server (986), (1235)
  • dsmBeginGetData
  • example, use in (980)
  • flowchart, in (975)
  • general description (964), (1022)
  • return codes (1025)
  • state diagram, in (969), (1008)
  • syntax (1024)
  • dsmBeginQuery
  • example, use in (916), (919)
  • flowchart, in (913), (974)
  • general description (906), (961), (1026)
  • receiving data, use in (962)
  • return codes (1030)
  • state diagram, in (910), (1013)
  • syntax (1028)
  • dsmBeginTxn
  • example, use in (949)
  • flowchart, in (942)
  • general description (922), (1031)
  • state diagram, in (935), (1001)
  • syntax (1034)
  • dsmBindMC
  • example, use in (903), (951)
  • flowchart, in (944)
  • general description (897), (948), (1035)
  • include-exclude list, and (898)
  • information returned by (900)
  • object name, and (871)
  • return codes (1038)
  • state diagram, in (937), (1003)
  • syntax (1037)
  • dsmChangePW
  • general description (992), (1039)
  • return codes (1042)
  • state diagram, in (999)
  • syntax (1041)
  • dsmCleanUp
  • general description (1043)
  • dsmDeleteAccess
  • general description (1045)
  • dsmDeleteFS
  • example, use in (890)
  • general description (887), (1047)
  • return codes (1050)
  • state diagram, in (998)
  • syntax (1049)
  • dsmDeleteObj
  • general description (989), (1051)
  • return codes (1054)
  • state diagram, in (941), (1007)
  • syntax (1053)
  • dsmEndGetData
  • example, use in (984)
  • flowchart, in (979)
  • general description (968), (1055)
  • state diagram, in (973), (1012)
  • syntax (1057)
  • dsmEndGetObj
  • example, use in (983)
  • flowchart, in (978)
  • general description (967), (1058)
  • return codes (1061)
  • state diagram, in (972), (1011)
  • syntax (1060)
  • dsmEndQuery
  • example, use in (918)
  • flowchart, in (915)
  • general description (909), (1062)
  • state diagram, in (912), (1015)
  • syntax (1064)
  • dsmEndSendObj
  • example, use in (954)
  • flowchart, in (947)
  • general description (926), (1065)
  • return codes (1068)
  • state diagram, in (940), (1006)
  • syntax (1067)
  • dsmEndTxn
  • example, use in (950)
  • flowchart, in (943)
  • general description (923), (1069)
  • return codes (1072)
  • state diagram, in (936), (1002)
  • syntax (1071)
  • dsmGetData
  • example, use in (982)
  • flowchart, in (977)
  • general description (966), (1073)
  • return codes (1076)
  • state diagram, in (971), (1010)
  • syntax (1075)
  • dsmGetNextQObj
  • example, use in (917)
  • flowchart, in (914)
  • general description (908), (1077)
  • return codes (1080)
  • state diagram, in (911), (1014)
  • syntax (1079)
  • dsmGetObj
  • example, use in (981)
  • flowchart, in (976)
  • general description (965), (1081)
  • return codes (1084)
  • state diagram, in (970), (1009)
  • syntax (1083)
  • dsmInit
  • general description (1085)
  • return codes (1090)
  • syntax (1087)
  • dsmInitEx
  • general description (843), (1091)
  • return codes (1096)
  • session owner, set (877)
  • state diagram, in (993)
  • syntax (1093)
  • dsmLogEvent
  • general description (1097)
  • return codes (1100), (1104)
  • syntax (1099)
  • dsmLogEventEx
  • general description (1101)
  • syntax (1103)
  • dsmQueryAccess
  • general description (1105)
  • dsmQueryApiVersion
  • general description (1107)
  • state diagram, in (995)
  • syntax (1109)
  • dsmQueryApiVersionEx
  • general description (835), (1110)
  • syntax (1112)
  • dsmQueryCliOptions
  • general description (1113)
  • syntax (1115)
  • dsmQuerySessInfo
  • general description (852), (1116)
  • return codes (1119)
  • state diagram, in (1000)
  • syntax (1118)
  • dsmQuerySessOptions
  • general description (1120)
  • syntax (1122)
  • dsmRCMsg
  • general description (1123)
  • return codes (1126)
  • syntax (1125)
  • dsmRegisterFS
  • example, use in (888)
  • general description (885), (1127)
  • return codes (1130)
  • state diagram, in (996)
  • syntax (1129)
  • dsmSendData
  • example, use in (953)
  • flowchart, in (946)
  • general description (925), (1131)
  • return codes (1134)
  • state diagram, in (939), (1005)
  • syntax (1133)
  • dsmSendObj
  • copy groups, and (901)
  • example, use in (952)
  • flowchart, in (945)
  • general description (924), (1135)
  • return codes (1138)
  • state diagram, in (938), (1004)
  • syntax (1137)
  • dsmSetAccess
  • general description (1139)
  • dsmSetUp
  • general description (1141)
  • return codes (1143)
  • dsmTerminate
  • general description (853), (1144)
  • return codes (1147)
  • state diagram, in (994)
  • syntax (1146)
  • dsmUpdateFS
  • example, use in (889)
  • general description (886), (1148)
  • return codes (1151)
  • state diagram, in (997)
  • syntax (1150)
  • dsmUpdateObj
  • general description (1152)
  • return codes (1155)
  • syntax (1154)
  • E
  • ending a session (847)
  • with BSATerminate (1178)
  • with dsmTerminate (854)
  • environment, setting up the API (815)
  • event logging (990)
  • F
  • fast path (907), (1029)
  • file space management (883)
  • file space name (866)
  • function calls
  • dsmBeginGetData (1023)
  • dsmBeginQuery (1027)
  • dsmBeginTxn (1032)
  • dsmBindMC (1036)
  • dsmChangePW (1040)
  • dsmCleanUp (1044)
  • dsmDeleteAccess (1046)
  • dsmDeleteFS (1048)
  • dsmDeleteObj (1052)
  • dsmEndGetData (1056)
  • dsmEndGetObj (1059)
  • dsmEndQuery (1063)
  • dsmEndSendObj (1066)
  • dsmEndTxn (1070)
  • dsmGetData (1074)
  • dsmGetNextQObj (1078)
  • dsmGetObj (1082)
  • dsmInit (1086)
  • dsmLogEvent (1098)
  • dsmLogEventEx (1102)
  • dsmQueryAccess (1106)
  • dsmQueryApiVersion (1108)
  • dsmQueryApiVersionEx (1111)
  • dsmQueryCliOptions (1114)
  • dsmQuerySessInfo (1117)
  • dsmQuerySessOptions (1121)
  • dsmRCMsg (1124)
  • dsmRegisterFS (1128)
  • dsmSendData (1132)
  • dsmSendObj (1136)
  • dsmSetAccess (1140)
  • dsmSetUp (1142)
  • dsmTerminate (1145)
  • dsmUpdateFS (1149)
  • dsmUpdateObj (1153)
  • overview (1021)
  • H
  • high-level name (868)
  • I
  • identifying the object (860), (1240)
  • inactive copies of objects (932), (1213)
  • include-exclude list (899), (1190)
  • installation
  • sample application, of (818), (1163)
  • interoperability
  • commands (1020)
  • conventions
  • Intel platforms (1018)
  • UNIX (1019)
  • naming API objects (1017)
  • overview (1016)
  • L
  • logging events (991)
  • low-level name (870)
  • M
  • management class
  • BSACreateObject, assigned by (1191)
  • BSAResolveLifecycleGroup, assigned by (1192)
  • defined (891), (1185)
  • dsmBindMC, assigned by (896)
  • querying (902)
  • managing file spaces (884)
  • metadata (864), (1244)
  • multi-threading, using (841)
  • N
  • naming of objects (862), (1242) See also object naming, object naming
  • NetWare platform
  • using the sample application (826)
  • nodes, accessing across
  • accessing across owners (880)
  • O
  • object naming
  • BSAResolveLifecycleGroup, and (1250)
  • description (861), (1241)
  • dsmBindMC, and (872)
  • file space name (865)
  • high-level name (867)
  • low-level name (869)
  • object space name (1245)
  • object type (873), (1251)
  • owner name (1253)
  • pathname (1247)
  • object space name (1246)
  • object type (874), (1252)
  • objects, accessing (875)
  • option list
  • format (1089), (1095)
  • options
  • set by administrator (808), (1160)
  • used for (807), (1159)
  • options files, user (814), (1162)
  • options list, API (810) See also API options list
  • OS/2 platform
  • using the sample application (822)
  • owner name (1254)
  • P
  • partial object restore or retrieve (959)
  • password, use of (858), (1183)
  • pathname (1248)
  • policy (892), (1186)
  • Q
  • queries, system (905), (1201)
  • R
  • rcApiOut
  • example, details (859)
  • receiving data from a server
  • general description (955), (1220)
  • partial object restore or retrieve (958)
  • procedure to follow (960), (1223)
  • sorting objects by restore order (963), (1226)
  • registration with server (1175)
  • restoring objects (956), (1221)
  • retrieving objects (957), (1222)
  • return calls
  • dsmInitEx (1092)
  • return codes (1156)
  • S
  • sample API application, using (816)
  • sample application (832)
  • installing on AS/400 platform (829)
  • installing on NetWare platform (827)
  • installing on OS/2 platform (823)
  • installing on UNIX platform (825), (1165)
  • installing on Windows 32-bit (NT, 98) platform (821)
  • running (830), (1166)
  • security (856), (1181)
  • sending data to a server (920), (1207)
  • server, deleting objects from (988)
  • server, TSM
  • main storage areas (863), (1243)
  • session
  • owner (878), (1256)
  • password, use of (857), (1182)
  • security (855), (1180)
  • starting with BSAInit (1172)
  • starting with dsmInitEx (844)
  • signals, using (842)
  • size limits
  • of API data structures (833)
  • starting a session (845), (1173)
  • stopping a session (846), (1174)
  • system queries (904), (1200)
  • T
  • transaction model (921), (1033), (1197)
  • turn off objects on the server (987)
  • U
  • understanding backup and archive objects (928)
  • UNIX platform
  • using the sample application (824), (1164)
  • updating objects on the server (985)
  • using the API
  • examples in this book (831)
  • V
  • verify version (837), (1169)
  • version control
  • API data structures (839)
  • BSAQueryApiVersion, using (1168)
  • dsmQueryApiVersionEx, using (836)
  • managing backed-up copies (930), (1211)
  • W
  • Windows 32-bit platform
  • NT and 98 (819)
  • using the sample application (820)
  • X
  • X/Open Backup Services (1157)
  • XBSA (1158)

  • [ Top of Page | Previous Page | Table of Contents | Index ]