instance

Manage Linode Instances, Configs, and Disks.

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: Create a new Linode instance.
  linode.cloud.instance:
    label: my-linode
    type: g6-nanode-1
    region: us-east
    image: linode/ubuntu22.04
    root_pass: verysecurepassword!!!
    private_ip: false
    authorized_keys:
      - "ssh-rsa ..."
    stackscript_id: 1337
    stackscript_data:
      variable: value
    tags:
      - env=prod
    boot_size: 8192
    kernel: "linode/latest-64bit"
    state: present

- name: Create a new Linode instance with an additional public IPv4 address.
  linode.cloud.instance:
    label: my-linode
    type: g6-nanode-1
    region: us-east
    image: linode/ubuntu22.04
    root_pass: verysecurepassword!!!
    private_ip: false
    authorized_keys:
      - "ssh-rsa ..."
    stackscript_id: 1337
    stackscript_data:
      variable: value
    tags:
      - env=prod
    additional_ipv4:
      - public: true
    state: present

- name: Create a Linode Instance with a reserved IPv4 address.
  linode.cloud.instance:
    label: my-linode
    type: g6-nanode-1
    region: us-east
    image: linode/ubuntu22.04
    root_pass: verysecurepassword!!!
    ipv4:
      - "192.0.2.141"
    state: present

- name: Create a Linode Instance with explicit configs and disks.
  linode.cloud.instance:
    label: 'my-complex-instance'
    region: us-southeast
    type: g6-standard-1
    booted: true
    boot_config_label: boot-config
    state: present
    disks:
      - label: boot
        image: linode/ubuntu22.04
        size: 3000
        root_pass: ans1ble-test!
      - label: swap
        filesystem: swap
        size: 512
    configs:
      - label: boot-config
        root_device: /dev/sda
        devices:
          sda:
            disk_label: boot
          sdb:
            disk_label: swap
        state: present

- name: Create a Linode Instance with custom user data.
  linode.cloud.instance:
    label: 'my-metadata-instance'
    region: us-southeast
    type: g6-standard-1
    image: linode/ubuntu22.04
    root_pass: verysecurepassword!!!
    metadata:
      user_data: myuserdata
    state: present

- name: Create a new Linode instance under a placement group.
  linode.cloud.instance:
    label: my-linode
    type: g6-nanode-1
    region: us-east
    placement_group:
      id: 123
      compliant_only: false
    state: present

- name: Create a new Linode instance with explicit public and VPC Linode interfaces.
  linode.cloud.instance:
    label: my-linode
    type: g6-nanode-1
    region: us-mia
    image: linode/ubuntu24.04
    authorized_keys:
      - "ssh-rsa ..."
    interface_generation: linode
    linode_interfaces:
      - default_route:
          ipv6: true
          ipv4: true
        firewall_id: null
        public:
          ipv4:
            addresses:
              - address: auto
                primary: true
          ipv6:
            ranges:
              - range: /64

      - firewall_id: 12345
        vpc:
          subnet_id: 456
          ipv4:
            addresses:
              - address: auto
                nat_1_1_address: auto
                primary: true
            ranges:
              - range: /32
    state: present

# NOTE: IPv6 VPCs may not currently be available to all users.
- name: Create a Linode Instance with a public VPC interface, assigning one IPv6 SLAAC prefix and one additional IPv6 range.
  linode.cloud.instance:
    label: my-vpc-ipv6-instance
    region: us-mia
    type: g6-nanode-1
    image: linode/alpine3.21
    booted: true
    interface_generation: linode
    linode_interfaces:
      - default_route:
          ipv4: true
          ipv6: true
        firewall_id: 12345
        vpc:
          subnet_id: 456
          ipv6:
            is_public: true
            slaac:
              - range: auto
            ranges:
              - range: auto
    state: present

- name: Create a Linode Instance with a legacy VPC interface assigning a specific VPC subnet IPv4 address and a NAT 1-1 mapping to its public IPv4 address.
  linode.cloud.instance:
    label: my-vpc-instance
    region: us-mia
    type: g6-nanode-1
    image: linode/alpine3.21
    booted: true
    interface_generation: legacy_config
    interfaces:
      - purpose: vpc
        primary: true
        subnet_id: '{{ create_subnet.subnet.id }}'
        ipv4:
          # The IPv4 address to assign from the VPC subnet.
          # Omit or use `auto` to have one automatically allocated.
          vpc: 10.0.0.10
          nat_1_1: any
    state: present

