client

package module

Go to main page

Versions in this module

v1

v1.2024.24

Jun 7, 2024

Changes in this version

+ type CPUSummary struct

+ IO float64

+ Reported int64

+ System float64

+ User float64

+ type ChangeRequest struct

+ BundleName config.Bundle

+ Content any

+ Extend bool

+ NodeID string

+ Tag string

type Client

+ func (cli *Client) GetLatestMetrics(ctx context.Context, deviceID string) (*MetricsSummary, error)

+ func (cli *Client) GroupsList(ctx context.Context, query *GroupListQuery) ([]GroupNode, error)

+ type ConfigurationManager struct

+ func NewConfigurationManager() *ConfigurationManager

+ func (c *ConfigurationManager) Commit(ctx context.Context, commitMessage string) error

+ func (c *ConfigurationManager) GetConfig(ctx context.Context, entityID string) (*config.Config, error)

+ func (c *ConfigurationManager) Save(ctx context.Context, target, bundleName, configFile string) error

+ func (c *ConfigurationManager) WithClient(client *Client) *ConfigurationManager

+ func (c *ConfigurationManager) WithEntityConfigScope(entityConfigScope config.EntityConfigScope) *ConfigurationManager

+ func (c *ConfigurationManager) WithEntityType(entityType config.EntityType) *ConfigurationManager

+ func (c *ConfigurationManager) WithTemplateParameters(params map[string]string) *ConfigurationManager

type FileManager

+ func (m *FileManager) DownloadFile(ctx context.Context, remotePath, localPath string) error

+ func (m *FileManager) UploadFile(ctx context.Context, remotePath, localPath string, overwrite bool) error

+ type FilesystemMount struct

+ Available int64

+ Path string

+ Used int64

+ type FilesystemSummary struct

+ Mounts []FilesystemMount

+ Reported int64

+ type GroupListQuery struct

+ Search GroupListSearch

+ func (q GroupListQuery) String() (string, error)

+ type GroupListSearch struct

+ ParentID string

+ Tags []string

+ type GroupNode struct

+ Ancestors []string

+ NodeID string

+ ParentID string

+ Tags []string

+ Title string

+ Type NodeType

+ Updated int64

+ type LoadSummary struct

+ Minute1 float64

+ Minute15 float64

+ Minute5 float64

+ Reported int64

+ type MemorySummary struct

+ Available int64

+ Reported int64

+ SwapUsed int64

+ Used int64

+ type MetricsSummary struct

+ CPU CPUSummary

+ Filesystem FilesystemSummary

+ Load LoadSummary

+ Memory MemorySummary

+ type RunAgentManager struct

+ func NewRunAgentManager() *RunAgentManager

+ func (m *RunAgentManager) RunAgentDevice(ctx context.Context, deviceID string) error

+ func (m *RunAgentManager) RunAgentGroup(ctx context.Context, groupID string) error

+ func (m *RunAgentManager) RunAgentTag(ctx context.Context, tag string) error

+ func (m *RunAgentManager) WithAllowFailures(allow bool) *RunAgentManager

+ func (m *RunAgentManager) WithClient(client *Client) *RunAgentManager

type SystemInfo

+ TPMEnabled bool

v1.2024.8

Feb 22, 2024

Changes in this version

+ const RootNodeID

+ const UnassignedGroupNodeID

+ type ApprovePendingDeviceRequest struct

+ NodeID string

+ type Change struct

+ Content any

+ Created types.Timestamp

+ ID string

+ NodeInfo *NodeInfo

+ SHA string

+ Status ChangeStatus

+ Type string

+ Updated types.Timestamp

+ User *UserBaseInfo

+ UserID string

+ UserName string

+ type ChangeListQuery struct

+ CreatedEnd time.Time

+ CreatedStart time.Time

+ Limit int

+ Offset int

+ Search ChangeListSearch

+ Sort string

+ SortDirection string

+ func (q ChangeListQuery) String() (string, error)

+ type ChangeListSearch struct

+ FormType string

+ GroupID string

+ Status ChangeStatus

+ Type string

+ UserID string

+ type ChangeStatus string

+ const ChangeStatusCommitted

+ const ChangeStatusNew

type Client

+ func (cli *Client) ApprovePendingDevice(ctx context.Context, nodeID string) error

+ func (cli *Client) CommitConfiguration(ctx context.Context, message string) (*Commit, error)

+ func (cli *Client) CreateConfigurationChange(ctx context.Context, change Change) (*Change, error)

+ func (cli *Client) DeleteConfigurationChange(ctx context.Context, sha string) error

