From 4160f2940f5fec75e1fa9a8fa5aa88b8e7f285b8 Mon Sep 17 00:00:00 2001
From: "Paul C. Buetow" <paul@buetow.org>
Date: Tue, 15 Apr 2014 23:01:04 +0200
Subject: Q:	How do you stop an elephant from charging? A:	Take away his
 credit cards.

---
 docs/fapi.1 | 48 ++++++++++++++++++++++++++++++++++++++----------
 1 file changed, 38 insertions(+), 10 deletions(-)

(limited to 'docs/fapi.1')

diff --git a/docs/fapi.1 b/docs/fapi.1
index 45b65c3..f7ca6d9 100644
--- a/docs/fapi.1
+++ b/docs/fapi.1
@@ -205,6 +205,15 @@ And run
 .Ve
 .SH "EXAMPLES"
 .IX Header "EXAMPLES"
+.SS "Listing"
+.IX Subsection "Listing"
+If you want to list all configured objects on your partition just run
+.PP
+.Vb 3
+\&  f node # To list all nodes
+\&  f pool # To list all pool
+\&  ... # etc
+.Ve
 .SS "Setting up simple \s-1NAT\s0 Services"
 .IX Subsection "Setting up simple NAT Services"
 .Vb 1
@@ -219,12 +228,14 @@ And run
 .IX Subsection "Setting up a simple nPath Service"
 A simple nPath service can be created as follows.
 .PP
-.Vb 3
-\&  # Creating two nodes, auto resolve the IP addresses
+.Vb 4
+\&  # Creating two nodes, fapi auto resolves the IP addresses, and use the
+\&  # FQDN as the node name. 
 \&  f node fooserver1.example.com create
 \&  f node fooserver2.example.com create
 \&
-\&  # Creating a pool and add the nodes to it
+\&  # Creating a pool and add the nodes to it. Also specify the node ports to 
+\&  # use by the monitors (and maybe PAT if enabled)
 \&  f pool foopool create
 \&  f pool foopool add member fooserver1.example.com:80
 \&  f pool foopool add member fooserver2.example.com:80
@@ -232,15 +243,32 @@ A simple nPath service can be created as follows.
 \&  # Add a monitor to the pool
 \&  f pool foopool add monitor http_lbtest
 \&
-\&  # Create a nPath HTTP service, \*(AqnPath\*(Aq also auto disables NAT and PAT
-\&  f vserver myservice.example.com:80 create PROTOCOL_TCP nPath
+\&  # Create a nPath HTTP vserver, \*(AqnPath\*(Aq also auto disables NAT and PAT
+\&  # fapi auto resolves the IP address.
+\&  f vserver myvserver.example.com:80 create PROTOCOL_TCP nPath
+\&
+\&  # Add the pool to the vserver. The vservers name will be the FQDN followed by
+\&  # _PORT. In this case it would be: myvserver.example.com_80. The reason is
+\&  # that : are not allowed in vserver names.
+\&  f vserver myvserver.example.com:80 set pool foopool
+\&
+\&  # Add a nPath HTTPS vserver
+\&  f vserver myvserver.example.com:443 create PROTOCOL_TCP nPath
+\&  f vserver myvserver.example.com:443 set pool foopool
+.Ve
+.PP
+And everything can be deleted as folows:
+.PP
+.Vb 2
+\&  # You can also specify the full object name (including the partition)
+\&  f vserver /Common/myvserver.example.com_80 delete
 \&
-\&  # Add the pool to the service
-\&  f vserver myservice.example.com:80 set pool foopool
+\&  # Or just the way the service was created from command line
+\&  f vserver myvserver.example.com:443 delete
 \&
-\&  # Add a nPath HTTPS service
-\&  f vserver myservice.example.com:443 create PROTOCOL_TCP nPath
-\&  f vserver myservice.example.com:443 set pool foopool
+\&  f pool foopool delete
+\&  f node fooserver1.example.com delete
+\&  f node fooserver2.example.com delete
 .Ve
 .SH "AUTHOR"
 .IX Header "AUTHOR"
-- 
cgit v1.2.3