Stormshield Network Security SNS v4

https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/
Admin
Stormshield Network Security (SNS) v4 is an IPS-Firewall solution that provides network security...
Tokens:417,299
Snippets:2,461
Trust Score:9.5
Update:8 months ago
Show doc for...
Tokens:
Raw
### SYSTEM INITIALIZE

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/SYSTEM.INITIALIZE

Initializes the product and retrieves the GUID required for the final init package.

```APIDOC
## SYSTEM INITIALIZE

### Description
Initializes the product. Retrieve the GUID of the product required to obtain the final init package.

### Method
Not specified (likely a CLI command, not a standard HTTP method)

### Endpoint
Not applicable (CLI command)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
SYSTEM INITIALIZE
```

### Response
#### Success Response
- **GUID** (string) - The unique identifier of the product required for the final init package.

#### Response Example
```json
{
  "GUID": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
```
```

--------------------------------

### CONFIG ANTIVIRUS LIST

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.ANTIVIRUS.LIST

Retrieves a list of installed antivirus configurations, including their names and last modification dates.

```APIDOC
## CONFIG ANTIVIRUS LIST

### Description
List installed antivirus configurations.

### Method
GET (Assumed, as it retrieves data)

### Endpoint
/serverd/commands/config/antivirus/list (Assumed endpoint based on command structure)

### Parameters
None explicitly mentioned for this command.

### Request Example
```
CONFIG ANTIVIRUS LIST
```

### Response
#### Success Response (200 OK)
- **name** (string) - The name of the installed antivirus.
- **lastmod** (string) - The last modification date of the antivirus configuration.

#### Response Example
```json
{
  "code": "00a00100",
  "msg": "Ok",
  "antivirus_list": [
    {
      "name": "clamav",
      "lastmod": "2006-05-11 16:51:31"
    },
    {
      "name": "AdvancedAV",
      "lastmod": "2006-01-10 11:28:40"
    }
  ]
}
```
```

--------------------------------

### Example: Add MAC Range (CLI)

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.OBJECT.HOST.NEW

Example demonstrating how to add a new MAC address range.

```cli
CONFIG OBJECT HOST NEW name=rangemac beginmac=11:22:33:44:55:60 endmac=11:22:33:44:55:70 comment="mac range"
```

--------------------------------

### CONFIG ANTIVIRUS SELECT

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.ANTIVIRUS.SELECT

Switches the active antivirus and initiates the download of the new database. Requires Contentfilter and Modify levels.

```APIDOC
## CONFIG ANTIVIRUS SELECT

### Description
Switch the active antivirus if possible and starts the download of the new database.

### Method
Not specified (assumed CLI command)

### Endpoint
Not applicable (CLI command)

### Parameters
#### Query Parameters
- **config** (string) - Required - The index of the configuration to select.

### Request Example
```
CONFIG ANTIVIRUS SELECT config=00
```

### Response
#### Success Response (200)
- **Error code** (integer) - Description of the error code returned.

#### Response Example
```
0
```

### Remark
Contentfilter and Modify levels needed to switch antivirus.
```

--------------------------------

### Example: Add MAC Host (CLI)

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.OBJECT.HOST.NEW

Example demonstrating how to add a new host object specified only by its MAC address.

```cli
CONFIG OBJECT HOST NEW name=hostmac mac=11:22:33:44:55:66 comment="mac only host"
```

--------------------------------

### SYSTEM TPM INIT

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/SYSTEM.TPM.INIT

Initializes the TPM (password, masterkey generation).

```APIDOC
## SYSTEM TPM INIT

### Description
Initialize TPM (password, masterkey generation).

### Method
COMMAND

### Endpoint
N/A (CLI Command)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
SYSTEM TPM INIT tpmpassword=<password> [derivekey=on|off]
```

### Response
#### Success Response (OK)
- **status** (string) - 'ok'

#### Error Response
- **error** (string) - Error message

#### Response Example
```
ok
```

### Parameters Description
- **tpmpassword** (string) - Required - The password for the TPM.
- **derivekey** (string) - Optional - 'on' to derive a symmetric key from the password, 'off' otherwise. Defaults to 'off'.
```

--------------------------------

### Example: Add IPv6 Host (CLI)

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.OBJECT.HOST.NEW

Example demonstrating how to add a new host with only an IPv6 address and a static resolution.

```cli
CONFIG OBJECT HOST NEW name=host6 ipv6=fe80::1 resolve=static comment="IPv6 only host"
```

--------------------------------

### CONFIG AUTOBACKUP LAUNCH

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.AUTOBACKUP.LAUNCH

Manually launches the autobackup process. This command is used for maintenance and configuration purposes.

```APIDOC
## CONFIG AUTOBACKUP LAUNCH

### Description
Launch autobackup manually.

### Method
COMMAND

### Endpoint
CONFIG AUTOBACKUP LAUNCH

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
CONFIG AUTOBACKUP LAUNCH
```

### Response
#### Success Response (0)
- **Error code** (integer) - Returns 0 on success.

