Skip to content

Latest commit

 

History

History
506 lines (473 loc) · 15.1 KB

instance_info.md

File metadata and controls

506 lines (473 loc) · 15.1 KB

instance_info

Get info about a Linode Instance.

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: Get info about an instance by label
  linode.cloud.instance_info:
    label: 'my-instance' 
- name: Get info about an instance by id
  linode.cloud.instance_info:
    id: 12345

Parameters

Field Type Required Description
id int Optional The ID of the Instance to resolve. (Conflicts With: label)
label str Optional The label of the Instance to resolve. (Conflicts With: id)

Return Values

  • instance - The returned Instance.

    • 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",
  "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 - The returned Configs.

    • 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 - The returned Disks.

    • 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 - The returned Networking Configuration.

    • 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 - The returned Linode Interfaces.

    • 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