Re: [ovirt-users] Looking for Python-SDK documentation

[Brett I. Holcomb]

On Wed, 2016-04-13 at 09:19 +0300, Yedidyah Bar David wrote:
> On Wed, Apr 13, 2016 at 12:03 AM, Brett I. Holcomb 
> com> wrote:
> > 
> > snipped
> > 
> > One question I have as I read this.  In a hosted-engine environment how
> > do I use the SDK to tell if the Engine VM is running.  I could dump a
> > hosted-engine --vm-status and parse it's output but is there a better
> > way.  Assuming that since the host is running the Engine is does not
> > always hold true.
> > 

> 
> 
> You can simply try to connect to the api. If you succeed, the engine is up.
> 
> You can also use this url, which is what hosted-engine
> --deploy uses:
> 
> 
http://{fqdn}/ovirt-engine/services/health
> {fqdn}/ovirt-engine/services/health
> 
> Not sure why we keep using it, as it was considered deprecated at some point,
> see this:
> 
> 
https://bugzilla.redhat.com/show_bug.cgi?id=1026723> 
https://gerrit.ovirt.org/20846
> 
> 
> If you want more, you can write something and start from the file implementing
> --vm-status, ovirt_hosted_engine_setup/vm_status.py . It uses
> ovirt_hosted_engine_ha.client to get the data and does rather shallow 
> massaging
> around that. Not sure ovirt_hosted_engine_ha.client is an official API, IIRC 
> no
> other project uses it, and even if it is, it's still not part of the engine 
> API.
> 
> Another option is to add an option to --vm-status to output machine-readable
> info. patches are welcome :-)
> 
> Best,
> 

Thanks.  I'll go with the if api connects engine running if not engine
down method.  I don't want to use a deprecated method and I'll stick
with whats part of the API. 
___
Users mailing list
Users@ovirt.org
http://lists.ovirt.org/mailman/listinfo/users

Re: [ovirt-users] Looking for Python-SDK documentation

[Simone Tiraboschi]

