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       This section documents constants that are used with various APIs
47       described above
48
49   SECRET USAGE TYPE
50       The following constants refer to the different usage types
51
52       Sys::Virt::Secret::USAGE_TYPE_NONE
53           The constant for secrets which are not assigned for use with a
54           particular object
55
56       Sys::Virt::Secret::USAGE_TYPE_VOLUME
57           The constant for secrets which are to be used for storage volume
58           encryption. The usage ID for secrets will refer to the fully
59           qualified volume path.
60
61       Sys::Virt::Secret::USAGE_TYPE_CEPH
62           The constant for secrets which are to be used for authenticating to
63           CEPH storage volumes. The usage ID for secrets will refer to the
64           server name.
65
66       Sys::Virt::Secret::USAGE_TYPE_ISCSI
67           The constant for secrets which are to be used for authenticating to
68           iSCSI storage volumes. The usage ID for secrets will refer to the
69           server name.
70
71       Sys::Virt::Secret::USAGE_TYPE_TLS
72           The constant for secrets which are to be used for authenticating
73           for the TLS environment. The usage ID for the secret can be any
74           name. The UUID for the secret will be used by the hypervisor to
75           fetch the secret value.
76
77   LIST FILTERING
78       The following constants are used to filter object lists
79
80       Sys::Virt::Secret::LIST_EPHEMERAL
81           Include any secrets marked as ephemeral
82
83       Sys::Virt::Secret::LIST_NO_EPHEMERAL
84           Include any secrets not marked as ephemeral
85
86       Sys::Virt::Secret::LIST_PRIVATE
87           Include any secrets marked as private
88
89       Sys::Virt::Secret::LIST_NO_PRIVATE
90           Include any secrets not marked as private
91
92   EVENT ID CONSTANTS
93       Sys::Virt::Secret::EVENT_ID_LIFECYCLE
94           Secret lifecycle events
95
96       Sys::Virt::Secret::EVENT_ID_VALUE_CHANGED
97           Secret value change events
98
99   LIFECYCLE CHANGE EVENTS
100       The following constants allow secret lifecycle change events to be
101       interpreted. The events contain both a state change, and a reason
102       though the reason is currently unused.
103
104       Sys::Virt::Secret::EVENT_DEFINED
105           Indicates that a persistent configuration has been defined for the
106           secret.
107
108       Sys::Virt::Secret::EVENT_UNDEFINED
109           The persistent configuration has gone away
110

AUTHORS

112       Daniel P. Berrange <berrange@redhat.com>
113

COPYRIGHT

115       Copyright (C) 2006-2009 Red Hat Copyright (C) 2006-2007 Daniel P.
116       Berrange
117

LICENSE

119       This program is free software; you can redistribute it and/or modify it
120       under the terms of either the GNU General Public License as published
121       by the Free Software Foundation (either version 2 of the License, or at
122       your option any later version), or, the Artistic License, as specified
123       in the Perl README file.
124