instance_interface_settings.md

instance_interface_settings

Create, read, and update the interface settings for a Linode instance.

• Minimum Required Fields
• Examples
• Parameters
• Return Values

Minimum Required Fields

Field	Type	Required	Description
api_token	str	Required	The Linode account personal access token. It is necessary to run the module. It can be exposed by the environment variable LINODE_API_TOKEN instead. See details in Usage.

Examples

- name: Configure the interface settings of a Linode Instance
  linode.cloud.instance_interface_settings:
    linode_id: 123
    network_helper: true
    default_route:
        ipv4_interface_id: 123
        ipv6_interface_id: 456

Parameters

Field	Type	Required	Description
linode_id	int	Required	The ID of the instance to configure the interface settngs for.
network_helper	bool	Optional	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.
default_route (sub-options)	dict	Optional	Interfaces used for the IPv4 default_route and IPv6 default_route when multiple interfaces are eligible for the role.

default_route

Field	Type	Required	Description
ipv4_interface_id	int	Optional	The VPC or public interface ID assigned as the IPv4 default_route.
ipv6_interface_id	int	Optional	The VPC or public interface ID assigned as the IPv6 default_route.

Return Values

• settings - The Linode interface settings in JSON serialized form.

  • Sample Response:

    {
      "default_route": {
        "ipv4_eligible_interface_ids": [
          123,
          456
        ],
        "ipv4_interface_id": 456,
        "ipv6_eligible_interface_ids": [
          123
        ],
        "ipv6_interface_id": 123
      },
      "network_helper": true
    }
    

  • See the Linode API response documentation for a list of returned fields