vlan

Documentation

Overview

Package vlan is the client.Network.Vlan namespace.

Normalized object: Entry

Index

• type Entry
  • func (o *Entry) Copy(s Entry, copyMacs bool)
• type FwVlan
  • func (c *FwVlan) Delete(e ...interface{}) error
  • func (c *FwVlan) DeleteInterface(vlan interface{}, iface string) error
  • func (c *FwVlan) Edit(vsys string, e Entry) error
  • func (c *FwVlan) Get(name string) (Entry, error)
  • func (c *FwVlan) GetList() ([]string, error)
  • func (c *FwVlan) Initialize(con util.XapiClient)
  • func (c *FwVlan) Set(vsys string, e ...Entry) error
  • func (c *FwVlan) SetInterface(vlan interface{}, iface string, rmMacs, addMacs []string) error
  • func (c *FwVlan) Show(name string) (Entry, error)
  • func (c *FwVlan) ShowList() ([]string, error)
• type PanoVlan
  • func (c *PanoVlan) Delete(tmpl, ts string, e ...interface{}) error
  • func (c *PanoVlan) DeleteInterface(tmpl, ts string, vlan interface{}, iface string) error
  • func (c *PanoVlan) Edit(tmpl, ts, vsys string, e Entry) error
  • func (c *PanoVlan) Get(tmpl, ts, name string) (Entry, error)
  • func (c *PanoVlan) GetList(tmpl, ts string) ([]string, error)
  • func (c *PanoVlan) Initialize(con util.XapiClient)
  • func (c *PanoVlan) Set(tmpl, ts, vsys string, e ...Entry) error
  • func (c *PanoVlan) SetInterface(tmpl, ts string, vlan interface{}, iface string, rmMacs, addMacs []string) error
  • func (c *PanoVlan) Show(tmpl, ts, name string) (Entry, error)
  • func (c *PanoVlan) ShowList(tmpl, ts string) ([]string, error)

Types

type Entry

type Entry struct {
	Name          string
	VlanInterface string
	Interfaces    []string // unordered
	StaticMacs    map[string]string
}

Entry is a normalized, version independent representation of a VLAN.

Static MAC addresses are given as a map[string] string, where the key is the MAC address and the value is the interface it should be associated with.

func (*Entry) Copy

func (o *Entry) Copy(s Entry, copyMacs bool)

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 FwVlan

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

FwVlan is the client.Network.Vlan namespace.

func (*FwVlan) Delete

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

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

VLANs can be a string or an Entry object.

func (*FwVlan) DeleteInterface

func (c *FwVlan) DeleteInterface(vlan interface{}, iface string) error

DeleteInterface performs a DELETE to remove an interface from a VLAN.

The VLAN can be either a string or an Entry object.

All MAC addresses referencing this interface are deleted.

func (*FwVlan) Edit

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

Edit performs EDIT to create / update a VLAN.

Specify a non-empty vsys to import the VLAN into the given vsys after creating, allowing the vsys to use it.

func (*FwVlan) Get

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

Get performs GET to retrieve information for the given VLAN.

func (*FwVlan) GetList

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

GetList performs GET to retrieve a list of VLANs.

func (*FwVlan) Initialize

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

Initialize is invoked by client.Initialize().

func (*FwVlan) Set

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

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

Specify a non-empty vsys to import the VLAN(s) into the given vsys after creating, allowing the vsys to use them.

func (*FwVlan) SetInterface

func (c *FwVlan) SetInterface(vlan interface{}, iface string, rmMacs, addMacs []string) error

SetInterface performs a SET to add an interface to a VLAN.

The VLAN can be either a string or an Entry object. The iface variable is the interface. The rmMacs and addMacs params are MAC addresses to remove/add that will reference the iface interface.

func (*FwVlan) Show

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

Show performs SHOW to retrieve information for the given VLAN.

func (*FwVlan) ShowList

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

ShowList performs SHOW to retrieve a list of VLANs.

type PanoVlan

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

PanoVlan is the client.Network.Vlan namespace.

func (*PanoVlan) Delete

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

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

VLANs can be a string or an Entry object.

func (*PanoVlan) DeleteInterface

func (c *PanoVlan) DeleteInterface(tmpl, ts string, vlan interface{}, iface string) error

DeleteInterface performs a DELETE to remove an interface from a VLAN.

The VLAN can be either a string or an Entry object.

All MAC addresses referencing this interface are deleted.

func (*PanoVlan) Edit

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

Edit performs EDIT to create / update a VLAN.

Specify a non-empty vsys to import the VLAN into the given vsys after creating, allowing the vsys to use it.

func (*PanoVlan) Get

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

Get performs GET to retrieve information for the given VLAN.

func (*PanoVlan) GetList

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

GetList performs GET to retrieve a list of VLANs.

func (*PanoVlan) Initialize

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

Initialize is invoked by client.Initialize().

func (*PanoVlan) Set

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

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

Specify a non-empty vsys to import the VLAN(s) into the given vsys after creating, allowing the vsys to use them.

func (*PanoVlan) SetInterface

func (c *PanoVlan) SetInterface(tmpl, ts string, vlan interface{}, iface string, rmMacs, addMacs []string) error

SetInterface performs a SET to add an interface to a VLAN.

The VLAN can be either a string or an Entry object. The iface variable is the interface. The rmMacs and addMacs params are MAC addresses to remove/add that will reference the iface interface.

func (*PanoVlan) Show

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

Show performs SHOW to retrieve information for the given VLAN.

func (*PanoVlan) ShowList

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

ShowList performs SHOW to retrieve a list of VLANs.