# NOTE: IPv6 VPCs may not currently be available to all users.
- name: Create a Linode Instance with a legacy public VPC interface, assigning one IPv6 SLAAC prefix and one additional IPv6 range.
  linode.cloud.instance:
    label: my-vpc-ipv6-instance
    region: us-mia
    type: g6-nanode-1
    image: linode/alpine3.21
    booted: true
    interface_generation: legacy_config
    interfaces:
      - purpose: vpc
        subnet_id: '{{ create_subnet.subnet.id }}'
        ipv6:
          is_public: true
          slaac:
            - range: auto
          ranges:
            - range: auto
    state: present

- name: Delete a Linode instance.
  linode.cloud.instance:
    label: my-linode
    state: absent

Parameters

Field	Type	Required	Description
`state`	`str`	Required	The desired state of the target. (Choices: `present`, `absent`)
`label`	`str`	Optional	The unique label to give this instance.
`type`	`str`	Optional	The Linode Type of the Linode you are creating.
`region`	`str`	Optional	The location to deploy the instance in. See the Linode API documentation.
`image`	`str`	Optional	The image ID to deploy the instance disk from. (Conflicts With: `disks`,`configs`)
`authorized_keys`	`list`	Optional	A list of SSH public key parts to deploy for the root user. If image is provided, one of root_pass, authorized_keys, or authorized_users is required.
`authorized_users`	`list`	Optional	A list of SSH public key parts to deploy for the root user. If image is provided, one of root_pass, authorized_keys, or authorized_users is required.
`maintenance_policy`	`str`	Optional	The slug of the maintenance policy to apply during maintenance. (Choices: `linode/migrate`, `linode/power_off_on`)
`root_pass`	`str`	Optional	The password for the root user. If image is provided, one of root_pass, authorized_keys, or authorized_users is required.
`stackscript_id`	`int`	Optional	The ID of the StackScript to use when creating the instance. See the Linode API documentation.
`stackscript_data`	`dict`	Optional	An object containing arguments to any User Defined Fields present in the StackScript used when creating the instance. Only valid when a stackscript_id is provided. See the Linode API documentation.
`firewall_id`	`int`	Optional	The ID of a Firewall this Linode to assign this Linode to.
`private_ip`	`bool`	Optional	If true, the created Linode will have private networking enabled.
`group`	`str`	Optional	The group that the instance should be marked under. Please note, that group labelling is deprecated but still supported. The encouraged method for marking instances is to use tags. (Updatable)
`boot_config_label`	`str`	Optional	The label of the config to boot from.
`configs` (sub-options)	`list`	Optional	A list of Instance configs to apply to the Linode. See the Linode API documentation. (Updatable; Conflicts With: `image`,`interfaces`)
`disks` (sub-options)	`list`	Optional	A list of Disks to create on the Linode. See the Linode API documentation. (Updatable; Conflicts With: `image`,`interfaces`)
`interfaces` (sub-options)	`list`	Optional	A list of network interfaces to apply to the Linode. See the Linode API documentation. (Conflicts With: `disks`,`configs`)
`interface_generation`	`str`	Optional	Specifies the interface type for the Linode. The default value is determined by the interfaces_for_new_linodes setting in the account settings. (Choices: `legacy_config`, `linode`)
`linode_interfaces` (sub-options)	`list`	Optional	A list of Linode interfaces to apply to the Linode. See the Linode API documentation. NOTE: To upgrade from config (legacy) interfaces, consider using the linode.cloud.api_request module to make a request to the (POST linode/instances/{linode_id}/upgrade-interfaces endpoint). (Updatable)
`allow_implicit_reboots`	`bool`	Optional	Whether the Linode should be implicitly rebooted during operations that require a certain power status. (Default: `False`)
`booted`	`bool`	Optional	Whether the new Instance should be booted. This will default to True if the Instance is deployed from an Image or Backup.
`backup_id`	`int`	Optional	The id of the Backup to restore to the new Instance. May not be provided if "image" is given.
`metadata` (sub-options)	`dict`	Optional	Fields relating to the Linode Metadata service.
`backups_enabled`	`bool`	Optional	Enroll Instance in Linode Backup service.
`alerts` (sub-options)	`dict`	Optional	Configuration options for alert triggers on this Linode. (Updatable)
`wait`	`bool`	Optional	Wait for the instance to have status "running" before returning. (Default: `True`)
`wait_timeout`	`int`	Optional	The amount of time, in seconds, to wait for an instance to have status "running". (Default: `1500`)
`additional_ipv4` (sub-options)	`list`	Optional	Additional ipv4 addresses to allocate.
`ipv4`	`list`	Optional	A list of reserved IPv4 addresses to assign to this Linode on creation. The list must contain exactly one reserved, unassigned IPv4 address. NOTE: This field is create-only. Changes after creation are ignored.
`rebooted`	`bool`	Optional	If true, the Linode Instance will be rebooted. NOTE: The instance will only be rebooted if it was previously in a running state. To ensure your Linode will always be rebooted, consider also setting the `booted` field. (Default: `False`)
`migration_type`	`str`	Optional	The type of migration to use for Region and Type migrations. (Choices: `cold`, `warm`; Default: `cold`)
`auto_disk_resize`	`bool`	Optional	Whether implicitly created disks should be resized during a type change operation. (Default: `False`)
`tags`	`list`	Optional	An array of tags applied to this object. Tags are for organizational purposes only. (Updatable)
`capabilities`	`list`	Optional	Read-only. A list of capabilities this compute instance supports.
`placement_group` (sub-options)	`dict`	Optional	A Placement Group to create this Linode under.
`disk_encryption`	`str`	Optional	The disk encryption status of this Linode. (Choices: `enabled`, `disabled`)
`swap_size`	`int`	Optional	When deploying from an Image, this field is optional, otherwise it is ignored. This is used to set the swap disk size for the newly-created Linode.
`kernel`	`str`	Optional	The kernel to deploy with when creating a Linode.
`boot_size`	`int`	Optional	The size of the boot disk in MB for the newly-created Linode. Must be at least 8192 MB.

