docs/synopsis.txt


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

usage: fapi [-a] [-b B] [-d] [-e E] [-f F] [-h] [-i] [-l] [-n] [-v] [-V]
            [-C C]
            [what] [name] [sub] [sub2] [sub3] [sub4] [sub5]

positional arguments:
  what  node|pool|monitor|vserver|...
  name  The object name to operate on
  sub   First sub command
  sub2  Second sub command
  sub3  Third sub command
  sub4  Fourth sub command
  sub5  Fith sub command

optional arguments:
  -a    Disables auto port in vserver name
  -b B  Forces to use the secified loadbalancer (overwrites -e)
  -d    Disable colorful output
  -e E  Env to use, e.g. dev,qa,live
  -f F  Overwrite partition/folder from fapi.conf
  -h    Print this help
  -i    Interactive shell
  -l    Use list output
  -n    No-op (don't do actual stuff)
  -v    Verbose
  -V    Print program version
  -C C  Config file


Synopsis:
[2m    monitor
    monitor NAME get desc|state
    node
    node NODENAME create|delete
    node NODENAME get detail|status|ratio
    node NODENAME set ratio RATIO
    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
    poolmember NAME MEMBER:PORT get ratio
    poolmember NAME MEMBER:PORT set ratio RATIO
    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|vlan|profile|rule
    vserver NAME set nat|pat disabled|enabled
    vserver NAME set pool POOLNAME
    vserver NAME set snat automap|none
    vserver NAME set vlan [list,of,vlans,to,allow]
    vserver NAME profile add PROFILENAME [PROFILECONTEXT]
    vserver NAME profile remove PROFILENAME
    vserver NAME rule add RULENAME [RULEPRIORITY]
    vserver NAME rule remove RULENAME
    profileclientssl
    profileclientssl PROFILENAME create [SSLKEYNAME] [SSLCERTNAME]
    profileclientssl PROFILENAME delete
    profileclientssl PROFILENAME get detail[0m
The following partially needs admininstrator privileges on / and /Common
[2m    -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 -b balancer.example.com vlan
    -f Common -b balancer.example.com vlan NAME create tagged VLANID internal|external|...
    -f Common -b balancer.example.com vlan NAME delete
    -f Common -b balancer.example.com vlan NAME get detail
    -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 / folder
    -f / folder NAME create|delete
    -f / folder NAME get detail|dgroup|tgroup
    -f / folder NAME set dgroup|tgroup DGROUP|TGROUP[0m
Please consult the manpage for examples.