Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ForeignSourcesAPI ¶
type ForeignSourcesAPI interface {
GetForeignSourceDef(foreignSource string) (*model.ForeignSourceDef, error)
SetForeignSourceDef(fs model.ForeignSourceDef) error
SetScanInterval(foreignSource string, scanInterval string) error
DeleteForeignSourceDef(foreignSource string) error
IsForeignSourceValid(fsDef model.ForeignSourceDef) error
IsPolicyValid(policy model.Policy) error
IsDetectorValid(detector model.Detector) error
GetDetectorConfig(detectorID string) (*model.Plugin, error)
GetDetector(foreignSource string, detectorID string) (*model.Detector, error)
SetDetector(foreignSource string, detector model.Detector) error
DeleteDetector(foreignSource string, detectorName string) error
GetPolicyConfig(policyID string) (*model.Plugin, error)
GetPolicy(foreignSource string, policyID string) (*model.Policy, error)
SetPolicy(foreignSource string, policy model.Policy) error
DeletePolicy(foreignSource string, policyName string) error
}
ForeignSourcesAPI the API to manipulate Foreign Source definitions
type MonitoringLocationsAPI ¶
type MonitoringLocationsAPI interface {
GetLocations() (*model.MonitoringLocationList, error)
LocationExists(location string) (bool, error)
GetLocation(location string) (*model.MonitoringLocation, error)
SetLocation(location model.MonitoringLocation) error
}
MonitoringLocationsAPI the API to manipulate Monitoring Locations
type NodesAPI ¶
type NodesAPI interface {
GetNodes() (*model.OnmsNodeList, error)
GetNode(nodeCriteria string) (*model.OnmsNode, error)
AddNode(node *model.OnmsNode) error
DeleteNode(nodeCriteria string) error
GetNodeMetadata(nodeCriteria string) ([]model.MetaData, error)
SetNodeMetadata(nodeCriteria string, meta model.MetaData) error
DeleteNodeMetadata(nodeCriteria string, context string, key string) error
GetIPInterfaces(nodeCriteria string) (*model.OnmsIPInterfaceList, error)
GetIPInterface(nodeCriteria string, ipAddress string) (*model.OnmsIPInterface, error)
SetIPInterface(nodeCriteria string, intf *model.OnmsIPInterface) error
DeleteIPInterface(nodeCriteria string, ipAddress string) error
GetIPInterfaceMetadata(nodeCriteria string, ipAddress string) ([]model.MetaData, error)
SetIPInterfaceMetadata(nodeCriteria string, ipAddress string, meta model.MetaData) error
DeleteIPInterfaceMetadata(nodeCriteria string, ipAddress string, context string, key string) error
GetSnmpInterfaces(nodeCriteria string) (*model.OnmsSnmpInterfaceList, error)
GetSnmpInterface(nodeCriteria string, ifIndex int) (*model.OnmsSnmpInterface, error)
SetSnmpInterface(nodeCriteria string, intf *model.OnmsSnmpInterface) error
DeleteSnmpInterface(nodeCriteria string, ifIndex int) error
GetMonitoredServices(nodeCriteria string, ipAddress string) (*model.OnmsMonitoredServiceList, error)
GetMonitoredService(nodeCriteria string, ipAddress string, service string) (*model.OnmsMonitoredService, error)
SetMonitoredService(nodeCriteria string, ipAddress string, svc *model.OnmsMonitoredService) error
DeleteMonitoredService(nodeCriteria string, ipAddress string, service string) error
GetMonitoredServiceMetadata(nodeCriteria string, ipAddress string, service string) ([]model.MetaData, error)
SetMonitoredServiceMetadata(nodeCriteria string, ipAddress string, service string, meta model.MetaData) error
DeleteMonitoredServiceMetadata(nodeCriteria string, ipAddress string, service string, context string, key string) error
GetCategories(nodeCriteria string) ([]model.OnmsCategory, error)
AddCategory(nodeCriteria string, category *model.OnmsCategory) error
DeleteCategory(nodeCriteria string, category string) error
GetAssetRecord(nodeCriteria string) (*model.OnmsAssetRecord, error)
SetAssetField(nodeCriteria string, field string, value string) error
}
NodesAPI the API to manipulate nodes
type ProfilesAPI ¶
type ProfilesAPI interface {
GetProfilesConfig() (*model.ProfilesConfig, error)
SetProfile(profile model.Profile) error
SetDefault(profileName string) error
DeleteProfile(profileName string) error
}
ProfilesAPI the API to manipulate configuration profiles
type ProvisioningUtilsAPI ¶
type ProvisioningUtilsAPI interface {
GetRequisitionNames() (*model.RequisitionsList, error)
RequisitionExists(foreignSource string) bool
GetAvailableAssets() (*model.ElementList, error)
GetAvailableDetectors() (*model.PluginList, error)
GetAvailablePolicies() (*model.PluginList, error)
}
ProvisioningUtilsAPI The API for common Provisioning operations
type RequisitionsAPI ¶
type RequisitionsAPI interface {
GetRequisitionsStats() (*model.RequisitionsStats, error)
CreateRequisition(foreignSource string) error
GetRequisition(foreignSource string) (*model.Requisition, error)
SetRequisition(req model.Requisition) error
DeleteRequisition(foreignSource string) error
ImportRequisition(foreignSource string, rescanExisting string) error
GetNode(foreignSource string, foreignID string) (*model.RequisitionNode, error)
SetNode(foreignSource string, node model.RequisitionNode) error
DeleteNode(foreignSource string, foreignID string) error
GetInterface(foreignSource string, foreignID string, ipAddress string) (*model.RequisitionInterface, error)
SetInterface(foreignSource string, foreignID string, intf model.RequisitionInterface) error
DeleteInterface(foreignSource string, foreignID string, ipAddress string) error
SetService(foreignSource string, foreignID string, ipAddress string, svc model.RequisitionMonitoredService) error
DeleteService(foreignSource string, foreignID string, ipAddress string, serviceName string) error
SetCategory(foreignSource string, foreignID string, category model.RequisitionCategory) error
DeleteCategory(foreignSource string, foreignID string, categoryName string) error
SetAsset(foreignSource string, foreignID string, asset model.RequisitionAsset) error
DeleteAsset(foreignSource string, foreignID string, assetName string) error
}
RequisitionsAPI the API to manipulate Requisitions
type ResourcesAPI ¶
type ResourcesAPI interface {
GetResourceForNode(nodeCriteria string) (*model.Resource, error)
GetResources() (*model.ResourceList, error)
GetResource(resourceID string) (*model.Resource, error)
DeleteResource(resourceID string) error
}
ResourcesAPI the API to manipulate Resources
type RestAPI ¶
type RestAPI interface {
Get(path string) ([]byte, error)
Post(path string, jsonBytes []byte) error
PostRaw(path string, dataBytes []byte, contentType string) (*http.Response, error)
Delete(path string) error
Put(path string, dataBytes []byte, contentType string) error
IsValid(response *http.Response) error
}
RestAPI the API for ReST Operations
Click to show internal directories.
Click to hide internal directories.