POST /system/network/adapters/wireless/primary/client
This connects the controller as a client of a Wi-Fi access point.
All fields are optional.
If the encryption node is present, then all values on which it relies upon are required.
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: Client
| 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 |
| 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 |
| HiddenSsid | Boolean | This property is used to indicate to the device if the network name (SSID), is visible or not during a discovering. | GET POST |
URL Example: https://0.0.0.0/api/rest/v1/system/network/adapters/wireless/primary/client
{
"networkName": "TheNetworkName",
"hiddenSsid": true,
"encryption": {
"type": "WPA2E",
"password": "SecurePassword",
"username": "Jean",
"eap": "PEAP",
"phase2": "PAP"
}
}
URL Example: https://0.0.0.0/api/rest/v1/system/network/adapters/wireless/primary/client
<?xml version="1.0" encoding="utf-8"?>
<Client>
<NetworkName>TheNetworkName</NetworkName>
<HiddenSsid>true</HiddenSsid>
<Encryption>
<Type>WPA2E</Type>
<Password>SecurePassword</Password>
<Username>Jean</Username>
<Eap>PEAP</Eap>
<Phase2>PAP</Phase2>
</Encryption>
</Client>