Skip to content

[Update] Linode Config Interfaces (VLAN descriptions) #848

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.

Sign up for GitHub

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 2 commits into from
Sep 12, 2023
Merged

[Update] Linode Config Interfaces (VLAN descriptions) #848

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6542844
Updates vlan config interface descriptions related to 222 bug
bbiggerr Sep 8, 2023
ce3eda4
Revisions to vlan config interface descriptions
bbiggerr Sep 8, 2023
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
31 changes: 19 additions & 12 deletions openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22593,13 +22593,16 @@ components:
description: |
The name of this interface.

Required for `vlan` purpose interfaces. Must be an empty string or `null` for `public` purpose interfaces.
For `vlan` purpose interfaces:
* Required.
* Must be unique among the Linode's interfaces (a Linode cannot be attached to the same VLAN multiple times).
* May only consist of ASCII letters, numbers, and dashes (`-`).

If the VLAN label is new, a VLAN is created. Up to 10 VLANs can be created in each data center region. To view your active VLANs, use the [VLANs List](/docs/api/networking/#vlans-list) endpoint.

May only consist of ASCII letters, numbers, and dashes (`-`).
For `public` purpose interfaces:
* In requests, must be an empty string (`""`) or `null` if included.
* In responses, always returns `null`.

Must be unique among the Linode's interfaces.
If the VLAN label is new, a VLAN is created. Up to 10 VLANs can be created in each data center region. To view your active VLANs, use the [VLANs List](/docs/api/networking/#vlans-list) endpoint.
example: example-interface
ipam_address:
type: string
Expand All @@ -22608,11 +22611,15 @@ components:
description: |
This Network Interface's private IP address in Classless Inter-Domain Routing (CIDR) notation.

Only used for `vlan` purpose interfaces. Must be an empty string or `null` for `public` purpose interfaces.
For `vlan` purpose interfaces:
* Must be unique among the Linode's interfaces to avoid conflicting addresses.
* Should be unique among devices attached to the VLAN to avoid conflict.

The Linode is configured to use this address for the associated interface upon reboot if Network Helper is enabled. If Network Helper is disabled, the address can be enabled with [manual static IP configuration](/docs/guides/manual-network-configuration/).
For `public` purpose interfaces:
* In requests, must be an empty string (`""`) or `null` if included.
* In responses, always returns `null`.

Must be unique among the Linode's interfaces.
The Linode is configured to use this address for the associated interface upon reboot if Network Helper is enabled. If Network Helper is disabled, the address can be enabled with [manual static IP configuration](/docs/guides/manual-network-configuration/).
example: '10.0.0.1/24'
purpose:
type: string
Expand All @@ -22625,7 +22632,7 @@ components:
* `public`
* Only one `public` interface per Linode can be defined.
* The Linode's default public IPv4 address is assigned to the `public` interface.
* A Linode must have a public interface in the first/eth0 position to be reachable via the public internet upon boot without additional system configuration. If no `public` interface is configured, the Linode is not directly reachable via the public internet. In this case, access can only be established via LISH or other Linodes connected to the same VLAN.
* A Linode must have a public interface in the first/eth0 position to be reachable via the public internet upon boot without additional system configuration. If no `public` interface is configured, the Linode is not directly reachable via the public internet. In this case, access can only be established via [LISH](/docs/products/compute/compute-instances/guides/lish/) or other Linodes connected to the same VLAN.

* `vlan`
* Configuring a `vlan` purpose interface attaches this Linode to the VLAN with the specified `label`.
Expand All @@ -22642,9 +22649,9 @@ components:

Up to three interface objects can be entered in this array. The position in the array determines the interface to which the settings apply:

- First/0: eth0
- Second/1: eth1
- Third/2: eth2
- First [0]: eth0
- Second [1]: eth1
- Third [2]: eth2

When updating a Linode's interfaces, *each interface must be redefined*. An empty interfaces array results in a default public interface configuration only.

Expand Down