Skip to content

OCC Diagnostics - New feature documentation #7794

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Apr 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions pages/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -1833,6 +1833,7 @@
+ [Installation of OVHcloud Connect Provider from the OVHcloud Control Panel](network/ovhcloud_connect/occ-provider-control-panel)
+ [FAQ](network/ovhcloud_connect/occdedicated-faq)
+ [Troubleshooting common errors setting up OVHcloud Connect](network/ovhcloud_connect/occ-setup-diagnostics)
+ [How to initiate a diagnostic for OVHcloud Connect from the OVHcloud Control Panel](network/ovhcloud_connect/occ-diagnostics)
+ [Technical resources](network-ovhcloud-connect-technical-resources)
+ [Technical capabilities and limitations](network/ovhcloud_connect/occ-limits)
+ [Configuration](network-ovhcloud-connect-configuration)
Expand Down
93 changes: 93 additions & 0 deletions pages/network/ovhcloud_connect/occ-diagnostics/guide.de-de.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
---
title: How to initiate a diagnostic for OVHcloud Connect from the OVHcloud Control Panel
excerpt: Find out how to get a status report of your OVHcloud Connect services
updated: 2025-04-28
---

## Objective

With OVHcloud Connect, you can link your company network to your private OVHcloud vRack network, without creating a VPN tunnel through the internet. This will give you a quicker, more stable connection with guaranteed bandwidth.

**This guide will show you how to get a status report of your OVHcloud Connect services via the OVHcloud Control Panel.**

## Requirements

- An [OVHcloud Connect solution](/links/network/ovhcloud-connect) with a valid POP configuration.
- Access to the [OVHcloud Control Panel](/links/manager).

## List of available diagnostics

### Layer 3 mode

- **Default**: Fetches the BGP session states and all related information.
- **Routes**: Fetches the routing table learned by OVHcloud via BGP.
- **Advertised-Routes**: Fetches the routing table advertised by OVHcloud via BGP.

### Layer 2 mode

- **MAC Address**: Fetches the list of MAC addresses of network devices and vRack.

## Instructions

### Layer 3 mode

You can find the list of your `OVHcloud Connect`{.action} services in the `Network`{.action} section of your [OVHcloud Control Panel](/links/manager).

![OCC Control Panel](images/OCC_cpanel.png){.thumbnail}

Open the service for which you want to get a diagnosis:

![OCC Service](images/OCC_service_BGP.png){.thumbnail}

At the bottom of the "POP Configuration" panel, you will find a segment named "Diagnostic POP", and an ellipsis button `...`{.action}. Click it, and then select "BGP Peering Test":

![OCC Service Test Button](images/OCC_service_test_button_BGP.png){.thumbnail}

A window will open. Select the type of diagnostics you wish to use, and click "launch diagnostic":

![OCC Diagnostics Choice](images/OCC_diag_choice.png){.thumbnail}

You can now access the list of your diagnostics by opening the "Diagnostics" tab.

![OCC Diagnostics Tab](images/OCC_diag_tab_BGP.png){.thumbnail}

Each diagnostic is referred to using an ID and a timestamp.
To access the diagnostics content, click the ellipsis button `...`{.action} located to the right of each one listed. You can select either "See result" to have a window open with the content of the desired diagnostic, or "Download result" to get a *.txt* file with the same content.

![OCC Diagnostic view button](images/OCC_diag_view_button.png){.thumbnail}

### Layer 2 mode

You can find the list of your `OVHcloud Connect`{.action} services in the `Network`{.action} section of your [OVHcloud Control Panel](/links/manager).

![OCC Control Panel](images/OCC_cpanel.png){.thumbnail}

Open the service for which you want to get a diagnosis:

![OCC Service](images/OCC_service_MAC.png){.thumbnail}

At the bottom of the "POP Configuration" panel, you will find a segment named "Diagnostic POP", and an ellipsis button `...`{.action}. Click it, and then select "Get the list of my MAC addresses":

![OCC Service Test Button](images/OCC_service_test_button_MAC.png){.thumbnail}

You can now access the list of your diagnostics by opening the "Diagnostics" tab.

![OCC Diagnostics Tab](images/OCC_diag_tab_MAC.png){.thumbnail}

Each diagnostic is referred to using an ID and a timestamp.
To access the diagnostics content, click the ellipsis button `...`{.action} located to the right of each one listed. You can select either "See result" to have a window open with the content of the desired diagnostic, or "Download result" to get a *.txt* file with the same content.

![OCC Diagnostic view button](images/OCC_diag_view_button.png){.thumbnail}

## Limits

