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 NS-INACTIVATE.PL 8 "Mar 5, 2013"
6
.\" Please adjust this date whenever revising the manpage.
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)
19
ns-inactivate.pl - Directory Server perl script for inactivating entries.
21
ns-inactivate.pl [-Z serverID] [-D rootdn] { -w password | -w - | -j filename } [-p port] [-h host] [-P protocol] -I DN
23
Inactivates, and consequently locks, an entry or group of entries.
25
A summary of options is included below:
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.
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.
35
.B \fB\-w\fR \fIpassword\fR
40
Prompt for the rootdn password.
42
.B \fB\-j\fR \fIpassword filename\fR
43
The name of the file that contains the root DN password.
45
.B \fB\-P\fR \fIProtocol\fR
46
The connection protocol to connect to the Directory Server. Protocols are STARTTLS, LDAPS, LDAPI, and LDAP.
47
If this option is skipped, the most secure protocol that is available is used. For LDAPI, AUTOBIND is also
48
available for the root user.
51
Specifies the entry DN or role DN to deactivate.
53
.B \fB\-h\fR \fIhost\fR
54
Host name of the Directory Server.
56
.B \fB\-p\fR \fIport\fR
57
Port number of the Directory Server.
60
ns-inactivate.pl -Z instance2 -D 'cn=directory manager' -j /tmp/passwd.txt -P STARTTLS -I 'uid=user,ou=people,dc=example,dc=com'
62
Note: security must be enabled to use protocol STARTTLS. If STARTTLS is not available it will default to next strongest/available protocol automatically.
64
Exit status is zero if no errors occur. Errors result in a
65
non-zero exit status and a diagnostic message being written
68
ns-inactivate.pl was written by the 389 Project.
70
Report bugs to http://bugzilla.redhat.com.
72
Copyright \(co 2013 Red Hat, Inc.