Context Navigation

Shared Network Manipulation Commands MIGRATED TO GITLAB

The following page documents our plan for implementing initial set of commands used to manipulate shared networks. This set of commands is somewhat basic, but we expect to have it expanded in the future.

List networks (network4-list, network6-list)

There are two commands: network4-list and network6-list. Each returns specific type of shared networks.

{"command":"network4-list"}

The response will generate a list of IPv4 shared networks. Only very basic information is returned about each network at this stage. To get more details, use network4-get. Example response:

TODO: describe network6-list. It will work exactly the same as network4-list.

Retrieving shared network (network4-get, network6-get)

Once network4-list is called, the names of configured shared networks are known. To retrieve details about specific shared network, network4-get and network6-get can be called. Both of those commands have one mandatory parameter "name" that specifies a name of the network to be retrieved. Example command:

Adding shared network (network4-add, network6-add)

Shared networks can be added using network4-add and network6-add commands. Typically, a whole shared network with several subnets would be added at once. In the near future it will be possible to add a new subnet to existing network or add existing subnet to existing network.

Deleting shared network (network4-del, network6-del)

There are two commands that allow deleting shared networks: network4-add and network6-del. An example call looks as follows:

{"command":"network4-del","arguments":{"name":"floor13"}}

If there are any subnets in the shared network being deleted, those will be downgraded to regular subnets. If you want to delete them, please use subnet4-del command before or after deleting the network.

Adding subnet to existing shared network

TODO: need to extend existing subnet4-add, subnet6-add to accept additional parameter "shared-network" what would take the shared network name.

Removing a subnet from existing shared network

To remove a subnet from existing shared network, simply use subnet4-del, in the similar
way as if removing plain subnet.

Old notes (obsolete)

TODO: need to remove this.

Proposed operations:

Create shared network (without subnets in it)

Remove shared network with an option for cascaded removal of subnets within this network.

A possible way forward is to allow assignment of shared subnets using subnet4-update commands (that may be useful in some cases when there is a general subnet information update going on), but later implement additional (dedicated) commands that solely assign/unassign subnets to/from shared networks. How about that?