interface_settings
Creates, updates, deletes, gets or lists an interface_settings resource.
Overview
| Name | interface_settings |
| Type | Resource |
| Id | linode.linode.interface_settings |
Fields
The following fields are returned by SELECT queries:
- get
Returns a single Linode interface settings object.
| Name | Datatype | Description |
|---|---|---|
default_route | object | Interfaces used for the IPv4 default_route and IPv6 default_route when multiple interfaces are eligible for the role. |
network_helper | boolean | Enables the Network Helper feature. The default value is determined by the network_helper setting in the account settings. Power off the Linode before disabling or enabling Network Helper. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | linodeId | Beta Lists a Linode's interface settings, including Network Helper and default route settings. This operation is for Linode interfaces, not for legacy configuration profile interfaces. Learn more... Learn more... | |
update | replace | linodeId | Beta Updates Network Helper and default route settings on the Linode. CLI: Public interface.<br /> linode-cli linodes interface-settings-update $linodeId \<br /> --network_helper true \<br /> --default_route.ipv4_interface_id 4527 \<br /> --default_route.ipv6_interface_id 4541 \<br /> --default_route.ipv4_eligible_interface_ids 4527 \<br /> --default_route.ipv4_eligible_interface_ids 4541 \<br /> --default_route.ipv6_eligible_interface_ids 4527 \<br /> --default_route.ipv6_eligible_interface_ids 4541<br /> Learn more... - CLI: VLAN interface. <br /> linode-cli linodes interface-settings-update $linodeId \<br /> --network_helper true<br /> Learn more... - CLI: VPC interface. <br /> linode-cli linodes interface-settings-update $linodeId \<br /> --network_helper true \<br /> --default_route.ipv4_interface_id 5527 \<br /> --default_route.ipv4_eligible_interface_ids 5527 \<br /> --default_route.ipv4_eligible_interface_ids 5541<br /> Learn more... Learn more... |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
linodeId | string | The id of the Linode. |
SELECT examples
- get
Beta Lists a Linode's interface settings, including Network Helper and default route settings. This operation is for Linode interfaces, not for legacy configuration profile interfaces.
Learn more...
Learn more...
SELECT
default_route,
network_helper
FROM linode.linode.interface_settings
WHERE linodeId = '{{ linodeId }}' -- required
;
REPLACE examples
- update
Beta Updates Network Helper and default route settings on the Linode. CLI: Public interface.
<br /> linode-cli linodes interface-settings-update $linodeId \<br /> --network_helper true \<br /> --default_route.ipv4_interface_id 4527 \<br /> --default_route.ipv6_interface_id 4541 \<br /> --default_route.ipv4_eligible_interface_ids 4527 \<br /> --default_route.ipv4_eligible_interface_ids 4541 \<br /> --default_route.ipv6_eligible_interface_ids 4527 \<br /> --default_route.ipv6_eligible_interface_ids 4541<br />
Learn more...
- CLI: VLAN interface.
<br /> linode-cli linodes interface-settings-update $linodeId \<br /> --network_helper true<br />
Learn more...
- CLI: VPC interface.
<br /> linode-cli linodes interface-settings-update $linodeId \<br /> --network_helper true \<br /> --default_route.ipv4_interface_id 5527 \<br /> --default_route.ipv4_eligible_interface_ids 5527 \<br /> --default_route.ipv4_eligible_interface_ids 5541<br />
Learn more...
Learn more...
REPLACE linode.linode.interface_settings
SET
default_route = '{{ default_route }}',
network_helper = {{ network_helper }}
WHERE
linodeId = '{{ linodeId }}' --required
RETURNING
default_route,
network_helper;