Type Alias PutLinodeConfigData

type PutLinodeConfigData = {
    body: {
        comments?: string | null;
        devices?: {
            sda?: { disk_id?: number; volume_id?: number | null };
            sdb?: { disk_id?: number; volume_id?: number | null };
            sdc?: { disk_id?: number; volume_id?: number | null };
            sdd?: { disk_id?: number; volume_id?: number | null };
            sde?: { disk_id?: number; volume_id?: number | null };
            sdf?: { disk_id?: number; volume_id?: number | null };
            sdg?: { disk_id?: number; volume_id?: number | null };
            sdh?: { disk_id?: number; volume_id?: number | null };
        };
        helpers?: {
            devtmpfs_automount?: boolean;
            distro?: boolean;
            modules_dep?: boolean;
            network?: boolean
            | null;
            updatedb_disabled?: boolean;
        };
        id?: number;
        interfaces?: {
            active?: boolean;
            id?: number;
            ip_ranges?: string[]
            | null;
            ipam_address?: string | null;
            ipv4?: { nat_1_1?: string | "any" | null; vpc?: string | null };
            label?: string | null;
            primary?: boolean;
            purpose: "public" | "vlan" | "vpc";
            subnet_id?: number | null;
            vpc_id?: number | null;
        }[];
        kernel?: string;
        label?: string;
        memory_limit?: number;
        root_device?: string;
        run_level?: "default"
        | "single"
        | "binbash";
        virt_mode?: "paravirt" | "fullvirt";
    };
    path: { configId: number; linodeId: number };
    query?: never;
    url: "linode/instances/{linodeId}/configs/{configId}";
}

Index

Properties

body path query? url

Properties

body

body: {
    comments?: string | null;
    devices?: {
        sda?: { disk_id?: number; volume_id?: number | null };
        sdb?: { disk_id?: number; volume_id?: number | null };
        sdc?: { disk_id?: number; volume_id?: number | null };
        sdd?: { disk_id?: number; volume_id?: number | null };
        sde?: { disk_id?: number; volume_id?: number | null };
        sdf?: { disk_id?: number; volume_id?: number | null };
        sdg?: { disk_id?: number; volume_id?: number | null };
        sdh?: { disk_id?: number; volume_id?: number | null };
    };
    helpers?: {
        devtmpfs_automount?: boolean;
        distro?: boolean;
        modules_dep?: boolean;
        network?: boolean
        | null;
        updatedb_disabled?: boolean;
    };
    id?: number;
    interfaces?: {
        active?: boolean;
        id?: number;
        ip_ranges?: string[]
        | null;
        ipam_address?: string | null;
        ipv4?: { nat_1_1?: string | "any" | null; vpc?: string | null };
        label?: string | null;
        primary?: boolean;
        purpose: "public" | "vlan" | "vpc";
        subnet_id?: number | null;
        vpc_id?: number | null;
    }[];
    kernel?: string;
    label?: string;
    memory_limit?: number;
    root_device?: string;
    run_level?: "default"
    | "single"
    | "binbash";
    virt_mode?: "paravirt" | "fullvirt";
}

Type Declaration

Optionalcomments?: string | null
Optional field for arbitrary user comments on this configuration.
Optionaldevices?: {
    sda?: { disk_id?: number; volume_id?: number | null };
    sdb?: { disk_id?: number; volume_id?: number | null };
    sdc?: { disk_id?: number; volume_id?: number | null };
    sdd?: { disk_id?: number; volume_id?: number | null };
    sde?: { disk_id?: number; volume_id?: number | null };
    sdf?: { disk_id?: number; volume_id?: number | null };
    sdg?: { disk_id?: number; volume_id?: number | null };
    sdh?: { disk_id?: number; volume_id?: number | null };
}
A dictionary of device disks to use as a device map in a Linode's configuration profile.
- An empty device disk dictionary or a dictionary with empty values for device slots is allowed.
- If no devices are specified, booting from this configuration will hold until a device exists that allows the boot process to start.
- Optionalsda?: { disk_id?: number; volume_id?: number | null }
  Device can be either a Disk or Volume identified by disk_id or volume_id. Only one type per slot allowed. Can be null. Devices mapped from sde through sdh are unavailable in fullvirt virt_mode.
  - Optionaldisk_id?: number
    The Disk ID, or null if a Volume is assigned to this slot.
  - Optionalvolume_id?: number | null
    The Volume ID, or null if a Disk is assigned to this slot.
