devices

package
v2.61.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 14, 2024 License: MIT Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetWebProbes added in v2.61.0 

func GetWebProbes(service *services.Service, deviceID, appID, probeID int, filters common.GetFromToFilters) ([]common.Metric, *http.Response, error)

Gets the Web Probe metrics trend on a device for an application. For Web Probes, you can access Page Fetch Time, Server Response Time, DNS Time, or Availability. If not specified, it defaults to Page Fetch Time (PFT). If the time range is not specified, the endpoint defaults to the last 2 hours.

Types

type App 

type App struct {
	ID    int     `json:"id,omitempty"`
	Name  string  `json:"name,omitempty"`
	Score float32 `json:"score,omitempty"`
}

func GetDeviceAllApps added in v2.61.0 

func GetDeviceAllApps(service *services.Service, deviceID string, filters common.GetFromToFilters) ([]App, *http.Response, error)

Gets the list all active applications for a device. The endpoint gets the ZDX score each application. If the time range is not specified, the endpoint defaults to the last 2 hours.

func GetDeviceApp added in v2.61.0 

func GetDeviceApp(service *services.Service, deviceID, appID string, filters common.GetFromToFilters) (*App, *http.Response, error)

Gets the application's ZDX score trend for a device. If the time range is not specified, the endpoint defaults to the last 2 hours.

type AverageLatency 

type AverageLatency struct {
	LegSRC  string  `json:"leg_src,omitempty"`
	LegDst  string  `json:"leg_dst,omitempty"`
	Latency float32 `json:"latency,omitempty"`
}

type CallQualityMetrics 

type CallQualityMetrics struct {
	MeetID        string          `json:"meet_id,omitempty"`
	MeetSessionID string          `json:"meet_session_id,omitempty"`
	MeetSubject   string          `json:"meet_subject,omitempty"`
	Metrics       []common.Metric `json:"metrics,omitempty"`
}

func GetQualityMetrics added in v2.61.0 

func GetQualityMetrics(service *services.Service, deviceID, appID int, filters common.GetFromToFilters) ([]CallQualityMetrics, *http.Response, error)

Gets the Call Quality metric trend for a device for a CQM application. If the time range is not specified, the endpoint defaults to the last 2 hours.

type Children added in v2.61.0 

type Children struct {
	ID          string `json:"id"`
	Description string `json:"description,omitempty"`
	GeoType     string `json:"geo_type,omitempty"`
}

type CloudPath 

type CloudPath struct {
	SRC           string  `json:"src,omitempty"`
	DST           string  `json:"dst,omitempty"`
	NumHops       int     `json:"num_hops,omitempty"`
	Latency       float32 `json:"latency,omitempty"`
	Loss          float32 `json:"loss,omitempty"`
	NumUnrespHops int     `json:"num_unresp_hops,omitempty"`
	TunnelType    int     `json:"tunnel_type,omitempty"`
	Hops          []Hops  `json:"hops,omitempty"` // Changed to a slice
}

type CloudPathProbe added in v2.61.0 

type CloudPathProbe struct {
	TimeStamp int         `json:"timestamp,omitempty"`
	CloudPath []CloudPath `json:"cloudpath,omitempty"` // Changed to a slice
}

/devices/{deviceid}/apps/{appid}/cloudpath-probes/{probeid}/cloudpath

func GetCloudPathAppDevice added in v2.61.0 

func GetCloudPathAppDevice(service *services.Service, deviceID, appID, probeID int, filters common.GetFromToFilters) ([]CloudPathProbe, *http.Response, error)

/devices/{deviceid}/apps/{appid}/cloudpath-probes/{probeid}/cloudpath

type DeviceCloudPathProbe 

type DeviceCloudPathProbe struct {
	ID             int              `json:"id,omitempty"`
	Name           string           `json:"name,omitempty"`
	NumProbes      int              `json:"num_probes,omitempty"`
	AverageLatency []AverageLatency `json:"avg_latencies,omitempty"`
}

devices/{deviceid}/apps/{appid}/cloudpath-probes

func GetAllCloudPathProbes added in v2.61.0 

func GetAllCloudPathProbes(service *services.Service, deviceID, appID int, filters common.GetFromToFilters) ([]DeviceCloudPathProbe, *http.Response, error)

devices/{deviceid}/apps/{appid}/cloudpath-probes Gets the list of all active Cloud Path probes on a device. If the time range is not specified, the endpoint defaults to the last 2 hours.

type DeviceDetail 

type DeviceDetail struct {
	ID       int       `json:"id"`
	Name     string    `json:"name,omitempty"`
	Hardware *Hardware `json:"hardware,omitempty"`
	Network  []Network `json:"network,omitempty"`
	Software *Software `json:"software,omitempty"`
}

