usermacro.go

package zabbix

// UserMacroResponse represent usermacro action response body
type UserMacroResponse struct {
	HostMacroIDs []string `json:"hostmacroids"`
}

// UserMacroGetParams represent the parameters for a `usermacro.get` API call (see zabbix documentation).
type UserMacroGetParams struct {
	GetParameters

	// Return global macros instead of host macros.
	GlobalMacro bool `json:"globalmacro,omitempty"`

	// Return only global macros with the given IDs.
	GlobalMacroIDs []string `json:"globalmacroids,omitempty"`

	// Return only host macros that belong to hosts or templates from the given host groups.
	GroupIDs []string `json:"groupids,omitempty"`

	// Return only macros that belong to the given hosts or templates.
	HostIDs []string `json:"hostids,omitempty"`

	// Return only host macros with the given IDs.
	HostMacroIDs []string `json:"hostmacroids,omitempty"`

	// Return only host macros that belong to the given templates. (Zabbix 2.x only)
	TemplateIDs []string `json:"templateids,omitempty"`

	// TODO: add selectGroups, selectHosts and selectTemplates queries
}

// GetUserMacro queries the Zabbix API for user macros matching the given search
// parameters.
//
// ErrEventNotFound is returned if the search result set is empty.
// An error is returned if a transport, parsing or API error occurs.
func (c *Session) GetUserMacro(params UserMacroGetParams) ([]HostMacro, error) {
	macros := make([]HostMacro, 0)

	if err := c.Get("usermacro.get", params, &macros); err != nil {
		return nil, err
	}

	if len(macros) == 0 {
		return nil, ErrNotFound
	}

	return macros, nil
}

// CreateUserMacros creates a single or multiple new user macros.
// Returns a list of macro id(s) of created macro(s).
//
// Zabbix API docs: https://www.zabbix.com/documentation/3.0/manual/config/macros/usermacros
func (c *Session) CreateUserMacros(macros ...HostMacro) (hostMacroIds []string, err error) {
	var body UserMacroResponse

	if err := c.Get("usermacro.create", macros, &body); err != nil {
		return nil, err
	}

	if (body.HostMacroIDs == nil) || (len(body.HostMacroIDs) == 0) {
		return nil, ErrNotFound
	}

	return body.HostMacroIDs, nil
}

// DeleteUserMacros method allows to delete host user macros.
// Returns a list of deleted macro id(s).
//
// Zabbix API docs: https://www.zabbix.com/documentation/2.2/manual/api/reference/usermacro/delete
func (c *Session) DeleteUserMacros(hostMacroIDs ...string) (hostMacroIds []string, err error) {
	var body UserMacroResponse

	if err := c.Get("usermacro.delete", hostMacroIds, &body); err != nil {
		return nil, err
	}

	if (body.HostMacroIDs == nil) || (len(body.HostMacroIDs) == 0) {
		return nil, ErrNotFound
	}

	return body.HostMacroIDs, nil
}

// UpdateUserMacros method allows to update host user macros.
// Returns a list of updated macro id(s).
//
// Zabbix API docs: https://www.zabbix.com/documentation/2.2/manual/api/reference/usermacro/update
func (c *Session) UpdateUserMacros(macros ...HostMacro) (hostMacroIds []string, err error) {
	var body UserMacroResponse

	if err := c.Get("usermacro.update", hostMacroIds, &body); err != nil {
		return nil, err
	}

	if (body.HostMacroIDs == nil) || (len(body.HostMacroIDs) == 0) {
		return nil, ErrNotFound
	}

	return body.HostMacroIDs, nil
}