Documentation ¶
Index ¶
- Variables
- type ACL
- type Client
- func (c *Client) AddExportClients(ctx context.Context, name string, clients ...string) error
- func (c *Client) AddExportClientsByID(ctx context.Context, id int, clients ...string) error
- func (c *Client) AddExportRootClients(ctx context.Context, name string, clients ...string) error
- func (c *Client) AddExportRootClientsByID(ctx context.Context, id int, clients ...string) error
- func (c *Client) ClearExportClients(ctx context.Context, name string) error
- func (c *Client) ClearExportClientsByID(ctx context.Context, id int) error
- func (c *Client) ClearExportRootClients(ctx context.Context, name string) error
- func (c *Client) ClearExportRootClientsByID(ctx context.Context, id int) error
- func (c *Client) ClearQuota(ctx context.Context, name string) error
- func (c *Client) CopySnapshot(ctx context.Context, sourceID int64, sourceName, destinationName string) (Volume, error)
- func (c *Client) CopyVolume(ctx context.Context, src, dest string) (Volume, error)
- func (c *Client) CreateQuota(ctx context.Context, name string, container bool, size int64) error
- func (c *Client) CreateSnapshot(ctx context.Context, path, name string) (Snapshot, error)
- func (c *Client) CreateVolume(ctx context.Context, name string) (Volume, error)
- func (c *Client) CreateVolumeDir(ctx context.Context, volumeName, dirPath string, fileMode os.FileMode, ...) error
- func (c *Client) CreateVolumeNoACL(ctx context.Context, name string) (Volume, error)
- func (c *Client) DeleteVolume(ctx context.Context, name string) error
- func (c *Client) DisableFailureMapping(ctx context.Context, name string) error
- func (c *Client) DisableFailureMappingByID(ctx context.Context, id int) error
- func (c *Client) DisableNonRootMapping(ctx context.Context, name string) error
- func (c *Client) DisableNonRootMappingByID(ctx context.Context, id int) error
- func (c *Client) DisableRootMapping(ctx context.Context, name string) error
- func (c *Client) DisableRootMappingByID(ctx context.Context, id int) error
- func (c *Client) EnableFailureMapping(ctx context.Context, name, user string) error
- func (c *Client) EnableFailureMappingByID(ctx context.Context, id int, user string) error
- func (c *Client) EnableNonRootMapping(ctx context.Context, name, user string) error
- func (c *Client) EnableNonRootMappingByID(ctx context.Context, id int, user string) error
- func (c *Client) EnableRootMapping(ctx context.Context, name, user string) error
- func (c *Client) EnableRootMappingByID(ctx context.Context, id int, user string) error
- func (c *Client) Export(ctx context.Context, name string) (int, error)
- func (c *Client) ExportVolume(ctx context.Context, name string) (int, error)
- func (c *Client) ExportVolumeWithZone(ctx context.Context, name, zone string) (int, error)
- func (c *Client) ExportWithZone(ctx context.Context, name, zone string) (int, error)
- func (c *Client) ForceDeleteVolume(ctx context.Context, name string) error
- func (c *Client) GetExportByID(ctx context.Context, id int) (Export, error)
- func (c *Client) GetExportByName(ctx context.Context, name string) (Export, error)
- func (c *Client) GetExportByNameWithZone(ctx context.Context, name, zone string) (Export, error)
- func (c *Client) GetExportClients(ctx context.Context, name string) ([]string, error)
- func (c *Client) GetExportClientsByID(ctx context.Context, id int) ([]string, error)
- func (c *Client) GetExportRootClients(ctx context.Context, name string) ([]string, error)
- func (c *Client) GetExportRootClientsByID(ctx context.Context, id int) ([]string, error)
- func (c *Client) GetExports(ctx context.Context) (ExportList, error)
- func (c *Client) GetFailureMapping(ctx context.Context, name string) (UserMapping, error)
- func (c *Client) GetFailureMappingByID(ctx context.Context, id int) (UserMapping, error)
- func (c *Client) GetNonRootMapping(ctx context.Context, name string) (UserMapping, error)
- func (c *Client) GetNonRootMappingByID(ctx context.Context, id int) (UserMapping, error)
- func (c *Client) GetQuota(ctx context.Context, name string) (Quota, error)
- func (c *Client) GetRootMapping(ctx context.Context, name string) (UserMapping, error)
- func (c *Client) GetRootMappingByID(ctx context.Context, id int) (UserMapping, error)
- func (c *Client) GetSnapshot(ctx context.Context, id int64, name string) (Snapshot, error)
- func (c *Client) GetSnapshots(ctx context.Context) (SnapshotList, error)
- func (c *Client) GetSnapshotsByPath(ctx context.Context, path string) (SnapshotList, error)
- func (c *Client) GetVolume(ctx context.Context, id, name string) (Volume, error)
- func (c *Client) GetVolumeACL(ctx context.Context, volumeName string) (ACL, error)
- func (c *Client) GetVolumeExportMap(ctx context.Context, includeRootClients bool) (map[Volume]Export, error)
- func (c *Client) GetVolumes(ctx context.Context) ([]Volume, error)
- func (c *Client) IsExported(ctx context.Context, name string) (bool, int, error)
- func (c *Client) IsExportedWithZone(ctx context.Context, name, zone string) (bool, int, error)
- func (c *Client) QueryVolumeChildren(ctx context.Context, name string) (VolumeChildrenMap, error)
- func (c *Client) RemoveSnapshot(ctx context.Context, id int64, name string) error
- func (c *Client) SetExportClients(ctx context.Context, name string, clients ...string) error
- func (c *Client) SetExportClientsByID(ctx context.Context, id int, clients ...string) error
- func (c *Client) SetExportRootClients(ctx context.Context, name string, clients ...string) error
- func (c *Client) SetExportRootClientsByID(ctx context.Context, id int, clients ...string) error
- func (c *Client) SetQuotaSize(ctx context.Context, name string, size int64) error
- func (c *Client) SetVolumeMode(ctx context.Context, volumeName string, mode int) error
- func (c *Client) SetVolumeOwner(ctx context.Context, volumeName, userName string) error
- func (c *Client) SetVolumeOwnerToCurrentUser(ctx context.Context, volumeName string) error
- func (c *Client) Unexport(ctx context.Context, name string) error
- func (c *Client) UnexportByID(ctx context.Context, id int) error
- func (c *Client) UnexportByIDWithZone(ctx context.Context, id int, zone string) error
- func (c *Client) UnexportVolume(ctx context.Context, name string) error
- func (c *Client) UnexportWithZone(ctx context.Context, name, zone string) error
- func (c *Client) UpdateQuotaSize(ctx context.Context, name string, size int64) error
- type Export
- type ExportList
- type Quota
- type Snapshot
- type SnapshotList
- type UserMapping
- type Volume
- type VolumeChildren
- type VolumeChildrenMap
Constants ¶
This section is empty.
Variables ¶
var ConcurrentHTTPConnections = 2
ConcurrentHTTPConnections is the number of allowed concurrent HTTP connections for API functions that attempt to send multiple API calls at once.
Functions ¶
This section is empty.
Types ¶
type ACL ¶ added in v1.3.0
ACL is an Isilon Access Control List used for managing an object's security.
type Client ¶
Client is an Isilon client.
func NewClientWithArgs ¶
func NewClientWithArgs( ctx context.Context, endpoint string, insecure bool, user, group, pass, volumesPath string) (*Client, error)
NewClientWithArgs returns a new Isilon client struct initialized from the supplied arguments.
func (*Client) AddExportClients ¶ added in v1.1.0
AddExportClients adds to the Export's clients property.
func (*Client) AddExportClientsByID ¶ added in v1.1.0
AddExportClientsByID adds to the Export's clients property.
func (*Client) AddExportRootClients ¶ added in v1.1.0
AddExportRootClients adds to the Export's root_clients property.
func (*Client) AddExportRootClientsByID ¶ added in v1.1.0
AddExportRootClientsByID adds to the Export's root_clients property.
func (*Client) ClearExportClients ¶
ClearExportClients sets the Export's clients property to nil.
func (*Client) ClearExportClientsByID ¶ added in v1.1.0
ClearExportClientsByID sets the Export's clients property to nil.
func (*Client) ClearExportRootClients ¶ added in v1.1.0
ClearExportRootClients sets the Export's root_clients property to nil.
func (*Client) ClearExportRootClientsByID ¶ added in v1.1.0
ClearExportRootClientsByID sets the Export's clients property to nil.
func (*Client) ClearQuota ¶
ClearQuota removes the quota from a volume
func (*Client) CopySnapshot ¶
func (c *Client) CopySnapshot( ctx context.Context, sourceID int64, sourceName, destinationName string) (Volume, error)
CopySnapshot copies all files/directories in a snapshot to a new directory.
func (*Client) CopyVolume ¶
CopyVolume creates a volume based on an existing volume
func (*Client) CreateQuota ¶ added in v1.7.3
CreateQuota creates a new hard directory quota with the specified size and container option
func (*Client) CreateSnapshot ¶
CreateSnapshot creates a snapshot called name of the given path.
func (*Client) CreateVolume ¶
CreateVolume creates a volume
func (*Client) CreateVolumeDir ¶ added in v1.4.0
func (c *Client) CreateVolumeDir( ctx context.Context, volumeName, dirPath string, fileMode os.FileMode, overwrite, recursive bool) error
CreateVolumeDir creates a directory inside a volume.
func (*Client) CreateVolumeNoACL ¶ added in v1.7.5
CreateVolume creates a volume
func (*Client) DeleteVolume ¶
DeleteVolume deletes a volume
func (*Client) DisableFailureMapping ¶ added in v1.2.0
DisableFailureMapping disables the map_failure mapping for an Export.
func (*Client) DisableFailureMappingByID ¶ added in v1.2.0
DisableFailureMappingByID disables the map_failure mapping for an Export.
func (*Client) DisableNonRootMapping ¶ added in v1.2.0
DisableNonRootMapping disables the map_non_root mapping for an Export.
func (*Client) DisableNonRootMappingByID ¶ added in v1.2.0
DisableNonRootMappingByID disables the map_non_root mapping for an Export.
func (*Client) DisableRootMapping ¶ added in v1.1.0
DisableRootMapping disables the root mapping for an Export.
func (*Client) DisableRootMappingByID ¶ added in v1.1.0
DisableRootMappingByID disables the root mapping for an Export.
func (*Client) EnableFailureMapping ¶ added in v1.2.0
EnableFailureMapping enables the map_failure mapping for an Export.
func (*Client) EnableFailureMappingByID ¶ added in v1.2.0
EnableFailureMappingByID enables the map_failure mapping for an Export.
func (*Client) EnableNonRootMapping ¶ added in v1.2.0
EnableNonRootMapping enables the map_non_root mapping for an Export.
func (*Client) EnableNonRootMappingByID ¶ added in v1.2.0
EnableNonRootMappingByID enables the map_non_root mapping for an Export.
func (*Client) EnableRootMapping ¶ added in v1.1.0
EnableRootMapping enables the root mapping for an Export.
func (*Client) EnableRootMappingByID ¶ added in v1.1.0
EnableRootMappingByID enables the root mapping for an Export.
func (*Client) ExportVolume ¶
ExportVolume exports a volume
func (*Client) ExportVolumeWithZone ¶ added in v1.7.2
ExportVolumeWithZone exports a volume in the specified access zone
func (*Client) ExportWithZone ¶ added in v1.7.2
ExportWithZone exports the volume with a given name and zone on the cluster
func (*Client) ForceDeleteVolume ¶ added in v1.4.0
ForceDeleteVolume force deletes a volume by resetting the ownership of all descendent directories to the current user prior to issuing a delete call.
func (*Client) GetExportByID ¶ added in v1.1.0
GetExportByID returns an export with the provided ID.
func (*Client) GetExportByName ¶ added in v1.1.0
GetExportByName returns the first export with a path for the provided volume name.
func (*Client) GetExportByNameWithZone ¶ added in v1.7.4
GetExportByNameWithZone returns the first export with a path for the provided volume name in the given zone.
func (*Client) GetExportClients ¶
GetExportClients returns an Export's clients property.
func (*Client) GetExportClientsByID ¶ added in v1.1.0
GetExportClientsByID returns an Export's clients property.
func (*Client) GetExportRootClients ¶ added in v1.1.0
GetExportRootClients returns an Export's root_clients property.
func (*Client) GetExportRootClientsByID ¶ added in v1.1.0
GetExportRootClientsByID returns an Export's clients property.
func (*Client) GetExports ¶ added in v1.1.0
func (c *Client) GetExports(ctx context.Context) (ExportList, error)
GetExports returns a list of all exports on the cluster
func (*Client) GetFailureMapping ¶ added in v1.2.0
GetFailureMapping returns the map_failure mapping for an Export.
func (*Client) GetFailureMappingByID ¶ added in v1.2.0
GetFailureMappingByID returns the map_failure mapping for an Export.
func (*Client) GetNonRootMapping ¶ added in v1.2.0
GetNonRootMapping returns the map_non_root mapping for an Export.
func (*Client) GetNonRootMappingByID ¶ added in v1.2.0
GetNonRootMappingByID returns the map_non_root mapping for an Export.
func (*Client) GetRootMapping ¶ added in v1.1.0
GetRootMapping returns the root mapping for an Export.
func (*Client) GetRootMappingByID ¶ added in v1.1.0
GetRootMappingByID returns the root mapping for an Export.
func (*Client) GetSnapshot ¶
GetSnapshot returns a snapshot matching id, or if that is not found, matching name
func (*Client) GetSnapshots ¶
func (c *Client) GetSnapshots(ctx context.Context) (SnapshotList, error)
GetSnapshots returns a list of snapshots from the cluster.
func (*Client) GetSnapshotsByPath ¶
GetSnapshotsByPath returns a list of snapshots covering the supplied path.
func (*Client) GetVolumeACL ¶ added in v1.3.0
GetVolumeACL returns the ACL for a volume.
func (*Client) GetVolumeExportMap ¶ added in v1.2.0
func (c *Client) GetVolumeExportMap( ctx context.Context, includeRootClients bool) (map[Volume]Export, error)
GetVolumeExportMap returns a map that relates Volumes to their corresponding Exports. This function uses an Export's "clients" property to define the relationship. The flag "includeRootClients" can be set to "true" in order to also inspect the "root_clients" property of an Export when determining the Volume-to-Export relationship.
func (*Client) GetVolumes ¶
GetVolumes returns a list of volumes
func (*Client) IsExported ¶ added in v1.1.0
IsExported returns a flag and export ID if the provided volume name is already exported.
func (*Client) IsExportedWithZone ¶ added in v1.7.4
IsExportedWithZone returns a flag and export ID if the provided volume name in the specified zone isalready exported.
func (*Client) QueryVolumeChildren ¶ added in v1.4.0
QueryVolumeChildren retrieves a list of all of a volume's descendent files and directories.
func (*Client) RemoveSnapshot ¶
RemoveSnapshot removes the snapshot by id, or failing that, the snapshot matching name.
func (*Client) SetExportClients ¶
SetExportClients sets the Export's clients property.
func (*Client) SetExportClientsByID ¶ added in v1.1.0
SetExportClientsByID sets the Export's clients property.
func (*Client) SetExportRootClients ¶ added in v1.1.0
SetExportRootClients sets the Export's root_clients property.
func (*Client) SetExportRootClientsByID ¶ added in v1.1.0
SetExportRootClientsByID sets the Export's clients property.
func (*Client) SetQuotaSize ¶
SetQuotaSize sets the max size (hard threshold) of a quota for a volume
func (*Client) SetVolumeMode ¶ added in v1.7.7
SetVolumeMode sets the permissions to the specified mode (chmod)
func (*Client) SetVolumeOwner ¶ added in v1.3.0
SetVolumeOwner sets the owner for a volume.
func (*Client) SetVolumeOwnerToCurrentUser ¶ added in v1.3.0
SetVolumeOwnerToCurrentUser sets the owner for a volume to the user that was used to connect to the API.
func (*Client) UnexportByID ¶ added in v1.1.0
UnexportByID unexports an Export by its ID.
func (*Client) UnexportByIDWithZone ¶ added in v1.7.4
UnexportByIDWithZone unexports an Export by its ID and zone.
func (*Client) UnexportVolume ¶
UnexportVolume stops exporting a volume
func (*Client) UnexportWithZone ¶ added in v1.7.4
UnexportWithZone stops exporting a given volume in the given from the cluster.
type SnapshotList ¶
type SnapshotList []*api.IsiSnapshot
SnapshotList represents a list of Isilon snapshots.
type UserMapping ¶ added in v1.1.0
type UserMapping *api.UserMapping
UserMapping maps to the ISI <user-mapping> type.
type VolumeChildren ¶ added in v1.4.0
type VolumeChildren apiv2.ContainerChildList
VolumeChildren is a list of a container's children.
type VolumeChildrenMap ¶ added in v1.4.0
type VolumeChildrenMap map[string]*apiv2.ContainerChild
VolumeChildrenMap returns a map of all descendent children of a container, where the key is the path.