- **Retention time of diagnostics**: Only diagnostics initiated **within the last seven days** are accessible. We recommend you download them and properly archive them, in case you need future access.

- **Maximum number of diagnostics**: On a 24 hour period, you can initiate a maximum of 10 diagnostics per type of diagnostic, and per service. For example, if you have two OVHcloud Connect services configured on your OVHcloud Control Panel, both configured in Layer 3 mode, you can theoretically launch 10 of each diagnostic type per service, for a total of 60.<br>
This limit has been set in order to restrict the amount of resources used by the OVHcloud infrastructures, as the diagnostics are launched in real-time.

## Go further

If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for assisting you on your specific use case of your project.

Join our [community of users](/links/community).
93 changes: 93 additions & 0 deletions pages/network/ovhcloud_connect/occ-diagnostics/guide.en-asia.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
---
title: How to initiate a diagnostic for OVHcloud Connect from the OVHcloud Control Panel
excerpt: Find out how to get a status report of your OVHcloud Connect services
updated: 2025-04-28
---

## Objective

With OVHcloud Connect, you can link your company network to your private OVHcloud vRack network, without creating a VPN tunnel through the internet. This will give you a quicker, more stable connection with guaranteed bandwidth.

**This guide will show you how to get a status report of your OVHcloud Connect services via the OVHcloud Control Panel.**

## Requirements

- An [OVHcloud Connect solution](/links/network/ovhcloud-connect) with a valid POP configuration.
- Access to the [OVHcloud Control Panel](/links/manager).

## List of available diagnostics

### Layer 3 mode

- **Default**: Fetches the BGP session states and all related information.
- **Routes**: Fetches the routing table learned by OVHcloud via BGP.
- **Advertised-Routes**: Fetches the routing table advertised by OVHcloud via BGP.

### Layer 2 mode

- **MAC Address**: Fetches the list of MAC addresses of network devices and vRack.

## Instructions

### Layer 3 mode

You can find the list of your `OVHcloud Connect`{.action} services in the `Network`{.action} section of your [OVHcloud Control Panel](/links/manager).

![OCC Control Panel](images/OCC_cpanel.png){.thumbnail}

Open the service for which you want to get a diagnosis:

![OCC Service](images/OCC_service_BGP.png){.thumbnail}

At the bottom of the "POP Configuration" panel, you will find a segment named "Diagnostic POP", and an ellipsis button `...`{.action}. Click it, and then select "BGP Peering Test":

![OCC Service Test Button](images/OCC_service_test_button_BGP.png){.thumbnail}

A window will open. Select the type of diagnostics you wish to use, and click "launch diagnostic":

![OCC Diagnostics Choice](images/OCC_diag_choice.png){.thumbnail}

You can now access the list of your diagnostics by opening the "Diagnostics" tab.

![OCC Diagnostics Tab](images/OCC_diag_tab_BGP.png){.thumbnail}

Each diagnostic is referred to using an ID and a timestamp.
To access the diagnostics content, click the ellipsis button `...`{.action} located to the right of each one listed. You can select either "See result" to have a window open with the content of the desired diagnostic, or "Download result" to get a *.txt* file with the same content.

![OCC Diagnostic view button](images/OCC_diag_view_button.png){.thumbnail}

### Layer 2 mode

You can find the list of your `OVHcloud Connect`{.action} services in the `Network`{.action} section of your [OVHcloud Control Panel](/links/manager).

![OCC Control Panel](images/OCC_cpanel.png){.thumbnail}

Open the service for which you want to get a diagnosis:

![OCC Service](images/OCC_service_MAC.png){.thumbnail}

At the bottom of the "POP Configuration" panel, you will find a segment named "Diagnostic POP", and an ellipsis button `...`{.action}. Click it, and then select "Get the list of my MAC addresses":

![OCC Service Test Button](images/OCC_service_test_button_MAC.png){.thumbnail}

You can now access the list of your diagnostics by opening the "Diagnostics" tab.

![OCC Diagnostics Tab](images/OCC_diag_tab_MAC.png){.thumbnail}

Each diagnostic is referred to using an ID and a timestamp.
To access the diagnostics content, click the ellipsis button `...`{.action} located to the right of each one listed. You can select either "See result" to have a window open with the content of the desired diagnostic, or "Download result" to get a *.txt* file with the same content.

![OCC Diagnostic view button](images/OCC_diag_view_button.png){.thumbnail}

## Limits

- **Retention time of diagnostics**: Only diagnostics initiated **within the last seven days** are accessible. We recommend you download them and properly archive them, in case you need future access.

