POST /system/network/adapters/wireless/primary/mesh
This feature is only available to Beta clients. This makes the controller a member of a mesh network. This interface can auto-configure its IP parameters when the connected network has a DHCP server.
All fields are optional.
If the encryption node is present, all the values on which it depends are required.
The password must be encoded in Base64.
The values sent are saved but the mode is not applied.
If this parameter is not in the request, the Application/Json will be chosen by default.
There are multiple possible values (according the resource):
The first two are the most often used.
There are multiple possible values according the resource:
If this parameter is not present during the request, and error 415 Unsupported Media Type will be thrown.
The Content-Length entity-header field indicates the size of the entity-body.
Object Name: Encryption
| Property Name | Type | Description | Method |
|---|---|---|---|
| Type | String | This property references the type of the encryption. There are multiple encryption types:
|
GET POST |
| Password | String | This property is the password of the encryption. The password value need to be encoded in Base64. When encryption is used, set the password to access the Wi-Fi network as a client or the password other clients will use to access this hotspot. Passwords should be a long series of random alphanumeric characters and symbols that are hard to guess. This parameter is case sensitive. For the type WPA2E, the password is that of the user. |
GET POST |
| Username | String | This property represents the user's name that can be connected to the network. | GET POST |
| EAP | String | This property is EAP, it's the network communication protocol. It's used to connect to an enterprise network that has a working RADIUS authentication server. The possible values are : |
GET POST |
| Phase2 | String | This property is the phase 2 authentication, used to connect to an enterprise network that has a working RADIUS authentication server. The possible values are : |
GET POST |
Object Name: Advanced
| Property Name | Type | Description | Method |
|---|---|---|---|
| ChannelNumber | Object | This object represents the channel number. This sets the center frequency of the transmission. If there are other Wi-Fi networks are nearby, configure each Wi-Fi network to use different channel numbers to reduce interference and network drop-outs. |
GET POST |
| WifiMode | String | This object sets the wireless mode (wireless G or wireless N). Wireless N mode is backwards compatible with Wireless G and B. Wireless G mode is backwards compatible with Wireless B. A mesh network uses the wireless N mode. |
GET POST |
Object Name: ChannelNumber
| Property Name | Type | Description | Method |
|---|---|---|---|
| Id | Integer | This property is the id of a channel number. Lists of the ID : |
GET POST |
| Value | String | This property is the channel number value. Lists of the values : |
GET |
Object Name: Mesh
| Property Name | Type | Description | Method |
|---|---|---|---|
| Encryption | Object | This object represents the encryption details. It can be multiple type of encryption possible. Each encryption type need different properties. | GET POST |
| Advanced | Object | This object represents the advanced values you can configure for a Wi-Fi connection. | GET POST |
| NetworkName | String | This property is the name of the Wi-Fi network (SSID). The size limit is 32 char. (Except for the client mode) |
GET POST |
| MeshGate | Boolean | Set this option when this controller has direct access to another non-mesh network segment through a wired Ethernet connection that acts as a primary network interconnect. This increases the data rate between mesh network nodes and other network segments. When this option is enabled, this mesh node will broadcast to the other mesh nodes at regular intervals that this mesh node has the shortest path to other networks. Only one or two mesh network nodes should have this option set as these broadcasts use wireless network bandwidth. | GET POST |
| MeshForwarding | Boolean | GET POST |
URL Example: https://0.0.0.0/api/rest/v1/system/network/adapters/wireless/primary/mesh
{
"meshGate": false,
"networkName": "ECLYPSEMesh",
"encryption": {
"type": "open"
},
"advanced": {
"channelNumber": {
"id": 3
},
"wifiMode": "N"
}
}
URL Example: https://0.0.0.0/api/rest/v1/system/network/adapters/wireless/primary/mesh
<?xml version="1.0" encoding="utf-8"?>
<Mesh>
<MeshGate>false</MeshGate>
<MeshForwarding>true</MeshForwarding>
<NetworkName>ECLYPSEMesh</NetworkName>
<Encryption>
<Type>open</Type>
</Encryption>
<Advanced>
<ChannelNumber>
<Id>2</Id>
</ChannelNumber>
</Advanced>
</Mesh>