- Optionalsdb?: { disk_id?: number; volume_id?: number | null }
  Device can be either a Disk or Volume identified by disk_id or volume_id. Only one type per slot allowed. Can be null. Devices mapped from sde through sdh are unavailable in fullvirt virt_mode.
  - Optionaldisk_id?: number
    The Disk ID, or null if a Volume is assigned to this slot.
  - Optionalvolume_id?: number | null
    The Volume ID, or null if a Disk is assigned to this slot.
- Optionalsdc?: { disk_id?: number; volume_id?: number | null }
  Device can be either a Disk or Volume identified by disk_id or volume_id. Only one type per slot allowed. Can be null. Devices mapped from sde through sdh are unavailable in fullvirt virt_mode.
  - Optionaldisk_id?: number
    The Disk ID, or null if a Volume is assigned to this slot.
  - Optionalvolume_id?: number | null
    The Volume ID, or null if a Disk is assigned to this slot.
- Optionalsdd?: { disk_id?: number; volume_id?: number | null }
  Device can be either a Disk or Volume identified by disk_id or volume_id. Only one type per slot allowed. Can be null. Devices mapped from sde through sdh are unavailable in fullvirt virt_mode.
  - Optionaldisk_id?: number
    The Disk ID, or null if a Volume is assigned to this slot.
  - Optionalvolume_id?: number | null
    The Volume ID, or null if a Disk is assigned to this slot.
- Optionalsde?: { disk_id?: number; volume_id?: number | null }
  Device can be either a Disk or Volume identified by disk_id or volume_id. Only one type per slot allowed. Can be null. Devices mapped from sde through sdh are unavailable in fullvirt virt_mode.
  - Optionaldisk_id?: number
    The Disk ID, or null if a Volume is assigned to this slot.
  - Optionalvolume_id?: number | null
    The Volume ID, or null if a Disk is assigned to this slot.
- Optionalsdf?: { disk_id?: number; volume_id?: number | null }
  Device can be either a Disk or Volume identified by disk_id or volume_id. Only one type per slot allowed. Can be null. Devices mapped from sde through sdh are unavailable in fullvirt virt_mode.
  - Optionaldisk_id?: number
    The Disk ID, or null if a Volume is assigned to this slot.
  - Optionalvolume_id?: number | null
    The Volume ID, or null if a Disk is assigned to this slot.
- Optionalsdg?: { disk_id?: number; volume_id?: number | null }
  Device can be either a Disk or Volume identified by disk_id or volume_id. Only one type per slot allowed. Can be null. Devices mapped from sde through sdh are unavailable in fullvirt virt_mode.
  - Optionaldisk_id?: number
    The Disk ID, or null if a Volume is assigned to this slot.
  - Optionalvolume_id?: number | null
    The Volume ID, or null if a Disk is assigned to this slot.
- Optionalsdh?: { disk_id?: number; volume_id?: number | null }
  Device can be either a Disk or Volume identified by disk_id or volume_id. Only one type per slot allowed. Can be null. Devices mapped from sde through sdh are unavailable in fullvirt virt_mode.
  - Optionaldisk_id?: number
    The Disk ID, or null if a Volume is assigned to this slot.
  - Optionalvolume_id?: number | null
    The Volume ID, or null if a Disk is assigned to this slot.
