eth

Documentation

Overview

Package eth is the client.Network.EthernetInterface namespace.

Normalized object: Entry

Index

• type Entry
  • func (o *Entry) Copy(s Entry)
• type FwEth
  • func (c *FwEth) Delete(e ...interface{}) error
  • func (c *FwEth) Edit(vsys string, e Entry) error
  • func (c *FwEth) Get(name string) (Entry, error)
  • func (c *FwEth) GetList() ([]string, error)
  • func (c *FwEth) Initialize(con util.XapiClient)
  • func (c *FwEth) Set(vsys string, e ...Entry) error
  • func (c *FwEth) Show(name string) (Entry, error)
  • func (c *FwEth) ShowList() ([]string, error)
• type PanoEth
  • func (c *PanoEth) Delete(tmpl, ts string, e ...interface{}) error
  • func (c *PanoEth) Edit(tmpl, ts, vsys string, e Entry) error
  • func (c *PanoEth) Get(tmpl, ts, name string) (Entry, error)
  • func (c *PanoEth) GetList(tmpl, ts string) ([]string, error)
  • func (c *PanoEth) Initialize(con util.XapiClient)
  • func (c *PanoEth) Set(tmpl, ts, vsys string, e ...Entry) error
  • func (c *PanoEth) Show(tmpl, ts, name string) (Entry, error)
  • func (c *PanoEth) ShowList(tmpl, ts string) ([]string, error)

Types

type Entry

type Entry struct {
	Name                       string
	Mode                       string
	StaticIps                  []string // ordered
	EnableDhcp                 bool
	CreateDhcpDefaultRoute     bool
	DhcpDefaultRouteMetric     int
	Ipv6Enabled                bool
	Ipv6InterfaceId            string
	ManagementProfile          string
	Mtu                        int
	AdjustTcpMss               bool
	NetflowProfile             string
	LldpEnabled                bool
	LldpProfile                string
	LinkSpeed                  string
	LinkDuplex                 string
	LinkState                  string
	AggregateGroup             string
	Comment                    string
	Ipv4MssAdjust              int    // 7.1+
	Ipv6MssAdjust              int    // 7.1+
	EnableUntaggedSubinterface bool   // 7.1+
	DecryptForward             bool   // 8.1+
	RxPolicingRate             int    // 8.1+
	TxPolicingRate             int    // 8.1+
	DhcpSendHostnameEnable     bool   // 9.0+
	DhcpSendHostnameValue      string // 9.0+
	// contains filtered or unexported fields
}

Entry is a normalized, version independent representation of an ethernet interface.

func (*Entry) Copy

func (o *Entry) Copy(s Entry)

Copy copies the information from source Entry `s` to this object. As the Name field relates to the XPATH of this object, this field is not copied.

type FwEth

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

FwEth is the client.Network.EthernetInterface namespace.

func (*FwEth) Delete

func (c *FwEth) Delete(e ...interface{}) error

Delete removes the given interface(s) from the firewall.

Interfaces can be a string or an Entry object.

func (*FwEth) Edit

func (c *FwEth) Edit(vsys string, e Entry) error

Edit performs EDIT to create / update the specified ethernet interface.

Specifying a non-empty vsys will import the interface into that vsys, allowing the vsys to use it, as long as the interface does not have a mode of "ha" or "aggregate-group". Interfaces that have either of those modes are omitted from this function's followup vsys import.

func (*FwEth) Get

func (c *FwEth) Get(name string) (Entry, error)

Get performs GET to retrieve information for the given ethernet interface.

func (*FwEth) GetList

func (c *FwEth) GetList() ([]string, error)

GetList performs GET to retrieve a list of ethernet interfaces.

func (*FwEth) Initialize

func (c *FwEth) Initialize(con util.XapiClient)

Initialize is invoked by client.Initialize().

func (*FwEth) Set

func (c *FwEth) Set(vsys string, e ...Entry) error

Set performs SET to create / update one or more ethernet interfaces.

Specifying a non-empty vsys will import the interfaces into that vsys, allowing the vsys to use them, as long as the interface does not have a mode of "ha" or "aggregate-group". Interfaces that have either of those modes are omitted from this function's followup vsys import.

func (*FwEth) Show

func (c *FwEth) Show(name string) (Entry, error)

Show performs SHOW to retrieve information for the given ethernet interface.

func (*FwEth) ShowList

func (c *FwEth) ShowList() ([]string, error)

ShowList performs SHOW to retrieve a list of ethernet interfaces.

type PanoEth

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

PanoEth is the client.Network.EthernetInterface namespace.

func (*PanoEth) Delete

func (c *PanoEth) Delete(tmpl, ts string, e ...interface{}) error

Delete removes the given interface(s) from the firewall.

Interfaces can be a string or an Entry object.

func (*PanoEth) Edit

func (c *PanoEth) Edit(tmpl, ts, vsys string, e Entry) error

Edit performs EDIT to create / update the specified ethernet interface.

Specifying a non-empty vsys will import the interface into that vsys, allowing the vsys to use it, as long as the interface does not have a mode of "ha" or "aggregate-group". Interfaces that have either of those modes are omitted from this function's followup vsys import.

func (*PanoEth) Get

func (c *PanoEth) Get(tmpl, ts, name string) (Entry, error)

Get performs GET to retrieve information for the given ethernet interface.

func (*PanoEth) GetList

func (c *PanoEth) GetList(tmpl, ts string) ([]string, error)

GetList performs GET to retrieve a list of ethernet interfaces.

func (*PanoEth) Initialize

func (c *PanoEth) Initialize(con util.XapiClient)

Initialize is invoked by client.Initialize().

func (*PanoEth) Set

func (c *PanoEth) Set(tmpl, ts, vsys string, e ...Entry) error

Set performs SET to create / update one or more ethernet interfaces.

Specifying a non-empty vsys will import the interfaces into that vsys, allowing the vsys to use them, as long as the interface does not have a mode of "ha" or "aggregate-group". Interfaces that have either of those modes are omitted from this function's followup vsys import.

func (*PanoEth) Show

func (c *PanoEth) Show(tmpl, ts, name string) (Entry, error)

Show performs SHOW to retrieve information for the given ethernet interface.

func (*PanoEth) ShowList

func (c *PanoEth) ShowList(tmpl, ts string) ([]string, error)

ShowList performs SHOW to retrieve a list of ethernet interfaces.