HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

/system/vrfs/{VRF.name}/ubt_zones/{UBT_Zone.name}

Path Params
string
required

Reference Resource: VRF
VRF identifier. Should be alphanumeric. VRF names must be unique.

string
required

Reference Resource: UBT_Zone
Zone name.

Body Params
controller_nodes
object

IP address of the primary and backup controller nodes.

boolean

Enables UBT functionality for this zone.

string
length ≥ 10

Shared security key that will be used to encrypt UBT PAPI messages exchanged between this switch and the controller cluster corresponding to this zone. when not set, shared security key is not used for encrypting papi messages.

integer
1 to 8

Time interval (in seconds) between successive heartbeat messages to the switch anchor node.

integer
1 to 60

Time interval (in seconds) between successive keep-alive messages sent to the user anchor node.

string
required

Reference Resource: UBT_Zone
VRF associated with this zone.

wol_vlans
array of integers
length ≤ 100

Wake-on-LAN VLAN configuration. This is applicable only for VLAN Extend mode.

wol_vlans
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Language
Response
Click Try It! to start a request and see the response here!