+ func (cli *Client) DeleteUncommittedConfigurationChanges(ctx context.Context) error

+ func (cli *Client) GetActiveConfig(ctx context.Context, entityType config.EntityType, entityID string, ...) (*config.Config, error)

+ func (cli *Client) GetCommit(ctx context.Context, sha string) (*CommitExtended, error)

+ func (cli *Client) GetConfigPreview(ctx context.Context, entityType config.EntityType, entityID string, ...) (*config.Config, error)

+ func (cli *Client) GetConfigurationChange(ctx context.Context, sha string) (*Change, error)

+ func (cli *Client) GetPendingDevices(ctx context.Context, pendingOnly bool) ([]PendingDevice, error)

+ func (cli *Client) GroupTreeGet(ctx context.Context, skipUnassigned bool) (*GroupTree, error)

+ func (cli *Client) GroupTreeGetNode(ctx context.Context, nodeID string) (*NodeInfo, error)

+ func (cli *Client) GroupTreeSetTags(ctx context.Context, nodeID string, tags []string) error

+ func (cli *Client) GroupTreeUpdate(ctx context.Context, req GroupTreeRequest) error

+ func (cli *Client) ListCommits(ctx context.Context, query CommitListQuery) (*CommitsList, error)

+ func (cli *Client) ListUncommittedConfigurationChanges(ctx context.Context, query ChangeListQuery) ([]Change, error)

+ func (cli *Client) RejectPendingDevice(ctx context.Context, nodeID string) error

+ func (cli *Client) RemoveApprovedHost(ctx context.Context, nodeID string) error

+ type Commit struct

+ Changes []string

+ Created types.Timestamp

+ ID string

+ Labels []string

+ Message string

+ SHA string

+ Type string

+ Updated types.Timestamp

+ User *UserBaseInfo

+ UserID string

+ type CommitExtended struct

+ Changes []Change

+ type CommitListQuery struct

+ Limit int

+ Offset int

+ Search CommitListSearch

+ Sort string

+ SortDirection string

+ func (q CommitListQuery) String() (string, error)

+ type CommitListSearch struct

+ ChangeSHA string

+ CommitSHA string

+ Committer string

+ EndDate string

+ LabelsExclude []string

+ LabelsInclude []string

+ Message string

+ StartDate string

+ UserID string

+ type CommitRequest struct

+ Action string

+ Message string

+ type CommitsList struct

+ Commits []*CommitExtended

+ Total int

+ type ConfigResponse struct

+ Config *config.Config

+ Status string

+ type GroupTree struct

+ TotalDevices int

+ Tree GroupTreeNode

+ type GroupTreeAction string

+ const TreeActionCreate

+ const TreeActionDelete

+ const TreeActionMove

+ const TreeActionRename

+ const TreeActionUpdate

+ type GroupTreeChange struct

+ Action GroupTreeAction

+ Data GroupTreeChangeData

+ type GroupTreeChangeData struct

+ NodeID string

+ OldParentID string

+ ParentID string

+ Tags []string

+ Title string

+ Type NodeType

+ type GroupTreeNode struct

+ AgentInterval int

+ Attributes DeviceAttributes

+ ConfigPropagated bool

+ DeviceCommitSHA string

+ Hostname string

+ ID string

+ LastReported int64

+ NodeID string

+ Nodes []GroupTreeNode

+ ParentID string

+ PublicKeyDigest string

+ Status string

+ Tags []string

+ Title string

+ Type NodeType

+ type GroupTreeRequest struct

+ Changes []GroupTreeChange

+ type GroupTreeSetTagsRequest struct

+ Tags []string

+ type NodeInfo struct

+ AgentInterval int

+ Ancestors []string

+ Attributes *DeviceAttributes

+ ConfigPropagated bool

+ DeviceCommitSHA string

+ LastReported int64

+ NodeID string

+ Nodes []NodeInfo

+ PublicKeyDigest string

+ PushedConfig *config.Pushed

+ Settings *config.Settings

+ Status string

+ System *SystemInfo

+ Tags []string

+ Title string

+ Type NodeType

+ UUID string

+ type NodeType string

+ const NodeTypeDevice

+ const NodeTypeGroup

+ type PendingDevice struct

+ Approved bool

+ ApprovedTimestamp int64

+ Certificate string

+ DeviceName string

+ FQHost string

+ GroupID string

+ HardwareMAC map[string]string

+ Host string

+ IPDefault string

+ IPv4 map[string]string

+ PublicKeyDigest string

+ RawPublicKey []string

+ RemoteAddress string

+ Timestamp int64

+ UQHost string

+ type UserBaseInfo struct