#### Response Example
```
0
```
```

--------------------------------

### Example: Add IPv4v6 Range (CLI)

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.OBJECT.HOST.NEW

Example demonstrating how to add a new range that includes both IPv4 and IPv6 address ranges.

```cli
CONFIG OBJECT HOST NEW name=range46 begin=10.0.0.1 end=10.0.0.10 beginv6=fe80::1 endv6=fe80::10 comment="IPv4v6 range"
```

--------------------------------

### Example: Add IPv4v6 Host (CLI)

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.OBJECT.HOST.NEW

Example demonstrating how to add a new host with both IPv4 and IPv6 addresses, and a static resolution.

```cli
CONFIG OBJECT HOST NEW name=host46 ip=10.0.0.1 ipv6=fe80::1 resolve=static comment="IPv4v6 host"
```

--------------------------------

### CONFIG OPENVPN SHOW

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.OPENVPN.SHOW

Displays OpenVPN information, including configuration details, available algorithms, and connection settings.

```APIDOC
## CONFIG OPENVPN SHOW

### Description
Display openvpn information.

### Method
GET

### Endpoint
/config/openvpn/show

### Parameters
#### Query Parameters
- **useclone** (integer) - Optional - Specify if displayed configuration comes from clone file or not (0 or 1).
- **crypto** (string) - Optional - Specify the type of crypto information to display. Possible values: 'authAlgo' (display available Auth algorithms), 'cipher' (display available Cipher algorithms), 'tlsCipher' (display available TLS algorithms).

### Request Example
```
CONFIG OPENVPN SHOW
CONFIG OPENVPN SHOW useclone=1
CONFIG OPENVPN SHOW crypto=authAlgo
```

### Response
#### Success Response (200)
- **state** (string) - OpenVPN activation state.
- **pool** (string) - IP addresses pool.
- **Port** (integer) - Public listening port for the service.
- **route** (string) - Pushed routes on OpenVPN client.
- **serverPublicAddr** (string) - Public address to contact OpenVPN server.
- **serverPublicAddrSecondary** (string) - Secondary public address to contact OpenVPN server.
- **timeout** (integer) - Renegotiation time of channel.
- **serverCertificate** (string) - Server certificate.
- **clientCertificate** (string) - Client certificate.
- **cipher** (string) - Used encrypt algorithm.
- **tlsCipher** (string) - Used encrypt algorithm for TLS.
- **authAlgo** (string) - Message digest algorithm.
- **persist** (string) - Client IP persistency.
- **primaryDns** (string) - Pushed primary DNS on OpenVPN client.
- **secondaryDns** (string) - Pushed secondary DNS on OpenVPN client.
- **domainName** (string) - Pushed domain name on OpenVPN client.
- **verbose** (integer) - Verbose activation level.
- **verboseFile** (string) - Used verbose file.
- **udpBindAddr** (string) - Firewall local IP used to bind the OpenVPN UDP server.
- **Compress** (boolean) - Enable/disable LZ4 compression.
- **StrictCert** (boolean) - Enable/disable strict server certificate check (type server and name).
- **HandWindow** (integer) - Configure Handshake Window -- the TLS-based key exchange must finalize within n seconds of handshake initiation by any peer.

#### Response Example
```json
{
  "state": "active",
  "pool": "10.8.0.0/24",
  "Port": 1194,
  "route": "192.168.1.0/24",
  "serverPublicAddr": "1.2.3.4",
  "timeout": 600,
  "serverCertificate": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----",
  "clientCertificate": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----",
  "cipher": "AES-256-CBC",
  "tlsCipher": "TLS-DHE-RSA-WITH-AES-256-GCM-SHA384",
  "authAlgo": "SHA256",
  "persist": "yes",
  "primaryDns": "8.8.8.8",
  "secondaryDns": "8.8.4.4",
  "domainName": "example.com",
  "verbose": 0,
  "udpBindAddr": "0.0.0.0",
  "Compress": true,
  "StrictCert": true,
  "HandWindow": 60
}
```
```

--------------------------------

### Example: Add IPv4 Host (CLI)

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.OBJECT.HOST.NEW

Example demonstrating how to add a new host with only an IPv4 address, a static resolution, and a comment.

```cli
CONFIG OBJECT HOST NEW name=host4 ip=10.0.0.1 resolve=static comment="IPv4 only host" mac=11:22:33:44:55:66
```

--------------------------------

### CONFIG XVPN SHOW

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.XVPN.SHOW

Displays the current configuration of the XVPN daemon, including its state, server settings, and various limits.

```APIDOC
## CONFIG XVPN SHOW

### Description
Show xvpn config

### Method
GET

### Endpoint
/config/xvpn/show

### Parameters
#### Query Parameters
* **level** (string) - Optional - The permission level required to execute the command (e.g., vpn_read).

#### Request Body
None

### Request Example
```
CONFIG XVPN SHOW
```

### Response
#### Success Response (200)
- **[Config]** (object) - Contains general XVPN configuration details.
  - **State** (integer) - xvpn daemon state.
  - **HttpServerState** (integer) - http server state.
  - **XServerState** (integer) - other server state.
  - **HttpRewriteURL** (string) - prefix of tag to rewrite URL.
  - **HttpHeaderLoginTag** (string) - name of tag to send login of user to server.
  - **ProfileAccess** (string) - action to proceed when user xvpn profile is not defined.
  - **XvpnId** (string) - name of xvpnd default profile.
  - **XserverStartScript** (string) - command to launch when xvpnd client starts.
  - **XserverEndScript** (string) - command to launch when xvpnd client stops.
  - **BasicAuth** (boolean) - force basic authentication.
  - **OwaCompatibility** (boolean) - activate OWA compatibility.