func GetAllDevices added in v2.61.0 

func GetAllDevices(service *services.Service, filters GetDevicesFilters) ([]DeviceDetail, *http.Response, error)

Gets the list of all active devices and its basic details. The JSON must contain the user's ID and email address to associate the device to the user. If the time range is not specified, the endpoint defaults to the last 2 hours.

func GetDevice added in v2.61.0 

func GetDevice(service *services.Service, deviceID string) (*DeviceDetail, *http.Response, error)

Gets the device details including the device model information, tunnel type, network, and software details. The JSON must contain the user ID and email address to associate the device to a user. If the time range is not specified, the endpoint defaults to the last 2 hours.

type DeviceEvents 

type DeviceEvents struct {
	TimeStamp int      `json:"timestamp,omitempty"`
	Events    []Events `json:"instances,omitempty"`
}

func GetEvents added in v2.61.0 

func GetEvents(service *services.Service, deviceID int, filters common.GetFromToFilters) ([]DeviceEvents, *http.Response, error)

Gets the Events metrics trend for a device. If the time range is not specified, the endpoint defaults to the last 2 hours. The event metrics include Zscaler, Hardware, Software, and Network event changes.

type DeviceTopProcesses added in v2.61.0 

type DeviceTopProcesses struct {
	TimeStamp    int            `json:"timestamp,omitempty"`
	TopProcesses []TopProcesses `json:"top_processes,omitempty"`
}

func GetDeviceTopProcesses added in v2.61.0 

func GetDeviceTopProcesses(service *services.Service, deviceID int, traceID string, filters common.GetFromToFilters) ([]DeviceTopProcesses, *http.Response, error)

GetDeviceTopProcesses gets the top processes for a device's deep trace session

type DeviceWebProbe 

type DeviceWebProbe struct {
	ID        int     `json:"id,omitempty"`
	Name      string  `json:"name,omitempty"`
	NumProbes int     `json:"num_probes,omitempty"`
	AvgScore  float32 `json:"avg_score,omitempty"`
	AvgPFT    float32 `json:"avg_pft,omitempty"`
}

func GetAllWebProbes added in v2.61.0 

func GetAllWebProbes(service *services.Service, deviceID, appID int, filters common.GetFromToFilters) ([]DeviceWebProbe, *http.Response, error)

Gets the list of all active web probes on a device. If the time range is not specified, the endpoint defaults to the last 2 hours.

type Events 

type Events struct {
	Category    string `json:"category,omitempty"`
	Name        string `json:"name,omitempty"`
	DisplayName string `json:"display_name,omitempty"`
	Prev        string `json:"prev,omitempty"`
	Curr        string `json:"curr,omitempty"`
}

type GeoLocation 

type GeoLocation struct {
	ID          string     `json:"id"`
	Name        string     `json:"name,omitempty"`
	GeoType     string     `json:"geo_type,omitempty"`
	Description string     `json:"description,omitempty"`
	Children    []Children `json:"children,omitempty"`
}

func GetGeoLocations added in v2.61.0 

func GetGeoLocations(service *services.Service, filters GeoLocationFilter) ([]GeoLocation, *http.Response, error)

Gets the list of all active geolocations for the time range specified. If not specified, the endpoint defaults to the last 2 hours. The state and city data is retrieved only for the US.

type GeoLocationFilter 

type GeoLocationFilter struct {
	common.GetFromToFilters
	// The parent geo ID.
	ParentGeoID string `json:"parent_geo_id,omitempty" url:"parent_geo_id,omitempty"`
	// The search string used to support search by name.
	Search string `json:"search,omitempty" url:"search,omitempty"`
}

type GetDevicesFilters 

type GetDevicesFilters struct {
	common.GetFromToFilters
	// The user IDs.
	UserIDs []int `json:"userids,omitempty" url:"userids,omitempty"`
	// Emails
	Emails []string `json:"emails,omitempty" url:"emails,omitempty"`
	// The Zscaler location (ID). You can add multiple location IDs.
	Loc []int `json:"loc,omitempty" url:"loc,omitempty"`
	// The department (ID). You can add multiple department IDs.
	Dept []int `json:"dept,omitempty" url:"dept,omitempty"`
	// The active geolocation (ID). You can add multiple active geolocation IDs.
	Geo []string `json:"geo,omitempty" url:"geo,omitempty"`
	// The next_offset value from the last request. You must enter this value to get the next batch from the list. When the next_offset value becomes null, the list is complete.
	Offset string `json:"offset,omitempty" url:"offset,omitempty"`
	// The number of items that must be returned per request from the list.
	Limit int `json:"limit,omitempty" url:"limit,omitempty"`
}

