Current File : //lib/python2.7/site-packages/salt/states/zfs.pyo
�
���^c @@ s� d Z d d l m Z m Z m Z d d l Z d d l m Z d d l m Z e j e
� Z d Z i d d 6Z
i d d 6d d 6Z i d d 6d d 6d d
6Z i d d 6d d 6d d
6d d 6Z d � Z e e d
� Z e e d � Z e e d � Z e e d � Z e e d � Z e d � Z e d � Z d e e d d d � Z e d d d � Z e e d d d � Z d � Z e d d � Z d � Z d � Z! d � Z" e# d d � Z$ d S( u�
States for managing zfs datasets
:maintainer: Jorge Schrauwen <sjorge@blackdot.be>
:maturity: new
:depends: salt.utils.zfs, salt.modules.zfs
:platform: smartos, illumos, solaris, freebsd, linux
.. versionadded:: 2016.3.0
.. versionchanged:: 2018.3.1
Big refactor to remove duplicate code, better type converions and improved
consistancy in output.
.. code-block:: yaml
test/shares/yuki:
zfs.filesystem_present:
- create_parent: true
- properties:
quota: 16G
test/iscsi/haruhi:
zfs.volume_present:
- create_parent: true
- volume_size: 16M
- sparse: true
- properties:
readonly: on
test/shares/yuki@frozen:
zfs.snapshot_present
moka_origin:
zfs.hold_present:
- snapshot: test/shares/yuki@frozen
test/shares/moka:
zfs.filesystem_present:
- cloned_from: test/shares/yuki@frozen
test/shares/moka@tsukune:
zfs.snapshot_absent
i ( t absolute_importt unicode_literalst print_functionN( t datetime( t OrderedDictu zfsu minuteu houri u dayu monthc C@ s t j d � s t d f St S( u
Provides zfs state
u zfs_supportu1 The zfs state cannot be loaded: zfs not supported( t
__grains__t gett Falset __virtualname__( ( ( s3 /usr/lib/python2.7/site-packages/salt/states/zfs.pyt __virtual__C s
c C@ sF i | d 6i d 6t d 6d d 6} | j � } t j d | | | � t j d | | | � t d | i | d 6� r,t d
s� t d | i | d 6| d
6� } n t d t f g � } | d | d <| d r� d | d | <d j | | � | d <qBd j | | � | d <d | k rB| d | d <qBn d j | | � | d <| S( uE
internal shared function for *_absent
name : string
name of dataset
dataset_type : string [filesystem, volume, snapshot, or bookmark]
type of dataset to remove
force : boolean
try harder to destroy the dataset
recursive : boolean
also destroy all the child datasets
u nameu changesu resultu u commentu% zfs.%s_absent::%s::config::force = %su) zfs.%s_absent::%s::config::recursive = %su
zfs.existsu typeu testu zfs.destroyu forceu recursiveu destroyedu {0} {1} was destroyedu failed to destroy {0} {1}u erroru {0} {1} is absent( t Truet lowert logt debugt __salt__t __opts__R t format( t namet dataset_typet forcet recursivet rett mod_res( ( s3 /usr/lib/python2.7/site-packages/salt/states/zfs.pyt _absentL s8
$
c C@ sW t d | � s> i | d 6i d 6t d 6d j | � d 6} n t | d | | � } | S( u�
ensure filesystem is absent on the system
name : string
name of filesystem
force : boolean
try harder to destroy the dataset (zfs destroy -f)
recursive : boolean
also destroy all the child datasets (zfs destroy -r)
.. warning::
If a volume with ``name`` exists, this state will succeed without
destroying the volume specified by ``name``. This module is dataset type sensitive.
u zfs.is_datasetu nameu changesu resultu invalid dataset name: {0}u commentu
filesystem( t __utils__R R R ( R R R R ( ( s3 /usr/lib/python2.7/site-packages/salt/states/zfs.pyt filesystem_absent� s
c C@ sW t d | � s> i | d 6i d 6t d 6d j | � d 6} n t | d | | � } | S( u�
ensure volume is absent on the system
name : string
name of volume
force : boolean
try harder to destroy the dataset (zfs destroy -f)
recursive : boolean
also destroy all the child datasets (zfs destroy -r)
.. warning::
If a filesystem with ``name`` exists, this state will succeed without
destroying the filesystem specified by ``name``. This module is dataset type sensitive.
u zfs.is_datasetu nameu changesu resultu invalid dataset name: {0}u commentu volume( R R R R ( R R R R ( ( s3 /usr/lib/python2.7/site-packages/salt/states/zfs.pyt
volume_absent� s
c C@ sW t d | � s> i | d 6i d 6t d 6d j | � d 6} n t | d | | � } | S( u
ensure snapshot is absent on the system
name : string
name of snapshot
force : boolean
try harder to destroy the dataset (zfs destroy -f)
recursive : boolean
also destroy all the child datasets (zfs destroy -r)
u zfs.is_snapshotu nameu changesu resultu invalid snapshot name: {0}u commentu snapshot( R R R R ( R R R R ( ( s3 /usr/lib/python2.7/site-packages/salt/states/zfs.pyt snapshot_absent� s
c C@ sW t d | � s> i | d 6i d 6t d 6d j | � d 6} n t | d | | � } | S( u
ensure bookmark is absent on the system
name : string
name of snapshot
force : boolean
try harder to destroy the dataset (zfs destroy -f)
recursive : boolean
also destroy all the child datasets (zfs destroy -r)
u zfs.is_bookmarku nameu changesu resultu invalid bookmark name: {0}u commentu bookmark( R R R R ( R R R R ( ( s3 /usr/lib/python2.7/site-packages/salt/states/zfs.pyt bookmark_absent� s
c C@ s� i | d 6i d 6t d 6d d 6} t j d | | � t j d | | � t d | � sy t | d <d j | � | d <| St d | � s� t d
| � s� | d k r� t | d <d j | � | d <| St d
| � } | | k r�t d s t d | | i | d 6� } n t d t f g � } | d | d <| d rgi i d | 6| 6| d <d j | � | d <q�d j | � | d <d | k r�| d | d <q�n: d | k r�t | d <| d | d <n d j | � | d <| S( u
ensure hold is absent on the system
name : string
name of hold
snapshot : string
name of snapshot
recursive : boolean
recursively releases a hold with the given tag on the snapshots of all descendent file systems.
u nameu changesu resultu u commentu* zfs.hold_absent::%s::config::snapshot = %su+ zfs.hold_absent::%s::config::recursive = %su zfs.is_snapshotu invalid snapshot name: {0}u zfs.is_bookmarku erroru invalid tag name: {0}u zfs.holdsu testu zfs.releaseu recursiveu releasedu hold {0} releasedu failed to release hold {0}u hold {0} is absent( R
R R
R R R R R R ( R t snapshotR R t holdsR ( ( s3 /usr/lib/python2.7/site-packages/salt/states/zfs.pyt hold_absent� sL
c C@ s� i | d 6i d 6t d 6d d 6} t j d | | � t j d | | � t d | � sy t | d <d j | � | d <| St d | � s� t d
| � s� | d k r� t | d <d j | � | d <| St d
| � } | | k r� d j | | � | d <n� t d s%t d | | i | d 6� } n t d t f g � } | d | d <| d r�t | t | d f g � f g � | d <d j | | � | d <n3 d j | | � | d <d | k r�| d | d <n | S( u
ensure hold is present on the system
name : string
name of holdt
snapshot : string
name of snapshot
recursive : boolean
recursively add hold with the given tag on the snapshots of all descendent file systems.
u nameu changesu resultu u commentu+ zfs.hold_present::%s::config::snapshot = %su, zfs.hold_present::%s::config::recursive = %su zfs.is_snapshotu invalid snapshot name: {0}u zfs.is_bookmarku erroru invalid tag name: {0}u zfs.holdsu hold {0} is present for {1}u testu zfs.holdu recursiveu heldu hold {0} added to {1}u failed to add hold {0} to {1}( R
R R
R R R R R R ( R R R R R R ( ( s3 /usr/lib/python2.7/site-packages/salt/states/zfs.pyt hold_present. sP
c
C@ s� i | d 6i d 6t d 6d d 6} | d2 k r7 d } n | rP t d | � } n | ri t d | � } n | d3 k r~ i } n t j d
| | | � t j d | | | � t j d | | | � t j d
| | | � t j d | | | � t d | � s t | d <d j | � | d <| S| rUt d | � rUt | d <d j | � | d <| St d | i | d 6� ret d | d | d d d d d t �j | t � � } | r�| | d <n g } x^ | D]V }
|
| k r�t j
d | | |
� q�n | |
d | |
k r�| j |
� q�q�Wx� | D]� }
t d sXt d | i | |
|
6� } n t d t f g � } | d r�| | d k r�i | d | <n | |
| d | |
<q't | d <| d d k r�d! | d <n d" j | d |
� | d <q'W| d r)| | d k r)d# j | | � | d <q�| d rLd$ j | | � | d <q�d% j | | � | d <n6| rqd& n d' } t d r�t | t f g � } no | r�| r�| | d <n t d( | | i | d) 6| d* 6� } n/ t d+ | i | d) 6| d* 6| d, 6| d- 6� } | | | d <| d ra| | d | <| rE| | d | <n d. j | | | � | d <n: d/ j | d0 | | � | d <d1 | k r�| d1 | d <n | S(4 uT
internal handler for filesystem_present/volume_present
dataset_type : string
volume or filesystem
name : string
name of volume
volume_size : string
size of volume
sparse : boolean
create sparse volume
create_parent : boolean
creates all the non-existing parent datasets.
any property specified on the command line using the -o option is ignored.
cloned_from : string
name of snapshot to clone
properties : dict
additional zfs properties (-o)
.. note::
``cloned_from`` is only use if the volume does not exist yet,
when ``cloned_from`` is set after the volume exists it will be ignored.
.. note::
Properties do not get cloned, if you specify the properties in the state file
they will be applied on a subsequent run.
``volume_size`` is considered a property, so the volume's size will be
corrected when the properties get updated if it differs from the
original volume.
The sparse parameter is ignored when using ``cloned_from``.
u nameu changesu resultu u commentu
filesystemu volumeu
zfs.from_sizeu zfs.from_auto_dictu, zfs.%s_present::%s::config::volume_size = %su' zfs.%s_present::%s::config::sparse = %su. zfs.%s_present::%s::config::create_parent = %su, zfs.%s_present::%s::config::cloned_from = %su+ zfs.%s_present::%s::config::properties = %su zfs.is_datasetu invalid dataset name: {0}u zfs.is_snapshotu {0} is not a snapshotu
zfs.existsu typeu zfs.gett typet fieldsu valuet depthi t parsableu volsizeu1 zfs.%s_present::%s::update - unknown property: %su testu zfs.setu setu* The following properties were not updated:u {0} {1}u {0} {1} was updatedu {0} {1} is uptodateu {0} {1} failed to be updatedu clonedu createdu zfs.cloneu
create_parentu
propertiesu
zfs.createu volume_sizeu sparseu {0} {1} was {2}u failed to {0} {1} {2}i����u error( u
filesystemu volumeN(
R
R t NoneR R
R R R R R t warningt appendR (
R R t volume_sizet sparset
create_parentt
propertiest cloned_fromR t properties_currentt properties_updatet propR t mod_res_action( ( s3 /usr/lib/python2.7/site-packages/salt/states/zfs.pyt _dataset_presentw s� #
!
c C@ s t d | d | d | d | �S( u�
ensure filesystem exists and has properties set
name : string
name of filesystem
create_parent : boolean
creates all the non-existing parent datasets.
any property specified on the command line using the -o option is ignored.
cloned_from : string
name of snapshot to clone
properties : dict
additional zfs properties (-o)
.. note::
``cloned_from`` is only use if the filesystem does not exist yet,
when ``cloned_from`` is set after the filesystem exists it will be ignored.
.. note::
Properties do not get cloned, if you specify the properties in the
state file they will be applied on a subsequent run.
u
filesystemR* R+ R, ( R1 ( R R* R+ R, ( ( s3 /usr/lib/python2.7/site-packages/salt/states/zfs.pyt filesystem_present) s c C@ s( t d | | d | d | d | d | �S( u
ensure volume exists and has properties set
name : string
name of volume
volume_size : string
size of volume
sparse : boolean
create sparse volume
create_parent : boolean
creates all the non-existing parent datasets.
any property specified on the command line using the -o option is ignored.
cloned_from : string
name of snapshot to clone
properties : dict
additional zfs properties (-o)
.. note::
``cloned_from`` is only use if the volume does not exist yet,
when ``cloned_from`` is set after the volume exists it will be ignored.
.. note::
Properties do not get cloned, if you specify the properties in the state file
they will be applied on a subsequent run.
``volume_size`` is considered a property, so the volume's size will be
corrected when the properties get updated if it differs from the
original volume.
The sparse parameter is ignored when using ``cloned_from``.
u volumeR) R* R+ R, ( R1 ( R R( R) R* R+ R, ( ( s3 /usr/lib/python2.7/site-packages/salt/states/zfs.pyt volume_presentI s !c C@ s� i | d 6i d 6t d 6d d 6} t j d | | � t d | � sf t | d <d j | � | d <| Sd | k r� d
| k r� d j | | j d � | � } | | d <n t d
| � s� t | d <d j | � | d <| St d | i d d 6� s�t d st d | | � } n t d t f g � } | d | d <| d ri| | d | <d j | | � | d <q�d j | � | d <d | k r�| d | d <q�n
d | d <| S( u|
ensure bookmark exists
name : string
name of bookmark
snapshot : string
name of snapshot
u nameu changesu resultu u commentu/ zfs.bookmark_present::%s::config::snapshot = %su zfs.is_snapshotu invalid snapshot name: {0}u #u /u {0}#{1}u @u zfs.is_bookmarku invalid bookmark name: {0}u
zfs.existsu bookmarku typeu testu zfs.bookmarku
bookmarkedu {0} bookmarked as {1}u failed to bookmark {0}u erroru bookmark is present(
R
R R
R R R t indexR R R ( R R R R ( ( s3 /usr/lib/python2.7/site-packages/salt/states/zfs.pyt bookmark_presentu s<
c C@ s� i | d 6i d 6t d 6d d 6} t j d | | � t j d | | � | ra t d | � } n t d | � s� t | d <d
j | � | d <| St d | i d d
6� sut d s� t d | i | d 6| d 6� } n t d t f g � } | d | d <| d rBd | d | <| r,| | d | <n d j | � | d <qd j | � | d <d | k r| d | d <qn
d | d <| S( u8
ensure snapshot exists and has properties set
name : string
name of snapshot
recursive : boolean
recursively create snapshots of all descendent datasets
properties : dict
additional zfs properties (-o)
.. note:
Properties are only set at creation time
u nameu changesu resultu u commentu0 zfs.snapshot_present::%s::config::recursive = %su1 zfs.snapshot_present::%s::config::properties = %su zfs.from_auto_dictu zfs.is_snapshotu invalid snapshot name: {0}u
zfs.existsu snapshotu typeu testu zfs.snapshotu recursiveu
propertiesu snapshottedu snapshot {0} was createdu failed to create snapshot {0}u erroru snapshot is present( R
R R
R R R R R R ( R R R+ R R ( ( s3 /usr/lib/python2.7/site-packages/salt/states/zfs.pyt snapshot_present� s:
$
c C@ s i | d 6i d 6t d 6d d 6} t d | � sS t | d <d j | � | d <| St d | i d d
6� s� t | d <d j | � | d <n� t d | i d
d 6d d 6t d 6� | d
d d k r� d j | � | d <n� t d s� t d | � } n t d t f g � } | d | d <| d rKd | d | <d j | � | d <n0 d j | � | d <d | k r{| d | d <n | S( u�
ensure a dataset is not a clone
name : string
name of fileset or volume
.. warning::
only one dataset can be the origin,
if you promote a clone the original will now point to the promoted dataset
u nameu changesu resultu u commentu zfs.is_datasetu invalid dataset name: {0}u
zfs.existsu filesystem,volumeu typeu dataset {0} does not existu zfs.getu originu
propertiesu valueu fieldsu parsableu -u {0} already promotedu testu zfs.promoteu promotedu {0} promotedu failed to promote {0}u error( R
R R R R R R ( R R R ( ( s3 /usr/lib/python2.7/site-packages/salt/states/zfs.pyt promoted� s0
:
c C@ s� x� t t d | i t d 6d d 6d d 6� j � � D]� } | | j d � d } | j d j | � � sp q5 n t d | � } | s� | d
j | � n x8 | D]0 } | | d j � k r� | | j | � q� q� Wq5 W| S( uA
Update snapshots dict with current snapshots
dataset: string
name of filesystem or volume
prefix : string
prefix for the snapshots
e.g. 'test' will result in snapshots being named 'test-yyyymmdd_hhmm'
snapshots : OrderedDict
preseeded OrderedDict with configuration
u zfs.listu recursivei u depthu snapshotu typeu @u {0}-u zfs.holdsu _prunableu _schedule( t sortedR R
t keysR4 t
startswithR R' ( t datasett prefixt snapshotst snapt snap_namet
snap_holdst hold( ( s3 /usr/lib/python2.7/site-packages/salt/states/zfs.pyt _schedule_snapshot_retrieve# s ;
c C@ s� d j d | d | d t j � j d � � } t j � j d d d d � } g | d | <xh| d
j � D]V\ } } | d k r� qj n | | r�t j | | d d j | | � � j d d d d � } | d
k r� | | k r� qj q�| d k r| j t � | j t � k rqj q�| d k rH| j t � | j t � k rHqj q�| d k rx| j t � | j t � k rxqj q�| d k r�| j t
� | j t
� k r�qj q�n | d | j | � qj W| S( uG
Update snapshots dict with info for a new snapshot
dataset: string
name of filesystem or volume
prefix : string
prefix for the snapshots
e.g. 'test' will result in snapshots being named 'test-yyyymmdd_hhmm'
snapshots : OrderedDict
preseeded OrderedDict with configuration
u {dataset}@{prefix}-{timestamp}R; R< t timestampu
%Y%m%d_%H%M%St secondi t microsecondu _createu _schedulei����u {0}@{1}-%Y%m%d_%H%M%Su minuteu houru dayu monthu year( R R t nowt strftimet replacet itemst strptimet comp_hourt comp_dayt
comp_montht comp_yearR' ( R; R< R= t snapshot_create_namet
timestamp_nowRA t
hold_countRC ( ( s3 /usr/lib/python2.7/site-packages/salt/states/zfs.pyt _schedule_snapshot_prepareK s>
c
C@ sd i | d 6i d 6t d 6d d 6} d d d d d
g } t d t � f d g f d
t � f g � } t d | � s� t | d <d j | � | d <n t d | i d d 6� s� d j | � | d <t | d <n | s� t | � d k rd j | � | d <t | d <n d } x� | D]� } g | | <| | k rAd | d
| <nF t | | t � ri| | | d
| <n t | d <d j | � | d <P| | d
| 7} qW| d r�| d k r�t | d <d | d <n | d s�| St | | | � } t
| | | � } t j d | | � t j d | | � t j d | | � xl| d j
� D]Z\ } }
|
s^qFn t d s�t d | i | d 6� } n t d t f g � } | d s�t | d <d j | � | d <n� x� |
D]� } t d s�t d! | | i | d 6� } n t d" t f g � } | d" s>t | d <d# j | | � | d <Pn | | j | � q�W| d rFd$ | d <d% | d k r�g | d d% <n | d d% j | � qFqFWx� | d
j
� D]� \ } } x� | d r�t | | � | k r�| | j d � } t d s!t d& | | i | d 6� } n t d' t f g � } | d' sct | d <d# j | | � | d <n t d( | � s�| d j | � q�q�Wq�Wxy | d D]m } t d s�t d) | i | d 6� } n t d* t f g � } | d* s�t | d <d+ j | � | d <Pq�q�W| d r>| d r>d$ | d <| d | d d, <n | d r`| d r`d- | d <n | S(. u�
maintain a set of snapshots based on a schedule
name : string
name of filesystem or volume
prefix : string
prefix for the snapshots
e.g. 'test' will result in snapshots being named 'test-yyyymmdd_hhmm'
recursive : boolean
create snapshots for all children also
schedule : dict
dict holding the schedule, the following keys are available (minute, hour,
day, month, and year) by default all are set to 0 the value indicated the
number of snapshots of that type to keep around.
.. warning::
snapshots will only be created and pruned every time the state runs.
a schedule must be setup to automatically run the state. this means that if
you run the state daily the hourly snapshot will only be made once per day!
.. versionchanged:: 2018.3.0
switched to localtime from gmtime so times now take into account timezones.
u nameu changesu resultu u commentu minuteu houru dayu monthu yearu _createu _prunableu _scheduleu zfs.is_datasetu invalid dataset name: {0}u
zfs.existsu filesystem,volumeu typeu dataset {0} does not existi u$ prefix ({0}) must be at least 4 longi u( schedule value for {0} is not an integeru: schedule is not valid, you need to keep atleast 1 snapshotu2 zfs.scheduled_snapshot::%s::config::recursive = %su/ zfs.scheduled_snapshot::%s::config::prefix = %su* zfs.scheduled_snapshot::%s::snapshots = %su testu zfs.snapshotu recursiveu snapshottedu error creating snapshot ({0})u zfs.holdu heldu) error adding hold ({0}) to snapshot ({1})u scheduled snapshots updatedu createdu zfs.releaseu releasedu zfs.holdsu zfs.destroyu destroyedu error prunding snapshot ({1})u prunedu" scheduled snapshots are up to date( R
R R R R R t lent
isinstancet intRB RR R R
RI R R' t pop(
R R< R t scheduleR t schedule_holdsR= t total_countRA t
snapshot_namet snapshot_holdsR RQ ( ( s3 /usr/lib/python2.7/site-packages/salt/states/zfs.pyt scheduled_snapshot� s�
#
(% t __doc__t
__future__R R R t loggingR t salt.utils.odictR t getLoggert __name__R R RK RL RM RN R R R R R R R R R R% R1 R2 R3 R5 R6 R7 RB RR R
R\ ( ( ( s3 /usr/lib/python2.7/site-packages/salt/states/zfs.pyt <module>- s6
" : F I� , <= 5 ( ;
Mini Shell