Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var AssignCmd = base.Cmd{ BaseCobraCommand: func(client hcapi2.Client) *cobra.Command { return &cobra.Command{ Use: "assign <floating-ip> <server>", Short: "Assign a Floating IP to a server", ValidArgsFunction: cmpl.SuggestArgs( cmpl.SuggestCandidatesF(client.FloatingIP().Names), cmpl.SuggestCandidatesF(client.Server().Names), ), TraverseChildren: true, DisableFlagsInUseLine: true, } }, Run: func(s state.State, cmd *cobra.Command, args []string) error { idOrName := args[0] floatingIP, _, err := s.Client().FloatingIP().Get(s, idOrName) if err != nil { return err } if floatingIP == nil { return fmt.Errorf("Floating IP not found: %v", idOrName) } serverIDOrName := args[1] server, _, err := s.Client().Server().Get(s, serverIDOrName) if err != nil { return err } if server == nil { return fmt.Errorf("Server not found: %s", serverIDOrName) } action, _, err := s.Client().FloatingIP().Assign(s, floatingIP, server) if err != nil { return err } if err := s.WaitForActions(s, cmd, action); err != nil { return err } cmd.Printf("Floating IP %d assigned to Server %d\n", floatingIP.ID, server.ID) return nil }, }
View Source
var ChangeProtectionCmds = base.ChangeProtectionCmds[*hcloud.FloatingIP, hcloud.FloatingIPChangeProtectionOpts]{ ResourceNameSingular: "Floating IP", NameSuggestions: func(client hcapi2.Client) func() []string { return client.FloatingIP().Names }, ProtectionLevels: map[string]func(opts *hcloud.FloatingIPChangeProtectionOpts, value bool){ "delete": func(opts *hcloud.FloatingIPChangeProtectionOpts, value bool) { opts.Delete = &value }, }, Fetch: func(s state.State, _ *cobra.Command, idOrName string) (*hcloud.FloatingIP, *hcloud.Response, error) { return s.Client().FloatingIP().Get(s, idOrName) }, ChangeProtectionFunction: func(s state.State, floatingIP *hcloud.FloatingIP, opts hcloud.FloatingIPChangeProtectionOpts) (*hcloud.Action, *hcloud.Response, error) { return s.Client().FloatingIP().ChangeProtection(s, floatingIP, opts) }, IDOrName: func(floatingIP *hcloud.FloatingIP) string { return fmt.Sprint(floatingIP.ID) }, }
View Source
var CreateCmd = base.CreateCmd[*hcloud.FloatingIP]{ BaseCobraCommand: func(client hcapi2.Client) *cobra.Command { cmd := &cobra.Command{ Use: "create [options] --type <ipv4|ipv6> (--home-location <location> | --server <server>)", Short: "Create a Floating IP", TraverseChildren: true, DisableFlagsInUseLine: true, } cmd.Flags().String("type", "", "Type (ipv4 or ipv6) (required)") _ = cmd.RegisterFlagCompletionFunc("type", cmpl.SuggestCandidates("ipv4", "ipv6")) _ = cmd.MarkFlagRequired("type") cmd.Flags().String("description", "", "Description") cmd.Flags().String("name", "", "Name") cmd.Flags().String("home-location", "", "Home Location") _ = cmd.RegisterFlagCompletionFunc("home-location", cmpl.SuggestCandidatesF(client.Location().Names)) cmd.Flags().String("server", "", "Server to assign Floating IP to") _ = cmd.RegisterFlagCompletionFunc("server", cmpl.SuggestCandidatesF(client.Server().Names)) cmd.Flags().StringToString("label", nil, "User-defined labels ('key=value') (can be specified multiple times)") cmd.Flags().StringSlice("enable-protection", []string{}, "Enable protection (delete) (default: none)") _ = cmd.RegisterFlagCompletionFunc("enable-protection", cmpl.SuggestCandidates("delete")) return cmd }, Run: func(s state.State, cmd *cobra.Command, _ []string) (*hcloud.FloatingIP, any, error) { typ, _ := cmd.Flags().GetString("type") if typ == "" { return nil, nil, errors.New("type is required") } homeLocation, _ := cmd.Flags().GetString("home-location") server, _ := cmd.Flags().GetString("server") if homeLocation == "" && server == "" { return nil, nil, errors.New("one of --home-location or --server is required") } name, _ := cmd.Flags().GetString("name") description, _ := cmd.Flags().GetString("description") serverNameOrID, _ := cmd.Flags().GetString("server") labels, _ := cmd.Flags().GetStringToString("label") protection, _ := cmd.Flags().GetStringSlice("enable-protection") protectionOpts, err := ChangeProtectionCmds.GetChangeProtectionOpts(true, protection) if err != nil { return nil, nil, err } createOpts := hcloud.FloatingIPCreateOpts{ Type: hcloud.FloatingIPType(typ), Description: &description, Labels: labels, } if name != "" { createOpts.Name = &name } if homeLocation != "" { createOpts.HomeLocation = &hcloud.Location{Name: homeLocation} } if serverNameOrID != "" { server, _, err := s.Client().Server().Get(s, serverNameOrID) if err != nil { return nil, nil, err } if server == nil { return nil, nil, fmt.Errorf("Server not found: %s", serverNameOrID) } createOpts.Server = server } result, _, err := s.Client().FloatingIP().Create(s, createOpts) if err != nil { return nil, nil, err } if result.Action != nil { if err := s.WaitForActions(s, cmd, result.Action); err != nil { return nil, nil, err } } cmd.Printf("Floating IP %d created\n", result.FloatingIP.ID) if protectionOpts.Delete != nil { if err := ChangeProtectionCmds.ChangeProtection(s, cmd, result.FloatingIP, true, protectionOpts); err != nil { return nil, nil, err } } floatingIP, _, err := s.Client().FloatingIP().GetByID(s, result.FloatingIP.ID) if err != nil { return nil, nil, err } if floatingIP == nil { return nil, nil, fmt.Errorf("Floating IP not found: %d", result.FloatingIP.ID) } return floatingIP, util.Wrap("floating_ip", hcloud.SchemaFromFloatingIP(floatingIP)), nil }, PrintResource: func(_ state.State, cmd *cobra.Command, floatingIP *hcloud.FloatingIP) { cmd.Printf("IP%s: %s\n", floatingIP.Type[2:], floatingIP.IP) }, }
View Source
var DeleteCmd = base.DeleteCmd[*hcloud.FloatingIP]{ ResourceNameSingular: "Floating IP", ResourceNamePlural: "Floating IPs", ShortDescription: "Delete a Floating IP", NameSuggestions: func(c hcapi2.Client) func() []string { return c.FloatingIP().Names }, Fetch: func(s state.State, _ *cobra.Command, idOrName string) (*hcloud.FloatingIP, *hcloud.Response, error) { return s.Client().FloatingIP().Get(s, idOrName) }, Delete: func(s state.State, _ *cobra.Command, floatingIP *hcloud.FloatingIP) (*hcloud.Action, error) { _, err := s.Client().FloatingIP().Delete(s, floatingIP) return nil, err }, }
View Source
var DescribeCmd = base.DescribeCmd[*hcloud.FloatingIP]{ ResourceNameSingular: "Floating IP", ShortDescription: "Describe a Floating IP", NameSuggestions: func(c hcapi2.Client) func() []string { return c.FloatingIP().Names }, Fetch: func(s state.State, _ *cobra.Command, idOrName string) (*hcloud.FloatingIP, any, error) { ip, _, err := s.Client().FloatingIP().Get(s, idOrName) if err != nil { return nil, nil, err } return ip, hcloud.SchemaFromFloatingIP(ip), nil }, PrintText: func(s state.State, _ *cobra.Command, out io.Writer, floatingIP *hcloud.FloatingIP) error { fmt.Fprintf(out, "ID:\t%d\n", floatingIP.ID) fmt.Fprintf(out, "Type:\t%s\n", floatingIP.Type) fmt.Fprintf(out, "Name:\t%s\n", floatingIP.Name) fmt.Fprintf(out, "Description:\t%s\n", util.NA(floatingIP.Description)) fmt.Fprintf(out, "Created:\t%s (%s)\n", util.Datetime(floatingIP.Created), humanize.Time(floatingIP.Created)) if floatingIP.Network != nil { fmt.Fprintf(out, "IP:\t%s\n", floatingIP.Network.String()) } else { fmt.Fprintf(out, "IP:\t%s\n", floatingIP.IP.String()) } fmt.Fprintf(out, "Blocked:\t%s\n", util.YesNo(floatingIP.Blocked)) fmt.Fprintf(out, "Home Location:\t%s\n", floatingIP.HomeLocation.Name) fmt.Fprintln(out) fmt.Fprintf(out, "Server:\n") if floatingIP.Server != nil { fmt.Fprintf(out, " ID:\t%d\n", floatingIP.Server.ID) fmt.Fprintf(out, " Name:\t%s\n", s.Client().Server().ServerName(floatingIP.Server.ID)) } else { fmt.Fprintf(out, " Not assigned\n") } fmt.Fprintln(out) fmt.Fprintf(out, "DNS:\n") if len(floatingIP.DNSPtr) == 0 { fmt.Fprintf(out, " No reverse DNS entries\n") } else { for ip, dns := range floatingIP.DNSPtr { fmt.Fprintf(out, " %s:\t%s\n", ip, dns) } } fmt.Fprintln(out) fmt.Fprintf(out, "Protection:\n") fmt.Fprintf(out, " Delete:\t%s\n", util.YesNo(floatingIP.Protection.Delete)) fmt.Fprintln(out) util.DescribeLabels(out, floatingIP.Labels, "") return nil }, }
View Source
var LabelCmds = base.LabelCmds[*hcloud.FloatingIP]{ ResourceNameSingular: "Floating IP", ShortDescriptionAdd: "Add a label to a Floating IP", ShortDescriptionRemove: "Remove a label from a Floating IP", NameSuggestions: func(c hcapi2.Client) func() []string { return c.FloatingIP().Names }, LabelKeySuggestions: func(c hcapi2.Client) func(idOrName string) []string { return c.FloatingIP().LabelKeys }, Fetch: func(s state.State, idOrName string) (*hcloud.FloatingIP, error) { floatingIP, _, err := s.Client().FloatingIP().Get(s, idOrName) if err != nil { return nil, err } if floatingIP == nil { return nil, fmt.Errorf("Floating IP not found: %s", idOrName) } return floatingIP, nil }, SetLabels: func(s state.State, floatingIP *hcloud.FloatingIP, labels map[string]string) error { opts := hcloud.FloatingIPUpdateOpts{ Labels: labels, } _, _, err := s.Client().FloatingIP().Update(s, floatingIP, opts) return err }, GetLabels: func(floatingIP *hcloud.FloatingIP) map[string]string { return floatingIP.Labels }, GetIDOrName: func(floatingIP *hcloud.FloatingIP) string { return strconv.FormatInt(floatingIP.ID, 10) }, }
View Source
var ListCmd = &base.ListCmd[*hcloud.FloatingIP, schema.FloatingIP]{ ResourceNamePlural: "Floating IPs", JSONKeyGetByName: "floating_ips", DefaultColumns: []string{"id", "type", "name", "description", "ip", "home", "server", "dns", "age"}, SortOption: config.OptionSortFloatingIP, Fetch: func(s state.State, _ *pflag.FlagSet, listOpts hcloud.ListOpts, sorts []string) ([]*hcloud.FloatingIP, error) { opts := hcloud.FloatingIPListOpts{ListOpts: listOpts} if len(sorts) > 0 { opts.Sort = sorts } return s.Client().FloatingIP().AllWithOpts(s, opts) }, OutputTable: func(t *output.Table[*hcloud.FloatingIP], client hcapi2.Client) { t. AddAllowedFields(&hcloud.FloatingIP{}). AddFieldFn("dns", func(floatingIP *hcloud.FloatingIP) string { var dns string if len(floatingIP.DNSPtr) == 1 { for _, v := range floatingIP.DNSPtr { dns = v } } if len(floatingIP.DNSPtr) > 1 { dns = fmt.Sprintf("%d entries", len(floatingIP.DNSPtr)) } return util.NA(dns) }). AddFieldFn("server", func(floatingIP *hcloud.FloatingIP) string { var server string if floatingIP.Server != nil { return client.Server().ServerName(floatingIP.Server.ID) } return util.NA(server) }). AddFieldFn("home", func(floatingIP *hcloud.FloatingIP) string { return floatingIP.HomeLocation.Name }). AddFieldFn("ip", func(floatingIP *hcloud.FloatingIP) string { if floatingIP.Network != nil { return floatingIP.Network.String() } return floatingIP.IP.String() }). AddFieldFn("protection", func(floatingIP *hcloud.FloatingIP) string { var protection []string if floatingIP.Protection.Delete { protection = append(protection, "delete") } return strings.Join(protection, ", ") }). AddFieldFn("labels", func(floatingIP *hcloud.FloatingIP) string { return util.LabelsToString(floatingIP.Labels) }). AddFieldFn("created", func(floatingIP *hcloud.FloatingIP) string { return util.Datetime(floatingIP.Created) }). AddFieldFn("age", func(floatingIP *hcloud.FloatingIP) string { return util.Age(floatingIP.Created, time.Now()) }) }, Schema: hcloud.SchemaFromFloatingIP, }
View Source
var SetRDNSCmd = base.SetRdnsCmd[*hcloud.FloatingIP]{ ResourceNameSingular: "Floating IP", ShortDescription: "Change reverse DNS of a Floating IP", NameSuggestions: func(c hcapi2.Client) func() []string { return c.FloatingIP().Names }, Fetch: func(s state.State, _ *cobra.Command, idOrName string) (*hcloud.FloatingIP, *hcloud.Response, error) { return s.Client().FloatingIP().Get(s, idOrName) }, GetDefaultIP: func(floatingIP *hcloud.FloatingIP) net.IP { return floatingIP.IP }, }
View Source
var UnassignCmd = base.Cmd{ BaseCobraCommand: func(client hcapi2.Client) *cobra.Command { return &cobra.Command{ Use: "unassign <floating-ip>", Short: "Unassign a Floating IP", ValidArgsFunction: cmpl.SuggestArgs(cmpl.SuggestCandidatesF(client.FloatingIP().Names)), TraverseChildren: true, DisableFlagsInUseLine: true, } }, Run: func(s state.State, cmd *cobra.Command, args []string) error { idOrName := args[0] floatingIP, _, err := s.Client().FloatingIP().Get(s, idOrName) if err != nil { return err } if floatingIP == nil { return fmt.Errorf("Floating IP not found: %v", idOrName) } action, _, err := s.Client().FloatingIP().Unassign(s, floatingIP) if err != nil { return err } if err := s.WaitForActions(s, cmd, action); err != nil { return err } cmd.Printf("Floating IP %d unassigned\n", floatingIP.ID) return nil }, }
View Source
var UpdateCmd = base.UpdateCmd[*hcloud.FloatingIP]{ ResourceNameSingular: "Floating IP", ShortDescription: "Update a Floating IP", NameSuggestions: func(c hcapi2.Client) func() []string { return c.FloatingIP().Names }, Fetch: func(s state.State, _ *cobra.Command, idOrName string) (*hcloud.FloatingIP, *hcloud.Response, error) { return s.Client().FloatingIP().Get(s, idOrName) }, DefineFlags: func(cmd *cobra.Command) { cmd.Flags().String("name", "", "Floating IP name") cmd.Flags().String("description", "", "Floating IP description") }, Update: func(s state.State, _ *cobra.Command, floatingIP *hcloud.FloatingIP, flags map[string]pflag.Value) error { updOpts := hcloud.FloatingIPUpdateOpts{ Name: flags["name"].String(), Description: flags["description"].String(), } _, _, err := s.Client().FloatingIP().Update(s, floatingIP, updOpts) if err != nil { return err } return nil }, }
Functions ¶
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.