email

Documentation

Overview

Package email is the client.Device.EmailServerProfile namespace.

For Panorama, there are two possibilities: managing this object on Panorama itself or inside of a Template.

To manage objects save on Panorama, leave "tmpl", "ts", and "vsys" params empty.

To manage objects in a template, specify the template name and the vsys (if unspecified, defaults to "shared").

Note: PAN-OS 7.1+

Normalized object: Entry

Index

• 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) AllFromPanosConfig(vsys string) ([]Entry, error)
  • func (c *Firewall) Delete(vsys string, e ...interface{}) error
  • func (c *Firewall) Edit(vsys string, e Entry) error
  • func (c *Firewall) FromPanosConfig(vsys, name string) (Entry, error)
  • func (c *Firewall) Get(vsys, name string) (Entry, error)
  • func (c *Firewall) GetAll(vsys string) ([]Entry, error)
  • func (c *Firewall) GetList(vsys string) ([]string, error)
  • func (c *Firewall) Set(vsys string, e ...Entry) error
  • func (c *Firewall) Show(vsys, name string) (Entry, error)
  • func (c *Firewall) ShowAll(vsys string) ([]Entry, error)
  • func (c *Firewall) ShowList(vsys string) ([]string, error)
• type Panorama
  • func PanoramaNamespace(client util.XapiClient) *Panorama
  • func (c *Panorama) AllFromPanosConfig(tmpl, ts, vsys string) ([]Entry, error)
  • func (c *Panorama) Delete(tmpl, ts, vsys string, e ...interface{}) error
  • func (c *Panorama) Edit(tmpl, ts, vsys string, e Entry) error
  • func (c *Panorama) FromPanosConfig(tmpl, ts, vsys, name string) (Entry, error)
  • func (c *Panorama) Get(tmpl, ts, vsys, name string) (Entry, error)
  • func (c *Panorama) GetAll(tmpl, ts, vsys string) ([]Entry, error)
  • func (c *Panorama) GetList(tmpl, ts, vsys string) ([]string, error)
  • func (c *Panorama) Set(tmpl, ts, vsys string, e ...Entry) error
  • func (c *Panorama) Show(tmpl, ts, vsys, name string) (Entry, error)
  • func (c *Panorama) ShowAll(tmpl, ts, vsys string) ([]Entry, error)
  • func (c *Panorama) ShowList(tmpl, ts, vsys string) ([]string, error)
• type Server

Types

type Entry

type Entry struct {
	Name              string
	Config            string
	System            string
	Threat            string
	Traffic           string
	HipMatch          string
	Url               string // 8.0+
	Data              string // 8.0+
	Wildfire          string // 8.0+
	Tunnel            string // 8.0+
	UserId            string // 8.0+
	Gtp               string // 8.0+
	Auth              string // 8.0+
	Sctp              string // 8.1+
	Iptag             string // 9.0+
	EscapedCharacters string
	EscapeCharacter   string
	Servers           []Server
}

Entry is a normalized, version independent representation of an email profile.

PAN-OS 7.1+.

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.Device.EmailServerProfile namespace.

func FirewallNamespace

func FirewallNamespace(client util.XapiClient) *Firewall

FirewallNamespace returns an initialized namespace.

func (*Firewall) AllFromPanosConfig

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

AllFromPanosConfig retrieves all objects stored in the retrieved config.

func (*Firewall) Delete

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

Edit performs EDIT to configure the specified object.

func (*Firewall) FromPanosConfig

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

FromPanosConfig retrieves the object stored in the retrieved config.

func (*Firewall) Get

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

Get performs GET to retrieve information for the given object.

func (*Firewall) GetAll

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

GetAll performs GET to retrieve all objects configured.

func (*Firewall) GetList

func (c *Firewall) GetList(vsys string) ([]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(vsys, name string) (Entry, error)

Show performs SHOW to retrieve information for the given object.

func (*Firewall) ShowAll

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

ShowAll performs SHOW to retrieve information for all objects.

func (*Firewall) ShowList

func (c *Firewall) ShowList(vsys 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.Device.EmailServerProfile namespace.

func PanoramaNamespace

func PanoramaNamespace(client util.XapiClient) *Panorama

PanoramaNamespace returns an initialized namespace.

func (*Panorama) AllFromPanosConfig

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

AllFromPanosConfig retrieves all objects stored in the retrieved config.

func (*Panorama) Delete

func (c *Panorama) Delete(tmpl, ts, vsys 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) FromPanosConfig

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

FromPanosConfig retrieves the object stored in the retrieved config.

func (*Panorama) Get

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

Get performs GET to retrieve information for the given object.

func (*Panorama) GetAll

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

GetAll performs GET to retrieve all objects configured.

func (*Panorama) GetList

func (c *Panorama) GetList(tmpl, ts, vsys 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, vsys, name string) (Entry, error)

Show performs SHOW to retrieve information for the given object.

func (*Panorama) ShowAll

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

ShowAll performs SHOW to retrieve information for all objects.

func (*Panorama) ShowList

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

ShowList performs SHOW to retrieve a list of all objects.

type Server

type Server struct {
	Name         string
	DisplayName  string
	From         string
	To           string
	AlsoTo       string
	EmailGateway string
}

Server is an email server.