On Wed, Apr 13, 2016 at 8:19 AM, Yedidyah Bar David  wrote:
> On Wed, Apr 13, 2016 at 12:03 AM, Brett I. Holcomb  
> wrote:
>> On Tue, 2016-04-12 at 07:57 -0400, Alexander Wels wrote:
>>> On Monday, April 11, 2016 05:03:28 PM Brett I. Holcomb wrote:
>>> >
>>> > On Mon, 2016-04-11 at 20:41 +0200, Frank Thommen wrote:
>>> > >
>>> > > On 11.04.16 20:17, Brett I. Holcomb wrote:
>>> > > >
>>> > > > On Mon, 2016-04-11 at 14:38 -0300, Amador Pahim wrote:
>>> > > > >
>>> > > > > On 04/11/2016 02:07 PM, Brett I. Holcomb wrote:
>>> > > > > >
>>> > > > > > On Mon, 2016-04-11 at 17:27 +0200, Frank Thommen wrote:
>>> > > > > > >
>>> > > > > > > Dear all,
>>> > > > > > >
>>> > > > > > > I'm currently lost at finding any documentation about the
>>> > > > > > > Python SDK
>>> > > > > > > (http://www.ovirt.org/develop/release-management/features
>>> > > > > > > /inf
>>> > > > > > > ra/python-sdk/)
>>> > > > > > > like provided classes, functions etc..  There are some
>>> > > > > > > examples on the
>>> > > > > > > mentioned page, but I cannot find a complete
>>> > > > > > > documentation.  Our oVirt
>>> > > > > > > server is running CentOS 7 with ovirt-engine-sdk-python
>>> > > > > > > installed.
>>> > > > > > > However there doesn't seem to exist an ovirt-engine-sdk-
>>> > > > > > > python-docs
>>> > > > > > > package and I couldn't find any appropriate link on the
>>> > > > > > > oVirt
>>> > > > > > > documentation pages (http://www.ovirt.org/documentation/)
>>> > > > > > > .
>>> > > > > > >
>>> > > > > > > Any ideas, where the documentation is available?
>>> > > > > > >
>>> > > > > > > Cheers
>>> > > > > > > Frank
>>> > > > > > > ___
>>> > > > > > > Users mailing list
>>> > > > > > > Users@ovirt.org 
>>> > > > > > > http://lists.ovirt.org/mailman/listinfo/users
>>> > > > > > > 
>>> > > > > > Other than what you found I found this but that's
>>> > > > > > all.  Doesn't
>>> > > > > > seem
>>> > > > > > to be much other than examples an the one that shows what
>>> > > > > > to
>>> > > > > > import.
>>> > > > > >  I, too would like to find what your are looking for so I
>>> > > > > > can
>>> > > > > > use it.
>>> > > > > There is this RHEV documentation that can be helpful:
>>> > > > > https://access.redhat.com/documentation/en-US/Red_Hat_Enterpr
>>> > > > > ise_
>>> > > > > Virtualization/3.3/html/Developer_Guide/chap-
>>> > > > > Python_Quick_Start_Example.html
>>> > > > >
>>> > > > > >
>>> > > > > > http://www.ovirt.org/develop/api/pythonapi/
>>> > > > > >
>>> > > > > >
>>> > > > > > ___
>>> > > > > > Users mailing list
>>> > > > > > Users@ovirt.org 
>>> > > > > > http://lists.ovirt.org/mailman/listinfo/users
>>> > > > > > 
>>> > > > Thanks.  That is helpful but as Frank said it would be nice to
>>> > > > have
>>> > > > an
>>> > > > api reference for each class and function that gives the
>>> > > > parameters,
>>> > > > return values, and other stuff usually found in an API
>>> > > > reference.  The
>>> > > > examples are helpful but don't give all the information abut a
>>> > > > function
>>> > > > or class.
>>> > > Thanks to all who answered.  Brett brings it to the point:  All
>>> > > sent
>>> > > links so far are indeed helpful - thanks a lot - but not the
>>> > > reference I
>>> > > expected.
>>> > > https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_
>>> > > Virt
>>> > > ualization/3.6/html/Python_SDK_Guide/chap-
>>> > > Python_Reference_Documentation.html#Python_Reference_Documentatio
>>> > > n
>>> > > mentions `pydoc`, but this documentation seems to be provided
>>> > > only
>>> > > for
>>> > > some modules or to be incomplete.  Also for me not being a
>>> > > software
>>> > > developper and newish to Python, the `pydoc` information is not
>>> > > very
>>> > > useful.  Where can I e.g. find the documentation for vms.get()
>>> > > and
>>> > > vms.add() (just to name teo concrete examples)?
>>> > >
>>> > > Frank
>>> > > ___
>>> > > Users mailing list
>>> > > Users@ovirt.org
>>> > > http://lists.ovirt.org/mailman/listinfo/users
>>> > I'm in the same boat as Frank.  I've done programming in various
>>> > languages since Fortran without the numbers  but only when
>>> > needed
>>> > for my job as an Engineer so I'm not a professional but just trying
>>> > to
>>> > get a job done.  It would be nice to have a full reference so we
>>> > know
>>> > what to provide.  When trying to connect with the api I finally
>>> > figured
>>> > out to use ca_file (like ca-file on the command line).  Raz's
>>> > reference
>>> > is more complete but still leaves a lot out.  The newer equivalent
>>> > of
>>> > Raz's reference seems to be http://www.ovirt.org/develop/release-ma
>>> > nage
>>> > 

Re: [ovirt-users] Looking for Python-SDK documentation

[Alexander Wels]

On Tuesday, April 12, 2016 05:12:34 PM Brett I. Holcomb wrote:
>1. On Tue, 2016-04-12 at 23:03 +0200, Frank Thommen wrote:
> > On 12.04.16 13:57, Alexander Wels wrote:
> > > On Monday, April 11, 2016 05:03:28 PM Brett I. Holcomb wrote:
> > > > On Mon, 2016-04-11 at 20:41 +0200, Frank Thommen wrote:
> > > > > On 11.04.16 20:17, Brett I. Holcomb wrote:
> > > > > [...]
> > > > 
> > > > I'm in the same boat as Frank.  I've done programming in various
> > > > languages since Fortran without the numbers  but only when
> > > > needed
> > > > for my job as an Engineer so I'm not a professional but just
> > > > trying to
> > > > get a job done.  It would be nice to have a full reference so we
> > > > know
> > > > what to provide.  When trying to connect with the api I finally
> > > > figured
> > > > out to use ca_file (like ca-file on the command line).  Raz's
> > > > reference
> > > > is more complete but still leaves a lot out.  The newer
> > > > equivalent of
> > > > Raz's reference seems to be http://www.ovirt.org/develop/release-> > > 
> > > > > manage
> > > > ment/features/infra/python-sdk/.
> > > 
> > > The Python/Java/Ruby SDKs are simply language specific wrappers
> > > around the REST
> > > api. So if you want a full list of all the options available check
> > > out the
> > > REST api documentation. You will have to translate a particular
> > > REST api
> > > field/feature to the SDK, but all the SDKs are generated from the
> > > REST api
> > > interface definition so the naming and everything should be the
> > > same.
> > 
> > That makes sense, thanks.  On the other hand I could also not find
> > any 
> > REST api reference.  Just some pages with examples a la "find it out 
> > yourself from there"...
> > 

The RH RHEV REST api documentation [1] looks fairly complete to me, the API is 
identical to oVirt.

[1] 
https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.6/html-single/REST_API_Guide/
> > frank
> > ___
> > Users mailing list
> > Users@ovirt.org
> > http://lists.ovirt.org/mailman/listinfo/users
> 
> Same here.  A lot of examples, some more detailed but no "API Reference
> Manual for oVirt REST API" like we had in the old days .
> 
> ___
> Users mailing list
> Users@ovirt.org
> http://lists.ovirt.org/mailman/listinfo/users

___
Users mailing list
Users@ovirt.org
http://lists.ovirt.org/mailman/listinfo/users

Re: [ovirt-users] Looking for Python-SDK documentation

[Yedidyah Bar David]

On Wed, Apr 13, 2016 at 12:03 AM, Brett I. Holcomb  wrote:
> On Tue, 2016-04-12 at 07:57 -0400, Alexander Wels wrote:
>> On Monday, April 11, 2016 05:03:28 PM Brett I. Holcomb wrote:
>> >
>> > On Mon, 2016-04-11 at 20:41 +0200, Frank Thommen wrote:
>> > >
>> > > On 11.04.16 20:17, Brett I. Holcomb wrote:
>> > > >
>> > > > On Mon, 2016-04-11 at 14:38 -0300, Amador Pahim wrote:
>> > > > >
>> > > > > On 04/11/2016 02:07 PM, Brett I. Holcomb wrote:
>> > > > > >
>> > > > > > On Mon, 2016-04-11 at 17:27 +0200, Frank Thommen wrote:
>> > > > > > >
>> > > > > > > Dear all,
>> > > > > > >
>> > > > > > > I'm currently lost at finding any documentation about the
>> > > > > > > Python SDK
>> > > > > > > (http://www.ovirt.org/develop/release-management/features
>> > > > > > > /inf
>> > > > > > > ra/python-sdk/)
>> > > > > > > like provided classes, functions etc..  There are some
>> > > > > > > examples on the
>> > > > > > > mentioned page, but I cannot find a complete
>> > > > > > > documentation.  Our oVirt
>> > > > > > > server is running CentOS 7 with ovirt-engine-sdk-python
>> > > > > > > installed.
>> > > > > > > However there doesn't seem to exist an ovirt-engine-sdk-
>> > > > > > > python-docs
>> > > > > > > package and I couldn't find any appropriate link on the
>> > > > > > > oVirt
>> > > > > > > documentation pages (http://www.ovirt.org/documentation/)
>> > > > > > > .
>> > > > > > >
>> > > > > > > Any ideas, where the documentation is available?
>> > > > > > >
>> > > > > > > Cheers
>> > > > > > > Frank
>> > > > > > > ___
>> > > > > > > Users mailing list
>> > > > > > > Users@ovirt.org 
>> > > > > > > http://lists.ovirt.org/mailman/listinfo/users
>> > > > > > > 
>> > > > > > Other than what you found I found this but that's
>> > > > > > all.  Doesn't
>> > > > > > seem
>> > > > > > to be much other than examples an the one that shows what
>> > > > > > to
>> > > > > > import.
>> > > > > >  I, too would like to find what your are looking for so I
>> > > > > > can
>> > > > > > use it.
>> > > > > There is this RHEV documentation that can be helpful:
>> > > > > https://access.redhat.com/documentation/en-US/Red_Hat_Enterpr
>> > > > > ise_
>> > > > > Virtualization/3.3/html/Developer_Guide/chap-
>> > > > > Python_Quick_Start_Example.html
>> > > > >
>> > > > > >
>> > > > > > http://www.ovirt.org/develop/api/pythonapi/
>> > > > > >
>> > > > > >
>> > > > > > ___
>> > > > > > Users mailing list
>> > > > > > Users@ovirt.org 
>> > > > > > http://lists.ovirt.org/mailman/listinfo/users
>> > > > > > 
>> > > > Thanks.  That is helpful but as Frank said it would be nice to
>> > > > have
>> > > > an
>> > > > api reference for each class and function that gives the
>> > > > parameters,
>> > > > return values, and other stuff usually found in an API
>> > > > reference.  The
>> > > > examples are helpful but don't give all the information abut a
>> > > > function
>> > > > or class.
>> > > Thanks to all who answered.  Brett brings it to the point:  All
>> > > sent
>> > > links so far are indeed helpful - thanks a lot - but not the
>> > > reference I
>> > > expected.
>> > > https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_
>> > > Virt
>> > > ualization/3.6/html/Python_SDK_Guide/chap-
>> > > Python_Reference_Documentation.html#Python_Reference_Documentatio
>> > > n
>> > > mentions `pydoc`, but this documentation seems to be provided
>> > > only
>> > > for
>> > > some modules or to be incomplete.  Also for me not being a
>> > > software
>> > > developper and newish to Python, the `pydoc` information is not
>> > > very
>> > > useful.  Where can I e.g. find the documentation for vms.get()
>> > > and
>> > > vms.add() (just to name teo concrete examples)?
>> > >
>> > > Frank
>> > > ___
>> > > Users mailing list
>> > > Users@ovirt.org
>> > > http://lists.ovirt.org/mailman/listinfo/users
>> > I'm in the same boat as Frank.  I've done programming in various
>> > languages since Fortran without the numbers  but only when
>> > needed
>> > for my job as an Engineer so I'm not a professional but just trying
>> > to
>> > get a job done.  It would be nice to have a full reference so we
>> > know
>> > what to provide.  When trying to connect with the api I finally
>> > figured
>> > out to use ca_file (like ca-file on the command line).  Raz's
>> > reference
>> > is more complete but still leaves a lot out.  The newer equivalent
>> > of
>> > Raz's reference seems to be http://www.ovirt.org/develop/release-ma
>> > nage
>> > ment/features/infra/python-sdk/.
>> The Python/Java/Ruby SDKs are simply language specific wrappers
>> around the REST
>> api. So if you want a full list of all the options available check
>> out the
>> REST api 

Re: [ovirt-users] Looking for Python-SDK documentation

[Brett I. Holcomb]

   1. On Tue, 2016-04-12 at 23:03 +0200, Frank Thommen wrote:
> On 12.04.16 13:57, Alexander Wels wrote:
> > 
> > On Monday, April 11, 2016 05:03:28 PM Brett I. Holcomb wrote:
> > > 
> > > On Mon, 2016-04-11 at 20:41 +0200, Frank Thommen wrote:
> > > > 
> > > > On 11.04.16 20:17, Brett I. Holcomb wrote:
> > > > [...]
> > > I'm in the same boat as Frank.  I've done programming in various
> > > languages since Fortran without the numbers  but only when
> > > needed
> > > for my job as an Engineer so I'm not a professional but just
> > > trying to
> > > get a job done.  It would be nice to have a full reference so we
> > > know
> > > what to provide.  When trying to connect with the api I finally
> > > figured
> > > out to use ca_file (like ca-file on the command line).  Raz's
> > > reference
> > > is more complete but still leaves a lot out.  The newer
> > > equivalent of
> > > Raz's reference seems to be http://www.ovirt.org/develop/release-
> > > manage
> > > ment/features/infra/python-sdk/.
> > The Python/Java/Ruby SDKs are simply language specific wrappers
> > around the REST
> > api. So if you want a full list of all the options available check
> > out the
> > REST api documentation. You will have to translate a particular
> > REST api
> > field/feature to the SDK, but all the SDKs are generated from the
> > REST api
> > interface definition so the naming and everything should be the
> > same.
> That makes sense, thanks.  On the other hand I could also not find
> any 
> REST api reference.  Just some pages with examples a la "find it out 
> yourself from there"...
> 
> frank
> ___
> Users mailing list
> Users@ovirt.org
> http://lists.ovirt.org/mailman/listinfo/users

Same here.  A lot of examples, some more detailed but no "API Reference
Manual for oVirt REST API" like we had in the old days .

___
Users mailing list
Users@ovirt.org
http://lists.ovirt.org/mailman/listinfo/users

Re: [ovirt-users] Looking for Python-SDK documentation

[Frank Thommen]

On 12.04.16 13:57, Alexander Wels wrote:

On Monday, April 11, 2016 05:03:28 PM Brett I. Holcomb wrote:

On Mon, 2016-04-11 at 20:41 +0200, Frank Thommen wrote:

On 11.04.16 20:17, Brett I. Holcomb wrote:
[...]

I'm in the same boat as Frank.  I've done programming in various
languages since Fortran without the numbers  but only when needed
for my job as an Engineer so I'm not a professional but just trying to
get a job done.  It would be nice to have a full reference so we know
what to provide.  When trying to connect with the api I finally figured
out to use ca_file (like ca-file on the command line).  Raz's reference
is more complete but still leaves a lot out.  The newer equivalent of
Raz's reference seems to be http://www.ovirt.org/develop/release-manage
ment/features/infra/python-sdk/.


The Python/Java/Ruby SDKs are simply language specific wrappers around the REST
api. So if you want a full list of all the options available check out the
REST api documentation. You will have to translate a particular REST api
field/feature to the SDK, but all the SDKs are generated from the REST api
interface definition so the naming and everything should be the same.


That makes sense, thanks.  On the other hand I could also not find any 
REST api reference.  Just some pages with examples a la "find it out 
yourself from there"...


frank
___
Users mailing list
Users@ovirt.org
http://lists.ovirt.org/mailman/listinfo/users

Re: [ovirt-users] Looking for Python-SDK documentation

[Brett I. Holcomb]

On Tue, 2016-04-12 at 07:57 -0400, Alexander Wels wrote:
> On Monday, April 11, 2016 05:03:28 PM Brett I. Holcomb wrote:
> > 
> > On Mon, 2016-04-11 at 20:41 +0200, Frank Thommen wrote:
> > > 
> > > On 11.04.16 20:17, Brett I. Holcomb wrote:
> > > > 
> > > > On Mon, 2016-04-11 at 14:38 -0300, Amador Pahim wrote:
> > > > > 
> > > > > On 04/11/2016 02:07 PM, Brett I. Holcomb wrote:
> > > > > > 
> > > > > > On Mon, 2016-04-11 at 17:27 +0200, Frank Thommen wrote:
> > > > > > > 
> > > > > > > Dear all,
> > > > > > > 
> > > > > > > I'm currently lost at finding any documentation about the
> > > > > > > Python SDK
> > > > > > > (http://www.ovirt.org/develop/release-management/features
> > > > > > > /inf
> > > > > > > ra/python-sdk/)
> > > > > > > like provided classes, functions etc..  There are some
> > > > > > > examples on the
> > > > > > > mentioned page, but I cannot find a complete
> > > > > > > documentation.  Our oVirt
> > > > > > > server is running CentOS 7 with ovirt-engine-sdk-python
> > > > > > > installed.
> > > > > > > However there doesn't seem to exist an ovirt-engine-sdk-
> > > > > > > python-docs
> > > > > > > package and I couldn't find any appropriate link on the
> > > > > > > oVirt
> > > > > > > documentation pages (http://www.ovirt.org/documentation/)
> > > > > > > .
> > > > > > > 
> > > > > > > Any ideas, where the documentation is available?
> > > > > > > 
> > > > > > > Cheers
> > > > > > > Frank
> > > > > > > ___
> > > > > > > Users mailing list
> > > > > > > Users@ovirt.org 
> > > > > > > http://lists.ovirt.org/mailman/listinfo/users
> > > > > > > 
> > > > > > Other than what you found I found this but that's
> > > > > > all.  Doesn't
> > > > > > seem
> > > > > > to be much other than examples an the one that shows what
> > > > > > to
> > > > > > import.
> > > > > >  I, too would like to find what your are looking for so I
> > > > > > can
> > > > > > use it.
> > > > > There is this RHEV documentation that can be helpful:
> > > > > https://access.redhat.com/documentation/en-US/Red_Hat_Enterpr
> > > > > ise_
> > > > > Virtualization/3.3/html/Developer_Guide/chap-
> > > > > Python_Quick_Start_Example.html
> > > > > 
> > > > > > 
> > > > > > http://www.ovirt.org/develop/api/pythonapi/
> > > > > > 
> > > > > > 
> > > > > > ___
> > > > > > Users mailing list
> > > > > > Users@ovirt.org 
> > > > > > http://lists.ovirt.org/mailman/listinfo/users
> > > > > > 
> > > > Thanks.  That is helpful but as Frank said it would be nice to
> > > > have
> > > > an
> > > > api reference for each class and function that gives the
> > > > parameters,
> > > > return values, and other stuff usually found in an API
> > > > reference.  The
> > > > examples are helpful but don't give all the information abut a
> > > > function
> > > > or class.
> > > Thanks to all who answered.  Brett brings it to the point:  All
> > > sent 
> > > links so far are indeed helpful - thanks a lot - but not the
> > > reference I 
> > > expected. 
> > > https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_
> > > Virt
> > > ualization/3.6/html/Python_SDK_Guide/chap-
> > > Python_Reference_Documentation.html#Python_Reference_Documentatio
> > > n 
> > > mentions `pydoc`, but this documentation seems to be provided
> > > only
> > > for 
> > > some modules or to be incomplete.  Also for me not being a
> > > software 
> > > developper and newish to Python, the `pydoc` information is not
> > > very 
> > > useful.  Where can I e.g. find the documentation for vms.get()
> > > and 
> > > vms.add() (just to name teo concrete examples)?
> > > 
> > > Frank
> > > ___
> > > Users mailing list
> > > Users@ovirt.org
> > > http://lists.ovirt.org/mailman/listinfo/users
> > I'm in the same boat as Frank.  I've done programming in various
> > languages since Fortran without the numbers  but only when
> > needed
> > for my job as an Engineer so I'm not a professional but just trying
> > to
> > get a job done.  It would be nice to have a full reference so we
> > know
> > what to provide.  When trying to connect with the api I finally
> > figured
> > out to use ca_file (like ca-file on the command line).  Raz's
> > reference
> > is more complete but still leaves a lot out.  The newer equivalent
> > of
> > Raz's reference seems to be http://www.ovirt.org/develop/release-ma
> > nage
> > ment/features/infra/python-sdk/.
> The Python/Java/Ruby SDKs are simply language specific wrappers
> around the REST 
> api. So if you want a full list of all the options available check
> out the 
> REST api documentation. You will have to translate a particular REST
> api 
> field/feature to the SDK, but all the SDKs are generated from the
> REST api 
> interface definition so the naming and 

Re: [ovirt-users] Looking for Python-SDK documentation

[Alexander Wels]

On Monday, April 11, 2016 05:03:28 PM Brett I. Holcomb wrote:
> On Mon, 2016-04-11 at 20:41 +0200, Frank Thommen wrote:
> > On 11.04.16 20:17, Brett I. Holcomb wrote:
> > > On Mon, 2016-04-11 at 14:38 -0300, Amador Pahim wrote:
> > > > On 04/11/2016 02:07 PM, Brett I. Holcomb wrote:
> > > > > On Mon, 2016-04-11 at 17:27 +0200, Frank Thommen wrote:
> > > > > > Dear all,
> > > > > > 
> > > > > > I'm currently lost at finding any documentation about the
> > > > > > Python SDK
> > > > > > (http://www.ovirt.org/develop/release-management/features/inf
> > > > > > ra/python-sdk/)
> > > > > > like provided classes, functions etc..  There are some
> > > > > > examples on the
> > > > > > mentioned page, but I cannot find a complete
> > > > > > documentation.  Our oVirt
> > > > > > server is running CentOS 7 with ovirt-engine-sdk-python
> > > > > > installed.
> > > > > > However there doesn't seem to exist an ovirt-engine-sdk-
> > > > > > python-docs
> > > > > > package and I couldn't find any appropriate link on the oVirt
> > > > > > documentation pages (http://www.ovirt.org/documentation/).
> > > > > > 
> > > > > > Any ideas, where the documentation is available?
> > > > > > 
> > > > > > Cheers
> > > > > > Frank
> > > > > > ___
> > > > > > Users mailing list
> > > > > > Users@ovirt.org 
> > > > > > http://lists.ovirt.org/mailman/listinfo/users
> > > > > > 
> > > > > 
> > > > > Other than what you found I found this but that's all.  Doesn't
> > > > > seem
> > > > > to be much other than examples an the one that shows what to
> > > > > import.
> > > > >  I, too would like to find what your are looking for so I can
> > > > > use it.
> > > > 
> > > > There is this RHEV documentation that can be helpful:
> > > > https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_
> > > > Virtualization/3.3/html/Developer_Guide/chap-
> > > > Python_Quick_Start_Example.html
> > > > 
> > > > > http://www.ovirt.org/develop/api/pythonapi/
> > > > > 
> > > > > 
> > > > > ___
> > > > > Users mailing list
> > > > > Users@ovirt.org 
> > > > > http://lists.ovirt.org/mailman/listinfo/users
> > > > > 
> > > 
> > > Thanks.  That is helpful but as Frank said it would be nice to have
> > > an
> > > api reference for each class and function that gives the
> > > parameters,
> > > return values, and other stuff usually found in an API
> > > reference.  The
> > > examples are helpful but don't give all the information abut a
> > > function
> > > or class.
> > 
> > Thanks to all who answered.  Brett brings it to the point:  All sent 
> > links so far are indeed helpful - thanks a lot - but not the
> > reference I 
> > expected. 
> > https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Virt
> > ualization/3.6/html/Python_SDK_Guide/chap-
> > Python_Reference_Documentation.html#Python_Reference_Documentation 
> > mentions `pydoc`, but this documentation seems to be provided only
> > for 
> > some modules or to be incomplete.  Also for me not being a software 
> > developper and newish to Python, the `pydoc` information is not very 
> > useful.  Where can I e.g. find the documentation for vms.get() and 
> > vms.add() (just to name teo concrete examples)?
> > 
> > Frank
> > ___
> > Users mailing list
> > Users@ovirt.org
> > http://lists.ovirt.org/mailman/listinfo/users
> 
> I'm in the same boat as Frank.  I've done programming in various
> languages since Fortran without the numbers  but only when needed
> for my job as an Engineer so I'm not a professional but just trying to
> get a job done.  It would be nice to have a full reference so we know
> what to provide.  When trying to connect with the api I finally figured
> out to use ca_file (like ca-file on the command line).  Raz's reference
> is more complete but still leaves a lot out.  The newer equivalent of
> Raz's reference seems to be http://www.ovirt.org/develop/release-manage
> ment/features/infra/python-sdk/.

The Python/Java/Ruby SDKs are simply language specific wrappers around the REST 
api. So if you want a full list of all the options available check out the 
REST api documentation. You will have to translate a particular REST api 
field/feature to the SDK, but all the SDKs are generated from the REST api 
interface definition so the naming and everything should be the same.
___
Users mailing list
Users@ovirt.org
http://lists.ovirt.org/mailman/listinfo/users

Re: [ovirt-users] Looking for Python-SDK documentation

[Brett I. Holcomb]

On Mon, 2016-04-11 at 20:41 +0200, Frank Thommen wrote:
> On 11.04.16 20:17, Brett I. Holcomb wrote:
> > 
> > On Mon, 2016-04-11 at 14:38 -0300, Amador Pahim wrote:
> > > 
> > > 
> > > On 04/11/2016 02:07 PM, Brett I. Holcomb wrote:
> > > > 
> > > > On Mon, 2016-04-11 at 17:27 +0200, Frank Thommen wrote:
> > > > > 
> > > > > Dear all,
> > > > > 
> > > > > I'm currently lost at finding any documentation about the
> > > > > Python SDK
> > > > > (http://www.ovirt.org/develop/release-management/features/inf
> > > > > ra/python-sdk/)
> > > > > like provided classes, functions etc..  There are some
> > > > > examples on the
> > > > > mentioned page, but I cannot find a complete
> > > > > documentation.  Our oVirt
> > > > > server is running CentOS 7 with ovirt-engine-sdk-python
> > > > > installed.
> > > > > However there doesn't seem to exist an ovirt-engine-sdk-
> > > > > python-docs
> > > > > package and I couldn't find any appropriate link on the oVirt
> > > > > documentation pages (http://www.ovirt.org/documentation/).
> > > > > 
> > > > > Any ideas, where the documentation is available?
> > > > > 
> > > > > Cheers
> > > > > Frank
> > > > > ___
> > > > > Users mailing list
> > > > > Users@ovirt.org 
> > > > > http://lists.ovirt.org/mailman/listinfo/users
> > > > > 
> > > > Other than what you found I found this but that's all.  Doesn't
> > > > seem
> > > > to be much other than examples an the one that shows what to
> > > > import.
> > > >  I, too would like to find what your are looking for so I can
> > > > use it.
> > > There is this RHEV documentation that can be helpful:
> > > https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_
> > > Virtualization/3.3/html/Developer_Guide/chap-
> > > Python_Quick_Start_Example.html
> > > 
> > > > 
> > > > 
> > > > http://www.ovirt.org/develop/api/pythonapi/
> > > > 
> > > > 
> > > > ___
> > > > Users mailing list
> > > > Users@ovirt.org 
> > > > http://lists.ovirt.org/mailman/listinfo/users
> > > > 
> > Thanks.  That is helpful but as Frank said it would be nice to have
> > an
> > api reference for each class and function that gives the
> > parameters,
> > return values, and other stuff usually found in an API
> > reference.  The
> > examples are helpful but don't give all the information abut a
> > function
> > or class.
> Thanks to all who answered.  Brett brings it to the point:  All sent 
> links so far are indeed helpful - thanks a lot - but not the
> reference I 
> expected. 
> https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Virt
> ualization/3.6/html/Python_SDK_Guide/chap-
> Python_Reference_Documentation.html#Python_Reference_Documentation 
> mentions `pydoc`, but this documentation seems to be provided only
> for 
> some modules or to be incomplete.  Also for me not being a software 
> developper and newish to Python, the `pydoc` information is not very 
> useful.  Where can I e.g. find the documentation for vms.get() and 
> vms.add() (just to name teo concrete examples)?
> 
> Frank
> ___
> Users mailing list
> Users@ovirt.org
> http://lists.ovirt.org/mailman/listinfo/users
I'm in the same boat as Frank.  I've done programming in various
languages since Fortran without the numbers  but only when needed
for my job as an Engineer so I'm not a professional but just trying to
get a job done.  It would be nice to have a full reference so we know
what to provide.  When trying to connect with the api I finally figured
out to use ca_file (like ca-file on the command line).  Raz's reference
is more complete but still leaves a lot out.  The newer equivalent of
Raz's reference seems to be http://www.ovirt.org/develop/release-manage
ment/features/infra/python-sdk/.
___
Users mailing list
Users@ovirt.org
http://lists.ovirt.org/mailman/listinfo/users

Re: [ovirt-users] Looking for Python-SDK documentation

[Raz Tamir]

Try this http://old.ovirt.org/Python-sdk



Thanks,
Raz Tamir
Red Hat Israel

On Mon, Apr 11, 2016 at 10:57 PM, Jamie Lawrence 
wrote:

>
> > On Apr 11, 2016, at 11:41 AM, Frank Thommen <
> f.thom...@dkfz-heidelberg.de> wrote:
> >
>
> > Thanks to all who answered.  Brett brings it to the point:  All sent
> links so far are indeed helpful - thanks a lot - but not the reference I
> expected.
> https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.6/html/Python_SDK_Guide/chap-Python_Reference_Documentation.html#Python_Reference_Documentation
> mentions `pydoc`, but this documentation seems to be provided only for some
> modules or to be incomplete.  Also for me not being a software developper
> and newish to Python, the `pydoc` information is not very useful.  Where
> can I e.g. find the documentation for vms.get() and vms.add() (just to name
> teo concrete examples)?
>
> I’m pretty sure the examples are all there is at the moment. I spent a
> while looking for reference material a few months ago and haven’t seen
> anything new mentioned in this thread. Between the examples and a couple of
> questions to the list, I managed to piece together what we needed
> (command-line-driven machine creation specific to our needs).
>
> I am a bit hazy on the specifics of what I did, but I recall that the main
> problem I had to ask about was with order-of-operations issues - it wasn’t
> obvious to me that setting some things out of the expected (by the API)
> order wouldn’t work. IIRC, this had to do with setting boot options.
>
> Best of luck,
>
> -j
> ___
> Users mailing list
> Users@ovirt.org
> http://lists.ovirt.org/mailman/listinfo/users
>
___
Users mailing list
Users@ovirt.org
http://lists.ovirt.org/mailman/listinfo/users

Re: [ovirt-users] Looking for Python-SDK documentation

[Jamie Lawrence]

> On Apr 11, 2016, at 11:41 AM, Frank Thommen  
> wrote:
> 

> Thanks to all who answered.  Brett brings it to the point:  All sent links so 
> far are indeed helpful - thanks a lot - but not the reference I expected. 
> https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.6/html/Python_SDK_Guide/chap-Python_Reference_Documentation.html#Python_Reference_Documentation
>  mentions `pydoc`, but this documentation seems to be provided only for some 
> modules or to be incomplete.  Also for me not being a software developper and 
> newish to Python, the `pydoc` information is not very useful.  Where can I 
> e.g. find the documentation for vms.get() and vms.add() (just to name teo 
> concrete examples)?

I’m pretty sure the examples are all there is at the moment. I spent a while 
looking for reference material a few months ago and haven’t seen anything new 
mentioned in this thread. Between the examples and a couple of questions to the 
list, I managed to piece together what we needed (command-line-driven machine 
creation specific to our needs). 

I am a bit hazy on the specifics of what I did, but I recall that the main 
problem I had to ask about was with order-of-operations issues - it wasn’t 
obvious to me that setting some things out of the expected (by the API) order 
wouldn’t work. IIRC, this had to do with setting boot options.

Best of luck,

-j 
___
Users mailing list
Users@ovirt.org
http://lists.ovirt.org/mailman/listinfo/users

Re: [ovirt-users] Looking for Python-SDK documentation

[Frank Thommen]

On 11.04.16 20:17, Brett I. Holcomb wrote:

On Mon, 2016-04-11 at 14:38 -0300, Amador Pahim wrote:


On 04/11/2016 02:07 PM, Brett I. Holcomb wrote:

On Mon, 2016-04-11 at 17:27 +0200, Frank Thommen wrote:

Dear all,

I'm currently lost at finding any documentation about the Python SDK
(http://www.ovirt.org/develop/release-management/features/infra/python-sdk/)
like provided classes, functions etc..  There are some examples on the
mentioned page, but I cannot find a complete documentation.  Our oVirt
server is running CentOS 7 with ovirt-engine-sdk-python installed.
However there doesn't seem to exist an ovirt-engine-sdk-python-docs
package and I couldn't find any appropriate link on the oVirt
documentation pages (http://www.ovirt.org/documentation/).

Any ideas, where the documentation is available?

Cheers
Frank
___
Users mailing list
Users@ovirt.org 
http://lists.ovirt.org/mailman/listinfo/users



Other than what you found I found this but that's all.  Doesn't seem
to be much other than examples an the one that shows what to import.
 I, too would like to find what your are looking for so I can use it.


There is this RHEV documentation that can be helpful:
https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.3/html/Developer_Guide/chap-Python_Quick_Start_Example.html



http://www.ovirt.org/develop/api/pythonapi/


___
Users mailing list
Users@ovirt.org 
http://lists.ovirt.org/mailman/listinfo/users



Thanks.  That is helpful but as Frank said it would be nice to have an
api reference for each class and function that gives the parameters,
return values, and other stuff usually found in an API reference.  The
examples are helpful but don't give all the information abut a function
or class.


Thanks to all who answered.  Brett brings it to the point:  All sent 
links so far are indeed helpful - thanks a lot - but not the reference I 
expected. 
https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.6/html/Python_SDK_Guide/chap-Python_Reference_Documentation.html#Python_Reference_Documentation 
mentions `pydoc`, but this documentation seems to be provided only for 
some modules or to be incomplete.  Also for me not being a software 
developper and newish to Python, the `pydoc` information is not very 
useful.  Where can I e.g. find the documentation for vms.get() and 
vms.add() (just to name teo concrete examples)?


Frank
___
Users mailing list
Users@ovirt.org
http://lists.ovirt.org/mailman/listinfo/users

Re: [ovirt-users] Looking for Python-SDK documentation

[Brett I. Holcomb]

On Mon, 2016-04-11 at 14:38 -0300, Amador Pahim wrote:
> 

On 04/11/2016 02:07 PM, Brett I. Holcomb wrote:
> On Mon, 2016-04-11 at 17:27 +0200, Frank Thommen wrote:
> > Dear all,
> > 
> > I'm currently lost at finding any documentation about the Python
> > SDK 
> > (http://www.ovirt.org/develop/release-management/features/infra/pyt
> > hon-sdk/) 
> > like provided classes, functions etc..  There are some examples on
> > the 
> > mentioned page, but I cannot find a complete documentation.  Our
> > oVirt 
> > server is running CentOS 7 with ovirt-engine-sdk-python installed. 
> > However there doesn't seem to exist an ovirt-engine-sdk-python-
> > docs 
> > package and I couldn't find any appropriate link on the oVirt 
> > documentation pages (http://www.ovirt.org/documentation/).
> > 
> > Any ideas, where the documentation is available?
> > 
> > Cheers
> > Frank
> > ___
> > Users mailing list
> > Users@ovirt.org
> > http://lists.ovirt.org/mailman/listinfo/users
> Other than what you found I found this but that's all.  Doesn't seem
> to be much other than examples an the one that shows what to import.
>  I, too would like to find what your are looking for so I can use
> it.  
 
There is this RHEV documentation that can be helpful:
https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Virtua
lization/3.3/html/Developer_Guide/chap-Python_Quick_Start_Example.html
> 
> http://www.ovirt.org/develop/api/pythonapi/
> 
> 
> ___
> Users mailing list
> Users@ovirt.org
> http://lists.ovirt.org/mailman/listinfo/users
Thanks.  That is helpful but as Frank said it would be nice to have an
api reference for each class and function that gives the parameters,
return values, and other stuff usually found in an API reference.  The
examples are helpful but don't give all the information abut a function
or class.
##SELECTION_END##
>  ___
Users mailing list
Users@ovirt.org
http://lists.ovirt.org/mailman/listinfo/users

Re: [ovirt-users] Looking for Python-SDK documentation

[Amador Pahim]

On 04/11/2016 02:07 PM, Brett I. Holcomb wrote:

On Mon, 2016-04-11 at 17:27 +0200, Frank Thommen wrote:

Dear all,

I'm currently lost at finding any documentation about the Python SDK
(http://www.ovirt.org/develop/release-management/features/infra/python-sdk/)
like provided classes, functions etc..  There are some examples on the
mentioned page, but I cannot find a complete documentation.  Our oVirt
server is running CentOS 7 with ovirt-engine-sdk-python installed.
However there doesn't seem to exist an ovirt-engine-sdk-python-docs
package and I couldn't find any appropriate link on the oVirt
documentation pages (http://www.ovirt.org/documentation/).

Any ideas, where the documentation is available?

Cheers
Frank
___
Users mailing list
Users@ovirt.org 
http://lists.ovirt.org/mailman/listinfo/users 



Other than what you found I found this but that's all.  Doesn't seem 
to be much other than examples an the one that shows what to import. 
 I, too would like to find what your are looking for so I can use it.


There is this RHEV documentation that can be helpful:
https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.3/html/Developer_Guide/chap-Python_Quick_Start_Example.html



http://www.ovirt.org/develop/api/pythonapi/


___
Users mailing list
Users@ovirt.org
http://lists.ovirt.org/mailman/listinfo/users


___
Users mailing list
Users@ovirt.org
http://lists.ovirt.org/mailman/listinfo/users

Re: [ovirt-users] Looking for Python-SDK documentation

[Brett I. Holcomb]

On Mon, 2016-04-11 at 17:27 +0200, Frank Thommen wrote:
> Dear all,
> 
> I'm currently lost at finding any documentation about the Python SDK 
> (http://www.ovirt.org/develop/release-management/features/infra/pytho
> n-sdk/) 
> like provided classes, functions etc..  There are some examples on
> the 
> mentioned page, but I cannot find a complete documentation.  Our
> oVirt 
> server is running CentOS 7 with ovirt-engine-sdk-python installed. 
> However there doesn't seem to exist an ovirt-engine-sdk-python-docs 
> package and I couldn't find any appropriate link on the oVirt 
> documentation pages (http://www.ovirt.org/documentation/).
> 
> Any ideas, where the documentation is available?
> 
> Cheers
> Frank
> ___
> Users mailing list
> Users@ovirt.org
> http://lists.ovirt.org/mailman/listinfo/users
Other than what you found I found this but that's all.  Doesn't seem to
be much other than examples an the one that shows what to import.  I,
too would like to find what your are looking for so I can use it.  
http://www.ovirt.org/develop/api/pythonapi/___
Users mailing list
Users@ovirt.org
http://lists.ovirt.org/mailman/listinfo/users