configs

Field	Type	Required	Description
`devices` (sub-options)	`dict`	Required	The devices to map to this configuration.
`label`	`str`	Required	The label to assign to this config.
`comments`	`str`	Optional	Arbitrary User comments on this Config. (Updatable)
`helpers` (sub-options)	`dict`	Optional	Helpers enabled when booting to this Linode Config.
`kernel`	`str`	Optional	A Kernel ID to boot a Linode with. Defaults to "linode/latest-64bit". (Updatable)
`memory_limit`	`int`	Optional	Defaults to the total RAM of the Linode. (Updatable)
`root_device`	`str`	Optional	The root device to boot. (Updatable)
`run_level`	`str`	Optional	Defines the state of your Linode after booting. (Updatable)
`virt_mode`	`str`	Optional	Controls the virtualization mode. (Choices: `paravirt`, `fullvirt`; Updatable)
`interfaces` (sub-options)	`list`	Optional	A list of network interfaces to apply to the Linode. See the Linode API documentation. (Updatable)

devices

Field	Type	Required	Description
`sda` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sda
`sdb` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdb
`sdc` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdc
`sdd` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdd
`sde` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sde
`sdf` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdf
`sdg` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdg
`sdh` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdh
`sdi` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdi
`sdj` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdj
`sdk` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdk
`sdl` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdl
`sdm` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdm
`sdn` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdn
`sdo` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdo
`sdp` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdp
`sdq` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdq
`sdr` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdr
`sds` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sds
`sdt` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdt
`sdu` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdu
`sdv` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdv
`sdw` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdw
`sdx` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdx
`sdy` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdy
`sdz` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdz
`sdaa` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdaa
`sdab` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdab
`sdac` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdac
`sdad` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdad
`sdae` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdae
`sdaf` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdaf
`sdag` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdag
`sdah` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdah
`sdai` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdai
`sdaj` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdaj
`sdak` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdak
`sdal` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdal
`sdam` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdam
`sdan` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdan
`sdao` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdao
`sdap` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdap
`sdaq` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdaq
`sdar` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdar
`sdas` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdas
`sdat` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdat
`sdau` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdau
`sdav` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdav
`sdaw` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdaw
`sdax` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdax
`sday` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sday
`sdaz` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdaz
`sdba` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdba
`sdbb` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdbb
`sdbc` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdbc
`sdbd` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdbd
`sdbe` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdbe
`sdbf` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdbf
`sdbg` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdbg
`sdbh` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdbh
`sdbi` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdbi
`sdbj` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdbj
`sdbk` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdbk
`sdbl` (sub-options)	`dict`	Optional	The device to be mapped to /dev/sdbl

