From 4da794b38970d3899e752ae3adf4e4f64c3651d8 Mon Sep 17 00:00:00 2001 From: Adam Ierymenko Date: Wed, 19 Aug 2015 11:43:56 -0700 Subject: Add authorizedMemberCount to controller network config records. --- service/README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'service') diff --git a/service/README.md b/service/README.md index 668aab05..3e52a8a1 100644 --- a/service/README.md +++ b/service/README.md @@ -173,6 +173,7 @@ To create a new network with a random last six digits safely and atomically, you creationTimeintegerTime network was created in ms since epochno revisionintegerNetwork config revision numberno memberRevisionCounterintegerCurrent value of network revision counter (incremented after every member add or revision)no +authorizedMemberCountintegerNumber of authorized membersno relays[object]Array of network-specific relay nodes (see below)yes ipLocalRoutes[string]Array of IP network/netmask entries corresponding to networks routed directly via this interface (e.g. 10.0.0.0/8 to route 10.0.0.0 via this interface) ipAssignmentPools[object]Array of IP auto-assignment pools for 'zt' assignment modeyes -- cgit v1.2.3 From 867258de8b5cbc3e3b26baa9b9e7332df9048328 Mon Sep 17 00:00:00 2001 From: Adam Ierymenko Date: Tue, 25 Aug 2015 09:44:21 -0700 Subject: Document clock convenience field. --- service/README.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'service') diff --git a/service/README.md b/service/README.md index 3e52a8a1..7ffabba3 100644 --- a/service/README.md +++ b/service/README.md @@ -173,6 +173,7 @@ To create a new network with a random last six digits safely and atomically, you creationTimeintegerTime network was created in ms since epochno revisionintegerNetwork config revision numberno memberRevisionCounterintegerCurrent value of network revision counter (incremented after every member add or revision)no +clockintegerCurrent clock in ms since epoch (for convenience)no authorizedMemberCountintegerNumber of authorized membersno relays[object]Array of network-specific relay nodes (see below)yes ipLocalRoutes[string]Array of IP network/netmask entries corresponding to networks routed directly via this interface (e.g. 10.0.0.0/8 to route 10.0.0.0 via this interface) @@ -243,6 +244,7 @@ IP related fields apply only to Ethernet frames of type IPv4 or IPV6. Otherwise + -- cgit v1.2.3 From b4487cefc978491ae40ba29c8c84ce0c23ba8fdb Mon Sep 17 00:00:00 2001 From: Adam Ierymenko Date: Tue, 25 Aug 2015 09:46:59 -0700 Subject: Document rules requirement in controller. --- service/README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) (limited to 'service') diff --git a/service/README.md b/service/README.md index 7ffabba3..05f340d8 100644 --- a/service/README.md +++ b/service/README.md @@ -156,9 +156,7 @@ By making queries to this path you can create, configure, and delete networks. D It's important to understand how network IDs work. The first ten digits (most significant 40 bits) of a network ID are the ZeroTier address of the controller. This is how clients find it. The last six digits (least significant 24 bits) are arbitrary and serve to identify the network uniquely on the controller. -Thus a network's first ten digits *must* be the controller's address. If your controller is *deadbeef01*, then the networks it controls must have IDs like *deadbeef01feed02* or *deadbeef01beef03*. This API however *does not* enforce this requirement. It will allow you to add arbitrary network IDs, but they won't work since clients will never be able to find them. - -To create a new network with a random last six digits safely and atomically, you can POST to */controller/network/##########\_\_\_\_\_\_* where ########## is the controller's address and the underscores are as shown. This will pick a random unallocated network ID, which will be returned in the 'nwid' field of the returned JSON object. +Thus a network's first ten digits *must* be the controller's address. If your controller is *deadbeef01*, then the networks it controls must have IDs like *deadbeef01feed02* or *deadbeef01beef03*. This API however *does not* enforce this requirement. It will allow you to add arbitrary network IDs, but they won't work since clients will never be able to find them. To create a new network with a random last six digits safely and atomically, you can POST to */controller/network/##########\_\_\_\_\_\_* where ########## is the controller's address and the underscores are as shown. This will pick a random unallocated network ID, which will be returned in the 'nwid' field of the returned JSON object.
FieldTypeDescriptionWritable
nwidstring16-digit hex network IDno
clockintegerCurrent clock in ms since epoch (for convenience)no
addressstring10-digit hex ZeroTier addressno
authorizedbooleanIs member authorized?yes
activeBridgebooleanThis member is an active network bridgeyes
@@ -181,9 +179,9 @@ To create a new network with a random last six digits safely and atomically, you
FieldTypeDescriptionWritable
rules[object]Array of network flow rules (see below)yes
-The network member list includes both authorized and unauthorized members. DELETE unauthorized members to remove them from the list. +The network member list includes both authorized and unauthorized members. DELETE unauthorized members to remove them from the list. Relays, IP assignment pools, and rules are edited via direct POSTs to the network object. New values replace all previous values. -Relays, IP assignment pools, and rules are edited via direct POSTs to the network object. New values replace all previous values. +Networks must have rules. If there are no rules, the default action is 'deny'. As also documented in the Rule object definition below, rules currently only support etherType and allow/deny. Thus to make a functioning network, add etherType allow entries for IPV4/ARP and/or IPv6. Alternately you can add a null allow entry to allow all traffic, causing the network to behave like a normal pass-through switch. **Relay object format:** -- cgit v1.2.3