Documentation ¶
Overview ¶
Package client provides the client interface for 'service'
Index ¶
- Variables
- func DisableRemoteService(ctx context.Context, conn *proxy.Conn, system pb.SystemType, service string) error
- func EnableRemoteService(ctx context.Context, conn *proxy.Conn, system pb.SystemType, service string) error
- func ListRemoteServices(ctx context.Context, conn *proxy.Conn, system pb.SystemType) (*pb.ListReply, error)
- func RestartRemoteService(ctx context.Context, conn *proxy.Conn, system pb.SystemType, service string) error
- func StartRemoteService(ctx context.Context, conn *proxy.Conn, system pb.SystemType, service string) error
- func StatusRemoteService(ctx context.Context, conn *proxy.Conn, system pb.SystemType, service string) (*pb.StatusReply, error)
- func StopRemoteService(ctx context.Context, conn *proxy.Conn, system pb.SystemType, service string) error
Constants ¶
This section is empty.
Variables ¶
var RestartService = RestartRemoteService
RestartService was the original exported name for RestartRemoteService and now exists for backwards compatibility.
Deprecated: Use RestartRemoteService instead.
Functions ¶
func DisableRemoteService ¶ added in v1.15.0
func DisableRemoteService(ctx context.Context, conn *proxy.Conn, system pb.SystemType, service string) error
DisableRemoteService is a helper function for disabling a service on a remote target using a proxy.Conn. If the conn is defined for >1 targets this will return an error.
func EnableRemoteService ¶ added in v1.15.0
func EnableRemoteService(ctx context.Context, conn *proxy.Conn, system pb.SystemType, service string) error
EnableRemoteService is a helper function for enabling a service on a remote target using a proxy.Conn. If the conn is defined for >1 targets this will return an error.
func ListRemoteServices ¶ added in v1.15.0
func ListRemoteServices(ctx context.Context, conn *proxy.Conn, system pb.SystemType) (*pb.ListReply, error)
ListRemoteServices is a helper function for listing all services on a remote target using a proxy.Conn. If the conn is defined for >1 targets this will return an error.
func RestartRemoteService ¶ added in v1.15.0
func RestartRemoteService(ctx context.Context, conn *proxy.Conn, system pb.SystemType, service string) error
RestartRemoteService is a helper function for restarting a service on a remote target using a proxy.Conn. If the conn is defined for >1 targets this will return an error.
func StartRemoteService ¶ added in v1.15.0
func StartRemoteService(ctx context.Context, conn *proxy.Conn, system pb.SystemType, service string) error
StartRemoteService is a helper function for starting a service on a remote target using a proxy.Conn. If the conn is defined for >1 targets this will return an error.
func StatusRemoteService ¶ added in v1.15.0
func StatusRemoteService(ctx context.Context, conn *proxy.Conn, system pb.SystemType, service string) (*pb.StatusReply, error)
StatusRemoteService is a helper function for getting the status of a service on a remote target using a proxy.Conn. If the conn is defined for >1 targets this will return an error.
func StopRemoteService ¶ added in v1.15.0
func StopRemoteService(ctx context.Context, conn *proxy.Conn, system pb.SystemType, service string) error
StopRemoteService is a helper function for stopping a service on a remote target using a proxy.Conn. If the conn is defined for >1 targets this will return an error.
Types ¶
This section is empty.