sda

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdb

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdc

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdd

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sde

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdf

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdg

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdh

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdi

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdj

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdk

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdl

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdm

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdn

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdo

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdp

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdq

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdr

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sds

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdt

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdu

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdv

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdw

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdx

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdy

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdz

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdaa

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdab

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdac

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdad

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdae

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdaf

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdag

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdah

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdai

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdaj

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdak

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdal

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdam

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdan

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdao

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdap

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdaq

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdar

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdas

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdat

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdau

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdav

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdaw

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdax

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sday

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdaz

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdba

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdbb

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdbc

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdbd

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdbe

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdbf

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdbg

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdbh

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdbi

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdbj

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdbk

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

sdbl

Field	Type	Required	Description
`disk_label`	`str`	Optional	The label of the disk to attach to this Linode.
`disk_id`	`int`	Optional	The ID of the disk to attach to this Linode.
`volume_id`	`int`	Optional	The ID of the volume to attach to this Linode.

helpers

Field	Type	Required	Description
`devtmpfs_automount`	`bool`	Optional	Populates the /dev directory early during boot without udev.
`distro`	`bool`	Optional	Helps maintain correct inittab/upstart console device.
`modules_dep`	`bool`	Optional	Creates a modules dependency file for the Kernel you run.
`network`	`bool`	Optional	Automatically configures static networking.
`updatedb_disabled`	`bool`	Optional	Disables updatedb cron job to avoid disk thrashing.

interfaces

Field	Type	Required	Description
`purpose`	`str`	Required	The type of interface. (Choices: `public`, `vlan`, `vpc`)
`primary`	`bool`	Optional	Whether this is a primary interface (Default: `False`)
`subnet_id`	`int`	Optional	The ID of the VPC subnet to assign this interface to.
`ipv4` (sub-options)	`dict`	Optional	The IPv4 configuration for this interface. (VPC only)
`ipv6` (sub-options)	`dict`	Optional	The IPv6 configuration for this interface. (VPC only) NOTE: IPv6 VPCs may not currently be available to all users.
`label`	`str`	Optional	The name of this interface. Required for vlan purpose interfaces. Must be an empty string or null for public purpose interfaces.
`ipam_address`	`str`	Optional	This Network Interface’s private IP address in Classless Inter-Domain Routing (CIDR) notation.
`ip_ranges`	`list`	Optional	Packets to these CIDR ranges are routed to the VPC network interface. (VPC only)

ipv4

Field	Type	Required	Description
`addresses` (sub-options)	`list`	Optional	(Updatable)
`ranges` (sub-options)	`list`	Optional	A list of VPC IPv4 ranges.

ipv6

Field	Type	Required	Description
`is_public`	`bool`	Optional	Indicates whether the IPv6 configuration on the Linode interface is public. (Updatable)
`slaac` (sub-options)	`list`	Optional	Defines IPv6 SLAAC address ranges. (Updatable)
`ranges` (sub-options)	`list`	Optional	Defines additional IPv6 network ranges.

slaac

Field	Type	Required	Description
`range`	`str`	Optional	The IPv6 network range in CIDR notation. (Default: `auto`; Updatable)

ranges

Field	Type	Required	Description
`range`	`str`	Optional	The IPv6 network range in CIDR notation. (Default: `auto`; Updatable)

disks

