vpe-router/actions.yaml

   1 configure-interface:
   2   description: Configure an ethernet interface.
   3   params:
   4     iface-name:
   5       type: string
   6       description: Device name, e.g. eth1
   7     cidr:
   8       type: string
   9       description: Network range to assign to the interface
  10   required: [iface-name]
  11 add-corporation:
  12   description: Add a new corporation to the router
  13   params:
  14     domain-name:
  15       type: string
  16       description: Name of the vlan corporation
  17     iface-name:
  18       type: string
  19       description: Device name. eg eth1
  20     vlan-id:
  21       type: integer
  22       description: The name of the vlan?
  23     cidr:
  24       type: string
  25       description: Network range to assign to the tagged vlan-id
  26     area:
  27       type: string
  28       description: Link State Advertisements (LSA) type
  29     subnet-cidr:
  30       type: string
  31       description: Network range
  32     subnet-area:
  33       type: string
  34       description: Link State Advertisements (LSA) type
  35   required: [domain-name, iface-name, vlan-id, cidr, area, subnet-cidr, subnet-area]
  36 delete-corporation:
  37   description: Remove the corporation from the router completely
  38   params:
  39     domain-name:
  40       type: string
  41       description: The domain of the corporation to remove
  42     cidr:
  43       type: string
  44       description: Network range to assign to the tagged vlan-id
  45     area:
  46       type: string
  47       description: Link State Advertisements (LSA) type
  48     subnet-cidr:
  49       type: string
  50       description: Network range
  51     subnet-area:
  52       type: string
  53       description: Link State Advertisements (LSA) type
  54   required: [domain-name, cidr, area, subnet-cidr, subnet-area]
  55 connect-domains:
  56   description: Connect the router to another router, where the same domain is present
  57   params:
  58     domain-name:
  59       type: string
  60       description: The domain of the coproration to connect
  61     iface-name:
  62       type: string
  63       description: Device name. eg eth1
  64     tunnel-name:
  65       type: string
  66       description: Name of the tunnel ?
  67     local-ip:
  68       type: string
  69       description: local ip ?
  70     remote-ip:
  71       type: string
  72       description: remote ip ?
  73     tunnel-key:
  74       type: string
  75       description: tunnel key?
  76     internal-local-ip:
  77       type: string
  78       description: internal local ip?
  79     internal-remote-ip:
  80       type: string
  81       description: internal remote ip?
  82     tunnel-type:
  83       type: string
  84       default: gre
  85       description: The type of tunnel to establish.
  86   required: [domain-name, iface-name, tunnel-name, local-ip, remote-ip, tunnel-key, internal-local-ip, internal-remote-ip]
  87 delete-domain-connection:
  88   description: Remove the tunnel to another router where the domain is present.
  89   params:
  90     domain-name:
  91       type: string
  92       description: The domain of the corporation to unlink
  93     tunnel-name:
  94       type: string
  95       description: The name of the tunnel to unlink that the domain-name is attached to
  96   required: [domain-name, tunnel-name]