.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Sys::Virt::Secret 3pm"
.TH Sys::Virt::Secret 3pm "2017-01-25" "perl v5.24.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Sys::Virt::Secret \- Represent & manage a libvirt secret
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \f(CW\*(C`Sys::Virt::Secret\*(C'\fR module represents a secret managed
by the virtual machine monitor.
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "my $uuid = $sec\->\fIget_uuid()\fR" 4
.el .IP "my \f(CW$uuid\fR = \f(CW$sec\fR\->\fIget_uuid()\fR" 4
.IX Item "my $uuid = $sec->get_uuid()"
Returns a 16 byte long string containing the raw globally unique identifier
(\s-1UUID\s0) for the secret.
.ie n .IP "my $uuid = $sec\->\fIget_uuid_string()\fR" 4
.el .IP "my \f(CW$uuid\fR = \f(CW$sec\fR\->\fIget_uuid_string()\fR" 4
.IX Item "my $uuid = $sec->get_uuid_string()"
Returns a printable string representation of the raw \s-1UUID,\s0 in the format
\&'\s-1XXXXXXXX\-XXXX\-XXXX\-XXXX\-XXXXXXXXXXXX\s0'.
.ie n .IP "my $type = $sec\->\fIget_usage_type()\fR" 4
.el .IP "my \f(CW$type\fR = \f(CW$sec\fR\->\fIget_usage_type()\fR" 4
.IX Item "my $type = $sec->get_usage_type()"
Returns the usage type of this secret. The usage type determines the
format of the unique identifier for this secret.
.ie n .IP "my $id = $sec\->\fIget_usage_id()\fR" 4
.el .IP "my \f(CW$id\fR = \f(CW$sec\fR\->\fIget_usage_id()\fR" 4
.IX Item "my $id = $sec->get_usage_id()"
Returns the identifier of the object with which the secret is to
be used. For secrets with a usage type of volume, the identifier
is the fully qualfied path.
.ie n .IP "my $xml = $sec\->\fIget_xml_description()\fR" 4
.el .IP "my \f(CW$xml\fR = \f(CW$sec\fR\->\fIget_xml_description()\fR" 4
.IX Item "my $xml = $sec->get_xml_description()"
Returns an \s-1XML\s0 document containing a complete description of
the secret's configuration
.ie n .IP "$sec\->\fIundefine()\fR" 4
.el .IP "\f(CW$sec\fR\->\fIundefine()\fR" 4
.IX Item "$sec->undefine()"
Remove the configuration associated with a secret previously defined
with the \f(CW\*(C`define_secret\*(C'\fR method in Sys::Virt.
.ie n .IP "$bytes = $sec\->\fIget_value()\fR" 4
.el .IP "\f(CW$bytes\fR = \f(CW$sec\fR\->\fIget_value()\fR" 4
.IX Item "$bytes = $sec->get_value()"
Returns the raw bytes for the value of this secret, or undef if
there is no value stored with the secret.
.ie n .IP "$sec\->set_value($bytes)" 4
.el .IP "\f(CW$sec\fR\->set_value($bytes)" 4
.IX Item "$sec->set_value($bytes)"
Sets the value for the secret to be \f(CW$bytes\fR.
.SH "CONSTANTS"
.IX Header "CONSTANTS"
This section documents constants that are used with various
APIs described above
.SS "\s-1SECRET USAGE TYPE\s0"
.IX Subsection "SECRET USAGE TYPE"
The following constants refer to the different usage types
.IP "Sys::Virt::Secret::USAGE_TYPE_NONE" 4
.IX Item "Sys::Virt::Secret::USAGE_TYPE_NONE"
The constant for secrets which are not assigned for use with a
particular object
.IP "Sys::Virt::Secret::USAGE_TYPE_VOLUME" 4
.IX Item "Sys::Virt::Secret::USAGE_TYPE_VOLUME"
The constant for secrets which are to be used for storage
volume encryption. The usage \s-1ID\s0 for secrets will refer to
the fully qualified volume path.
.IP "Sys::Virt::Secret::USAGE_TYPE_CEPH" 4
.IX Item "Sys::Virt::Secret::USAGE_TYPE_CEPH"
The constant for secrets which are to be used for authenticating
to \s-1CEPH\s0 storage volumes. The usage \s-1ID\s0 for secrets will refer to
the server name.
.IP "Sys::Virt::Secret::USAGE_TYPE_ISCSI" 4
.IX Item "Sys::Virt::Secret::USAGE_TYPE_ISCSI"
The constant for secrets which are to be used for authenticating
to iSCSI storage volumes. The usage \s-1ID\s0 for secrets will refer to
the server name.
.IP "Sys::Virt::Secret::USAGE_TYPE_TLS" 4
.IX Item "Sys::Virt::Secret::USAGE_TYPE_TLS"
The constant for secrets which are to be used for authenticating
for the \s-1TLS\s0 environment. The usage \s-1ID\s0 for the secret can be any
name. The \s-1UUID\s0 for the secret will be used by the hypervisor to
fetch the secret value.
.SS "\s-1LIST FILTERING\s0"
.IX Subsection "LIST FILTERING"
The following constants are used to filter object lists
.IP "Sys::Virt::Secret::LIST_EPHEMERAL" 4
.IX Item "Sys::Virt::Secret::LIST_EPHEMERAL"
Include any secrets marked as ephemeral
.IP "Sys::Virt::Secret::LIST_NO_EPHEMERAL" 4
.IX Item "Sys::Virt::Secret::LIST_NO_EPHEMERAL"
Include any secrets not marked as ephemeral
.IP "Sys::Virt::Secret::LIST_PRIVATE" 4
.IX Item "Sys::Virt::Secret::LIST_PRIVATE"
Include any secrets marked as private
.IP "Sys::Virt::Secret::LIST_NO_PRIVATE" 4
.IX Item "Sys::Virt::Secret::LIST_NO_PRIVATE"
Include any secrets not marked as private
.SS "\s-1EVENT ID CONSTANTS\s0"
.IX Subsection "EVENT ID CONSTANTS"
.IP "Sys::Virt::Secret::EVENT_ID_LIFECYCLE" 4
.IX Item "Sys::Virt::Secret::EVENT_ID_LIFECYCLE"
Secret lifecycle events
.IP "Sys::Virt::Secret::EVENT_ID_VALUE_CHANGED" 4
.IX Item "Sys::Virt::Secret::EVENT_ID_VALUE_CHANGED"
Secret value change events
.SS "\s-1LIFECYCLE CHANGE EVENTS\s0"
.IX Subsection "LIFECYCLE CHANGE EVENTS"
The following constants allow secret lifecycle change events to be
interpreted. The events contain both a state change, and a
reason though the reason is currently unsed.
.IP "Sys::Virt::Secret::EVENT_DEFINED" 4
.IX Item "Sys::Virt::Secret::EVENT_DEFINED"
Indicates that a persistent configuration has been defined for
the secret.
.IP "Sys::Virt::Secret::EVENT_UNDEFINED" 4
.IX Item "Sys::Virt::Secret::EVENT_UNDEFINED"
The persistent configuration has gone away
.SH "AUTHORS"
.IX Header "AUTHORS"
Daniel P. Berrange <berrange@redhat.com>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2006\-2009 Red Hat
Copyright (C) 2006\-2007 Daniel P. Berrange
.SH "LICENSE"
.IX Header "LICENSE"
This program is free software; you can redistribute it and/or modify
it under the terms of either the \s-1GNU\s0 General Public License as published
by the Free Software Foundation (either version 2 of the License, or at
your option any later version), or, the Artistic License, as specified
in the Perl \s-1README\s0 file.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Sys::Virt, Sys::Virt::Error, \f(CW\*(C`http://libvirt.org\*(C'\fR