Field	Type	Required	Description
`label`	`str`	Required	The label to give this Disk.
`size`	`int`	Required	The size of the Disk in MB. (Updatable)
`authorized_keys`	`list`	Optional	A list of SSH public key parts to deploy for the root user.
`authorized_users`	`list`	Optional	A list of usernames.
`filesystem`	`str`	Optional	The filesystem to create this disk with.
`disk_encryption`	`str`	Optional	READ ONLY The disk encryption status of this disk. This value is set at the Linode level. (Choices: `enabled`, `disabled`)
`image`	`str`	Optional	An Image ID to deploy the Disk from.
`root_pass`	`str`	Optional	The root user’s password on the newly-created Linode.
`stackscript_id`	`int`	Optional	The ID of the StackScript to use when creating the instance. See the Linode API documentation.
`stackscript_data`	`dict`	Optional	An object containing arguments to any User Defined Fields present in the StackScript used when creating the instance. Only valid when a stackscript_id is provided. See the Linode API documentation.

linode_interfaces

Field	Type	Required	Description
`firewall_id`	`int`	Optional	The enabled firewall to secure a VPC or public interface.
`default_route` (sub-options)	`dict`	Optional	Indicates if the interface serves as the default route when multiple interfaces are eligible for this role. (Updatable)
`public` (sub-options)	`dict`	Optional	Defines a Linode public interface. Any other type must either be omitted or set to null. (Updatable)
`vlan` (sub-options)	`dict`	Optional	VLAN interface settings. A Linode can have up to three VLAN interfaces, with a unique vlan_label for each. (Updatable)
`vpc` (sub-options)	`dict`	Optional	VPC interface settings. A Linode can have one VPC interface. The maximum number of interfaces allowed on a Linode is three. (Updatable)

default_route

Field	Type	Required	Description
`ipv4`	`bool`	Optional	If set to true, the interface is used for the IPv4 default_route. Only one interface per Linode can be set as the IPv4 default route. (Updatable)
`ipv6`	`bool`	Optional	If set to true, the interface is used for the IPv6 default_route. Only one interface per Linode can be set as the IPv6 default route. (Updatable)

public

Field	Type	Required	Description
`ipv4` (sub-options)	`dict`	Optional	IPv4 address settings for this public interface. If omitted, a public IPv4 address is automatically allocated. (Updatable)
`ipv6` (sub-options)	`dict`	Optional	IPv6 address ranges to assign to this interface. If omitted, no ranges are assigned. (Updatable)

addresses

Field	Type	Required	Description
`address`	`str`	Optional	Specifies which IPv4 address to use in the VPC subnet. (Default: `auto`; Updatable)
`nat_1_1_address`	`str`	Optional	The 1:1 NAT IPv4 address used to associate a public IPv4 address with the interface's VPC subnet IPv4 address. (Updatable)
`primary`	`bool`	Optional	This IPv4 primary address is used to configure the source address for routes within the Linode on the corresponding network interface. (Default: `False`; Updatable)

vlan

Field	Type	Required	Description
`vlan_label`	`str`	Optional	The VLAN's unique label.VLAN interfaces on the same Linode must have a unique vlan_label.
`ipam_address`	`str`	Optional	This VLAN interface's private IPv4 address in classless inter-domain routing (CIDR) notation.

vpc

Field	Type	Required	Description
`subnet_id`	`int`	Optional	The VPC subnet identifier for this interface.Your subnet’s VPC must be in the same data center (region) as the Linode.
`ipv4` (sub-options)	`dict`	Optional	Interfaces can be configured with IPv4 addresses or ranges (Updatable)
`ipv6` (sub-options)	`dict`	Optional	Interfaces can be configured with IPv6 addresses or ranges. (Updatable)

metadata

Field	Type	Required	Description
`user_data`	`str`	Optional	The user-defined data to supply for the Linode through the Metadata service.
`user_data_encoded`	`bool`	Optional	Whether the user_data field content is already encoded in Base64. (Default: `False`)

alerts

