netbox/docs/models/ipam/vlantranslationrule.md

# VLAN Translation Rules

!!! info "This feature was introduced in NetBox v4.2."

A VLAN translation rule represents a one-to-one mapping of a local VLAN ID (VID) to a remote VID. Many rules can belong to a single policy.

See [VLAN translation policies](./vlantranslationpolicy.md) for an overview of the VLAN Translation feature.

## Fields

### Policy

The [VLAN Translation Policy](./vlantranslationpolicy.md) to which this rule belongs.

### Local VID

VLAN ID (1-4094) in the local network which is to be translated to a remote VID.

### Remote VID

VLAN ID (1-4094) in the remote network to which the local VID will be translated.
Fixes: #7336 - VLAN Translation (#17745) * VLANTranslationPolicy and VLANTranslationRule models and all associated UI classes * Change VLANTranslationPolicy to a PrimaryModel and make name unique * Add serializer classes to InterfaceSerializer * Remake migrations * Add GraphQL typing * Skip tagged models in test * Missing migration * Remove get_absolute_url methods * Remove package-lock.json * Rebuild migration and add constraints and field options * Rebuild migrations * Use DynamicModelChoiceField for policy field * Make vlan_translation_policy fields on filtersets more consistent with existing __name convention * Add vlan_translation_table to VMInterface detail page * Add vlan_translation_policy to VMInterfaceSerializer * Move vlan_translation_policy fields to model and filterset mixins * Protect in-use policies against deletion * Add vlan_translation_policy to fields in VMInterfaceSerializer * Cleanup indentation * Remove unnecessary ordering column * Rebuild migrations * Search methods and registration * Ensure 'id' column is present by default * Add graphql types/filters/schema for VLANTranslationRule * Filterset tests * View tests * API and viewset tests (incomplete) * Add tags to VLANTranslationRuleForm * Complete viewset tests for VLANTranslationRule * Make VLANTranslationRule.policy nullable (but still required) * Revert "Make VLANTranslationRule.policy nullable (but still required)" This reverts commit 4c1bb437ef1a0a3593e5fbb87f08a0f158ea8c47. * Revert nullability * Explicitly prefetch policy in graphql * Documentation of new and affected models * Add note about select_related in graphql * Rework policy/rule documentation * Move vlan_translation_policy into 802.1Q Switching fieldset * Remove redundant InterfaceVLANTranslationTable * Conditionally include vlan_translation_table in interface.html and vminterface.html * Add description field to VLANTranslationRule * Define vlan_translation_table conditionally * Add policy (name) filter to VLANTranslationRuleFilterSet * Revert changes to adding-models.md (moved to another PR) * Dynamic table for linked rules in vlantranslationpolicy.html * Misc cleanup --------- Co-authored-by: Jeremy Stretch <jstretch@netboxlabs.com> 2024-10-30 17:09:46 -04:00			`# VLAN Translation Rules`

Update documentation for v4.2 2024-11-26 12:38:29 -05:00			`!!! info "This feature was introduced in NetBox v4.2."`

Fixes: #7336 - VLAN Translation (#17745) * VLANTranslationPolicy and VLANTranslationRule models and all associated UI classes * Change VLANTranslationPolicy to a PrimaryModel and make name unique * Add serializer classes to InterfaceSerializer * Remake migrations * Add GraphQL typing * Skip tagged models in test * Missing migration * Remove get_absolute_url methods * Remove package-lock.json * Rebuild migration and add constraints and field options * Rebuild migrations * Use DynamicModelChoiceField for policy field * Make vlan_translation_policy fields on filtersets more consistent with existing __name convention * Add vlan_translation_table to VMInterface detail page * Add vlan_translation_policy to VMInterfaceSerializer * Move vlan_translation_policy fields to model and filterset mixins * Protect in-use policies against deletion * Add vlan_translation_policy to fields in VMInterfaceSerializer * Cleanup indentation * Remove unnecessary ordering column * Rebuild migrations * Search methods and registration * Ensure 'id' column is present by default * Add graphql types/filters/schema for VLANTranslationRule * Filterset tests * View tests * API and viewset tests (incomplete) * Add tags to VLANTranslationRuleForm * Complete viewset tests for VLANTranslationRule * Make VLANTranslationRule.policy nullable (but still required) * Revert "Make VLANTranslationRule.policy nullable (but still required)" This reverts commit 4c1bb437ef1a0a3593e5fbb87f08a0f158ea8c47. * Revert nullability * Explicitly prefetch policy in graphql * Documentation of new and affected models * Add note about select_related in graphql * Rework policy/rule documentation * Move vlan_translation_policy into 802.1Q Switching fieldset * Remove redundant InterfaceVLANTranslationTable * Conditionally include vlan_translation_table in interface.html and vminterface.html * Add description field to VLANTranslationRule * Define vlan_translation_table conditionally * Add policy (name) filter to VLANTranslationRuleFilterSet * Revert changes to adding-models.md (moved to another PR) * Dynamic table for linked rules in vlantranslationpolicy.html * Misc cleanup --------- Co-authored-by: Jeremy Stretch <jstretch@netboxlabs.com> 2024-10-30 17:09:46 -04:00			`A VLAN translation rule represents a one-to-one mapping of a local VLAN ID (VID) to a remote VID. Many rules can belong to a single policy.`

			`See [VLAN translation policies](./vlantranslationpolicy.md) for an overview of the VLAN Translation feature.`

			`## Fields`

			`### Policy`

			`The [VLAN Translation Policy](./vlantranslationpolicy.md) to which this rule belongs.`

			`### Local VID`

			`VLAN ID (1-4094) in the local network which is to be translated to a remote VID.`

			`### Remote VID`

			`VLAN ID (1-4094) in the remote network to which the local VID will be translated.`