From db0fc9786cd56e31197b2322950d131fb3af76b2 Mon Sep 17 00:00:00 2001 From: Tatsuki Sugiura Date: Wed, 30 Aug 2017 16:42:09 +0900 Subject: [PATCH] Add README. --- .gitignore | 5 +++++ PPPConnection | 4 ++-- README.md | 31 +++++++++++++++++++++++++++++++ 3 files changed, 38 insertions(+), 2 deletions(-) create mode 100644 .gitignore create mode 100644 README.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..110dc5b --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +*~ +*.bak +*.rej +*.orig +.*.swp diff --git a/PPPConnection b/PPPConnection index 3c34cf8..ad0829a 100755 --- a/PPPConnection +++ b/PPPConnection @@ -3,7 +3,7 @@ # OCF resource agent for PPP connection # # License: GNU General Public License version 2 (GPL2) -# (c) 2017 Tatsuki Sugiura , +# (c) 2017 Tatsuki Sugiura and OSDN Corporation # # This program is free software; you can redistribute it and/or modify # it under the terms of version 2 of the GNU General Public License as @@ -110,7 +110,7 @@ Handle ppp connection as OCF resource. This resource calls pon/poff to connect p Resource will wait specified seconds for ppp interface aquires expected IP address provided by expected_ip4 or expected_ip6. Wait time for expected ip - + diff --git a/README.md b/README.md new file mode 100644 index 0000000..cc1136a --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# OCF Resource agent of PPP Connection + +## Example + +Here is an example that connect `dsl-provider` + +``` +primitive ppp-myisp PPPConnection \ + params isp=dsl-provider \ + op monitor interval=30 timeout=10 \ + op start timeout=60 interval=0 \ + op stop timeout=60 interval=0 +``` + +## Option parameters + +* **isp** - ISP name to connect. This will be passed to pon/poff, and pppd will be monitored with specified isp. Default is `provider`. +* **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. +* **expected_ip6** - Expected IPv6 local address (same as v4). +* **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. +* **pon_retries** - Retry limit for pon. Default is 30. +* **pon_wait_sec** - Resource will wait specified seconds for ppp connection up. When it's exceeded, retry to run pon. +* **poff_wait_sec** - Resource will wait specified seconds for ppp connection down. When it's exceeded, retry to run poff. + +## License/Copyright + +This script has been distributed under GNU General Public License version 2 (GPL2). + +Copyright (c) 2017 Tatsuki Sugiura and OSDN Corporation . + + -- 2.11.0