|
 |
51ca4a |
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
|
|
|
51ca4a |
From: Christophe Fergeau <cfergeau@redhat.com>
|
|
|
51ca4a |
Date: Fri, 15 Jan 2016 15:54:24 +0100
|
|
|
51ca4a |
Subject: [PATCH] proxy: Document OvirtProxy properties
|
|
|
51ca4a |
|
|
|
51ca4a |
---
|
|
|
51ca4a |
govirt/ovirt-proxy.c | 28 +++++++++++++++++++++++++++-
|
|
|
51ca4a |
1 file changed, 27 insertions(+), 1 deletion(-)
|
|
|
51ca4a |
|
|
|
51ca4a |
diff --git a/govirt/ovirt-proxy.c b/govirt/ovirt-proxy.c
|
|
|
51ca4a |
index d2c1d47..cea1042 100644
|
|
|
51ca4a |
--- a/govirt/ovirt-proxy.c
|
|
|
51ca4a |
+++ b/govirt/ovirt-proxy.c
|
|
|
51ca4a |
@@ -814,14 +814,31 @@ ovirt_proxy_class_init(OvirtProxyClass *klass)
|
|
|
51ca4a |
oclass->get_property = ovirt_proxy_get_property;
|
|
|
51ca4a |
oclass->set_property = ovirt_proxy_set_property;
|
|
|
51ca4a |
|
|
|
51ca4a |
+ /**
|
|
|
51ca4a |
+ * OvirtProxy:ca-cert;
|
|
|
51ca4a |
+ *
|
|
|
51ca4a |
+ * Path to a file containing the CA certificates to use for the HTTPS
|
|
|
51ca4a |
+ * REST API communication with the oVirt instance
|
|
|
51ca4a |
+ */
|
|
|
51ca4a |
g_object_class_install_property(oclass,
|
|
|
51ca4a |
PROP_CA_CERT,
|
|
|
51ca4a |
g_param_spec_boxed("ca-cert",
|
|
|
51ca4a |
"ca-cert",
|
|
|
51ca4a |
- "Virt CA certificate to use when connecting to remote VM",
|
|
|
51ca4a |
+ "Virt CA certificate to use for HTTPS REST communication",
|
|
|
51ca4a |
G_TYPE_BYTE_ARRAY,
|
|
|
51ca4a |
G_PARAM_READWRITE |
|
|
|
51ca4a |
G_PARAM_STATIC_STRINGS));
|
|
|
51ca4a |
+
|
|
|
51ca4a |
+ /**
|
|
|
51ca4a |
+ * OvirtProxy:admin:
|
|
|
51ca4a |
+ *
|
|
|
51ca4a |
+ * Indicates whether to connect to the REST API as an admin, or as a regular user.
|
|
|
51ca4a |
+ * Different content will be shown for the same user depending on if they connect as
|
|
|
51ca4a |
+ * an admin or not. Connecting as an admin requires to have admin priviledges on the
|
|
|
51ca4a |
+ * oVirt instance.
|
|
|
51ca4a |
+ *
|
|
|
51ca4a |
+ * Since: 0.0.2
|
|
|
51ca4a |
+ */
|
|
|
51ca4a |
g_object_class_install_property(oclass,
|
|
|
51ca4a |
PROP_ADMIN,
|
|
|
51ca4a |
g_param_spec_boolean("admin",
|
|
|
51ca4a |
@@ -830,6 +847,15 @@ ovirt_proxy_class_init(OvirtProxyClass *klass)
|
|
|
51ca4a |
FALSE,
|
|
|
51ca4a |
G_PARAM_READWRITE |
|
|
|
51ca4a |
G_PARAM_STATIC_STRINGS));
|
|
|
51ca4a |
+ /**
|
|
|
51ca4a |
+ * OvirtProxy:session-id:
|
|
|
51ca4a |
+ *
|
|
|
51ca4a |
+ * jsessionid cookie value. This allows to use the REST API without
|
|
|
51ca4a |
+ * authenticating first. This was used by oVirt 3.6 and is now replaced
|
|
|
51ca4a |
+ * by OvirtProxy:sso-token.
|
|
|
51ca4a |
+ *
|
|
|
51ca4a |
+ * Since: 0.3.1
|
|
|
51ca4a |
+ */
|
|
|
51ca4a |
g_object_class_install_property(oclass,
|
|
|
51ca4a |
PROP_SESSION_ID,
|
|
|
51ca4a |
g_param_spec_string("session-id",
|