userid

Documentation

Overview

Package userid is the client.UserId namespace, for interacting with the User-ID API. This includes login/logout of a user, user/group mappings, and dynamic address group tags.

Various features of User-ID API are supported across all versions of PANOS for the firewall, but User-ID API for Panorama was only added to PANOS version 8.0.

Index

• type UserId
  • func (c *UserId) Initialize(i util.XapiClient)
  • func (c *UserId) Registered(ip, tag, vsys string) (map[string][]string, error)
  • func (c *UserId) Run(logins, logouts map[string]string, reg, unreg map[string][]string, vsys string) error

Types

type UserId

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

UserId is the client.UserId namespace.

func (*UserId) Initialize

func (c *UserId) Initialize(i util.XapiClient)

Initialize is invoked on client.Initialize().

func (*UserId) Registered

func (c *UserId) Registered(ip, tag, vsys string) (map[string][]string, error)

Registered returns the registered IP address / tags for the given vsys.

Both the ip and tag params are server-side filters.

The vsys param is which vsys these operations should take place in. If vsys is an empty string, vsys defaults to "vsys1".

func (*UserId) Run

func (c *UserId) Run(logins, logouts map[string]string, reg, unreg map[string][]string, vsys string) error

Run executes the given User-Id related operations. This allows you to perform the following User-Id operations:

• login users
• logout users
• register ip/tags
• unregister ip/tags

Both logins and logouts are maps where the username is the key and the IP address is the value.

Both reg and unreg are maps where the IP address is the key and the list of tags are the values.

The vsys param is which vsys these operations should take place in. If vsys is an empty string, vsys defaults to "vsys1".