OpenStackClient

已弃用页面 此页面包含的信息已失效。 仅为历史原因保留在此处。 最后更新于 2015-03-19

[注意：截至 2015 年 1 月，此页面不再维护，OpenStackClient 的当前文档保存在源代码仓库中，可以在 OpenStack 文档 中找到]]

OpenStackClient CLI（又称 OSC）为用户提供了处理与 OpenStack 交互所需的各种命令和参数的改进体验。它将是（或将成为）OpenStack 项目客户端提供的捆绑 CLI 二进制文件的完整替代品。在尽可能的情况下，它利用现有的客户端 Python API 库，以最大限度地减少重复工作。

源代码	https://git.openstack.org/cgit/openstack/python-openstackclient
Bug 追踪器	https://bugs.launchpad.net/python-openstackclient/+bugs
Blueprints	https://blueprints.launchpad.net/python-openstackclient
PyPi	https://pypi.python.org/pypi/python-openstackclient
Tarball	http://tarballs.openstack.org/python-openstackclient
开发者文档	https://docs.openstack.org/developer/python-openstackclient/

状态

状态：v0.4.0 发布于 2014 年 6 月 20 日

python-openstackclient 项目正在进行中，并且已经实现了第一层 API 的基本命令集：Compute（2）、identity（2.0, 3）、image（1, 2）、object-store（1）和 volume（1）。持续的工作可以在 蓝图 中跟踪。

文档

• 命令翻译 - 项目 CLI 命令到 OSC 的映射
• 人类界面指南
• 修订的 OSCLI 身份验证
• Dotfiles - 用户特定的配置和状态

项目目标

• 使用 OpenStack Python 客户端 API 模块，并根据需要进行扩展
• 对命令和参数使用一致的命名和结构
• 提供一致的输出格式，并提供可选的机器可解析格式
• 使用单个二进制方法，其中还包含一个嵌入式 shell，可以在单个身份验证上执行多个命令（参见 libvirt 的 virsh 作为示例）
• 独立于 OpenStack 项目名称；仅引用 API 名称（在尽可能大的程度上）

命令

OpenStack Client 具有 一致且可预测的格式，适用于所有命令。有一个 命令操作列表，以及可以预期从每个操作获得的结果。对象可以由一个或多个单词引用（server 或 access token）。命令的一般格式是正在操作的主要对象，后跟操作，以及可选的附加对象，用于那些操作两个对象的命令，后跟特定于命令的选项和任何必需的位置参数。

还有全局选项，用于控制 OSC 的整体行为，例如提供身份验证凭据或使用特定的 API 版本。所有选项都是通常被称为“长选项”，即它们是前面带有两个破折号（'--'）且内部使用单个破折号代替空格的一个或多个单词。大多数全局选项还具有相应的环境变量，以方便使用。

相关项目

• 项目 Python API 库（python-cinderclient、python-glanceclient、python-keystoneclient、python-novaclient）
• 这方面以前的工作在 UnifiedCommandLineClient
• Perl 实现位于 https://metacpan.org/module/oscompute
• 此页面的原始版本位于 UnifiedCLI

---