fixup-linkedattrs.pl.8 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. .\" Hey, EMACS: -*- nroff -*-
  2. .\" First parameter, NAME, should be all caps
  3. .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
  4. .\" other parameters are allowed: see man(7), man(1)
  5. .TH FIXUP-LINKEDATTRS.PL 8 "Mar 5, 2013"
  6. .\" Please adjust this date whenever revising the manpage.
  7. .\"
  8. .\" Some roff macros, for reference:
  9. .\" .nh disable hyphenation
  10. .\" .hy enable hyphenation
  11. .\" .ad l left justify
  12. .\" .ad b justify to both left and right margins
  13. .\" .nf disable filling
  14. .\" .fi enable filling
  15. .\" .br insert line break
  16. .\" .sp <n> insert n+1 empty lines
  17. .\" for manpage-specific macros, see man(7)
  18. .SH NAME
  19. fixup-linkedattrs.pl - Directory Server perl script for creating a "fixup" task for linked attributes.
  20. .SH SYNOPSIS
  21. fixup-linkedattrs.pl [\-Z serverID] [\-D rootdn] { \-w password | \-w \- | \-j filename } [\-l linkDN] [\-P protocol] [\-v] [\-h]
  22. .SH DESCRIPTION
  23. Creates the managed attributes in the user entries once the linking plug-in instance is created or updates the managed attributes to keep everything in sync after operations like replication or synchronization.
  24. .SH OPTIONS
  25. A summary of options is included below:
  26. .TP
  27. .B \fB\-Z\fR \fIServer Identifier\fR
  28. The server ID of the Directory Server instance. If there is only
  29. one instance on the system, this option can be skipped.
  30. .TP
  31. .B \fB\-D\fR \fIRoot DN\fR
  32. The Directory Manager DN, or root DN. If not specified, the script will
  33. search the server instance configuration for the value.
  34. .TP
  35. .B \fB\-w\fR \fIpassword\fR
  36. The rootdn password.
  37. .TP
  38. .B \fB\-w -\fR
  39. .br
  40. Prompt for the rootdn password.
  41. .TP
  42. .B \fB\-j\fR \fIpassword filename\fR
  43. The name of the file that contains the root DN password.
  44. .TP
  45. .B \fB\-l\fR \fIlinkDN\fR
  46. Gives the target DN for which to update the linked attributes. If this is not set, then the default is to update all linked and managed attributes for the entire subtree or directory tree.
  47. .TP
  48. .B \fB\-P\fR \fIProtocol\fR
  49. The connection protocol to connect to the Directory Server. Protocols are STARTTLS, LDAPS, LDAPI, and LDAP.
  50. If this option is skipped, the most secure protocol that is available is used. For LDAPI, AUTOBIND is also
  51. available for the root user.
  52. .TP
  53. .B \fB\-v\fR
  54. .br
  55. Display verbose output
  56. .TP
  57. .B \fB\-h\fR
  58. .br
  59. Display usage
  60. .SH EXAMPLE
  61. .TP
  62. fixup-linkedattrs.pl \-Z instance1 \-D 'cn=directory manager' \-w password \-P STARTTLS
  63. Note: security must be enabled to use protocol STARTTLS. If STARTTLS is not available it will default to next strongest/available protocol automatically.
  64. .TP
  65. fixup-linkedattrs.pl \-w password \-l 'ou=people,dc=example,dc=com'
  66. .SH DIAGNOSTICS
  67. Exit status is zero if no errors occur. Errors result in a
  68. non-zero exit status and a diagnostic message being written
  69. to standard error.
  70. .SH AUTHOR
  71. fixup-linkedattrs.pl was written by the 389 Project.
  72. .SH "REPORTING BUGS"
  73. Report bugs to https://fedorahosted.org/389/newticket.
  74. .SH COPYRIGHT
  75. Copyright \(co 2013 Red Hat, Inc.