Generates and sends update packets
sync_export_list [ –c·ompress ] [ –lo·gdir log-directory ]
[ –f·ship | –sh·ip ] [ –lockwait minutes ] [ –q·uiet mode ]
[ –wo·rkdir directory ] [ –m·axsize max-packet-size ]
[ –sc·lass storage-class ] [ –u·pdate ] [ –li·mit num-packets ]
[ –t·race ] [ –p·oll ] [ –i·terate num-tries [ –wa·it num-seconds ] ]
{ –a·ll | –r·eplicas replica-list [ script-file ] | script-file }
sync_export_list –p·oll [ –sc·lass storage-class ]
sync_export_list –h·elp
On UNIX, sync_export_list is located in ccase-home-dir/config/scheduler/tasks. On Windows, sync_export_list is located in ccase-home-dir\config\scheduler\tasks.
sync_export_list generates update packets for one or more replicas. You can specify options for packet generation and transport on the command line, in a script file, or by using a combination of the command line and a script file.
You can run sync_export_list manually or run it automatically with the schedule command. For more information, see the schedule reference page in the Command Reference.
By default, synchronization exports fail if the VOB is locked. To allow sync_export_list to retry an export when it encounters a lock, use the –lockwait option, which specifies the amount of time (in minutes) for sync_export_list to keep trying to write to the VOB. During that time, sync_export_list retries the write operation every minute. If the time elapses and the VOB is still locked, sync_export_list exits with an error.
The –lockwait option sets the CLEARCASE_VOBLOCKWAIT environment variable in the script’s environment. If –lockwait is not used, sync_export_list ignores CLEARCASE_VOBLOCKWAIT if it is set outside the script’s environment.
Note: sync_export_list waits only if it detects the lock before it starts processing operations. If an administrator locks the VOB during operation processing, sync_export_list exits with an error.
You can modify the behavior of the sync_export_list script by creating a file named MSimport_export.conf and setting values in it. On UNIX, create the file in the directory /var/adm/rational/clearcase/config. On Windows, create the file in the directory ccase-home-dir\var\config.
The file can include the following export setting:
disable_export_locking = 1
Disables use of the export lockfile, allowing multiple exports from a single replica to run simultaneously. Setting the value to 0 (default) enables use of the lockfile.
This setting and the –lockwait option are not related. This setting configures use of the lock created by the sync_export_list process to prevent interference among export processes, and the –lockwait option handles VOB locks.
sync_export_list fails if another sync_export_list process is exporting data from the same replica, unless export locking is disabled (see Configuration File). This failure prevents interference among export processes. To retry an export, use the –iterate and –wait options.
To display informational messages, specify the –trace option on the command line.
To display all debugging print statements, set the TRACE_SUBSYS environment variable to the value sync_export_list.
sync_export_list creates a log file during execution. This log file is deleted unless sync_export_list fails or you use –trace or set TRACE_SUBSYS.
By default, log files are stored in the /var/adm/rational/clearcase/log/sync_logs directory on UNIX and the ccase-home-dir\var\log directory on Windows. The file name includes the process ID of the sync_export_list command and the time (in UTC format) at which you ran the command.
The Weekly Log Scrubbing job installed with ClearCase deletes log files in /var/adm/rational/clearcase/log/sync_logs (UNIX) or ccase-home-dir\var\log (Windows) that have the prefix send or recv and the suffix _log and are more than 14 days old.
Identities: You must have one of the following identities:
With –poll, you must have write and execute permissions on the directory containing the shipping orders, and on UNIX, you must own the shipping order files or be root.
Locks: An error occurs if one or more of these objects are locked: VOB.
Mastership: No mastership restrictions.
–h·elp
Prints help about command options.
–c·ompress
Compresses update packets using Gzip compression.
–lo·gdir log-directory
Writes log file to log-directory. You must have write access to log-directory.
–f·ship
–sh·ip
By default, sync_export_list ships packets immediately (–fship). To store packets in the shipping bay, specify –ship.
–lockwait minutes
Number of minutes for the script to keep retrying to write to the VOB, if the VOB is locked.
–q·uiet mode
Suppresses messages sent to STDOUT. mode can have the following values:
0
|
(default) Prints errors, warnings, and informational messages
|
1
|
Prints errors and warnings
|
2
|
Suppresses all messages
|
–wo·rkdir directory
Writes temporary files to directory. directory must exist and be writable by the user who enters the sync_export_list command.
–m·axsize max-packet-size
Maximum size for a physical packet, expressed as a number followed by a single letter. For example:
If you do not specify –maxsize, sync_export_list uses the value specified in the shipping.conf file (UNIX) or MultiSite Control Panel (Windows). To specify no size limit, use –maxsize 0.
–sc·lass storage-class
Uses the shipping parameters associated with storage-class. If you do not specify –sclass, sync_export_list uses the parameters for the default storage class. You can create or modify storage classes in the shipping.conf file on UNIX or the MultiSite Control Panel on Windows.
–u·pdate
For each current replica, queries the sibling replicas for their actual states and updates the current replica’s epoch table accordingly, and then generates update packets. The sites must have IP connections.
–li·mit num-packets
Limits the number of packets syncreplica generates. If you also specify –maxsize, each packet is no larger than max-packet-size; otherwise, each packet is no larger than the value specified in the shipping.conf file (UNIX) or MultiSite Control Panel (Windows). Use this option when the disk space for your shipping bay or staging area is limited, or when you are creating packets to be placed on magnetic tape (UNIX) or diskettes.
–t·race
Lists command-line options you specified, displays commands as they are executed, displays a success or failure message, and forces sync_export_list to keep its log file.
–p·oll
Executes shipping_server –poll before exporting any data. If you also specify –sclass, shipping_server –poll processes only the shipping orders for the specified storage class.
–i·terate num-tries –wa·it num-seconds
Tries a maximum of num-tries times to complete all exports successfully, and waits num-seconds seconds between tries. By default, sync_export_list does not retry failed exports (–iterate 1). If you specify –iterate without –wait, sync_export_list waits 30 seconds between tries.
–a·ll
Generates update packets from all replicas on the current host to all sibling replicas in their respective families.
–r·eplicas replica-list
Generates update packets for the replicas you specify in replica-list. You can specify replica-list in any of the following forms:
Examples:
You can specify only one VOB family with –replicas. To specify multiple VOB families, use multiple replicas: lines in a script-file. You must specify at least one replica, either on the command line, or in a script-file.
script-file
Path to file that contains directives for sync_export_list. You must specify this argument last on the command line. You can include the following directives:
sync_export_list processes all directives in the order listed in script-file. Rules for directives:
For example, in the following script file the directives sclass:daily and limit:10 apply to both replicas directives.
compress
ship
maxsize:2g
sclass:daily
update
limit:10
replicas:rep1@\myvob
nocompress
fship
maxsize:1g
noupdate
replicas:rep2@\myvob,rep3
In these examples, the lines are broken for readability. You must enter each command on a single physical line.
/opt/rational/clearcase/config/scheduler/tasks/sync_export_list –all SUCCESSFUL COMPLETION: log file removed.
Script file:
compress fship sclass:tests noupdate replicas:sanfran_hub@\tests,sydney sclass:dev update replicas:\dev
Job definition:
Job.Begin Job.Id: 25 Job.Name: "Sync Export tests dev" Job.Description.Begin: Every midnight, export update packets to replicas in VOB families \tests and \dev. Job.Description.End: Job.Schedule.Daily.Frequency: 1 Job.Schedule.FirstStartTime: 01:00:00 Job.DeleteWhenCompleted: FALSE Job.Task: 13 Job.Args: -quiet 1 \\shinjuku\scripts\sync_export_tests_dev Job.End
/opt/rational/clearcase/config/scheduler/tasks/sync_export_list –ship –maxsize 500k –trace –replicas /vobs/dev command options specified or defaulted: compress: 0 logdir: storage-class: workdir: maxpacket: 500k limit: 0 all: 0 fship: 0 ship: 1 poll: 0 lockwait: 0 minutes retries: 1 times, wait 30 seconds script: CMD: bin/cleartool lsvob /vobs/dev > /dev/null vob: /vobs/dev replicas: bangalore buenosaires CMD: bin/multitool syncreplica -export -maxsize 500k -ship replica:bangalore@/vobs/dev >&2 CMD: bin/multitool syncreplica -export -maxsize 500k -ship replica:buenosaires@/vobs/dev >&2 SUCCESSFUL COMPLETION: see log file at: "/var/adm/rational/clearcase/log/sync_logs/send-000815-183301Z-6043 _log".
/var/adm/rational/clearcase/log/sync_logs
/var/adm/rational/clearcase/config/shipping.conf
ccase-home-dir/config/scheduler/multisite.schedule
ccase-home-dir\var\log
mkorder, MultiSite Control Panel, shipping.conf, shipping_server, sync_receive, syncreplica