templates

Documentation

Index

• func ExactArgs(nameOfCommand string, n int) cobra.PositionalArgs
• func KindIsVM(kind string) bool
• func KindIsVMI(kind string) bool
• func MainUsageTemplate() string
• func OptionsUsageTemplate() string
• func ParseSCPArguments(arg1 string, arg2 string) (local LocalSCPArgument, remote RemoteSCPArgument, toRemote bool, err error)
• func ParseSSHTarget(arg string) (kind, namespace, name, username string, err error)
• func ParseTarget(arg string) (kind string, namespace string, name string, err error)
• func PrintWarningForPausedVMI(virtCli kubecli.KubevirtClient, vmiName string, namespace string)
• func UsageTemplate() string
• type LocalSCPArgument
• type RemoteSCPArgument

Functions

func ExactArgs

func ExactArgs(nameOfCommand string, n int) cobra.PositionalArgs

ExactArgs validate the number of input parameters

func KindIsVM

func KindIsVM(kind string) bool

KindIsVM helps validating input parameters for specifying the VM resource

func KindIsVMI

func KindIsVMI(kind string) bool

KindIsVMI helps validating input parameters for specifying the VMI resource

func MainUsageTemplate

func MainUsageTemplate() string

MainUsageTemplate returns the usage template for the root command

func OptionsUsageTemplate

func OptionsUsageTemplate() string

OptionsUsageTemplate returns a template which prints all global available commands

func ParseSCPArguments

func ParseSCPArguments(arg1 string, arg2 string) (local LocalSCPArgument, remote RemoteSCPArgument, toRemote bool, err error)

func ParseSSHTarget

func ParseSSHTarget(arg string) (kind, namespace, name, username string, err error)

ParseSSHTarget argument supporting the form of username@vmi/name.namespace (or simpler)

func ParseTarget

func ParseTarget(arg string) (kind string, namespace string, name string, err error)

ParseTarget argument supporting the form of vmi/name.namespace (or simpler)

func PrintWarningForPausedVMI

func PrintWarningForPausedVMI(virtCli kubecli.KubevirtClient, vmiName string, namespace string)

PrintWarningForPausedVMI prints warning message if VMI is paused

func UsageTemplate

func UsageTemplate() string

UsageTemplate returns the usage template for all subcommands

Types

type LocalSCPArgument

type LocalSCPArgument struct {
	Path string
}

type RemoteSCPArgument

type RemoteSCPArgument struct {
	Kind      string
	Namespace string
	Name      string
	Username  string
	Path      string
}