- **Maximum number of diagnostics**: On a 24 hour period, you can initiate a maximum of 10 diagnostics per type of diagnostic, and per service. For example, if you have two OVHcloud Connect services configured on your OVHcloud Control Panel, both configured in Layer 3 mode, you can theoretically launch 10 of each diagnostic type per service, for a total of 60.<br>
This limit has been set in order to restrict the amount of resources used by the OVHcloud infrastructures, as the diagnostics are launched in real-time.

## Go further

If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for assisting you on your specific use case of your project.

Join our [community of users](/links/community).
93 changes: 93 additions & 0 deletions pages/network/ovhcloud_connect/occ-diagnostics/guide.en-au.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
---
title: How to initiate a diagnostic for OVHcloud Connect from the OVHcloud Control Panel
excerpt: Find out how to get a status report of your OVHcloud Connect services
updated: 2025-04-28
---

## Objective

With OVHcloud Connect, you can link your company network to your private OVHcloud vRack network, without creating a VPN tunnel through the internet. This will give you a quicker, more stable connection with guaranteed bandwidth.

**This guide will show you how to get a status report of your OVHcloud Connect services via the OVHcloud Control Panel.**

## Requirements

- An [OVHcloud Connect solution](/links/network/ovhcloud-connect) with a valid POP configuration.
- Access to the [OVHcloud Control Panel](/links/manager).

## List of available diagnostics

### Layer 3 mode

- **Default**: Fetches the BGP session states and all related information.
- **Routes**: Fetches the routing table learned by OVHcloud via BGP.
- **Advertised-Routes**: Fetches the routing table advertised by OVHcloud via BGP.

### Layer 2 mode

- **MAC Address**: Fetches the list of MAC addresses of network devices and vRack.

## Instructions

### Layer 3 mode

You can find the list of your `OVHcloud Connect`{.action} services in the `Network`{.action} section of your [OVHcloud Control Panel](/links/manager).

![OCC Control Panel](images/OCC_cpanel.png){.thumbnail}

Open the service for which you want to get a diagnosis:

![OCC Service](images/OCC_service_BGP.png){.thumbnail}

At the bottom of the "POP Configuration" panel, you will find a segment named "Diagnostic POP", and an ellipsis button `...`{.action}. Click it, and then select "BGP Peering Test":

![OCC Service Test Button](images/OCC_service_test_button_BGP.png){.thumbnail}

A window will open. Select the type of diagnostics you wish to use, and click "launch diagnostic":

![OCC Diagnostics Choice](images/OCC_diag_choice.png){.thumbnail}

You can now access the list of your diagnostics by opening the "Diagnostics" tab.

![OCC Diagnostics Tab](images/OCC_diag_tab_BGP.png){.thumbnail}

Each diagnostic is referred to using an ID and a timestamp.
To access the diagnostics content, click the ellipsis button `...`{.action} located to the right of each one listed. You can select either "See result" to have a window open with the content of the desired diagnostic, or "Download result" to get a *.txt* file with the same content.

![OCC Diagnostic view button](images/OCC_diag_view_button.png){.thumbnail}

### Layer 2 mode

You can find the list of your `OVHcloud Connect`{.action} services in the `Network`{.action} section of your [OVHcloud Control Panel](/links/manager).

![OCC Control Panel](images/OCC_cpanel.png){.thumbnail}

Open the service for which you want to get a diagnosis:

![OCC Service](images/OCC_service_MAC.png){.thumbnail}

At the bottom of the "POP Configuration" panel, you will find a segment named "Diagnostic POP", and an ellipsis button `...`{.action}. Click it, and then select "Get the list of my MAC addresses":

![OCC Service Test Button](images/OCC_service_test_button_MAC.png){.thumbnail}

You can now access the list of your diagnostics by opening the "Diagnostics" tab.

![OCC Diagnostics Tab](images/OCC_diag_tab_MAC.png){.thumbnail}

Each diagnostic is referred to using an ID and a timestamp.
To access the diagnostics content, click the ellipsis button `...`{.action} located to the right of each one listed. You can select either "See result" to have a window open with the content of the desired diagnostic, or "Download result" to get a *.txt* file with the same content.

![OCC Diagnostic view button](images/OCC_diag_view_button.png){.thumbnail}

## Limits

- **Retention time of diagnostics**: Only diagnostics initiated **within the last seven days** are accessible. We recommend you download them and properly archive them, in case you need future access.

- **Maximum number of diagnostics**: On a 24 hour period, you can initiate a maximum of 10 diagnostics per type of diagnostic, and per service. For example, if you have two OVHcloud Connect services configured on your OVHcloud Control Panel, both configured in Layer 3 mode, you can theoretically launch 10 of each diagnostic type per service, for a total of 60.<br>
This limit has been set in order to restrict the amount of resources used by the OVHcloud infrastructures, as the diagnostics are launched in real-time.

