@akamai/openapi-ts
    Preparing search index...

    Type Alias PutLinodeConfigInterfaceResponses

    type PutLinodeConfigInterfaceResponses = {
        "200": {
            active?: boolean;
            id?: number;
            ip_ranges?: string[] | null;
            ipam_address?: string | null;
            ipv4?: { nat_1_1: string | null; vpc: string | null };
            label?: string | null;
            primary?: boolean;
            purpose: "public" | "vlan" | "vpc";
            subnet_id?: number | null;
            vpc_id?: number | null;
        };
    }
    Index

    Properties

    200

    Properties

    "200": {
        active?: boolean;
        id?: number;
        ip_ranges?: string[] | null;
        ipam_address?: string | null;
        ipv4?: { nat_1_1: string | null; vpc: string | null };
        label?: string | null;
        primary?: boolean;
        purpose: "public" | "vlan" | "vpc";
        subnet_id?: number | null;
        vpc_id?: number | null;
    }

    The network interface to apply to this Linode's configuration profile.

    Type Declaration

    • Optional Readonlyactive?: boolean

      Read-only Returned as true if the interface has been booted using the configuration profile to which the interface belongs.

    • Optional Readonlyid?: number

      Read-only The unique ID representing this interface.

    • Optionalip_ranges?: string[] | null

      IPv4 CIDR VPC subnet ranges that are routed to this interface. This only applies to interfaces with a purpose of vpc. Returned as an empty string ("") if the interface has a purpose of public or vlan.

    • Optionalipam_address?: string | null

      The interface's private IP address, in classless inter-domain routing (CIDR) notation. Only applies to interfaces with a purpose of vlan. Returned as null if the interface has a purpose of public or vpc.

      📘

      If Network Helper is enabled, the Linode's interface is automatically configured to use this address after the Linode is rebooted. If Network Helper is disabled, enable the address using manual static IP configuration.

    • Optionalipv4?: { nat_1_1: string | null; vpc: string | null }

      IPv4 addresses configured for this interface. Only applies to interfaces with a purpose of vpc. Returned as null if the interface has a purpose of public or vlan.

      • nat_1_1: string | null

        The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface's VPC subnet IPv4 address. This only applies to interfaces with a purpose of vpc. Returned as null if no 1:1 NAT is set for a vpc interface. Returned as an empty string ("") if the interface has a purpose of public or vlan.

      • vpc: string | null

        The VPC subnet IPv4 address for this interface. This only applies to interfaces with a purpose of vpc. Returned as an empty string ("") if the interface has a purpose of public or vlan.

    • Optionallabel?: string | null

      Filterable The name set for an interface with a purpose of vlan. Returned as null if the interface has a purpose of public or vpc.

    • Optionalprimary?: boolean

      The default route to the Linode. Each Linode can have one interface set as its primary. Defaults to the first non-vlan type interface, if you haven't specifically set a primary.

      📘

      The value needs to false for any interface that uses vlan as its purpose.

    • purpose: "public" | "vlan" | "vpc"

      The type of interface. This can be public, vlan, or vpc.

      For interfaces with a purpose of public:

      • You can only define one public interface per Linode.

      • The Linode's default public IPv4 address is assigned to the public interface.

      • A Linode needs a public interface in the first or eth0 position to be reachable via the public internet, after it boots. If no public interface is configured, you can only access the Linode through LISH, or through another Linode that's connected to the same VLAN or VPC.

      For interfaces with a purpose of vlan:

      • The target Linode is attached to the VLAN with the specified label.

      • If an ipam_address is configured, the Linode uses this address.

      For interfaces with a purpose of vpc:

      • The target Linode is attached to an existing VPC subnet with the specified subnet_id.

      • When the interface is activated, the Linode is configured to use an IP address from the range in the assigned VPC subnet. See ipv4.vpc for more information.

    • Optionalsubnet_id?: number | null

      The id of the VPC subnet for this interface. Only applies to interfaces with a purpose of vpc. Returned as null if the interface has a purpose of public or vlan.

      📘

      You need to reboot a Linode using the interface's configuration profile to assign the Linode to a VPC subnet.

    • Optional Readonlyvpc_id?: number | null

      Read-only The id of the VPC configured for this interface. Returned as null for non-vpc type interfaces.

    Settings

    Member Visibility

    On This Page

    Properties