- **[MaxValue]** (object) - Contains maximum values for various XVPN components.
  - **XServer** (integer) - max number of other servers.
  - **HttpServer** (integer) - max number of http servers.
  - **HttpServerAlias** (integer) - max number of aliases for http servers.
  - **UrlsOnWhiteList** (integer) - max number of urls for whitelist.
- **[HttpServer_xxx]** (object) - Configuration for specific HTTP servers (where xxx is the server name).
  - **Name** (string) - name of the server.
  - **Host** (string) - server object to connect to.
  - **Port** (string) - server port to connect to.
  - **FwPort** (integer) - firewall listen port.
  - **Hidden** (boolean) - specify if server is visible or not for user.
  - **URL** (string) - url of the server to connect to.
  - **Link** (string) - link on the web page to call the URL.
  - **Alias** (string) - list of aliases for the server.
  - **WhiteListUrls** (string) - white list URL group name.
- **[XServer_xxx]** (object) - Configuration for specific X servers (where xxx is the server name).
  - **Name** (string) - name of the server.
  - **Host** (string) - server IP to connect to.
  - **Port** (integer) - server port to connect to.
  - **CHost** (string) - local IP to listen to (client workstation).
  - **CPort** (integer) - local port to listen to (client workstation).
  - **Script** (string) - command to launch for this service.

#### Response Example
```json
{
  "[Config]": {
    "State": 1,
    "XServerState": 1,
    "HttpServerState": 1,
    "HttpRewriteURL": "stormshield",
    "HttpHeaderLoginTag": "stormshield",
    "ProfileAccess": "Pass",
    "XvpnId": "",
    "XserverStartScript": "",
    "XserverEndScript": "",
    "Owa": 0,
    "OwaCompatibility": 0,
    "CheckClientCert": 0
  },
  "[MaxValue]": {
    "XServer": 32,
    "HttpServer": 64,
    "HttpServerAlias": 24,
    "UrlsOnWhiteList": 32
  },
  "[XServer_ssh_build]": {
    "Name": "ssh_build",
    "Host": "build",
    "Port": "ssh",
    "CHost": "",
    "CPort": 11022,
    "Script": "ImM6XHwMjI="
  },
  "[HttpServer_owa]": {
    "Name": "owa",
    "Host": "owa",
    "Port": "http",
    "FwPort": 11235,
    "Hidden": 0,
    "URL": "exchange",
    "Link": "OWA server",
    "WhiteListUrls": "owa",
    "Alias": "192.168.1.1"
  }
}
```
```

--------------------------------

### Example: Add IPv6 Range (CLI)

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.OBJECT.HOST.NEW

Example demonstrating how to add a new IPv6 range with a specified beginning and ending IPv6 address.

```cli
CONFIG OBJECT HOST NEW name=range6 beginv6=fe80::1 endv6=fe80::10 comment="IPv6 only range"
```

--------------------------------

### CONFIG NETWORK GATEWAY SHOW

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.NETWORK.GATEWAY.SHOW

Displays the complete network gateway configuration.

```APIDOC
## CONFIG NETWORK GATEWAY SHOW

### Description
Show complete gateway configuration

### Method
GET

### Endpoint
/config/network/gateway/show

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
```
GET /config/network/gateway/show
```

### Response
#### Success Response (200)
- **State** (integer) - Configuration state.
- **GatewayThreshold** (integer) - Gateway threshold value.
- **Tries** (integer) - Number of tries.
- **Frequency** (integer) - Frequency in seconds.
- **ActivateAllBackup** (integer) - Flag to activate all backups (0 or 1).
- **PrincipalGateway** (array of objects) - List of principal gateways.
  - **Pos** (integer) - Position of the gateway.
  - **Host** (string) - Hostname or IP address of the gateway.
  - **Check** (string) - Check condition for the gateway.
  - **Comment** (string) - Comment for the gateway.
- **BackupGateway** (array of objects) - List of backup gateways.
  - **Pos** (integer) - Position of the gateway.
  - **Host** (string) - Hostname or IP address of the gateway.
  - **Comment** (string) - Comment for the gateway.