## Go further

If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for assisting you on your specific use case of your project.

Join our [community of users](/links/community).
93 changes: 93 additions & 0 deletions pages/network/ovhcloud_connect/occ-diagnostics/guide.en-ca.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
---
title: How to initiate a diagnostic for OVHcloud Connect from the OVHcloud Control Panel
excerpt: Find out how to get a status report of your OVHcloud Connect services
updated: 2025-04-28
---

## Objective

With OVHcloud Connect, you can link your company network to your private OVHcloud vRack network, without creating a VPN tunnel through the internet. This will give you a quicker, more stable connection with guaranteed bandwidth.

**This guide will show you how to get a status report of your OVHcloud Connect services via the OVHcloud Control Panel.**

## Requirements

- An [OVHcloud Connect solution](/links/network/ovhcloud-connect) with a valid POP configuration.
- Access to the [OVHcloud Control Panel](/links/manager).

## List of available diagnostics

### Layer 3 mode

- **Default**: Fetches the BGP session states and all related information.
- **Routes**: Fetches the routing table learned by OVHcloud via BGP.
- **Advertised-Routes**: Fetches the routing table advertised by OVHcloud via BGP.

### Layer 2 mode

- **MAC Address**: Fetches the list of MAC addresses of network devices and vRack.

## Instructions

### Layer 3 mode

You can find the list of your `OVHcloud Connect`{.action} services in the `Network`{.action} section of your [OVHcloud Control Panel](/links/manager).

![OCC Control Panel](images/OCC_cpanel.png){.thumbnail}

Open the service for which you want to get a diagnosis:

![OCC Service](images/OCC_service_BGP.png){.thumbnail}

At the bottom of the "POP Configuration" panel, you will find a segment named "Diagnostic POP", and an ellipsis button `...`{.action}. Click it, and then select "BGP Peering Test":

![OCC Service Test Button](images/OCC_service_test_button_BGP.png){.thumbnail}

A window will open. Select the type of diagnostics you wish to use, and click "launch diagnostic":

![OCC Diagnostics Choice](images/OCC_diag_choice.png){.thumbnail}

You can now access the list of your diagnostics by opening the "Diagnostics" tab.

![OCC Diagnostics Tab](images/OCC_diag_tab_BGP.png){.thumbnail}

Each diagnostic is referred to using an ID and a timestamp.
To access the diagnostics content, click the ellipsis button `...`{.action} located to the right of each one listed. You can select either "See result" to have a window open with the content of the desired diagnostic, or "Download result" to get a *.txt* file with the same content.

![OCC Diagnostic view button](images/OCC_diag_view_button.png){.thumbnail}

### Layer 2 mode

You can find the list of your `OVHcloud Connect`{.action} services in the `Network`{.action} section of your [OVHcloud Control Panel](/links/manager).

![OCC Control Panel](images/OCC_cpanel.png){.thumbnail}

Open the service for which you want to get a diagnosis:

![OCC Service](images/OCC_service_MAC.png){.thumbnail}

At the bottom of the "POP Configuration" panel, you will find a segment named "Diagnostic POP", and an ellipsis button `...`{.action}. Click it, and then select "Get the list of my MAC addresses":

![OCC Service Test Button](images/OCC_service_test_button_MAC.png){.thumbnail}

You can now access the list of your diagnostics by opening the "Diagnostics" tab.

![OCC Diagnostics Tab](images/OCC_diag_tab_MAC.png){.thumbnail}

Each diagnostic is referred to using an ID and a timestamp.
To access the diagnostics content, click the ellipsis button `...`{.action} located to the right of each one listed. You can select either "See result" to have a window open with the content of the desired diagnostic, or "Download result" to get a *.txt* file with the same content.

![OCC Diagnostic view button](images/OCC_diag_view_button.png){.thumbnail}

## Limits

- **Retention time of diagnostics**: Only diagnostics initiated **within the last seven days** are accessible. We recommend you download them and properly archive them, in case you need future access.

- **Maximum number of diagnostics**: On a 24 hour period, you can initiate a maximum of 10 diagnostics per type of diagnostic, and per service. For example, if you have two OVHcloud Connect services configured on your OVHcloud Control Panel, both configured in Layer 3 mode, you can theoretically launch 10 of each diagnostic type per service, for a total of 60.<br>
This limit has been set in order to restrict the amount of resources used by the OVHcloud infrastructures, as the diagnostics are launched in real-time.

## Go further

If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for assisting you on your specific use case of your project.

Join our [community of users](/links/community).
Loading