router

Documentation

Overview

Package router is the client.Network.VirtualRouter namespace.

Virtual routers can be imported into a vsys.

Normalized object: Entry

Index

• Constants
• type Entry
  • func (o *Entry) Copy(s Entry)
  • func (o *Entry) Defaults()
  • 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) CleanupDefault() error
  • func (c *Firewall) Delete(e ...interface{}) error
  • func (c *Firewall) DeleteInterface(vr interface{}, iface string) 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) SetInterface(vr interface{}, iface string) 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) CleanupDefault(tmpl, ts string) error
  • func (c *Panorama) Delete(tmpl, ts string, e ...interface{}) error
  • func (c *Panorama) DeleteInterface(tmpl, ts string, vr interface{}, iface string) error
  • func (c *Panorama) Edit(tmpl, ts, vsys string, e Entry) error
  • func (c *Panorama) FromPanosConfig(tmpl, ts, name string) (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) SetInterface(tmpl, ts string, vr interface{}, iface string) 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 (
	EcmpLoadBalanceMethodIpModulo           = "ip-modulo"
	EcmpLoadBalanceMethodIpHash             = "ip-hash"
	EcmpLoadBalanceMethodWeightedRoundRobin = "weighted-round-robin"
	EcmpLoadBalanceMethodBalancedRoundRobin = "balanced-round-robin"
)

Valid values for EcmpLoadBalanceMethod.

Types

type Entry

type Entry struct {
	Name                             string
	Interfaces                       []string
	StaticDist                       int
	StaticIpv6Dist                   int
	OspfIntDist                      int
	OspfExtDist                      int
	Ospfv3IntDist                    int
	Ospfv3ExtDist                    int
	IbgpDist                         int
	EbgpDist                         int
	RipDist                          int
	EnableEcmp                       bool
	EcmpSymmetricReturn              bool
	EcmpStrictSourcePath             bool
	EcmpMaxPath                      int
	EcmpLoadBalanceMethod            string
	EcmpHashSourceOnly               bool
	EcmpHashUsePort                  bool
	EcmpHashSeed                     int
	EcmpWeightedRoundRobinInterfaces map[string]int
	// contains filtered or unexported fields
}

Entry is a normalized, version independent representation of a virtual router.

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) Defaults

func (o *Entry) Defaults()

Defaults sets params with uninitialized values to their GUI default setting.

The defaults are as follows:

• StaticDist: 10
• StaticIpv6Dist: 10
• OspfIntDist: 30
• OspfExtDist: 110
• Ospfv3IntDist: 30
• Ospfv3ExtDist: 110
• IbgpDist: 200
• EbgpDist: 20
• RipDist: 120

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.VirtualRouter 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) CleanupDefault

func (c *Firewall) CleanupDefault() error

CleanupDefault clears the `default` route configuration instead of deleting it outright. This involves unimporting the route "default" from the given vsys, then performing an `EDIT` with an empty router.Entry object.

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) DeleteInterface

func (c *Firewall) DeleteInterface(vr interface{}, iface string) error

DeleteInterface performs a DELETE to remove an interface from a virtual router.

The virtual router 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) SetInterface

func (c *Firewall) SetInterface(vr interface{}, iface string) error

SetInterface performs a SET to add an interface to a virtual router.

The virtual router can be either a string or an Entry object.

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.VirtualRouter 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) CleanupDefault

func (c *Panorama) CleanupDefault(tmpl, ts string) error

CleanupDefault clears the `default` route configuration instead of deleting it outright. This involves unimporting the route "default" from the given vsys, then performing an `EDIT` with an empty router.Entry object.

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) DeleteInterface

func (c *Panorama) DeleteInterface(tmpl, ts string, vr interface{}, iface string) error

DeleteInterface performs a DELETE to remove an interface from a virtual router.

The virtual router 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) FromPanosConfig

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

FromPanosConfig retrieves the object stored in the retrieved config.

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) SetInterface

func (c *Panorama) SetInterface(tmpl, ts string, vr interface{}, iface string) error

SetInterface performs a SET to add an interface to a virtual router.

The virtual router can be either a string or an Entry object.

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.