scan

Documentation

Index

• type CifsscanRequest
• type CifsscanResponse
• type Client
  • func New(c HTTPClient) *Client
  • func (c *Client) Cifsscan(ctx context.Context, req CifsscanRequest) ([]CifsscanResponse, error)
  • func (c *Client) Glusterfsscan(ctx context.Context, req GlusterfsscanRequest) ([]GlusterfsscanResponse, error)
  • func (c *Client) Index(ctx context.Context, req IndexRequest) ([]IndexResponse, error)
  • func (c *Client) Iscsiscan(ctx context.Context, req IscsiscanRequest) ([]IscsiscanResponse, error)
  • func (c *Client) Lvmscan(ctx context.Context, req LvmscanRequest) ([]LvmscanResponse, error)
  • func (c *Client) Lvmthinscan(ctx context.Context, req LvmthinscanRequest) ([]LvmthinscanResponse, error)
  • func (c *Client) Nfsscan(ctx context.Context, req NfsscanRequest) ([]NfsscanResponse, error)
  • func (c *Client) Pbsscan(ctx context.Context, req PbsscanRequest) ([]PbsscanResponse, error)
  • func (c *Client) Zfsscan(ctx context.Context, req ZfsscanRequest) ([]ZfsscanResponse, error)
• type GlusterfsscanRequest
• type GlusterfsscanResponse
• type HTTPClient
• type IndexRequest
• type IndexResponse
• type IscsiscanRequest
• type IscsiscanResponse
• type LvmscanRequest
• type LvmscanResponse
• type LvmthinscanRequest
• type LvmthinscanResponse
• type NfsscanRequest
• type NfsscanResponse
• type PbsscanRequest
• type PbsscanResponse
• type ZfsscanRequest
• type ZfsscanResponse

Types

type CifsscanRequest

type CifsscanRequest struct {
	Node   string `url:"node" json:"node"`     // The cluster node name.
	Server string `url:"server" json:"server"` // The server address (name or IP).

	// The following parameters are optional
	Domain   *string `url:"domain,omitempty" json:"domain,omitempty"`     // SMB domain (Workgroup).
	Password *string `url:"password,omitempty" json:"password,omitempty"` // User password.
	Username *string `url:"username,omitempty" json:"username,omitempty"` // User name.
}

type CifsscanResponse

type CifsscanResponse struct {
	Description string `url:"description" json:"description"` // Descriptive text from server.
	Share       string `url:"share" json:"share"`             // The cifs share name.

}

type Client

type Client struct {
	// contains filtered or unexported fields
}

func New

func New(c HTTPClient) *Client

func (*Client) Cifsscan

func (c *Client) Cifsscan(ctx context.Context, req CifsscanRequest) ([]CifsscanResponse, error)

Cifsscan Scan remote CIFS server.

func (*Client) Glusterfsscan

func (c *Client) Glusterfsscan(ctx context.Context, req GlusterfsscanRequest) ([]GlusterfsscanResponse, error)

Glusterfsscan Scan remote GlusterFS server.

func (*Client) Index

func (c *Client) Index(ctx context.Context, req IndexRequest) ([]IndexResponse, error)

Index Index of available scan methods

func (*Client) Iscsiscan

func (c *Client) Iscsiscan(ctx context.Context, req IscsiscanRequest) ([]IscsiscanResponse, error)

Iscsiscan Scan remote iSCSI server.

func (*Client) Lvmscan

func (c *Client) Lvmscan(ctx context.Context, req LvmscanRequest) ([]LvmscanResponse, error)

Lvmscan List local LVM volume groups.

func (*Client) Lvmthinscan

func (c *Client) Lvmthinscan(ctx context.Context, req LvmthinscanRequest) ([]LvmthinscanResponse, error)

Lvmthinscan List local LVM Thin Pools.

func (*Client) Nfsscan

func (c *Client) Nfsscan(ctx context.Context, req NfsscanRequest) ([]NfsscanResponse, error)

Nfsscan Scan remote NFS server.

func (*Client) Pbsscan

func (c *Client) Pbsscan(ctx context.Context, req PbsscanRequest) ([]PbsscanResponse, error)

Pbsscan Scan remote Proxmox Backup Server.

func (*Client) Zfsscan

func (c *Client) Zfsscan(ctx context.Context, req ZfsscanRequest) ([]ZfsscanResponse, error)

Zfsscan Scan zfs pool list on local node.

type GlusterfsscanRequest

type GlusterfsscanRequest struct {
	Node   string `url:"node" json:"node"`     // The cluster node name.
	Server string `url:"server" json:"server"` // The server address (name or IP).

}

type GlusterfsscanResponse

type GlusterfsscanResponse struct {
	Volname string `url:"volname" json:"volname"` // The volume name.

}

type HTTPClient

type HTTPClient interface {
	Do(context.Context, string, string, interface{}, interface{}) error
}

type IndexRequest

type IndexRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.

}

type IndexResponse

type IndexResponse struct {
	Method string `url:"method" json:"method"`
}

type IscsiscanRequest

type IscsiscanRequest struct {
	Node   string `url:"node" json:"node"`     // The cluster node name.
	Portal string `url:"portal" json:"portal"` // The iSCSI portal (IP or DNS name with optional port).

}

type IscsiscanResponse

type IscsiscanResponse struct {
	Portal string `url:"portal" json:"portal"` // The iSCSI portal name.
	Target string `url:"target" json:"target"` // The iSCSI target name.

}

type LvmscanRequest

type LvmscanRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.

}

type LvmscanResponse

type LvmscanResponse struct {
	Vg string `url:"vg" json:"vg"` // The LVM logical volume group name.

}

type LvmthinscanRequest

type LvmthinscanRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.
	Vg   string `url:"vg" json:"vg"`
}

type LvmthinscanResponse

type LvmthinscanResponse struct {
	Lv string `url:"lv" json:"lv"` // The LVM Thin Pool name (LVM logical volume).

}

type NfsscanRequest

type NfsscanRequest struct {
	Node   string `url:"node" json:"node"`     // The cluster node name.
	Server string `url:"server" json:"server"` // The server address (name or IP).

}

type NfsscanResponse

type NfsscanResponse struct {
	Options string `url:"options" json:"options"` // NFS export options.
	Path    string `url:"path" json:"path"`       // The exported path.

}

type PbsscanRequest

type PbsscanRequest struct {
	Node     string `url:"node" json:"node"`         // The cluster node name.
	Password string `url:"password" json:"password"` // User password or API token secret.
	Server   string `url:"server" json:"server"`     // The server address (name or IP).
	Username string `url:"username" json:"username"` // User-name or API token-ID.

	// The following parameters are optional
	Fingerprint *string `url:"fingerprint,omitempty" json:"fingerprint,omitempty"` // Certificate SHA 256 fingerprint.
	Port        *int    `url:"port,omitempty" json:"port,omitempty"`               // Optional port.
}

type PbsscanResponse

type PbsscanResponse struct {
	Store string `url:"store" json:"store"` // The datastore name.

	// The following parameters are optional
	Comment *string `url:"comment,omitempty" json:"comment,omitempty"` // Comment from server.
}

type ZfsscanRequest

type ZfsscanRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.

}

type ZfsscanResponse

type ZfsscanResponse struct {
	Pool string `url:"pool" json:"pool"` // ZFS pool name.

}