esxcli

Documentation

Overview

Copyright (c) 2014-2023 VMware, Inc. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• type Command
  • func NewCommand(args []string) *Command
  • func (c *Command) Argument(name string, args ...string) internal.ReflectManagedMethodExecuterSoapArgument
  • func (c *Command) Method() string
  • func (c *Command) Moid() string
  • func (c *Command) Name() string
  • func (c *Command) Namespace() string
  • func (c *Command) Parse(params []CommandInfoParam) ([]internal.ReflectManagedMethodExecuterSoapArgument, error)
• type CommandInfo
• type CommandInfoHint
• type CommandInfoHints
  • func (h CommandInfoHints) Fields() []string
  • func (h CommandInfoHints) Formatter() string
• type CommandInfoItem
• type CommandInfoMethod
• type CommandInfoParam
• type Executor
  • func NewExecutor(c *vim25.Client, host *object.HostSystem) (*Executor, error)
  • func (e *Executor) CommandInfo(c *Command) (*CommandInfoMethod, error)
  • func (e *Executor) Execute(req *internal.ExecuteSoapRequest, res interface{}) error
  • func (e *Executor) NewRequest(args []string) (*internal.ExecuteSoapRequest, *CommandInfoMethod, error)
  • func (e *Executor) Run(args []string) (*Response, error)
• type Fault
  • func (f Fault) Error() string
• type FirewallInfo
  • func GetFirewallInfo(s *object.HostSystem) (*FirewallInfo, error)
• type GuestInfo
  • func NewGuestInfo(c *vim25.Client) *GuestInfo
  • func (g *GuestInfo) IpAddress(vm *object.VirtualMachine) (string, error)
• type Response
  • func (r *Response) Type(start xml.StartElement) string
  • func (r *Response) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error
• type Values
  • func (v Values) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

Types

type Command

type Command struct {
	// contains filtered or unexported fields
}

func NewCommand

func NewCommand(args []string) *Command

func (*Command) Argument

func (c *Command) Argument(name string, args ...string) internal.ReflectManagedMethodExecuterSoapArgument

func (*Command) Method

func (c *Command) Method() string

func (*Command) Moid

func (c *Command) Moid() string

func (*Command) Name

func (c *Command) Name() string

func (*Command) Namespace

func (c *Command) Namespace() string

func (*Command) Parse

func (c *Command) Parse(params []CommandInfoParam) ([]internal.ReflectManagedMethodExecuterSoapArgument, error)

Parse generates a flag.FlagSet based on the given []CommandInfoParam and returns arguments for use with methods.ExecuteSoap

type CommandInfo

type CommandInfo struct {
	CommandInfoItem
	Method []*CommandInfoMethod `xml:"method" json:"method"`
}

type CommandInfoHint

type CommandInfoHint struct {
	Key   string `xml:"key" json:"key"`
	Value string `xml:"value" json:"value"`
}

type CommandInfoHints

type CommandInfoHints []CommandInfoHint

func (CommandInfoHints) Fields

func (h CommandInfoHints) Fields() []string

func (CommandInfoHints) Formatter

func (h CommandInfoHints) Formatter() string

type CommandInfoItem

type CommandInfoItem struct {
	Name        string `xml:"name" json:"name"`
	DisplayName string `xml:"displayName" json:"displayName"`
	Help        string `xml:"help" json:"help"`
}

type CommandInfoMethod

type CommandInfoMethod struct {
	CommandInfoItem
	Param []CommandInfoParam `xml:"param" json:"param"`
	Hints CommandInfoHints   `xml:"hints" json:"hints"`
}

type CommandInfoParam

type CommandInfoParam struct {
	CommandInfoItem
	Aliases []string `xml:"aliases" json:"aliases"`
	Flag    bool     `xml:"flag" json:"flag"`
}

type Executor

type Executor struct {
	// contains filtered or unexported fields
}

func NewExecutor

func NewExecutor(c *vim25.Client, host *object.HostSystem) (*Executor, error)

func (*Executor) CommandInfo

func (e *Executor) CommandInfo(c *Command) (*CommandInfoMethod, error)

func (*Executor) Execute

func (e *Executor) Execute(req *internal.ExecuteSoapRequest, res interface{}) error

func (*Executor) NewRequest

func (e *Executor) NewRequest(args []string) (*internal.ExecuteSoapRequest, *CommandInfoMethod, error)

func (*Executor) Run

func (e *Executor) Run(args []string) (*Response, error)

type Fault

type Fault struct {
	Message string `json:"message"`
	Detail  string `json:"detail"`
}

func (Fault) Error

func (f Fault) Error() string

type FirewallInfo

type FirewallInfo struct {
	Loaded        bool   `json:"loaded"`
	Enabled       bool   `json:"enabled"`
	DefaultAction string `json:"defaultAction"`
}

func GetFirewallInfo

func GetFirewallInfo(s *object.HostSystem) (*FirewallInfo, error)

GetFirewallInfo via 'esxcli network firewall get' The HostFirewallSystem type does not expose this data. This helper can be useful in particular to determine if the firewall is enabled or disabled.

type GuestInfo

type GuestInfo struct {
	// contains filtered or unexported fields
}

func NewGuestInfo

func NewGuestInfo(c *vim25.Client) *GuestInfo

func (*GuestInfo) IpAddress

func (g *GuestInfo) IpAddress(vm *object.VirtualMachine) (string, error)

IpAddress attempts to find the guest IP address using esxcli. ESX hosts must be configured with the /Net/GuestIPHack enabled. For example: $ govc host.esxcli -- system settings advanced set -o /Net/GuestIPHack -i 1

type Response

type Response struct {
	Info   *CommandInfoMethod `json:"info"`
	Values []Values           `json:"values"`
	String string             `json:"string"`
}

func (*Response) Type

func (r *Response) Type(start xml.StartElement) string

func (*Response) UnmarshalXML

func (r *Response) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

type Values

type Values map[string][]string

func (Values) UnmarshalXML

func (v Values) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error