NAME

Backup::Omni::Session::Filesystem - Return a session object for a given backup

SYNOPSIS

 use Backup::Omni::Session::Filesystem;

 my $session = Backup::Omni::Session::Filesystem->new(
     -host => 'esd189-aix-01',
     -date => '2013-01-10' 
 );

 printf("session id = %s\n", $session->sessionid);

DESCRIPTION

This module will return the session object for a given filesystem backup on a particular date. It runs the omnidb command with the appropiate options. If any errors are encounterd, an exception is thrown.

METHODS

new

This method will initialze the object. It takes four parameters.

-host

The name of the host the backup was preformed against.

-date

The date the backup was ran. It must be in YYYY-MM-DD format.

-path

The path the backup was for. Defaults to '/archive'.

-label

The label of the backup. Defaults to '/archive'.

Session Object

If the session is found an object is returned. That object has the following methods defined.

sessionid

This method returns the session id.

started

The datetime when the backup started.

finished

The datetime when the backup finished.

object_status

The status of objec.

object_size

The size of the object.

backup_type

The type of backup.

protection

The protection level of the backup.

catalog_retention

The retention period of the backup. It may be the same as the protection.

version_type

The version type of the backup.

access

The access type of the backup.

number_of_warnings

The number of warning generated during this backup.

number_of_errors

The number of errors that were generated during this backup.

device_name

The name of the device that backup was performed on.

backup_id

The id of this backup.

copy_id

The copy id of this backup.

encrypted

Wither this backup was encrupted.

SEE ALSO

 Backup::Omni::Base
 Backup::Omni::Class
 Backup::Omni::Utils
 Backup::Omni::Constants
 Backup::Omni::Exception
 Backup::Omni::Restore::Filesystem::Single
 Backup::Omni::Session::Messages
 Backup::Omni::Session::Monitor
 Backup::Omni::Session::Results

AUTHOR

Kevin L. Esteb, <kesteb@wsipc.org>

COPYRIGHT AND LICENSE

Copyright (C) 2013 by WSIPC

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.