Field	Type	Required	Description
`network_in`	`int`	Optional	The amount of incoming traffic, in Mbit/s, required to trigger an alert. If the average incoming traffic over two hours exceeds this value, we'll send you an alert. If this is set to 0 (zero), the alert is disabled. Update only. (Updatable)
`network_out`	`int`	Optional	The amount of outbound traffic, in Mbit/s, required to trigger an alert. If the average outbound traffic over two hours exceeds this value, we'll send you an alert. If this is set to 0 (zero), the alert is disabled. Update only. (Updatable)
`cpu`	`int`	Optional	The percentage of CPU usage required to trigger an alert. If the average CPU usage over two hours exceeds this value, we'll send you an alert. If this is set to 0, the alert is disabled. Update only. (Updatable)
`transfer_quota`	`int`	Optional	The percentage of network transfer that may be used before an alert is triggered. When this value is exceeded, we'll alert you. If this is set to 0 (zero), the alert is disabled. Update only. (Updatable)
`io`	`int`	Optional	The amount of disk IO operation per second required to trigger an alert. If the average disk IO over two hours exceeds this value, we'll send you an alert. If set to 0, this alert is disabled. Update only. (Updatable)
`system_alerts`	`list`	Optional	A list of system alerts associated with the current instance. Note: v4beta only and may not currently be available to all users. (Updatable)
`user_alerts`	`list`	Optional	A list of user alerts associated with the current instance. Note: v4beta only and may not currently be available to all users. (Updatable)

additional_ipv4

Field	Type	Required	Description
`public`	`bool`	Required	Whether the allocated IPv4 address should be public or private.

placement_group

Field	Type	Required	Description
`id`	`int`	Required	The id of the placement group.
`compliant_only`	`bool`	Optional	Whether the newly added/migrated/resized linode must be compliant for flexible placement groups. (Default: `False`)

Return Values

instance - The instance description in JSON serialized form.

Sample Response:

{
  "alerts": {
    "cpu": 180,
    "io": 10000,
    "network_in": 10,
    "network_out": 10,
    "transfer_quota": 80
  },
  "backups": {
    "enabled": true,
    "last_successful": "2018-01-01T00:01:01",
    "schedule": {
      "day": "Saturday",
      "window": "W22"
    }
  },
  "created": "2018-01-01T00:01:01",
  "group": "Linode-Group",
  "has_user_data": true,
  "hypervisor": "kvm",
  "id": 123,
  "image": "linode/debian11",
  "ipv4": [
    "203.0.113.1",
    "192.0.2.1"
  ],
  "ipv6": "c001:d00d::1337/128",
  "label": "linode123",
  "region": "us-east",
  "specs": {
    "disk": 81920,
    "memory": 4096,
    "transfer": 4000,
    "vcpus": 2
  },
  "status": "running",
  "tags": [
    "example tag",
    "another example"
  ],
  "type": "g6-standard-1",
  "updated": "2018-01-01T00:01:01",
  "watchdog_enabled": true,
  "disk_encryption": "enabled",
  "lke_cluster_id": null,
  "maintenance_policy": "linode/migrate",
  "locks": [],
  "placement_group": {
    "id": 123,
    "label": "test",
    "placement_group_type": "anti_affinity:local",
    "placement_group_policy": "strict"
  }
}

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

configs - A list of configs tied to this Linode Instance.

Sample Response:

[
  {
    "comments": "This is my main Config",
    "devices": {
      "sda": {
        "disk_id": 124458,
        "volume_id": null
      },
      "sdb": {
        "disk_id": 124458,
        "volume_id": null
      },
      "sdc": {
        "disk_id": 124458,
        "volume_id": null
      },
      "sdd": {
        "disk_id": 124458,
        "volume_id": null
      },
      "sde": {
        "disk_id": 124458,
        "volume_id": null
      },
      "sdf": {
        "disk_id": 124458,
        "volume_id": null
      },
      "sdg": {
        "disk_id": 124458,
        "volume_id": null
      },
      "sdh": {
        "disk_id": 124458,
        "volume_id": null
      }
    },
    "helpers": {
      "devtmpfs_automount": false,
      "distro": true,
      "modules_dep": true,
      "network": true,
      "updatedb_disabled": true
    },
    "id": 23456,
    "interfaces": [
      {
        "ipam_address": "10.0.0.1/24",
        "label": "example-interface",
        "purpose": "vlan"
      },
      {
        "ip_ranges": null,
        "ipam_address": null,
        "ipv4": null,
        "ipv6": {
          "is_public": null,
          "ranges": [
            {
              "range": "auto"
            }
          ],
          "slaac": [
            {
              "range": "auto"
            }
          ]
        },
        "label": null,
        "primary": false,
        "purpose": "vpc",
        "subnet_id": 271176
      }
    ],
    "kernel": "linode/latest-64bit",
    "label": "My Config",
    "memory_limit": 2048,
    "root_device": "/dev/sda",
    "run_level": "default",
    "virt_mode": "paravirt"
  }
]

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

