mirror of https://github.com/OpenIdentityPlatform/OpenDJ.git

Mark Craig
05.33.2011 a37053aee4fdafae38054a8c3d02cac335b6bbc6
opendj3/src/main/docbkx/admin-guide/chap-monitoring.xml
@@ -91,11 +91,19 @@
  OpenDMK, provided separately due to licensing restrictions. Once you have
  installed OpenDMK, you can set up a connection handler for SNMP.</para>
  
  <screen>$ dsconfig -p 4444 -h `hostname` -D "cn=Directory Manager" -w password
 create-connection-handler --handler-name "SNMP Connection Handler"
 --type snmp --set enabled:true --set listen-port:11161
 --set trap-port:11162 -X -n
 --set opendmk-jarfile:<replaceable>OpenDMK-install-dir</replaceable>/lib/jdmkrt.jar</screen>
  <screen>$ dsconfig
 -p 4444
 -h `hostname`
 -D "cn=Directory Manager"
 -w password
 create-connection-handler
 --handler-name "SNMP Connection Handler"
 --type snmp
 --set enabled:true
 --set listen-port:11161
 --set trap-port:11162
 --set opendmk-jarfile:<replaceable>OpenDMK-install-dir</replaceable>/lib/jdmkrt.jar
 -X -n</screen>
 </section>
 <section xml:id="jmx-monitoring">
@@ -109,24 +117,36 @@
  <command>dsconfig</command> command to configure the JMX connection
  handler.</para>
  
  <screen>$ dsconfig -p 4444 -h `hostname` -D "cn=Directory Manager" -w password
 set-connection-handler-prop --handler-name "JMX Connection Handler"
 --set enabled:true -X -n</screen>
  <screen>$ dsconfig
 -p 4444
 -h `hostname`
 -D "cn=Directory Manager"
 -w password
 set-connection-handler-prop
 --handler-name "JMX Connection Handler"
 --set enabled:true
 -X -n</screen>
  <para>By default, no users have privileges to access the JMX connection. The
  following command adds JMX privileges for Directory Manager.</para>
  <screen>$ dsconfig -p 4444 -h `hostname` -D "cn=Directory Manager" -w password
 set-root-dn-prop --add default-root-privilege-name:jmx-notify
  <screen>$ dsconfig
 -p 4444
 -h `hostname`
 -D "cn=Directory Manager"
 -w password
 set-root-dn-prop
 --add default-root-privilege-name:jmx-notify
 --add default-root-privilege-name:jmx-read
 --add default-root-privilege-name:jmx-write -X -n</screen>
 --add default-root-privilege-name:jmx-write
 -X -n</screen>
  <para>You must also configure security to login remotely. Good luck.</para>
  
  <para>Alternatively, you can connect to a local server process by using the
  server process identifier.</para>
  <screen>$ cat ../logs/server.pid
  <screen>$ cat ../logs/server.pid
3363
$ jvisualvm --openpid 3363 &amp;</screen>
 </section>
@@ -174,13 +194,17 @@
  administration port, and so can connect to both local and remote
  servers.</para>
  
  <screen>$ manage-tasks -h opendj.example.com -p 4444 -D "cn=Directory Manager"
 -w password -X -n
  <screen>$ manage-tasks
 -h opendj.example.com
 -p 4444
 -D "cn=Directory Manager"
 -w password
 -X -n
  ID                         Type    Status
  --------------------------------------------------------
  example                    Backup  Recurring
  example-20110623030000000  Backup  Waiting on start time</screen>
ID                         Type    Status
--------------------------------------------------------
example                    Backup  Recurring
example-20110623030000000  Backup  Waiting on start time</screen>
 </section>
 <section xml:id="logging">
@@ -290,22 +314,41 @@
  events. Yet alert notifications are not enabled by default. You can use
  the <command>dsconfig</command> command to enable alert notifications.</para>
  
  <screen>$ dsconfig -p 4444 -h `hostname` -D "cn=Directory Manager" -w password
 set-alert-handler-prop --handler-name "JMX Alert Handler"
 --set enabled:true -X -n</screen>
  <screen>$ dsconfig
 -p 4444
 -h `hostname`
 -D "cn=Directory Manager"
 -w password
 set-alert-handler-prop
 --handler-name "JMX Alert Handler"
 --set enabled:true
 -X -n</screen>
  <para>OpenDJ can also send mail over SMTP instead of JMX notifications.
  Before you set up the SMTP-based alert handler, you must identify an SMTP
  server to which OpenDJ sends messages.</para>
  
  <screen>$ dsconfig -p 4444 -h `hostname` -D "cn=Directory Manager" -w password
 set-global-configuration-prop --set smtp-server:smtp.example.com -X -n
$ dsconfig -p 4444 -h `hostname` -D "cn=Directory Manager" -w password
 create-alert-handler --handler-name "SMTP Alert Handler" --type smtp
  <screen>$ dsconfig
 -p 4444
 -h `hostname`
 -D "cn=Directory Manager"
 -w password
 set-global-configuration-prop
 --set smtp-server:smtp.example.com
 -X -n
$ dsconfig
 -p 4444
 -h `hostname`
 -D "cn=Directory Manager"
 -w password
 create-alert-handler
 --handler-name "SMTP Alert Handler"
 --type smtp
 --set enabled:true
 --set message-subject: "OpenDJ Alert, Type: %%alert-type%%, ID: %%alert-id%%"
 --set message-body:"%%alert-message%%"
 --set recipient-address:kvaughan@example.com
 --set sender-address:opendj@example.com -X -n</screen>
 --set sender-address:opendj@example.com
 -X -n</screen>
 </section>
</chapter>