command

Documentation

Index

• func Arch(m remotecommand.Machine, cb ssh.HostKeyCallback) (string, error)
• func CPUCores(m remotecommand.Machine, cb ssh.HostKeyCallback) (int, error)
• func CPUName(m remotecommand.Machine, cb ssh.HostKeyCallback) (string, error)
• func CPUThreads(m remotecommand.Machine, cb ssh.HostKeyCallback) (int, error)
• func Disks(m remotecommand.Machine, cb ssh.HostKeyCallback) ([]totalos.Disk, error)
• func EthernetDeviceName(m remotecommand.Machine, cb ssh.HostKeyCallback) (string, error)
• func FormatXFS(m remotecommand.Machine, device, diskUUID, partLabel, partUUID string, ...) error
• func IPv4(m remotecommand.Machine, cb ssh.HostKeyCallback) (net.IP, error)
• func IPv4Gateway(m remotecommand.Machine, cb ssh.HostKeyCallback) (net.IP, error)
• func IPv4Netmask(m remotecommand.Machine, cb ssh.HostKeyCallback) (net.IP, error)
• func InstallImage(m remotecommand.Machine, isoImageURL, device string, cb ssh.HostKeyCallback) error
• func MAC(m remotecommand.Machine, cb ssh.HostKeyCallback) (string, error)
• func Memory(m remotecommand.Machine, cb ssh.HostKeyCallback) (totalos.GigaByte, error)
• func Reboot(m remotecommand.Machine, cb ssh.HostKeyCallback)
• func SelectStorageDisk(disks []totalos.Disk, systemDisk totalos.Disk, pref *DiskPreference) (totalos.Disk, error)
• func SelectSystemDisk(disks []totalos.Disk, pref *DiskPreference) (totalos.Disk, error)
• func SetConfigURL(m remotecommand.Machine, configURL, device string, cb ssh.HostKeyCallback) error
• func SoftwareRAIDNotExists(m remotecommand.Machine, cb ssh.HostKeyCallback) error
• func Storage(m remotecommand.Machine, cb ssh.HostKeyCallback) ([]totalos.GigaByte, error)
• func SystemUUID(m remotecommand.Machine, cb ssh.HostKeyCallback) (string, error)
• func WipeFileSystemSignatures(m remotecommand.Machine, cb ssh.HostKeyCallback) error
• type DiskPreference

Functions

func Arch

func Arch(m remotecommand.Machine, cb ssh.HostKeyCallback) (string, error)

Arch returns the machine architecture (see `uname -m`)

func CPUCores

func CPUCores(m remotecommand.Machine, cb ssh.HostKeyCallback) (int, error)

CPUCores returns the amount of real CPU cores

func CPUName

func CPUName(m remotecommand.Machine, cb ssh.HostKeyCallback) (string, error)

CPUName returns the CPU name

func CPUThreads

func CPUThreads(m remotecommand.Machine, cb ssh.HostKeyCallback) (int, error)

CPUThreads returns the amount of CPU threads

func Disks

func Disks(m remotecommand.Machine, cb ssh.HostKeyCallback) ([]totalos.Disk, error)

Disks returns all disks

func EthernetDeviceName

func EthernetDeviceName(m remotecommand.Machine, cb ssh.HostKeyCallback) (string, error)

EthernetDeviceName returns the name of the ethernet device, like eth0 or enp0s31f6 (when kernel is configured to use predictable network interface names).

func FormatXFS

func FormatXFS(m remotecommand.Machine, device, diskUUID, partLabel, partUUID string, cb ssh.HostKeyCallback) error

FormatXFS formats the full device with one XFS partition. Sets disk UUID (default is "61291e61-291e-6129-1e61-291e61291e00"), partition label (default is "storage") and partition UUID (default is "61291e61-291e-6129-1e61-291e61291e01").

func IPv4

func IPv4(m remotecommand.Machine, cb ssh.HostKeyCallback) (net.IP, error)

IPv4 address of ethernet device

func IPv4Gateway

func IPv4Gateway(m remotecommand.Machine, cb ssh.HostKeyCallback) (net.IP, error)

IPv4Gateway returns the default gateway IPv4 of ethernet device

func IPv4Netmask

func IPv4Netmask(m remotecommand.Machine, cb ssh.HostKeyCallback) (net.IP, error)

IPv4Netmask returns the IPv4 netmask of ethernet device

func InstallImage

func InstallImage(m remotecommand.Machine, isoImageURL, device string, cb ssh.HostKeyCallback) error

InstallImage downloads the raw.xz image URL and writes it to the given device.

func MAC

func MAC(m remotecommand.Machine, cb ssh.HostKeyCallback) (string, error)

MAC returns the address of the ethernet interface

func Memory

func Memory(m remotecommand.Machine, cb ssh.HostKeyCallback) (totalos.GigaByte, error)

Memory returns the amount of RAM

func Reboot

func Reboot(m remotecommand.Machine, cb ssh.HostKeyCallback)

Reboot triggers a reboot. It does not return anything, since the machine should be offline and not be able to have an SSH chat :)

func SelectStorageDisk

func SelectStorageDisk(disks []totalos.Disk, systemDisk totalos.Disk, pref *DiskPreference) (totalos.Disk, error)

SelectStorageDisk finds and returns the biggest available disk which is not the system disk.

func SelectSystemDisk

func SelectSystemDisk(disks []totalos.Disk, pref *DiskPreference) (totalos.Disk, error)

SelectSystemDisk takes all disks, sorts them by their serial alphabetically and returns the first one. The result is deterministic.

func SetConfigURL

func SetConfigURL(m remotecommand.Machine, configURL, device string, cb ssh.HostKeyCallback) error

Sets talos.config in grub.cfg

func SoftwareRAIDNotExists

func SoftwareRAIDNotExists(m remotecommand.Machine, cb ssh.HostKeyCallback) error

SoftwareRAIDNotExists ensures that there are no software RAID partitions (/dev/md*)

func Storage

func Storage(m remotecommand.Machine, cb ssh.HostKeyCallback) ([]totalos.GigaByte, error)

Storage returns a slice with the gigabytes of storage per disk

func SystemUUID

func SystemUUID(m remotecommand.Machine, cb ssh.HostKeyCallback) (string, error)

SystemUUID as defined in SMBIOS data

func WipeFileSystemSignatures

func WipeFileSystemSignatures(m remotecommand.Machine, cb ssh.HostKeyCallback) error

WipeFileSystemSignatures erases all available signatures of all NVMe and SATA drives. It does not shred the data, though!

Types

type DiskPreference

type DiskPreference struct {
	IgnoreUSB bool
}