disks - A list of disks tied to this Linode Instance.

Sample Response:

[
  {
    "created": "2018-01-01T00:01:01",
    "filesystem": "ext4",
    "id": 25674,
    "label": "Debian 9 Disk",
    "size": 48640,
    "status": "ready",
    "updated": "2018-01-01T00:01:01",
    "disk_encryption": "enabled"
  }
]

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

networking - Networking information about this Linode Instance.

Sample Response:

{
  "ipv4": {
    "private": [
      {
        "address": "192.168.133.234",
        "gateway": null,
        "linode_id": 123,
        "prefix": 17,
        "public": false,
        "rdns": null,
        "region": "us-east",
        "subnet_mask": "255.255.128.0",
        "type": "ipv4"
      }
    ],
    "public": [
      {
        "address": "97.107.143.141",
        "gateway": "97.107.143.1",
        "linode_id": 123,
        "prefix": 24,
        "public": true,
        "rdns": "test.example.org",
        "region": "us-east",
        "subnet_mask": "255.255.255.0",
        "type": "ipv4"
      }
    ],
    "reserved": [
      {
        "address": "97.107.143.141",
        "gateway": "97.107.143.1",
        "linode_id": 123,
        "prefix": 24,
        "public": true,
        "rdns": "test.example.org",
        "region": "us-east",
        "subnet_mask": "255.255.255.0",
        "type": "ipv4"
      }
    ],
    "shared": [
      {
        "address": "97.107.143.141",
        "gateway": "97.107.143.1",
        "linode_id": 123,
        "prefix": 24,
        "public": true,
        "rdns": "test.example.org",
        "region": "us-east",
        "subnet_mask": "255.255.255.0",
        "type": "ipv4"
      }
    ],
    "vpc": [
      {
        "active": true,
        "address": "10.0.0.2",
        "address_range": null,
        "config_id": 12345,
        "database_id": null,
        "gateway": "10.0.0.1",
        "interface_id": 12345,
        "linode_id": 12345,
        "nat_1_1": null,
        "nodebalancer_id": null,
        "prefix": 24,
        "region": "us-example-1",
        "subnet_id": 12345,
        "subnet_mask": "255.255.255.0",
        "vpc_id": 12345
      }
    ]
  },
  "ipv6": {
    "global": {
      "prefix": 124,
      "range": "2600:3c01::2:5000:0",
      "region": "us-east",
      "route_target": "2600:3c01::2:5000:f"
    },
    "link_local": {
      "address": "fe80::f03c:91ff:fe24:3a2f",
      "gateway": "fe80::1",
      "linode_id": 123,
      "prefix": 64,
      "public": false,
      "rdns": null,
      "region": "us-east",
      "subnet_mask": "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff",
      "type": "ipv6"
    },
    "slaac": {
      "address": "2600:3c03::f03c:91ff:fe24:3a2f",
      "gateway": "fe80::1",
      "linode_id": 123,
      "prefix": 64,
      "public": true,
      "rdns": null,
      "region": "us-east",
      "subnet_mask": "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff",
      "type": "ipv6"
    },
    "vpc": {
      "vpc": [
        {
          "active": true,
          "address": null,
          "address_range": null,
          "config_id": 12345,
          "database_id": null,
          "gateway": null,
          "interface_id": 12345,
          "ipv6_addresses": [
            {
              "slaac_address": "2001:db8:acad:1:abcd:ef12:3456:7890"
            }
          ],
          "ipv6_is_public": false,
          "ipv6_range": "2001:db8:acad:1::/64",
          "linode_id": 12345,
          "nat_1_1": "",
          "nodebalancer_id": null,
          "prefix": 64,
          "region": "us-example-1",
          "subnet_id": 12345,
          "subnet_mask": "",
          "vpc_id": 12345
        },
        {
          "active": true,
          "address": null,
          "address_range": null,
          "config_id": 12345,
          "database_id": null,
          "gateway": null,
          "interface_id": 12345,
          "ipv6_addresses": [],
          "ipv6_is_public": false,
          "ipv6_range": "2001:db8:acad:2::/64",
          "linode_id": 12345,
          "nat_1_1": "",
          "nodebalancer_id": null,
          "prefix": 64,
          "region": "us-example-1",
          "subnet_id": 12345,
          "subnet_mask": "",
          "vpc_id": 12345
        }
      ]
    }
  }
}

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

