Daniel P. Berrangé > Sys-Virt-0.10.0 > Sys::Virt::Secret

Download:
Sys-Virt-0.10.0.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  0
View/Report Bugs
Source   Latest Release: Sys-Virt-1.2.6

NAME ^

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

DESCRIPTION ^

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

METHODS ^

my $uuid = $sec->get_uuid()

Returns a 16 byte long string containing the raw globally unique identifier (UUID) for the secret.

my $uuid = $sec->get_uuid_string()

Returns a printable string representation of the raw UUID, in the format 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'.

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.

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.

my $xml = $sec->get_xml_description()

Returns an XML document containing a complete description of the secret's configuration

$sec->undefine()

Remove the configuration associated with a secret previously defined with the define_secret method in Sys::Virt.

$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.

$sec->set_value($bytes)

Sets the value for the secret to be $bytes.

CONSTANTS ^

Sys::Virt::Secret::USAGE_TYPE_NONE

The constant for secrets which are not assigned for use with a particular object

Sys::Virt::Secret::USAGE_TYPE_VOLUME

The constant for secrets which are to be used for storage volume encryption. The usage ID for secrets will refer to the fully qualified volume path.

Sys::Virt::Secret::USAGE_TYPE_CEPH

The constant for secrets which are to be used for authenticating to CEPH storage volumes. The usage ID for secrets will refer to the server name.

AUTHORS ^

Daniel P. Berrange <berrange@redhat.com>

COPYRIGHT ^

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

LICENSE ^

This program is free software; you can redistribute it and/or modify it under the terms of either the GNU 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 README file.

SEE ALSO ^

Sys::Virt, Sys::Virt::Error, http://libvirt.org

syntax highlighting: