Sys::Virt::Secret(3pm)

1Sys::Virt::Secret(3)  User Contributed Perl Documentation Sys::Virt::Secret(3)
2
3
4

NAME

6       Sys::Virt::Secret - Represent & manage a libvirt secret
7

DESCRIPTION

9       The "Sys::Virt::Secret" module represents a secret managed by the
10       virtual machine monitor.
11

METHODS

13       my $uuid = $sec->get_uuid()
14           Returns a 16 byte long string containing the raw globally unique
15           identifier (UUID) for the secret.
16
17       my $uuid = $sec->get_uuid_string()
18           Returns a printable string representation of the raw UUID, in the
19           format 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'.
20
21       my $type = $sec->get_usage_type()
22           Returns the usage type of this secret. The usage type determines
23           the format of the unique identifier for this secret.
24
25       my $id = $sec->get_usage_id()
26           Returns the identifier of the object with which the secret is to be
27           used. For secrets with a usage type of volume, the identifier is
28           the fully qualfied path.
29
30       my $xml = $sec->get_xml_description()
31           Returns an XML document containing a complete description of the
32           secret's configuration
33
34       $sec->undefine()
35           Remove the configuration associated with a secret previously
36           defined with the "define_secret" method in Sys::Virt.
37
38       $bytes = $sec->get_value()
39           Returns the raw bytes for the value of this secret, or undef if
40           there is no value stored with the secret.
41
42       $sec->set_value($bytes)
43           Sets the value for the secret to be $bytes.
44

CONSTANTS

46       Sys::Virt::Secret::USAGE_TYPE_NONE
47           The constant for secrets which are not assigned for use with a
48           particular object
49
50       Sys::Virt::Secret::USAGE_TYPE_VOLUME
51           The constant for secrets which are to be used for storage volume
52           encryption. The usage ID for secrets will refer to the fully
53           qualified volume path.
54

AUTHORS

56       Daniel P. Berrange <berrange@redhat.com>
57

COPYRIGHT

59       Copyright (C) 2006-2009 Red Hat Copyright (C) 2006-2007 Daniel P.
60       Berrange
61

LICENSE

63       This program is free software; you can redistribute it and/or modify it
64       under the terms of either the GNU General Public License as published
65       by the Free Software Foundation (either version 2 of the License, or at
66       your option any later version), or, the Artistic License, as specified
67       in the Perl README file.
68