#### Response Example
```json
{
  "State": 1,
  "GatewayThreshold": 1,
  "Tries": 3,
  "Frequency": 60,
  "ActivateAllBackup": 0,
  "PrincipalGateway": [
    {
      "Pos": 1,
      "Host": "Host_Default_Router",
      "Check": "Host_Behind_Default_Router",
      "Comment": "default"
    },
    {
      "Pos": 2,
      "Host": "Host_Router_Next",
      "Comment": ""
    }
  ],
  "BackupGateway": [
    {
      "Pos": 1,
      "Host": "Host_Bkp_Router",
      "Comment": ""
    },
    {
      "Pos": 2,
      "Host": "Host_Bkp_Router_Next",
      "Comment": ""
    }
  ]
}
```
```

--------------------------------

### Example: Add IPv4 Range (CLI)

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.OBJECT.HOST.NEW

Example demonstrating how to add a new IPv4 range with a specified beginning and ending IP address.

```cli
CONFIG OBJECT HOST NEW name=range4 begin=10.0.0.1 end=10.0.0.10 comment="IPv4 only range"
```

--------------------------------

### Activate PROXY_TCP Protocol Configuration

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.PROTOCOL.PROXY_TCP.ACTIVATE

This command activates the configuration for the PROXY_TCP protocol. It allows for immediate activation or activation upon the next boot.

```APIDOC
## CONFIG PROTOCOL PROXY_TCP ACTIVATE

### Description
Activate the PROXY_TCP protocol's configuration.

### Method
CONFIG PROTOCOL PROXY_TCP ACTIVATE

### Endpoint
Not applicable (CLI command)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
CONFIG PROTOCOL PROXY_TCP ACTIVATE [CANCEL|NEXTBOOT]
```

### Response
#### Success Response
Returns an error code indicating the success or failure of the operation.

#### Response Example
```
Error code: 0 (Success)
```
```

--------------------------------

### CONFIG DHCP6 PARAMETERS LIST

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.DHCP6.PARAMETERS.LIST

Lists the global parameters and options for the DHCPv6 server.

```APIDOC
## CONFIG DHCP6 PARAMETERS LIST

### Description
List DHCPv6 server global parameters and options.

### Method
GET

### Endpoint
/network/dhcp6/parameters

### Parameters
#### Query Parameters
- **domain-name** (string) - Optional - The domain name to be provided to clients.
- **default-ltime** (integer) - Optional - The default lease time for clients in seconds.
- **min-ltime** (integer) - Optional - The minimum lease time for clients in seconds.
- **max-ltime** (integer) - Optional - The maximum lease time for clients in seconds.

### Request Example
```
CONFIG DHCP6 PARAMETERS LIST
```

### Response
#### Success Response (200)
- **Parameters** (object) - An object containing the DHCPv6 server parameters.
  - **domain-name** (string) - The domain name for clients.
  - **default-ltime** (integer) - The default lease time for clients in seconds.
  - **min-ltime** (integer) - The minimum lease time for clients in seconds.
  - **max-ltime** (integer) - The maximum lease time for clients in seconds.

#### Response Example
```json
{
  "Parameters": {
    "domain-name": "my.domain.com",
    "default-ltime": 3600,
    "min-ltime": 600,
    "max-ltime": 7200
  }
}
```
```

--------------------------------

### REPORT GET DAY

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/REPORT.GET.DAY

Retrieves report results for a specific day. The results always cover a period starting at midnight.

```APIDOC
## REPORT GET DAY

### Description
Get report results regarding a specific day. These results always cover a period starting at midnight.

### Method
GET

### Endpoint
/report/day

### Parameters
#### Query Parameters
- **report** (string) - Required - The ID of the report for which to retrieve results.
- **offset** (integer) - Optional - Specifies the day to be covered by the results (0 = today, 1 = yesterday, etc.). Defaults to 0. The number of days supported depends on the firewall model.
- **format** (string) - Optional - The output format. Can be 'section_line' (default) or 'csv'.
- **content** (list) - Optional - A list of expected data, works only in linechart mode.
- **ip** (string) - Optional - The specific IP address to filter results for (mandatory and only works for hostrep reports).

### Request Example
```
REPORT GET DAY report=top_ips_alarms
REPORT GET DAY report=top_webdomains offset=3
REPORT GET DAY report=top_webdomains offset=3 format=csv
```

### Response
#### Success Response (200)
- **data** (string) - The report data in the specified format.

#### Response Example
```json
{
  "data": "[Report data in section_line or csv format]"
}
```
```

--------------------------------

### List Installed Antivirus Configurations (CLI)

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.ANTIVIRUS.LIST

This command retrieves a list of all installed antivirus configurations on the SNS system. It returns the name and the last modification date for each antivirus.

```CLI
# CONFIG ANTIVIRUS LIST
# Level: base
# History: Appears in Netasq 6.1.0
# Description: List installed antivirus
# Returns: Name and last modification date of each config
# Example:
# 101 code=00a01000 msg="Begin"
# [00]
# name="clamav"
# lastmod="2006-05-11 16:51:31"
# [01]
# name="AdvancedAV"
# lastmod="2006-01-10 11:28:40"
# 100 code=00a00100 msg="Ok"
```

--------------------------------

### PROFINET-PTCP Profile Configuration Commands

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.PROTOCOL.PROFINET-PTCP.PROFILE

This section outlines the various commands available for configuring the PROFINET-PTCP protocol profiles. These commands allow for managing alarms, checks, copying, defaults, IPS, listing, showing, and updating profile settings.

