hostgroup.go

package zabbix

// For `HostgroupObject` field: `Status`
const (
	HostgroupFlagsPlain       = 0
	HostgroupFlagsDiscrovered = 4
)

// For `HostgroupObject` field: `Internal`
const (
	HostgroupInternalFalse = 0
	HostgroupInternalTrue  = 1
)

// HostgroupObject struct is used to store hostgroup operations results
//
// see: https://www.zabbix.com/documentation/5.0/manual/api/reference/hostgroup/object
type HostgroupObject struct {
	GroupID  int    `json:"groupid,omitempty"`
	Name     string `json:"name,omitempty"`
	Flags    int    `json:"flags,omitempty"`    // has defined consts, see above
	Internal int    `json:"internal,omitempty"` // has defined consts, see above

	Hosts     []HostObject     `json:"hosts,omitempty"`
	Templates []TemplateObject `json:"templates,omitempty"`
}

// HostgroupGetParams struct is used for hostgroup get requests
//
// see: https://www.zabbix.com/documentation/5.0/manual/api/reference/hostgroup/get#parameters
type HostgroupGetParams struct {
	GetParameters

	GraphIDs       []int `json:"graphids,omitempty"`
	GroupIDs       []int `json:"groupids,omitempty"`
	HostIDs        []int `json:"hostids,omitempty"`
	MaintenanceIDs []int `json:"maintenanceids,omitempty"`
	MonitoredHosts bool  `json:"monitored_hosts,omitempty"`
	RealHosts      bool  `json:"real_hosts,omitempty"`
	TemplatedHosts bool  `json:"templated_hosts,omitempty"`
	TemplateIDs    []int `json:"templateids,omitempty"`
	TriggerIDs     []int `json:"triggerids,omitempty"`

	WithApplications              bool `json:"with_applications,omitempty"`
	WithGraphs                    bool `json:"with_graphs,omitempty"`
	WithGraphPrototypes           bool `json:"with_graph_prototypes,omitempty"`
	WithHostsAndTemplates         bool `json:"with_hosts_and_templates,omitempty"`
	WithHttptests                 bool `json:"with_httptests,omitempty"`
	WithItems                     bool `json:"with_items,omitempty"`
	WithItemPrototypes            bool `json:"with_item_prototypes,omitempty"`
	WithSimpleGraphItemPrototypes bool `json:"with_simple_graph_item_prototypes,omitempty"`
	WithMonitoredHttptests        bool `json:"with_monitored_httptests,omitempty"`
	WithMonitoredItems            bool `json:"with_monitored_items,omitempty"`
	WithMonitoredTriggers         bool `json:"with_monitored_triggers,omitempty"`
	WithSimpleGraphItems          bool `json:"with_simple_graph_items,omitempty"`
	WithTriggers                  bool `json:"with_triggers,omitempty"`

	// SelectDiscoveryRule  SelectQuery `json:"selectDiscoveryRule,omitempty"` // not implemented yet
	// SelectGroupDiscovery SelectQuery `json:"selectGroupDiscovery,omitempty"` // not implemented yet
	SelectHosts     SelectQuery `json:"selectHosts,omitempty"`
	SelectTemplates SelectQuery `json:"selectTemplates,omitempty"`
}

// Structure to store creation result
type hostgroupCreateResult struct {
	GroupIDs []int `json:"groupids"`
}

// Structure to store deletion result
type hostgroupDeleteResult struct {
	GroupIDs []int `json:"groupids"`
}

// HostgroupGet gets hostgroups
func (z *Context) HostgroupGet(params HostgroupGetParams) ([]HostgroupObject, int, error) {

	var result []HostgroupObject

	status, err := z.request("hostgroup.get", params, &result)
	if err != nil {
		return nil, status, err
	}

	return result, status, nil
}

// HostgroupCreate creates hostgroups
func (z *Context) HostgroupCreate(params []HostgroupObject) ([]int, int, error) {

	var result hostgroupCreateResult

	status, err := z.request("hostgroup.create", params, &result)
	if err != nil {
		return nil, status, err
	}

	return result.GroupIDs, status, nil
}

// HostgroupDelete deletes hostgroups
func (z *Context) HostgroupDelete(groupIDs []int) ([]int, int, error) {

	var result hostgroupDeleteResult

	status, err := z.request("hostgroup.delete", groupIDs, &result)
	if err != nil {
		return nil, status, err
	}

	return result.GroupIDs, status, nil
}