vfradmin - administer File Replicator (VFR) in a distributed environment

VRTSfsadv

vfradmin job create [-p tgt_port] [-s|-t] [-d 0|1] [-n] [-g cgrp_name] [-S num_socket] [-T num_threads] job_name src_addr src_mntpt tgt_addr tgt_mntpt freq

vfradmin job list [-v] [-j job_name] mntpt

vfradmin job start job_name mntpt

vfradmin job sync job_name mntpt

vfradmin job stop [-n] job_name mntpt

vfradmin job abort job_name mntpt

vfradmin job wait job_name mntpt

vfradmin job get status job_name mntpt

vfradmin job get ckpt job_name mntpt

vfradmin job get stats [-v] [-fh] job_name mntpt

vfradmin job set srcaddr job_name mntpt src_addr

vfradmin job set tgtaddr job_name mntpt tgt_addr

vfradmin job set port -p tgt_port job_name mntpt

vfradmin job set socket nsockets job_name mntpt

vfradmin job set thread nthreads job_name mntpt

vfradmin job set dbg [-d] [-0|1] job_name mntpt

vfradmin job set fcl job_name mntpt [on|off]

vfradmin job set host job_name mntpt host

vfradmin job set freq job_name mntpt freq

vfradmin job set srcmntpt [-t tgt_mntpt] job_name newsrc_mntpt

vfradmin job set tgtmntpt [-s src_mntpt] job_name newtgt_mntpt

vfradmin job set mode [-s|-t] job_name mntpt

vfradmin job set cgrp job_name mntpt cgrp_name

vfradmin job clear cgrp job_name mntpt cgrp_name

vfradmin job destroy job_name mntpt

vfradmin job promote [-q] [-f] job_name mntpt

vfradmin job recover job_name mntpt

vfradmin job pause job_name mntpt

vfradmin job resume job_name mntpt

vfradmin cgrp create cgrp_name mntpt

vfradmin cgrp destroy cgrp_name mntpt

vfradmin cgrp list [-v] [-g cgrp_name] mntpt

vfradmin cgrp include add cgrp_name mntpt [include-path(s) | -p include-pattern(s)]

vfradmin cgrp include remove cgrp_name mntpt [include-path(s) | -p include-pattern(s)]

vfradmin cgrp exclude add cgrp_name mntpt [exclude-path(s) | -p exclude-pattern(s)]

vfradmin cgrp exclude remove cgrp_name mntpt [exclude-path(s) | -p exclude-pattern(s)]

vfradmin cgrp set mntpt cgrp_name old_mntpt new_mntpt

vfradmin sched start

vfradmin sched stop [-f]

vfradmin vxfsrepld start [-p port]

vfradmin vxfsrepld stop [-f]

The vfradmin utility lets you manage and control the file replication feature. The utility lets you view and modify the configuration of replication groups as well as control the actual replication service to start or stop replication for a replication group.

Prior to creating a replication job, you must run the scheduler daemon (vxfstaskd) and the replication target daemon (vxfsrepld).

job create	Creates a new replication job using the specified source address, source mount point, target address, target port, target mount point and frequency. A replication job must be configured on both source and target machine with the same parameters. Use the -s option on the source system and the -t option on the target system. Use -S and -T option to configure sockets and threads respectively.
job list	Prints out the list of currently configured jobs for a given mount point. On the source system mntpt is the source mount point and on target system mntpt is the target mount point.
job start	Starts the specified replication job. This command starts replication and will initiate replication after every subsequent frequency interval.
job sync	This command is similar to the jobstart command but will stop the replication job after one iteration (full or incremental) is complete. This command can be used if the primary file system is completely destroyed and needs to be recovered from the secondary site after a disaster.
job stop	Stops the specified replication job. This command waits for the currently running replication iteration along with dropping it from the regular schedule.
job abort	Aborts the specified replication job. Aborting a job will forcefully cancel the job even if it is in progress and might leave Storage Checkpoints mounted on source machine and target file system might be left in intermediate state.
job wait	Waits for the current iteration of a replication job to complete.
job get status
	Prints out the current status of the replication job, which includes the current state such as running, full-sync-prepare, failed, or any other valid states. This command is valid only on source systems.
