Configures store-and-forward facility
Product | Command type |
---|---|
MultiSite | Administrative tool |
Platform |
---|
Windows |
The MultiSite Control Panel controls operation of the MultiSite store-and-forward facility on each host. MultiSite installation creates registry keys in which all these entries are defined. In some cases, the corresponding store-and-forward operation fails if a parameter is not defined, and in other cases there is a hard-coded default.
The MultiSite Control Panel provides controls for setting the configuration parameters described in the following sections.
Controls the splitting of individual logical packets into multiple physical packets. This value specifies the maximum size for a physical packet file. Limiting the size of physical packets can improve the reliability of packet delivery in some networks. To specify no limit, use 0 (zero).
This value is used by the following commands (unless you also specify -maxsize):
mkreplica -fship
mkreplica -ship
syncreplica -fship
syncreplica -ship
When you invoke mkreplica or syncreplica with -out, this value is not used, and you must use -maxsize to limit the packet size.
Specifies the electronic mail address of the user to be notified when any of these events occur:
A packet (on the local host) that has expired is returned to its sending host.
A packet that was not delivered to its next hop is returned to its sending host.
syncreplica -import finds a replica-creation packet.
To enable e-mail notification:
Make sure the SMTP Host box in the ClearCase Control Panel specifies a valid host. (This box is located on the Options tab.)
Enter an e-mail address in the Administrator Email box in the MultiSite Control Panel. You can specify only one address.
Specifies the name of a storage class. You can associate values for packet expiration, the storage bay, the return bay, and the receipt handler with each storage class.
Default: ClearCase MultiSite installation sets up a default storage class (-default) with predefined values. The -default class is used when you invoke the mkorder, mkreplica, syncreplica, or sync_export_list command with the -fship or -ship option and do not specify a storage class. You can change the values associated with the -default class.
NOTE: The name for the ClearQuest MultiSite storage class must be cq_default.
Specifies the expiration period (in days) for shipping orders generated in the associated storage class. This period begins at the time the shipping order is generated. If a packet cannot be delivered to all its specified destinations in the specified number of days, the packet is returned to the original sending host and a message is sent to the address specified in the Administrator Email box. If e-mail notification is not enabled, a message is written to the Windows Event Viewer.
A value of 0 (zero) specifies no expiration; delivery is reattempted indefinitely.
This setting is overridden by the -pexpire option to syncreplica or mkreplica.
The shipping_server program does not retry delivery of packets. The Packet Expiration specification is useful only if you set up a host to periodically attempt delivery of any undelivered packets. To set up redelivery attempts, use the schedule command to invoke sync_export_list -poll, which invokes shipping_server -poll. For more information, see the schedule reference page in the Command Reference.
Default: When the Use Default Expiration check box is selected, the storage class uses the packet expiration value associated with the -default class. (This value is not shown in the Packet Expiration box; you must display the -default class to determine the value.) When MultiSite is installed for the first time, the Packet Expiration value for the -default class is set to 14 days.
Defines the location of a storage bay, a directory that holds the outgoing and incoming update packets and shipping orders of a particular storage class.
Packets placed in a storage bay on an NTFS file system inherit the Windows ACL on the storage bay. Define ACLs on the storage and return bays to enable successful execution of MultiSite commands to process the packets, and to guard against unauthorized access. (If you use the schedule command to invoke sync_export_list -poll on shipping_server, the group ClearCase must have read and write permissions on all storage directories.) Packets stored on FAT file systems have no protections.
Before using the store-and-forward facility, make sure that the disk partition where the ccase-home-dir\var\shipping directory is created has sufficient free space for anticipated replica-creation and update packets. The amount of available space on the disk partition where the shipping and return bays are located must be at least twice as big as the largest packet that will be stored in the bays. This is because there may be two copies of the same packet in the bay at one time: one on its way to another destination, and another waiting to be applied to the replica on the host.
Default: When MultiSite is installed for the first time, the storage bay associated with the -default storage class is ccase-home-dir\var\shipping\ms_ship. This bay contains subdirectories named incoming and outgoing, which hold incoming and outgoing packets. Shipping operations look for packets in these subdirectories.
NOTE: When you create a new storage class, the storage bay and return bay that you specify are created, along with the incoming and outgoing directories within the bays.
Defines a return bay (directory) to hold incoming or outgoing packets in the process of being returned to their origin because they could not be delivered to all specified destinations.
Packets placed in a return bay inherit the ACL on the directory.
Default: When MultiSite is installed for the first time, the return bay associated with the -default storage class is ccase-home-dir\var\shipping\ms_rtn. This bay contains subdirectories named incoming and outgoing, which hold incoming and outgoing packets. Shipping operations look for packets in these subdirectories.
Specifies a batch file or program for the shipping_server to run when a packet is received for the storage class. You can use this instead of scheduling executions of sync_receive. By default, no file is specified. We recommend that you specify ccase-home-dir\config\scheduler\tasks\sync_receive in the Receipt Handler Path box.
For each packet that is received, shipping_server does the following:
Reads the entries in the MultiSite Control Panel to find the appropriate Receipt Handler value for the packet.
If the packet is associated with a storage class and there is a Receipt Handler value for that storage class, shipping_server uses the specified batch file or program
If the packet is not associated with a storage class and there is a Receipt Handler value for the -default storage class, shipping_server uses the batch file or program specified for -default
Invokes the receipt handler, as follows:
script-pname [ -d·ata packet-file-pname ] [ -a·ctual shipping-order-pname ]
[ -s·class storage-class ] -o·rigin hostname
script-pname | Script specified in the RECEIPT-HANDLER entry. |
-d·ata packet-file-pname | Location of the packet. This parameter is used only when the packet is destined for this host. |
-a·ctual shipping-order-pname | Location of the shipping order. This parameter is used only when the packet is destined for another host. |
-s·class storage-class | Storage class associated with the packet. This parameter is used only if the packet was associated with a storage class when it was created. |
-o·rigin hostname | Host name of the machine from which the packet was first sent. |
NOTE: If a packet is destined for both the local host and another host, both the -data and -actual parameters are used. The packet is imported at the replica on the host, then forwarded to its next destination.
The Routing Information settings control the network routing of packets.
The host specified here is the next destination for packets whose final destination is any of the host names specified in the Destination Hostnames list. This host is responsible for delivery of the packet to its destinations. You can specify a host using either its host name (which must be usable by hosts in different domains) or its numeric IP address.
Packets destined for any host listed in this field are sent to the host specified in the Next Routing Hop box. The value -default as the Destination Hostname accommodates all hosts that are not associated with a routing hop. You can specify a host using either its host name (which must be usable by hosts in different domains) or its numeric IP address.
Feedback on the documentation in this site? We welcome any comments!
Copyright © 2001 by Rational Software Corporation. All rights reserved. |