Red Hat Summit Red Hat SummitSupportConsoleDéveloppeursCommencer un essaiContact

Ce contenu n'est pas disponible dans la langue sélectionnée.

Chapter 16. Using the Software Development Kit

16.1. Connecting to the API Using Python
Copier lien

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
Copy to Clipboard Toggle word wrap
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 /api path. 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 username parameter. 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 insecure parameter is set to True.
port
Specifies the port to use when connecting, where it has not been provided as component of the url parameter. 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 True and False. This parameter is optional and defaults to False.
insecure
Allows a connection via SSL without a certificate authority. Valid values are True and False, and the default is False. If the insecure parameter is set to False then 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 True and False, and the default is False. If the filter parameter is set to False, the authentication credentials provided must be those of an administrative user. If the filter parameter is set to True, 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 True and False. 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
Retour au début
Red Hat logoGithubredditYoutubeTwitter

Apprendre

Essayez, achetez et vendez

Communautés

À propos de la documentation Red Hat

Nous aidons les utilisateurs de Red Hat à innover et à atteindre leurs objectifs grâce à nos produits et services avec un contenu auquel ils peuvent faire confiance. Découvrez nos récentes mises à jour.

Rendre l’open source plus inclusif

Red Hat s'engage à remplacer le langage problématique dans notre code, notre documentation et nos propriétés Web. Pour plus de détails, consultez le Blog Red Hat.

À propos de Red Hat

Nous proposons des solutions renforcées qui facilitent le travail des entreprises sur plusieurs plates-formes et environnements, du centre de données central à la périphérie du réseau.

Theme

© 2025 Red Hat