-- import "github.com/Nexenta/go-nexentastor/pkg/ns"
func GetNefErrorCode(err error) stringGetNefErrorCode - treats an error as NefError and returns its code in case of success
func IsAlreadyExistNefError(err error) boolIsAlreadyExistNefError treats an error as NefError and returns true if its code is "EEXIST"
func IsAuthNefError(err error) boolIsAuthNefError treats an error as NefError and returns true if its code is "EAUTH"
func IsBadArgNefError(err error) boolIsBadArgNefError treats an error as NefError and returns true if its code is "EBADARG"
func IsBusyNefError(err error) boolIsBusyNefError treats an error as NefError and returns true if its code is "EBUSY" Example: filesystem cannot be deleted because it has snapshots
func IsNefError(err error) boolIsNefError - checks if an error is an NefError
func IsNotExistNefError(err error) boolIsNotExistNefError treats an error as NefError and returns true if its code is "ENOENT"
type ACLRuleSet int64ACLRuleSet - filesystem ACL rule set
const (
// ACLReadOnly - apply read only set of rules to filesystem
ACLReadOnly ACLRuleSet = iota
// ACLReadWrite - apply full access set of rules to filesystem
ACLReadWrite
)type CloneSnapshotParams struct {
// filesystem path w/o leading slash
TargetPath string `json:"targetPath"`
ReferencedQuotaSize int64 `json:"referencedQuotaSize,omitempty"`
}CloneSnapshotParams - params to clone snapshot to filesystem
type CreateFilesystemParams struct {
// filesystem path w/o leading slash
Path string `json:"path"`
// filesystem referenced quota size in bytes
ReferencedQuotaSize int64 `json:"referencedQuotaSize,omitempty"`
}CreateFilesystemParams - params to create filesystem
type CreateHostGroupParams struct {
// list of IQNs for the hostGroup
Members []string `json:"members"`
// a unique name for the hostGroup
Name string `json:"name"`
}CreateHostGroupParams - params to create a hostGroup
type CreateISCSITargetParams struct {
Name string `json:"name"`
Portals []Portal `json:"portals"`
}CreateISCSITargetParams - params to create new iSCSI target
type CreateLunMappingParams struct {
HostGroup string `json:"hostGroup"`
Volume string `json:"volume"`
TargetGroup string `json:"targetGroup"`
}CreateLunMappingParams - params to create new lun
type CreateNfsShareParams struct {
// filesystem path w/o leading slash
Filesystem string `json:"filesystem"`
ReadWriteList []NfsRuleList `json:"readWriteList"`
ReadOnlyList []NfsRuleList `json:"readOnlyList"`
}CreateNfsShareParams - params to create NFS share
type CreateRemoteInitiatorParams struct {
Name string `json:"name"`
ChapUser string `json:"chapUser"`
ChapSecret string `json:"chapSecret"`
}CreateRemoteInitiatorParams - params to create credentials for remote initiator
type CreateSmbShareParams struct {
// filesystem path w/o leading slash
Filesystem string `json:"filesystem"`
// share name, used in mount command
ShareName string `json:"shareName,omitempty"`
}CreateSmbShareParams - params to create SMB share
type CreateSnapshotParams struct {
// snapshot path w/o leading slash
Path string `json:"path"`
}CreateSnapshotParams - params to create snapshot
type CreateTargetGroupParams struct {
Name string `json:"name"`
Members []string `json:"members"`
}CreateTargetGroupParams - params to create target group
type CreateVolumeParams struct {
// volume path w/o leading slash
Path string `json:"path"`
VolumeSize int64 `json:"volumeSize"`
}CreateVolumeParams - params to create a volume
type DestroyFilesystemParams struct {
// If set to `true`, then tries to destroy filesystem's snapshots as well.
// In case some snapshots have clones, the filesystem cannot be deleted
// without deleting all dependent clones, OR promoting one of the clones
// to take over the snapshots (see "PromoteMostRecentCloneIfExists" parameter).
DestroySnapshots bool
// If set to `true`, then tries to find the most recent snapshot clone and if found one,
// that clone will be promoted to take over all the snapshots from the original filesystem,
// then the original filesystem will be destroyed.
//
// Initial state:
// [fsSource]---+ // source filesystem
// | [snapshot1] // source filesystem snapshots
// | [snapshot2]
// `--->[snapshot3]<---+
// |
// [fsClone1]-----------------------+ // filesystem clone of "snapshot3"
// [fsClone2]-----------------------+ // another filesystem clone of "snapshot3"
//
// After destroy "fsSource" filesystem call (PromoteMostRecentCloneIfExists=true and DestroySnapshots=true):
// [fsClone1]<----------------------+ // "fsClone1" is still linked to "snapshot3"
// [fsClone2]---+ | // "fsClone2" is got promoted to take over snapshots of "fsSource"
// | [snapshot1] |
// | [snapshot2] |
// `--->[snapshot3]<---+
//
PromoteMostRecentCloneIfExists bool
}DestroyFilesystemParams - filesystem deletion parameters
type DestroyVolumeParams struct {
DestroySnapshots bool
PromoteMostRecentCloneIfExists bool
}type Filesystem struct {
Path string `json:"path"`
MountPoint string `json:"mountPoint"`
SharedOverNfs bool `json:"sharedOverNfs"`
SharedOverSmb bool `json:"sharedOverSmb"`
BytesAvailable int64 `json:"bytesAvailable"`
BytesUsed int64 `json:"bytesUsed"`
}Filesystem - NexentaStor filesystem
func (fs *Filesystem) GetDefaultSmbShareName() stringGetDefaultSmbShareName - get default SMB share name (all slashes get replaced by underscore) Converts '/pool/dataset/fs' to 'pool_dataset_fs'
func (fs *Filesystem) GetReferencedQuotaSize() int64GetReferencedQuotaSize - get total referenced quota size
func (fs *Filesystem) String() stringtype GetLunMappingsParams struct {
TargetGroup string `json:"targetGroup,omitempty"`
Volume string `json:"volume,omitempty"`
HostGroup string `json:"hostGroup,omitempty"`
}type License struct {
Valid bool `json:"valid"`
Expires string `json:"expires"`
}License - NexentaStor license
type LunMapping struct {
Id string `json:"id"`
Volume string `json:"volume"`
TargetGroup string `json:"targetGroup"`
HostGroup string `json:"hostGroup"`
Lun int `json:"lun"`
}LunMapping - NexentaStor lunmapping
type NefError struct {
Err error
Code string
}NefError - nef error format
func (e *NefError) Error() stringtype NfsRuleList struct {
Etype string `json:"etype"`
Entity string `json:"entity"`
Mask int `json:"mask"`
}type Pool struct {
Name string `json:"poolName"`
}Pool - NS pool
type Portal struct {
Address string `json:"address"`
Port int `json:"port"`
}type Provider struct {
Address string
Username string
Password string
RestClient rest.ClientInterface
Log *logrus.Entry
}Provider - NexentaStor API provider
func (p *Provider) CloneSnapshot(path string, params CloneSnapshotParams) errorCloneSnapshot clones snapshot to FS
func (p *Provider) CreateFilesystem(params CreateFilesystemParams) errorCreateFilesystem creates filesystem by path
func (p *Provider) CreateHostGroup(params CreateHostGroupParams) errorfunc (p *Provider) CreateISCSITarget(params CreateISCSITargetParams) errorCreateISCSITarget - create new iSCSI target on NexentaStor
func (p *Provider) CreateLunMapping(params CreateLunMappingParams) errorCreateLunMapping - creates lun for given volume
func (p *Provider) CreateNfsShare(params CreateNfsShareParams) errorCreateNfsShare creates NFS share on specified filesystem CLI test:
showmount -e HOST
mkdir -p /mnt/test && sudo mount -v -t nfs HOST:/pool/fs /mnt/test
findmnt /mnt/test
func (p *Provider) CreateRemoteInitiator(params CreateRemoteInitiatorParams) errorCreateRemoteInitiator - create new remote initiator in NexentaStor
func (p *Provider) CreateSmbShare(params CreateSmbShareParams) errorCreateSmbShare creates SMB share (cifs) on specified filesystem Leave shareName empty to generate default value CLI test:
mkdir -p /mnt/test && sudo mount -v -t cifs -o username=admin,password=Nexenta@1 //HOST//pool_fs /mnt/test
findmnt /mnt/test
func (p *Provider) CreateSnapshot(params CreateSnapshotParams) errorCreateSnapshot creates snapshot by filesystem path
func (p *Provider) CreateUpdateTargetGroup(params CreateTargetGroupParams) errorCreateUpdateTargetGroup - create new target group on NexentaStor
func (p *Provider) CreateVolume(params CreateVolumeParams) errorCreateVolume creates volume by path and size
func (p *Provider) DeleteNfsShare(path string) errorDeleteNfsShare destroys NFS chare by filesystem path
func (p *Provider) DeleteSmbShare(path string) errorDeleteSmbShare destroys SMB share by filesystem path
func (p *Provider) DestroyFilesystem(path string, params DestroyFilesystemParams) errorDestroyFilesystem destroys filesystem on NS, may destroy snapshots and promote clones (see DestroyFilesystemParams) Path format: 'pool/dataset/filesystem'
func (p *Provider) DestroyLunMapping(id string) errorfunc (p *Provider) DestroySnapshot(path string) errorDestroySnapshot destroys snapshot by path
func (p *Provider) DestroyVolume(path string, params DestroyVolumeParams) errorfunc (p *Provider) GetFilesystem(path string) (filesystem Filesystem, err error)GetFilesystem returns NexentaStor filesystem by its path
func (p *Provider) GetFilesystemAvailableCapacity(path string) (int64, error)GetFilesystemAvailableCapacity returns NexentaStor filesystem available size by its path
func (p *Provider) GetFilesystems(parent string) ([]Filesystem, error)GetFilesystems returns all NexentaStor filesystems by parent filesystem
func (p *Provider) GetFilesystemsSlice(parent string, limit, offset int) ([]Filesystem, error)GetFilesystemsSlice returns a slice of filesystems by parent filesystem with specified limit and offset offset - the first record number of collection, that would be included in result
func (p *Provider) GetFilesystemsWithStartingToken(parent string, startingToken string, limit int) (
filesystems []Filesystem,
nextToken string,
err error,
)GetFilesystemsWithStartingToken returns filesystems by parent filesystem after specified starting token parent - parent filesystem's path startingToken - a path to a specific filesystem to start AFTER this token limit - the maximum count of filesystems to return in the list Function may return nextToken if there is more filesystems than limit value
func (p *Provider) GetHostGroups() (hostGroups []nefHostGroup, err error)func (p *Provider) GetLicense() (license License, err error)GetLicense returns NexentaStor license
func (p *Provider) GetLunMapping(path string) (lunMapping LunMapping, err error)GetLunMapping returns NexentaStor lunmapping for a volume
func (p *Provider) GetLunMappings(params GetLunMappingsParams) (lunMappings []LunMapping, err error)GetLunMappings returns NexentaStor lunmappings for given parameters
func (p *Provider) GetPools() ([]Pool, error)GetPools returns NexentaStor pools
func (p *Provider) GetRSFClusters() ([]RSFCluster, error)GetRSFClusters returns RSF clusters from NS
func (p *Provider) GetRemoteInitiator(name string) (remoteInitiator RemoteInitiator, err error)GetRemoteInitiator - returns remote initiator object for given name
func (p *Provider) GetSmbShareName(path string) (string, error)GetSmbShareName returns share name for filesystem that shared over SMB
func (p *Provider) GetSnapshot(path string) (snapshot Snapshot, err error)GetSnapshot returns snapshot by its path path - full path to snapshot w/o leading slash (e.g. "p/d/fs@s")
func (p *Provider) GetSnapshots(volumePath string, recursive bool) ([]Snapshot, error)GetSnapshots returns snapshots by volume path
func (p *Provider) GetTargetGroup(name string) (targetGroup TargetGroup, err error)GetTargetGroup returns TargetGroup by its name
func (p *Provider) GetTargetGroups() ([]TargetGroup, error)GetTargetGroups - returns the list of targetGroups on NexentaStor
func (p *Provider) GetVolume(path string) (volume Volume, err error)GetVolume - returns NexentaStor volume properties
func (p *Provider) GetVolumeGroup(path string) (volumeGroup VolumeGroup, err error)GetVolumeGroup returns NexentaStor volumeGroup by its path
func (p *Provider) GetVolumes(parent string) ([]Volume, error)GetVolumes returns all NexentaStor volumes by parent volumeGroup
func (p *Provider) GetVolumesSlice(parent string, limit, offset int) ([]Volume, error)GetVolumesSlice returns a slice of volumes by parent volumeGroup with specified limit and offset offset - the first record number of collection, that would be included in result
func (p *Provider) GetVolumesWithStartingToken(parent string, startingToken string, limit int) (
volumes []Volume,
nextToken string,
err error,
)GetVolumesWithStartingToken returns volumes by parent volumeGroup after specified starting token parent - parent volumeGroup's path startingToken - a path to a specific volume to start AFTER this token limit - the maximum count of volumes to return in the list Function may return nextToken if there is more volumes than limit value
func (p *Provider) IsJobDone(jobID string) (bool, error)IsJobDone checks if job is done by jobId
func (p *Provider) LogIn() errorLogIn logs in to NexentaStor API and get auth token
func (p *Provider) PromoteFilesystem(path string) errorPromoteFilesystem promotes a cloned filesystem to be no longer dependent on its original snapshot
func (p *Provider) PromoteVolume(path string) errorPromoteVolume promotes a cloned volume to be no longer dependent on its original snapshot
func (p *Provider) SetFilesystemACL(path string, aclRuleSet ACLRuleSet) errorSetFilesystemACL sets filesystem ACL, so NFS share can allow user to write w/o checking UNIX user uid
func (p *Provider) String() stringfunc (p *Provider) UpdateFilesystem(path string, params UpdateFilesystemParams) errorUpdateFilesystem updates filesystem by path
func (p *Provider) UpdateHostGroup(path string, params UpdateHostGroupParams) errorfunc (p *Provider) UpdateISCSITarget(name string, params UpdateISCSITargetParams) (err error)UpdateISCSITarget - update existing iSCSI target
func (p *Provider) UpdateRemoteInitiator(name string, params UpdateRemoteInitiatorParams) errorUpdateRemoteInitiator updates remote initiator for given name
func (p *Provider) UpdateVolume(path string, params UpdateVolumeParams) errorUpdateVolume updates volume by path
type ProviderArgs struct {
Address string
Username string
Password string
Log *logrus.Entry
// InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name.
InsecureSkipVerify bool
}ProviderArgs - params to create Provider instance
type ProviderInterface interface {
// system
LogIn() error
IsJobDone(jobID string) (bool, error)
GetLicense() (License, error)
GetRSFClusters() ([]RSFCluster, error)
// pools
GetPools() ([]Pool, error)
// filesystems
CreateFilesystem(params CreateFilesystemParams) error
UpdateFilesystem(path string, params UpdateFilesystemParams) error
DestroyFilesystem(path string, params DestroyFilesystemParams) error
SetFilesystemACL(path string, aclRuleSet ACLRuleSet) error
GetFilesystem(path string) (Filesystem, error)
GetFilesystemAvailableCapacity(path string) (int64, error)
GetFilesystems(parent string) ([]Filesystem, error)
GetFilesystemsWithStartingToken(parent string, startingToken string, limit int) ([]Filesystem, string, error)
GetFilesystemsSlice(parent string, limit, offset int) ([]Filesystem, error)
// filesystems - nfs share
CreateNfsShare(params CreateNfsShareParams) error
DeleteNfsShare(path string) error
// filesystems - smb share
CreateSmbShare(params CreateSmbShareParams) error
DeleteSmbShare(path string) error
GetSmbShareName(path string) (string, error)
// snapshots
CreateSnapshot(params CreateSnapshotParams) error
DestroySnapshot(path string) error
GetSnapshot(path string) (Snapshot, error)
GetSnapshots(volumePath string, recursive bool) ([]Snapshot, error)
CloneSnapshot(path string, params CloneSnapshotParams) error
PromoteFilesystem(path string) error
// volumes
CreateVolume(params CreateVolumeParams) error
GetVolume(path string) (Volume, error)
GetVolumes(parent string) ([]Volume, error)
UpdateVolume(path string, params UpdateVolumeParams) error
DestroyVolume(path string, params DestroyVolumeParams) error
GetVolumeGroup(path string) (VolumeGroup, error)
GetVolumesWithStartingToken(parent string, startingToken string, limit int) ([]Volume, string, error)
PromoteVolume(path string) error
// iSCSI
CreateLunMapping(params CreateLunMappingParams) error
GetLunMapping(path string) (LunMapping, error)
GetLunMappings(params GetLunMappingsParams) (lunMappings []LunMapping, err error)
DestroyLunMapping(id string) error
CreateISCSITarget(params CreateISCSITargetParams) error
UpdateISCSITarget(name string, params UpdateISCSITargetParams) error
GetTargetGroups() ([]TargetGroup, error)
GetTargetGroup(name string) (targetGroup TargetGroup, err error)
CreateUpdateTargetGroup(params CreateTargetGroupParams) error
CreateHostGroup(params CreateHostGroupParams) error
GetHostGroups() ([]nefHostGroup, error)
UpdateHostGroup(path string, params UpdateHostGroupParams) error
GetRemoteInitiator(name string) (remoteInitiator RemoteInitiator, err error)
CreateRemoteInitiator(params CreateRemoteInitiatorParams) error
UpdateRemoteInitiator(name string, params UpdateRemoteInitiatorParams) error
}ProviderInterface - NexentaStor provider interface
func NewProvider(args ProviderArgs) (ProviderInterface, error)NewProvider creates NexentaStor provider instance
type RSFCluster struct {
Name string `json:"clusterName"`
}RSFCluster - RSF cluster with a name
type RemoteInitiator struct {
Name string `json:"name"`
ChapUser string `json:"chapUser"`
ChapSecretSet bool `json:"chapSecretSet"`
}RemoteInitiator - NexentaStor remote initiator for CHAP access
type Resolver struct {
Nodes []ProviderInterface
Log *logrus.Entry
}Resolver - NexentaStor cluster API provider
func NewResolver(args ResolverArgs) (*Resolver, error)NewResolver creates NexentaStor resolver instance based on configuration
func (r *Resolver) IsCluster() (bool, error)IsCluster checks if nodes is a NS cluster For now it simple checks if all nodes return at least one similar cluster name
func (r *Resolver) Resolve(path string) (ProviderInterface, error)Resolve returns one NS from the list of NSs by provided pool/dataset/fs path
func (r *Resolver) ResolveFromVg(path string) (ProviderInterface, error)Resolve returns one NS from the list of NSs by provided pool/volumeGroup path
type ResolverArgs struct {
Address string
Username string
Password string
Log *logrus.Entry
// InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name.
InsecureSkipVerify bool
}ResolverArgs - params to create resolver instance from config
type Snapshot struct {
Path string `json:"path"`
Name string `json:"name"`
Parent string `json:"parent"`
Clones []string `json:"clones"`
CreationTxg string `json:"creationTxg"`
CreationTime time.Time `json:"creationTime"`
}Snapshot - NexentaStor snapshot
func (snapshot *Snapshot) String() stringtype TargetGroup struct {
Name string `json:"name"`
Members []string `json:"members"`
}type UpdateFilesystemParams struct {
// filesystem referenced quota size in bytes
ReferencedQuotaSize int64 `json:"referencedQuotaSize,omitempty"`
}UpdateFilesystemParams - params to update filesystem
type UpdateHostGroupParams struct {
// list of IQNs for the hostGroup
Members []string `json:"members"`
}UpdateHostGroupParams - params to update a hostGroup
type UpdateISCSITargetParams struct {
Authentication string `json:"authentication"`
}UpdateISCSITargetParams - params to update existing iSCSI target
type UpdateRemoteInitiatorParams struct {
ChapUser string `json:"chapUser"`
ChapSecret string `json:"chapSecret"`
}UpdateRemoteInitiatorParams - params to update credentials for remote initiator
type UpdateTargetGroupParams struct {
Members []string `json:"members"`
}UpdateTargetGroupParams - params to update existing target group
type UpdateVolumeParams struct {
// volume referenced quota size in bytes
VolumeSize int64 `json:"volumeSize,omitempty"`
}UpdateVolumeParams - params to update volume
type Volume struct {
Path string `json:"path"`
BytesAvailable int64 `json:"bytesAvailable"`
BytesUsed int64 `json:"bytesUsed"`
VolumeSize int64 `json:"volumeSize"`
}Volume - NexentaStor volume
type VolumeGroup struct {
Path string `json:"path"`
BytesAvailable int64 `json:"bytesAvailable"`
BytesUsed int64 `json:"bytesUsed"`
}VolumeGroup - NexentaStor volumeGroup