community.hrobot.boot (1.9.1) — module

Install collection

Install with ansible-galaxy collection install community.hrobot:==1.9.1

Add to requirements.yml

  collections:
    - name: community.hrobot
      version: 1.9.1

Description

Set the boot configuration for a dedicated server.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Disable all special boot configurations
  community.hrobot.boot:
    hetzner_user: foo
    hetzner_password: bar
    regular_boot: true

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Enable a rescue system (64bit Linux) for the next boot
  community.hrobot.boot:
    hetzner_user: foo
    hetzner_password: bar
    rescue:
      os: linux

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Enable a Linux install for the next boot
  community.hrobot.boot:
    hetzner_user: foo
    hetzner_password: bar
    install_linux:
      dist: CentOS 5.5 minimal
      lang: en
      authorized_keys:
        - 56:29:99:a4:5d:ed:ac:95:c1:f5:88:82:90:5d:dd:10
        - 15:28:b0:03:95:f0:77:b3:10:56:15:6b:77:22:a5:bb

Inputs

    
rescue:
    description:
    - If this option is provided, the rescue system will be activated for the next boot.
    - Precisely one of O(regular_boot), O(rescue), O(install_linux), O(install_vnc), O(install_windows),
      O(install_plesk), and O(install_cpanel) must be provided.
    suboptions:
      arch:
        choices:
        - 32
        - 64
        description:
        - The architecture to use for the rescue system.
        - Not all architectures are available for all operating systems.
        - Defaults to V(64).
        type: int
      authorized_keys:
        description:
        - One or more SSH key fingerprints to equip the rescue system with.
        - Only fingerprints for SSH keys deposited in the Robot API can be used.
        - You can use the M(community.hrobot.ssh_key_info) module to query the SSH keys
          you can use, and the M(community.hrobot.ssh_key) module to add or update SSH
          keys.
        elements: str
        type: list
      os:
        description:
        - The operating system to use for the rescue system. Possible choices can change
          over time.
        - Currently, V(linux), V(linuxold), V(freebsd), V(freebsdold), V(freebsdax), V(freebsdbetaax),
          V(vkvm), and V(vkvmold) seem to be available.
        required: true
        type: str
    type: dict

install_vnc:
    description:
    - If this option is provided, a VNC installation will be activated for the next boot.
    - Precisely one of O(regular_boot), O(rescue), O(install_linux), O(install_vnc), O(install_windows),
      O(install_plesk), and O(install_cpanel) must be provided.
    suboptions:
      arch:
        choices:
        - 32
        - 64
        description:
        - The architecture to use for the install.
        - Not all architectures are available for all distributions.
        - Defaults to V(64).
        type: int
      dist:
        description:
        - The distribution to install.
        required: true
        type: str
      lang:
        description:
        - The language to use for the operating system.
        required: true
        type: str
    type: dict

hetzner_user:
    description: The username for the Robot webservice user.
    required: true
    type: str

regular_boot:
    choices:
    - true
    description:
    - If this option is provided, all special boot configurations are removed and the
      installed operating system will be booted up next (assuming it is bootable).
    - Precisely one of O(regular_boot), O(rescue), O(install_linux), O(install_vnc), O(install_windows),
      O(install_plesk), and O(install_cpanel) must be provided.
    type: bool

install_linux:
    description:
    - If this option is provided, a Linux system install will be activated for the next
      boot.
    - Precisely one of O(regular_boot), O(rescue), O(install_linux), O(install_vnc), O(install_windows),
      O(install_plesk), and O(install_cpanel) must be provided.
    suboptions:
      arch:
        choices:
        - 32
        - 64
        description:
        - The architecture to use for the install.
        - Not all architectures are available for all distributions.
        - Defaults to V(64).
        type: int
      authorized_keys:
        description:
        - One or more SSH key fingerprints to equip the rescue system with.
        - Only fingerprints for SSH keys deposited in the Robot API can be used.
        - You can use the M(community.hrobot.ssh_key_info) module to query the SSH keys
          you can use, and the M(community.hrobot.ssh_key) module to add or update SSH
          keys.
        elements: str
        type: list
      dist:
        description:
        - The distribution to install.
        required: true
        type: str
      lang:
        description:
        - The language to use for the operating system.
        required: true
        type: str
    type: dict

install_plesk:
    description:
    - If this option is provided, a Plesk installation will be activated for the next
      boot.
    - Precisely one of O(regular_boot), O(rescue), O(install_linux), O(install_vnc), O(install_windows),
      O(install_plesk), and O(install_cpanel) must be provided.
    suboptions:
      arch:
        choices:
        - 32
        - 64
        description:
        - The architecture to use for the install.
        - Not all architectures are available for all distributions.
        - Defaults to V(64).
        type: int
      dist:
        description:
        - The distribution to install.
        required: true
        type: str
      hostname:
        description:
        - The hostname.
        required: true
        type: str
      lang:
        description:
        - The language to use for the operating system.
        required: true
        type: str
    type: dict

server_number:
    description:
    - The server number of the server whose boot configuration to adjust.
    required: true
    type: int

install_cpanel:
    description:
    - If this option is provided, a cPanel installation will be activated for the next
      boot.
    - Precisely one of O(regular_boot), O(rescue), O(install_linux), O(install_vnc), O(install_windows),
      O(install_plesk), and O(install_cpanel) must be provided.
    suboptions:
      arch:
        choices:
        - 32
        - 64
        description:
        - The architecture to use for the install.
        - Not all architectures are available for all distributions.
        - Defaults to V(64).
        type: int
      dist:
        description:
        - The distribution to install.
        required: true
        type: str
      hostname:
        description:
        - The hostname.
        required: true
        type: str
      lang:
        description:
        - The language to use for the operating system.
        required: true
        type: str
    type: dict

install_windows:
    description:
    - If this option is provided, a Windows installation will be activated for the next
      boot.
    - Precisely one of O(regular_boot), O(rescue), O(install_linux), O(install_vnc), O(install_windows),
      O(install_plesk), and O(install_cpanel) must be provided.
    suboptions:
      lang:
        description:
        - The language to use for Windows.
        required: true
        type: str
    type: dict

hetzner_password:
    description: The password for the Robot webservice user.
    required: true
    type: str

Outputs

configuration_type:
  choices:
  - regular_boot
  - rescue
  - install_linux
  - install_vnc
  - install_windows
  - install_plesk
  - install_cpanel
  description:
  - Describes the active boot configuration.
  returned: success
  type: str
password:
  description:
  - The root password for the active boot configuration, if available.
  - For non-rescue boot configurations, it is avised to change the root password as
    soon as possible.
  returned: success and if RV(configuration_type) is not V(regular_boot)
  type: str

See also

• community.hrobot.ssh_key : Add, remove or update SSH key
• community.hrobot.ssh_key_info : Query information on SSH keys