+ FirstName string

+ ID string

+ LastName string

v1.2024.7-pre

Feb 8, 2024

v1.2024.6

Feb 1, 2024

Changes in this version

+ const EdgeVersionNative

+ const EdgeVersionOpenVPN

type Client

+ func (cli *Client) GetDeviceStatus(ctx context.Context, deviceID string) (*DeviceStatus, error)

+ type DeviceStatus struct

+ Edge string

+ EdgeVersion EdgeVersion

+ RemoteAccess bool

+ UUID string

+ type EdgeVersion uint8

v1.2024.5

Jan 26, 2024

Changes in this version

type Client

+ func (cli *Client) UploadFileReplace(ctx context.Context, path, name string, replace bool, reader io.Reader) error

type File

+ Digest string

+ type FileManager struct

+ func NewFileManager() *FileManager

+ func (m *FileManager) List(ctx context.Context, remotePath string) error

+ func (m *FileManager) Remove(ctx context.Context, remotePath string, recursive bool) error

+ func (m *FileManager) Sync(ctx context.Context, source, dest string) error

+ func (m *FileManager) WithClient(client *Client) *FileManager

+ func (m *FileManager) WithDelete(del bool) *FileManager

+ func (m *FileManager) WithDryRun(dryrun bool) *FileManager

type ListSearch

+ Path string

v1.2024.4

Jan 18, 2024

v1.24.4

Jan 18, 2024

Changes in this version

+ const DefaultBaseURL

+ const SortDirectionAsc

+ const SortDirectionDesc

+ const TCP

+ const UDP

+ var Name = "qbee-cli"

+ var UserAgent = Name + "/" + Version

+ var Version = "1.0.0"

+ func IsValidDeviceID(deviceID string) bool

+ func LoginWriteConfig(config LoginConfig) error

+ type Client struct

+ func LoginGetAuthenticatedClient(ctx context.Context) (*Client, error)

+ func New() *Client

+ func (cli *Client) Authenticate(ctx context.Context, email string, password string) error

+ func (cli *Client) Call(ctx context.Context, method, path string, src, dst any) error

+ func (cli *Client) Connect(ctx context.Context, deviceID string, targets []RemoteAccessTarget) error

+ func (cli *Client) ConnectMulti(ctx context.Context, connections []RemoteAccessConnection, allowFailures bool) error

+ func (cli *Client) CreateDirectory(ctx context.Context, path, name string) error

+ func (cli *Client) DeleteFile(ctx context.Context, name string) error

+ func (cli *Client) DownloadFile(ctx context.Context, name string) (io.ReadCloser, error)

+ func (cli *Client) FileStats(ctx context.Context) (*Stats, error)

+ func (cli *Client) GetAuthToken() string

+ func (cli *Client) GetBaseURL() string

+ func (cli *Client) GetDeviceInventory(ctx context.Context, deviceID string) (*DeviceInventory, error)

+ func (cli *Client) GetFileMetadata(ctx context.Context, filePath string) (*File, error)

+ func (cli *Client) GetHTTPClient() *http.Client

+ func (cli *Client) GetRemoteAccessToken(ctx context.Context, req RemoteAccessTokenRequest) (*RemoteAccessToken, error)

+ func (cli *Client) ListDeviceInventory(ctx context.Context, query InventoryListQuery) (*InventoryListResponse, error)

+ func (cli *Client) ListFiles(ctx context.Context, query ListQuery) (*FilesListResponse, error)

+ func (cli *Client) Login(ctx context.Context, email, password string) (string, error)

+ func (cli *Client) Login2FA(ctx context.Context, challenge string) (string, error)

+ func (cli *Client) ParseConnect(ctx context.Context, deviceID string, targets []string) error

+ func (cli *Client) RenameFile(ctx context.Context, path, name, newPath string) error

+ func (cli *Client) Request(ctx context.Context, method, path string, src any) (*http.Response, error)

+ func (cli *Client) UploadFile(ctx context.Context, path, name string, reader io.Reader) error

+ func (cli *Client) WithAuthToken(authToken string) *Client

+ func (cli *Client) WithBaseURL(baseURL string) *Client

+ func (cli *Client) WithHTTPClient(httpClient *http.Client) *Client

+ type DeviceAttributes struct

+ Address string

+ City string

+ Country string

+ Description string

+ DeviceName string

+ DiscoveredAddress string

+ DiscoveredByPostAddressLatitude string

+ DiscoveredByPostAddressLongitude string

+ DiscoveredCity string

+ DiscoveredCountry string

+ DiscoveredLatitude string

+ DiscoveredLongitude string

