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

    Type Alias PutLinodeConfigInterfaceData

    type PutLinodeConfigInterfaceData = {
        body: {
            ip_ranges?: string[];
            ipv4?: { nat_1_1?: string | "any" | null; vpc?: string | null };
            primary?: boolean;
        };
        path: { configId: number; interfaceId: number; linodeId: number };
        query?: never;
        url: "linode/instances/{linodeId}/configs/{configId}/interfaces/{interfaceId}";
    }
    Index

    Properties

    body path query? url

    Properties

    body

    body: {
        ip_ranges?: string[];
        ipv4?: { nat_1_1?: string | "any" | null; vpc?: string | null };
        primary?: boolean;
    }

    Linode configuration profile interface update request object.

    Type Declaration

    • Optionalip_ranges?: string[]

      IPv4 CIDR VPC subnet ranges that are routed to this interface.

      • A range can't include any addresses that are assigned to an active Linode or another VPC subnet.

      • When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed.

      • Include this as an empty array ([]) to remove all existing nat_1_1 values.

      • Omit this array to leave all existing ip_ranges as is. <>

      📘

      This only applies to interfaces with a purpose of vpc.

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

      IPv4 addresses configured for this interface.

      📘

      This only applies to interfaces with a purpose of vpc.

      • Optionalnat_1_1?: string | "any" | null

        The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface's VPC subnet IPv4 address.

        • You can set this to a specific, public IPv4 address that's available on the Linode. You can also use the any keyword to enable the Linode's assigned public IPv4 address.

        • A specified address can't be used on another Linode.

        • Include this as an empty object ("") to remove an existing nat_1_1 value.

        • Omit this object or include it and set it to null to leave an existing nat_1_1 value as is.

      • Optionalvpc?: string | null

        The VPC subnet IPv4 address for this interface.

        • The vpc can't be assigned to an existing Linode as an address or in a range.

        • The target address can't be the first two or last two addresses in the subnet IPv4 range.

        • If omitted, a valid address within the subnet IPv4 range is automatically assigned.

    • Optionalprimary?: boolean

      Set to true to label this configuration profile interface as the default route to the Linode.

      • Each Linode can have one interface set as its primary.

      • If you don't specifically set a primary, the first non-vlan type interface is automatically treated as the primary.

    path: { configId: number; interfaceId: number; linodeId: number }

    Type Declaration

    • configId: number

      The id of the Configuration Profile.

    • interfaceId: number

      The id of the Linode Configuration Profile Interface.

    • linodeId: number

      The id of the Linode.

    query?: never
    url: "linode/instances/{linodeId}/configs/{configId}/interfaces/{interfaceId}"

    Settings

    Member Visibility

    On This Page

    Properties