Versions in this module Expand all Collapse all v0 v0.2.0 Oct 3, 2026 Changes in this version type Client + Schedule *ScheduleService type JobOperation + const OpScheduleCreate + const OpScheduleDelete + const OpScheduleGet + const OpScheduleList + const OpScheduleUpdate + type ScheduleCreateOpts struct + ContentType string + Interval string + Name string + Object string + Schedule string + User string + Vars map[string]any + type ScheduleEntryResult struct + Error string + Hostname string + Interval string + Name string + Object string + Schedule string + Source string + Status string + User string + type ScheduleMutationResult struct + Changed bool + Error string + Hostname string + Name string + Status string + type ScheduleService struct + func (s *ScheduleService) Create(ctx context.Context, hostname string, opts ScheduleCreateOpts) (*Response[Collection[ScheduleMutationResult]], error) + func (s *ScheduleService) Delete(ctx context.Context, hostname string, name string) (*Response[Collection[ScheduleMutationResult]], error) + func (s *ScheduleService) Get(ctx context.Context, hostname string, name string) (*Response[Collection[ScheduleEntryResult]], error) + func (s *ScheduleService) List(ctx context.Context, hostname string) (*Response[Collection[ScheduleEntryResult]], error) + func (s *ScheduleService) Update(ctx context.Context, hostname string, name string, opts ScheduleUpdateOpts) (*Response[Collection[ScheduleMutationResult]], error) + type ScheduleUpdateOpts struct + ContentType string + Object string + Schedule string + User string + Vars map[string]any v0.1.0 Oct 1, 2026 Changes in this version + const TargetAll + const TargetAny + type APIError struct + Message string + StatusCode int + func (e *APIError) Error() string + type Agent struct + Architecture string + CPUCount int + Conditions []Condition + Facts map[string]any + Fingerprint string + Fqdn string + Hostname string + Interfaces []NetworkInterface + KernelVersion string + Labels map[string]string + LoadAverage *LoadAverage + MachineID string + Memory *Memory + OSInfo *OSInfo + PackageMgr string + PrimaryInterface string + RegisteredAt time.Time + Routes []Route + ServiceMgr string + StartedAt time.Time + State string + Status string + Timeline []TimelineEvent + Uptime string + type AgentJobResponse struct + Changed *bool + Data any + Error string + Hostname string + Status string + type AgentList struct + Agents []Agent + Total int + type AgentSchedulingState = string + const AgentCordoned + const AgentDraining + const AgentPending + const AgentReady + type AgentService struct + func (s *AgentService) Accept(ctx context.Context, hostname string, fingerprint string) (*Response[MessageResponse], error) + func (s *AgentService) Drain(ctx context.Context, hostname string) (*Response[MessageResponse], error) + func (s *AgentService) Get(ctx context.Context, hostname string) (*Response[Agent], error) + func (s *AgentService) List(ctx context.Context) (*Response[AgentList], error) + func (s *AgentService) ListPending(ctx context.Context) (*Response[PendingAgentList], error) + func (s *AgentService) Reject(ctx context.Context, hostname string) (*Response[MessageResponse], error) + func (s *AgentService) Undrain(ctx context.Context, hostname string) (*Response[MessageResponse], error) + type AgentState struct + Duration string + Error string + Status string + type AgentStats struct + Agents []AgentSummary + Ready int + Total int + type AgentSummary struct + Hostname string + Labels string + Registered string + type AuditEntry struct + DurationMs int64 + ID string + Method string + OperationID string + Path string + ResponseCode int + Roles []string + SourceIP string + Timestamp time.Time + TraceID string + User string + type AuditList struct + Items []AuditEntry + TotalItems int + type AuditService struct + func (s *AuditService) Export(ctx context.Context) (*Response[AuditList], error) + func (s *AuditService) Get(ctx context.Context, id string) (*Response[AuditEntry], error) + func (s *AuditService) List(ctx context.Context, limit int, offset int) (*Response[AuditList], error) + type AuthError struct + func (e *AuthError) Unwrap() error + type CertificateCA struct + Name string + Object string + Source string + type CertificateCAMutationResult struct + Changed bool + Error string + Hostname string + Name string + Status string + type CertificateCAResult struct + Certificates []CertificateCA + Error string + Hostname string + Status string + type CertificateCreateOpts struct + Name string + Object string + type CertificateService struct + func (s *CertificateService) Create(ctx context.Context, hostname string, opts CertificateCreateOpts) (*Response[Collection[CertificateCAMutationResult]], error) + func (s *CertificateService) Delete(ctx context.Context, hostname string, name string) (*Response[Collection[CertificateCAMutationResult]], error) + func (s *CertificateService) List(ctx context.Context, hostname string) (*Response[Collection[CertificateCAResult]], error) + func (s *CertificateService) Update(ctx context.Context, hostname string, name string, opts CertificateUpdateOpts) (*Response[Collection[CertificateCAMutationResult]], error) + type CertificateUpdateOpts struct + Object string + type Client struct + Agent *AgentService + Audit *AuditService + Certificate *CertificateService + Command *CommandService + Cron *CronService + DNS *DNSService + Disk *DiskService + Docker *DockerService + File *FileService + FileDeploy *FileDeployService + Group *GroupService + Health *HealthService + Hostname *HostnameService + Interface *InterfaceService + Job *JobService + Load *LoadService + Log *LogService + Memory *MemoryService + NTP *NTPService + OS *OSService + Package *PackageService + Ping *PingService + Power *PowerService + Process *ProcessService + Route *RouteService + Service *ServiceService + Status *StatusService + Sysctl *SysctlService + Timezone *TimezoneService + Uptime *UptimeService + User *UserService + func New(baseURL string, bearerToken string, opts ...Option) *Client + type Collection struct + JobID string + Results []T + func (c Collection[T]) First() (T, bool) + type CommandResult struct + Changed bool + DurationMs int64 + Error string + ExitCode int + Hostname string + Status string + Stderr string + Stdout string + type CommandService struct + func (s *CommandService) Exec(ctx context.Context, req ExecRequest) (*Response[Collection[CommandResult]], error) + func (s *CommandService) Shell(ctx context.Context, req ShellRequest) (*Response[Collection[CommandResult]], error) + type ComponentHealth struct + Address string + Error string + Status string + type Condition struct + LastTransitionTime time.Time + Reason string + Status bool + Type string + type ConditionType = string + const ConditionDiskPressure + const ConditionHighLoad + const ConditionMemoryPressure + type ConflictError struct + func (e *ConflictError) Unwrap() error + type ConsumerDetail struct + AckPending int + Name string + Pending int + Redelivered int + type ConsumerStats struct + Consumers []ConsumerDetail + Total int + type CronCreateOpts struct + ContentType string + Interval string + Name string + Object string + Schedule string + User string + Vars map[string]any + type CronEntryResult struct + Error string + Hostname string + Interval string + Name string + Object string + Schedule string + Source string + Status string + User string + type CronMutationResult struct + Changed bool + Error string + Hostname string + Name string + Status string + type CronService struct + func (s *CronService) Create(ctx context.Context, hostname string, opts CronCreateOpts) (*Response[Collection[CronMutationResult]], error) + func (s *CronService) Delete(ctx context.Context, hostname string, name string) (*Response[Collection[CronMutationResult]], error) + func (s *CronService) Get(ctx context.Context, hostname string, name string) (*Response[Collection[CronEntryResult]], error) + func (s *CronService) List(ctx context.Context, hostname string) (*Response[Collection[CronEntryResult]], error) + func (s *CronService) Update(ctx context.Context, hostname string, name string, opts CronUpdateOpts) (*Response[Collection[CronMutationResult]], error) + type CronUpdateOpts struct + ContentType string + Object string + Schedule string + User string + Vars map[string]any + type DNSConfig struct + Changed bool + Error string + Hostname string + SearchDomains []string + Servers []string + Status string + type DNSDeleteResult struct + Changed bool + Error string + Hostname string + Status string + type DNSService struct + func (s *DNSService) Delete(ctx context.Context, target string, interfaceName string) (*Response[Collection[DNSDeleteResult]], error) + func (s *DNSService) Get(ctx context.Context, target string, interfaceName string) (*Response[Collection[DNSConfig]], error) + func (s *DNSService) Update(ctx context.Context, target string, interfaceName string, servers []string, ...) (*Response[Collection[DNSUpdateResult]], error) + type DNSUpdateResult struct + Changed bool + Error string + Hostname string + Status string + type Disk struct + Free int + Name string + Total int + Used int + type DiskResult struct + Changed bool + Disks []Disk + Error string + Hostname string + Status string + type DiskService struct + func (s *DiskService) Get(ctx context.Context, target string) (*Response[Collection[DiskResult]], error) + type DockerActionResult struct + Changed bool + Error string + Hostname string + ID string + Message string + Status string + type DockerCreateOpts struct + AutoStart *bool + Command []string + DNS []string + Env []string + Hostname string + Image string + Name string + Ports []string + Volumes []string + type DockerDetailResult struct + Changed bool + Created string + Env []string + Error string + Health string + Hostname string + ID string + Image string + Mounts []string + Name string + NetworkSettings map[string]string + Ports []string + State string + Status string + type DockerExecOpts struct + Command []string + Env []string + WorkingDir string + type DockerExecResult struct + Changed bool + Error string + ExitCode int + Hostname string + Status string + Stderr string + Stdout string + type DockerListParams struct + Limit int + State string + type DockerListResult struct + Changed bool + Containers []DockerSummaryItem + Error string + Hostname string + Status string + type DockerPullOpts struct + Image string + type DockerPullResult struct + Changed bool + Error string + Hostname string + ImageID string + Size int64 + Status string + Tag string + type DockerRemoveImageParams struct + Force bool + type DockerRemoveParams struct + Force bool + type DockerResult struct + Changed bool + Created string + Error string + Hostname string + ID string + Image string + Name string + State string + Status string + type DockerService struct + func (s *DockerService) Create(ctx context.Context, hostname string, opts DockerCreateOpts) (*Response[Collection[DockerResult]], error) + func (s *DockerService) Exec(ctx context.Context, hostname string, id string, opts DockerExecOpts) (*Response[Collection[DockerExecResult]], error) + func (s *DockerService) Inspect(ctx context.Context, hostname string, id string) (*Response[Collection[DockerDetailResult]], error) + func (s *DockerService) List(ctx context.Context, hostname string, params *DockerListParams) (*Response[Collection[DockerListResult]], error) + func (s *DockerService) Pull(ctx context.Context, hostname string, opts DockerPullOpts) (*Response[Collection[DockerPullResult]], error) + func (s *DockerService) Remove(ctx context.Context, hostname string, id string, params *DockerRemoveParams) (*Response[Collection[DockerActionResult]], error) + func (s *DockerService) RemoveImage(ctx context.Context, hostname string, imageName string, ...) (*Response[Collection[DockerActionResult]], error) + func (s *DockerService) Start(ctx context.Context, hostname string, id string) (*Response[Collection[DockerActionResult]], error) + func (s *DockerService) Stop(ctx context.Context, hostname string, id string, opts DockerStopOpts) (*Response[Collection[DockerActionResult]], error) + type DockerStopOpts struct + Timeout int + type DockerSummaryItem struct + Created string + ID string + Image string + Name string + State string + type ExecRequest struct + Args []string + Command string + Cwd string + Target string + Timeout int + type FileChanged struct + Changed bool + Name string + SHA256 string + type FileDelete struct + Deleted bool + Name string + type FileDeployOpts struct + ContentType string + Group string + Mode string + ObjectName string + Owner string + Path string + Target string + Vars map[string]any + type FileDeployResult struct + Changed bool + Error string + Hostname string + Status string + type FileDeployService struct + func (s *FileDeployService) Deploy(ctx context.Context, req FileDeployOpts) (*Response[Collection[FileDeployResult]], error) + func (s *FileDeployService) Status(ctx context.Context, target string, path string) (*Response[Collection[FileStatusResult]], error) + func (s *FileDeployService) Undeploy(ctx context.Context, req FileUndeployOpts) (*Response[Collection[FileUndeployResult]], error) + type FileItem struct + ContentType string + Name string + SHA256 string + Size int + Source string + type FileList struct + Files []FileItem + Total int + type FileMetadata struct + ContentType string + Name string + SHA256 string + Size int + type FileService struct + func (s *FileService) Delete(ctx context.Context, name string) (*Response[FileDelete], error) + func (s *FileService) Get(ctx context.Context, name string) (*Response[FileMetadata], error) + func (s *FileService) GetChanged(ctx context.Context, name string, file io.Reader) (*Response[FileChanged], error) + func (s *FileService) List(ctx context.Context) (*Response[FileList], error) + func (s *FileService) ListStale(ctx context.Context) (*Response[StaleList], error) + func (s *FileService) Upload(ctx context.Context, name string, contentType string, file io.Reader, ...) (*Response[FileUpload], error) + type FileStatusResult struct + Changed bool + Error string + Hostname string + Path string + SHA256 string + Status string + type FileUndeployOpts struct + Path string + Target string + type FileUndeployResult struct + Changed bool + Error string + Hostname string + Status string + type FileUpload struct + Changed bool + ContentType string + Name string + SHA256 string + Size int + type GroupCreateOpts struct + GID int + Name string + System bool + type GroupInfo struct + GID int + Members []string + Name string + type GroupInfoResult struct + Error string + Groups []GroupInfo + Hostname string + Status string + type GroupMutationResult struct + Changed bool + Error string + Hostname string + Name string + Status string + type GroupService struct + func (s *GroupService) Create(ctx context.Context, hostname string, opts GroupCreateOpts) (*Response[Collection[GroupMutationResult]], error) + func (s *GroupService) Delete(ctx context.Context, hostname string, name string) (*Response[Collection[GroupMutationResult]], error) + func (s *GroupService) Get(ctx context.Context, hostname string, name string) (*Response[Collection[GroupInfoResult]], error) + func (s *GroupService) List(ctx context.Context, hostname string) (*Response[Collection[GroupInfoResult]], error) + func (s *GroupService) Update(ctx context.Context, hostname string, name string, opts GroupUpdateOpts) (*Response[Collection[GroupMutationResult]], error) + type GroupUpdateOpts struct + Members []string + type HealthService struct + func (s *HealthService) GetLiveness(ctx context.Context) (*Response[HealthStatus], error) + func (s *HealthService) GetReady(ctx context.Context) (*Response[ReadyStatus], error) + func (s *HealthService) GetStatus(ctx context.Context) (*Response[SystemStatus], error) + type HealthStatus struct + Status string + type HostnameResult struct + Changed bool + Error string + Hostname string + Labels map[string]string + Status string + type HostnameService struct + func (s *HostnameService) Get(ctx context.Context, target string) (*Response[Collection[HostnameResult]], error) + func (s *HostnameService) Update(ctx context.Context, target string, name string) (*Response[Collection[HostnameUpdateResult]], error) + type HostnameUpdateResult struct + Changed bool + Error string + Hostname string + Status string + type InterfaceConfigOpts struct + Addresses []string + DHCP4 *bool + DHCP6 *bool + Gateway4 string + Gateway6 string + MACAddress string + MTU *int + WakeOnLAN *bool + type InterfaceGetResult struct + Error string + Hostname string + Interface *InterfaceInfo + Status string + type InterfaceInfo struct + Addresses []string + DHCP4 bool + DHCP6 bool + Family string + Gateway4 string + Gateway6 string + IPv4 string + IPv6 string + MAC string + MACAddress string + MTU int + Name string + Primary bool + State string + WakeOnLAN bool + type InterfaceListResult struct + Error string + Hostname string + Interfaces []InterfaceInfo + Status string + type InterfaceMutationResult struct + Changed bool + Error string + Hostname string + Name string + Status string + type InterfaceService struct + func (s *InterfaceService) Create(ctx context.Context, target string, name string, opts InterfaceConfigOpts) (*Response[Collection[InterfaceMutationResult]], error) + func (s *InterfaceService) Delete(ctx context.Context, target string, name string) (*Response[Collection[InterfaceMutationResult]], error) + func (s *InterfaceService) Get(ctx context.Context, target string, name string) (*Response[Collection[InterfaceGetResult]], error) + func (s *InterfaceService) List(ctx context.Context, target string) (*Response[Collection[InterfaceListResult]], error) + func (s *InterfaceService) Update(ctx context.Context, target string, name string, opts InterfaceConfigOpts) (*Response[Collection[InterfaceMutationResult]], error) + type JobCreated struct + JobID string + Revision int64 + Status string + Timestamp string + type JobDetail struct + AgentStates map[string]AgentState + Changed *bool + Created string + Error string + Hostname string + ID string + Operation map[string]any + Responses map[string]AgentJobResponse + Result any + Status string + Timeline []TimelineEvent + UpdatedAt string + type JobList struct + Items []JobDetail + StatusCounts map[string]int + TotalItems int + type JobOperation = string + const OpCertificateCACreate + const OpCertificateCADelete + const OpCertificateCAList + const OpCertificateCAUpdate + const OpCommandExec + const OpCommandShell + const OpCronCreate + const OpCronDelete + const OpCronGet + const OpCronList + const OpCronUpdate + const OpDockerCreate + const OpDockerExec + const OpDockerImageRemove + const OpDockerInspect + const OpDockerList + const OpDockerPull + const OpDockerRemove + const OpDockerStart + const OpDockerStop + const OpFileDeploy + const OpFileStatusGet + const OpFileUndeploy + const OpGroupCreate + const OpGroupDelete + const OpGroupGet + const OpGroupList + const OpGroupUpdate + const OpLogQuery + const OpLogQueryUnit + const OpLogSources + const OpNetworkDNSDelete + const OpNetworkDNSGet + const OpNetworkDNSUpdate + const OpNetworkInterfaceCreate + const OpNetworkInterfaceDelete + const OpNetworkInterfaceGet + const OpNetworkInterfaceList + const OpNetworkInterfaceUpdate + const OpNetworkPingDo + const OpNetworkRouteCreate + const OpNetworkRouteDelete + const OpNetworkRouteGet + const OpNetworkRouteList + const OpNetworkRouteUpdate + const OpNodeDiskGet + const OpNodeHostnameGet + const OpNodeHostnameUpdate + const OpNodeLoadGet + const OpNodeMemoryGet + const OpNodeOSGet + const OpNodeStatusGet + const OpNodeUptimeGet + const OpNtpCreate + const OpNtpDelete + const OpNtpGet + const OpNtpUpdate + const OpPackageGet + const OpPackageInstall + const OpPackageList + const OpPackageListUpdates + const OpPackageRemove + const OpPackageUpdate + const OpPowerReboot + const OpPowerShutdown + const OpProcessGet + const OpProcessList + const OpProcessSignal + const OpSSHKeyAdd + const OpSSHKeyList + const OpSSHKeyRemove + const OpServiceCreate + const OpServiceDelete + const OpServiceDisable + const OpServiceEnable + const OpServiceGet + const OpServiceList + const OpServiceRestart + const OpServiceStart + const OpServiceStop + const OpServiceUpdate + const OpSysctlCreate + const OpSysctlDelete + const OpSysctlGet + const OpSysctlList + const OpSysctlUpdate + const OpTimezoneGet + const OpTimezoneUpdate + const OpUserChangePassword + const OpUserCreate + const OpUserDelete + const OpUserGet + const OpUserList + const OpUserUpdate + type JobService struct + func (s *JobService) Delete(ctx context.Context, id string) error + func (s *JobService) Get(ctx context.Context, id string) (*Response[JobDetail], error) + func (s *JobService) List(ctx context.Context, params ListParams) (*Response[JobList], error) + func (s *JobService) Retry(ctx context.Context, id string, target string) (*Response[JobCreated], error) + type JobStats struct + Completed int + Dlq int + Failed int + Processing int + Total int + Unprocessed int + type JobStatus string + const JobStatusAcknowledged + const JobStatusCompleted + const JobStatusFailed + const JobStatusPartialFailure + const JobStatusPending + const JobStatusProcessing + const JobStatusRetried + const JobStatusSkipped + const JobStatusStarted + const JobStatusSubmitted + const JobStatusTimeout + type JobType = string + const JobTypeModify + const JobTypeQuery + type KVBucketInfo struct + Bytes int + Keys int + Name string + type ListParams struct + Limit int + Offset int + Status string + type LoadAverage struct + FifteenMin float32 + FiveMin float32 + OneMin float32 + type LoadResult struct + Changed bool + Error string + Hostname string + LoadAverage *LoadAverage + Status string + type LoadService struct + func (s *LoadService) Get(ctx context.Context, target string) (*Response[Collection[LoadResult]], error) + type LogEntry struct + Hostname string + Message string + PID int + Priority string + Timestamp string + Unit string + type LogEntryResult struct + Entries []LogEntry + Error string + Hostname string + Status string + type LogQueryOpts struct + Lines *int + Priority *string + Since *string + type LogService struct + func (s *LogService) Query(ctx context.Context, hostname string, opts LogQueryOpts) (*Response[Collection[LogEntryResult]], error) + func (s *LogService) QueryUnit(ctx context.Context, hostname string, unit string, opts LogQueryOpts) (*Response[Collection[LogEntryResult]], error) + func (s *LogService) Sources(ctx context.Context, hostname string) (*Response[Collection[LogSourceResult]], error) + type LogSourceResult struct + Error string + Hostname string + Sources []string + Status string + type Memory struct + Free int + Total int + Used int + type MemoryResult struct + Changed bool + Error string + Hostname string + Memory *Memory + Status string + type MemoryService struct + func (s *MemoryService) Get(ctx context.Context, target string) (*Response[Collection[MemoryResult]], error) + type MessageResponse struct + Message string + type NATSInfo struct + URL string + Version string + type NTPService struct + func (s *NTPService) Create(ctx context.Context, hostname string, opts NtpCreateOpts) (*Response[Collection[NtpMutationResult]], error) + func (s *NTPService) Delete(ctx context.Context, hostname string) (*Response[Collection[NtpMutationResult]], error) + func (s *NTPService) Get(ctx context.Context, hostname string) (*Response[Collection[NtpStatusResult]], error) + func (s *NTPService) Update(ctx context.Context, hostname string, opts NtpUpdateOpts) (*Response[Collection[NtpMutationResult]], error) + type NetworkInterface struct + Family string + IPv4 string + IPv6 string + MAC string + Name string + type NodeStatus struct + Changed bool + Disks []Disk + Error string + FieldErrors map[string]string + Hostname string + LoadAverage *LoadAverage + Memory *Memory + OSInfo *OSInfo + Partial bool + Status string + Uptime string + type NotFoundError struct + func (e *NotFoundError) Unwrap() error + type NtpCreateOpts struct + Servers []string + type NtpMutationResult struct + Changed bool + Error string + Hostname string + Status string + type NtpStatusResult struct + CurrentSource string + Error string + Hostname string + Offset string + Servers []string + Status string + Stratum int + Synchronized bool + type NtpUpdateOpts struct + Servers []string + type OSInfo struct + Distribution string + Version string + type OSInfoResult struct + Changed bool + Error string + Hostname string + OSInfo *OSInfo + Status string + type OSService struct + func (s *OSService) Get(ctx context.Context, target string) (*Response[Collection[OSInfoResult]], error) + type ObjectStoreInfo struct + Name string + Size int + type Option func(*Client) + func WithHTTPTransport(transport http.RoundTripper) Option + func WithLogger(logger *slog.Logger) Option + type PackageInfo struct + Description string + Name string + Size int64 + Status string + Version string + type PackageInfoResult struct + Error string + Hostname string + Packages []PackageInfo + Status string + type PackageMutationResult struct + Changed bool + Error string + Hostname string + Name string + Status string + type PackageService struct + func (s *PackageService) Get(ctx context.Context, hostname string, name string) (*Response[Collection[PackageInfoResult]], error) + func (s *PackageService) Install(ctx context.Context, hostname string, name string) (*Response[Collection[PackageMutationResult]], error) + func (s *PackageService) List(ctx context.Context, hostname string) (*Response[Collection[PackageInfoResult]], error) + func (s *PackageService) ListUpdates(ctx context.Context, hostname string) (*Response[Collection[PackageUpdateResult]], error) + func (s *PackageService) Remove(ctx context.Context, hostname string, name string) (*Response[Collection[PackageMutationResult]], error) + func (s *PackageService) Update(ctx context.Context, hostname string) (*Response[Collection[PackageMutationResult]], error) + type PackageUpdateResult struct + Error string + Hostname string + Status string + Updates []UpdateInfo + type PendingAgent struct + Fingerprint string + Hostname string + MachineID string + RequestedAt time.Time + type PendingAgentList struct + Agents []PendingAgent + Total int + type Permission = string + const PermAgentRead + const PermAgentWrite + const PermAuditRead + const PermCertificateRead + const PermCertificateWrite + const PermCommandExecute + const PermCommandShell + const PermCronRead + const PermCronWrite + const PermDockerExecute + const PermDockerRead + const PermDockerWrite + const PermFileRead + const PermFileWrite + const PermHealthRead + const PermJobRead + const PermJobWrite + const PermLogRead + const PermNetworkRead + const PermNetworkWrite + const PermNodeRead + const PermNodeWrite + const PermNtpRead + const PermNtpWrite + const PermPackageRead + const PermPackageWrite + const PermPowerExecute + const PermProcessExecute + const PermProcessRead + const PermServiceRead + const PermServiceWrite + const PermSysctlRead + const PermSysctlWrite + const PermTimezoneRead + const PermTimezoneWrite + const PermUserRead + const PermUserWrite + type PingResult struct + AvgRtt string + Changed bool + Error string + Hostname string + MaxRtt string + MinRtt string + PacketLoss float64 + PacketsReceived int + PacketsSent int + Status string + type PingService struct + func (s *PingService) Send(ctx context.Context, target string, address string) (*Response[Collection[PingResult]], error) + type PowerOpts struct + Delay int + Message string + type PowerResult struct + Action string + Changed bool + Delay int + Error string + Hostname string + Status string + type PowerService struct + func (s *PowerService) Reboot(ctx context.Context, hostname string, opts PowerOpts) (*Response[Collection[PowerResult]], error) + func (s *PowerService) Shutdown(ctx context.Context, hostname string, opts PowerOpts) (*Response[Collection[PowerResult]], error) + type ProcessInfo struct + CPUPercent float64 + Command string + MemPercent float32 + MemRSS int64 + Name string + PID int + StartTime string + State string + User string + type ProcessInfoResult struct + Error string + Hostname string + Processes []ProcessInfo + Status string + type ProcessService struct + func (s *ProcessService) Get(ctx context.Context, hostname string, pid int) (*Response[Collection[ProcessInfoResult]], error) + func (s *ProcessService) List(ctx context.Context, hostname string) (*Response[Collection[ProcessInfoResult]], error) + func (s *ProcessService) Signal(ctx context.Context, hostname string, pid int, opts ProcessSignalOpts) (*Response[Collection[ProcessSignalResult]], error) + type ProcessSignalOpts struct + Signal string + type ProcessSignalResult struct + Changed bool + Error string + Hostname string + PID int + Signal string + Status string + type ReadyStatus struct + Error string + ServiceUnavailable bool + Status string + type RegistryEntry struct + Age string + CPUPercent float64 + Conditions []string + Hostname string + MemBytes int64 + Status string + Type string + type Response struct + Data T + func NewResponse[T any](data T, rawJSON []byte) *Response[T] + func (r *Response[T]) RawJSON() []byte + type Role = string + const RoleAdmin + const RoleRead + const RoleWrite + type Route struct + Destination string + Flags string + Gateway string + Interface string + Mask string + Metric int + type RouteConfigOpts struct + Routes []RouteItem + type RouteGetResult struct + Error string + Hostname string + Routes []RouteInfo + Status string + type RouteInfo struct + Destination string + Gateway string + Interface string + Metric int + Scope string + type RouteItem struct + Metric *int + To string + Via string + type RouteListResult struct + Error string + Hostname string + Routes []RouteInfo + Status string + type RouteMutationResult struct + Changed bool + Error string + Hostname string + Interface string + Status string + type RouteService struct + func (s *RouteService) Create(ctx context.Context, target string, interfaceName string, opts RouteConfigOpts) (*Response[Collection[RouteMutationResult]], error) + func (s *RouteService) Delete(ctx context.Context, target string, interfaceName string) (*Response[Collection[RouteMutationResult]], error) + func (s *RouteService) Get(ctx context.Context, target string, interfaceName string) (*Response[Collection[RouteGetResult]], error) + func (s *RouteService) List(ctx context.Context, target string) (*Response[Collection[RouteListResult]], error) + func (s *RouteService) Update(ctx context.Context, target string, interfaceName string, opts RouteConfigOpts) (*Response[Collection[RouteMutationResult]], error) + type SSHKeyAddOpts struct + Key string + type SSHKeyInfo struct + Comment string + Fingerprint string + Type string + type SSHKeyInfoResult struct + Error string + Hostname string + Keys []SSHKeyInfo + Status string + type SSHKeyMutationResult struct + Changed bool + Error string + Hostname string + Status string + type ServerError struct + func (e *ServerError) Unwrap() error + type ServiceCreateOpts struct + Name string + Object string + type ServiceGetResult struct + Error string + Hostname string + Service *ServiceInfo + Status string + type ServiceInfo struct + Description string + Enabled bool + Name string + PID int + Status string + type ServiceInfoResult struct + Error string + Hostname string + Services []ServiceInfo + Status string + type ServiceMutationResult struct + Changed bool + Error string + Hostname string + Name string + Status string + type ServiceService struct + func (s *ServiceService) Create(ctx context.Context, hostname string, opts ServiceCreateOpts) (*Response[Collection[ServiceMutationResult]], error) + func (s *ServiceService) Delete(ctx context.Context, hostname string, name string) (*Response[Collection[ServiceMutationResult]], error) + func (s *ServiceService) Disable(ctx context.Context, hostname string, name string) (*Response[Collection[ServiceMutationResult]], error) + func (s *ServiceService) Enable(ctx context.Context, hostname string, name string) (*Response[Collection[ServiceMutationResult]], error) + func (s *ServiceService) Get(ctx context.Context, hostname string, name string) (*Response[Collection[ServiceGetResult]], error) + func (s *ServiceService) List(ctx context.Context, hostname string) (*Response[Collection[ServiceInfoResult]], error) + func (s *ServiceService) Restart(ctx context.Context, hostname string, name string) (*Response[Collection[ServiceMutationResult]], error) + func (s *ServiceService) Start(ctx context.Context, hostname string, name string) (*Response[Collection[ServiceMutationResult]], error) + func (s *ServiceService) Stop(ctx context.Context, hostname string, name string) (*Response[Collection[ServiceMutationResult]], error) + func (s *ServiceService) Update(ctx context.Context, hostname string, name string, opts ServiceUpdateOpts) (*Response[Collection[ServiceMutationResult]], error) + type ServiceUpdateOpts struct + Object string + type ShellRequest struct + Command string + Cwd string + Target string + Timeout int + type StaleDeployment struct + CurrentSHA string + DeployedAt string + DeployedSHA string + Hostname string + ObjectName string + Path string + Provider string + type StaleList struct + Stale []StaleDeployment + Total int + type StatusService struct + func (s *StatusService) Get(ctx context.Context, target string) (*Response[Collection[NodeStatus]], error) + type StreamInfo struct + Bytes int + Consumers int + Messages int + Name string + type SysctlCreateOpts struct + Key string + Value string + type SysctlEntryResult struct + Error string + Hostname string + Key string + Status string + Value string + type SysctlMutationResult struct + Changed bool + Error string + Hostname string + Key string + Status string + type SysctlService struct + func (s *SysctlService) Create(ctx context.Context, hostname string, opts SysctlCreateOpts) (*Response[Collection[SysctlMutationResult]], error) + func (s *SysctlService) Delete(ctx context.Context, hostname string, key string) (*Response[Collection[SysctlMutationResult]], error) + func (s *SysctlService) Get(ctx context.Context, hostname string, key string) (*Response[Collection[SysctlEntryResult]], error) + func (s *SysctlService) List(ctx context.Context, hostname string) (*Response[Collection[SysctlEntryResult]], error) + func (s *SysctlService) Update(ctx context.Context, hostname string, key string, opts SysctlUpdateOpts) (*Response[Collection[SysctlMutationResult]], error) + type SysctlUpdateOpts struct + Value string + type SystemStatus struct + Agents *AgentStats + Components map[string]ComponentHealth + Consumers *ConsumerStats + Jobs *JobStats + KVBuckets []KVBucketInfo + NATS *NATSInfo + ObjectStores []ObjectStoreInfo + Registry []RegistryEntry + ServiceUnavailable bool + Status string + Streams []StreamInfo + Uptime string + Version string + type TimelineEvent struct + Error string + Event string + Hostname string + Message string + Timestamp string + type TimezoneMutationResult struct + Changed bool + Error string + Hostname string + Status string + Timezone string + type TimezoneResult struct + Error string + Hostname string + Status string + Timezone string + UTCOffset string + type TimezoneService struct + func (s *TimezoneService) Get(ctx context.Context, hostname string) (*Response[Collection[TimezoneResult]], error) + func (s *TimezoneService) Update(ctx context.Context, hostname string, opts TimezoneUpdateOpts) (*Response[Collection[TimezoneMutationResult]], error) + type TimezoneUpdateOpts struct + Timezone string + type UnexpectedStatusError struct + func (e *UnexpectedStatusError) Unwrap() error + type UpdateInfo struct + CurrentVersion string + Name string + NewVersion string + type UploadOption func(*uploadOptions) + func WithForce() UploadOption + type UptimeResult struct + Changed bool + Error string + Hostname string + Status string + Uptime string + type UptimeService struct + func (s *UptimeService) Get(ctx context.Context, target string) (*Response[Collection[UptimeResult]], error) + type UserCreateOpts struct + GID int + Groups []string + Home string + Name string + Password string + Shell string + System bool + UID int + type UserInfo struct + GID int + Groups []string + Home string + Locked bool + Name string + Shell string + UID int + type UserInfoResult struct + Error string + Hostname string + Status string + Users []UserInfo + type UserMutationResult struct + Changed bool + Error string + Hostname string + Name string + Status string + type UserService struct + func (s *UserService) AddKey(ctx context.Context, hostname string, username string, opts SSHKeyAddOpts) (*Response[Collection[SSHKeyMutationResult]], error) + func (s *UserService) ChangePassword(ctx context.Context, hostname string, name string, password string) (*Response[Collection[UserMutationResult]], error) + func (s *UserService) Create(ctx context.Context, hostname string, opts UserCreateOpts) (*Response[Collection[UserMutationResult]], error) + func (s *UserService) Delete(ctx context.Context, hostname string, name string) (*Response[Collection[UserMutationResult]], error) + func (s *UserService) Get(ctx context.Context, hostname string, name string) (*Response[Collection[UserInfoResult]], error) + func (s *UserService) List(ctx context.Context, hostname string) (*Response[Collection[UserInfoResult]], error) + func (s *UserService) ListKeys(ctx context.Context, hostname string, username string) (*Response[Collection[SSHKeyInfoResult]], error) + func (s *UserService) RemoveKey(ctx context.Context, hostname string, username string, fingerprint string) (*Response[Collection[SSHKeyMutationResult]], error) + func (s *UserService) Update(ctx context.Context, hostname string, name string, opts UserUpdateOpts) (*Response[Collection[UserMutationResult]], error) + type UserUpdateOpts struct + Groups []string + Home string + Lock *bool + Shell string + type ValidationError struct + func (e *ValidationError) Unwrap() error
Go to main page