put http://127.0.0.1:8080/gms/overlays/config
Use this API to update an existing overlay configuration. If you are using regions and have customized regional BIO per region, it will be overridden. To avoid this use the other PUT api which takes regionID as an input. Any changes made to the overlay configuration will be pushed to the appliances automatically.
Please see the model for more information (click 'Model' under Data Type)
Valid values:
Topology type:
- 1 - Mesh
- 2 - Hub and Spoke
Bonding Policy:
- 1 - High availability
- 2 - High quality
- 3 - High throughput
- 4 - High efficiency
Overlay Fallback Option
- 1 - pass-through
- 3 - drop
- label_{labelId} - pass-through an interface with a specific label
Internet Policy
- policyList - The policy list is what policies to take, in order, for internet traffic. If the first policy fails, it will try the next one. The items in the list can be one of the options below, or a service name. The service name needs to match the peer name of a passthrough tunnel on the appliance.
- backhaul_via_overlay - Send the internet traffic back through overlay
- local_breakout - Break out locally through specific interfaces (must configure interface label IDs in localBreakout)
- localBreakout - Two lists (primary/backup) of the interface labels to break out of (see model for more details)
- pathLoad - The path loading option of determining the best primary link to break out of locally
- serviceLevelObjective - Ranking metric for determining the best break out link for waterfall path loading
- brownoutLossThreshold - The percentage of loss to classify that the break out link is in the brownout state for load balancing
- brownoutLatencyThreshold - The amount of latency (in ms) to classify that the break out link is in the brownout state for load balancing
- brownoutJitterThreshold - The amount of jitter (in ms) to classify that the break out link is in the brownout state for load balancing
- bandwidthThreshold - The bandwidth limit to classify that the link has reached its full bandwidth capacity
- excludeBrownoutLinks - Exclude links that are below performance thresholds, and move on to the next internet policy in the preferred policy order list if no links are available