The cinder.volume.drivers.zfssa.zfssarest Module

ZFS Storage Appliance Proxy

class ZFSSAApi

Bases: object

ZFSSA API proxy class

add_to_initiatorgroup(initiator, initiatorgroup)

Add an iSCSI initiator to initiatorgroup

add_to_targetgroup(iqn, targetgroup)

Add an iSCSI target to targetgroup.

clone_snapshot(pool, project, lun, snapshot, clone)

clone snapshot.

create_initiator(initiator, alias, chapuser=None, chapsecret=None)

Create an iSCSI initiator.

create_lun(pool, project, lun, volsize, targetgroup, specs)

Create a LUN. specs - contains volume properties (e.g blocksize, compression).

create_project(pool, project, compression=None, logbias=None)

Create a project on a pool Check first whether the pool exists.

create_snapshot(pool, project, lun, snapshot)

create snapshot.

create_target(alias, interfaces=None, tchapuser=None, tchapsecret=None)

Create an iSCSI target. interfaces: an array with network interfaces tchapuser, tchapsecret: target’s chapuser and chapsecret returns target iqn

delete_lun(pool, project, lun)

delete iscsi lun.

delete_snapshot(pool, project, lun, snapshot)

delete snapshot.

get_initiator_initiatorgroup(initiator)

Returns the initiator group of the initiator.

get_lun(pool, project, lun)

return iscsi lun properties.

get_pool_stats(pool)

Get space available and total properties of a pool returns (avail, total).

get_target(alias)

Get an iSCSI target iqn.

has_clones(pool, project, lun, snapshot)

Checks whether snapshot has clones or not.

login(auth_str)

Login to the appliance

set_host(host, timeout=None)
set_lun_initiatorgroup(pool, project, lun, initiatorgroup)

Set the initiatorgroup property of a LUN.

set_lun_props(pool, project, lun, **kargs)

set lun properties.

verify_initiator(iqn)

Check whether initiator iqn exists.

verify_pool(pool)

Checks whether pool exists.

verify_project(pool, project)

Checks whether project exists.

verify_target(alias)

Check whether target alias exists.

class ZFSSANfsApi(*args, **kwargs)

Bases: cinder.volume.drivers.zfssa.zfssarest.ZFSSAApi

ZFSSA API proxy class for NFS driver

create_share(pool, project, share, args)

Create a share in the specified pool and project

create_snapshot(pool, project, share, snapshot)

create snapshot of a share

create_snapshot_of_volume_file(src_file='', dst_file='')
create_volume_from_snapshot_file(src_file='', dst_file='', method='COPY')
delete_snapshot(pool, project, share, snapshot)

delete snapshot of a share

delete_snapshot_of_volume_file(src_file='')
disable_service(service)
enable_service(service)
get_share(pool, project, share)

return share properties

modify_service(service, edit_args=None)

Edit service properties

project_path = '/api/storage/v1/pools/%s/projects/%s'
projects_path = '/api/storage/v1/pools/%s/projects'
services_path = '/api/service/v1/services/'
set_webdav(https_path, auth_str)
share_path = '/api/storage/v1/pools/%s/projects/%s/filesystems/%s'
share_snapshot_path = '/api/storage/v1/pools/%s/projects/%s/filesystems/%s/snapshots/%s'
share_snapshots_path = '/api/storage/v1/pools/%s/projects/%s/filesystems/%s/snapshots'
shares_path = '/api/storage/v1/pools/%s/projects/%s/filesystems'
verify_service(service, status='online')

Checks whether a service is online or not

verify_share(pool, project, share)

Checks whether the share exists

Previous topic

The cinder.volume.drivers.zfssa.zfssanfs Module

Next topic

The cinder.volume.flows.api.create_volume Module

This Page