locationgroups

Documentation

Index

• type City
• type DynamicLocationGroupCriteria
• type LastModUser
• type LocationGroup
• type Name
• type Service
  • func New(c *zia.Client) *Service
  • func (service *Service) CreateLocationGroup(locationGroups *LocationGroup) (*LocationGroup, error)
  • func (service *Service) DeleteLocationGroup(groupID int) (*http.Response, error)
  • func (service *Service) GetAll() ([]LocationGroup, error)
  • func (service *Service) GetLocationGroup(groupID int) (*LocationGroup, error)
  • func (service *Service) GetLocationGroupByName(locationGroupName string) (*LocationGroup, error)
  • func (service *Service) UpdateLocationGroup(groupID int, locationGroups *LocationGroup) (*LocationGroup, *http.Response, error)

Types

type City

type City struct {
	// String value to be matched or partially matched
	MatchString string `json:"matchString,omitempty"`

	// Operator that performs match action
	MatchType string `json:"matchType,omitempty"`
}

type DynamicLocationGroupCriteria

type DynamicLocationGroupCriteria struct {
	// A sub-string to match location name. Valid operators are contains, starts with, and ends with",
	Name *Name `json:"name,omitempty"`

	// One or more countries from a predefined set
	Countries []string `json:"countries,omitempty"`

	// A sub-string to match city. Valid operators are starts with, ends with, contains, and exact match operators.
	City *City `json:"city,omitempty"`

	// One or more values from a predefined set of SD-WAN partner list to display partner names.
	ManagedBy *common.IDNameExtensions `json:"managedBy,omitempty"`

	// Enforce Authentication. Required when ports are enabled, IP Surrogate is enabled, or Kerberos Authentication is enabled.
	EnforceAuthentication bool `json:"enforceAuthentication"`

	// Enable AUP. When set to true, AUP is enabled for the location.
	EnforceAup bool `json:"enforceAup"`

	// Enable Firewall. When set to true, Firewall is enabled for the location.
	EnforceFirewallControl bool `json:"enforceFirewallControl"`

	// Enable XFF Forwarding. When set to true, traffic is passed to Zscaler Cloud via the X-Forwarded-For (XFF) header.
	EnableXffForwarding bool `json:"enableXffForwarding"`

	// Enable Caution. When set to true, a caution notifcation is enabled for the location.
	EnableCaution bool `json:"enableCaution"`

	// Enable Bandwidth Control. When set to true, Bandwidth Control is enabled for the location.
	EnableBandwidthControl bool `json:"enableBandwidthControl"`

	// One or more location profiles from a predefined set
	Profiles []string `json:"profiles"`
}

type LastModUser

type LastModUser struct {
	// Identifier that uniquely identifies an entity
	ID int `json:"id,omitempty"`

	// The configured name of the entity
	Name       string                 `json:"name,omitempty"`
	Extensions map[string]interface{} `json:"extensions,omitempty"`
}

type LocationGroup

type LocationGroup struct {
	// Unique identifier for the location group
	ID int `json:"id,omitempty"`

	// Location group name
	Name string `json:"name,omitempty"`

	// Indicates the location group was deleted
	Deleted bool `json:"deleted,omitempty"`

	// The location group's type (i.e., Static or Dynamic)
	GroupType string `json:"groupType,omitempty"`

	// A dynamic location group's criteria. This is ignored if the groupType is Static.
	DynamicLocationGroupCriteria *DynamicLocationGroupCriteria `json:"dynamicLocationGroupCriteria,omitempty"`

	// Additional information about the location group
	Comments string `json:"comments"`

	// The Name-ID pairs of the locations that are assigned to the static location group. This is ignored if the groupType is Dynamic.
	Locations []common.IDNameExtensions `json:"locations"`

	// Automatically populated with the current ZIA admin user, after a successful POST or PUT request.
	LastModUser *LastModUser `json:"lastModUser"`

	// Automatically populated with the current time, after a successful POST or PUT request.
	LastModTime int  `json:"lastModTime"`
	Predefined  bool `json:"predefined"`
}

type Name

type Name struct {
	// String value to be matched or partially matched
	MatchString string `json:"matchString,omitempty"`

	// Operator that performs match action
	MatchType string `json:"matchType,omitempty"`
}

type Service

type Service struct {
	Client *zia.Client
}

func New

func New(c *zia.Client) *Service

func (*Service) CreateLocationGroup

func (service *Service) CreateLocationGroup(locationGroups *LocationGroup) (*LocationGroup, error)

func (*Service) DeleteLocationGroup

func (service *Service) DeleteLocationGroup(groupID int) (*http.Response, error)

func (*Service) GetAll

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

func (*Service) GetLocationGroup

func (service *Service) GetLocationGroup(groupID int) (*LocationGroup, error)

func (*Service) GetLocationGroupByName

func (service *Service) GetLocationGroupByName(locationGroupName string) (*LocationGroup, error)

func (*Service) UpdateLocationGroup

func (service *Service) UpdateLocationGroup(groupID int, locationGroups *LocationGroup) (*LocationGroup, *http.Response, error)