Optionalhelpers?: {
    devtmpfs_automount?: boolean;
    distro?: boolean;
    modules_dep?: boolean;
    network?: boolean | null;
    updatedb_disabled?: boolean;
}
Helpers enabled when booting to this Linode configuration.
- Optionaldevtmpfs_automount?: boolean
  Populates the /dev directory early during boot without udev. Defaults to false.
- Optionaldistro?: boolean
  Helps maintain correct inittab or upstart console device.
- Optionalmodules_dep?: boolean
  Creates a modules dependency file for the kernel you run.
- Optionalnetwork?: boolean | null
  Set to true to automatically configure static networking. The network option applies only to legacy configuration profile interfaces and does not apply to Linode interfaces.
- Optionalupdatedb_disabled?: boolean
  Set to true to disable the updatedb cron job to avoid disk thrashing.
Optional Readonlyid?: number
Read-only The ID of this Config.
Optionalinterfaces?: {
    active?: boolean;
    id?: number;
    ip_ranges?: string[] | null;
    ipam_address?: string | null;
    ipv4?: { nat_1_1?: string | "any" | null; vpc?: string | null };
    label?: string | null;
    primary?: boolean;
    purpose: "public" | "vlan" | "vpc";
    subnet_id?: number | null;
    vpc_id?: number | null;
}[]
interfaces is applicable only to legacy configuration profiles and does not apply to Linode interfaces.

From one to three network interfaces to add to this Linode's configuration profile. The position in the array determines which of the Linode's network interfaces is configured:
- First [0]: eth0
- Second [1]: eth1
- Third [2]: eth2
When updating a Linode's legacy interfaces, each interface must be redefined. An empty interfaces array results in a default public type interface configuration only.

If no public Interface is configured, public IP addresses are still assigned to the Linode but will not be usable without manual configuration.

📘

Changes to Linode Interface configurations can be enabled by rebooting the Linode.

vpc details

See the VPC documentation guide for its specifications and limitations.

vlan details
- Only Next Generation Network (NGN) data centers support VLANs. Run the List regions operation to view the capabilities of data center regions. If a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center, the migration or cloning will not initiate. If a Linode cannot be migrated or cloned because of an incompatibility, you will be prompted to select a different data center or contact support.
- See the VLANs Overview guide to view additional specifications and limitations.
Optionalkernel?: string
The ID of the kernel used to boot a Linode. Run the List kernels operation to see all available kernels. Here are some commonly used kernels:
- linode/latest-64bit. This is the default, our latest kernel at the time of an instance boot or reboot.
- linode/grub2. The upstream distribution-supplied kernel that's installed on the primary disk, or a custom kernel if installed.
- linode/direct-disk. The master boot record (MBR) of the primary disk or root device. Use this in place of a Linux kernel.
Optionallabel?: string
Filterable The name of the configuration for display in Akamai Cloud Manager.
Optionalmemory_limit?: number
Defaults to the total RAM of the Linode.
Optionalroot_device?: string
The root device to boot.

📘
- If you leave this empty or set an invalid value, the root device defaults to /dev/sda.
- If you specify a device at the root device location and it's not mounted, the Linode won't boot until a device is mounted.
Optionalrun_level?: "default" | "single" | "binbash"
Defines the state of your Linode after booting. Defaults to default.
Optionalvirt_mode?: "paravirt" | "fullvirt"
Controls the virtualization mode. Defaults to paravirt.
- paravirt is suitable for most cases. Linodes running in paravirt mode share some qualities with the host, ultimately making it run faster since there is less transition between it and the host.
- fullvirt affords more customization, but is slower because 100% of the VM is virtualized.

path

path: { configId: number; linodeId: number }

Type Declaration

configId: number
The id of the Configuration Profile.
linodeId: number
The id of the Linode.

`Optional`query

query?: never

url

url: "linode/instances/{linodeId}/configs/{configId}"

Type Alias PutLinodeConfigData

Index