+ DiscoveredZip string

+ Latitude string

+ Longitude string

+ UpdatedAuto types.Timestamp

+ UpdatedUser types.Timestamp

+ Zip string

+ type DeviceInventory struct

+ Attributes DeviceAttributes

+ ConfigPropagated bool

+ DeviceCommitSHA string

+ HeartbeatExpirationHard types.Timestamp

+ HeartbeatExpirationSoft types.Timestamp

+ ID string

+ LastReported types.Timestamp

+ PushedConfig config.Pushed

+ Settings config.Settings

+ Status string

+ SystemInfo SystemInfo

+ Tags []string

+ type Error map[string]any

+ func ParseErrorResponse(responseBody []byte) Error

+ func (error Error) Error() string

+ type File struct

+ Created int64

+ Extension string

+ IsDir bool

+ Mime string

+ Name string

+ Path string

+ Size int

+ User struct{ ... }

+ type FilesListResponse struct

+ Items []File

+ Total int

+ type InventoryListItem struct

+ AgentInterval string

+ Ancestors []string

+ Attributes DeviceAttributes

+ HeartbeatExpireHard int64

+ HeartbeatExpireSoft int64

+ LastReportedTime int64

+ NodeID string

+ PubKeyDigest string

+ Status string

+ System SystemInfo

+ Tags []string

+ Title string

+ UUID string

+ type InventoryListQuery struct

+ ItemsPerPage int

+ Offset int

+ ReportType InventoryReportType

+ Search InventoryListSearch

+ SortDirection string

+ SortField string

+ func (q InventoryListQuery) String() (string, error)

+ type InventoryListResponse struct

+ Items []InventoryListItem

+ Total int

+ type InventoryListSearch struct

+ Address string

+ Ancestors []string

+ Architecture string

+ City string

+ CommitSHA string

+ Country string

+ Description string

+ DeviceAttribute string

+ Flavor string

+ IPAddress string

+ Latitude string

+ Longitude string

+ MACAddress string

+ NodeID string

+ Tags []string

+ Title string

+ UUID string

+ Unassigned bool

+ Zip string

+ type InventoryReportType string

+ const InventoryReportTypeDetailed

+ const InventoryReportTypeShort

+ type ListQuery struct

+ ItemsPerPage int

+ Offset int

+ Path string

+ Search ListSearch

+ SortDirection string

+ SortField string

+ func (q ListQuery) String() (string, error)

+ type ListSearch struct

+ Name string

+ type Login2FARequest struct

+ Challenge string

+ Code string

+ Provider string

+ type Login2FAResponse struct

+ Challenge string

+ Token string

+ type LoginConfig struct

+ AuthToken string

+ BaseURL string

+ func LoginReadConfig() (*LoginConfig, error)

+ type LoginRequest struct

+ Email string

+ Password string

+ type LoginResponse struct

+ Token string

+ type RemoteAccessConnection struct

+ DeviceID string

+ Targets []string

+ type RemoteAccessConnectionInfo struct

+ Address string

+ Password string

+ URL string

+ Username string

+ VPNIndex string

+ type RemoteAccessTarget struct

+ LocalPort string

+ Protocol string

+ RemoteHost string

+ RemotePort string

+ func ParseRemoteAccessTarget(targetString string) (RemoteAccessTarget, error)

+ func (target RemoteAccessTarget) String() string

+ type RemoteAccessToken struct

+ Connection RemoteAccessConnectionInfo

+ Title string

+ func (token RemoteAccessToken) AuthString() string

+ func (token RemoteAccessToken) ProxyURL() (string, error)

+ type RemoteAccessTokenRequest struct

+ Application string

+ DeviceID string

+ Ports []string

+ Username string

+ type RemoteAccessTokenResponse map[string]RemoteAccessToken

+ type Stats struct

+ CountFiles int64

+ Quota int64

+ Used float64

+ type SystemInfo struct

+ AgentVersion string

+ Architecture string

+ BootTime string

+ CPUHardware string

+ CPURevision string

+ CPUSerialNumber string

+ CPUs string

+ Class string

+ FQHost string

+ Flavor string

+ HardwareMAC map[string]string

+ Host string

+ IPAddresses string

+ IPv4 map[string]string

+ IPv4First string

+ Interface string

+ InterfaceFlags map[string]string

+ LastConfigCommitID string

+ LastConfigUpdate types.Timestamp

+ LastPolicyUpdate types.Timestamp

+ LongArchitecture string

+ OS string

+ OSType string

+ Release string

+ RemoteAddress string

+ UQHost string

+ VPNIndex string

+ Version string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL