summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/fapi.18
-rw-r--r--docs/fapi.txt6
-rw-r--r--docs/synopsis.txt51
3 files changed, 11 insertions, 54 deletions
diff --git a/docs/fapi.1 b/docs/fapi.1
index a5a8ec8..1dc317f 100644
--- a/docs/fapi.1
+++ b/docs/fapi.1
@@ -124,7 +124,7 @@
.\" ========================================================================
.\"
.IX Title "FAPI 1"
-.TH FAPI 1 "2014-05-15" "fapi 0.6.2" "User Commands"
+.TH FAPI 1 "2014-05-16" "fapi 0.7.0" "User Commands"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -179,7 +179,7 @@ https://devcentral.f5.com/d/bigsuds\-python\-icontrol\-library <https://devcentr
Unzip it and run
.PP
.Vb 1
-\& sudo python setyp.py install
+\& sudo python setup.py install
.Ve
.PP
You may also install bigsuds from the contrib dir of the fapi source tree.
@@ -260,6 +260,10 @@ A simple nPath service can be created as follows.
\& fapi vserver myvserver.example.com:443 create PROTOCOL_TCP nPath
\& fapi vserver myvserver.example.com:443 set pool foopool
\&
+\& # Restrict the vserver to a specific VLAN (IMPORTANT! security
+\& # hole otherwise!)
+\& fapi vserver myvserver.example.com:443 set vlan VLANNAME
+\&
\& # Put the VirtualAddress of the vserver into a specific traffic group
\& fapi vip myserver.example.com set tgroup some\-traffic\-group
.Ve
diff --git a/docs/fapi.txt b/docs/fapi.txt
index b96dbed..698a0cb 100644
--- a/docs/fapi.txt
+++ b/docs/fapi.txt
@@ -40,7 +40,7 @@ BIGSUDS
Unzip it and run
- sudo python setyp.py install
+ sudo python setup.py install
You may also install bigsuds from the contrib dir of the fapi source
tree.
@@ -109,6 +109,10 @@ EXAMPLES
fapi vserver myvserver.example.com:443 create PROTOCOL_TCP nPath
fapi vserver myvserver.example.com:443 set pool foopool
+ # Restrict the vserver to a specific VLAN (IMPORTANT! security
+ # hole otherwise!)
+ fapi vserver myvserver.example.com:443 set vlan VLANNAME
+
# Put the VirtualAddress of the vserver into a specific traffic group
fapi vip myserver.example.com set tgroup some-traffic-group
diff --git a/docs/synopsis.txt b/docs/synopsis.txt
index 3d1e7f0..4112cc6 100644
--- a/docs/synopsis.txt
+++ b/docs/synopsis.txt
@@ -22,54 +22,3 @@ optional arguments:
-V Print program version
-C C Config file
-
-Synopsis:
- monitor
- monitor NAME get desc|state
- node
- node NODENAME create|delete
- node NODENAME get detail|status
- pool
- pool NAME add member MEMBER:PORT
- pool NAME add monitor MONITOR
- pool NAME create [LIST,OF,POOL,MEMBERS:PORT]
- pool NAME delete
- pool NAME del member MEMBER:PORT
- pool NAME del monitors
- pool NAME get detail|lbmethod|members|monitor|status
- pool NAME set lbmethod LBMETHOD
- vip
- vip NAME create NETMASK
- vip NAME get arp|detail|status|tgroup
- vip NAME set arp enabled|disabled
- vip NAME set tgroup TGROUP
- vserver
- vserver NAME create [protocol] [profile] [poolname] [mask]
- vserver NAME delete
- vserver NAME get brief|detail|status
- vserver NAME set nat|pat disabled|enabled
- vserver NAME set pool POOLNAME
- vserver NAME set snat none
-The following partially needs admininstrator privileges on / and /Common
- -f Common -b balancer.example.com selfip
- -f Common -b balancer.example.com selfip NAME create NETMASK VLANNAME [TGROUP]
- -f Common -b balancer.example.com selfip NAME delete
- -f Common -b balancer.example.com selfip NAME get detail|tgroup
- -f Common -b balancer.example.com selfip NAME set tgroup TGROUP
- -f Common tgroup
- -f Common tgroup NAME add ha_order DEVICE ORDER
- -f Common tgroup NAME create
- -f Common tgroup NAME delete
- -f Common tgroup NAME get detail
- -f Common tgroup NAME get ha_order
- -f Common tgroup NAME remove all_ha_orders
- -f Common tgroup NAME remove ha_order DEVICE ORDER
- -f Common vlan
- -f Common vlan NAME create tagged VLANID internal|external|...
- -f Common vlan NAME delete
- -f Common vlan NAME get detail
- -f / folder
- -f / folder NAME create|delete
- -f / folder NAME get detail|dgroup|tgroup
- -f / folder NAME set dgroup|tgroup DGROUP|TGROUP
-Please consult the manpage for examples.