Skip to content
Open
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 config/sidebar/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -593,6 +593,7 @@
+ [How to see node inventory](hosted-private-cloud/opcp/how-to-see-node-inventory)
+ [How to handle the NetBox rack elevation](hosted-private-cloud/opcp/how-to-handle-rack-elevation)
+ [How the Ironic to NetBox synchronisation works](hosted-private-cloud/opcp/netbox-ironic-synchronisation)
+ [How to interact with NetBox safely](hosted-private-cloud/opcp/how-to-interact-with-netbox-safely)
+ [How to use Terraform](hosted-private-cloud/opcp/use-terraform)
+ [How to update the backup S3 buckets](hosted-private-cloud/opcp/how-to-update-backup-s3-buckets)
+ [Security](hosted-private-cloud-hosted-private-cloud-opcp-security)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
title: NetBox Automation - How to interact with your NetBox instance safely
description: Learn how to identify which NetBox objects are managed automatically, which are yours to maintain, and how to make changes without conflicting with automation
lastUpdated: 2026-07-15
---

## Objective

**This guide will help you interact with your NetBox instance safely while parts of its inventory are managed automatically.**

## Requirements

- Access to your NetBox web interface.

## Instructions

### How NetBox is organised

Your NetBox instance contains two kinds of objects:

- **Objects managed automatically.** These carry the **`automation-managed`** tag. They are created and kept in sync with the external Source of Truth (SoT). You do not need to maintain them.

- **Objects managed by you.** These do not carry the `automation-managed` tag. They are yours: create, edit, delete, retag, comment — whatever your workflow requires.


The `automation-managed` tag is the single signal that tells you which side an object belongs to. When in doubt, check the tag.

:::warning
Do not remove the `automation-managed` tag from objects that carry it, and do not add it to objects you create yourself. Doing either of these will cause the automation to overwrite your changes on its next run.
:::

### Making changes

The method to modify an object depends on whether it is automation-managed.

**For objects without the `automation-managed` tag:**

Make changes directly in the NetBox UI as usual. The automation does not touch these objects.

**For objects with the `automation-managed` tag:**

These are driven by the external Source of Truth.

:::info
If you edit an `automation-managed` object directly in NetBox, the next automation run will revert your change. The SoT is authoritative for these objects.
:::

These changes will persist across automation runs.

### The Automation State tenant

In the **Tenancy** section of NetBox, you will see a tenant named **`Automation State`** (slug: `automation-state`). This tenant holds internal bookkeeping used by the automation.

:::warning
Do not delete the `Automation State` tenant, and do not edit its custom fields (`automation_non_taggable_state` and `initializer_sot_hash`). Modifying or deleting them will cause the automation to misbehave on its next run.
:::

### Quick reference

| Action | Allowed? |
|---|---|
| Edit an object without the `automation-managed` tag | Yes |
| Add journal entries, comments, or other tags on any object | Yes |
| Edit a field on an `automation-managed` object that the SoT manages | Will be reverted on the next run |
| Delete an object with the `automation-managed` tag | Will be recreated on the next run |
| Remove the `automation-managed` tag from an object | Will be added again on the next run |
| Add the `automation-managed` tag to an object you created | Causes the automation to overwrite or delete it |

### What to expect during normal operation

- **Changelog entries from the automation account** after each successful run. This is normal.
- **A short-lived branch** named `initializer-automation`. It is created, used, and merged (or removed) by the automation.
- **The `automation-managed` tag** present on many objects.
- **The `Automation State` tenant** present in your tenant list.

## Go further

For training or technical assistance implementing our solutions, contact your sales representative or visit our [Professional Services](/links/professional-services) page to request a quote and have your project analysed by our experts.

Join our [community of users](/links/community).
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
title: "NetBox Automation - Interagir avec votre instance NetBox en toute sécurité"
description: "Découvrez comment identifier les objets NetBox gérés automatiquement, ceux dont vous avez la charge, et comment effectuer des modifications sans entrer en conflit avec l'automatisation"
lastUpdated: 2026-07-15
---

