Some checks failed
Build & Deploy docs / build-deploy (push) Failing after 10m17s
- Nouveau générateur scripts/gen_api_reference.py : 19 namespaces → docs/api/metier/ (10) + docs/api/systeme/ (9) + notifications.md + types.md (96 types · 55 enums · 4 flags) + SUMMARY.md literate-nav - Badges permissionScope (perm-none/control/configure/admin) dans extra.css - Guide docs/integrations/jsonrpc-api.md (connexion TCP/WS, auth, conventions énergie) - mkdocs.yml : Référence API dans la nav, REST→JsonRPC renommé - mkdocs build --strict : 0 warnings · --check idempotent Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
302 lines
6.4 KiB
Markdown
302 lines
6.4 KiB
Markdown
# NetworkManager
|
|
|
|
<!-- BEGIN GENERATED: __api_NetworkManager__ -->
|
|
## Méthodes
|
|
|
|
### NetworkManager.ConnectWifiNetwork
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Connect to the wifi network with the given ssid and password.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `interface` | `String` | |
|
|
| `password` | `String` | optionnel |
|
|
| `ssid` | `String` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `networkManagerError` | [NetworkManagerError](../types.md#networkmanagererror) | |
|
|
|
|
---
|
|
|
|
### NetworkManager.CreateWiredConnection
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Create a wired connection.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `interface` | `String` | |
|
|
| `dns` | `String` | optionnel |
|
|
| `gateway` | `String` | optionnel |
|
|
| `ip` | `String` | optionnel |
|
|
| `prefix` | `Uint` | optionnel |
|
|
| `type` | [WiredNetworkConnectionType](../types.md#wirednetworkconnectiontype) | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `networkManagerError` | [NetworkManagerError](../types.md#networkmanagererror) | |
|
|
|
|
---
|
|
|
|
### NetworkManager.DisconnectInterface
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Disconnect the given network interface. The interface will remain disconnected until the user connect it again.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `interface` | `String` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `networkManagerError` | [NetworkManagerError](../types.md#networkmanagererror) | |
|
|
|
|
---
|
|
|
|
### NetworkManager.EnableNetworking
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Enable or disable networking in the NetworkManager.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `enable` | `Bool` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `networkManagerError` | [NetworkManagerError](../types.md#networkmanagererror) | |
|
|
|
|
---
|
|
|
|
### NetworkManager.EnableWirelessNetworking
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Enable or disable wireless networking in the NetworkManager.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `enable` | `Bool` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `networkManagerError` | [NetworkManagerError](../types.md#networkmanagererror) | |
|
|
|
|
---
|
|
|
|
### NetworkManager.GetNetworkDevices
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Get the list of current network devices.
|
|
|
|
**Paramètres :**
|
|
|
|
_Aucun paramètre._
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `networkManagerError` | [NetworkManagerError](../types.md#networkmanagererror) | |
|
|
| `wiredNetworkDevices` | [WiredNetworkDevice](../types.md#wirednetworkdevice)[] | optionnel |
|
|
| `wirelessNetworkDevices` | [WirelessNetworkDevice](../types.md#wirelessnetworkdevice)[] | optionnel |
|
|
|
|
---
|
|
|
|
### NetworkManager.GetNetworkStatus
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Get the current network manager status.
|
|
|
|
**Paramètres :**
|
|
|
|
_Aucun paramètre._
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `networkManagerError` | [NetworkManagerError](../types.md#networkmanagererror) | |
|
|
| `status` | `{'networkingEnabled': 'Bool', 'state': '$ref:NetworkManagerState', 'wirelessNetworkingEnabled': 'Bool'}` | optionnel |
|
|
|
|
---
|
|
|
|
### NetworkManager.GetWirelessAccessPoints
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Get the current list of wireless network access points for the given interface. The interface has to be a WirelessNetworkDevice.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `interface` | `String` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `networkManagerError` | [NetworkManagerError](../types.md#networkmanagererror) | |
|
|
| `wirelessAccessPoints` | [WirelessAccessPoint](../types.md#wirelessaccesspoint)[] | optionnel |
|
|
|
|
---
|
|
|
|
### NetworkManager.ScanWifiNetworks
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Start a wifi scan for searching new networks.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `interface` | `String` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `networkManagerError` | [NetworkManagerError](../types.md#networkmanagererror) | |
|
|
|
|
---
|
|
|
|
### NetworkManager.StartAccessPoint
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Start a WiFi Access point on the given interface with the given SSID and password. Use DisconnectInterface to stop it again.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `interface` | `String` | |
|
|
| `password` | `String` | |
|
|
| `ssid` | `String` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `networkManagerError` | [NetworkManagerError](../types.md#networkmanagererror) | |
|
|
|
|
---
|
|
|
|
## Notifications
|
|
|
|
### NetworkManager.NetworkStatusChanged
|
|
|
|
Emitted whenever a status of a NetworkManager changes.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `status` | `{'networkingEnabled': 'Bool', 'state': '$ref:NetworkManagerState', 'wirelessNetworkingEnabled': 'Bool'}` | |
|
|
|
|
---
|
|
|
|
### NetworkManager.WiredNetworkDeviceAdded
|
|
|
|
Emitted whenever a new WiredNetworkDevice was added.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `wiredNetworkDevice` | [WiredNetworkDevice](../types.md#wirednetworkdevice) | |
|
|
|
|
---
|
|
|
|
### NetworkManager.WiredNetworkDeviceChanged
|
|
|
|
Emitted whenever the given WiredNetworkDevice has changed.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `wiredNetworkDevice` | [WiredNetworkDevice](../types.md#wirednetworkdevice) | |
|
|
|
|
---
|
|
|
|
### NetworkManager.WiredNetworkDeviceRemoved
|
|
|
|
Emitted whenever a WiredNetworkDevice was removed.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `interface` | `String` | |
|
|
|
|
---
|
|
|
|
### NetworkManager.WirelessNetworkDeviceAdded
|
|
|
|
Emitted whenever a new WirelessNetworkDevice was added.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `wirelessNetworkDevice` | [WirelessNetworkDevice](../types.md#wirelessnetworkdevice) | |
|
|
|
|
---
|
|
|
|
### NetworkManager.WirelessNetworkDeviceChanged
|
|
|
|
Emitted whenever the given WirelessNetworkDevice has changed.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `wirelessNetworkDevice` | [WirelessNetworkDevice](../types.md#wirelessnetworkdevice) | |
|
|
|
|
---
|
|
|
|
### NetworkManager.WirelessNetworkDeviceRemoved
|
|
|
|
Emitted whenever a WirelessNetworkDevice was removed.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `interface` | `String` | |
|
|
|
|
---
|
|
|
|
<!-- END GENERATED -->
|