type Hardware 

type Hardware struct {
	HWModel     string  `json:"hw_model,omitempty"`
	HWMFG       string  `json:"hw_mfg,omitempty"`
	HWType      string  `json:"hw_type,omitempty"`
	HWSerial    string  `json:"hw_serial,omitempty"`
	TotMem      int     `json:"tot_mem,omitempty"`
	GPU         string  `json:"gpu,omitempty"`
	DiskSize    int     `json:"disk_size,omitempty"`
	DiskModel   string  `json:"disk_model,omitempty"`
	DiskType    string  `json:"disk_type,omitempty"`
	CPUMFG      string  `json:"cpu_mfg,omitempty"`
	CPUModel    string  `json:"cpu_model,omitempty"`
	SpeedGHZ    float32 `json:"speed_ghz,omitempty"`
	LogicalProc int     `json:"logical_proc,omitempty"`
	NumCores    int     `json:"num_cores,omitempty"`
}

type HealthMetrics 

type HealthMetrics struct {
	Category  string      `json:"category,omitempty"`
	Instances []Instances `json:"instances,omitempty"`
}

func GetHealthMetrics added in v2.61.0 

func GetHealthMetrics(service *services.Service, deviceID int, filters common.GetFromToFilters) ([]HealthMetrics, *http.Response, error)

/devices/42827781/apps/1/health-metrics?from=1718247199&to=1718254399 Gets the health metrics trend for a device. If the time range is not specified, the endpoint defaults to the last 2 hours. The health metrics include CPU, Memory, Disk I/O, Network I/O, Wi-Fi, Network Bandwidth, etc.

type Hops 

type Hops struct {
	IP          string `json:"ip,omitempty"`
	GWMac       string `json:"gw_mac,omitempty"`
	GWMacVendor string `json:"gw_mac_vendor,omitempty"`
	PktSent     int    `json:"pkt_sent,omitempty"`
	PktRcvd     int    `json:"pkt_rcvd,omitempty"`
	LatencyMin  int    `json:"latency_min,omitempty"`
	LatencyMax  int    `json:"latency_max,omitempty"`
	LatencyAvg  int    `json:"latency_avg,omitempty"`
	LatencyDiff int    `json:"latency_diff,omitempty"`
}

type Instances 

type Instances struct {
	Name    string          `json:"metric,omitempty"`
	Metrics []common.Metric `json:"metrics,omitempty"`
}

type Network 

type Network struct {
	NetType     string `json:"net_type,omitempty"`
	Status      string `json:"status,omitempty"`
	IPv4        string `json:"ipv4,omitempty"`
	IPv6        string `json:"ipv6,omitempty"`
	DNSSRVS     string `json:"dns_srvs,omitempty"`
	DNSSuffix   string `json:"dns_suffix,omitempty"`
	Gateway     string `json:"gateway,omitempty"`
	MAC         string `json:"mac,omitempty"`
	GUID        string `json:"guid,omitempty"`
	WiFiAdapter string `json:"wifi_adapter,omitempty"`
	WiFiType    string `json:"wifi_type,omitempty"`
	SSID        string `json:"ssid,omitempty"`
	Channel     string `json:"channel,omitempty"`
	BSSID       string `json:"bssid,omitempty"`
}

type NetworkStats added in v2.61.0 

type NetworkStats struct {
	LegSRC string          `json:"leg_src,omitempty"`
	LegDst string          `json:"leg_dst,omitempty"`
	Stats  []common.Metric `json:"stats,omitempty"`
}

/devices/{deviceid}/apps/{appid}/cloudpath-probes/{probeid}

func GetDeviceAppCloudPathProbe added in v2.61.0 

func GetDeviceAppCloudPathProbe(service *services.Service, deviceID, appID, probeID int, filters common.GetFromToFilters) ([]NetworkStats, *http.Response, error)

/devices/{deviceid}/apps/{appid}/cloudpath-probes/{probeid}/cloudpath

type Processes added in v2.61.0 

type Processes struct {
	ID   int    `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
}

type Software 

type Software struct {
	OSName        string `json:"os_name,omitempty"`
	OSVer         string `json:"os_ver,omitempty"`
	Hostname      string `json:"hostname,omitempty"`
	NetBios       string `json:"netbios,omitempty"`
	User          string `json:"user,omitempty"`
	ClientConnVer string `json:"client_conn_ver,omitempty"`
	ZDXVer        string `json:"zdx_ver,omitempty"`
}

type TopProcesses added in v2.61.0 

type TopProcesses struct {
	Category  string      `json:"category,omitempty"`
	Processes []Processes `json:"processes,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.