## Objectif

**Ce guide vous aide à interagir en toute sécurité avec votre instance NetBox lorsqu'une partie de son inventaire est gérée automatiquement.**

## Prérequis

- Avoir accès à l'interface web de votre NetBox.

## En pratique

### Organisation de NetBox

Votre instance NetBox contient deux types d'objets :

- **Les objets gérés automatiquement.** Ils portent le tag **`automation-managed`**. Ils sont créés et maintenus synchronisés avec la Source of Truth (SoT) externe. Vous n'avez pas à les maintenir.

- **Les objets que vous gérez vous-même.** Ils ne portent pas le tag `automation-managed`. Ils vous appartiennent : créez, modifiez, supprimez, retaguez, commentez — selon les besoins de votre workflow.


Le tag `automation-managed` est le seul indicateur qui vous permet de savoir à quel côté appartient un objet. En cas de doute, vérifiez le tag.

:::warning
Ne retirez pas le tag `automation-managed` des objets qui le portent, et ne l'ajoutez pas aux objets que vous créez vous-même. L'une comme l'autre de ces actions conduira l'automatisation à écraser vos modifications lors de sa prochaine exécution.
:::

### Effectuer des modifications

La méthode pour modifier un objet dépend de son caractère géré ou non par l'automatisation.

**Pour les objets sans le tag `automation-managed` :**

Effectuez vos modifications directement dans l'interface de NetBox, comme d'habitude. L'automatisation ne touche pas à ces objets.

**Pour les objets avec le tag `automation-managed` :**

Ils sont pilotés par la Source of Truth externe.

:::info
Si vous modifiez un objet `automation-managed` directement dans NetBox, la prochaine exécution de l'automatisation annulera votre modification. La SoT fait référence pour ces objets.
:::

Ces modifications persistent d'une exécution de l'automatisation à l'autre.

### Le tenant Automation State

Dans la section **Tenancy** de NetBox, vous verrez un tenant nommé **`Automation State`** (slug : `automation-state`). Ce tenant contient des données de gestion interne utilisées par l'automatisation.

:::warning
Ne supprimez pas le tenant `Automation State` et ne modifiez pas ses champs personnalisés (`automation_non_taggable_state` et `initializer_sot_hash`). Les modifier ou les supprimer entraînera un dysfonctionnement de l'automatisation lors de sa prochaine exécution.
:::

### Référence rapide

| Action | Autorisée ? |
|---|---|
| Modifier un objet sans le tag `automation-managed` | Oui |
| Ajouter des entrées de journal, des commentaires ou d'autres tags sur n'importe quel objet | Oui |
| Modifier un champ géré par la SoT sur un objet `automation-managed` | Sera annulé à la prochaine exécution |
| Supprimer un objet portant le tag `automation-managed` | Sera recréé à la prochaine exécution |
| Retirer le tag `automation-managed` d'un objet | Sera rajouté à la prochaine exécution |
| Ajouter le tag `automation-managed` à un objet que vous avez créé | Conduit l'automatisation à l'écraser ou à le supprimer |

### À quoi s'attendre en fonctionnement normal

- **Des entrées de changelog émises par le compte de l'automatisation** après chaque exécution réussie. C'est normal.
- **Une branche éphémère** nommée `initializer-automation`. Elle est créée, utilisée puis fusionnée (ou supprimée) par l'automatisation.
- **Le tag `automation-managed`** présent sur de nombreux objets.
- **Le tenant `Automation State`** présent dans votre liste de tenants.

## Aller plus loin

Pour une formation ou une assistance technique sur la mise en œuvre de nos solutions, contactez votre commercial ou consultez la page [Professional Services](/links/professional-services) pour obtenir un devis et faire analyser votre projet par nos experts.

Échangez avec notre [communauté d'utilisateurs](/links/community).