ds-replcheck.1 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163
  1. .TH DS-REPLCHECK 1 "July 22, 2022"
  2. .SH NAME
  3. ds-replcheck
  4. .SH SYNOPSIS
  5. .B ds-replcheck
  6. [-h] [-v] {online,offline,state} ...
  7. .SH DESCRIPTION
  8. Replication Comparison Tool (v2.0). This script can be used to compare two
  9. .br
  10. replicas to see if they are in sync.
  11. .SH OPTIONS
  12. .SS
  13. \fBSub-commands\fR
  14. .TP
  15. \fBds-replcheck\fR \fI\,online\/\fR
  16. Compare two online replicas for differences
  17. .TP
  18. \fBds-replcheck\fR \fI\,offline\/\fR
  19. Compare two replication LDIF files for differences (LDIF file generated by 'db2ldif -r')
  20. .TP
  21. \fBds-replcheck\fR \fI\,state\/\fR
  22. Get the general state of replication between two replicas
  23. .SH OPTIONS 'ds-replcheck state'
  24. usage: ds-replcheck online [-h] -m URL -r URL -b SUFFIX -D BINDDN
  25. [-w BINDPW] [-W] [-y PASS_FILE] [-Z CERTDIR]
  26. .TP
  27. \fB\-m\fR \fI\,URL\/\fR, \fB\-\-supplier\-url\fR \fI\,URL\/\fR
  28. The LDAP URL for the Supplier server
  29. .TP
  30. \fB\-r\fR \fI\,URL\/\fR, \fB\-\-replica\-url\fR \fI\,URL\/\fR
  31. The LDAP URL for the Replica server
  32. .TP
  33. \fB\-b\fR \fI\,SUFFIX\/\fR, \fB\-\-suffix\fR \fI\,SUFFIX\/\fR
  34. Replicated suffix
  35. .TP
  36. \fB\-D\fR \fI\,BINDDN\/\fR, \fB\-\-bind\-dn\fR \fI\,BINDDN\/\fR
  37. The Bind DN
  38. .TP
  39. \fB\-w\fR \fI\,BINDPW\/\fR, \fB\-\-bind\-pw\fR \fI\,BINDPW\/\fR
  40. The Bind password
  41. .TP
  42. \fB\-W\fR, \fB\-\-prompt\fR
  43. Prompt for the bind DN password
  44. .TP
  45. \fB\-y\fR \fI\,PASS_FILE\/\fR, \fB\-\-pass\-file\fR \fI\,PASS_FILE\/\fR
  46. A text file containing the clear text password for the bind dn
  47. .TP
  48. \fB\-Z\fR \fI\,CERTDIR\/\fR, \fB\-\-cert\-dir\fR \fI\,CERTDIR\/\fR
  49. The certificate database directory for secure connections
  50. .SH OPTIONS 'ds-replcheck online'
  51. usage: ds-replcheck online [-h] -m URL -r URL --rid RID -b SUFFIX -D BINDDN
  52. [-w BINDPW] [-W] [-y PASS_FILE] [-l LAG] [-c]
  53. [-Z CERTDIR] [-i IGNORE] [-p PAGESIZE] [-o FILE]
  54. .TP
  55. \fB\-m\fR \fI\,URL\/\fR, \fB\-\-supplier\-url\fR \fI\,MRL\/\fR
  56. The LDAP URL for the Supplier server
  57. .TP
  58. \fB\-r\fR \fI\,URL\/\fR, \fB\-\-replica\-url\fR \fI\,URL\/\fR
  59. The LDAP URL for the Replica server
  60. .TP
  61. \fB\-b\fR \fI\,SUFFIX\/\fR, \fB\-\-suffix\fR \fI\,SUFFIX\/\fR
  62. Replicated suffix
  63. .TP
  64. \fB\-D\fR \fI\,BINDDN\/\fR, \fB\-\-bind\-dn\fR \fI\,BINDDN\/\fR
  65. The Bind DN
  66. .TP
  67. \fB\-w\fR \fI\,BINDPW\/\fR, \fB\-\-bind\-pw\fR \fI\,BINDPW\/\fR
  68. The Bind password
  69. .TP
  70. \fB\-W\fR, \fB\-\-prompt\fR
  71. Prompt for the bind DN password
  72. .TP
  73. \fB\-y\fR \fI\,PASS_FILE\/\fR, \fB\-\-pass\-file\fR \fI\,PASS_FILE\/\fR
  74. A text file containing the clear text password for the bind dn
  75. .TP
  76. \fB\-l\fR \fI\,LAG\/\fR, \fB\-\-lag\-time\fR \fI\,LAG\/\fR
  77. The amount of time to ignore inconsistencies (default 300 seconds)
  78. .TP
  79. \fB\-c\fR, \fB\-\-conflicts\fR
  80. Display verbose conflict entry information
  81. .TP
  82. \fB\-Z\fR \fI\,CERTDIR\/\fR, \fB\-\-cert\-dir\fR \fI\,CERTDIR\/\fR
  83. The certificate database directory for secure connections
  84. .TP
  85. \fB\-i\fR \fI\,IGNORE\/\fR, \fB\-\-ignore\fR \fI\,IGNORE\/\fR
  86. Comma separated list of attributes to ignore
  87. .TP
  88. \fB\-p\fR \fI\,PAGESIZE\/\fR, \fB\-\-page\-size\fR \fI\,PAGESIZE\/\fR
  89. The paged\-search result grouping size (default 500 entries)
  90. .TP
  91. \fB\-o\fR \fI\,FILE\/\fR, \fB\-\-out\-file\fR \fI\,FILE\/\fR
  92. The output file
  93. .SH OPTIONS 'ds-replcheck offline'
  94. usage: ds-replcheck offline [-h] -m LDIF_FILE -r LDIF_FILE --rid RID -b SUFFIX [-c]
  95. [-i IGNORE] [-o FILE]
  96. .TP
  97. \fB\-m\fR \fI\,LDIF_FILE\/\fR, \fB\-\-supplier\-ldif\fR \fI\,LDIF_FILE\/\fR
  98. Supplier LDIF file
  99. .TP
  100. \fB\-r\fR \fI\,LDIF_FILE\/\fR, \fB\-\-replica\-ldif\fR \fI\,LDIF_FILE\/\fR
  101. Replica LDIF file
  102. .TP
  103. \fB\-\-rid\fR \fI\,RID\/\fR
  104. The Replica Identifier (rid) for the "Supplier" server
  105. .TP
  106. \fB\-b\fR \fI\,SUFFIX\/\fR, \fB\-\-suffix\fR \fI\,SUFFIX\/\fR
  107. Replicated suffix
  108. .TP
  109. \fB\-c\fR, \fB\-\-conflicts\fR
  110. Display verbose conflict entry information
  111. .TP
  112. \fB\-i\fR \fI\,IGNORE\/\fR, \fB\-\-ignore\fR \fI\,IGNORE\/\fR
  113. Comma separated list of attributes to ignore
  114. .TP
  115. \fB\-o\fR \fI\,FILE\/\fR, \fB\-\-out\-file\fR \fI\,FILE\/\fR
  116. The output file
  117. .TP
  118. \fB\-v\fR, \fB\-\-verbose\fR
  119. Verbose output
  120. .SH AUTHOR
  121. ds-replcheck was written by the 389 Project.
  122. .SH "REPORTING BUGS"
  123. Report bugs to https://github.com/389ds/389-ds-base/issues/new
  124. .SH COPYRIGHT
  125. Copyright \(co 2022 Red Hat, Inc.