红帽全球峰会此内容没有您所选择的语言版本。
Chapter 16. Using the Software Development Kit
16.1. Connecting to the API Using Python
复制链接链接已复制到粘贴板!
To connect to the REST API using Python, you must create an instance of the
API class from the ovirtsdk.api module. To be able to do this, it is necessary to first import the class at the start of the script:
from ovirtsdk.api import API
from ovirtsdk.api import API
The constuctor of the
API class takes a number of arguments. Supported arguments are:
-
url - Specifies the URL of the Manager to connect to, including the
/apipath. This parameter is mandatory. -
username - Specifies the user name to use when connecting, in the User Principle Name (UPN) format. This parameter is mandatory.
-
password - Specifies the password for the user provided by the
usernameparameter. This parameter is mandatory. -
key_file - Specifies a PEM-formatted key file containing the private key associated with the certificate specified by
cert_file. This parameter is optional. -
cert_file - Specifies a PEM-formatted client certificate to be used for establishing the identity of the client on the server. This parameter is optional.
-
ca_file - Specifies the certificate file of the certificate authority for the server. This parameter is mandatory unless the
insecureparameter is set toTrue. -
port - Specifies the port to use when connecting, where it has not been provided as component of the
urlparameter. This parameter is optional. -
timeout - Specifies the amount of time in seconds that is allowed to pass before a request is considered to be timed out. This parameter is optional.
-
persistent_auth - Specifies whether persistent authentication is enabled for this connection. Valid values are
TrueandFalse. This parameter is optional and defaults toFalse. -
insecure - Allows a connection via SSL without a certificate authority. Valid values are
TrueandFalse, and the default isFalse. If theinsecureparameter is set toFalsethen the ca_file must be supplied to secure the connection.This option should be used with caution, as it may allow man-in-the-middle (MITM) attackers to spoof the identity of the server. -
filter - Specifies whether or not the user permission based filter is on or off. Valid values are
TrueandFalse, and the default isFalse. If thefilterparameter is set toFalse, the authentication credentials provided must be those of an administrative user. If thefilterparameter is set toTrue, any user can be used and the Console will filter the actions available to the user based on their permissions. -
debug - Specifies whether debug mode is enabled for this connection. Valid values are
TrueandFalse. This parameter is optional.
You can communicate with multiple Red Hat Storage Console by creating and manipulating separate instances of the
ovirtsdk.API Python class.
For a full list of methods supported by the
API class, refer to the PyDoc output for the ovirtsdk.api package.
22632%2C+Console+Developer+Guide-322-09-2014+17%3A11%3A35Report a bug
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}