peer

Documentation

Overview

Package peer is the client.Network.BgpPeer namespace.

The "pg" param in the function signatures in this page is the peer group name.

Normalized object: Entry

Index

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

Constants

const (
	ReflectorClientNonClient    = "non-client"
	ReflectorClientClient       = "client"
	ReflectorClientMeshedClient = "meshed-client"
)

Valid values for ReflectorClient.

const (
	PeeringTypeBilateral   = "bilateral"
	PeeringTypeUnspecified = "unspecified"
)

Valid values for PeeringType.

const (
	BfdProfileInherit = "Inherit-vr-global-setting"
	BfdProfileNone    = "None"
)

Valid values for BfdProfile, besides an actual BFD profile's name.

const (
	AddressFamilyTypeIpv4 = "ipv4"
	AddressFamilyTypeIpv6 = "ipv6"
)

Valid values for AddressFamilyType.

const MaxPrefixesUnlimited = "unlimited"

Valid non-int value for MaxPrefixes.

Types

type Entry

type Entry struct {
	Name                             string
	Enable                           bool
	PeerAs                           string
	LocalAddressInterface            string
	LocalAddressIp                   string
	PeerAddressIp                    string
	ReflectorClient                  string
	PeeringType                      string
	MaxPrefixes                      string
	AuthProfile                      string
	KeepAliveInterval                int
	MultiHop                         int
	OpenDelayTime                    int
	HoldTime                         int
	IdleHoldTime                     int
	AllowIncomingConnections         bool
	IncomingConnectionsRemotePort    int
	AllowOutgoingConnections         bool
	OutgoingConnectionsLocalPort     int
	BfdProfile                       string // 7.1+
	EnableMpBgp                      bool   // 8.0+
	AddressFamilyType                string // 8.0+
	SubsequentAddressFamilyUnicast   bool   // 8.0+
	SubsequentAddressFamilyMulticast bool   // 8.0+
	EnableSenderSideLoopDetection    bool   // 8.0+
	MinRouteAdvertisementInterval    int    // 8.1+
}

Entry is a normalized, version independent representation of a BGP peer group peer.

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, interface{})

type Firewall

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

Firewall is the client.Network.BgpPeer namespace.

func FirewallNamespace

func FirewallNamespace(client util.XapiClient) *Firewall

FirewallNamespace returns an initialized namespace.

func (*Firewall) Delete

func (c *Firewall) Delete(vr, pg string, 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(vr, pg string, e Entry) error

Edit performs EDIT to configure the specified object.

func (*Firewall) Get

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

Get performs GET to retrieve information for the given object.

func (*Firewall) GetAll

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

GetAll performs GET to retrieve all objects configured.

func (*Firewall) GetList

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

GetList performs GET to retrieve a list of all objects.

func (*Firewall) Set

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

Set performs SET to configure the specified objects.

func (*Firewall) Show

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

Show performs SHOW to retrieve information for the given object.

func (*Firewall) ShowAll

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

ShowAll performs SHOW to retrieve information for all objects.

func (*Firewall) ShowList

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

ShowList performs SHOW to retrieve a list of all objects.

type Panorama

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

Panorama is the client.Network.BgpPeer namespace.

func PanoramaNamespace

func PanoramaNamespace(client util.XapiClient) *Panorama

PanoramaNamespace returns an initialized namespace.

func (*Panorama) Delete

func (c *Panorama) Delete(tmpl, ts, vr, pg 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, vr, pg string, e Entry) error

Edit performs EDIT to configure the specified object.

func (*Panorama) Get

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

Get performs GET to retrieve information for the given object.

func (*Panorama) GetAll

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

GetAll performs GET to retrieve all objects configured.

func (*Panorama) GetList

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

GetList performs GET to retrieve a list of all objects.

func (*Panorama) Set

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

Set performs SET to configure the specified objects.

func (*Panorama) Show

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

Show performs SHOW to retrieve information for the given object.

func (*Panorama) ShowAll

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

ShowAll performs SHOW to retrieve information for all objects.

func (*Panorama) ShowList

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

ShowList performs SHOW to retrieve a list of all objects.