File: Qtree.pod

package info (click to toggle)
libnetapp-perl 1.1.2-1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 384 kB
  • ctags: 226
  • sloc: perl: 4,539; makefile: 15
file content (81 lines) | stat: -rw-r--r-- 1,742 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

=head1 NAME

NetApp::Qtree -- OO class for creating and managing qtrees

=head1 SYNOPSIS

    use NetApp::Filer;
    use NetApp::Qtree;

    my $filer 	= NetApp::Filer->new( .... );

    # Create a tree, with all options in one call
    my $qtree	= $filer->create_qtree(
        name		=> "/vol/vol1/qtreename",
	oplocks		=> 1,
	mode		=> 0755,
	security	=> 'unix',
    );

    # Alternately, you can create it, and then change things
    my $qtree	= $filer->create_qtree(
        name		=> "/vol/vol1/qtreename",
        mode		=> 0755,
    );    
    
    # The mode must be set when created
    $qtree->set_oplock(1);
    $qtree->set_security('unix');

=head1 DESCRIPTION

This class encapsulates a single NetApp qtree, and provides methods
for querying information about the qtree, as well as methods for
managing it.

=head1 METHODS

=head2 set_security( $security )

This method method takes a single argument, which is the security
value to set on the qtree.  It must have one of the following values:

    unix
    ntfs
    mixed

=head2 get_security

Returns a string containing the current security setting
of the qtree.

=head2 set_oplocks( $boolean )

This method takes a boolean argument, and sets the oplocks attribute
of the qtree to "enabled" if the value is true, and "disabled" if the
value is false.

=head2 get_oplocks

Returns true is the oplocks are set to "enabled", false if
they are set to "disabled".

=head2 get_status

Returns the status value for the qtree.  It waill have the
values such as:

    normal
    snapmirrored

=head2 get_id

Returns the qtree id.

=head2 get_vfiler

Returns the vfiler which owns the qtree.  If vfilers are not licensed
on the filer, this method will simply return a false value.

=cut