job get ckpt
	Prints out the most recent Storage Checkpoint used by replication. If last run of replication job was successful same Storage Checkpoint name must exist on target machine with same data.
job get stats
	Prints out recent and aggregated statistics for a replication job depending on the options specified. If no options are specified, the command displays counters over the lifetime since replication was configured and started. Lifetime counters accumulate after every replication attempt, lagging by one time interval. Displayed fields are: files changed synced, directories changed synced, named attribute files synced, file data synced, errors, stats start time, last update time, and completion time. In addition to the previous list of fields, the recent statistics if printed will also display the transfer rate for the most recent replication interval. This command is only valid on source systems.
job set srcaddr
	Updates the source address of the replication job.
job set tgtaddr
	Updates the target address of the replication job.
job set port
	Updates the target port of the replication job. If this command is used the vxfsrepld daemon on the target machine should be started with the appropriate port.
job set socket
	Sets the number of sockets for the replication job.
job set thread
	Sets the number of threads for the replication job.
job set dbg	Sets the debug level for the replication job. By default, the debug level is set to 0. Setting to 1 displays diagnostic information in the job log file.
job set fcl	When used with the "on" option, modifies the replication job to use the File Change Log (FCL) feature to detect changes in the file system. When used with the "off" option, the replication job will not use the FCL feature to detect changes in the file system.
job set host
	Updates the host name where replication job can come online. The host must be same as returned by uname -n command. This is useful to failover the replication job from one cluster machine to another.
job set freq
	Updates the frequency at which the file system data is replicated.
job set srcmntpt
	Updates the replication job source mount point to newsrc_mntpt. To change the source mount point on the target system, the target mount point must be specified using the -t tgt_mntpt option. The file system must be mounted on newsrc_mntpt on the source system for the command to succeed. The replication job must not be running for this command to succeed. On the source system, the replication job must not be associated with a consistency group.
job set tgtmntpt
	Updates the replication job target mount point to newtgt_mntpt. To change the target mount point on the source system, the source mount point must be specified using the -s src_mntpt option. The file system must be mounted on newtgt_mntpt on the target system for the command to succeed. The replication job must not be running for this command to succeed. On the target system, the replication job must not be associated with a consistency group.
job set mode
	Updates the replication job mode, source or target, to the new value specified by the -s or -t option. Also swaps the source and target mount points and IP addresses.
job set cgrp
	Associates a consistency group with a replication job for a mount point.
job clear cgrp
	Disassociates a consistency group with a replication job for a mount point.
job destroy
	Removes the specified replication job from the configuration completely. This will also clean up any saved statistics related to the replication job and will also remove related Storage Checkpoints. The replication job must not be running for this command to succeed.
job promote
	Promotes the replication target to become the source. This command can be run from either the current replication source or the target. You cannot have any application I/O activity on the file system during the operation of this command. This is an interactive command. You can specify the -q option to suppress interactivity.
job recover
	Starts disaster recovery in the case of a failed node or old source coming up again, or if a completely new node is designated as the target. You can use this command to restart the replication from a new source to a new target after a disaster occurred. In the case of a new target, the file system will be empty; you must perform a full initial synchronization. In the case of an old source and the last good Storage Checkpoint is found, then you must perform an incremental synchronization. You can execute this command only on the new source.
job pause	Does not drop the replication job from the schedule but instead it just pauses the current replication process immediately without waiting for the running iteration to complete.
job resume	Does a resume of the replication process which was paused. It continues to replicate the data from the point where it was paused.
cgrp create
	Creates a consistency group using the include and exclude paths and patterns supplied. All files in the include path and pattern will be replicated and all files in the exclude path and pattern will be excluded from replication.
cgrp destroy
	Destroys a consistency group.
cgrp list	Lists all consistency groups associated with a mountpoint.
cgrp include add
	Modifies a consistency group by adding new paths to the include path list or new patterns to the include pattern list.
cgrp include remove
	Modifies a consistency group by removing paths from the include path list or patterns from include pattern list.
cgrp exclude add
	Modifies a consistency group by adding new paths to the exclude path list or new patterns to exclude pattern list.
