summaryrefslogtreecommitdiff
path: root/docs/fapi.txt
diff options
context:
space:
mode:
authorPaul C. Buetow <paul@buetow.org>2014-04-15 09:17:21 +0200
committerPaul C. Buetow <paul@buetow.org>2014-04-15 09:17:21 +0200
commit4d3c53a1d14229940de04f7392548de666b4c2c3 (patch)
tree9ac911fab7af0758d2b6095fcc319b4f3596c03f /docs/fapi.txt
parent5d1a4b71e11059445db7062b0b9fe2269104643b (diff)
add initial docs
Diffstat (limited to 'docs/fapi.txt')
-rw-r--r--docs/fapi.txt35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/fapi.txt b/docs/fapi.txt
new file mode 100644
index 0000000..b77b18f
--- /dev/null
+++ b/docs/fapi.txt
@@ -0,0 +1,35 @@
+NAME
+ fapi - A humble command line tool to manage F5 BigIP loadbalancers
+
+ This is a simple command line client to do basic stuff with the iControl
+ F5 API such as:
+
+ Managing Nodes
+ Managing Monitors
+ Managing Pools
+ Managing Virtual Servers
+
+Synopsis
+ Just run
+
+ fapi -h
+
+ or
+
+ f -h
+
+ because it's shorter to type.
+
+Requirement of bigsuds
+ This tool depends on bigsuds. Please install this library from F5 dev
+ central manually. Otherwise this script will not work.
+
+iControl reference
+ <https://devcentral.f5.com/wiki/icontrol.apireference.ashx>
+
+Project Homepage
+ See <http://japi.buetow.org>
+
+AUTHOR
+ Paul C. Buetow - <paul@buetow.org>
+