diff options
author | Christophe Fergeau <cfergeau@redhat.com> | 2014-10-06 10:52:15 +0200 |
---|---|---|
committer | Christophe Fergeau <cfergeau@redhat.com> | 2014-10-09 17:21:26 +0200 |
commit | 334169749ef482281e5da11c5cd79d4f196c4780 (patch) | |
tree | 279e6362d9e9763ccda6fa430d4c76854779c314 | |
parent | 53b347c92c3a048205336174f844fcd4cc9dd78e (diff) | |
download | virt-viewer-334169749ef482281e5da11c5cd79d4f196c4780.tar.gz virt-viewer-334169749ef482281e5da11c5cd79d4f196c4780.tar.xz virt-viewer-334169749ef482281e5da11c5cd79d4f196c4780.zip |
man: Document [ovirt] section in .vv files
Add documentation for these options even though they are mainly meant to
be set by the oVirt portal when it generates the .vv file.
-rw-r--r-- | man/remote-viewer.pod | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/man/remote-viewer.pod b/man/remote-viewer.pod index 2526675..7e8718b 100644 --- a/man/remote-viewer.pod +++ b/man/remote-viewer.pod @@ -270,6 +270,37 @@ port 8080, use the value "http://foobar:8080". =back +=head2 oVirt Support + +The connection file can also carry some oVirt-specific options when oVirt +support is compiled in. These options are used to interact with oVirt REST API. +This is currently only used in order to show a menu allowing to change the CD +image being used by the virtual machine from remote-viewer user interface. +These options go in an optional [ovirt] group. + +=over 4 + +=item C<host> (string, mandatory) + +The oVirt instance to connect to. This corresponds to the hostname one would +connect to to access the oVirt user or admin portal. + +=item C<vm-guid> (string, mandatory) + +GUID of the oVirt virtual machine to connect to. + +=item C<jsessionid> (string) + +Value to set the 'jsessionid' cookie to. Setting this authentication cookie to a valid value +will allow to interact with the oVirt REST API without being asked for credentials. + +=item C<ca> (string) + +CA certificate in PEM format (using "\n" to separate the lines). This will be used to validate +the certificate used for the oVirt REST https session remote-viewer will establish. + +=back + =head1 CONFIGURATION A small number of configuration options can be controlled by editing the |