pbf

Documentation

Overview

Package pbf is the client.Policies.PolicyBasedForwarding namespace.

Normalized object: Entry

Index

• Constants
• type Entry
  • func (o *Entry) Copy(s Entry)
• type FwPbf
  • func (c *FwPbf) Delete(vsys string, e ...interface{}) error
  • func (c *FwPbf) Edit(vsys string, e Entry) error
  • func (c *FwPbf) Get(vsys, name string) (Entry, error)
  • func (c *FwPbf) GetList(vsys string) ([]string, error)
  • func (c *FwPbf) Initialize(con util.XapiClient)
  • func (c *FwPbf) MoveGroup(vsys string, mvt int, rule string, e ...Entry) error
  • func (c *FwPbf) Set(vsys string, e ...Entry) error
  • func (c *FwPbf) Show(vsys, name string) (Entry, error)
  • func (c *FwPbf) ShowList(vsys string) ([]string, error)
• type PanoPbf
  • func (c *PanoPbf) Delete(dg, base string, e ...interface{}) error
  • func (c *PanoPbf) Edit(dg, base string, e Entry) error
  • func (c *PanoPbf) Get(dg, base, name string) (Entry, error)
  • func (c *PanoPbf) GetList(dg, base string) ([]string, error)
  • func (c *PanoPbf) Initialize(con util.XapiClient)
  • func (c *PanoPbf) MoveGroup(dg, base string, mvt int, rule string, e ...Entry) error
  • func (c *PanoPbf) Set(dg, base string, e ...Entry) error
  • func (c *PanoPbf) Show(dg, base, name string) (Entry, error)
  • func (c *PanoPbf) ShowList(dg, base string) ([]string, error)

Constants

const (
	FromTypeZone      = "zone"
	FromTypeInterface = "interface"
)

Valid FromType values.

const (
	ForwardNextHopTypeIpAddress = "ip-address"
	ForwardNextHopTypeFqdn      = "fqdn"
)

Valid ForwardNextHopType values.

const (
	ActionForward     = "forward"
	ActionVsysForward = "forward-to-vsys"
	ActionDiscard     = "discard"
	ActionNoPbf       = "no-pbf"
)

Valid Action values.

Types

type Entry

type Entry struct {
	Name                               string
	Description                        string
	Tags                               []string // ordered
	FromType                           string
	FromValues                         []string // unordered
	SourceAddresses                    []string // unordered
	SourceUsers                        []string // unordered
	NegateSource                       bool
	DestinationAddresses               []string // unordered
	NegateDestination                  bool
	Applications                       []string // unordered
	Services                           []string // unordered
	Schedule                           string
	Disabled                           bool
	Action                             string
	ForwardVsys                        string
	ForwardEgressInterface             string
	ForwardNextHopType                 string
	ForwardNextHopValue                string
	ForwardMonitorProfile              string
	ForwardMonitorIpAddress            string
	ForwardMonitorDisableIfUnreachable bool
	EnableEnforceSymmetricReturn       bool
	SymmetricReturnAddresses           []string // ordered
	ActiveActiveDeviceBinding          string
	Targets                            map[string][]string
	NegateTarget                       bool
	Uuid                               string // 9.0+
}

Entry is a normalized, version independent representation of a policy based forwarding rule.

Targets is a map where the key is the serial number of the target device and the value is a list of specific vsys on that device. The list of vsys is nil if all vsys on that device should be included or if the device is a virtual firewall (and thus only has vsys1).

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 FwPbf

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

FwPbf is the client.Policies.PolicyBasedForwarding namespace.

func (*FwPbf) Delete

func (c *FwPbf) Delete(vsys string, e ...interface{}) error

Delete removes the given objects.

Objects can be a string or an Entry object.

func (*FwPbf) Edit

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

Edit performs EDIT to create / update one object.

func (*FwPbf) Get

func (c *FwPbf) Get(vsys, name string) (Entry, error)

Get performs GET to retrieve information for the given uid.

func (*FwPbf) GetList

func (c *FwPbf) GetList(vsys string) ([]string, error)

GetList performs GET to retrieve a list of values.

func (*FwPbf) Initialize

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

Initialize is invoked by client.Initialize().

func (*FwPbf) MoveGroup

func (c *FwPbf) MoveGroup(vsys string, mvt int, rule string, e ...Entry) error

MoveGroup moves a logical group of policy based forwarding rules somewhere in relation to another rule.

func (*FwPbf) Set

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

Set performs SET to create / update one or more objects.

func (*FwPbf) Show

func (c *FwPbf) Show(vsys, name string) (Entry, error)

Show performs SHOW to retrieve information for the given uid.

func (*FwPbf) ShowList

func (c *FwPbf) ShowList(vsys string) ([]string, error)

ShowList performs SHOW to retrieve a list of values.

type PanoPbf

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

PanoPbf is the client.Policies.PolicyBasedForwarding namespace.

func (*PanoPbf) Delete

func (c *PanoPbf) Delete(dg, base string, e ...interface{}) error

Delete removes the given objects.

Objects can be a string or an Entry object.

func (*PanoPbf) Edit

func (c *PanoPbf) Edit(dg, base string, e Entry) error

Edit performs EDIT to create / update one object.

func (*PanoPbf) Get

func (c *PanoPbf) Get(dg, base, name string) (Entry, error)

Get performs GET to retrieve information for the given uid.

func (*PanoPbf) GetList

func (c *PanoPbf) GetList(dg, base string) ([]string, error)

GetList performs GET to retrieve a list of values.

func (*PanoPbf) Initialize

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

Initialize is invoked by client.Initialize().

func (*PanoPbf) MoveGroup

func (c *PanoPbf) MoveGroup(dg, base string, mvt int, rule string, e ...Entry) error

MoveGroup moves a logical group of policy based forwarding rules somewhere in relation to another rule.

func (*PanoPbf) Set

func (c *PanoPbf) Set(dg, base string, e ...Entry) error

Set performs SET to create / update one or more objects.

func (*PanoPbf) Show

func (c *PanoPbf) Show(dg, base, name string) (Entry, error)

Show performs SHOW to retrieve information for the given uid.

func (*PanoPbf) ShowList

func (c *PanoPbf) ShowList(dg, base string) ([]string, error)

ShowList performs SHOW to retrieve a list of values.