3.2. 连接到版本 4 中的 Red Hat Virtualization Manager
要连接到 Red Hat Virtualization Manager,您必须通过导入脚本开头的类从 ovirtsdk4.sdk
模块创建一个 Connection 类的实例:
import ovirtsdk4 as sdk
Connection 类的构造器采用几个参数。支持的参数有:
url
-
包含管理器基本 URL 的字符串,如
https://server.example.com/ovirt-engine/api
。 username
-
指定用于连接的用户名,如
admin@internal
。这个参数是必需的。 password
-
指定
username
参数提供的用户名的密码。这个参数是必需的。 token
-
用于访问 API 的可选令牌,而不是用户名和密码。如果没有指定
令牌
参数,则 SDK 将自动创建令牌参数。 insecure
- 指明是否应检查服务器的 TLS 证书和密钥名称的布尔值标志。
ca_file
-
包含可信 CA 证书的 PEM 文件。将使用这些 CA 证书来验证服务器所提供的证书。如果没有设置
ca_file
参数,则使用系统范围的 CA 证书存储。 debug
指明是否应该生成调试输出的布尔值标志。如果值为
True
且log
参数不是None
,则从服务器发送和接收到的数据将写入到日志中。注意用户名和密码写入到调试日志中,因此要小心处理。
在调试模式中禁用压缩,这意味着调试消息会以纯文本形式发送。
log
- 将写入日志消息的日志记录器。
kerberos
- 指明是否应使用 Kerberos 验证的布尔值标志,而不是默认的基本身份验证。
timeout
-
响应等待的最长时间,以秒为单位。值
0(
默认)表示要等待。如果超时在收到响应前过期,则会引发异常。 压缩
-
指明 SDK 是否应该要求服务器发送压缩响应的布尔值标志。默认值为
True
。这是服务器的提示,它可以返回未压缩数据,即使此参数设为True
。在调试模式中禁用压缩,这意味着调试消息会以纯文本形式发送。 sso_url
-
包含服务器基本 SSO URL 的字符串。如果没有提供
sso_
,则默认 SSO URL 从 url 进行计算。url
sso_revoke_url
-
包含 SSO 撤销服务的基本 URL 的字符串。这只有在使用外部身份验证服务时才需要指定。默认情况下,此 URL 会自动从
url
参数的值计算,以便将使用 SSO 服务(属于 Manager 的一部分)执行 SSO 令牌撤销。 sso_token_name
-
从 SSO 服务器返回的 JSON SSO 响应中的令牌名称。默认值为
access_token
。 标头
- 包含标头的字典,应随每个请求一起发送。
连接
-
对主机打开的最大连接数。如果值为
0(
默认),连接数量没有限制。 pipeline
-
要放入 HTTP 管道的最大请求数,而不等待响应。如果值为
0(
默认),则 pipelining 被禁用。
import ovirtsdk4 as sdk # Create a connection to the server: connection = sdk.Connection( url='https://engine.example.com/ovirt-engine/api', username='admin@internal', password='password', ca_file='ca.pem', ) connection.test() print("Connected successfully!") connection.close()
如需支持的方法的完整列表,您可以在 Manager 机器上生成 ovirtsdk.api
模块的文档:
$ pydoc ovirtsdk.api