Skip to main content

A simple script to create and manage virtual ZFS images on OS X withoutrequiring repartitioning

Project description

Introduction

Test Status Code Health Requirements Status

A simple script to create and manage virtual ZFS images on OS X without requiring repartitioning

Install

To install simply run pip install zfs-utils-osx.

Example usage

To create a pool (does a dry-run with the -n flag):

zfs.py zpool -n <pool_name>

Usage:

usage: zfs.py [-h] {zpool} ...

optional arguments:
  -h, --help  show this help message and exit

Subcommands:
  Please specify one of the following subcommands

  {zpool,load}
    zpool     zpool creation
    load        load (import) the zpools

Zpool create usage:

usage: zfs.py zpool [-h] [-c COUNT] [-s SIZE]
                    [-t {raidz1,raidz2,raidz3,mirror,raidz}] [-n]
                    [-m MOUNTPOINT] [-o] [-p PATTERN]
                    pool_name

positional arguments:
  pool_name             The name of the pool to create

optional arguments:
  -h, --help            show this help message and exit
  -c COUNT, --count COUNT
                        The amount of images to use (default: 3)
  -s SIZE, --size SIZE  The usable size of the zpool in GiB (default: 10GiB)
  -t {raidz1,raidz2,raidz3,mirror,raidz}, --type {raidz1,raidz2,raidz3,mirror,raidz}
                        The zpool type to use (default: raidz)
  -n, --no-op, --dry-run
                        Show what will be done but dont execute
  -m MOUNTPOINT, --mountpoint MOUNTPOINT
                        Where should the disk be mounted (default:
                        ~/%(pool_name)s
  -o, --overwrite       Overwrite old images if they exist
  -p PATTERN, --pattern PATTERN
                        File name pattern to store the images (default:
                        %(pool_name)s_%(i)02d)

Zpool import usage:

usage: zfs.py load [-h] [-d IMAGE_DIRECTORY] [-p PREFIX] [--postfix POSTFIX]
                   [-n]
                   pool_names [pool_names ...]

positional arguments:
  pool_names            The name of the pool to import

optional arguments:
  -h, --help            show this help message and exit
  -d IMAGE_DIRECTORY, --image-directory IMAGE_DIRECTORY
                        File name pattern to store the images (default:
                        ~/zfs/)
  -p PREFIX, --prefix PREFIX
                        File name prefix for the images (default:
                        %(pool_name)s_)
  --postfix POSTFIX     File name postfix for the images (default: )
  -n, --no-op, --dry-run
                        Show what will be done but dont execute

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zfs-utils-osx-1.1.0.tar.gz (4.7 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page