cgrp exclude remove
	Modifies a consistency group by removing paths from the exclude path list or patterns from exclude pattern list.
cgrp set mntpt
	Updates the consistency group mount point from old_mntpt to new_mntpt. The file system must be mounted at the new_mntpt for this command to succeed.
sched start
	Starts the vxfstaskd scheduler daemon.
sched stop	Stops the vxfstaskd scheduler daemon.
vxfsrepld start
	Starts the vxfsrepld replication target daemon.
vxfsrepld stop
	Stops the vxfsrepld replication target daemon.

-d	When used with the job create command, this option sets the debug level to 0 or 1. 0 specifies that debugging is off. 1 specifies that debugging is on and will print detailed debugging messages in /var/VRTSvxfs/replication/log/job_name.log. The default debug level is 0.
	When used with the job set dbg command, this option sets the debug level to 0 or 1. 0 specifies that debugging is off. 1 specifies that debugging is on and will print detailed debugging messages in the /var/VRTSvxfs/replication/log/job_name.log file.
-f	When used with the sched stop command, this option aborts all the replication jobs that are currently scheduled. Specifying this option might leave the file system Storage Checkpoints mounted and might leave the target file system in an intermediate state.
	When used with the vxfsrepld stop command, all in progress replication jobs are aborted. This might result in a file system in an intermediate state.
	When used with the job promote keyword, the command forces a failover of the application on the target in the event of a disaster. You will suffer some data loss. The role of the job on the target is the source, but the replication will not start as there is no target available. You must execute this command on the target node.
	When used with the job get stats command, this option reports data related to the files transferred. The data includes the number of files, the total amount of data replicated.
-g	When used with the job create command, this option specifies the consistency group to be replicated. Only files specified in the consistency group are replicated. If the option is not used, the entire file system is replicated.
	When used with the cgrp list command, this option displays only information related to the named consistency group.
-h	When used with the job get stats command, this option formats the file data synced field in human readable format. This option must be specified with the -f option.
-j	When used with the job list command, this option displays only information related to the named replication job.
-n	When used with the job stop command, this option initiates the replication job stop without waiting for it to complete.
	When used with the job create command, this option will not use the File Change Log (FCL) feature to detect the changes in the file system for replication. If FCL is turned off, VFR will not enable FCL.
-p	When used with the vxfsrepld start command, this option specifies the port on which the vxfsrepld daemon will listen for the incoming connection. .IP When used with the job create command, this option specifies the target port. If the target port is not specified, the default port 56987 is used. .IP When used with the cgrp include add, cgrp include remove, cgrp exclude add and cgrp exclude remove commands, this option specifies that the value to be added or removed is a pattern rather than a path. Each instance of this option takes only a single pattern, but the option may be provided multiple times on a single command line for multiple patterns.
-q	Suppresses interactive prompting.
-T	When used with the job create command, this option specifies that the replication job is being created or configured with specified number of threads on the source system. Without this option, by default 8 Threads are configured with the Job. The number of threads configured with this option should be in the range of 1 to 64.
-S	When used with the job create command, this option specifies that the replication job is being created or configured with specified number of sockets on the source system. Without this option, by default 8 Sockets are configured with the Job. The number of sockets configured with this option should be in the range of 2 to 64.
-s	When used with the job create and job set mode command, this option specifies that the replication job is being created or updated on the source system.
	When used with the job set tgtmntpt command, this option specifies the mount point of the source file system when updating the replication job target mount point.
-t	When used with the job create and job set mode command, this option specifies that the replication job is being created or updated on the target system.
	When used with the job set srcmntpt command, this option specifies the mount point of the target file system when updating the replication job source mount point.
-v	When used with the job list command, this option prints the current configuration, which includes the mode, source mount point, target mount point, frequency, and other configuration information. Also it will display number of sockets and threads the job is configured with. .IP When used with the job get stats command, this option displays the most recent replication interval statistics. .IP When used with the cgrp list command, this option displays all the details for the consistency group.

/var/VRTSvxfs/replication/log	Directory containing replication log files.
/var/VRTSvxfs/replication/diag	Directory containing core dumps if ulimit is set appropriately before daemons are started.

fsckpt_restore(1M), fsckpt_adm(1M)