Ds vsphere logs

pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vsphere_logs_syslog_ldp/guide.en-gb.md

@@ -0,0 +1,197 @@
+---
+title: "Enable syslog and LDP subscription for vSphere logs"
+excerpt: "Learn how to forward vSphere logs to your own syslog server or subscribe to the OVHcloud Log Data Platform (LDP) service"
+updated: 2025-10-13
+---
+
+## Objective
+
+This guide explains how to activate vSphere log forwarding through two different methods:
+
+- **Syslog Forward**, to export NSX-T logs to your own syslog server.
+- **LDP subscription**, to centralise VMware logs within the **OVHcloud Log Data Platform (LDP)**.
+
+It also helps you select the most appropriate solution depending on your Hosted Private Cloud configuration (SNC, PCI-DSS, or standard).
+
+## Prerequisites
+
+- A [Hosted Private Cloud service](/links/hosted-private-cloud) running vSphere version 6.5 or higher.
+- Access to the [OVHcloud API](/links/api).
+- The `syslogForward` security option enabled on your PCC.
+- A valid destination for the logs:
+    - **Customer syslog server**, reachable via your private VLAN (RFC 5424 compliant).
+    - **OVHcloud Log Data Platform (LDP)** stream with the same NIC as your PCC
+- Administrative rights to create or modify log forwarding rules.
+
+## Step 1 - Compare Syslog and LDP forwarding methods
+
+| Method | Logs available | Network | Certification | Cost | Ideal for |
+|:--|:--|:--|:--|:--|:--|
+| **Syslog Forward** | NSX-T logs only | Private VLAN (no public network for SNC) | PCI-DSS / SNC compatible | Free | Private, secure log export |
+| **LDP subscription** | ESXi, vCenter, NSX-T (filtered) | Public network | Not available for PCI-DSS / SNC | Paid | Centralised log correlation and observability |
+
+> [!primary]
+> Syslog Forward is the default method for most Hosted Private Cloud services.
+> The LDP option is recommended for advanced monitoring and observability use cases.
+
+## Step 2 - Activate Syslog Forward
+
+You can enable the Syslog Forward feature directly from the **OVHcloud Control Panel** or through the **OVHcloud API**.
+
+### Through the OVHcloud Control Panel
+
+1. Go to your `Hosted Private Cloud` service in your [OVHcloud Control Panel](/links/manager).
+
+2. Select your VMware service, then click the `Logs`{.action} tab.
+
+3. Click `Activate log transfer via Syslog`{.action}.
+
+4. Wait for the activation process to complete (this may take up to 20 minutes).
+
+5. When activation is complete, a confirmation banner appears indicating that logs are now being sent via Syslog.
+
+> [!warning]
+> The `Logs` tab may not yet be visible in your OVHcloud Control Panel.  
+> It becomes available once the Syslog Forward feature is enabled for your PCC service.
+
+### Through the OVHcloud API
+
+1. Log in to the [OVHcloud API](/links/api).
+
+2. Create a new syslog forwarder using the following route:
+
+> [!api]
+> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/syslogForward/forwarder
+
+3. Fill in the required parameters:
+
+| Parameter | Description |
+|:--|:--|
+| `ip` | Destination IP address of your syslog server |
+| `port` | Listening port (default: 6514 for TLS) |
+| `protocol` | `tcp` or `tls` |
+| `sourceType` | Example: `nsxtEdge`, `nsxtManager` |
+| `logLevel` | `error`, `warning`, or `info` |
+
+4. Validate the configuration.
+
+5. You can verify your server configuration using a compatible syslog daemon such as **syslog-ng**, **rsyslog**, or **fluentd**.
+
+<<Screenshot placeholder – Syslog activation form in vSphere Manager>>
+
+### Configuration examples
+
+#### Syslog-ng (TLS)
+
+```bash
+source s_syslog_server {
+    network(ip("0.0.0.0") port(7514)
+        transport("tls")
+        tls(
+            key_file("/etc/ssl/private/syslog.key")
+            cert_file("/etc/ssl/certs/syslog.pem")
+            peer-verify(optional-trusted)
+        )
+    );
+};
+destination d_syslog_server {
+    file("/var/log/syslog-ng-server/test.log");
+};
+log {
+    source(s_syslog_server);
+    destination(d_syslog_server);
+};
+```
+
+#### Rsyslog (TLS)
+
+```bash
+module(load="imtcp"
+StreamDriver.Name="gtls"
+StreamDriver.Mode="1"
+StreamDriver.Authmode="anon"
+)
+
+global(
+DefaultNetstreamDriver="gtls"
+DefaultNetstreamDriverCertFile="/etc/ssl/certs/syslog.pem"
+DefaultNetstreamDriverKeyFile="/etc/ssl/private/syslog.key"
+)
+input(type="imtcp" port="7514" ruleset="syslog_tls")
+```
+
+<<Screenshot placeholder – Example syslog server configuration>>
+
+## Step 3 - Activate LDP subscription
+
+If you prefer to consume VMware logs directly through the **Log Data Platform (LDP)**, you can subscribe to an existing LDP stream.
+
+1. Make sure that the `syslogForward` option is enabled on your PCC.
+
+2. Your LDP stream must use the same NIC as your PCC and offer equivalent security.
+
+3. Subscription is available for **non-SNC** and **non-PCI-DSS** clusters only.
+
+Logs available through LDP:
+
+| Source | Log type |
+|:--|:--|
+| ESXi | `app.hostd`, `app.dfw` |
+| vCenter | `vpxd` |
+| NSX-T | `app.nsx` |
+
+<<Screenshot placeholder – LDP subscription form>>
+
+### API route to create an LDP subscription
+
+> [!api]
+> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/logForward/ldp/subscription
+
+| Parameter | Description |
+|:--|:--|
+| `ldpStream` | Name of the target LDP stream |
+| `securityLevel` | Must match your PCC configuration |
+| `filter` | Optional log filters |
+| `activation` | Specify `true` to start forwarding immediately |
+
+## Step 4 - Monitoring and troubleshooting
+
+Each log forward is monitored automatically via **Zabbix** using discovery rules.
+
+Monitored checks:
+
+- Syslog server accessibility (telnet to `<ip>:<port>`).
+- SSL certificate thumbprint validity.
+
+If an issue is detected:
+
+- A **self-healing process** will try to re-establish the connection.
+- If the problem persists, the system triggers an incident for further investigation.
+- Customers receive an **automatic email** if the issue comes from their configuration.
+
+Notification example:
+
+> **Subject:** Configuration issue on your log server
+> “We were unable to reach your syslog server or its SSL certificate thumbprint does not match the expected value. Please update it using the following API route.”
+
+> [!api]
+> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/syslogForward/forwarder/{logForwardId}/changeProperties
+
+<<Screenshot placeholder – Monitoring view in Manager>>
+
+## Step 5. Disable or remove a Syslog Forward
+
+> [!api]
+> @api {v1} /dedicatedCloud DELETE /dedicatedCloud/{serviceName}/syslogForward/forwarder/{logForwardId}
+
+This route removes the existing forwarding configuration and stops log export to the target syslog server.
+
+## Go further
+
+- [Managing granular rights on vSphere objects](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vsphere_granular_rights)
+- [Creating an alert on your vSphere client](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/create_an_alert)
+- [OVHcloud Log Data Platform documentation](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_ldp)
+
+If you need training or technical assistance to implement our solutions, please contact your sales representative or click [this link](/links/professional-services) to get a quote and request a personalised analysis of your project from our Professional Services team.
+
+Join our [community of users](/links/community).

pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vsphere_logs_syslog_ldp/guide.fr-fr.md

@@ -0,0 +1,197 @@
+---
+title: "Activer le Syslog et l’abonnement LDP pour les journaux vSphere"
+excerpt: "Découvrez comment transférer les journaux vSphere vers votre propre serveur syslog ou les centraliser via le service Log Data Platform (LDP) d’OVHcloud"
+updated: 2025-10-13
+---
+
+## Objectif
+
+Ce guide explique comment activer le transfert des journaux vSphere selon deux méthodes :
+
+- **Syslog Forward**, pour exporter les journaux NSX-T vers un serveur syslog géré par le client.
+- **Abonnement LDP**, pour centraliser les journaux VMware dans la plateforme **OVHcloud Log Data Platform (LDP)**.
+
+Il vous aide également à choisir la solution la plus adaptée à votre environnement Hosted Private Cloud (SNC, PCI-DSS ou standard).
+
+## Prérequis
+
+- Disposer d'un [service Hosted Private Cloud](/links/hosted-private-cloud) utilisant une version de vSphere 6.5 ou ultérieure.
+- Avoir accès à l’[API OVHcloud](/links/api).
+- Avoir activé l’option de sécurité `syslogForward` sur votre PCC.
+- Disposer d'une destination valide pour les journaux :
+    - **Serveur syslog client**, joignable via un VLAN privé (conforme à la norme RFC 5424).
+    - **Flux LDP OVHcloud**, utilisant la même interface réseau (NIC) que votre PCC.
+- Disposer des droits administrateur nécessaires pour créer ou modifier les règles de transfert de journaux.
+
+## Étape 1 - Comparer les méthodes Syslog et LDP
+
+| Méthode | Journaux disponibles | Réseau | Certification | Coût | Cas d’usage idéal |
+|:--|:--|:--|:--|:--|:--|
+| **Syslog Forward** | Journaux NSX-T uniquement | VLAN privé (pas de réseau public pour SNC) | Compatible PCI-DSS / SNC | Gratuit | Export sécurisé et privé |
+| **Abonnement LDP** | ESXi, vCenter, NSX-T (filtrés) | Réseau public | Non disponible pour les environnements PCI-DSS ou SNC | Payant | Corrélation et observabilité centralisées |
+
+> [!primary]
+> Le Syslog Forward est la méthode par défaut pour la plupart des services Hosted Private Cloud.
+> L’abonnement LDP est recommandé pour les besoins avancés de supervision et d’observabilité.
+
+## Étape 2 - Activer le Syslog Forward
+
+Vous pouvez activer la fonctionnalité Syslog Forward directement depuis **l’espace client OVHcloud** ou via **l’API OVHcloud**.
+
+### Depuis l’espace client OVHcloud
+
+1. Accédez à votre service `Hosted Private Cloud` dans votre [espace client OVHcloud](/links/manager).
+
+2. Sélectionnez votre service VMware, puis cliquez sur l’onglet `Logs`{.action}.
+
+3. Cliquez sur `Activer le transfert de logs via le système Syslog`{.action}.
+
+4. Patientez le temps que l’activation se termine (cela peut prendre jusqu’à 20 minutes).
+
+5. Une fois terminée, une bannière de confirmation s’affiche indiquant que les journaux sont désormais transférés via Syslog.
+
+> [!warning]
+> L’onglet `Logs` peut ne pas encore être visible dans votre espace client OVHcloud.
+> Il devient disponible une fois la fonctionnalité Syslog Forward activée pour votre service PCC.
+
+### Via l’API OVHcloud
+
+1. Connectez-vous à l’[API OVHcloud](/links/api).
+
+2. Créez un nouveau forwarder syslog via l’appel suivant :
+
+> [!api]
+> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/syslogForward/forwarder
+
+3. Renseignez les paramètres requis :
+
+| Paramètre | Description |
+|:--|:--|
+| `ip` | Adresse IP de destination de votre serveur syslog |
+| `port` | Port d’écoute (par défaut : 6514 pour TLS) |
+| `protocol` | `tcp` ou `tls` |
+| `sourceType` | Exemple : `nsxtEdge`, `nsxtManager` |
+| `logLevel` | `error`, `warning` ou `info` |
+
+4. Validez la configuration.
+
+5. Vérifiez la réception des journaux sur votre serveur syslog (compatible avec **syslog-ng**, **rsyslog** ou **fluentd**).
+
+<<Screenshot placeholder – Syslog activation form in vSphere Manager>>
+
+### Exemples de configuration
+
+#### Syslog-ng (TLS)
+
+```bash
+source s_syslog_server {
+    network(ip("0.0.0.0") port(7514)
+        transport("tls")
+        tls(
+            key_file("/etc/ssl/private/syslog.key")
+            cert_file("/etc/ssl/certs/syslog.pem")
+            peer-verify(optional-trusted)
+        )
+    );
+};
+destination d_syslog_server {
+    file("/var/log/syslog-ng-server/test.log");
+};
+log {
+    source(s_syslog_server);
+    destination(d_syslog_server);
+};
+```
+
+#### Rsyslog (TLS)
+
+```bash
+module(load="imtcp"
+StreamDriver.Name="gtls"
+StreamDriver.Mode="1"
+StreamDriver.Authmode="anon"
+)
+
+global(
+DefaultNetstreamDriver="gtls"
+DefaultNetstreamDriverCertFile="/etc/ssl/certs/syslog.pem"
+DefaultNetstreamDriverKeyFile="/etc/ssl/private/syslog.key"
+)
+input(type="imtcp" port="7514" ruleset="syslog_tls")
+```
+
+<<Screenshot placeholder – Interface d’un serveur syslog recevant les journaux VMware>>
+
+## Étape 3 - Activer un abonnement LDP
+
+Si vous préférez centraliser vos journaux VMware directement dans **Log Data Platform (LDP)**, vous pouvez souscrire à un flux LDP existant.
+
+1. Vérifiez que l’option `syslogForward` est activée sur votre PCC.
+
+2. Le flux LDP doit utiliser la même interface réseau (NIC) que votre PCC et offrir un niveau de sécurité équivalent.
+
+3. Cette fonctionnalité est disponible uniquement pour les clusters **non SNC** et **non PCI-DSS**.
+
+Journaux disponibles via LDP :
+
+| Source | Types de journaux |
+|:--|:--|
+| ESXi | `app.hostd`, `app.dfw` |
+| vCenter | `vpxd` |
+| NSX-T | `app.nsx` |
+
+<<Screenshot placeholder – Page d’abonnement LDP dans le Manager OVHcloud avec sélection du flux>>
+
+### Appel API pour créer un abonnement LDP
+
+> [!api]
+> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/logForward/ldp/subscription
+
+| Paramètre | Description |
+|:--|:--|
+| `ldpStream` | Nom du flux LDP cible |
+| `securityLevel` | Doit correspondre à la configuration de votre PCC |
+| `filter` | Filtres optionnels sur les journaux |
+| `activation` | Indiquer `true` pour activer immédiatement le transfert |
+
+## Étape 4 - Supervision et dépannage
+
+Chaque log forward est surveillé automatiquement par **Zabbix** à l’aide de règles de découverte.
+
+Points de contrôle :
+
+- Accessibilité du serveur syslog (telnet sur `<ip>:<port>`).
+- Validité de l’empreinte du certificat SSL.
+
+En cas de problème :
+
+- Un **processus de récupération automatique** tente de rétablir la connexion.
+- Si l’anomalie persiste, un incident est déclenché pour investigation.
+- Le client reçoit une **notification automatique** si le problème provient d’une mauvaise configuration.
+
+Exemple de notification :
+
+> **Objet:** Problème de configuration sur votre serveur de logs
+> « Nous n'avons pas pu atteindre votre serveur syslog ou son empreinte de certificat SSL ne correspond pas à la valeur attendue. Merci de le mettre à jour en utilisant la route API suivante. »
+
+> [!api]
+> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/syslogForward/forwarder/{logForwardId}/changeProperties
+
+<<Screenshot placeholder – Vue de supervision affichant l’état du syslogForward>>
+
+## Étape 5 - Désactiver ou supprimer un Syslog Forward
+
+> [!api]
+> @api {v1} /dedicatedCloud DELETE /dedicatedCloud/{serviceName}/syslogForward/forwarder/{logForwardId}
+
+Cet appel supprime la configuration existante et interrompt le transfert des journaux vers le serveur syslog cible.
+
+## Aller plus loin
+
+- [Gérer les droits granulaires sur les objets vSphere](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vsphere_granular_rights)
+- [Créer une alerte sur votre client vSphere](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/monitoring_and_alerts)
+- [Documentation OVHcloud Log Data Platform](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_ldp)
+
+Si vous avez besoin d’une formation ou d’une assistance technique pour la mise en œuvre de nos solutions, contactez votre représentant commercial ou cliquez sur [ce lien](/links/professional-services) pour obtenir un devis et demander une analyse personnalisée de votre projet par notre équipe Professional Services.
+
+Rejoignez notre [communauté d’utilisateurs](/links/community).