locationtemplate

Documentation

Index

• type LocationTemplate
• type LocationTemplateDetails
• type Service
  • func New(c *zcon.Client) *Service
  • func (service *Service) Create(locations *LocationTemplate) (*LocationTemplate, error)
  • func (service *Service) Delete(locTemplateID int) (*http.Response, error)
  • func (service *Service) Get(locTemplateID int) (*LocationTemplate, error)
  • func (service *Service) GetAll() ([]LocationTemplate, error)
  • func (service *Service) GetByName(templateName string) (*LocationTemplate, error)
  • func (service *Service) Update(locTemplateID int, locations *LocationTemplate) (*LocationTemplate, *http.Response, error)

Types

type LocationTemplate

type LocationTemplate struct {
	// ID of Cloud & Branch Connector location template
	ID int `json:"id,omitempty"`

	// Name of Cloud & Branch Connector location template
	Name string `json:"name,omitempty"`

	// Description of Cloud & Branch Connector location template
	Description string `json:"desc,omitempty"`

	// Details of Cloud & Branch Connector location template
	LocationTemplateDetails *LocationTemplateDetails `json:"template,omitempty"`

	// Whether Cloud & Branch Connector location template is editable
	Editable bool `json:"editable"`

	// Last time Cloud & Branch Connector location template was modified
	LastModTime int `json:"lastModTime,omitempty"`

	// User ID of last time Cloud & Branch Connector location template was modified
	LastModUid *common.GeneralPurpose `json:"lastModUid,omitempty"`
}

type LocationTemplateDetails

type LocationTemplateDetails struct {
	// Prefix of Cloud & Branch Connector location template
	TemplatePrefix string `json:"templatePrefix,omitempty"`

	// Enable if you want the Zscaler service to use the X-Forwarded-For (XFF) headers that your on-premise proxy server inserts in outbound HTTP requests
	XFFForwardEnabled bool `json:"xffForwardEnabled,omitempty"`

	// Indicates whether "Authentication Required" is enabled in the location template
	AuthRequired bool `json:"authRequired,omitempty"`

	// Enable to display an end user notification for unauthenticated traffic. If disabled, the action is treated as an allow-policy
	CautionEnabled bool `json:"cautionEnabled,omitempty"`

	// Enable this feature to display an Acceptable Use Policy (AUP) for unauthenticated traffic and require users to accept it
	AupEnabled bool `json:"aupEnabled,omitempty"`

	// If you enabled aupEnabled, specify in days how frequently the AUP is displayed to users
	AupTimeoutInDays int `json:"aupTimeoutInDays,omitempty"`

	// Enables the service's firewall controls
	OFWEnabled bool `json:"ofwEnabled"`

	// If you enabled ofwEnabled, enable this for IPS controls for the location template
	IPSControl bool `json:"ipsControl"`

	// Enable to specify the maximum bandwidth limits for download (Mbps) and upload (Mbps)
	EnforceBandwidthControl bool `json:"enforceBandwidthControl"`

	// If you enabled enforceBandwidthControl, specify the maximum bandwidth for upload (Mbps)
	UpBandwidth int `json:"upBandwidth,omitempty"`

	// If you enabled enforceBandwidthControl, specify the maximum bandwidth for download (Mbps)
	DnBandwidth int `json:"dnBandwidth,omitempty"`

	// Display Time Unit. The time unit to display for IP Surrogate idle time to disassociation
	// Support values are: "MINUTE", "HOUR", "DAY"
	DisplayTimeUnit string `json:"displayTimeUnit,omitempty"`

	// Idle Time to Disassociation. The user mapping idle time (in minutes) is required if a Surrogate IP is enabled
	IdleTimeInMinutes int `json:"idleTimeInMinutes,omitempty"`

	// Idle Time to Disassociation. The user mapping idle time (in minutes) is required if a Surrogate IP is enabled
	SurrogateIPEnforcedForKnownBrowsers bool `json:"surrogateIPEnforcedForKnownBrowsers,omitempty"`

	// Display Refresh Time Unit. The time unit to display for refresh time for re-validation of surrogacy
	// Support values are: "MINUTE", "HOUR", "DAY"
	SurrogateRefreshTimeUnit string `json:"surrogateRefreshTimeUnit,omitempty"`

	// Refresh Time for re-validation of Surrogacy. The surrogate refresh time (in minutes) to re-validate the IP surrogates
	SurrogateRefreshTimeInMinutes int `json:"surrogateRefreshTimeInMinutes,omitempty"`

	// Refresh Time for re-validation of Surrogacy. The surrogate refresh time (in minutes) to re-validate the IP surrogates
	SurrogateIP bool `json:"surrogateIP,omitempty"`
}

type Service

type Service struct {
	Client *zcon.Client
}

func New

func New(c *zcon.Client) *Service

func (*Service) Create

func (service *Service) Create(locations *LocationTemplate) (*LocationTemplate, error)

func (*Service) Delete

func (service *Service) Delete(locTemplateID int) (*http.Response, error)

func (*Service) Get

func (service *Service) Get(locTemplateID int) (*LocationTemplate, error)

func (*Service) GetAll

func (service *Service) GetAll() ([]LocationTemplate, error)

func (*Service) GetByName

func (service *Service) GetByName(templateName string) (*LocationTemplate, error)

func (*Service) Update

func (service *Service) Update(locTemplateID int, locations *LocationTemplate) (*LocationTemplate, *http.Response, error)