put_fw_incoming_port_id
Update properties of an incoming port configuration, such as port number, protocol, or enabled status, for services like HTTP, VPN, or FTP on your Freebox server.
Instructions
Update a IncomingPortConfig properties
Error codes: noent, internal_error, exist
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| port_id | Yes | ||
| id | No | incoming port id — Values: `http`: http port for remote access to Freebox OS; `https`: https port for tls remote access to Freebox OS; `bittorrent-main`: main bittorrent port for Freebox downloader; `bittorrent-dht`: bittorrent port for DHT; `openvpn_routed`: routed openvpn port; `openvpn_bridge`: bridged openvpn port; `ipsec_ike`: ipsec ikev2 vpn port; `ipsec_nat`: ipsec nat vpn port; `pptp`: pptp vpn server port; `ftp`: ftp control port for FTP remote access; `ftp_pasv`: ftp data port for FTP remote access | |
| enabled | No | is the port binding allowed | |
| active | No | is the port binding currently active | |
| type | No | Values: `tcp`: TCP; `udp`: UDP; `tcp_udp`: both TCP and UDP | |
| in_port | No | binding port | |
| netns | No | network namespace. The service may be running on a different namespace (for instance if the service uses the vpn client). | |
| min_port | No | This field indicate the minimum possible value for in_port (see ConnectionStatus ipv4_port_range) | |
| max_port | No | This field indicate the maximum possible value for in_port (see ConnectionStatus ipv4_port_range) | |
| readonly | No | If set to true, the in_port field cannot be changed because of the underlying protocol does not allow it |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||