```APIDOC
## PROFINET-PTCP Profile Configuration

### Description

This section details the configuration commands for the PROFINET-PTCP protocol profiles. These commands allow for managing alarms, checks, copying, defaults, IPS, listing, showing, and updating profile settings.

### Commands

- **CONFIG.PROTOCOL.PROFINET-PTCP.PROFILE.ALARM**
  - Description: Configures alarm settings for the PROFINET-PTCP profile.
  - Level: base, asq

- **CONFIG.PROTOCOL.PROFINET-PTCP.PROFILE.CHECK**
  - Description: Performs checks on the PROFINET-PTCP profile settings.
  - Level: base, asq

- **CONFIG.PROTOCOL.PROFINET-PTCP.PROFILE.COPY**
  - Description: Copies PROFINET-PTCP profile settings.
  - Level: base, asq

- **CONFIG.PROTOCOL.PROFINET-PTCP.PROFILE.DEFAULT**
  - Description: Resets the PROFINET-PTCP profile to default settings.
  - Level: base, asq

- **CONFIG.PROTOCOL.PROFINET-PTCP.PROFILE.IPS**
  - Description: Configures IPS (Inter-Process Signaling) settings for the PROFINET-PTCP profile.
  - Level: base, asq

- **CONFIG.PROTOCOL.PROFINET-PTCP.PROFILE.LIST**
  - Description: Lists available PROFINET-PTCP profiles.
  - Level: base, asq

- **CONFIG.PROTOCOL.PROFINET-PTCP.PROFILE.SHOW**
  - Description: Displays the current PROFINET-PTCP profile settings.
  - Level: base, asq

- **CONFIG.PROTOCOL.PROFINET-PTCP.PROFILE.UPDATE**
  - Description: Updates the PROFINET-PTCP profile settings.
  - Level: base, asq

### Parameters

- **Level** (string) - base, asq - Specifies the access level for the command.
```

--------------------------------

### Example: Rename Host Object in SNS CLI

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.GLOBAL.OBJECT.RENAME

An example demonstrating how to rename a host object named 'foo' to 'bar' using the 'config global object rename' command in the SNS CLI.

```cli
config global object rename type=host oldname=foo newname=bar
```

--------------------------------

### Show Global QoS Parameters (Netasq CLI)

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.OBJECT.QOS.SHOW

This command displays the global Quality of Service (QoS) parameters configured on the device. It is part of the Netasq command-line interface and is useful for monitoring and troubleshooting network traffic management settings. The output includes details like Drop, Max_Qids, Default_QLen, and Max_QLen.

```cli
CONFIG QOS SHOW 101 code=00a01000 msg="Begin"
[QoS]
Drop=0
Max_Qids=98
Default_QLen=200
Max_QLen=500
100 code=00a00100 msg="Ok"
```

--------------------------------

### Example IPS UUID Rule Update

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.PROTOCOL.NB-CIFS_TCP.PROFILE.IPS.UUID.UPDATE

An example demonstrating the usage of the CONFIG PROTOCOL NB-CIFS_TCP PROFILE IPS UUID UPDATE command. This specific example updates rule ID 1 in profile index 0, setting a specific UUID, action to block, and assigning it to group 'group2'.

```cli
CONFIG PROTOCOL NB-CIFS_TCP PROFILE IPS UUID UPDATE index=0 rule=1 uuid="00000000-0000-0000-0000-000000000000" action=block group="group2"
```

--------------------------------

### CONFIG MODEM UPDATE

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.MODEM.UPDATE

Configures a modem with various parameters such as state, name, model, vendor ID, product ID, and initialization strings.

```APIDOC
## CONFIG MODEM UPDATE

### Description
Configure a modem with specified parameters.

### Method
MAINTENANCE, MODIFY

### Endpoint
Not applicable (CLI command)

### Parameters
#### Usage
`Index=<modem_idx> [State=(1|0)] [Name=<modem user name>] [Model=(<string>|"")] [VendorId=(<hex string>|"")] [ProductIdInit=(<hex string>|"")] [ModeSwitchString=(<hex string>|"")] [ProductId=(<hex string>|"")] [CommandPort=(<integer>|"")] [MonitoringPort=(<integer>|"")] [InitString1=(<string>|"")] [InitString2=(<string>|"")] [InitString3=(<string>|"")]`

#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None (CLI command arguments)

### Request Example
```
CONFIG MODEM UPDATE Index=0 State=1 Name="My 4G Operator" Model="My 4G Key Model" VendorId=01ab ProductId=08ff
CONFIG MODEM UPDATE Index=0 State=0
```

### Response
#### Success Response
Error code

#### Response Example
(No specific example provided, returns an error code)
```

--------------------------------

### CONFIG OPENVPN ACTIVATE

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.OPENVPN.ACTIVATE

Applies the OpenVPN configuration and reloads the OpenVPN service.

