config_profiles

Creates, updates, deletes, gets or lists a config_profiles resource.

Overview

Name	config_profiles
Type	Resource
Id	linode.linode.config_profiles

Fields

The following fields are returned by SELECT queries:

get_linode_config

A configuration profile object.

Name	Datatype	Description
id	integer	Read-only The ID of this Config.
comments	string	Optional field for arbitrary user comments on this configuration. (example: This is my main Config)
devices	object	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.
helpers	object	Helpers enabled when booting to this Linode configuration.
interfaces	array	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.
kernel	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. (default: linode/latest-64bit, example: linode/latest-64bit)
label	string	Filterable The name of the configuration for display in Akamai Cloud Manager. (example: My Config)
memory_limit	integer	Defaults to the total RAM of the Linode.
root_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. (example: /dev/sda, pattern: a-z, A-Z, 0-9, /, _, -)
run_level	string	Defines the state of your Linode after booting. Defaults to default. (example: default)
virt_mode	string	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. (example: paravirt)

get_linode_configs

Returns the configuration profiles associated with this Linode.

Name	Datatype	Description
data	array
page	integer	Read-only The current page.
pages	integer	Read-only The total number of pages.
results	integer	Read-only The total number of results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_linode_config	select			Returns information about a specific configuration profile. Learn more... Learn more...
get_linode_configs	select		page, page_size	Lists configuration profiles associated with a Linode. Learn more... Learn more...
post_add_linode_config	insert	data__label, data__devices		Adds a new configuration profile to a Linode. > 📘 > > This operation is for legacy configuration profiles only, and not Linode interfaces. Learn more... Learn more...
put_linode_config	replace			Updates a configuration profile. Learn more... Learn more...
delete_linode_config	delete			Deletes the specified configuration profile from the specified Linode. 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
page	integer	The page of a collection to return.
page_size	integer	The number of items to return per page.

SELECT examples

get_linode_config

Returns information about a specific configuration profile.

Learn more...

Learn more...

SELECT
id,
comments,
devices,
helpers,
interfaces,
kernel,
label,
memory_limit,
root_device,
run_level,
virt_mode
FROM linode.linode.config_profiles;

get_linode_configs

Lists configuration profiles associated with a Linode.

Learn more...

Learn more...

SELECT
data,
page,
pages,
results
FROM linode.linode.config_profiles
WHERE page = '{{ page }}'
AND page_size = '{{ page_size }}';

INSERT examples

post_add_linode_config

Adds a new configuration profile to a Linode.

> 📘
>
> This operation is for legacy configuration profiles only, and not Linode interfaces.

Learn more...

Learn more...

INSERT INTO linode.linode.config_profiles (
data__comments,
data__devices,
data__helpers,
data__interfaces,
data__kernel,
data__label,
data__memory_limit,
data__root_device,
data__run_level,
data__virt_mode
)
SELECT 
'{{ comments }}',
'{{ devices }}' --required,
'{{ helpers }}',
'{{ interfaces }}',
'{{ kernel }}',
'{{ label }}' --required,
{{ memory_limit }},
'{{ root_device }}',
'{{ run_level }}',
'{{ virt_mode }}'
RETURNING
id,
comments,
devices,
helpers,
interfaces,
kernel,
label,
memory_limit,
root_device,
run_level,
virt_mode
;

Manifest

# Description fields are for documentation purposes
- name: config_profiles
  props:
    - name: comments
      value: string
      description: >
        Optional field for arbitrary user comments on this configuration.
        
    - name: devices
      value: object
      description: >
        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.
        
    - name: helpers
      value: object
      description: >
        Helpers enabled when booting to this Linode configuration.
        
    - name: interfaces
      value: array
      description: >
        `interfaces` is applicable only to legacy configuration profiles and does not apply to [Linode interfaces](https://techdocs.akamai.com/linode-api/reference/post-linode-interface).

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](https://www.linode.com/docs/products/networking/vpc/#technical-specifications) guide for its specifications and limitations.

`vlan` details

- Only Next Generation Network (NGN) data centers support VLANs. Run the [List regions](https://techdocs.akamai.com/linode-api/reference/get-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](https://www.linode.com/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations.
        
    - name: kernel
      value: string
      description: >
        The ID of the kernel used to boot a Linode. Run the [List kernels](https://techdocs.akamai.com/linode-api/reference/get-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.
        
      default: linode/latest-64bit
    - name: label
      value: string
      description: >
        __Filterable__ The name of the configuration for display in Akamai Cloud Manager.
        
    - name: memory_limit
      value: integer
      description: >
        Defaults to the total RAM of the Linode.
        
    - name: root_device
      value: string
      description: >
        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.
        
    - name: run_level
      value: string
      description: >
        Defines the state of your Linode after booting. Defaults to `default`.
        
      valid_values: ['default', 'single', 'binbash']
    - name: virt_mode
      value: string
      description: >
        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.
        
      valid_values: ['paravirt', 'fullvirt']

REPLACE examples

put_linode_config

Updates a configuration profile.

Learn more...

Learn more...

REPLACE linode.linode.config_profiles
SET 
data__comments = '{{ comments }}',
data__devices = '{{ devices }}',
data__helpers = '{{ helpers }}',
data__interfaces = '{{ interfaces }}',
data__kernel = '{{ kernel }}',
data__label = '{{ label }}',
data__memory_limit = {{ memory_limit }},
data__root_device = '{{ root_device }}',
data__run_level = '{{ run_level }}',
data__virt_mode = '{{ virt_mode }}'
WHERE 

RETURNING
id,
comments,
devices,
helpers,
interfaces,
kernel,
label,
memory_limit,
root_device,
run_level,
virt_mode;

DELETE examples

delete_linode_config

Deletes the specified configuration profile from the specified Linode.

Learn more...

Learn more...

DELETE FROM linode.linode.config_profiles;