summaryrefslogtreecommitdiff
path: root/docs/extended-synopsis.txt
blob: eb1e87dc15e4395a86ba95598f7fabda93b8b982 (plain)
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
usage: fapi [-a] [-b B] [-d] [-E] [-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    Show extended synopsis
  -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


Extended synopsis.
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 -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