README.md

   1 # OCF Resource agent of PPP Connection
   2
   3 ## Example
   4
   5 Here is an example that connect `dsl-provider`
   6
   7 ```
   8 primitive ppp-myisp PPPConnection \
   9         params isp=dsl-provider \
  10         op monitor interval=30 timeout=10 on-fail=restart \
  11         op start timeout=60 interval=0 on-fail=restart \
  12         op stop timeout=60 interval=0 \
  13         meta failure-timeout=300
  14 ```
  15
  16 ## Option parameters
  17
  18 * **isp** - ISP name to connect. This will be passed to pon/poff, and pppd will be monitored with specified isp. Default is `provider`.
  19 * **expected_ip4** - Expected IPv4 address for the ppp connection. If you specify this parameter, startup and monitor proecesses will wait the address associated with ppp interface.
  20 * **expected_ip6** - Expected IPv6 local address (same as v4).
  21 * **ip_wait_sec** - Resource will wait specified seconds for ppp interface aquires expected IP address provided by `expected_ip4` or `expected_ip6`. Default is 30.
  22 * **pon_retries** - Retry limit for pon. Default is 30.
  23 * **pon_wait_sec** - Resource will wait specified seconds for ppp connection up. When it's exceeded, retry to run pon.
  24 * **poff_wait_sec** - Resource will wait specified seconds for ppp connection down. When it's exceeded, retry to run poff.
  25
  26 ## License/Copyright
  27
  28 This script has been distributed under GNU General Public License version 2 (GPL2).
  29
  30 Copyright (c) 2017 Tatsuki Sugiura <sugi@nemui.org> and OSDN Corporation <tech@osdn.jp>.
  31
  32