Skip to content

snapshot.md

Latest commit

 

History

History
144 lines (102 loc) · 2.67 KB

snapshot.md

File metadata and controls

144 lines (102 loc) · 2.67 KB

glustercli.cli.snapshot

activate

activate(snapname, force=False)

Activate Snapshot

:param snapname: Snapshot Name :param force: True|False Force Activate the snapshot :returns: Output of the command, raises GlusterCmdException((rc, out, err)) on error

clone

clone(clonename, snapname)

Clone the Snapshot

:param clonename: Snapshot Clone Name :param snapname: Snapshot Name :returns: Output of the command, raises GlusterCmdException((rc, out, err)) on error

create

create(volname,
       snapname,
       no_timestamp=False,
       description='',
       force=False)

Create Snapshot

:param volname: Volume Name :param snapname: Snapshot Name :param no_timestamp: True|False Do not add Timestamp to name :param description: Description for Created Snapshot :param force: True|False Force Create the snapshot :returns: Output of the command, raises GlusterCmdException((rc, out, err)) on error

deactivate

deactivate(snapname)

Deactivate the Snapshot

:param snapname: Snapshot Name :returns: Output of the command, raises GlusterCmdException((rc, out, err)) on error

delete

delete(snapname=None, volname=None)

Delete Snapshot

:param snapname: Snapshot Name :param volname: Volume Name :returns: Output of the command, raises GlusterCmdException((rc, out, err)) on error

info

info(snapname=None, volname=None)

Snapshot Info

:param snapname: Snapshot Name :param volname: Volume Name :returns: Snapshot Info, raises GlusterCmdException((rc, out, err)) on error

snaplist

snaplist(volname=None)

List of Snapshots

:param volname: Volume Name :returns: Output of the command, raises GlusterCmdException((rc, out, err)) on error

restore

restore(snapname)

Restore Snapshot

:param snapname: Snapshot Name :returns: Output of the command, raises GlusterCmdException((rc, out, err)) on error

status

status(snapname=None, volname=None)

Snapshot Status

:param snapname: Snapshot Name :param volname: Volume Name :returns: Output of the command, raises GlusterCmdException((rc, out, err)) on error

config

config(volname,
       snap_max_hard_limit=None,
       snap_max_soft_limit=None,
       auto_delete=None,
       activate_on_create=None)

Set Snapshot Config

:param volname: Volume Name :param snap_max_hard_limit: Number of Snapshots hard limit :param snap_max_soft_limit: Number of Snapshots soft limit :param auto_delete: True|False Auto delete old snapshots :param activate_on_create: True|False Activate Snapshot after Create :returns: Output of the command, raises GlusterCmdException((rc, out, err)) on error