Properties

Properties

body

Type Declaration

Optionalcomments?: string | null

Optionalsda?: { disk_id?: number; volume_id?: number | null }

Optionaldisk_id?: number

Optionalvolume_id?: number | null

Optionalsdb?: { disk_id?: number; volume_id?: number | null }

Optionaldisk_id?: number

Optionalvolume_id?: number | null

Optionalsdc?: { disk_id?: number; volume_id?: number | null }

Optionaldisk_id?: number

Optionalvolume_id?: number | null

Optionalsdd?: { disk_id?: number; volume_id?: number | null }

Optionaldisk_id?: number

Optionalvolume_id?: number | null

Optionalsde?: { disk_id?: number; volume_id?: number | null }

Optionaldisk_id?: number

Optionalvolume_id?: number | null

Optionalsdf?: { disk_id?: number; volume_id?: number | null }

Optionaldisk_id?: number

Optionalvolume_id?: number | null

Optionalsdg?: { disk_id?: number; volume_id?: number | null }

Optionaldisk_id?: number

Optionalvolume_id?: number | null

Optionalsdh?: { disk_id?: number; volume_id?: number | null }

Optionaldisk_id?: number

Optionalvolume_id?: number | null

Optionalhelpers?: { devtmpfs_automount?: boolean; distro?: boolean; modules_dep?: boolean; network?: boolean | null; updatedb_disabled?: boolean;}

Optionaldevtmpfs_automount?: boolean

Optionaldistro?: boolean

Optionalmodules_dep?: boolean

Optionalnetwork?: boolean | null

Optionalupdatedb_disabled?: boolean

Optional Readonlyid?: number

Optionalkernel?: string

Optionallabel?: string

Optionalmemory_limit?: number

Optionalroot_device?: string

Optionalrun_level?: "default" | "single" | "binbash"

Optionalvirt_mode?: "paravirt" | "fullvirt"

path

Type Declaration

configId: number

linodeId: number

Optionalquery

url

Settings

On This Page

`Optional`comments?: string | null

`Optional`sda?: { disk_id?: number; volume_id?: number | null }

`Optional`disk_id?: number

`Optional`volume_id?: number | null

`Optional`sdb?: { disk_id?: number; volume_id?: number | null }

`Optional`disk_id?: number

`Optional`volume_id?: number | null

`Optional`sdc?: { disk_id?: number; volume_id?: number | null }

`Optional`disk_id?: number

`Optional`volume_id?: number | null

`Optional`sdd?: { disk_id?: number; volume_id?: number | null }

`Optional`disk_id?: number

`Optional`volume_id?: number | null

`Optional`sde?: { disk_id?: number; volume_id?: number | null }

`Optional`disk_id?: number

`Optional`volume_id?: number | null

`Optional`sdf?: { disk_id?: number; volume_id?: number | null }

`Optional`disk_id?: number

`Optional`volume_id?: number | null

`Optional`sdg?: { disk_id?: number; volume_id?: number | null }

`Optional`disk_id?: number

`Optional`volume_id?: number | null

`Optional`sdh?: { disk_id?: number; volume_id?: number | null }

`Optional`disk_id?: number

`Optional`volume_id?: number | null

`Optional`helpers?: {
devtmpfs_automount?: boolean;
distro?: boolean;
modules_dep?: boolean;
network?: boolean | null;
updatedb_disabled?: boolean;
}

`Optional`devtmpfs_automount?: boolean

`Optional`distro?: boolean

`Optional`modules_dep?: boolean

`Optional`network?: boolean | null

`Optional`updatedb_disabled?: boolean

`Optional` `Readonly`id?: number

`Optional`kernel?: string

`Optional`label?: string

`Optional`memory_limit?: number

`Optional`root_device?: string

`Optional`run_level?: "default" | "single" | "binbash"

`Optional`virt_mode?: "paravirt" | "fullvirt"

`Optional`query