```APIDOC
## CONFIG OPENVPN ACTIVATE

### Description
Applies the OpenVPN configuration and reloads the OpenVPN service with the new configuration.

### Method
POST (Assumed, as it modifies service state)

### Endpoint
/config/openvpn/activate

### Parameters
#### Query Parameters
- **CANCEL** (string) - Optional - Discards changes.

#### Request Body
(No specific request body defined in the provided text, but typically would contain the configuration details)

### Request Example
```json
{
  "configuration": "<your_openvpn_config_here>"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates successful activation.

#### Error Response (e.g., 400, 500)
- **errorCode** (integer) - The error code returned by the service.

#### Response Example
```json
{
  "status": "OpenVPN configuration activated successfully."
}
```

```json
{
  "errorCode": 101
}
```
```

--------------------------------

### REPORT GET LAST7DAYS

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/REPORT.GET.LAST7DAYS

Retrieves report results for the last 7 days. The results cover a period starting at D-7 midnight and ending today at midnight (today is excluded).

```APIDOC
## REPORT GET LAST7DAYS

### Description
Get report results regarding the last 7 days.

### Method
GET

### Endpoint
/report/last7days

### Parameters
#### Query Parameters
- **report** (string) - Required - Report ID for which we want the results.
- **format** (string) - Optional - Output format. Can be 'section_line' (default) or 'csv'.
- **content** (string) - Optional - List of expected data (works in linechart only).
- **ip** (string) - Optional - Wanted IP address (mandatory and only works for hostrep reports).

### Request Example
```
REPORT GET LAST7DAYS report=top_ips_alarms
REPORT GET LAST7DAYS report=top_webdomains format=csv
```

### Response
#### Success Response (200)
- **data** (object) - Report data. The structure depends on the report type.

#### Response Example
```json
{
  "data": [
    {
      "field1": "value1",
      "field2": "value2"
    }
  ]
}
```
```

--------------------------------

### Example Network Interface Configuration (INI)

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.NETWORK.INTERFACE.AGGREGATE

This INI-formatted configuration snippet shows an example of an Ethernet interface configured to be part of an aggregate interface. It includes settings like state, name, media type, color, and the aggregate interface name it belongs to.

```ini
[Ethernet1]
State=1
Name=Ethernet_1
Media=0
Color=408080
Agg=agg1
```

--------------------------------

### Activate HTTP-WEBSOCKET Protocol Configuration

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.PROTOCOL.HTTP-WEBSOCKET.ACTIVATE

This command activates the configuration for the HTTP-WEBSOCKET protocol. It supports options to either cancel or apply the configuration on the next boot.

```APIDOC
## CONFIG PROTOCOL HTTP-WEBSOCKET ACTIVATE

### Description
Activate the HTTP-WEBSOCKET protocol's configuration.

### Method
Not specified (likely a CLI command, not an HTTP request)

### Endpoint
Not applicable (CLI command)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
CONFIG PROTOCOL HTTP-WEBSOCKET ACTIVATE [CANCEL|NEXTBOOT]
```

### Response
#### Success Response (0)
Returns an error code (specific codes not detailed in the provided text).

#### Response Example
```
Error code: [code]
```
```

--------------------------------

### CONFIG XVPN PROFILE LIST

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.XVPN.PROFILE.LIST

Lists all server profiles for XVPN. Returns an error code if no profiles are found, otherwise returns the list of profiles.

```APIDOC
## CONFIG XVPN PROFILE LIST

### Description
Lists all server profiles for XVPN.

### Method
GET (assumed, as it's a listing command)

### Endpoint
/config/xvpn/profile/list (assumed)

### Parameters
#### Query Parameters
None specified.

#### Request Body
None specified.

### Request Example
```
CONFIG XVPN PROFILE LIST
```

### Response
#### Success Response (200)
- **NetasqIdXvpn** (string) - The identifier for the XVPN profile.

#### Response Example
```json
{
  "NetasqIdXvpn": "mail"
}
{
  "NetasqIdXvpn": "web"
}
```

#### Error Response (e.g., 404)
- **Error code** (integer) - Indicates that no profiles were found.
```

--------------------------------

### CONFIG OBJECT URLGROUP CHECK

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.OBJECT.URLGROUP.CHECK

Checks an URL/CN/OEM group object. This command is available starting from Netasq 9.0.0.

```APIDOC
## CONFIG OBJECT URLGROUP CHECK

### Description
Check an URL/CN/OEM group object

### Method
GET (Implicit, command-line execution)

### Endpoint
Not applicable (CLI command)

### Parameters
#### Query Parameters
- **name** (string) - Required - The name of the group to check.
- **type** (string) - Required - The type of group to check. Accepted values: urlgroup, cngroup, oemgroup, iocgroup.

### Request Example
```
CONFIG OBJECT URLGROUP CHECK name=antivirus_bypass type=urlgroup
CONFIG OBJECT URLGROUP CHECK name=bank_bypass type=cngroup
CONFIG OBJECT URLGROUP CHECK name=ads type=oemgroup
```

### Response
#### Success Response (200)
- **module** (string) - The module associated with the configuration.
- **slot** (string) - The slot number (00-10).
- **line** (integer) - The line number within the configuration.
- **section** (string) - The configuration section.
- **profile** (string) - The configuration profile (00-03).

#### Response Example
```json
{
  "module": "urlfilter",
  "slot": "01",
  "line": 15,
  "section": "default",
  "profile": "00"
}
```
```

--------------------------------

### CONFIG PVM PROFILE LIST

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.PVM.PROFILE.LIST

Lists all defined PVM profiles, including their names and associated comments.

```APIDOC
## CONFIG PVM PROFILE LIST

### Description
Lists all defined profiles.

### Method
CLI Command

### Endpoint
N/A (CLI Command)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
CONFIG PVM PROFILE LIST
```

### Response
#### Success Response (200)
- **profile** (string) - The name of the profile.
- **comment** (string) - The comment associated with the profile.

#### Response Example
```
101 code=00a01000 msg="Début"
profile=profile1 comment=x
profile=profile2 comment=x
100 code=00a00100 msg="Ok"
```
```

--------------------------------

### CONFIG AUTH SSL CAVERIFY REMOVE

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.AUTH.SSL.CAVERIFY.REMOVE

Removes an authority from the list. This command is available starting from Netasq 9.0.0.

```APIDOC
## POST /config/auth/ssl/caverify/remove

### Description
Removes an authority from the list.

### Method
POST

### Endpoint
/config/auth/ssl/caverify/remove

### Parameters
#### Query Parameters
- **id** (integer) - Required - The ID of the list from which to remove the authority.

### Request Example
```json
{
  "id": 1
}
```

### Response
#### Success Response (200)
- **ErrorCode** (integer) - Description of the error code returned upon successful execution.

#### Response Example
```json
{
  "ErrorCode": 0
}
```
```

--------------------------------

### Configure Dynamic DNS Client (CLI)

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.DDNSCLIENT.NEW

Creates a new dynamic DNS client configuration. Requires a name for the configuration and the provider (dyndns or noip). Returns an error code upon completion.

```bash
CONFIG DDNSCLIENT NEW name=<confname> provider=<dyndns|noip>
```

```bash
CONFIG DDNSCLIENT NEW name=DynamicDNS provider=dyndns
```

--------------------------------

### CONFIG AUTOBACKUP SHOW

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.AUTOBACKUP.SHOW

Displays the current autobackup configuration settings.

```APIDOC
## CONFIG AUTOBACKUP SHOW

### Description
Show the autobackup config.

### Method
GET

### Endpoint
/config/autobackup/show

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **AUTOBACKUP** (object) - Autobackup configuration details.
  - **State** (string) - The state of the autobackup.
  - **DistantBackup** (boolean) - Indicates if distant backup is enabled.
  - **Server** (string) - The name of the server object.
  - **Port** (string) - The port object name for the server.
  - **Path** (string) - The backup path.
  - **Period** (string) - The backup period.
  - **BackupId** (string) - The backup ID.
  - **BackupPassword** (string) - The backup password.
  - **IgnoreProxy** (0|1) - Whether to ignore the proxy.
  - **BindAddr** (string) - The bind address (host).
  - **Protocol** (string) - The protocol used for backup.
  - **Mode** (string) - The mode used for backup.
  - **AuthUsername** (string) - The authentication username.
  - **AuthPassword** (string) - The authentication password.
  - **ControlName** (string) - The HTTP control name.
  - **servercertificate** (string) - Reference to the server certificate.
  - **clientcertificate** (string) - Reference to the client certificate.

#### Response Example
```json
{
  "AUTOBACKUP": {
    "State": "enabled",
    "DistantBackup": true,
    "Server": "my_backup_server",
    "Port": "8080",
    "Path": "/backups",
    "Period": "daily",
    "BackupId": "backup-123",
    "BackupPassword": "********",
    "IgnoreProxy": 0,
    "BindAddr": "192.168.1.100",
    "Protocol": "https",
    "Mode": "full",
    "AuthUsername": "backup_user",
    "AuthPassword": "********",
    "ControlName": "http_control",
    "servercertificate": "server.crt",
    "clientcertificate": "client.crt"
  }
}
```
```

--------------------------------

### Add SNMP Trap v3 Configuration Example

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.SNMP.TRAP.V3.MODIFY

An example demonstrating how to add a new SNMP trap v3 configuration. This includes specifying the host, port, authentication method and password, security name, engine ID, security level, and privacy method and password.

```cli
CONFIG SNMP TRAP V3 ADD host=trapV3 port=162 AuthMethod=SHA128 AuthPass=passpass  SecurityName=James engineID=0x0102030405 SecurityLevel=authNoPriv  PrivMethod=DES PrivPass=passpass
```

--------------------------------

### CONFIG DNS STATE

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.DNS.STATE

This command allows you to get or set the DNS state on the SNS device. The state can be set to 'On' or 'Off'.

```APIDOC
## CONFIG DNS STATE

### Description
Get or set the DNS state.

### Method
CLI Command

### Endpoint
N/A (CLI Command)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
CONFIG DNS STATE On
CONFIG DNS STATE Off
```

### Response
#### Success Response (200)
Returns the current DNS state.
- **State** (string) - The current state of DNS, either 'on' or 'off'.

#### Response Example
```json
{
  "State": "on"
}
```

### Remark
Network and Modify levels are required to update the state value.
```

--------------------------------

### CONFIG QOS SHOW

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.OBJECT.QOS.SHOW

Displays global Quality of Service (QoS) parameters.

```APIDOC
## CONFIG QOS SHOW

### Description
Show global QoS parameters.

### Method
GET (Implicit)

### Endpoint
CONFIG QOS SHOW

### Parameters
#### Query Parameters
- **101** (integer) - Optional - A status code, likely for internal use.

### Request Example
```
CONFIG QOS SHOW 101 code=00a01000 msg="Begin"
```

### Response
#### Success Response (200)
- **Drop** (integer) - The current drop count for QoS.
- **Max_Qids** (integer) - The maximum number of QoS IDs allowed.
- **Default_QLen** (integer) - The default queue length for QoS.
- **Max_QLen** (integer) - The maximum queue length for QoS.

#### Response Example
```json
{
  "Drop": 0,
  "Max_Qids": 98,
  "Default_QLen": 200,
  "Max_QLen": 500
}
```

**Note:** This command was first introduced in Netasq 6.1.0.
```

--------------------------------

### CONFIG GLOBAL OBJECT TIME CHECK

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.GLOBAL.OBJECT.TIME.CHECK

Checks the global time object configuration. This command is available starting from Netasq 9.0.0.

```APIDOC
## CONFIG GLOBAL OBJECT TIME CHECK

### Description
Checks the global time object configuration.

### Method
N/A (CLI Command)

### Endpoint
N/A (CLI Command)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Usage
`name=<timeobject name>`

### Returns
[Configuration]
`module=<string> (slot=<00-10> line=<int>| section=<string>|profile=<00-03> section=<string>)`

### Format
`section_line`

### Example
```
config global object host check name=daysoff
```

### Response
#### Success Response (200)
[Configuration]
`module=Filter slot=04 line=1`
```

--------------------------------

### CONFIG DNS SHOW

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.DNS.SHOW

Displays the current DNS configuration settings for the SNS system.

```APIDOC
## CONFIG DNS SHOW

### Description
Show DNS configuration.

### Method
GET (Implied by the command structure, typically a read operation)

### Endpoint
Not applicable for CLI commands, but conceptually represents querying the serverd configuration.

### Parameters
None

### Request Example
```
CONFIG DNS SHOW
```

### Response
#### Success Response (200)
- **[Config]** (object) - DNS configuration details.
  - **State** (string) - 'on' or 'off'. Indicates if the DNS proxy is enabled.
  - **[Advanced]** (object) - Advanced DNS settings.
    - **redirect** (string) - 'on' or 'off'. Indicates if redirection is enabled.
    - **cacheSize** (string) - Cache size in bytes.
    - **cacheMaxSize** (string) - Maximum cache size in bytes.
    - **randomServerOrder** (string) - 'on' or 'off'. Indicates if random server order is enabled.
    - **ipsend** (string) - Specifies the IP sending interface (e.g., 'Firewall_in').

#### Response Example
```json
{
  "[Config]": {
    "State": "On"
  },
  "[Advanced]": {
    "redirect": "Off",
    "cacheSize": "999424",
    "cacheMaxSize": "5000000",
    "randomServerOrder": "On",
    "ipsend": "Firewall_in"
  }
}
```
```

--------------------------------

### CONFIG PROTOCOL OPENVPN_TCP ACTIVATE

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.PROTOCOL.OPENVPN_TCP.ACTIVATE

Activates the configuration for the OPENVPN_TCP protocol. This command allows for immediate or next boot activation.

```APIDOC
## CONFIG PROTOCOL OPENVPN_TCP ACTIVATE

### Description
Activate the OPENVPN_TCP protocol's configuration.

### Method
Not specified (likely a CLI command, not a REST API)

### Endpoint
Not applicable (CLI command)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
CONFIG PROTOCOL OPENVPN_TCP ACTIVATE [CANCEL|NEXTBOOT]
```

### Response
#### Success Response (200)
Returns an error code (specific codes not detailed).

#### Response Example
```
Error code
```
```

--------------------------------

### Show CONFIG GLOBAL OBJECT IMPORT STATUS

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/CONFIG.GLOBAL.OBJECT.IMPORT.STATUS

Displays the status of the last import for the global configuration object. This command is available starting from version 3.0.0.

```bash
config object import status
```

--------------------------------

### REPORT GET LAST30DAYS

Source: https://documentation.stormshield.eu/SNS/v4/en/Content/CLI_Serverd_Commands_reference_Guide_v4/Commands/serverd/REPORT.GET.LAST30DAYS

Retrieves report results for the last 30 days. The results cover a period starting from D-30 at midnight and ending today at midnight (today is excluded). An error will be returned if there is no /log on the firewall.

```APIDOC
## REPORT GET LAST30DAYS

### Description
Get report results regarding the last 30 days.

### Method
GET

### Endpoint
/report/last30days

### Parameters
#### Query Parameters
- **report** (string) - Required - Report ID for which we want the results.
- **format** (string) - Optional - Output format: 'section_line' (default) or 'csv'.
- **content** (string) - Optional - List of expected data, works in linechart only.
- **ip** (string) - Optional - Wanted IP address (mandatory and only works for hostrep reports).

### Request Example
```
REPORT GET LAST30DAYS report=top_ips_alarms
REPORT GET LAST30DAYS report=top_webdomains format=csv
```

### Response
#### Success Response (200)
- **report_data** (object) - The report results. The structure depends on the report type and format.

#### Response Example
(See REPORT GET LASTHOUR for response structure as it is similar)
```json
{
  "report_data": "..."
}
```
```
Tokens:
Raw