ansible.builtin.linode_v4 (v2.9.27) — module

Manage instances on the Linode cloud.

| "added in version" 2.8 of ansible.builtin"

Authors: Luke Murphy (@lwm)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Manage instances on the Linode cloud.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create a new Linode.
  linode_v4:
    label: new-linode
    type: g6-nanode-1
    region: eu-west
    image: linode/debian9
    root_pass: passw0rd
    authorized_keys:
      - "ssh-rsa ..."
    state: present
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete that new Linode.
  linode_v4:
    label: new-linode
    state: absent

Inputs

    
tags:
    description:
    - The tags that the instance should be marked under. See U(https://developers.linode.com/api/v4#tag/Tags).
    required: false
    type: list

type:
    description:
    - The type of the instance. This is a required parameter only when creating Linode
      instances. See U(https://developers.linode.com/api/v4#tag/Linode-Types).
    required: false
    type: str

group:
    description:
    - 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.
    required: false
    type: str

image:
    description:
    - The image of the instance. This is a required parameter only when creating Linode
      instances. See U(https://developers.linode.com/api/v4#tag/Images).
    required: false
    type: str

label:
    description:
    - The instance label. This label is used as the main determiner for idempotence for
      the module and is therefore mandatory.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    description:
    - The desired instance state.
    required: true
    type: str

region:
    description:
    - The region of the instance. This is a required parameter only when creating Linode
      instances. See U(https://developers.linode.com/api/v4#tag/Regions).
    required: false
    type: str

root_pass:
    description:
    - The password for the root user. If not specified, one will be generated. This generated
      password will be available in the task success JSON.
    required: false
    type: str

access_token:
    description:
    - The Linode API v4 access token. It may also be specified by exposing the C(LINODE_ACCESS_TOKEN)
      environment variable. See U(https://developers.linode.com/api/v4#section/Access-and-Authentication).
    required: true

authorized_keys:
    description:
    - A list of SSH public key parts to deploy for the root user.
    required: false
    type: list

Outputs

instance:
  description: The instance description in JSON serialized form.
  returned: Always.
  sample:
    alerts:
      cpu: 90
      io: 10000
      network_in: 10
      network_out: 10
      transfer_quota: 80
    backups:
      enabled: false
      schedule:
        day: null
        window: null
    created: '2018-09-26T08:12:33'
    group: Foobar Group
    hypervisor: kvm
    id: 10480444
    image: linode/centos7
    ipv4:
    - 130.132.285.233
    ipv6: 2a82:7e00::h03c:46ff:fe04:5cd2/64
    label: lin-foo
    region: eu-west
    root_pass: foobar
    specs:
      disk: 25600
      memory: 1024
      transfer: 1000
      vcpus: 1
    status: running
    tags: []
    type: g6-nanode-1
    updated: '2018-09-26T10:10:14'
    watchdog_enabled: true
  type: dict