linode_interfaces - A list of Linode interfaces tied to this Linode Instance.

Sample Response:

{
  "created": "2025-01-01T00:01:01",
  "default_route": {
    "ipv4": true,
    "ipv6": true
  },
  "id": 1234,
  "mac_address": "22:00:AB:CD:EF:01",
  "public": {
    "ipv4": {
      "addresses": [
        {
          "address": "172.30.0.50",
          "primary": true
        }
      ],
      "shared": [
        {
          "address": "172.30.0.51",
          "linode_id": 12345
        }
      ]
    },
    "ipv6": {
      "ranges": [
        {
          "range": "2600:3c09:e001:59::/64",
          "route_target": "2600:3c09::ff:feab:cdef"
        },
        {
          "range": "2600:3c09:e001:5a::/64",
          "route_target": "2600:3c09::ff:feab:cdef"
        }
      ],
      "shared": [
        {
          "range": "2600:3c09:e001:2a::/64",
          "route_target": null
        }
      ],
      "slaac": [
        {
          "address": "2600:3c09::ff:feab:cdef",
          "prefix": 64
        }
      ]
    }
  },
  "updated": "2025-01-01T00:01:01",
  "version": 1,
  "vlan": null,
  "vpc": null
}

{
  "created": "2025-01-01T00:01:01",
  "default_route": {},
  "id": 1234,
  "mac_address": "22:00:AB:CD:EF:01",
  "public": null,
  "updated": "2025-01-01T00:01:01",
  "version": 1,
  "vlan": {
    "ipam_address": "10.0.0.1/24",
    "vlan_label": "my-vlan"
  },
  "vpc": null
}

{
  "created": "2025-01-01T00:01:01",
  "default_route": {
    "ipv4": true,
    "ipv6": true
  },
  "id": 1234,
  "mac_address": "22:00:AB:CD:EF:01",
  "public": null,
  "updated": "2025-01-01T00:02:01",
  "version": 1,
  "vlan": null,
  "vpc": {
    "ipv4": {
      "addresses": [
        {
          "address": "192.168.22.3",
          "primary": true
        }
      ],
      "ranges": [
        {
          "range": "192.168.22.16/28"
        },
        {
          "range": "192.168.22.32/28"
        }
      ]
    },
    "ipv6": {
      "is_public": false,
      "ranges": [
        {
          "range": "2600:3c13:e405:2::/64"
        },
        {
          "range": "2600:3c13:e405:3::/64"
        }
      ],
      "slaac": [
        {
          "address": "2600:3c13:e405:1:2000:71ff:fea5:7f5b",
          "range": "2600:3c13:e405:1::/64"
        }
      ]
    },
    "subnet_id": 1234,
    "vpc_id": 1234
  }
}

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

FilesExpand file tree

instance.md

Latest commit

History

instance.md

File metadata and controls

instance

Minimum Required Fields

Examples

Parameters

configs

devices

sda

sdb

sdc

sdd

sde

sdf

sdg

sdh

sdi

sdj

sdk

sdl

sdm

sdn

sdo

sdp

sdq

sdr

sds

sdt

sdu

sdv

sdw

sdx

sdy

sdz

sdaa

sdab

sdac

sdad

sdae

sdaf

sdag

sdah

sdai

sdaj

sdak

sdal

sdam

sdan

sdao

sdap

sdaq

sdar

sdas

sdat

sdau

sdav

sdaw

sdax

sday

sdaz

sdba

sdbb

sdbc

sdbd

sdbe

sdbf

sdbg

sdbh

sdbi

sdbj

sdbk

sdbl

helpers

interfaces

ipv4

ipv6