eth

Documentation

Overview

Package eth is the client.Network.EthernetInterface namespace.

The Set() and Edit() functions in these namespaces takes a vsys parameter. These functions do not force you to specify a vsys to import the interface into, however it should be noted that interfaces must be imported into a vsys in order for PAN-OS to be able to use that interface.

Interfaces with a Mode of "ha" or "aggregate-group" will not be imported, as is proper for these types of interfaces.

Normalized object: Entry

Index

• Constants
• type Entry
  • func (o *Entry) Copy(s Entry)
  • func (o Entry) Specify(v version.Number) (string, string, interface{})
• type Firewall
  • func FirewallNamespace(client util.XapiClient) *Firewall
  • func (c *Firewall) AllFromPanosConfig() ([]Entry, error)
  • func (c *Firewall) Delete(e ...interface{}) error
  • func (c *Firewall) Edit(vsys string, e Entry) error
  • func (c *Firewall) FromPanosConfig(name string) (Entry, error)
  • func (c *Firewall) Get(name string) (Entry, error)
  • func (c *Firewall) GetAll() ([]Entry, error)
  • func (c *Firewall) GetList() ([]string, error)
  • func (c *Firewall) Set(vsys string, e ...Entry) error
  • func (c *Firewall) Show(name string) (Entry, error)
  • func (c *Firewall) ShowAll() ([]Entry, error)
  • func (c *Firewall) ShowList() ([]string, error)
• type Panorama
  • func PanoramaNamespace(client util.XapiClient) *Panorama
  • func (c *Panorama) AllFromPanosConfig(tmpl, ts string) ([]Entry, error)
  • func (c *Panorama) Delete(tmpl, ts string, e ...interface{}) error
  • func (c *Panorama) Edit(tmpl, ts, vsys string, e Entry) error
  • func (c *Panorama) Get(tmpl, ts, name string) (Entry, error)
  • func (c *Panorama) GetAll(tmpl, ts string) ([]Entry, error)
  • func (c *Panorama) GetList(tmpl, ts string) ([]string, error)
  • func (c *Panorama) Set(tmpl, ts, vsys string, e ...Entry) error
  • func (c *Panorama) Show(tmpl, ts, name string) (Entry, error)
  • func (c *Panorama) ShowAll(tmpl, ts string) ([]Entry, error)
  • func (c *Panorama) ShowList(tmpl, ts string) ([]string, error)

Constants

const (
	ModeLayer3         = "layer3"
	ModeLayer2         = "layer2"
	ModeVirtualWire    = "virtual-wire"
	ModeTap            = "tap"
	ModeHa             = "ha"
	ModeDecryptMirror  = "decrypt-mirror"
	ModeAggregateGroup = "aggregate-group"
)

These are valid values for the Mode parameter.

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
	LldpHaPassivePreNegotiation bool
	LacpHaPassivePreNegotiation bool
	LinkSpeed                   string
	LinkDuplex                  string
	LinkState                   string
	AggregateGroup              string
	Comment                     string
	LacpPortPriority            int
	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.

func (Entry) Specify

func (o Entry) Specify(v version.Number) (string, string, interface{})

type Firewall

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

Firewall is the client.Network.EthernetInterface namespace.

func FirewallNamespace

func FirewallNamespace(client util.XapiClient) *Firewall

FirewallNamespace returns an initialized namespace.

func (*Firewall) AllFromPanosConfig

func (c *Firewall) AllFromPanosConfig() ([]Entry, error)

AllFromPanosConfig retrieves all objects stored in the retrieved config.

func (*Firewall) Delete

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

Delete performs DELETE to remove the specified objects.

Objects can be either a string or an Entry object.

func (*Firewall) Edit

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

Edit performs EDIT to configure the specified object.

func (*Firewall) FromPanosConfig

func (c *Firewall) FromPanosConfig(name string) (Entry, error)

FromPanosConfig retrieves the object stored in the retrieved config.

func (*Firewall) Get

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

Get performs GET to retrieve configuration for the given object.

func (*Firewall) GetAll

func (c *Firewall) GetAll() ([]Entry, error)

GetAll performs GET to retrieve all objects configured.

func (*Firewall) GetList

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

GetList performs GET to retrieve a list of all objects.

func (*Firewall) Set

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

Set performs SET to configure the specified objects.

func (*Firewall) Show

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

Show performs SHOW to retrieve configuration for the given object.

func (*Firewall) ShowAll

func (c *Firewall) ShowAll() ([]Entry, error)

ShowAll performs SHOW to retrieve all objects configured.

func (*Firewall) ShowList

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

ShowList performs a SHOW to retrieve a list of all objects.

type Panorama

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

Panorama is the client.Network.EthernetInterface namespace.

func PanoramaNamespace

func PanoramaNamespace(client util.XapiClient) *Panorama

PanoramaNamespace returns an initialized namespace.

func (*Panorama) AllFromPanosConfig

func (c *Panorama) AllFromPanosConfig(tmpl, ts string) ([]Entry, error)

AllFromPanosConfig retrieves all objects stored in the retrieved config.

func (*Panorama) Delete

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

Delete performs DELETE to remove the specified objects.

Objects can be either a string or an Entry object.

func (*Panorama) Edit

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

Edit performs EDIT to configure the specified object.

func (*Panorama) Get

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

Get performs GET to retrieve configuration for the given object.

func (*Panorama) GetAll

func (c *Panorama) GetAll(tmpl, ts string) ([]Entry, error)

GetAll performs GET to retrieve all objects configured.

func (*Panorama) GetList

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

GetList performs GET to retrieve a list of all objects.

func (*Panorama) Set

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

Set performs SET to configure the specified objects.

func (*Panorama) Show

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

Show performs SHOW to retrieve configuration for the given object.

func (*Panorama) ShowAll

func (c *Panorama) ShowAll(tmpl, ts string) ([]Entry, error)

ShowAll performs SHOW to retrieve all objects configured.

func (*Panorama) ShowList

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

ShowList performs a SHOW to retrieve a list of all objects.