devicegroups

Documentation

Index

• type DeviceGroups
  • func GetAllDevicesGroups(service *services.Service) ([]DeviceGroups, error)
  • func GetDeviceGroupByName(service *services.Service, deviceGroupName string) (*DeviceGroups, error)
  • func GetIncludeDeviceInfo(service *services.Service, includeDeviceInfo, includePseudoGroups bool) ([]DeviceGroups, error)
• type Devices
  • func GetAllDevices(service *services.Service) ([]Devices, error)
  • func GetDevicesByID(service *services.Service, deviceID int) (*Devices, error)
  • func GetDevicesByModel(service *services.Service, deviceModel string) (*Devices, error)
  • func GetDevicesByName(service *services.Service, deviceName string) (*Devices, error)
  • func GetDevicesByOSType(service *services.Service, osTypeName string) (*Devices, error)
  • func GetDevicesByOSVersion(service *services.Service, osVersionName string) (*Devices, error)
  • func GetDevicesByOwner(service *services.Service, ownerName string) (*Devices, error)

Types

type DeviceGroups

type DeviceGroups struct {
	// The unique identifer for the device group
	ID int `json:"id"`

	// The device group name
	Name string `json:"name,omitempty"`

	// The device group type
	GroupType string `json:"groupType,omitempty"`

	// The device group's description
	Description string `json:"description,omitempty"`

	// The operating system (OS)
	OSType string `json:"osType,omitempty"`

	// Indicates whether this is a predefined device group. If this value is set to true, the group is predefined
	Predefined  bool   `json:"predefined"`
	DeviceNames string `json:"deviceNames,omitempty"`

	// The number of devices within the group
	DeviceCount int `json:"deviceCount,omitempty"`
}

func GetAllDevicesGroups

func GetAllDevicesGroups(service *services.Service) ([]DeviceGroups, error)

func GetDeviceGroupByName

func GetDeviceGroupByName(service *services.Service, deviceGroupName string) (*DeviceGroups, error)

func GetIncludeDeviceInfo

func GetIncludeDeviceInfo(service *services.Service, includeDeviceInfo, includePseudoGroups bool) ([]DeviceGroups, error)

type Devices

type Devices struct {
	// The unique identifier for the device
	ID int `json:"id"`

	// The device name
	Name string `json:"name,omitempty"`

	// The device group type
	DeviceGroupType string `json:"deviceGroupType,omitempty"`

	// The device model
	DeviceModel string `json:"deviceModel,omitempty"`

	// The operating system (OS)
	OSType string `json:"osType,omitempty"`

	// The operating system version
	OSVersion string `json:"osVersion,omitempty"`

	// The device's description
	Description string `json:"description,omitempty"`

	// The unique identifier of the device owner (i.e., user)
	OwnerUserId int `json:"ownerUserId,omitempty"`

	// The device owner's user name
	OwnerName string `json:"ownerName,omitempty"`

	// The hostname of the device
	HostName string `json:"hostName,omitempty"`
}

func GetAllDevices

func GetAllDevices(service *services.Service) ([]Devices, error)

func GetDevicesByID

func GetDevicesByID(service *services.Service, deviceID int) (*Devices, error)

func GetDevicesByModel

func GetDevicesByModel(service *services.Service, deviceModel string) (*Devices, error)

func GetDevicesByName

func GetDevicesByName(service *services.Service, deviceName string) (*Devices, error)

Get Devices by Name.

func GetDevicesByOSType

func GetDevicesByOSType(service *services.Service, osTypeName string) (*Devices, error)

func GetDevicesByOSVersion

func GetDevicesByOSVersion(service *services.Service, osVersionName string) (*Devices, error)

func GetDevicesByOwner

func GetDevicesByOwner(service *services.Service, ownerName string) (*Devices, error)