命令行界面参考


Red Hat OpenStack Platform 8

Red Hat OpenStack Platform 的命令行客户端

OpenStack Documentation Team

Red Hat Customer Content Services

摘要

本指南从 OpenStack 命令行客户端收集帮助内容以供参考。

第 1 章 OpenStack 命令行客户端

1.1. 概述

您可以使用 OpenStack 命令行客户端运行发出 API 调用的简单命令。您可以从命令行或脚本运行这些命令,以自动执行任务。如果提供 OpenStack 凭据,您可以在任何计算机上运行这些命令。
在内部,每个客户端命令运行嵌入 API 请求的 cURL 命令。OpenStack API 是使用 HTTP 协议的 RESTful API,包括方法、URI、媒体类型和响应代码。
这些开源 Python 客户端在 Linux 或 Mac OS X 系统上运行,可轻松学习和使用。每个 OpenStack 服务都有自己的命令行客户端。在某些客户端命令中,您可以指定 debug 参数来显示该命令的底层 API 请求。这是熟悉 OpenStack API 调用的好方法。
下表列出了每个 OpenStack 服务的命令行客户端及其软件包名称和描述。
Expand
表 1.1. OpenStack 服务和客户端
service 客户端 软件包 描述
块存储 cinder python-cinderclient 创建和管理卷。
Compute nova python-novaclient 创建和管理镜像、实例和类别。
数据库服务 Trove python-troveclient 创建和管理数据库。
身份 keystone python-keystoneclient 创建和管理用户、租户、角色、端点和凭据。
镜像服务 Glance python-glanceclient 创建和管理镜像。
网络 neutron python-neutronclient 为客户机服务器配置网络。此客户端之前被称为 量子
对象存储 swift python-swiftclient 收集统计信息、列出项目、更新元数据以及上传、下载和删除由对象存储服务存储的文件。获取对象存储安装的访问权限,以进行临时处理。
编配 heat python-heatclient 从模板启动堆栈,查看正在运行的堆栈详情,包括事件和资源,以及更新和删除堆栈。
Telemetry ceilometer python-ceilometerclient 跨 OpenStack 创建和收集测量。
OpenStack 通用 客户端正在开发中。
有关客户端安装说明请查看 第 1.2 节 “安装 OpenStack 命令行客户端”。有关 OpenStack RC 文件的详情,请查看 Red Hat OpenStack Platform 最终用户指南

1.2. 安装 OpenStack 命令行客户端

为每个 OpenStack 客户端安装必备软件和 Python 软件包。

1.2.1. 安装先决条件软件

下表列出了您需要运行命令行客户端的软件,并根据需要提供安装说明。
Expand
表 1.2. 先决条件软件
前提条件 描述
Python 2.6 或更高版本
目前,客户端不支持 Python 3。
setuptools 软件包
许多 Linux 发行版提供软件包,使 setuptools 易于安装。在您的软件包管理器中搜索 setuptools 以查找安装软件包。如果您无法找到,请直接从 http://pypi.python.org/pypi/setuptools 下载 setuptools 软件包。

1.2.2. 安装客户端

在按照本节中的说明进行操作时,将 PROJECT 替换为要安装的客户端的小写名称,如 nova。对每个客户端重复此操作。以下值有效:
  • ceilometer - Telemetry API
  • cinder - Block Storage API 和扩展
  • glance - Image Service API
  • Heat - Orchestration API
  • Keystone - Identity 服务 API 和扩展
  • neutron - Networking API
  • nova - Compute API 和扩展
  • Swift - Object Storage API
  • Trove - Database Service API
以下示例显示了使用 yum 安装 nova 客户端的命令。
# yum install python-novaclient
Copy to Clipboard Toggle word wrap
1.2.2.1. 从软件包安装
在 Red Hat Enterprise Linux 中,使用 yum 安装客户端:
# yum install python-PROJECTclient
Copy to Clipboard Toggle word wrap

1.2.3. 升级或删除客户端

要升级客户端,请在 yum install 命令中添加 the- upgrade 选项:
# yum install --upgrade python-PROJECTclient
Copy to Clipboard Toggle word wrap
要删除客户端,请运行 yum erase 命令:
# yum erase python-PROJECTclient
Copy to Clipboard Toggle word wrap

1.2.4. 接下来是什么

在运行客户端命令前,您必须创建并 source PROJECT-openrc.sh 文件来设置环境变量。请参阅 第 1.4 节 “使用 OpenStack RC 文件设置环境变量”

1.3. 发现客户端的版本号

运行以下命令来发现客户端的版本号:
$ PROJECT --version
Copy to Clipboard Toggle word wrap
例如,要查看 nova 客户端的版本号,请运行以下命令:
$ nova --version
Copy to Clipboard Toggle word wrap
返回版本号(示例中为2.15.0)。
2.15.0
Copy to Clipboard Toggle word wrap

1.4. 使用 OpenStack RC 文件设置环境变量

要为 OpenStack 命令行客户端设置所需的环境变量,您必须创建名为 OpenStack rc 文件或 openrc.sh 文件的环境文件。如果 OpenStack 安装提供它,您可以以管理用户或任何其他用户从 OpenStack 控制面板下载 文件。此项目的环境文件包含所有 OpenStack 服务使用的凭据。
提供该文件时,会为当前 shell 设置环境变量。变量使 OpenStack 客户端命令能够与云中运行的 OpenStack 服务通信。
注意
使用环境文件定义环境变量不是 Microsoft Windows 上的常见做法。环境变量通常在"系统属性"对话框的" 高级 "选项卡中定义。

1.4.1. 下载并提供 OpenStack RC 文件

  1. 登录 OpenStack 仪表板,选择要下载 OpenStack RC 文件的项目,然后点 Access & Security
  2. 在 API Access 选项卡中,点 Download OpenStack RC File 并保存文件。文件名将格式为 PROJECT-openrc.sh,其中 PROJECT 是您下载该文件的项目的名称。
  3. PROJECT-openrc.sh 文件复制到您要运行 OpenStack 命令的计算机。
    例如,将文件复制到您要使用 glance 客户端命令上传镜像的计算机。
  4. 在您要运行 OpenStack 命令的任何 shell 上,提供对应项目的 PROJECT-openrc.sh 文件。
    在以下示例中,demo-openrc.sh 文件为 demo 项目提供:
    $ source demo-openrc.sh
    Copy to Clipboard Toggle word wrap
  5. 当您提示输入 OpenStack 密码时,输入下载 PROJECT-openrc.sh 文件的用户的密码。

1.4.2. 创建并提供 OpenStack RC 文件

或者,如果出于某种原因,您无法从控制面板下载该文件,则从头开始创建 PROJECT-openrc.sh 文件。
  1. 在文本编辑器中,创建名为 PROJECT-openrc.sh 文件的文件,并添加以下身份验证信息:
    export OS_USERNAME=username
    export OS_PASSWORD=password
    export OS_TENANT_NAME=projectName
    export OS_AUTH_URL=https://identityHost:portNumber/v2.0
    # The following lines can be omitted
    export OS_TENANT_ID=tenantIDString
    export OS_REGION_NAME=regionName
    Copy to Clipboard Toggle word wrap
    以下示例显示了名为 admin 的项目的信息,其中 OS 用户名也是 admin,而身份主机位于 控制器
    export OS_USERNAME=admin
    export OS_PASSWORD=ADMIN_PASS
    export OS_TENANT_NAME=admin
    export OS_AUTH_URL=http://controller:35357/v2.0
    Copy to Clipboard Toggle word wrap
  2. 在您要运行 OpenStack 命令的任何 shell 上,提供对应项目的 PROJECT-openrc.sh 文件。在本例中,您要提供 admin 项目的 admin -openrc.sh 文件:
    $ source admin-openrc.sh
    Copy to Clipboard Toggle word wrap
注意
使用此方法不会提示您输入密码。密码在 PROJECT-openrc.sh 文件中以明文格式有效。限制此文件的权限以避免安全问题。您也可以从文件中删除 OS_PASSWORD 变量,而可将 use- password 参数用于 OpenStack 客户端命令。

1.4.3. 覆盖环境变量值

运行 OpenStack 客户端命令时,您可以使用各种客户端命令输出中列出的选项来覆盖一些环境变量设置。例如,您可以通过在 keystone 命令中指定密码来覆盖 PROJECT-openrc.sh 文件中的 OS_PASSWORD 设置,如下所示:
$ keystone --os-password PASSWORD service-list
Copy to Clipboard Toggle word wrap
其中 PASSWORD 是您的密码。

第 2 章 Packstack 命令行客户端

username 客户端是命令行界面(CLI),用于安装单一节点(概念验证部署)。本章记录了 2015.1.dev1537.gba5183c 版本 syntax .1.dev1537.gba5183c
有关特定 username 命令的帮助信息 请输入:
$ packstack help COMMAND
Copy to Clipboard Toggle word wrap

2.1. stackstack 用法

Usage: packstack [options] [--help]
Copy to Clipboard Toggle word wrap

2.2. Packstack 可选参数

--version
显示程序的版本号并退出
-h, --help
显示帮助信息并退出
--gen-answer-file=GEN_ANSWER_FILE
生成应答文件的模板。
--answer-file=ANSWER_FILE
以非交互模式运行配置,从配置文件中提取所有信息。使用这个选项排除所有其他选项
--install-hosts=INSTALL_HOSTS
在单一步骤中,在一组主机上安装。格式应该是以逗号分隔的主机列表,第一个设置为控制器,而其他格式则设置为计算节点。如果只提供一个主机,则它将设置为在一个安装中全部。另外,还会生成 answerfile,并且应该使用stackstack 需要第二次运行
--allinone
--install-hosts=<local ipaddr> --novanetwork-pubif=<dev> --novacompute-privif=lo --novanetwork-privif=lo --os-swift-install=y 的缩写,可以使用此选项在此主机上安装一个所有的 OpenStack。
-t TIMEOUT, --timeout=TIMEOUT
puppet Exec 调用的超时
-o, --options
打印应答文件(rst 格式)中可用选项的详细信息。
-d, --debug
在日志中启用 debug
-y, --dry-run
不要执行,只生成清单

2.3. Packstack Global Options

--ssh-public-key=SSH_PUBLIC_KEY
要在服务器上安装的公钥的路径。如果远程服务器上尚未安装可用的密钥,则会提示用户输入密码,并且安装此密钥,因此不需要密码。
--default-password=DEFAULT_PASSWORD
随处使用的默认密码(通过为单个服务或用户设置的密码覆盖)。
--mariadb-install=MARIADB_INSTALL
指定 'y' to install MariaDB. ['y', 'n']
--os-glance-install=OS_GLANCE_INSTALL
指定 'y' 来安装 OpenStack Image Service (glance)。['y', 'n']
--os-cinder-install=OS_CINDER_INSTALL
指定 'y' 来安装 OpenStack Block Storage (cinder)。['y', 'n']
--os-manila-install=OS_MANILA_INSTALL
指定"y"来安装 OpenStack 共享文件系统服务(manila)。['y', 'n']
--os-nova-install=OS_NOVA_INSTALL
指定"y"来安装 OpenStack Compute (nova)。['y', 'n']
--os-neutron-install=OS_NEUTRON_INSTALL
指定"y"来安装 OpenStack Networking (neutron);否则,将使用 Compute Networking (nova)。['y', 'n']
--os-horizon-install=OS_HORIZON_INSTALL
指定 'y' 来安装 OpenStack Dashboard (horizon). ['y', 'n']
--os-swift-install=OS_SWIFT_INSTALL
指定 'y' 来安装 OpenStack Object Storage (swift)。['y', 'n']
--os-ceilometer-install=OS_CEILOMETER_INSTALL
指定"y"来安装 OpenStack Metering (ceilometer)。['y', 'n']
--os-heat-install=OS_HEAT_INSTALL
指定"y"来安装 OpenStack Orchestration (heat)。['y', 'n']
--os-sahara-install=OS_SAHARA_INSTALL
指定"y"来安装 OpenStack 数据处理(sahara)。['y', 'n']
--os-trove-install=OS_TROVE_INSTALL
指定 'y' 来安装 OpenStack Database (trove)['y', 'n']
--os-ironic-install=OS_IRONIC_INSTALL
指定 'y' to install OpenStack Bare Metal Provisioning (ironic)['y', 'n']
--os-client-install=OS_CLIENT_INSTALL
指定"y"来安装 OpenStack 客户端软件包(命令行工具)。也会安装管理员"rc"文件。['y', 'n']
--ntp-servers=NTP_SERVERS
以逗号分隔的 NTP 服务器列表。如果Packstack 不应该在实例上安装 ntpd,请保留 plain。
--exclude-servers=EXCLUDE_SERVERS
要排除安装中的服务器的逗号分隔列表。如果您正在运行具有相同应答文件的Packstack 第二次,并且不想Packstack 覆盖这些服务器配置,这非常有用。如果您不需要排除任何服务器,请保留为空。
--os-debug-mode=OS_DEBUG_MODE
如果要在 debug 模式下运行 OpenStack 服务,请指定 'y',请指定 'n'. ['y', 'n']
--os-controller-host=OS_CONTROLLER_HOST
安装特定于控制器角色的 OpenStack 服务的服务器的 IP 地址(如 API 服务器或仪表板)。
--os-compute-hosts=OS_COMPUTE_HOSTS
要安装计算服务的服务器的 IP 地址列表。
--os-network-hosts=OS_NETWORK_HOSTS
要安装网络服务的服务器的 IP 地址列表,如 Compute 网络(nova network)或 OpenStack Networking (neutron)。
--os-vmware=OS_VMWARE
如果要使用 VMware vCenter 作为 hypervisor 和存储,请指定 'y',请指定 'n'. ['y', 'n']
--unsupported=UNSUPPORTED
如果要使用不支持的参数,请指定 'y'。只有在您知道正在做什么时,才应使用它。在下一个主发行版本前,使用不支持的选项导致的问题不会被修复。['y', 'n']

2.4. PPP vCenter 配置参数

--vcenter-host=VCENTER_HOST
VMware vCenter 服务器的 IP 地址。
--vcenter-username=VCENTER_USERNAME
VMware vCenter 服务器身份验证的用户名。
--vcenter-password=VCENTER_PASSWORD
VMware vCenter 服务器身份验证的密码。
--vcenter-cluster=VCENTER_CLUSTER
VMware vCenter 集群的名称。

2.5. Packstack Server Prepare Configs

--use-epel=USE_EPEL
指定"y"以启用 EPEL 存储库(Extra Packages for Enterprise Linux). ['y', 'n']
--additional-repo=ADDITIONAL_REPO
用于安装的任何其他 yum 存储库的 URL 的逗号分隔列表。

2.6. stack RHEL 配置

--RH-username=RH_USERNAME
要使用 Red Hat Subscription Manager 订阅每个服务器,请在 CONFIG_RH_PW 中包含它。
--rhn-satellite-server=RHN_SATELLITE_SERVER
要订阅每个服务器以从 Satellite 服务器接收更新,请提供 Satellite 服务器的 URL。您还必须提供用户名(CONFIG_SATELLITE_USERNAME)和密码(CONFIG_SATELLITE_PASSWORD)或用于身份验证的访问密钥(CONFIG_SATELLITE_AKEY)。

2.7. Packstack RHN Satellite 配置

--rhn-satellite-username=RHN_SATELLITE_USERNAME
与 RHN Satellite 服务器进行身份验证的用户名 ; 如果您打算使用 access key 进行 Satellite 身份验证,请将此留空。
--rhn-satellite-password=RHN_SATELLITE_PASSWORD
使用 RHN Satellite 服务器进行身份验证的密码 ; 如果您打算使用 access key 进行 Satellite 身份验证,请将此留空。
--rhn-satellite-activation-key=RHN_SATELLITE_ACTIVATION_KEY
Satellite 服务器的访问密钥;如果您打算使用用户名和密码进行 Satellite 身份验证,请将此留空。
--rhn-satellite-cacert=RHN_SATELLITE_CACERT
证书颁发机构的证书路径或 URL,以验证与 Satellite 服务器的连接是否安全。如果您在部署中没有使用 Satellite,请将此留空。
--rhn-satellite-profile=RHN_SATELLITE_PROFILE
应用作 RHN Satellite 中系统的标识符的配置文件名称(如果需要)。
--rhn-satellite-flags=RHN_SATELLITE_FLAGS
传递给 rhnreg_ks 命令的以逗号分隔的标志列表。有效标记有:novirtinfo, norhnsd, nopackages ['novirtinfo', 'norhnsd', 'nopackages']
--rhn-satellite-proxy-host=RHN_SATELLITE_PROXY_HOST
连接到 RHN Satellite 服务器时要使用的 HTTP 代理(如果需要)。

2.8. stack RHN Satellite 代理配置

--rhn-satellite-proxy-username=RHN_SATELLITE_PROXY_USERNAME
使用 Satellite-server HTTP 代理进行身份验证的用户名。
--rhn-satellite-proxy-password=RHN_SATELLITE_PROXY_PASSWORD
使用 Satellite- 服务器 HTTP 代理进行身份验证的用户密码。

2.9. Packstack AMQP 配置参数

--amqp-backend=AMQP_BACKEND
用作 AMQP 代理的服务。允许的值有:qpid, rabbitmq ['qpid', 'rabbitmq']
--amqp-host=AMQP_HOST
要安装 AMQP 服务的服务器的 IP 地址。
--amqp-enable-ssl=AMQP_ENABLE_SSL
指定 'y' 来为 AMQP 服务启用 SSL。['y', 'n']
--amqp-enable-auth=AMQP_ENABLE_AUTH
指定 'y' 来为 AMQP 服务启用身份验证。['y', 'n']

2.10. Packstack AMQP 配置 SSL 参数

--amqp-nss-certdb-pw=AMQP_NSS_CERTDB_PW
AMQP 服务的 NSS 证书数据库的密码。
--amqp-ssl-port=AMQP_SSL_PORT
AMQP 服务在其上侦听 SSL 连接的端口。
--amqp-ssl-cacert-file=AMQP_SSL_CACERT_FILE
AMQP 服务将用于验证的 CAcertificate 的文件名。
--amqp-ssl-cert-file=AMQP_SSL_CERT_FILE
AMQP 服务将用于验证的证书的文件名。
--amqp-ssl-key-file=AMQP_SSL_KEY_FILE
AMQP 服务将用于验证的私钥的文件名。
--amqp-ssl-self-signed=AMQP_SSL_SELF_SIGNED
指定 'y' 以自动生成自签名 SSL 证书和密钥。['y', 'n']

2.11. stack AMQP Config Athentication 参数

--amqp-auth-user=amqp_AUTH_USER
用于 AMQP 身份验证的用户。
--amqp-auth-password=amqp_AUTH_PASSWORD
用于 AMQP 验证的密码。

2.12. Packstack Keystone Config 参数

--keystone-db-passwd=KEYSTONE_DB_PASSWD
用于访问数据库的 Identity 服务(keystone)的密码。
--keystone-region=KEYSTONE_REGION
在 Identity 服务中创建租户时使用的默认区域名称。
--keystone-admin-email=KEYSTONE_ADMIN_EMAIL
Identity 服务 'admin' 用户的电子邮件地址。默认为
--keystone-admin-username=KEYSTONE_ADMIN_USERNAME
Identity 服务 'admin' 用户的用户名。默认为 'admin'。
--keystone-admin-passwd=KEYSTONE_ADMIN_PASSWD
用于 Identity 服务 'admin' 用户的密码。
--keystone-demo-passwd=KEYSTONE_DEMO_PASSWD
用于 Identity 服务"demo"用户的密码。
--keystone-service-name=KEYSTONE_SERVICE_NAME
用于运行 Identity 服务(keystone 或 httpd)的服务名称。['keystone', 'httpd']
--Keystone-identity-backend=KEYSTONE_IDENTITY_BACKEND
Identity 服务后端的类型(sql 或 ldap)。['sql', 'ldap']

2.13. Packstack Glance Config 参数

--glance-db-passwd=GLANCE_DB_PASSWD
用于访问数据库的镜像服务(glance)的密码。
--glance-ks-passwd=GLANCE_KS_PASSWD
用于镜像服务用于通过 Identity 服务进行身份验证的密码。
--Glance-backend=GLANCE_BACKEND
镜像服务的存储后端(控制镜像服务如何存储磁盘镜像)。有效选项包括:file 或 swift (对象存储)。必须启用对象存储服务以将其用作工作后端;否则,Packstack 会回退到 'file'. ['file', 'swift']

2.14. Packstack Cinder 配置参数

--cinder-db-passwd=CINDER_DB_PASSWD
用于访问数据库的块存储服务(cinder)的密码。
--cinder-ks-passwd=CINDER_KS_PASSWD
块存储服务用于通过 Identity 服务进行身份验证的密码。
--Cinder-backend=CINDER_BACKEND
用于块存储服务的存储后端; 有效选项为 lvm, gluster, nfs, vmdk, netapp. ['lvm', 'gluster', 'nfs', 'vmdk', 'netapp']

2.15. Packstack Cinder 卷创建配置参数

--cinder-volumes-create=CINDER_VOLUMES_CREATE
指定"y"来创建块存储卷组。也就是说,Packstack 在 /var/lib/cinder 中创建原始磁盘镜像,并使用回环设备挂载它。这应该只用于测试块存储服务的概念验证安装(文件支持的卷组不适用于生产环境使用)。['y', 'n']

2.16. stackstack Cinder 卷大小配置参数

--cinder-volumes-size=CINDER_VOLUMES_SIZE
块存储卷组的大小。实际卷大小将扩展为 VG 元数据的 3% 空间。请记住,卷组的大小将限制您可以公开给计算实例的磁盘空间量,并且指定的数量必须在用于 /var/lib/cinder 的设备上可用。

2.17. stackstack Cinder gluster Config 参数

--Cinder-gluster-mounts=CINDER_GLUSTER_MOUNTS
要挂载的 Red Hat Storage (gluster)卷共享的一个或逗号分隔的列表。示例: 'ip-address :/vol-name', 'domain:/vol-name'

2.18. stackstack Cinder NFS 配置参数

--cinder-nfs-mounts=CINDER_NFS_MOUNTS
要挂载的单个或以逗号分隔的 NFS 导出列表。示例: 'ip-address:/export-name'

2.19. stack Nova 选项

--nova-db-passwd=NOVA_DB_PASSWD
用于访问数据库的计算服务(nova)的密码。
--nova-ks-passwd=NOVA_KS_PASSWD
用于计算服务用于通过 Identity 服务进行身份验证的密码。
--novasched-cpu-allocation-ratio=NOVASCHED_CPU_ALLOCATION_RATIO
虚拟 CPU 和物理 CPU 的过量使用比率。指定 1.0 以禁用 CPU 过量使用。
--novasched-ram-allocation-ratio=NOVASCHED_RAM_ALLOCATION_RATIO
虚拟到物理 RAM 的过量使用比率。指定 1.0 以禁用 RAM 过量使用。
--novacompute-migrate-protocol=NOVACOMPUTE_MIGRATE_PROTOCOL
用于实例迁移的协议。有效选项包括:tcp 和 ssh。请注意,默认情况下,Compute 用户是使用 /sbin/nologin shell 创建的,因此 SSH 协议将无法正常工作。要使 SSH 协议正常工作,您必须手动在计算主机上配置 Compute 用户。['tcp', 'ssh']
--nova-compute-manager=NOVA_COMPUTE_MANAGER
运行计算服务的经理。

2.20. Packstack Nova 网络选项

--novacompute-privif=NOVACOMPUTE_PRIVIF
计算服务器上扁平 DHCP 的专用接口。
--novanetwork-manager=NOVANETWORK_MANAGER
Compute Network Manager. ['^nova\.network\.manager\.\w+Manager$']
--novanetwork-pubif=NOVANETWORK_PUBIF
计算网络服务器上的公共接口。
--novanetwork-privif=NOVANETWORK_PRIVIF
计算网络服务器上扁平 DHCP 的专用接口。
--novanetwork-fixed-range=NOVANETWORK_FIXED_RANGE
IP Range for flat DHCP. ['^[\:\.\da- fA-f]+(\/\d+){0,1}$']
--novanetwork-floating-range=NOVANETWORK_FLOATING_RANGE
IP Range for floating IP address. ['^[\:\.\da- fA-f]+(\/\d+){0,1}$']
--novanetwork-auto-assign-floating-ip=NOVANETWORK_AUTO_ASSIGN_FLOATING_IP
指定 'y' 以自动将浮动 IP 分配给新实例。['y', 'n']

2.21. Packstack Nova 网络 VLAN 选项

--novanetwork-vlan-start=NOVANETWORK_VLAN_START
第一个 VLAN 用于专用网络(计算网络)。
--novanetwork-num-networks=NOVANETWORK_NUM_NETWORKS
要支持的网络数量(计算网络)。
--novanetwork-network-size=NOVANETWORK_NETWORK_SIZE
每个专用子网中的地址数(计算联网)。

2.22. stack Neutron 配置

--os-neutron-ks-password=OS_NEUTRON_KS_PASSWORD
用于 OpenStack Networking (neutron)与 Identity 服务进行身份验证的密码。
--os-neutron-db-password=OS_NEUTRON_DB_PASSWORD
用于访问数据库的 OpenStack 网络的密码。
--os-neutron-l3-ext-bridge=OS_NEUTRON_L3_EXT_BRIDGE
用于外部流量的 OpenStack 网络 L3 代理的 Open vSwitch 网桥(或 linuxbridge 为空)的名称。如果要使用提供商网络来处理外部流量,请指定 'provider'。
--os-neutron-metadata-pw=OS_NEUTRON_METADATA_PW
OpenStack 网络元数据代理的密码。
--os-neutron-lbaas-install=OS_NEUTRON_LBAAS_INSTALL
指定"y"以安装 OpenStack 网络负载平衡即服务(LBaaS)。['y', 'n']
--os-neutron-metering-agent-install=OS_NEUTRON_METERING_AGENT_INSTALL
指定"y"来安装 OpenStack 网络的 L3 Metering 代理 ['y', 'n']
--neutron-fwaas=NEUTRON_FWAAS
指定"y"以配置 OpenStack 网络防火墙即服务(FWaaS)。['y', 'n']

2.23. stack Neutron LB 代理配置

--os-neutron-lb-interface-mappings=OS_NEUTRON_LB_INTERFACE_MAPPINGS
以逗号分隔的 OpenStack 网络 linuxbridge 插件接口映射列表。列表中的每个元组都必须格式为 <physical_network>:<net_interface>。示例:physnet1:eth1,physnet2:eth2,physnet3:eth3。

2.24. stack Neutron OVS 代理配置

--os-neutron-ovs-bridge-mappings=OS_NEUTRON_OVS_BRIDGE_MAPPINGS
以逗号分隔的 OpenStack 网络 Open vSwitch 插件的网桥映射列表。列表中的每个元组都必须格式为 <physical_network>:<ovs_bridge>。示例:physnet1:br- eth1,physnet2:br-eth2,physnet3:br-eth3
--os-neutron-ovs-bridge-interfaces=OS_NEUTRON_OVS_BRIDGE_INTERFACES
以逗号分隔的 Open vSwitch <bridge>:<interface> 对列表。接口将添加到关联的网桥。

2.25. 用于隧道的stack Neutron OVS 代理配置

--os-neutron-ovs-tunnel-if=OS_NEUTRON_OVS_TUNNEL_IF
Open vSwitch 隧道的接口。stackstack 将用于此虚拟机监控程序上隧道的 IP 地址覆盖到指定接口(如 eth1)上找到的 IP 地址。

2.26. VXLAN 的stack Neutron OVS 代理配置

--os-neutron-ovs-vxlan-udp-port=OS_NEUTRON_OVS_VXLAN_UDP_PORT
VXLAN UDP 端口。

2.27. Packstack NOVACLIENT 配置参数

2.28. stackstack OpenStack Horizon Config 参数

--os-horizon-ssl=OS_HORIZON_SSL
指定 'y' 通过 https 设置 Horizon 通信。['y', 'n']

2.29. Packstack SSL Config 参数

--os-ssl-cert=OS_SSL_CERT
用于 https 服务器上的 SSL 连接的 PEM 编码证书(证书不需要密码短语)。要生成证书,请留空。
--os-ssl-key=OS_SSL_KEY
如果指定了证书,则与证书相对应的 SSL 密钥文件。
--os-ssl-cachain=OS_SSL_CACHAIN
可以编译服务器证书证书链的 PEM 编码的 CA 证书。

2.30. Packstack OpenStack Swift 配置参数

--os-swift-ks-passwd=OS_SWIFT_KS_PASSWD
对象存储服务用来与身份服务进行身份验证的密码。
--os-swift-storages=OS_SWIFT_STORAGES
以逗号分隔的设备列表,用作对象存储的存储设备。每个条目都必须采用 /path/to/dev 格式(例如,指定 /dev/vdb 安装 /dev/vdb 作为对象存储设备;Packstack 不创建文件系统),您必须先执行此操作。如果留空,Packstack 会为测试设置创建一个环回设备。
--os-swift-storage-zones=OS_SWIFT_STORAGE_ZONES
对象存储存储区的数量;这个数字必须不大于配置的存储设备数量。
--os-swift-storage-replicas=OS_SWIFT_STORAGE_REPLICAS
对象存储副本数量;这个数字必须不大于配置的存储区的数量。
--os-swift-storage-fstype=OS_SWIFT_STORAGE_FSTYPE
存储节点的文件系统类型。['xfs', 'ext4']
--os-swift-storage-size=OS_SWIFT_STORAGE_SIZE
对象存储回送文件存储设备的大小。

2.31. stackstack Heat Config 参数

--os-heat-mysql-password=OS_HEAT_MYSQL_PASSWORD
编排服务用户用于对数据库进行身份验证的密码。
--os-heat-ks-passwd=OS_HEAT_KS_PASSWD
用于编排服务用于通过 Identity 服务进行身份验证的密码。
--os-heat-cloudwatch-install=OS_HEAT_CLOUDWATCH_INSTALL
指定 'y' 来安装 Orchestration CloudWatch API。['y', 'n']
--os-heat-cfn-install=OS_HEAT_CFN_INSTALL
指定"y"以安装 Orchestration CloudFormation API。['y', 'n']
--os-heat-domain=OS_HEAT_DOMAIN
编排的 Identity 域的名称。
--os-heat-domain-admin=OS_HEAT_DOMAIN_ADMIN
用于编排的 Identity 域管理用户的名称。
--os-heat-domain-password=OS_HEAT_DOMAIN_PASSWORD
用于编排的 Identity 域管理用户的密码。

2.32. Packstack Provisioning 演示配置

--provision-demo=PROVISION_DEMO
指定 'y' to provision for demo usage and testing. ['y', 'n']
--provision-tempest=PROVISION_TEMPEST
指定 'y' 来配置 OpenStack Integration Test Suite (tempest)进行测试。测试套件需要安装 OpenStack 网络。['y', 'n']

2.33. Packstack Provisioning 演示配置

--provision-demo-floatrange=PROVISION_DEMO_FLOATRANGE
浮动 IP 子网的 CIDR 网络地址。
--provision-image-name=PROVISION_IMAGE_NAME
要分配给 Glance 中的 demo 镜像的名称(默认为"cirros")。
--provision-image-url=PROVISION_IMAGE_URL
在 Glance 中下载和调配镜像的 URL 或本地文件位置(默认为最近"辅助"镜像的 URL)。
--provision-image-format=PROVISION_IMAGE_FORMAT
演示镜像的格式(默认为 "qcow2")。
--provision-image-ssh-user=PROVISION_IMAGE_SSH_USER
从 demo 镜像连接到实例时使用的用户。

2.34. Packstack Ceilometer 配置参数

--ceilometer-ks-passwd=CEILOMETER_KS_PASSWD
用于通过 Identity 服务进行身份验证的 Telemetry 的密码。

2.35. Packstack MONGODB 配置参数

--mongodb-host=MONGODB_HOST
要安装 MongoDB 的服务器的 IP 地址。

2.36. stackstack POSTSCRIPT Config 参数

2.37. Packstack Puppet Config 参数

第 3 章 OpenStack 命令行客户端

openstack 客户端是常见的 OpenStack 命令行界面(CLI)。本章记录了 openstack 版本 1.7.2
如需特定 openstack 命令的帮助信息,请输入:
$ openstack help COMMAND
Copy to Clipboard Toggle word wrap

3.1. OpenStack 用法

usage: openstack [--version] [-v] [--log-file LOG_FILE] [-q] [-h] [--debug] [--os-cloud <cloud-config-name>] [--os-region-name <auth-region-name>] [--os-cacert <ca-bundle-file>] [--verify | --insecure] [--os-default-domain <auth-domain>] [--os-interface <interface>] [--timing] [--os-compute-api-version <compute-api-version>] [--os-network-api-version <network-api-version>] [--os-image-api-version <image-api-version>] [--os-volume-api-version <volume-api-version>] [--os-identity-api-version <identity-api-version>] [--os-auth-type <auth-type>] [--os-project-domain-id <auth-project-domain-id>] [--os-protocol <auth-protocol>] [--os-project-name <auth-project-name>] [--os-trust-id <auth-trust-id>] [--os-service-provider-endpoint <auth-service-provider-endpoint>] [--os-domain-name <auth-domain-name>] [--os-user-domain-id <auth-user-domain-id>] [--os-identity-provider-url <auth-identity-provider-url>] [--os-access-token-endpoint <auth-access-token-endpoint>] [--os-domain-id <auth-domain-id>] [--os-user-domain-name <auth-user-domain-name>] [--os-scope <auth-scope>] [--os-user-id <auth-user-id>] [--os-identity-provider <auth-identity-provider>] [--os-username <auth-username>] [--os-auth-url <auth-auth-url>] [--os-client-secret <auth-client-secret>] [--os-client-id <auth-client-id>] [--os-project-domain-name <auth-project-domain-name>] [--os-password <auth-password>] [--os-endpoint <auth-endpoint>] [--os-url <auth-url>] [--os-token <auth-token>] [--os-project-id <auth-project-id>] [--os-object-api-version <object-api-version>] [--inspector-api-version INSPECTOR_API_VERSION] [--inspector-url INSPECTOR_URL] [--os-tripleoclient-api-version <tripleoclient-api-version>] [--os-data-processing-api-version <data-processing-api-version>] [--os-dns-api-version <dns-api-version>]
Copy to Clipboard Toggle word wrap

3.2. OpenStack 可选参数

--version
显示程序的版本号并退出
-v, --verbose
提高输出的详细程度。可以重复。
--log-file LOG_FILE
指定要记录输出的文件。默认禁用此选项。
-q, --quiet
抑制输出,除了警告和错误外。
-h, --help
显示帮助消息并退出。
--debug
显示错误的回溯。
--os-cloud <cloud-config-name>
clouds.yaml 中的云名称(Env: OS_CLOUD)
--os-region-name <auth-region-name>
身份验证区域名称(Env: OS_REGION_NAME)
--os-cacert <ca-bundle-file>
CA 证书捆绑包文件(Env: OS_CACERT)
--verify
验证服务器证书(默认)
--insecure
禁用服务器证书验证
--os-default-domain <auth-domain>
默认域 ID,default=default (Env: OS_DEFAULT_DOMAIN)
--os-interface <interface>
选择接口类型。有效的接口类型: [admin, public, internal]。(env: OS_INTERFACE)
--timing
打印 API 调用时间信息
--os-compute-api-version <compute-api-version>
compute API 版本, default=2 (Env: OS_COMPUTE_API_VERSION)
--os-network-api-version <network-api-version>
Network API 版本, default=2 (Env: OS_NETWORK_API_VERSION)
--os-image-api-version <image-api-version>
镜像 API 版本,default=1 (Env: OS_IMAGE_API_VERSION)
--os-volume-api-version <volume-api-version>
卷 API 版本,default=2 (Env: OS_VOLUME_API_VERSION)
--os-identity-api-version <identity-api-version>
Identity API 版本, default=2 (Env: OS_IDENTITY_API_VERSION)
--os-auth-type <auth-type>
选择验证类型。可用类型:v2token, admin_token, v2password, v3password, v3scopedsaml, v3oidcpassword, v3unscopedadfs, token, v3token, password, v3unscopedsaml, osc_password, token_endpoint.Default: 基于 --os- username/--os-token (Env: OS_AUTH_TYPE)选择
--os-project-domain-id <auth-project-domain-id>
使用 v3password: 域 ID,包含带有 v3scopedsaml 的项目的域 ID:包含带有 v3unscopedadfs 的项目的域 ID,包含带有 v3unscopedadfs 的项目的域 ID:包含带有 v3token 的项目的域 ID:域 ID 包含带有 v3unscopedsaml 的项目的域 ID:包含带有 osc_password 的项目的域 ID:包含带有 osc_password 的项目的域 ID:包含带有密码的项目(Env: OS_PROJECT_DOMAIN)
--os-protocol <auth-protocol>
使用 v3oidcpassword: 用于联邦身份验证的联邦协议名称。必须与 keystone 服务提供商中配置的 counterpart 名称匹配。通常,值应为 'saml2' 或 'oidc'。(env: OS_PROTOCOL)
--os-project-name <auth-project-name>
使用 v3password: Project name to scope to scope to With v3scopedsaml: Project name to scope to With v3oidcpassword: Project name to With v3unscopedadfs: Project name to scope to With token: Project name to scope to scope to scope to with password: Project name to scope to with v3unscopedadfs: Project name to scope to With token: Project name to scope to With v3unscopedsaml: Project name to scope to With v3oidcpassword: Project name to With v3unscopedadfs: Project name to scope to With token: Project name to scope to with v3oidcpassword: Project name to scope to With v3unscopedadfs: Project name to scope to With v3unscopedadfs: Project name to scope to With v3unscopedadfs: Project name to scope to With v3unscopedadfs: Project name to scope to With v3unscopedadfs: Project name to scope to With v3scopedsaml: Project name to scope to With v3oidcpassword: Project name to With v3unscopedadfs: Project name to scope to With v3unscopedadfs: Project name to With v3unscopedadfs: Project name to scope to With v3unscopedadfs: Project name to scope to With v3unscopedadfs: Project name to scope to With v3unscopedadfs: Project name to With token: Project name to scope to With v3unscopedadfs:
--os-trust-id <auth-trust-id>
使用 v2token: Trust ID with v2password: Trust ID with v3password: Trust ID with v3scopedsaml: Trust ID with v3oidcpassword: Trust ID with v3unscopedadfs: Trust ID with token: Trust ID with v3token: Trust ID with password: Trust ID with v3unscopedsaml: Trust ID with osc_password: Trust ID (Env: OS_TRUST_ID)
--os-service-provider-endpoint <auth-service-provider-endpoint>
使用 v3unscopedadfs:服务提供商的端点(Env: OS_SERVICE_PROVIDER_ENDPOINT)
--os-domain-name <auth-domain-name>
使用 v3password: Domain name to scope to scope to With v3scopedsaml: Domain to scope to With v3oidcpassword: Domain to scope to With v3unscopedadfs: Domain name to scope to With token: Domain name to scope to scope to scope to with password: Domain name to scope to with v3unscopedsaml: Domain name to scope to With token: Domain name to scope to With v3token: Domain name to scope to scope to with v3oidcpassword: Domain to scope to With v3unscopedadfs: Domain name to scope to With token: Domain name to scope to With v3oidcpassword: Domain name to scope to With v3unscopedadfs: Domain name to scope to With v3unscopedadfs: Domain name to scope to With v3unscopedadfs: Domain name to scope to With v3unscopedadfs: Domain name to scope to With v3unscopedadfs: Domain name to With v3scopedsaml: Domain name to scope to With v3oidcpassword: Domain name to With v3unscopedadfs: Domain name to scope to With v3unscopedadfs: Domain name to scope to With v3unscopedadfs: Domain name to scope to With v3unscopedsaml: Domain name to scope to With v3unscopedadfs: Domain name to scope to With v3unscopedadfs: Domain name to scope to With v3scopedsaml: Domain name to scope to With v
--os-user-domain-id <auth-user-domain-id>
使用 v3password: User 的 domain id with password: User's domain id with osc_password: User domain id (Env: OS_USER_DOMAIN_ID)
--os-identity-provider-url <auth-identity-provider-url>
使用 v3unscopedadfs: Identity Provider's URL With v3unscopedsaml: Identity Provider's URL (Env: OS_IDENTITY_PROVIDER_URL)
--os-access-token-endpoint <auth-access-token-endpoint>
使用 v3oidcpassword: OpenID Connect Provider Token Endpoint (Env: OS_ACCESS_TOKEN_ENDPOINT)
--os-domain-id <auth-domain-id>
使用 v3password: Domain ID to scope to scope to With v3scopedsaml: Domain ID to scope to With v3oidcpassword: Domain ID to scope to With v3unscopedadfs: Domain ID to scope to With v3token: Domain ID to scope to with password: Domain ID to scope to with v3unscopedsaml: Domain ID to scope to With token: Domain ID to scope to With v3token: Domain ID to scope to scope to with v3oidcpassword: Domain ID to scope to With v3unscopedadfs: Domain ID to scope to With a token: Domain ID to scope to with v3oidcpassword: Domain ID to scope to With v3unscopedadfs: Domain ID to scope to With v3unscopedadfs: Domain ID to scope to With v3unscopedadfs: Domain ID to scope to With v3unscopedadfs: Domain ID to scope to With v3scopedsaml: Domain ID to scope to With v3oidscopedadfs: Domain ID to scope to With v3unscopedadfs: Domain ID to scope to With v3scopedsaml to scope to with v3oid: Domain ID to scope to With v3unscopedadfs: Domain ID to scope to With v3unscopedsaml: Domain ID to scope to With v3unscopedadfs: Domain ID to scope to With v3unscopedadfs: Domain ID to scope to With v3scopedsaml: Domain ID to scope to with v
--os-user-domain-name <auth-user-domain-name>
使用 v3password: 用户的域名,带有 password: User 的域名带有 osc_password: User 的域名(Env: OS_USER_DOMAIN_NAME)
--os-scope <auth-scope>
使用 v3oidcpassword: 从 OP 请求的 OpenID Connect 范围(Env: OS_SCOPE)
--os-user-id <auth-user-id>
使用 v2password: User ID to login with v3password: User ID with password: User id with osc_password: User id (Env: OS_USER_ID)
--os-identity-provider <auth-identity-provider>
使用 v3oidcpassword: Identity Provider's name with v3unscopedadfs: Identity Provider's name with v3unscopedsaml: Identity Provider's name (Env: OS_IDENTITY_PROVIDER)
--os-username <auth-username>
使用 v2password: Username 使用 v3password: Username with v3oidcpassword: Username with v3unscopedadfs: Username with password: Username with v3unscopedsaml: Username with osc_password: Username with osc_password: Username (Env: OS_USERNAME)
--os-auth-url <auth-auth-url>
使用 v2token: Authentication URL with v2password: Authentication URL with v3password: Authentication URL with v3scopedsaml: Authentication URL with v3oidcpassword: Authentication URL with v3unscopedadfs: Authentication URL with token: Authentication URL with v3token: Authentication URL with v3unscopedsaml: Authentication URL with osc_password: Authentication URL with osc_password: Authentication URL (Env: OS_AUTH_URL)
--os-client-secret <auth-client-secret>
使用 v3oidcpassword: OAuth 2.0 Client Secret (Env: OS_CLIENT_SECRET)
--os-client-id <auth-client-id>
使用 v3oidcpassword: OAuth 2.0 Client ID (Env: OS_CLIENT_ID)
--os-project-domain-name <auth-project-domain-name>
with v3password: Domain name contains project with v3scopedsaml: Domain name contains project with v3oidcpassword: Domain name contains project with v3unscopedadfs: Domain name contains project with token: Domain name contains project with password: Domain name contains project with v3unscopedsaml: Domain name contains project with osc_password: Domain name contains project with带有 osc_password: Domain name contains project with password: Domain name contains project with password: Domain name contains project with v3unscopedadfs: Domain name contains project with with osc_password: Domain name contains project with with v3unscopedsaml: Domain name with with v3unscopedadfs: Domain name contains project with v3unscopedadfs: Domain name contains project with v3unscopedadfs: 包含带有 v3unscopedadfs 的项目的域名,其中包含带有 v3unscopedadfs 的项目的域名,其中包含带有 v3unscopedadfs 的项目的域名,其中包含带有 v3unscopedadfs 的项目的域名,其中包含带有 v3unscopedadfs 的项目的域名,其中包含带有 v3unscopedsa_password: Domain name contains project with v3unscopedsaml: Domain name: 包含带有 osc_password: Domain name with with osc_password: Domain name with带有 osc_password: Domain name with with v3unscopedsaml_DOMAIN_DOMAIN: Domain name contains project
--os-password <auth-password>
使用 v2password: Password to with v3password: User password with v3oidcpassword: Password With v3unscopedadfs: Password With password: User password with v3unscopedsaml: Password With osc_password: User password with v3unscopedadfs: Password With password: User password with v3unscopedsaml: Password With osc_password: User password with v3unscopedsaml: Password With osc_password: User password with v3unscopedadfs: Password with v3unscopedsaml: Password With v3unscopedsaml: Password With v3unscopedadfs: Password With v3unscopedadfs: Password With v3unscopedsaml: Password With v3unscopedadfs: Password With v3unscopedadfs: Password With v3unscopedsaml: Password With v3unscopedadfs: Password With v3unscopedsaml: Password With v3un
--os-endpoint <auth-endpoint>
使用 admin_token :始终与 token_endpoint 一起使用的端点:将始终使用的端点(Env: OS_ENDPOINT)
--os-url <auth-url>
使用 token_endpoint:要使用的特定服务端点(Env: OS_URL)
--os-token <auth-token>
有了 v2token: Token with admin_token: Token,该令牌将始终与 v3scopedsaml: Token 与 token: Token 进行身份验证,与 with v3token: Token 进行身份验证以使用 token_endpoint:令牌将总是与 token_endpoint: Authentication token 进行身份验证(Env: OS_TOKEN)
--os-project-id <auth-project-id>
使用 v3password: Project ID to scope to scope to With v3scopedsaml: Project ID to scope to With v3oidcpassword: Project ID to scope to With v3unscopedadfs: Project ID to scope to With token: Project ID to scope to scope to with password: Project ID to scope to with v3unscopedsaml: Project ID to scope to With for osc_password: Project ID to scope to using password: Project ID to scope to With v3unscopedadfs: Project ID to scope to With token: Project ID to scope to With v3scopedsaml: Project ID to scope to with v3oidcpassword: Project ID to scope to With v3unscopedadfs: Project ID to scope to With v3unscopedadfs: Project ID to scope to With v3unscopedadfs: Project ID to scope to With v3unscopedadfs: Project ID to scope to With v3unscopedadfs: Project ID to scope to With v3scopedsaml: Project ID to scope to With v3unscopedadfs: Project ID to scope to With v3unscopedadfs: Project ID to scope to With v3scopedsaml: Project ID to scope to With v3unscopedadfs: Project ID to scope to With v3unscopedadfs: Project ID to With token: Project ID to scope to With v3unscopedadfs: Project ID to scope to With v3scopedsaml: Project ID to scope to with v3oid
--os-object-api-version <object-api-version>
对象 API 版本,default=1 (Env: OS_OBJECT_API_VERSION)
--inspector-api-version INSPECTOR_API_VERSION
检查器 API 版本,现在只支持 1 (env: INSPECTOR_VERSION)。
--inspector-url INSPECTOR_URL
检查器 URL,默认为 localhost (env: INSPECTOR_URL)。
--os-tripleoclient-api-version <tripleoclient-api-version>
tripleo Client API version, default=1 (Env: OS_TRIPLEOCLIENT_API_VERSION)
--os-data-processing-api-version <data-processing-api-version>
数据处理 API 版本,default=1.1 (Env: OS_DATA_PROCESSING_API_VERSION)
--os-dns-api-version <dns-api-version>
DNS API 版本, default=2 (Env: OS_DNS_API_VERSION)

3.3. 子命令

3.3.1. OpenStack 聚合添加主机

usage: openstack aggregate add host [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <aggregate> <host>
Copy to Clipboard Toggle word wrap
添加主机来聚合

positional 参数

<aggregate>
聚合(名称或 ID)
<host>
要添加到 <aggregate> 的主机

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.2. OpenStack 聚合创建

usage: openstack aggregate create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--zone <availability-zone>] [--property <key=value>] <name>
Copy to Clipboard Toggle word wrap
创建新聚合

positional 参数

<name>
新聚合名称

可选参数

-h, --help
显示帮助信息并退出
--zone <availability-zone>
可用区名称
--property <key=value>
要添加到此聚合的属性(重复选项来设置多个属性)

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.3. OpenStack 聚合删除

usage: openstack aggregate delete [-h] <aggregate>
Copy to Clipboard Toggle word wrap
删除现有聚合

positional 参数

<aggregate>
要删除的聚合(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

3.3.4. OpenStack 聚合列表

usage: openstack aggregate list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long]
Copy to Clipboard Toggle word wrap
列出所有聚合

可选参数

-h, --help
显示帮助信息并退出
--long
列出输出中的其他字段

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.5. OpenStack 聚合删除主机

usage: openstack aggregate remove host [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <aggregate> <host>
Copy to Clipboard Toggle word wrap
从聚合中删除主机

positional 参数

<aggregate>
聚合(名称或 ID)
<host>
从 <aggregate> 中删除的主机

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.6. OpenStack 聚合集

usage: openstack aggregate set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name <name>] [--zone <availability-zone>] [--property <key=value>] <aggregate>
Copy to Clipboard Toggle word wrap
设置聚合属性

positional 参数

<aggregate>
要修改的聚合(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--name <name>
设置聚合名称
--zone <availability-zone>
设置可用区名称
--property <key=value>
要在 <aggregate> 上设置的属性(重复选项来设置多个属性)

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.7. OpenStack 聚合显示

usage: openstack aggregate show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <aggregate>
Copy to Clipboard Toggle word wrap
显示聚合详情

positional 参数

<aggregate>
要显示的聚合(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.8. OpenStack 可用区列表

usage: openstack availability zone list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long]
Copy to Clipboard Toggle word wrap
列出可用区及其状态

可选参数

-h, --help
显示帮助信息并退出
--long
列出输出中的其他字段

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.9. OpenStack 备份创建

usage: openstack backup create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--container <container>] [--name <name>] [--description <description>] <volume>
Copy to Clipboard Toggle word wrap
创建新备份

positional 参数

<volume>
要备份的卷(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--container <container>
可选备份容器名称
--name <name>
备份的名称
--description <description>
备份的描述

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.10. OpenStack backup delete

usage: openstack backup delete [-h] <backup> [<backup> ...]
Copy to Clipboard Toggle word wrap
删除备份

positional 参数

<backup>
备份要删除的(仅限 ID)

可选参数

-h, --help
显示帮助信息并退出

3.3.11. OpenStack 备份列表

usage: openstack backup list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long]
Copy to Clipboard Toggle word wrap
列出备份

可选参数

-h, --help
显示帮助信息并退出
--long
列出输出中的其他字段

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.12. OpenStack 备份恢复

usage: openstack backup restore [-h] <backup> <volume>
Copy to Clipboard Toggle word wrap
恢复备份

positional 参数

<backup>
备份以恢复(仅限 ID)
<volume>
要恢复到的卷(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

3.3.13. OpenStack 备份显示

usage: openstack backup show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <backup>
Copy to Clipboard Toggle word wrap
显示备份详情

positional 参数

<backup>
备份以显示(仅限 ID)

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.14. OpenStack baremetal 内省规则删除

usage: openstack baremetal introspection rule delete [-h] uuid
Copy to Clipboard Toggle word wrap
删除内省规则。

positional 参数

uuid
规则 UUID

可选参数

-h, --help
显示帮助信息并退出

3.3.15. OpenStack baremetal 内省规则导入

usage: openstack baremetal introspection rule import [-h] file
Copy to Clipboard Toggle word wrap
从 json 文件导入一个或多个内省规则。

positional 参数

file
要导入的 JSON 文件,可能包含一个或多个规则

可选参数

-h, --help
显示帮助信息并退出

3.3.16. OpenStack baremetal 内省规则列表

usage: openstack baremetal introspection rule list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
列出所有内省规则。

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.17. OpenStack baremetal 内省规则清除

usage: openstack baremetal introspection rule purge [-h]
Copy to Clipboard Toggle word wrap
丢弃所有内省规则。

可选参数

-h, --help
显示帮助信息并退出

3.3.18. OpenStack baremetal 内省规则显示

usage: openstack baremetal introspection rule show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] uuid
Copy to Clipboard Toggle word wrap
显示内省规则。

positional 参数

uuid
规则 UUID

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.19. OpenStack baremetal introspection start

usage: openstack baremetal introspection start [-h] [--new-ipmi-username NEW_IPMI_USERNAME] [--new-ipmi-password NEW_IPMI_PASSWORD] uuid
Copy to Clipboard Toggle word wrap
启动内省。

positional 参数

uuid
裸机节点 UUID

可选参数

-h, --help
显示帮助信息并退出
--new-ipmi-username NEW_IPMI_USERNAME
如果设置,则 *Ironic Inspector* 会将 IPMI 用户名更新为这个值
--new-ipmi-password NEW_IPMI_PASSWORD
如果设置,则 *Ironic Inspector* 会将 IPMI 密码更新为这个值

3.3.20. OpenStack baremetal 内省状态

usage: openstack baremetal introspection status [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] uuid
Copy to Clipboard Toggle word wrap
获取内省状态。

positional 参数

uuid
裸机节点 UUID

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.21. OpenStack 目录列表

usage: openstack catalog list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
列出服务目录中的服务

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.22. OpenStack 目录显示

usage: openstack catalog show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <service>
Copy to Clipboard Toggle word wrap
显示服务目录详情

positional 参数

<service>
要显示的服务(类型或名称)

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.23. OpenStack 命令列表

usage: openstack command list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
按组列出可识别的命令

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.24. OpenStack 计算代理创建

usage: openstack compute agent create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <os> <architecture> <version> <url> <md5hash> <hypervisor>
Copy to Clipboard Toggle word wrap
创建计算代理命令

positional 参数

<os>
操作系统类型
<architecture>
架构类型
<version>
Version
<url>
URL
<md5hash>
MD5 哈希
<hypervisor>
hypervisor 的类型

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.25. OpenStack 计算代理删除

usage: openstack compute agent delete [-h] <id>
Copy to Clipboard Toggle word wrap
删除计算代理命令

positional 参数

<id>
要删除的代理 ID

可选参数

-h, --help
显示帮助信息并退出

3.3.26. OpenStack 计算代理列表

usage: openstack compute agent list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--hypervisor <hypervisor>]
Copy to Clipboard Toggle word wrap
列出计算代理命令

可选参数

-h, --help
显示帮助信息并退出
--hypervisor <hypervisor>
hypervisor 的类型

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.27. OpenStack 计算代理集

usage: openstack compute agent set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <id> <version> <url> <md5hash>
Copy to Clipboard Toggle word wrap
设置计算代理命令

positional 参数

<id>
代理的 ID
<version>
代理的版本
<url>
URL
<md5hash>
MD5 哈希

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.28. OpenStack 计算服务列表

usage: openstack compute service list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--host <host>] [--service <service>]
Copy to Clipboard Toggle word wrap
列出 service 命令

可选参数

-h, --help
显示帮助信息并退出
--host <host>
主机的名称
--service <service>
服务的名称

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.29. OpenStack 计算服务集

usage: openstack compute service set [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--enable | --disable] <host> <service>
Copy to Clipboard Toggle word wrap
设置 service 命令

positional 参数

<host>
主机的名称
<service>
服务的名称

可选参数

-h, --help
显示帮助信息并退出
--enable
启用服务
--disable
禁用服务

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.30. OpenStack 配置显示

usage: openstack configuration show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--mask | --unmask]
Copy to Clipboard Toggle word wrap
显示配置详情

可选参数

-h, --help
显示帮助信息并退出
--mask
尝试屏蔽密码(默认)
--unmask
以明文形式显示密码

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.31. OpenStack 控制台日志显示

usage: openstack console log show [-h] [--lines <num-lines>] <server>
Copy to Clipboard Toggle word wrap
显示服务器的控制台输出

positional 参数

<server>
服务器以显示控制台日志(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--lines <num-lines>
从日志末尾显示的行数(default=all)

3.3.32. OpenStack 控制台 url 显示

usage: openstack console url show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--novnc | --xvpvnc | --spice] <server>
Copy to Clipboard Toggle word wrap
显示服务器的远程控制台 URL

positional 参数

<server>
服务器以显示 URL (名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--novnc
显示 noVNC 控制台 URL (默认)
--xvpvnc
show xpvnc 控制台 URL
--SPICE
显示 SPICE 控制台 URL

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.33. OpenStack 容器创建

usage: openstack container create [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] <container-name> [<container-name> ...]
Copy to Clipboard Toggle word wrap
创建新容器

positional 参数

<container-name>
新容器名称

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.34. OpenStack 容器删除

usage: openstack container delete [-h] <container> [<container> ...]
Copy to Clipboard Toggle word wrap
删除容器

positional 参数

<container>
要删除的容器

可选参数

-h, --help
显示帮助信息并退出

3.3.35. OpenStack 容器列表

usage: openstack container list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--prefix <prefix>] [--marker <marker>] [--end-marker <end-marker>] [--limit <limit>] [--long] [--all]
Copy to Clipboard Toggle word wrap
列出容器

可选参数

-h, --help
显示帮助信息并退出
--prefix <prefix>
使用 <prefix> 过滤列表
--marker <marker>
用于分页的 anchor
--end-marker <end-marker>
结束分页锚
--limit <limit>
限制返回的容器数量
--long
列出输出中的其他字段
--all
列出所有容器(默认为 10000)

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.36. OpenStack 容器保存

usage: openstack container save [-h] <container>
Copy to Clipboard Toggle word wrap
在本地保存容器内容

positional 参数

<container>
要保存的容器

可选参数

-h, --help
显示帮助信息并退出

3.3.37. OpenStack 容器显示

usage: openstack container show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <container>
Copy to Clipboard Toggle word wrap
显示容器详情

positional 参数

<container>
要显示的容器

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.38. OpenStack 数据处理数据源创建

usage: openstack dataprocessing data source create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --type <type> --url <url> [--username <username>] [--password <password>] [--description <description>] <name>
Copy to Clipboard Toggle word wrap
创建数据源

positional 参数

<name>
数据源的名称

可选参数

-h, --help
显示帮助信息并退出
--type <type>
数据源的类型(swift、hdfs 或 maprfs)[REQUIRED]
--url <url>
数据源的 URL [REQUIRED]
--username <username>
用于访问数据源 url 的用户名
--password <password>
用于访问数据源 url 的密码
--description <description>
数据源的描述

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.39. OpenStack 数据源删除

usage: openstack dataprocessing data source delete [-h] <data-source>
Copy to Clipboard Toggle word wrap
删除数据源

positional 参数

<data-source>
要删除的数据源的名称或 id

可选参数

-h, --help
显示帮助信息并退出

3.3.40. OpenStack 数据处理数据源列表

usage: openstack dataprocessing data source list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long] [--type <type>]
Copy to Clipboard Toggle word wrap
列出数据源

可选参数

-h, --help
显示帮助信息并退出
--long
列出输出中的其他字段
--type <type>
列出特定类型的数据源(swift、hdfs 或映射rfs)

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.41. OpenStack 数据处理数据源显示

usage: openstack dataprocessing data source show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <data-source>
Copy to Clipboard Toggle word wrap
显示数据源详情

positional 参数

<data-source>
要显示的数据源的名称或 id

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.42. OpenStack 数据处理插件配置获取

usage: openstack dataprocessing plugin configs get [-h] [--file <file>] <plugin> <version>
Copy to Clipboard Toggle word wrap
获取插件配置

positional 参数

<plugin>
用于提供配置信息的插件名称
<version>
用于提供配置信息的插件版本

可选参数

-h, --help
显示帮助信息并退出
--file <file>
目标文件(默认为插件名称)

3.3.43. OpenStack dataprocessing 插件列表

usage: openstack dataprocessing plugin list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long]
Copy to Clipboard Toggle word wrap
列出插件

可选参数

-h, --help
显示帮助信息并退出
--long
列出输出中的其他字段

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.44. OpenStack 数据处理插件显示

usage: openstack dataprocessing plugin show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <plugin>
Copy to Clipboard Toggle word wrap
显示插件详情

positional 参数

<plugin>
要显示的插件名称

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.45. OpenStack ec2 凭据创建

usage: openstack ec2 credentials create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--project <project>] [--user <user>]
Copy to Clipboard Toggle word wrap
创建 EC2 凭证

可选参数

-h, --help
显示帮助信息并退出
--project <project>
在项目中创建凭证(名称或 ID;默认:当前验证的项目)
--user <user>
为用户创建凭证(名称或 ID;默认:当前经过身份验证的用户)

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.46. OpenStack ec2 凭证删除

usage: openstack ec2 credentials delete [-h] [--user <user>] <access-key>
Copy to Clipboard Toggle word wrap
删除 EC2 凭证

positional 参数

<access-key>
凭证访问密钥

可选参数

-h, --help
显示帮助信息并退出
--user <user>
删除用户的凭证(名称或 ID)

3.3.47. OpenStack ec2 凭证列表

usage: openstack ec2 credentials list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--user <user>]
Copy to Clipboard Toggle word wrap
列出 EC2 凭证

可选参数

-h, --help
显示帮助信息并退出
--user <user>
按用户过滤列表(名称或 ID)

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.48. OpenStack ec2 凭据显示

usage: openstack ec2 credentials show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--user <user>] <access-key>
Copy to Clipboard Toggle word wrap
显示 EC2 凭证详情

positional 参数

<access-key>
凭证访问密钥

可选参数

-h, --help
显示帮助信息并退出
--user <user>
显示用户的凭证(名称或 ID)

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.49. OpenStack 端点创建

usage: openstack endpoint create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --publicurl <url> [--adminurl <url>] [--internalurl <url>] [--region <region-id>] <service>
Copy to Clipboard Toggle word wrap
创建新端点

positional 参数

<service>
新端点服务(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--publicurl <url>
新端点公共 URL (必需)
--adminurl <url>
新的端点管理 URL
--internalURL <url>
新端点内部 URL
--region <region-id>
新端点区域 ID

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.50. OpenStack endpoint delete

usage: openstack endpoint delete [-h] <endpoint-id>
Copy to Clipboard Toggle word wrap
删除端点

positional 参数

<endpoint-id>
要删除的端点 ID

可选参数

-h, --help
显示帮助信息并退出

3.3.51. OpenStack 端点列表

usage: openstack endpoint list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long]
Copy to Clipboard Toggle word wrap
列出端点

可选参数

-h, --help
显示帮助信息并退出
--long
列出输出中的其他字段

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.52. OpenStack 端点显示

usage: openstack endpoint show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <endpoint-id>
Copy to Clipboard Toggle word wrap
显示端点详情

positional 参数

<endpoint-id>
要显示的端点 ID

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.53. OpenStack 扩展列表

usage: openstack extension list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--compute] [--identity] [--network] [--volume] [--long]
Copy to Clipboard Toggle word wrap
列出 API 扩展

可选参数

-h, --help
显示帮助信息并退出
--compute
列出 Compute API 的扩展
--identity
列出 Identity API 的扩展
--network
列出 Network API 的扩展
--volume
列出卷 API 的扩展
--long
列出输出中的其他字段

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.54. OpenStack flavor create

usage: openstack flavor create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--id <id>] [--ram <size-mb>] [--disk <size-gb>] [--ephemeral <size-gb>] [--swap <size-gb>] [--vcpus <vcpus>] [--rxtx-factor <factor>] [--public | --private] <flavor-name>
Copy to Clipboard Toggle word wrap
创建新类别

positional 参数

<flavor-name>
新类别名称

可选参数

-h, --help
显示帮助信息并退出
--id <id>
唯一的类别 ID; 'auto' 创建一个 UUID (默认值:auto)
--ram <size-mb>
以 MB 为单位的内存大小(默认为 256M)
--disk <size-gb>
以 GB 为单位的磁盘大小(默认为 0G)
--ephemeral <size-gb>
临时磁盘大小(以 GB 为单位)(默认值为 0G)
--swap <size-gb>
交换空间大小(以 GB 为单位)(默认值为 0G)
--vcpus <vcpus>
vcpus 数量(默认值 1)
--rxtx-factor <factor>
RX/TX 因素(默认值 1)
--public
类别可用于其他项目(默认)
--private
类别不可用于其他项目

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.55. OpenStack flavor delete

usage: openstack flavor delete [-h] <flavor>
Copy to Clipboard Toggle word wrap
删除类别

positional 参数

<flavor>
类别要删除的类别(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

3.3.56. OpenStack 类别列表

usage: openstack flavor list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--public | --private | --all] [--long]
Copy to Clipboard Toggle word wrap
列出类别

可选参数

-h, --help
显示帮助信息并退出
--public
仅列出公共类别(默认)
--private
仅列出私有类别
--all
列出所有类别,无论是公共还是私有
--long
列出输出中的其他字段

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.57. OpenStack 类别集

usage: openstack flavor set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--property <key=value>] <flavor>
Copy to Clipboard Toggle word wrap
设置类别属性

positional 参数

<flavor>
要修改的类别(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--property <key=value>
此类别添加或修改的属性(重复选项可设置多个属性)

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.58. OpenStack flavor show

usage: openstack flavor show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <flavor>
Copy to Clipboard Toggle word wrap
显示类别详情

positional 参数

<flavor>
要显示的类别(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.59. OpenStack flavor unset

usage: openstack flavor unset [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --property <key> <flavor>
Copy to Clipboard Toggle word wrap
取消设置 flavor 属性

positional 参数

<flavor>
要修改的类别(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--property <key>
从 flavor 移除的属性(重复选项以取消设置多个属性)

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.60. OpenStack 主机列表

usage: openstack host list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--zone <zone>]
Copy to Clipboard Toggle word wrap
列出主机命令

可选参数

-h, --help
显示帮助信息并退出
--zone <zone>
仅返回可用区中的主机。

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.61. OpenStack 主机显示

usage: openstack host show [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] <host>
Copy to Clipboard Toggle word wrap
显示主机命令

positional 参数

<host>
主机的名称

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.62. OpenStack hypervisor 列表

usage: openstack hypervisor list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--matching <hostname>]
Copy to Clipboard Toggle word wrap
列出虚拟机监控程序

可选参数

-h, --help
显示帮助信息并退出
--matching <hostname>
使用 <hostname> 子字符串过滤 hypervisor

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.63. OpenStack hypervisor 显示

usage: openstack hypervisor show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <hypervisor>
Copy to Clipboard Toggle word wrap
显示 hypervisor 详情

positional 参数

<hypervisor>
要显示的虚拟机监控程序(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.64. OpenStack hypervisor stats 显示

usage: openstack hypervisor stats show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX]
Copy to Clipboard Toggle word wrap
显示 hypervisor stats 详情

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.65. OpenStack image add project

usage: openstack image add project [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--project-domain <project-domain>] <image> <project>
Copy to Clipboard Toggle word wrap
将项目与镜像关联

positional 参数

<image>
要共享的镜像(名称或 ID)
<project>
与镜像关联的项目(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--project-domain <project-domain>
项目所属的域(名称或 ID)。当项目名称存在时,可以使用此选项。

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.66. OpenStack 镜像创建

usage: openstack image create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--id <id>] [--container-format <container-format>] [--disk-format <disk-format>] [--min-disk <disk-gb>] [--min-ram <ram-mb>] [--file <file>] [--protected | --unprotected] [--public | --private] [--property <key=value>] [--tag <tag>] <image-name>
Copy to Clipboard Toggle word wrap
创建/上传镜像

positional 参数

<image-name>
新镜像名称

可选参数

-h, --help
显示帮助信息并退出
--id <id>
要保留的镜像 ID
--container-format <container-format>
镜像容器格式(默认: bare)
--disk-format <disk-format>
镜像磁盘格式(默认:raw)
--min-disk <disk-gb>
引导镜像所需的最小磁盘大小,以 GB 为单位
--min-ram <ram-mb>
引导镜像所需的最小 RAM 大小,以 MB 为单位
--file <file>
从本地文件上传镜像
--protected
防止镜像被删除
--unprotected
允许删除镜像(默认)
--public
镜像可以被公共访问
--private
镜像无法被公共访问(默认)
--property <key=value>
在此镜像上设置属性(重复选项可设置多个属性)
--tag <tag>
在此镜像上设置标签(重复选项可设置多个标签)

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.67. OpenStack image delete

usage: openstack image delete [-h] <image> [<image> ...]
Copy to Clipboard Toggle word wrap
删除镜像

positional 参数

<image>
要删除的镜像(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

3.3.68. OpenStack 镜像列表

usage: openstack image list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--public | --private | --shared] [--property <key=value>] [--long] [--sort <key>[:<direction>]]
Copy to Clipboard Toggle word wrap
列出可用的镜像

可选参数

-h, --help
显示帮助信息并退出
--public
仅列出公共镜像
--private
仅列出私有镜像
--shared
仅列出共享镜像
--property <key=value>
根据属性过滤输出
--long
列出输出中的其他字段
--sort <key>[:<direction>]
通过所选键和方向(默认: asc)对输出进行排序,可以用逗号分隔多个键和方向

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.69. OpenStack image remove project

usage: openstack image remove project [-h] [--project-domain <project-domain>] <image> <project>
Copy to Clipboard Toggle word wrap
与镜像解除关联项目

positional 参数

<image>
要取消共享的镜像(名称或 ID)
<project>
与镜像解除关联的项目(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--project-domain <project-domain>
项目所属的域(名称或 ID)。当项目名称存在时,可以使用此选项。

3.3.70. OpenStack 镜像保存

usage: openstack image save [-h] [--file <filename>] <image>
Copy to Clipboard Toggle word wrap
在本地保存镜像

positional 参数

<image>
要保存的镜像(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--file <filename>
下载的镜像保存文件名(默认为 stdout)

3.3.71. OpenStack 镜像集

usage: openstack image set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name <name>] [--architecture <architecture>] [--protected | --unprotected] [--public] [--private] [--instance-uuid <instance_uuid>] [--min-disk <disk-gb>] [--kernel-id <kernel-id>] [--os-version <os-version>] [--disk-format <disk-format>] [--os-distro <os-distro>] [--owner <owner>] [--ramdisk-id <ramdisk-id>] [--min-ram <ram-mb>] [--container-format <container-format>] <image>
Copy to Clipboard Toggle word wrap
设置镜像属性

positional 参数

<image>
要修改的镜像(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--name <name>
新镜像名称
--architecture <architecture>
操作系统架构
--protected
防止镜像被删除
--unprotected
允许删除镜像(默认)
--public
镜像可以被公共访问
--private
镜像无法被公共访问(默认)
--instance-uuid <instance_uuid>
用于创建此镜像的实例 ID
--min-disk <disk-gb>
引导镜像所需的最小磁盘大小,以 GB 为单位
--kernel-id <kernel-id>
Glance 中的映像 ID,在引导 AMI 式镜像时应用作内核
--os-version <os-version>
根据经销商指定的操作系统版本
--disk-format <disk-format>
磁盘格式。有效值: ['None', 'ami', 'ari', 'aki', 'vhd', 'vmdk', 'raw', 'qcow2', 'vdi', 'iso']
--os-distro <os-distro>
操作系统分发的通用名称
--owner <owner>
镜像的新所有者
--ramdisk-id <ramdisk-id>
存储在 Glance 中的 ID,在引导 AMI 式镜像时应用作 ramdisk
--min-ram <ram-mb>
引导镜像所需的 RAM 量(以 MB 为单位)
--container-format <container-format>
容器的格式。有效值: ['None', 'ami', 'ari', 'aki', 'bare', 'ovf', 'ova']

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.72. OpenStack image show

usage: openstack image show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <image>
Copy to Clipboard Toggle word wrap
显示镜像详情

positional 参数

<image>
要显示的镜像(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.73. openstack ip fixed add

usage: openstack ip fixed add [-h] <network> <server>
Copy to Clipboard Toggle word wrap
添加 fixed-ip 命令

positional 参数

<network>
要从中获取 IP 地址的网络的名称
<server>
用于接收 IP 地址的服务器的名称

可选参数

-h, --help
显示帮助信息并退出

3.3.74. openstack ip fixed remove

usage: openstack ip fixed remove [-h] <ip-address> <server>
Copy to Clipboard Toggle word wrap
删除 fixed-ip 命令

positional 参数

<ip-address>
要从服务器中删除的 IP 地址
<server>
从中删除 IP 地址的服务器的名称

可选参数

-h, --help
显示帮助信息并退出

3.3.75. openstack ip floating add

usage: openstack ip floating add [-h] <ip-address> <server>
Copy to Clipboard Toggle word wrap
将 floating-ip 添加到 server

positional 参数

<ip-address>
要添加到服务器的 IP 地址
<server>
服务器以接收 IP 地址(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

3.3.76. openstack ip floating create

usage: openstack ip floating create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <pool>
Copy to Clipboard Toggle word wrap
创建新的 floating-ip

positional 参数

<pool>
从中获取浮动 IP 的池

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.77. openstack ip floating delete

usage: openstack ip floating delete [-h] <ip-address>
Copy to Clipboard Toggle word wrap
删除 floating-ip

positional 参数

<ip-address>
要删除的 IP 地址

可选参数

-h, --help
显示帮助信息并退出

3.3.78. openstack ip floating list

usage: openstack ip floating list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
list floating-ips

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.79. openstack ip floating pool list

usage: openstack ip floating pool list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
list floating-ip-pools

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.80. openstack ip floating remove

usage: openstack ip floating remove [-h] <ip-address> <server>
Copy to Clipboard Toggle word wrap
从 server 中删除 floating-ip

positional 参数

<ip-address>
要从服务器中删除的 IP 地址
<server>
服务器从中删除 IP 地址(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

3.3.81. OpenStack keypair create

usage: openstack keypair create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--public-key <file>] <name>
Copy to Clipboard Toggle word wrap
创建新公钥

positional 参数

<name>
新公钥名称

可选参数

-h, --help
显示帮助信息并退出
--public-key <file>
要添加的公钥的文件名

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.82. OpenStack keypair delete

usage: openstack keypair delete [-h] <key>
Copy to Clipboard Toggle word wrap
删除公钥

positional 参数

<key>
要删除的公钥

可选参数

-h, --help
显示帮助信息并退出

3.3.83. OpenStack keypair list

usage: openstack keypair list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
列出公钥指纹

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.84. OpenStack keypair show

usage: openstack keypair show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--public-key] <key>
Copy to Clipboard Toggle word wrap
显示公钥详情

positional 参数

<key>
要显示的公钥

可选参数

-h, --help
显示帮助信息并退出
--public-key
仅显示裸机公钥

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.85. OpenStack 限制显示

usage: openstack limits show [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] (--absolute | --rate) [--reserved] [--project <project>] [--domain <domain>]
Copy to Clipboard Toggle word wrap
显示计算和卷限制

可选参数

-h, --help
显示帮助信息并退出
--absolute
显示绝对限制
--rate
显示速率限制
--reserved
包括保留计数 [只有 --absolute]
--project <project>
显示特定项目的限值(名称或 ID)[只有 --absolute]
--domain <domain>
拥有 --project (名称或 ID)的域 [只有使用 --absolute] 有效

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.86. OpenStack 模块列表

usage: openstack module list [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--all]
Copy to Clipboard Toggle word wrap
列出模块版本

可选参数

-h, --help
显示帮助信息并退出
--all
显示具有版本信息的所有模块

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.87. OpenStack 网络创建

usage: openstack network create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--enable | --disable] [--share | --no-share] [--project <project>] [--project-domain <project-domain>] <name>
Copy to Clipboard Toggle word wrap
创建新网络

positional 参数

<name>
新网络名称

可选参数

-h, --help
显示帮助信息并退出
--enable
启用网络(默认)
--disable
禁用网络
--share
在项目间共享网络
--no-share
不要在项目间共享网络
--project <project>
所有者的项目(名称或 ID)
--project-domain <project-domain>
项目所属的域(名称或 ID)。当项目名称存在时,可以使用此选项。

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.88. OpenStack network delete

usage: openstack network delete [-h] <network> [<network> ...]
Copy to Clipboard Toggle word wrap
删除网络

positional 参数

<network>
要删除的网络(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

3.3.89. OpenStack 网络列表

usage: openstack network list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--external] [--long]
Copy to Clipboard Toggle word wrap
列出网络

可选参数

-h, --help
显示帮助信息并退出
--external
列出外部网络
--long
列出输出中的其他字段

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.90. OpenStack 网络设置

usage: openstack network set [-h] [--name <name>] [--enable | --disable] [--share | --no-share] <network>
Copy to Clipboard Toggle word wrap
设置网络属性

positional 参数

<network>
要修改的网络(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--name <name>
设置网络名称
--enable
启用网络
--disable
禁用网络
--share
在项目间共享网络
--no-share
不要在项目间共享网络

3.3.91. OpenStack 网络显示

usage: openstack network show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <network>
Copy to Clipboard Toggle word wrap
显示网络详情

positional 参数

<network>
要显示的网络(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.92. OpenStack 对象创建

usage: openstack object create [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] <container> <filename> [<filename> ...]
Copy to Clipboard Toggle word wrap
将对象上传到容器

positional 参数

<container>
新对象的容器
<filename>
要上传的本地文件名

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.93. OpenStack 对象删除

usage: openstack object delete [-h] <container> <object> [<object> ...]
Copy to Clipboard Toggle word wrap
从容器中删除对象

positional 参数

<container>
从 <container> 删除对象
<object>
要删除的对象

可选参数

-h, --help
显示帮助信息并退出

3.3.94. OpenStack 对象列表

usage: openstack object list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--prefix <prefix>] [--delimiter <delimiter>] [--marker <marker>] [--end-marker <end-marker>] [--limit <limit>] [--long] [--all] <container>
Copy to Clipboard Toggle word wrap
列出对象

positional 参数

<container>
要列出的容器

可选参数

-h, --help
显示帮助信息并退出
--prefix <prefix>
使用 <prefix> 过滤列表
--delimiter <delimiter>
使用 <delimiter> 汇总项目
--marker <marker>
用于分页的 anchor
--end-marker <end-marker>
结束分页锚
--limit <limit>
限制返回的对象数量
--long
列出输出中的其他字段
--all
列出容器中的所有对象(默认为 10000)

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.95. OpenStack 对象保存

usage: openstack object save [-h] [--file <filename>] <container> <object>
Copy to Clipboard Toggle word wrap
本地保存对象

positional 参数

<container>
从 <container> 下载 <object>
<object>
要保存的对象

可选参数

-h, --help
显示帮助信息并退出
--file <filename>
目标文件名(默认为对象名称)

3.3.96. OpenStack 对象显示

usage: openstack object show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <container> <object>
Copy to Clipboard Toggle word wrap
显示对象详情

positional 参数

<container>
显示 <container> 中的 <container>
<object>
要显示的对象

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.97. OpenStack overcloud 镜像构建

usage: openstack overcloud image build [-h] [--all] [--type <image type>] [--base-image BASE_IMAGE] [--instack-undercloud-elements INSTACK_UNDERCLOUD_ELEMENTS] [--tripleo-puppet-elements TRIPLEO_PUPPET_ELEMENTS] [--elements-path ELEMENTS_PATH] [--tmp-dir TMP_DIR] [--node-arch NODE_ARCH] [--node-dist NODE_DIST] [--registration-method REG_METHOD] [--use-delorean-trunk] [--delorean-trunk-repo DELOREAN_TRUNK_REPO] [--delorean-repo-file DELOREAN_REPO_FILE] [--overcloud-full-dib-extra-args OVERCLOUD_FULL_DIB_EXTRA_ARGS] [--overcloud-full-name OVERCLOUD_FULL_NAME] [--fedora-user-name FEDORA_USER_NAME] [--agent-name AGENT_NAME] [--deploy-name DEPLOY_NAME] [--discovery-name DISCOVERY_NAME] [--agent-image-element AGENT_IMAGE_ELEMENT] [--deploy-image-element DEPLOY_IMAGE_ELEMENT] [--discovery-image-element DISCOVERY_IMAGE_ELEMENT] [--builder <builder>]
Copy to Clipboard Toggle word wrap
为 overcloud 构建镜像

可选参数

-h, --help
显示帮助信息并退出
--all
构建所有镜像
--type <image type>
按名称构建镜像。一个 agent-ramdisk、deploy- ramdisk、discovery-ramdisk、fedora-user、overcloud-full
--base-image BASE_IMAGE
用作新镜像的基础的镜像文件
--instack-undercloud-elements INSTACK_UNDERCLOUD_ELEMENTS
Instack Undercloud 元素的路径
--tripleo-puppet-elements TRIPLEO_PUPPET_ELEMENTS
TripleO Puppet 元素的路径
--elements-path ELEMENTS_PATH
完整元素路径,用 分隔:
--tmp-dir TMP_DIR
创建镜像的临时目录的路径
--node-arch NODE_ARCH
要构建镜像的架构
--node-dist NODE_DIST
要构建镜像的分发
--registration-method REG_METHOD
注册方法
--use-delorean-trunk
使用 Delorean 中继存储库
--delorean-trunk-repo DELOREAN_TRUNK_REPO
到 Delorean 中继存储库的 URL
--delorean-repo-file DELOREAN_REPO_FILE
delorean repo 配置文件的文件名
--overcloud-full-dib-extra-args OVERCLOUD_FULL_DIB_EXTRA_ARGS
Overcloud 完整的额外参数
--overcloud-full-name OVERCLOUD_FULL_NAME
overcloud 完整镜像名称
--fedora-user-name FEDORA_USER_NAME
Fedora 用户镜像名称
--agent-name AGENT_NAME
IPA ramdisk 镜像的名称
--deploy-name DEPLOY_NAME
部署 ramdisk 镜像的名称
--discovery-name DISCOVERY_NAME
发现 ramdisk 镜像的名称
--agent-image-element AGENT_IMAGE_ELEMENT
IPA 镜像的 DIB 元素
--deploy-image-element DEPLOY_IMAGE_ELEMENT
用于部署镜像的 DIB 元素
--discovery-image-element DISCOVERY_IMAGE_ELEMENT
发现镜像的 DIB 元素
--builder <builder>
镜像构建器。dib 之一

3.3.98. OpenStack overcloud 镜像上传

usage: openstack overcloud image upload [-h] [--image-path IMAGE_PATH] [--os-image OS_IMAGE] [--http-boot HTTP_BOOT] [--update-existing]
Copy to Clipboard Toggle word wrap
从现有镜像文件创建 overcloud glance 镜像。

可选参数

-h, --help
显示帮助信息并退出
--image-path IMAGE_PATH
包含镜像文件的目录路径
--os-image OS_IMAGE
OpenStack 磁盘镜像 filename
--http-boot HTTP_BOOT
发现镜像的根目录
--update-existing
更新镜像(如果已存在)

3.3.99. OpenStack overcloud netenv 验证

usage: openstack overcloud netenv validate [-h] [-f NETENV]
Copy to Clipboard Toggle word wrap
验证网络环境文件。

可选参数

-h, --help
显示帮助信息并退出
-f NETENV, --file NETENV
网络环境文件的路径

3.3.100. OpenStack overcloud 节点删除

usage: openstack overcloud node delete [-h] [--stack STACK] [--templates [TEMPLATES]] [-e <HEAT ENVIRONMENT FILE>] <node> [<node> ...]
Copy to Clipboard Toggle word wrap
删除 overcloud 节点。

positional 参数

<node>
要删除的节点 ID

可选参数

-h, --help
显示帮助信息并退出
--stack STACK
要扩展的 heat 堆栈的名称或 ID (default=Env: OVERCLOUD_STACK_NAME)
--templates [TEMPLATES]
包含要部署的 Heat 模板的目录
-e <HEAT ENVIRONMENT FILE>, --environment-file <HEAT ENVIRONMENT FILE>
要传递给 heat stack- create 或 heat stack-update 命令的环境文件。(可以多次指定。)

3.3.101. OpenStack overcloud 更新堆栈

usage: openstack overcloud update stack [-h] --templates [TEMPLATES] [-i] [-a] [-e <HEAT ENVIRONMENT FILE>] [stack]
Copy to Clipboard Toggle word wrap
更新 overcloud 节点上的软件包

positional 参数

queue
要扩展的 heat 堆栈的名称或 ID (default=Env: OVERCLOUD_STACK_NAME)

可选参数

-h, --help
显示帮助信息并退出
--templates [TEMPLATES]
包含要部署的 Heat 模板的目录
-i, --interactive
-a,--abort
-e <HEAT ENVIRONMENT FILE>, --environment-file <HEAT ENVIRONMENT FILE>
要传递给 heat stack- create 或 heat stack-update 命令的环境文件。(可以多次指定。)

3.3.102. OpenStack 项目创建

usage: openstack project create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--description <description>] [--enable | --disable] [--property <key=value>] [--or-show] <project-name>
Copy to Clipboard Toggle word wrap
创建新项目

positional 参数

<project-name>
新项目名称

可选参数

-h, --help
显示帮助信息并退出
--description <description>
项目描述
--enable
启用项目(默认)
--disable
禁用项目
--property <key=value>
在 <name> 中添加属性(重复选项来设置多个属性)
--or-show
返回现有项目

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.103. OpenStack 项目删除

usage: openstack project delete [-h] <project> [<project> ...]
Copy to Clipboard Toggle word wrap
删除项目

positional 参数

<project>
要删除的项目(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

3.3.104. OpenStack 项目列表

usage: openstack project list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long]
Copy to Clipboard Toggle word wrap
列出项目

可选参数

-h, --help
显示帮助信息并退出
--long
列出输出中的其他字段

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.105. OpenStack 项目集

usage: openstack project set [-h] [--name <name>] [--description <description>] [--enable | --disable] [--property <key=value>] <project>
Copy to Clipboard Toggle word wrap
设置项目属性

positional 参数

<project>
要修改的项目(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--name <name>
设置项目名称
--description <description>
设置项目描述
--enable
启用项目
--disable
禁用项目
--property <key=value>
设置项目属性(重复选项来设置多个属性)

3.3.106. OpenStack 项目显示

usage: openstack project show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <project>
Copy to Clipboard Toggle word wrap
显示项目详情

positional 参数

<project>
要显示的项目(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.107. OpenStack ptr 记录列表

usage: openstack ptr record list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
列出 floatingip ptr 记录

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.108. OpenStack ptr 记录集

usage: openstack ptr record set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--description DESCRIPTION | --no-description] [--ttl TTL | --no-ttl] floatingip_id ptrdname
Copy to Clipboard Toggle word wrap
设置 floatingip ptr 记录

positional 参数

floatingip_id
浮动 IP ID
ptrdname
PTRD 名称

可选参数

-h, --help
显示帮助信息并退出
--description DESCRIPTION
描述
--no-description
--TTL TTL TTL
--no-ttl

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.109. OpenStack ptr 记录显示

usage: openstack ptr record show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] floatingip_id
Copy to Clipboard Toggle word wrap
显示 floatingip ptr 记录详情

positional 参数

floatingip_id
浮动 IP ID

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.110. OpenStack ptr 记录未设置

usage: openstack ptr record unset [-h] floatingip_id
Copy to Clipboard Toggle word wrap
取消设置 floatingip ptr 记录

positional 参数

floatingip_id
浮动 IP ID

可选参数

-h, --help
显示帮助信息并退出

3.3.111. OpenStack 配额集

usage: openstack quota set [-h] [--class] [--properties <properties>] [--ram <ram>] [--secgroup-rules <secgroup-rules>] [--instances <instances>] [--key-pairs <key-pairs>] [--fixed-ips <fixed-ips>] [--secgroups <secgroups>] [--injected-file-size <injected-file-size>] [--floating-ips <floating-ips>] [--injected-files <injected-files>] [--cores <cores>] [--injected-path-size <injected-path-size>] [--gigabytes <gigabytes>] [--volumes <volumes>] [--snapshots <snapshots>] [--volume-type <volume-type>] <project/class>
Copy to Clipboard Toggle word wrap
为项目或类设置配额

positional 参数

<project/class>
为这个项目或类设置配额(name/ID)

可选参数

-h, --help
显示帮助信息并退出
--class
为 <class> 设置配额
--properties <properties>
属性配额的新值
--ram <ram>
ram 配额的新值
--secgroup-rules <secgroup-rules>
secgroup-rules 配额的新值
--instances <instances>
实例配额的新值
--key-pairs <key-pairs>
键对配额的新值
--fixed-ips <fixed-ips>
fixed-ips 配额的新值
--secgroups <secgroups>
secgroups 配额的新值
--injected-file-size <injected-file-size>
injected-file-size 配额的新值
--floating-ips <floating-ips>
floating-ips 配额的新值
--injected-files <injected-files>
injected-files 配额的新值
--cores <cores>
内核配额的新值
--injected-path-size <injected-path-size>
injected-path-size 配额的新值
--gigabytes <gigabytes>
GB 配额的新值
--volumes <volumes>
卷配额的新值
--snapshots <snapshots>
快照配额的新值
--volume-type <volume-type>
为特定 <volume-type> 设置配额

3.3.112. OpenStack 配额显示

usage: openstack quota show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--class | --default] <project/class>
Copy to Clipboard Toggle word wrap
显示项目或类的配额

positional 参数

<project/class>
显示此项目或类(name/ID)

可选参数

-h, --help
显示帮助信息并退出
--class
显示 <class> 的配额
--default
显示 <project> 的默认配额

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.113. OpenStack recordset create

usage: openstack recordset create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --records RECORDS [RECORDS ...] --type TYPE [--ttl TTL] [--description DESCRIPTION] zone_id name
Copy to Clipboard Toggle word wrap
创建新记录集

positional 参数

zone_id
区 ID
名称
recordset Name

可选参数

-h, --help
显示帮助信息并退出
--records RECORDS [RECORDS ...]
recordset Records
--type TYPE
recordset Type
--ttl TTL
生存时间(Seconds)
--description DESCRIPTION
描述

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.114. OpenStack recordset delete

usage: openstack recordset delete [-h] zone_id id
Copy to Clipboard Toggle word wrap
删除记录集

positional 参数

zone_id
区 ID
id
recordset ID

可选参数

-h, --help
显示帮助信息并退出

3.3.115. OpenStack recordset list

usage: openstack recordset list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] zone_id
Copy to Clipboard Toggle word wrap
list recordsets

positional 参数

zone_id
区 ID

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.116. OpenStack recordset set

usage: openstack recordset set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name NAME] [--records RECORDS [RECORDS ...]] [--description DESCRIPTION | --no-description] [--ttl TTL | --no-ttl] zone_id id
Copy to Clipboard Toggle word wrap
设置 recordset 属性

positional 参数

zone_id
区 ID
id
recordset ID

可选参数

-h, --help
显示帮助信息并退出
--name NAME
recordset Name
--records RECORDS [RECORDS ...]
Records
--description DESCRIPTION
描述
--no-description
--TTL TTL TTL
--no-ttl

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.117. OpenStack recordset show

usage: openstack recordset show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] zone_id id
Copy to Clipboard Toggle word wrap
显示记录集详情

positional 参数

zone_id
区 ID
id
recordset ID

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.118. OpenStack 角色添加

usage: openstack role add [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --project <project> --user <user> <role>
Copy to Clipboard Toggle word wrap
为项目添加角色:user

positional 参数

<role>
添加到 <project>:<user> 的角色(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--project <project>
包括 <project> (名称或 ID)
--user <user>
包括 <user> (名称或 ID)

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.119. OpenStack 角色创建

usage: openstack role create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--or-show] <name>
Copy to Clipboard Toggle word wrap
创建新角色

positional 参数

<name>
新角色名称

可选参数

-h, --help
显示帮助信息并退出
--or-show
返回现有角色

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.120. OpenStack 角色删除

usage: openstack role delete [-h] <role> [<role> ...]
Copy to Clipboard Toggle word wrap
删除角色

positional 参数

<role>
要删除的角色(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

3.3.121. OpenStack 角色列表

usage: openstack role list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--project <project>] [--user <user>]
Copy to Clipboard Toggle word wrap
列出角色

可选参数

-h, --help
显示帮助信息并退出
--project <project>
根据 <project> (名称或 ID)过滤角色
--user <user>
根据 <user> (名称或 ID)过滤角色

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.122. OpenStack role remove

usage: openstack role remove [-h] --project <project> --user <user> <role>
Copy to Clipboard Toggle word wrap
从项目 中删除角色:user

positional 参数

<role>
要删除的角色(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--project <project>
包括 <project> (名称或 ID)
--user <user>
包括 <user> (名称或 ID)

3.3.123. OpenStack 角色显示

usage: openstack role show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <role>
Copy to Clipboard Toggle word wrap
显示角色详情

positional 参数

<role>
要显示的角色(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.124. OpenStack 安全组创建

usage: openstack security group create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--description <description>] <name>
Copy to Clipboard Toggle word wrap
创建新安全组

positional 参数

<name>
新安全组名称

可选参数

-h, --help
显示帮助信息并退出
--description <description>
安全组描述

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.125. OpenStack 安全组删除

usage: openstack security group delete [-h] <group>
Copy to Clipboard Toggle word wrap
删除安全组

positional 参数

<group>
要删除的安全组的名称或 ID

可选参数

-h, --help
显示帮助信息并退出

3.3.126. OpenStack 安全组列表

usage: openstack security group list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--all-projects]
Copy to Clipboard Toggle word wrap
列出所有安全组

可选参数

-h, --help
显示帮助信息并退出
--all-projects
显示所有项目的信息(仅限管理员)

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.127. OpenStack 安全组规则创建

usage: openstack security group rule create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--proto <proto>] [--src-ip <ip-address>] [--dst-port <port-range>] <group>
Copy to Clipboard Toggle word wrap
创建新的安全组规则

positional 参数

<group>
在此安全组中创建规则

可选参数

-h, --help
显示帮助信息并退出
--Proto <proto> IP
协议(icmp、tcp、udp;默认为 tcp)
--src-ip <ip-address>
源 IP (可以使用 CIDR 表示法;默认为 0.0.0.0/0)
--dst-port <port-range>
目的地端口,可以是范围:137:139 (默认值: 0,仅适用于 proto tcp 和 udp)

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.128. OpenStack 安全组规则删除

usage: openstack security group rule delete [-h] <rule>
Copy to Clipboard Toggle word wrap
删除安全组规则

positional 参数

<rule>
要删除的安全组规则 ID

可选参数

-h, --help
显示帮助信息并退出

3.3.129. OpenStack 安全组规则列表

usage: openstack security group rule list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] <group>
Copy to Clipboard Toggle word wrap
列出所有安全组规则

positional 参数

<group>
列出此安全组中的所有规则

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.130. OpenStack 安全组设置

usage: openstack security group set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name <new-name>] [--description <description>] <group>
Copy to Clipboard Toggle word wrap
设置安全组属性

positional 参数

<group>
要更改的安全组的名称或 ID

可选参数

-h, --help
显示帮助信息并退出
--name <new-name>
新安全组名称
--description <description>
新安全组名称

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.131. OpenStack 安全组显示

usage: openstack security group show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <group>
Copy to Clipboard Toggle word wrap
显示特定的安全组

positional 参数

<group>
要更改的安全组的名称或 ID

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.132. OpenStack 服务器添加安全组

usage: openstack server add security group [-h] <server> <group>
Copy to Clipboard Toggle word wrap
将安全组添加到服务器

positional 参数

<server>
server (名称或 ID)
<group>
要添加的安全组(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

3.3.133. OpenStack 服务器添加卷

usage: openstack server add volume [-h] [--device <device>] <server> <volume>
Copy to Clipboard Toggle word wrap
将卷添加到服务器

positional 参数

<server>
server (名称或 ID)
<volume>
要添加的卷(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--device <device>
卷的服务器内部设备名称

3.3.134. OpenStack 服务器创建

usage: openstack server create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] (--image <image> | --volume <volume>) --flavor <flavor> [--security-group <security-group-name>] [--key-name <key-name>] [--property <key=value>] [--file <dest-filename=source-filename>] [--user-data <user-data>] [--availability-zone <zone-name>] [--block-device-mapping <dev-name=mapping>] [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid>] [--hint <key=value>] [--config-drive <config-drive-volume>|True] [--min <count>] [--max <count>] [--wait] <server-name>
Copy to Clipboard Toggle word wrap
创建新服务器

positional 参数

<server-name>
新服务器名称

可选参数

-h, --help
显示帮助信息并退出
--image <image>
从此镜像创建服务器
--volume <volume>
从这个卷创建服务器
--flavor <flavor>
创建使用此类别的服务器
--security-group <security-group-name>
要分配给此服务器的安全组(对多个组重复)
--key-name <key-name>
要注入到此服务器的密钥对(可选扩展)
--property <key=value>
在此服务器上设置属性(对多个值重复)
--file <dest-filename=source-filename>
在引导前要注入镜像的文件(对多个文件重复)
--user-data <user-data>
从元数据服务器提供服务的用户数据文件
--availability-zone <zone-name>
为服务器选择一个可用区
--block-device-mapping <dev-name=mapping>
映射块设备;映射为 <id>:<type>:<size (GB)>:<delete_on_terminate> (可选扩展)
--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid>
在服务器上创建 NIC。多次指定选项来创建多个 NIC。必须提供 net-id 或 port- id,但不同时提供 net-id: attach NIC to network with this UUID, port-id: attach NIC to port with this UUID, v4-fixed-ip: IPv4 fixed address for NIC (可选), v6-fixed-ip: IPv6 fixed address for NIC (可选)。
--hint <key=value>
调度程序提示(可选扩展)
--config-drive <config-drive-volume>|True
使用指定的卷作为配置驱动器,或使用 'True' 使用临时驱动器
--min <count>
要启动的最小服务器数量(default=1)
--max <count>
要启动的最大服务器数量(default=1)
--wait
等待构建完成

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.135. OpenStack 服务器删除

usage: openstack server delete [-h] [--wait] <server> [<server> ...]
Copy to Clipboard Toggle word wrap
删除服务器

positional 参数

<server>
要删除的服务器(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--wait
等待删除完成

3.3.136. OpenStack 服务器镜像创建

usage: openstack server image create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name <image-name>] [--wait] <server>
Copy to Clipboard Toggle word wrap
从运行的服务器创建新磁盘镜像

positional 参数

<server>
server (名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--name <image-name>
新镜像的名称(默认为服务器名称)
--wait
等待镜像创建完成

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.137. OpenStack 服务器列表

usage: openstack server list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--reservation-id <reservation-id>] [--ip <ip-address-regex>] [--ip6 <ip-address-regex>] [--name <name-regex>] [--instance-name <server-name>] [--status <status>] [--flavor <flavor>] [--image <image>] [--host <hostname>] [--all-projects] [--project <project>] [--project-domain <project-domain>] [--user <user>] [--user-domain <user-domain>] [--long]
Copy to Clipboard Toggle word wrap
列出服务器

可选参数

-h, --help
显示帮助信息并退出
--reservation-id <reservation-id>
仅返回与保留匹配的实例
--ip <ip-address-regex>
匹配 IP 地址的正则表达式
--ip6 <ip-address-regex>
匹配 IPv6 地址的正则表达式
--name <name-regex>
匹配名称的正则表达式
--instance-name <server-name>
匹配实例名称的正则表达式(仅限管理员)
--status <status>
根据服务器状态搜索
--flavor <flavor>
按类别搜索
--image <image>
按镜像搜索
--host <hostname>
按主机名搜索
--all-projects
包括所有项目(仅限管理员)
--project <project>
按项目(仅限管理员)搜索(仅限管理员)(名称或 ID)
--project-domain <project-domain>
项目所属的域(名称或 ID)。当项目名称存在时,可以使用此选项。
--user <user>
按用户搜索(仅限管理员)(名称或 ID)
--user-domain <user-domain>
用户所属的域(名称或 ID)。如果存在用户名之间的冲突,可以使用它。
--long
列出输出中的其他字段

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.138. OpenStack 服务器锁定

usage: openstack server lock [-h] <server>
Copy to Clipboard Toggle word wrap
锁定服务器。非管理员用户将无法执行操作

positional 参数

<server>
server (名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

3.3.139. OpenStack 服务器迁移

usage: openstack server migrate [-h] [--live <hostname>] [--shared-migration | --block-migration] [--disk-overcommit | --no-disk-overcommit] [--wait] <server>
Copy to Clipboard Toggle word wrap
将服务器迁移到其他主机

positional 参数

<server>
server (名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--live <hostname>
目标主机名
--shared-migration
执行共享实时迁移(默认)
--block-migration
执行块实时迁移
--disk-overcommit
允许目标主机上的磁盘 over-commit
--no-disk-overcommit
不要在目标主机上过量使用磁盘(默认)
--wait
等待调整大小完成

3.3.140. OpenStack 服务器暂停

usage: openstack server pause [-h] <server>
Copy to Clipboard Toggle word wrap
暂停服务器

positional 参数

<server>
server (名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

3.3.141. OpenStack 服务器重启

usage: openstack server reboot [-h] [--hard | --soft] [--wait] <server>
Copy to Clipboard Toggle word wrap
执行硬或软服务器重启

positional 参数

<server>
server (名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--hard
执行硬重启
--soft
执行软重启
--wait
等待重启完成

3.3.142. OpenStack 服务器重建

usage: openstack server rebuild [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --image <image> [--password <password>] [--wait] <server>
Copy to Clipboard Toggle word wrap
重建服务器

positional 参数

<server>
server (名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--image <image>
从此镜像重新创建服务器
--password <password>
在重建实例上设置密码
--wait
等待重建完成

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.143. OpenStack 服务器移除安全组

usage: openstack server remove security group [-h] <server> <group>
Copy to Clipboard Toggle word wrap
从服务器中删除安全组

positional 参数

<server>
要使用的服务器的名称或 ID
<group>
从服务器中删除的安全组的名称或 ID

可选参数

-h, --help
显示帮助信息并退出

3.3.144. OpenStack 服务器删除卷

usage: openstack server remove volume [-h] <server> <volume>
Copy to Clipboard Toggle word wrap
从服务器中删除卷

positional 参数

<server>
server (名称或 ID)
<volume>
要删除的卷(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

3.3.145. OpenStack 服务器救援

usage: openstack server rescue [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <server>
Copy to Clipboard Toggle word wrap
将服务器置于救援模式

positional 参数

<server>
server (名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.146. OpenStack 服务器调整大小

usage: openstack server resize [-h] [--flavor <flavor> | --confirm | --revert] [--wait] <server>
Copy to Clipboard Toggle word wrap
将服务器扩展到新类别

positional 参数

<server>
server (名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--flavor <flavor>
将 server 的大小调整为指定的类别
--confirm
确认服务器调整大小已完成
--revert
在调整大小前恢复服务器状态
--wait
等待调整大小完成

3.3.147. OpenStack 服务器恢复

usage: openstack server resume [-h] <server>
Copy to Clipboard Toggle word wrap
恢复服务器

positional 参数

<server>
server (名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

3.3.148. OpenStack 服务器设置

usage: openstack server set [-h] [--name <new-name>] [--root-password] [--property <key=value>] <server>
Copy to Clipboard Toggle word wrap
设置服务器属性

positional 参数

<server>
server (名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--name <new-name>
新服务器名称
--root-password
设置新的 root 密码(仅限交互式)
--property <key=value>
此服务器添加/更改的属性(重复选项可设置多个属性)

3.3.149. OpenStack 服务器显示

usage: openstack server show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--diagnostics] <server>
Copy to Clipboard Toggle word wrap
显示服务器详情

positional 参数

<server>
server (名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--diagnostics
显示服务器诊断信息

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.150. OpenStack 服务器 ssh

usage: openstack server ssh [-h] [--login <login-name>] [--port <port>] [--identity <keyfile>] [--option <config-options>] [-4 | -6] [--public | --private | --address-type <address-type>] <server>
Copy to Clipboard Toggle word wrap
SSH 到服务器

positional 参数

<server>
server (名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--login <login-name>
登录名称(ssh -l 选项)
--port <port>
目的地端口(ssh -p 选项)
--identity <keyfile>
私钥文件(ssh -i 选项)
--option <config-options>
ssh_config (5)格式的选项(ssh -o 选项)
-4
只使用 IPv4 地址
-6
只使用 IPv6 地址
--public
使用公共 IP 地址
--private
使用私有 IP 地址
--address-type <address-type>
使用其他 IP 地址(公共、专用等)

3.3.151. OpenStack 服务器挂起

usage: openstack server suspend [-h] <server>
Copy to Clipboard Toggle word wrap
挂起服务器

positional 参数

<server>
server (名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

3.3.152. OpenStack 服务器解锁

usage: openstack server unlock [-h] <server>
Copy to Clipboard Toggle word wrap
解锁服务器

positional 参数

<server>
server (名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

3.3.153. OpenStack 服务器取消暂停

usage: openstack server unpause [-h] <server>
Copy to Clipboard Toggle word wrap
取消暂停服务器

positional 参数

<server>
server (名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

3.3.154. OpenStack 服务器 unrescue

usage: openstack server unrescue [-h] <server>
Copy to Clipboard Toggle word wrap
从救援模式恢复服务器

positional 参数

<server>
server (名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

3.3.155. OpenStack server unset

usage: openstack server unset [-h] [--property <key>] <server>
Copy to Clipboard Toggle word wrap
取消设置服务器属性

positional 参数

<server>
server (名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--property <key>
从 server 中删除的属性键(重复要取消设置多个值)

3.3.156. OpenStack 服务创建

usage: openstack service create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name <name>] [--description <description>] <type>
Copy to Clipboard Toggle word wrap
创建新服务

positional 参数

<type>
新服务类型(计算、镜像、身份、卷等)

可选参数

-h, --help
显示帮助信息并退出
--name <name>
新服务名称
--description <description>
新服务描述

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.157. OpenStack 服务删除

usage: openstack service delete [-h] <service>
Copy to Clipboard Toggle word wrap
删除服务

positional 参数

<service>
要删除的服务(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

3.3.158. OpenStack 服务列表

usage: openstack service list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long]
Copy to Clipboard Toggle word wrap
列出服务

可选参数

-h, --help
显示帮助信息并退出
--long
列出输出中的其他字段

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.159. OpenStack 服务显示

usage: openstack service show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--catalog] <service>
Copy to Clipboard Toggle word wrap
显示服务详情

positional 参数

<service>
要显示的服务(类型、名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--catalog
显示服务目录信息

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.160. OpenStack 快照创建

usage: openstack snapshot create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --name <name> [--description <description>] [--force] <volume>
Copy to Clipboard Toggle word wrap
创建新快照

positional 参数

<volume>
要快照的卷(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--name <name>
快照的名称
--description <description>
快照的描述
--force
创建与实例连接的快照。默认为 False

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.161. OpenStack snapshot delete

usage: openstack snapshot delete [-h] <snapshot> [<snapshot> ...]
Copy to Clipboard Toggle word wrap
删除快照

positional 参数

<snapshot>
要删除的快照(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

3.3.162. OpenStack 快照列表

usage: openstack snapshot list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long]
Copy to Clipboard Toggle word wrap
列出快照

可选参数

-h, --help
显示帮助信息并退出
--long
列出输出中的其他字段

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.163. OpenStack 快照集

usage: openstack snapshot set [-h] [--name <name>] [--description <description>] [--property <key=value>] <snapshot>
Copy to Clipboard Toggle word wrap
设置快照属性

positional 参数

<snapshot>
要修改的快照(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--name <name>
新快照名称
--description <description>
新快照描述
--property <key=value>
此快照添加/更改的属性(重复选项可设置多个属性)

3.3.164. OpenStack 快照显示

usage: openstack snapshot show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <snapshot>
Copy to Clipboard Toggle word wrap
显示快照详情

positional 参数

<snapshot>
要显示的快照(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.165. OpenStack snapshot unset

usage: openstack snapshot unset [-h] --property <key> <snapshot>
Copy to Clipboard Toggle word wrap
取消设置快照属性

positional 参数

<snapshot>
要修改的快照(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--property <key>
从快照中删除的属性(重复删除多个值)

3.3.166. OpenStack tld create

usage: openstack tld create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --name NAME [--description DESCRIPTION]
Copy to Clipboard Toggle word wrap
创建新 tld

可选参数

-h, --help
显示帮助信息并退出
--name NAME TLD
Name
--description DESCRIPTION
描述

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.167. OpenStack tld delete

usage: openstack tld delete [-h] id
Copy to Clipboard Toggle word wrap
删除 tld

positional 参数

id
TLD ID

可选参数

-h, --help
显示帮助信息并退出

3.3.168. OpenStack tld list

usage: openstack tld list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
列出 tlds

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.169. OpenStack tld set

usage: openstack tld set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name NAME] [--description DESCRIPTION | --no-description] id
Copy to Clipboard Toggle word wrap
设置 tld 属性

positional 参数

id
TLD ID

可选参数

-h, --help
显示帮助信息并退出
--name NAME TLD
Name
--description DESCRIPTION
描述
--no-description

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.170. OpenStack tld show

usage: openstack tld show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id
Copy to Clipboard Toggle word wrap
显示 tld 详情

positional 参数

id
TLD ID

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.171. OpenStack 令牌问题

usage: openstack token issue [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX]
Copy to Clipboard Toggle word wrap
发出新令牌

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.172. OpenStack 令牌撤销

usage: openstack token revoke [-h] <token>
Copy to Clipboard Toggle word wrap
撤销现有令牌

positional 参数

<token>
要删除的令牌

可选参数

-h, --help
显示帮助信息并退出

3.3.173. OpenStack undercloud 安装

usage: openstack undercloud install [-h]
Copy to Clipboard Toggle word wrap
安装和设置 undercloud

可选参数

-h, --help
显示帮助信息并退出

3.3.174. OpenStack 使用列表

usage: openstack usage list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--start <start>] [--end <end>]
Copy to Clipboard Toggle word wrap
列出每个项目的资源使用量

可选参数

-h, --help
显示帮助信息并退出
--start <start>
使用范围开始日期,例如 2012-01-20 (默认值:4 周前)
--end <end>
使用范围结束日期,ex 2012-01-20 (默认值:明天)

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.175. OpenStack 使用量显示

usage: openstack usage show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--project <project>] [--start <start>] [--end <end>]
Copy to Clipboard Toggle word wrap
显示单个项目的资源使用情况

可选参数

-h, --help
显示帮助信息并退出
--project <project>
显示使用的项目的名称或 ID
--start <start>
使用范围开始日期,例如 2012-01-20 (默认值:4 周前)
--end <end>
使用范围结束日期,ex 2012-01-20 (默认值:明天)

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.176. OpenStack 用户创建

usage: openstack user create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--project <project>] [--password <password>] [--password-prompt] [--email <email-address>] [--enable | --disable] [--or-show] <name>
Copy to Clipboard Toggle word wrap
创建新用户

positional 参数

<name>
新用户名

可选参数

-h, --help
显示帮助信息并退出
--project <project>
默认项目(名称或 ID)
--password <password>
设置用户密码
--password-prompt
以交互方式输入密码
--email <email-address>
设置用户电子邮件地址
--enable
启用用户(默认)
--disable
禁用用户
--or-show
返回现有用户

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.177. OpenStack 用户删除

usage: openstack user delete [-h] <user> [<user> ...]
Copy to Clipboard Toggle word wrap
删除用户

positional 参数

<user>
要删除的用户(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

3.3.178. OpenStack 用户列表

usage: openstack user list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--project <project>] [--long]
Copy to Clipboard Toggle word wrap
列出用户

可选参数

-h, --help
显示帮助信息并退出
--project <project>
按项目过滤用户(名称或 ID)
--long
列出输出中的其他字段

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.179. OpenStack 用户角色列表

usage: openstack user role list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--project <project>] [<user>]
Copy to Clipboard Toggle word wrap
列出用户角色分配

positional 参数

<user>
要列出的用户(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--project <project>
根据 <project> (名称或 ID)过滤用户

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.180. OpenStack 用户集

usage: openstack user set [-h] [--name <name>] [--project <project>] [--password <user-password>] [--password-prompt] [--email <email-address>] [--enable | --disable] <user>
Copy to Clipboard Toggle word wrap
设置用户属性

positional 参数

<user>
要更改的用户(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--name <name>
设置用户名
--project <project>
设置默认项目(名称或 ID)
--password <user-password>
设置用户密码
--password-prompt
以交互方式输入密码
--email <email-address>
设置用户电子邮件地址
--enable
启用用户(默认)
--disable
禁用用户

3.3.181. OpenStack 用户显示

usage: openstack user show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <user>
Copy to Clipboard Toggle word wrap
显示用户详情

positional 参数

<user>
要显示的用户(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.182. OpenStack 卷创建

usage: openstack volume create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --size <size> [--snapshot <snapshot>] [--description <description>] [--type <volume-type>] [--user <user>] [--project <project>] [--availability-zone <availability-zone>] [--image <image>] [--source <volume>] [--property <key=value>] <name>
Copy to Clipboard Toggle word wrap
创建新卷

positional 参数

<name>
新卷名称

可选参数

-h, --help
显示帮助信息并退出
--size <size>
新卷大小(以 GB 为单位)
--snapshot <snapshot>
使用 <snapshot> 作为新卷的源
--description <description>
新卷描述
--type <volume-type>
使用 <volume-type> 作为新卷类型
--user <user>
指定备用用户(名称或 ID)
--project <project>
指定备用项目(名称或 ID)
--availability-zone <availability-zone>
在 <availability-zone> 中创建新卷
--image <image>
使用 <image> 作为新卷的来源(名称或 ID)
--source <volume>
要克隆的卷(名称或 ID)
--property <key=value>
在此卷上设置属性(重复选项可设置多个属性)

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.183. OpenStack volume delete

usage: openstack volume delete [-h] [--force] <volume> [<volume> ...]
Copy to Clipboard Toggle word wrap
删除卷

positional 参数

<volume>
要删除的卷(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--force
尝试强制删除卷,无论状态如何(默认为 False)

3.3.184. OpenStack 卷列表

usage: openstack volume list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--status <status>] [--name <name>] [--all-projects] [--long]
Copy to Clipboard Toggle word wrap
列出卷

可选参数

-h, --help
显示帮助信息并退出
--status <status>
根据状态过滤结果
--name <name>
按名称过滤结果
--all-projects
包括所有项目(仅限管理员)
--long
列出输出中的其他字段

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.185. OpenStack 卷 qos 关联

usage: openstack volume qos associate [-h] <qos-spec> <volume-type>
Copy to Clipboard Toggle word wrap
将 QoS 规格与卷类型关联

positional 参数

<qos-spec>
要修改的 QoS 规格(名称或 ID)
<volume-type>
关联 QoS 的卷类型(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

3.3.186. OpenStack volume qos create

usage: openstack volume qos create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--consumer <consumer>] [--property <key=value>] <name>
Copy to Clipboard Toggle word wrap
创建新的 QoS 规格

positional 参数

<name>
新的 QoS 规格名称

可选参数

-h, --help
显示帮助信息并退出
--consumer <consumer>
QoS 的使用者。有效的消费者:后端,两者的前端(默认为"二者")
--property <key=value>
设置 QoS 规格属性(重复选项来设置多个属性)

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.187. OpenStack volume qos delete

usage: openstack volume qos delete [-h] <qos-spec> [<qos-spec> ...]
Copy to Clipboard Toggle word wrap
删除 QoS 规格

positional 参数

<qos-spec>
要删除的 QoS 规格(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

3.3.188. OpenStack 卷 qos 解除关联

usage: openstack volume qos disassociate [-h] [--volume-type <volume-type> | --all] <qos-spec>
Copy to Clipboard Toggle word wrap
将 QoS 规格与卷类型关联

positional 参数

<qos-spec>
要修改的 QoS 规格(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--volume-type <volume-type>
卷类型,以解除 QoS 解除关联(名称或 ID)
--all
从每个卷类型中解除 QoS 解除关联

3.3.189. OpenStack volume qos list

usage: openstack volume qos list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
列出 QoS 规格

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.190. OpenStack volume qos set

usage: openstack volume qos set [-h] [--property <key=value>] <qos-spec>
Copy to Clipboard Toggle word wrap
设置 QoS 规格属性

positional 参数

<qos-spec>
要修改的 QoS 规格(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--property <key=value>
添加或修改此 QoS 规格的属性(重复选项来设置多个属性)

3.3.191. OpenStack 卷 qos show

usage: openstack volume qos show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <qos-spec>
Copy to Clipboard Toggle word wrap
显示 QoS 规格详情

positional 参数

<qos-spec>
要显示的 QoS 规格(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.192. OpenStack volume qos unset

usage: openstack volume qos unset [-h] [--property <key>] <qos-spec>
Copy to Clipboard Toggle word wrap
取消设置 QoS 规格属性

positional 参数

<qos-spec>
要修改的 QoS 规格(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--property <key>
从 QoS 规范中删除的属性。(重复选项可取消设置多个属性)

3.3.193. OpenStack 卷集

usage: openstack volume set [-h] [--name <name>] [--description <description>] [--size <size>] [--property <key=value>] <volume>
Copy to Clipboard Toggle word wrap
设置卷属性

positional 参数

<volume>
要更改的卷(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--name <name>
新卷名称
--description <description>
新卷描述
--size <size>
以 GB 为单位扩展卷大小
--property <key=value>
添加或修改这个卷的属性(重复选项来设置多个属性)

3.3.194. OpenStack 卷显示

usage: openstack volume show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <volume>
Copy to Clipboard Toggle word wrap
显示卷详情

positional 参数

<volume>
要显示的卷(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.195. OpenStack 卷类型 create

usage: openstack volume type create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--property <key=value>] <name>
Copy to Clipboard Toggle word wrap
创建新卷类型

positional 参数

<name>
新卷类型名称

可选参数

-h, --help
显示帮助信息并退出
--property <key=value>
为此卷类型添加的属性(重复选项可设置多个属性)

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.196. OpenStack 卷类型 delete

usage: openstack volume type delete [-h] <volume-type>
Copy to Clipboard Toggle word wrap
删除卷类型

positional 参数

<volume-type>
要删除的卷类型(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

3.3.197. OpenStack 卷类型列表

usage: openstack volume type list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long]
Copy to Clipboard Toggle word wrap
列出卷类型

可选参数

-h, --help
显示帮助信息并退出
--long
列出输出中的其他字段

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.198. OpenStack 卷类型集

usage: openstack volume type set [-h] [--property <key=value>] <volume-type>
Copy to Clipboard Toggle word wrap
设置卷类型属性

positional 参数

<volume-type>
要修改的卷类型(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--property <key=value>
添加或修改此卷类型的属性(重复选项来设置多个属性)

3.3.199. OpenStack 卷类型显示

usage: openstack volume type show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <volume-type>
Copy to Clipboard Toggle word wrap
显示卷类型详情

positional 参数

<volume-type>
要显示的卷类型(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.200. OpenStack 卷类型未设置

usage: openstack volume type unset [-h] --property <key> <volume-type>
Copy to Clipboard Toggle word wrap
取消设置卷类型属性

positional 参数

<volume-type>
要修改的卷类型(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--property <key>
从卷类型中删除的属性(删除多个属性)

3.3.201. OpenStack volume unset

usage: openstack volume unset [-h] --property <key> <volume>
Copy to Clipboard Toggle word wrap
取消设置卷属性

positional 参数

<volume>
要修改的卷(名称或 ID)

可选参数

-h, --help
显示帮助信息并退出
--property <key>
从卷中删除的属性(重复选项以移除多个属性)

3.3.202. OpenStack zone abandon

usage: openstack zone abandon [-h] id
Copy to Clipboard Toggle word wrap
取消区

positional 参数

id
区 ID

可选参数

-h, --help
显示帮助信息并退出

3.3.203. OpenStack 区域 axfr

usage: openstack zone axfr [-h] id
Copy to Clipboard Toggle word wrap
AXFR 一个区

positional 参数

id
区 ID

可选参数

-h, --help
显示帮助信息并退出

3.3.204. OpenStack zone blacklist create

usage: openstack zone blacklist create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --pattern PATTERN [--description DESCRIPTION]
Copy to Clipboard Toggle word wrap
创建新黑名单

可选参数

-h, --help
显示帮助信息并退出
--pattern PATTERN
黑名单模式
--description DESCRIPTION
描述

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.205. OpenStack zone blacklist delete

usage: openstack zone blacklist delete [-h] id
Copy to Clipboard Toggle word wrap
删除黑名单

positional 参数

id
黑名单 ID

可选参数

-h, --help
显示帮助信息并退出

3.3.206. OpenStack zone blacklist 列表

usage: openstack zone blacklist list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
列出黑名单

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.207. OpenStack zone blacklist set

usage: openstack zone blacklist set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --pattern PATTERN [--description DESCRIPTION | --no-description] id
Copy to Clipboard Toggle word wrap
设置黑名单属性

positional 参数

id
黑名单 ID

可选参数

-h, --help
显示帮助信息并退出
--pattern PATTERN
黑名单模式
--description DESCRIPTION
描述
--no-description

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.208. OpenStack zone blacklist 显示

usage: openstack zone blacklist show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id
Copy to Clipboard Toggle word wrap
显示黑名单详情

positional 参数

id
黑名单 ID

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.209. OpenStack zone create

usage: openstack zone create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--email EMAIL] [--type TYPE] [--ttl TTL] [--description DESCRIPTION] [--masters MASTERS [MASTERS ...]] name
Copy to Clipboard Toggle word wrap
创建新区

positional 参数

名称
区域名称

可选参数

-h, --help
显示帮助信息并退出
--email EMAIL
区域电子邮件
--type TYPE
区类型
--ttl TTL
生存时间(Seconds)
--description DESCRIPTION
描述
--masters MASTERS [MASTERS ...]
zone Master

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.210. OpenStack zone delete

usage: openstack zone delete [-h] id
Copy to Clipboard Toggle word wrap
删除区

positional 参数

id
区 ID

可选参数

-h, --help
显示帮助信息并退出

3.3.211. OpenStack zone list

usage: openstack zone list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--type TYPE]
Copy to Clipboard Toggle word wrap
列出区域

可选参数

-h, --help
显示帮助信息并退出
--type TYPE
区类型

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.212. OpenStack zone set

usage: openstack zone set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name NAME] [--email EMAIL] [--ttl TTL] [--description DESCRIPTION | --no-description] [--masters MASTERS [MASTERS ...]] id
Copy to Clipboard Toggle word wrap
设置区属性

positional 参数

id
区 ID

可选参数

-h, --help
显示帮助信息并退出
--name NAME
区域名称
--email EMAIL
区域电子邮件
--ttl TTL
生存时间(Seconds)
--description DESCRIPTION
描述
--no-description
--masters MASTERS [MASTERS ...]
zone Master

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.213. OpenStack zone show

usage: openstack zone show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id
Copy to Clipboard Toggle word wrap
显示区域详情

positional 参数

id
区 ID

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.214. OpenStack zone transfer accept request

usage: openstack zone transfer accept request [-h] --transfer-id TRANSFER_ID --key KEY
Copy to Clipboard Toggle word wrap
接受区域传输请求

可选参数

-h, --help
显示帮助信息并退出
--transfer-id TRANSFER_ID
转让 ID
--key KEY
转让密钥

3.3.215. OpenStack zone transfer accept show

usage: openstack zone transfer accept show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id
Copy to Clipboard Toggle word wrap
显示区域传输接受

positional 参数

id
zone Tranfer Accept ID

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.216. OpenStack zone transfer request create

usage: openstack zone transfer request create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --target-project-id TARGET_PROJECT_ID [--description DESCRIPTION] zone_id
Copy to Clipboard Toggle word wrap
创建新区传输请求

positional 参数

zone_id
要传输的区域 ID。

可选参数

-h, --help
显示帮助信息并退出
--target-project-id TARGET_PROJECT_ID
要转移到的目标项目 ID。
--description DESCRIPTION
描述

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

3.3.217. OpenStack zone transfer request delete

usage: openstack zone transfer request delete [-h] id
Copy to Clipboard Toggle word wrap

positional 参数

id
区域传输 ID

可选参数

-h, --help
显示帮助信息并退出

3.3.218. OpenStack zone transfer request list

usage: openstack zone transfer request list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
列出区域传送请求

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

3.3.219. OpenStack zone transfer request set

usage: openstack zone transfer request set [-h] [--description DESCRIPTION | --no-description] id
Copy to Clipboard Toggle word wrap
设置传输

positional 参数

id
区域传输 ID

可选参数

-h, --help
显示帮助信息并退出
--description DESCRIPTION
描述
--no-description

3.3.220. OpenStack zone transfer request show

usage: openstack zone transfer request show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id
Copy to Clipboard Toggle word wrap
显示区域传输详情

positional 参数

id
zone Tranfer ID

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

第 4 章 配置文件编辑器

openstack-config 客户端是命令行界面(CLI),适用于 及其扩展。本章记录了 openstack-config 版本 0.5
如需特定 openstack-config 命令的帮助信息,请输入:
$ openstack-config help COMMAND
Copy to Clipboard Toggle word wrap

4.1. openstack-config usage

 Usage: crudini --set [OPTION]... config_file section [param] [value] crudini --get [OPTION]... config_file [section] [param] crudini --del [OPTION]... config_file section [param] [list value] crudini --merge [OPTION]... config_file [section]
Copy to Clipboard Toggle word wrap

4.2. openstack-config 可选参数

--existing[=WHAT]
对于 --set、--del 和 --merge,如果没有项,则会失败,其中 WHAT 为 'file'、'section' 或 'param',如果没有指定;所有指定项目。
--format=FMT
对于 --get,请选择输出 FMT。格式是 sh,ini,lines
--InPlace
锁定和写入文件。这不是原子的,但受到默认替换方法的限制要少。
--list
对于 --set 和 --del,请更新值的列表(设置)
--list-sep=STR
使用 "STR" 而不是 "," 的 delimit 列表值
--output=FILE
将输出写入 FILE。'-' 表示 stdout
--verbose
如果进行了更改,则在 stderr 上指示

第 5 章 块存储服务命令行客户端

cinder 客户端是块存储服务 API 及其扩展的命令行界面(CLI)。本章记录了 cinder 版本 1.4.0
有关特定 cinder 命令的帮助信息,请输入:
$ cinder help COMMAND
Copy to Clipboard Toggle word wrap

5.1. Cinder 使用量

usage: cinder [--version] [-d] [--os-auth-system <auth-system>] [--service-type <service-type>] [--service-name <service-name>] [--volume-service-name <volume-service-name>] [--endpoint-type <endpoint-type>] [--os-endpoint-type <os-endpoint-type>] [--os-volume-api-version <volume-api-ver>] [--bypass-url <bypass-url>] [--retries <retries>] [--profile HMAC_KEY] [--os-auth-strategy <auth-strategy>] [--os-username <auth-user-name>] [--os-password <auth-password>] [--os-tenant-name <auth-tenant-name>] [--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>] [--os-user-id <auth-user-id>] [--os-user-domain-id <auth-user-domain-id>] [--os-user-domain-name <auth-user-domain-name>] [--os-project-id <auth-project-id>] [--os-project-name <auth-project-name>] [--os-project-domain-id <auth-project-domain-id>] [--os-project-domain-name <auth-project-domain-name>] [--os-region-name <region-name>] [--os-token <token>] [--os-url <url>] [--insecure] [--os-cacert <ca-certificate>] [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>] <subcommand> ...
Copy to Clipboard Toggle word wrap

子命令

absolute-limits
列出用户的绝对限制。
availability-zone-list
列出所有可用区。
backup-create
创建卷备份。
backup-delete
删除备份。
backup-export
导出备份元数据记录。
backup-import
导入备份元数据记录。
backup-list
列出所有备份。
backup-restore
恢复备份。
backup-show
显示备份详情。
cgsnapshot-create
创建一个 cgsnapshot。
cgsnapshot-delete
删除一个或多个 cgsnapshot。
cgsnapshot-list
列出所有 cgsnapshot。
cgsnapshot-show
显示 cgsnapshot 详情。
consisgroup-create
创建一致性组。
consisgroup-create-from-src
从 cgsnapshot 或源 CG 创建一致性组。
consisgroup-delete
删除一个或多个一致性组。
consisgroup-list
列出所有一致性组。
consisgroup-show
显示一致性组的详细信息。
consisgroup-update
更新一致性组。
create
创建一个卷。
credentials
显示从 auth 返回的用户凭证。
delete
删除一个或多个卷。
encryption-type-create
为卷类型创建加密类型。仅限管理。
encryption-type-delete
删除卷类型的加密类型。仅限管理。
encryption-type-list
显示卷类型的加密类型详情。仅限管理。
encryption-type-show
显示卷类型的加密类型详情。仅限管理。
encryption-type-update
更新卷类型的加密类型信息(Admin Only)。
端点
发现由身份验证服务注册的端点。
扩展
尝试扩展现有卷的大小。
extra-specs-list
列出当前卷类型和额外规格。
force-delete
无论状态如何,尝试强制删除卷。
get-capabilities
显示后端卷统计和属性。仅限管理。
get-pools
显示后端的池信息。仅限管理。
image-metadata
设置或删除卷镜像元数据。
list
列出所有卷。
管理
管理现有卷。
metadata
设置或删除卷元数据。
metadata-show
显示卷元数据。
metadata-update-all
更新卷元数据。
migrate
将卷迁移到新主机。
qos-associate
将 qos specs 与指定的卷类型相关联。
qos-create
创建 qos specs。
qos-delete
删除指定的 qos specs。
qos-disassociate
从指定的卷类型解除 qos specs 的关联。
qos-disassociate-all
从其所有关联关联关联 qos specs。
qos-get-association
列出指定 qos specs 的所有关联。
QoS-key
为 qos spec 设置或取消设置规格。
qos-list
列出 qos specs。
qos-show
显示 qos specs 详情。
quota-class-show
列出配额类的配额。
quota-class-update
更新配额类的配额。
quota-defaults
列出租户的默认配额。
quota-delete
删除租户的配额。
quota-show
列出租户的配额。
quota-update
更新租户的配额。
quota-usage
列出租户的配额使用量。
rate-limits
列出用户的速率限值。
readonly-mode-update
更新卷只读 access-mode 标志。
rename
重命名卷。
replication-promote
将二级卷提升为主卷,以保持关系。
replication-reenable
将二级卷与主要卷同步。
reset-state
显式更新 Cinder 数据库中的卷状态。
retype
更改卷的卷类型。
service-disable
禁用服务。
service-enable
启用服务。
service-list
列出所有服务。按主机和服务二进制文件过滤。
set-bootable
更新卷的可引导状态。
显示
显示卷详情。
snapshot-create
创建快照。
snapshot-delete
删除一个或多个快照。
snapshot-list
列出所有快照。
snapshot-metadata
设置或删除快照元数据。
snapshot-metadata-show
显示快照元数据。
snapshot-metadata-update-all
更新快照元数据。
snapshot-rename
重命名快照。
snapshot-reset-state
显式更新快照状态。
snapshot-show
显示快照详情。
transfer-accept
接受卷转让。
transfer-create
创建卷转让。
transfer-delete
撤消转让。
transfer-list
列出所有传输。
transfer-show
显示传输详细信息。
type-access-add
添加给定项目的卷类型访问权限。
type-access-list
打印有关给定卷类型的访问信息。
type-access-remove
删除给定项目的卷类型访问权限。
type-create
创建卷类型。
type-default
列出默认卷类型。
type-delete
删除卷类型。
type-key
为卷类型设置或取消设置 extra_spec。
type-list
列出可用的"卷类型"。(管理员将只看到私有类型。)
type-update
更新卷类型名称和/或描述。
unmanage
停止管理卷。
upload-to-image
将卷上传到镜像服务作为镜像。
bash-completion
输出 bash_completion 的参数。
帮助
显示有关该程序或其其中一个子命令的帮助。
list-extensions
列出所有可用的 os-api 扩展。

5.2. Cinder 可选参数

--version
显示程序的版本号并退出
-d, --debug
显示调试输出。
--os-auth-system <auth-system>
默认为 env[OS_AUTH_SYSTEM]
--service-type <service-type>
服务类型。对于大多数操作,默认为 volume。
--service-name <service-name>
服务名称.Default=env[CINDER_SERVICE_NAME]
--volume-service-name <volume-service-name>
卷服务名称。Default=env[CINDER_VOLUME_SERVICE_NAME]
--endpoint-type <endpoint-type>
弃用!使用 --os-endpoint-type。
--os-endpoint-type <os-endpoint-type>
端点类型,即 publicURL 或 internalURL。default=env[OS_ENDPOINT_TYPE] 或 nova env[CINDER_ENDPOINT_TYPE] 或 publicURL。
--os-volume-api-version <volume-api-ver>
块存储 API 版本。有效值为 1 或 2。Default=env[OS_VOLUME_API_VERSION]
--bypass-url <bypass-url>
使用此 API 端点而不是服务目录。默认为 env[CINDERCLIENT_BYPASS_URL]
--retries <retries>
重试次数。
--profile HMAC_KEY
HMAC 密钥用于加密上下文数据以进行操作性能分析。此密钥需要与 cinder api 服务器上配置的密钥匹配。如果没有键,即使服务器端启用了 osprofiler,也不会触发性能分析。
--os-auth-strategy <auth-strategy>
身份验证策略(Env: OS_AUTH_STRATEGY,默认 keystone)。现在,任何其他值将禁用身份验证
--os-username <auth-user-name>
OpenStack 用户名。Default=env[OS_USERNAME]
--os-password <auth-password>
OpenStack 用户的密码。Default=env[OS_PASSWORD]
--os-tenant-name <auth-tenant-name>
租户名称。Default=env[OS_TENANT_NAME]
--os-tenant-id <auth-tenant-id>
租户 ID。Default=env[OS_TENANT_ID]
--os-auth-url <auth-url>
身份验证服务的 URL。Default=env[OS_AUTH_URL]
--os-user-id <auth-user-id>
身份验证用户 ID (Env: OS_USER_ID)
--os-user-domain-id <auth-user-domain-id>
OpenStack 用户域 ID。默认为 env[OS_USER_DOMAIN_ID]
--os-user-domain-name <auth-user-domain-name>
OpenStack 用户域名。默认为 env[OS_USER_DOMAIN_NAME]
--os-project-id <auth-project-id>
指定租户 ID 的另一种方式。这个选项与 --os-tenant-id 相互排斥。默认为 env[OS_PROJECT_ID]
--os-project-name <auth-project-name>
指定租户名称的另一种方法。这个选项与 --os-tenant-name 相互排斥。默认为 env[OS_PROJECT_NAME]
--os-project-domain-id <auth-project-domain-id>
默认为 env[OS_PROJECT_DOMAIN_ID]
--os-project-domain-name <auth-project-domain-name>
默认为 env[OS_PROJECT_DOMAIN_NAME]
--os-region-name <region-name>
区域名称.Default=env[OS_REGION_NAME]
--os-token <token>
默认为 env[OS_TOKEN]
--os-url <url>
默认为 env[OS_URL]
--insecure
明确允许客户端执行"不安全"TLS (https)请求。服务器的证书不会针对任何证书颁发机构进行验证。这个选项应谨慎使用。
--os-cacert <ca-certificate>
指定用于验证 TLS (https)服务器证书中使用的 CA 捆绑包文件。默认为 env[OS_CACERT]
--os-cert <certificate>
默认为 env[OS_CERT]
--os-key <key>
默认为 env[OS_KEY]
--timeout <seconds>
设置请求超时(以秒为单位)。

5.3. 块存储 API v1 命令(DEPRECATED)

5.3.1. Cinder 绝对限制

usage: cinder absolute-limits
Copy to Clipboard Toggle word wrap
列出用户的绝对限制。

5.3.2. cinder availability-zone-list

usage: cinder availability-zone-list
Copy to Clipboard Toggle word wrap
列出所有可用区。

5.3.3. cinder backup-create

usage: cinder backup-create [--container <container>] [--name <name>] [--description <description>] [--incremental] [--force] <volume>
Copy to Clipboard Toggle word wrap
创建卷备份。

positional 参数

<volume>
要备份的卷的名称或 ID。

可选参数

--container <container>
备份容器名称。default=None。
--name <name>
备份名称。default=None。
--description <description>
备份描述。default=None。
--incremental
增量备份。默认=False。
--force
当卷附加到实例时,允许或拒绝备份卷。如果设置为 True,则备份卷的状态是 "available" 或 "in- use"。" in-use" 卷的备份意味着您的数据崩溃。默认=False。

5.3.4. cinder backup-delete

usage: cinder backup-delete <backup>
Copy to Clipboard Toggle word wrap
删除备份。

positional 参数

<backup>
要删除的备份的名称或 ID。

5.3.5. cinder backup-export

usage: cinder backup-export <backup>
Copy to Clipboard Toggle word wrap
导出备份元数据记录。

positional 参数

<backup>
要导出的备份的 ID。

5.3.6. cinder backup-import

usage: cinder backup-import <backup_service> <backup_url>
Copy to Clipboard Toggle word wrap
导入备份元数据记录。

positional 参数

<backup_service>
用于导入备份的备份服务。
<backup_url>
用于导入备份元数据的备份 URL。

5.3.7. cinder backup-list

usage: cinder backup-list [--all-tenants [<all_tenants>]] [--name <name>] [--status <status>] [--volume-id <volume-id>]
Copy to Clipboard Toggle word wrap
列出所有备份。

可选参数

--all-tenants [<all_tenants>]
显示所有租户的详细信息。仅限管理。
--name <name>
按名称过滤结果。default=None。
--status <status>
按状态过滤结果。default=None。
--volume-id <volume-id>
根据卷 ID 过滤结果。default=None。

5.3.8. cinder backup-restore

usage: cinder backup-restore [--volume <volume>] <backup>
Copy to Clipboard Toggle word wrap
恢复备份。

positional 参数

<backup>
要恢复的备份 ID。

可选参数

--volume <volume>
要恢复到的卷的名称或 ID。default=None。

5.3.9. cinder backup-show

usage: cinder backup-show <backup>
Copy to Clipboard Toggle word wrap
显示备份详情。

positional 参数

<backup>
备份的名称或 ID。

5.3.10. cinder cgsnapshot-create

usage: cinder cgsnapshot-create [--name <name>] [--description <description>] <consistencygroup>
Copy to Clipboard Toggle word wrap
创建一个 cgsnapshot。

positional 参数

<consistencygroup>
一致性组的名称或 ID。

可选参数

--name <name>
Cgsnapshot 名称。default=None。
--description <description>
Cgsnapshot 描述。default=None。

5.3.11. cinder cgsnapshot-delete

usage: cinder cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]
Copy to Clipboard Toggle word wrap
删除一个或多个 cgsnapshot。

positional 参数

<cgsnapshot>
要删除的一个或多个 cgsnapshot 的名称或 ID。

5.3.12. cinder cgsnapshot-list

usage: cinder cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>] [--consistencygroup-id <consistencygroup_id>]
Copy to Clipboard Toggle word wrap
列出所有 cgsnapshot。

可选参数

--all-tenants [<0|1>]
显示所有租户的详细信息。仅限管理。
--status <status>
按状态过滤结果。default=None。
--consistencygroup-id <consistencygroup_id>
通过一致性组 ID 过滤结果。default=None。

5.3.13. cinder cgsnapshot-show

usage: cinder cgsnapshot-show <cgsnapshot>
Copy to Clipboard Toggle word wrap
显示 cgsnapshot 详情。

positional 参数

<cgsnapshot>
cgsnapshot 的名称或 ID。

5.3.14. Cinder consisgroup-create

usage: cinder consisgroup-create [--name <name>] [--description <description>] [--availability-zone <availability-zone>] <volume-types>
Copy to Clipboard Toggle word wrap
创建一致性组。

positional 参数

<volume-types>
卷类型。

可选参数

--name <name>
一致性组的名称。
--description <description>
一致性组的描述。default=None。
--availability-zone <availability-zone>
卷的可用区。default=None。

5.3.15. cinder consisgroup-create-from-src

usage: cinder consisgroup-create-from-src [--cgsnapshot <cgsnapshot>] [--source-cg <source-cg>] [--name <name>] [--description <description>]
Copy to Clipboard Toggle word wrap
从 cgsnapshot 或源 CG 创建一致性组。

可选参数

--cgsnapshot <cgsnapshot>
cgsnapshot 的名称或 ID。default=None。
--source-cg <source-cg>
源 CG 的名称或 ID。default=None。
--name <name>
一致性组的名称。default=None。
--description <description>
一致性组的描述。default=None。

5.3.16. Cinder consisgroup-delete

usage: cinder consisgroup-delete [--force] <consistencygroup> [<consistencygroup> ...]
Copy to Clipboard Toggle word wrap
删除一个或多个一致性组。

positional 参数

<consistencygroup>
要删除的一个或多个一致性组的名称或 ID。

可选参数

--force
允许或不允许删除一致性组。如果一致性组为空,可以在无 force 标志的情况下删除它。如果一致性组不为空,则需要删除 force 标志。

5.3.17. Cinder consisgroup-list

usage: cinder consisgroup-list [--all-tenants [<0|1>]]
Copy to Clipboard Toggle word wrap
列出所有一致性组。

可选参数

--all-tenants [<0|1>]
显示所有租户的详细信息。仅限管理。

5.3.18. Cinder consisgroup-show

usage: cinder consisgroup-show <consistencygroup>
Copy to Clipboard Toggle word wrap
显示一致性组的详细信息。

positional 参数

<consistencygroup>
一致性组的名称或 ID。

5.3.19. Cinder consisgroup-update

usage: cinder consisgroup-update [--name <name>] [--description <description>] [--add-volumes <uuid1,uuid2,......>] [--remove-volumes <uuid3,uuid4,......>] <consistencygroup>
Copy to Clipboard Toggle word wrap
更新一致性组。

positional 参数

<consistencygroup>
一致性组的名称或 ID。

可选参数

--name <name>
一致性组的新名称。default=None。
--description <description>
一致性组的新描述。default=None。
--add-volumes <uuid1,uuid2,......>
要添加到一致性组中的一个或多个卷的 UUID,用逗号分开。default=None。
--remove-volumes <uuid3,uuid4,......>
要从一致性组中删除的一个或多个卷的 UUID,用逗号分隔。default=None。

5.3.20. Cinder 创建

usage: cinder create [--consisgroup-id <consistencygroup-id>] [--snapshot-id <snapshot-id>] [--source-volid <source-volid>] [--source-replica <source-replica>] [--image-id <image-id>] [--image <image>] [--name <name>] [--description <description>] [--volume-type <volume-type>] [--availability-zone <availability-zone>] [--metadata [<key=value> [<key=value> ...]]] [--hint <key=value>] [--allow-multiattach] [<size>]
Copy to Clipboard Toggle word wrap
创建一个卷。

positional 参数

<size>
卷大小(以 GB 为单位)。(必需,除非指定了 snapshot-id /source-volid)。

可选参数

--consisgroup-id <consistencygroup-id>
新卷所属的一致性组的 ID。default=None。
--snapshot-id <snapshot-id>
从快照 ID 创建卷。default=None。
--source-volid <source-volid>
从卷 ID 创建卷。default=None。
--source-replica <source-replica>
从复制卷 ID 创建卷。default=None。
--image-id <image-id>
从镜像 ID 创建卷。default=None。
--image <image>
从镜像(ID 或名称)创建卷。default=None。
--name <name>
卷名称。default=None。
--description <description>
卷描述.default=None。
--volume-type <volume-type>
卷类型。default=None。
--availability-zone <availability-zone>
卷的可用区。default=None。
--metadata [<key=value> [<key=value> ...]]
元数据键和值对。default=None。
--hint <key=value>
调度程序提示,如 nova 中。
--allow-multiattach
允许多次连接卷。Default=False

5.3.21. Cinder 凭证

usage: cinder credentials
Copy to Clipboard Toggle word wrap
显示从 auth 返回的用户凭证。

5.3.22. Cinder 删除

usage: cinder delete <volume> [<volume> ...]
Copy to Clipboard Toggle word wrap
删除一个或多个卷。

positional 参数

<volume>
要删除的卷名称或 ID。

5.3.23. cinder encryption-type-create

usage: cinder encryption-type-create [--cipher <cipher>] [--key_size <key_size>] [--control_location <control_location>] <volume_type> <provider>
Copy to Clipboard Toggle word wrap
为卷类型创建加密类型。仅限管理。

positional 参数

<volume_type>
卷类型的名称或 ID。
<provider>
提供加密支持的类。例如,LuksEncryptor。

可选参数

--cipher <cipher>
加密算法或模式。例如: aes- xts-plain64。default=None。
--key_size <key_size>
加密密钥大小,以位为单位。例如:128 或 256。default=None。
--control_location <control_location>
执行加密的 notional 服务。有效值为 "front-end" 或 "back-end"。例如,前端=Nova。默认为"前端"。

5.3.24. cinder encryption-type-delete

usage: cinder encryption-type-delete <volume_type>
Copy to Clipboard Toggle word wrap
删除卷类型的加密类型。仅限管理。

positional 参数

<volume_type>
卷类型的名称或 ID。

5.3.25. cinder encryption-type-list

usage: cinder encryption-type-list
Copy to Clipboard Toggle word wrap
显示卷类型的加密类型详情。仅限管理。

5.3.26. cinder encryption-type-show

usage: cinder encryption-type-show <volume_type>
Copy to Clipboard Toggle word wrap
显示卷类型的加密类型详情。仅限管理。

positional 参数

<volume_type>
卷类型的名称或 ID。

5.3.27. cinder encryption-type-update

usage: cinder encryption-type-update [--provider <provider>] [--cipher [<cipher>]] [--key-size [<key-size>]] [--control-location <control-location>] <volume-type>
Copy to Clipboard Toggle word wrap
更新卷类型的加密类型信息(Admin Only)。

positional 参数

<volume-type>
卷类型的名称或 ID

可选参数

--provider <provider>
提供加密支持的类(如 LuksEncryptor)(可选)
--cipher [<cipher>]
要使用的加密算法/模式(如 aes-xts- plain64))。提供参数,但没有值设为 provider default。(可选)
--key-size [<key-size>]
加密密钥的大小,以位为单位(例如 128、256)。提供参数,但没有值设为 provider default。(可选)
--control-location <control-location>
执行加密的 notional 服务(例如,前端=Nova)。值:"前端",'back-end'(可选)

5.3.28. Cinder 端点

usage: cinder endpoints
Copy to Clipboard Toggle word wrap
发现由身份验证服务注册的端点。

5.3.29. Cinder 扩展

usage: cinder extend <volume> <new_size>
Copy to Clipboard Toggle word wrap
尝试扩展现有卷的大小。

positional 参数

<volume>
要扩展的卷的名称或 ID。
<new_size>
新卷的大小(以 GB 为单位)。

5.3.30. cinder extra-specs-list

usage: cinder extra-specs-list
Copy to Clipboard Toggle word wrap
列出当前卷类型和额外规格。

5.3.31. cinder force-delete

usage: cinder force-delete <volume> [<volume> ...]
Copy to Clipboard Toggle word wrap
无论状态如何,尝试强制删除卷。

positional 参数

<volume>
要删除的卷名称或 ID。

5.3.32. cinder get-capabilities

usage: cinder get-capabilities <host>
Copy to Clipboard Toggle word wrap
显示后端卷统计和属性。仅限管理。

positional 参数

<host>
Cinder host 以显示后端卷统计和属性;采用以下形式:host@backend-name

5.3.33. cinder get-pools

usage: cinder get-pools [--detail]
Copy to Clipboard Toggle word wrap
显示后端的池信息。仅限管理。

可选参数

--detail
显示有关池的详细信息。

5.3.34. cinder image-metadata

usage: cinder image-metadata <volume> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
设置或删除卷镜像元数据。

positional 参数

<volume>
要更新元数据的卷的名称或 ID。
<action>
该操作。有效值为 'set' 或 'unset.'
<key=value>
要设置或取消设置的元数据键和值对。对于未设置,请只指定密钥。

5.3.35. cinder list

usage: cinder list [--all-tenants [<0|1>]] [--name <name>] [--status <status>] [--migration_status <migration_status>] [--metadata [<key=value> [<key=value> ...]]] [--marker <marker>] [--limit <limit>] [--sort <key>[:<direction>]] [--tenant [<tenant>]]
Copy to Clipboard Toggle word wrap
列出所有卷。

可选参数

--all-tenants [<0|1>]
显示所有租户的详细信息。仅限管理。
--name <name>
按名称过滤结果。default=None。
--status <status>
按状态过滤结果。default=None。
--migration_status <migration_status>
根据迁移状态过滤结果。default=None。仅限管理。
--metadata [<key=value> [<key=value> ...]]
通过元数据键值对过滤结果。default=None。
--marker <marker>
开始返回稍后出现在卷列表中的卷,而不是此卷 ID 表示的卷。default=None。
--limit <limit>
要返回的最大卷数。default=None。
--sort <key>[:<direction>]
以逗号分隔的排序键和方向列表,格式为 <key>[:<asc|desc>]。有效键: id, status, size, availability_zone, name, bootable, created_at.default=None。
--tenant [<tenant>]
显示来自单个租户的信息(仅限管理员)。

5.3.36. cinder list-extensions

usage: cinder list-extensions
Copy to Clipboard Toggle word wrap
列出所有可用的 os-api 扩展。

5.3.37. Cinder 管理

usage: cinder manage [--id-type <id-type>] [--name <name>] [--description <description>] [--volume-type <volume-type>] [--availability-zone <availability-zone>] [--metadata [<key=value> [<key=value> ...]]] [--bootable] <host> <identifier>
Copy to Clipboard Toggle word wrap
管理现有卷。

positional 参数

<host>
现有卷所在的 Cinder 主机 ; 采用以下形式:host@backend-name""pool
<identifier>
现有卷的名称或其他标识符

可选参数

--id-type <id-type>
提供的后端设备标识符类型,通常为 source-name 或 source-id (Default=source-name)
--name <name>
卷名称(Default=None)
--description <description>
卷描述(Default=None)
--volume-type <volume-type>
卷类型(Default=None)
--availability-zone <availability-zone>
卷的可用区(Default=None)
--metadata [<key=value> [<key=value> ...]]
metadata key=value 对(Default=None)
--bootable
指定新创建的卷应标记为可引导

5.3.38. Cinder 元数据

usage: cinder metadata <volume> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
设置或删除卷元数据。

positional 参数

<volume>
要更新元数据的卷的名称或 ID。
<action>
该操作。有效值为 "set" 或 "unset"。
<key=value>
要设置或取消设置的元数据键和值对。对于未设置,请只指定密钥。

5.3.39. cinder metadata-show

usage: cinder metadata-show <volume>
Copy to Clipboard Toggle word wrap
显示卷元数据。

positional 参数

<volume>
卷的 ID。

5.3.40. cinder metadata-update-all

usage: cinder metadata-update-all <volume> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
更新卷元数据。

positional 参数

<volume>
要更新元数据的卷 ID。
<key=value>
要更新的元数据键和值对或对。

5.3.41. Cinder 迁移

usage: cinder migrate [--force-host-copy [<True|False>]] [--lock-volume [<True|False>]] <volume> <host>
Copy to Clipboard Toggle word wrap
将卷迁移到新主机。

positional 参数

<volume>
要迁移的卷 ID。
<host>
目标主机.

可选参数

--force-host-copy [<True|False>]
启用或禁用基于主机的通用强制迁移,这样可绕过驱动程序优化。默认=False。
--lock-volume [<True|False>]
启用或禁用由其他命令导致的卷迁移终止。这个选项适用于可用的卷。true 表示它锁定卷状态,不允许迁移中止。卷状态将在迁移过程中处于维护状态。false 表示卷迁移可以被中止。卷状态仍处于原始状态。默认=False。

5.3.42. cinder qos-associate

usage: cinder qos-associate <qos_specs> <volume_type_id>
Copy to Clipboard Toggle word wrap
将 qos specs 与指定的卷类型相关联。

positional 参数

<qos_specs>
QoS 规格 ID。
<volume_type_id>
关联 QoS 规格的卷类型 ID。

5.3.43. cinder qos-create

usage: cinder qos-create <name> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
创建 qos specs。

positional 参数

<name>
新的 QoS 规格的名称。
<key=value>
QoS 规格。

5.3.44. cinder qos-delete

usage: cinder qos-delete [--force [<True|False>]] <qos_specs>
Copy to Clipboard Toggle word wrap
删除指定的 qos specs。

positional 参数

<qos_specs>
要删除的 QoS 规格的 ID。

可选参数

--force [<True|False>]
启用或禁用删除 in-use QoS 规格。默认=False。

5.3.45. cinder qos-disassociate

usage: cinder qos-disassociate <qos_specs> <volume_type_id>
Copy to Clipboard Toggle word wrap
从指定的卷类型解除 qos specs 的关联。

positional 参数

<qos_specs>
QoS 规格 ID。
<volume_type_id>
关联 QoS 规格的卷类型 ID。

5.3.46. cinder qos-disassociate-all

usage: cinder qos-disassociate-all <qos_specs>
Copy to Clipboard Toggle word wrap
从其所有关联关联关联 qos specs。

positional 参数

<qos_specs>
要操作的 QoS 规格的 ID。

5.3.47. cinder qos-get-association

usage: cinder qos-get-association <qos_specs>
Copy to Clipboard Toggle word wrap
列出指定 qos specs 的所有关联。

positional 参数

<qos_specs>
QoS 规格 ID。

5.3.48. cinder qos-key

usage: cinder qos-key <qos_specs> <action> key=value [key=value ...]
Copy to Clipboard Toggle word wrap
为 qos spec 设置或取消设置规格。

positional 参数

<qos_specs>
QoS 规格 ID。
<action>
该操作。有效值为 "set" 或 "unset"。
key=value
要设置或取消设置的元数据键和值对。对于未设置,请只指定密钥。

5.3.49. cinder qos-list

usage: cinder qos-list
Copy to Clipboard Toggle word wrap
列出 qos specs。

5.3.50. cinder qos-show

usage: cinder qos-show <qos_specs>
Copy to Clipboard Toggle word wrap
显示 qos specs 详情。

positional 参数

<qos_specs>
要显示的 QoS 规格的 ID。

5.3.51. cinder quota-class-show

usage: cinder quota-class-show <class>
Copy to Clipboard Toggle word wrap
列出配额类的配额。

positional 参数

<class>
列出配额的配额类的名称。

5.3.52. cinder quota-class-update

usage: cinder quota-class-update [--volumes <volumes>] [--snapshots <snapshots>] [--gigabytes <gigabytes>] [--volume-type <volume_type_name>] <class_name>
Copy to Clipboard Toggle word wrap
更新配额类的配额。

positional 参数

<class_name>
设置配额的配额类的名称。

可选参数

--volumes <volumes>
新的 "volumes" 配额值。default=None。
--snapshots <snapshots>
新的 "snapshots" 配额值。default=None。
--gigabytes <gigabytes>
新的"千兆字节"配额值。default=None。
--volume-type <volume_type_name>
卷类型。default=None。

5.3.53. cinder quota-defaults

usage: cinder quota-defaults <tenant_id>
Copy to Clipboard Toggle word wrap
列出租户的默认配额。

positional 参数

<tenant_id>
列出配额默认值的租户 ID。

5.3.54. cinder quota-delete

usage: cinder quota-delete <tenant_id>
Copy to Clipboard Toggle word wrap
删除租户的配额。

positional 参数

<tenant_id>
用于删除配额的租户 UUID。

5.3.55. cinder quota-show

usage: cinder quota-show <tenant_id>
Copy to Clipboard Toggle word wrap
列出租户的配额。

positional 参数

<tenant_id>
列出配额的租户 ID。

5.3.56. cinder quota-update

usage: cinder quota-update [--volumes <volumes>] [--snapshots <snapshots>] [--gigabytes <gigabytes>] [--backups <backups>] [--backup-gigabytes <backup_gigabytes>] [--consistencygroups <consistencygroups>] [--volume-type <volume_type_name>] [--per-volume-gigabytes <per_volume_gigabytes>] <tenant_id>
Copy to Clipboard Toggle word wrap
更新租户的配额。

positional 参数

<tenant_id>
设置配额的租户 ID。

可选参数

--volumes <volumes>
新的 "volumes" 配额值。default=None。
--snapshots <snapshots>
新的 "snapshots" 配额值。default=None。
--gigabytes <gigabytes>
新的"千兆字节"配额值。default=None。
--backups <backups>
新的 "backups" 配额值。default=None。
--backup-gigabytes <backup_gigabytes>
新的 "backup_gigabytes" 配额值。default=None。
--consistencygroups <consistencygroups>
新的 "consistencygroups" 配额值。default=None。
--volume-type <volume_type_name>
卷类型。default=None。
--per-volume-gigabytes <per_volume_gigabytes>
设置最大卷大小限制。default=None。

5.3.57. cinder quota-usage

usage: cinder quota-usage <tenant_id>
Copy to Clipboard Toggle word wrap
列出租户的配额使用量。

positional 参数

<tenant_id>
列出配额使用的租户 ID。

5.3.58. cinder 速率限制

usage: cinder rate-limits
Copy to Clipboard Toggle word wrap
列出用户的速率限值。

5.3.59. cinder readonly-mode-update

usage: cinder readonly-mode-update <volume> <True|true|False|false>
Copy to Clipboard Toggle word wrap
更新卷只读 access-mode 标志。

positional 参数

<volume>
要更新的卷 ID。
<True|true|False|false>
启用或禁用卷更新到只读访问模式。

5.3.60. Cinder 重命名

usage: cinder rename [--description <description>] <volume> [<name>]
Copy to Clipboard Toggle word wrap
重命名卷。

positional 参数

<volume>
要重命名的卷的名称或 ID。
<name>
卷的新名称。

可选参数

--description <description>
卷描述.default=None。

5.3.61. cinder replication-promote

usage: cinder replication-promote <volume>
Copy to Clipboard Toggle word wrap
将二级卷提升为主卷,以保持关系。

positional 参数

<volume>
要提升的卷的名称或 ID。卷应该具有使用 source-replica 参数创建的副本卷。

5.3.62. cinder replication-reenable

usage: cinder replication-reenable <volume>
Copy to Clipboard Toggle word wrap
将二级卷与主要卷同步。

positional 参数

<volume>
重新启用复制的卷的名称或 ID。卷的 replication- 状态应该不活跃。

5.3.63. cinder reset-state

usage: cinder reset-state [--state <state>] [--attach-status <attach-status>] [--reset-migration-status] <volume> [<volume> ...]
Copy to Clipboard Toggle word wrap
显式更新 Cinder 数据库中的卷状态。请注意,这不会影响卷是否实际附加到 Nova 计算主机或实例,并可能导致卷不可用。只是一个数据库更改,这不会影响卷的 true 状态,且可能与实际状态不匹配。当卷更改为 'available' 状态时,可能会导致卷不可用。

positional 参数

<volume>
要修改的卷的名称或 ID。

可选参数

--state <state>
分配给卷的状态。有效值为 "available", "error", "creating", "deleting", "in- use", "attaching", "detaching", "error_deleting" 和 "maintenance"。注意:此命令只需更改 DataBase 中的卷状态,在使用时不考虑实际状态,请谨慎操作。default=available。
--attach-status <attach-status>
要分配给 DataBase 中的卷的附加状态,其实际状态与实际状态无关。有效值为 "attached" 和 "detached"。default=None,这意味着状态保持不变。
--reset-migration-status
清除 DataBase 中卷的迁移状态,表示卷是卷迁移的来源或目标,与实际状态无关。

5.3.64. Cinder 重新类型

usage: cinder retype [--migration-policy <never|on-demand>] <volume> <volume-type>
Copy to Clipboard Toggle word wrap
更改卷的卷类型。

positional 参数

<volume>
要修改类型的卷的名称或 ID。
<volume-type>
新卷类型。

可选参数

--migration-policy <never|on-demand>
重新键入卷期间迁移策略。

5.3.65. cinder service-disable

usage: cinder service-disable [--reason <reason>] <hostname> <binary>
Copy to Clipboard Toggle word wrap
禁用服务。

positional 参数

<hostname>
主机名.
<binary>
服务二进制文件。

可选参数

--reason <reason>
禁用服务的原因。

5.3.66. cinder service-enable

usage: cinder service-enable <hostname> <binary>
Copy to Clipboard Toggle word wrap
启用服务。

positional 参数

<hostname>
主机名.
<binary>
服务二进制文件。

5.3.67. cinder service-list

usage: cinder service-list [--host <hostname>] [--binary <binary>]
Copy to Clipboard Toggle word wrap
列出所有服务。按主机和服务二进制文件过滤。

可选参数

--host <hostname>
主机名.default=None。
--binary <binary>
服务二进制文件。default=None。

5.3.68. cinder set-bootable

usage: cinder set-bootable <volume> <True|true|False|false>
Copy to Clipboard Toggle word wrap
更新卷的可引导状态。

positional 参数

<volume>
要更新的卷 ID。
<True|true|False|false>
指明卷是否可引导的标记。

5.3.69. Cinder 显示

usage: cinder show <volume>
Copy to Clipboard Toggle word wrap
显示卷详情。

positional 参数

<volume>
卷的名称或 ID。

5.3.70. cinder snapshot-create

usage: cinder snapshot-create [--force [<True|False>]] [--name <name>] [--description <description>] [--metadata [<key=value> [<key=value> ...]]] <volume>
Copy to Clipboard Toggle word wrap
创建快照。

positional 参数

<volume>
要快照的卷名称或 ID。

可选参数

--force [<True|False>]
当卷附加到实例时,允许或拒绝卷快照。如果设置为 True,则在尝试快照时忽略卷的当前状态,而不是强制它可用。默认=False。
--name <name>
快照名称。default=None。
--description <description>
快照描述。default=None。
--metadata [<key=value> [<key=value> ...]]
快照元数据键值对。default=None。

5.3.71. cinder snapshot-delete

usage: cinder snapshot-delete <snapshot> [<snapshot> ...]
Copy to Clipboard Toggle word wrap
删除一个或多个快照。

positional 参数

<snapshot>
要删除的快照的名称或 ID。

5.3.72. cinder snapshot-list

usage: cinder snapshot-list [--all-tenants [<0|1>]] [--name <name>] [--status <status>] [--volume-id <volume-id>]
Copy to Clipboard Toggle word wrap
列出所有快照。

可选参数

--all-tenants [<0|1>]
显示所有租户的详细信息。仅限管理。
--name <name>
按名称过滤结果。default=None。
--status <status>
按状态过滤结果。default=None。
--volume-id <volume-id>
根据卷 ID 过滤结果。default=None。

5.3.73. cinder snapshot-metadata

usage: cinder snapshot-metadata <snapshot> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
设置或删除快照元数据。

positional 参数

<snapshot>
要更新元数据的快照 ID。
<action>
该操作。有效值为 "set" 或 "unset"。
<key=value>
要设置或取消设置的元数据键和值对。对于未设置,请只指定密钥。

5.3.74. cinder snapshot-metadata-show

usage: cinder snapshot-metadata-show <snapshot>
Copy to Clipboard Toggle word wrap
显示快照元数据。

positional 参数

<snapshot>
快照 ID。

5.3.75. cinder snapshot-metadata-update-all

usage: cinder snapshot-metadata-update-all <snapshot> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
更新快照元数据。

positional 参数

<snapshot>
要更新元数据的快照 ID。
<key=value>
要更新的元数据键和值对。

5.3.76. cinder snapshot-rename

usage: cinder snapshot-rename [--description <description>] <snapshot> [<name>]
Copy to Clipboard Toggle word wrap
重命名快照。

positional 参数

<snapshot>
快照的名称或 ID。
<name>
快照的新名称。

可选参数

--description <description>
快照描述。default=None。

5.3.77. cinder snapshot-reset-state

usage: cinder snapshot-reset-state [--state <state>] <snapshot> [<snapshot> ...]
Copy to Clipboard Toggle word wrap
显式更新快照状态。

positional 参数

<snapshot>
要修改的快照的名称或 ID。

可选参数

--state <state>
分配给快照的状态。有效值为 "available", "error", "creating", "deleting", 和 "error_deleting"。注意:此命令只需更改 DataBase 中快照的状态,在使用时不考虑实际状态,请谨慎操作。default=available。

5.3.78. cinder snapshot-show

usage: cinder snapshot-show <snapshot>
Copy to Clipboard Toggle word wrap
显示快照详情。

positional 参数

<snapshot>
快照的名称或 ID。

5.3.79. cinder transfer-accept

usage: cinder transfer-accept <transfer> <auth_key>
Copy to Clipboard Toggle word wrap
接受卷转让。

positional 参数

<transfer>
要接受的转让 ID。
<auth_key>
接受转让的身份验证密钥。

5.3.80. cinder transfer-create

usage: cinder transfer-create [--name <name>] <volume>
Copy to Clipboard Toggle word wrap
创建卷转让。

positional 参数

<volume>
要转让的卷的名称或 ID。

可选参数

--name <name>
转让名称。default=None。

5.3.81. cinder transfer-delete

usage: cinder transfer-delete <transfer>
Copy to Clipboard Toggle word wrap
撤消转让。

positional 参数

<transfer>
要删除的转让的名称或 ID。

5.3.82. cinder transfer-list

usage: cinder transfer-list [--all-tenants [<0|1>]]
Copy to Clipboard Toggle word wrap
列出所有传输。

可选参数

--all-tenants [<0|1>]
显示所有租户的详细信息。仅限管理。

5.3.83. cinder transfer-show

usage: cinder transfer-show <transfer>
Copy to Clipboard Toggle word wrap
显示传输详细信息。

positional 参数

<transfer>
要接受的转让名称或 ID。

5.3.84. cinder type-access-add

usage: cinder type-access-add --volume-type <volume_type> --project-id <project_id>
Copy to Clipboard Toggle word wrap
添加给定项目的卷类型访问权限。

可选参数

--volume-type <volume_type>
为给定项目添加访问权限的卷类型名称或 ID。
--project-id <project_id>
用于添加卷类型访问权限的项目 ID。

5.3.85. cinder type-access-list

usage: cinder type-access-list --volume-type <volume_type>
Copy to Clipboard Toggle word wrap
打印有关给定卷类型的访问信息。

可选参数

--volume-type <volume_type>
根据卷类型名称或 ID 过滤结果。

5.3.86. cinder type-access-remove

usage: cinder type-access-remove --volume-type <volume_type> --project-id <project_id>
Copy to Clipboard Toggle word wrap
删除给定项目的卷类型访问权限。

可选参数

--volume-type <volume_type>
删除给定项目的卷类型名称或 ID。
--project-id <project_id>
移除卷类型访问的项目 ID。

5.3.87. cinder type-create

usage: cinder type-create [--description <description>] [--is-public <is-public>] <name>
Copy to Clipboard Toggle word wrap
创建卷类型。

positional 参数

<name>
新卷类型的名称。

可选参数

--description <description>
新卷类型的描述。
--is-public <is-public>
make 类型可以被公共访问(默认为 true)。

5.3.88. cinder type-default

usage: cinder type-default
Copy to Clipboard Toggle word wrap
列出默认卷类型。

5.3.89. cinder type-delete

usage: cinder type-delete <id>
Copy to Clipboard Toggle word wrap
删除卷类型。

positional 参数

<id>
要删除的卷类型 ID。

5.3.90. cinder type-key

usage: cinder type-key <vtype> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
为卷类型设置或取消设置 extra_spec。

positional 参数

<vtype>
卷类型的名称或 ID。
<action>
该操作。有效值为 "set" 或 "unset"。
<key=value>
要设置或取消设置的额外 specs 键和值对。对于未设置,请只指定密钥。

5.3.91. cinder type-list

usage: cinder type-list
Copy to Clipboard Toggle word wrap
列出可用的"卷类型"。(管理员将只看到私有类型。)

5.3.92. cinder type-update

usage: cinder type-update [--name <name>] [--description <description>] <id>
Copy to Clipboard Toggle word wrap
更新卷类型名称和/或描述。

positional 参数

<id>
卷类型的 ID。

可选参数

--name <name>
卷类型的名称。
--description <description>
卷类型的描述。

5.3.93. Cinder unmanage

usage: cinder unmanage <volume>
Copy to Clipboard Toggle word wrap
停止管理卷。

positional 参数

<volume>
要取消管理的卷的名称或 ID。

5.3.94. Cinder upload-to-image

usage: cinder upload-to-image [--force [<True|False>]] [--container-format <container-format>] [--disk-format <disk-format>] <volume> <image-name>
Copy to Clipboard Toggle word wrap
将卷上传到镜像服务作为镜像。

positional 参数

<volume>
要快照的卷名称或 ID。
<image-name>
新镜像名称。

可选参数

--force [<True|False>]
启用或禁用将附加到实例的卷上传。默认=False。
--container-format <container-format>
容器格式类型。默认为 bare。
--disk-format <disk-format>
磁盘格式类型。默认为 raw。

5.4. 块存储 API v2 命令

您可以通过添加 -os-volume-api-version 参数或设置对应的 环境变量来选择要使用的 API 版本:
$ export OS_VOLUME_API_VERSION=2
Copy to Clipboard Toggle word wrap

5.4.1. Cinder 绝对限制(v2)

usage: cinder --os-volume-api-version 2 absolute-limits
Copy to Clipboard Toggle word wrap
列出用户的绝对限制。

5.4.2. cinder availability-zone-list (v2)

usage: cinder --os-volume-api-version 2 availability-zone-list
Copy to Clipboard Toggle word wrap
列出所有可用区。

5.4.3. cinder backup-create (v2)

usage: cinder --os-volume-api-version 2 backup-create [--container <container>] [--name <name>] [--description <description>] [--incremental] [--force] <volume>
Copy to Clipboard Toggle word wrap
创建卷备份。

positional 参数

<volume>
要备份的卷的名称或 ID。

可选参数

--container <container>
备份容器名称。default=None。
--name <name>
备份名称。default=None。
--description <description>
备份描述。default=None。
--incremental
增量备份。默认=False。
--force
当卷附加到实例时,允许或拒绝备份卷。如果设置为 True,则备份卷的状态是 "available" 或 "in- use"。" in-use" 卷的备份意味着您的数据崩溃。默认=False。

5.4.4. cinder backup-delete (v2)

usage: cinder --os-volume-api-version 2 backup-delete <backup>
Copy to Clipboard Toggle word wrap
删除备份。

positional 参数

<backup>
要删除的备份的名称或 ID。

5.4.5. cinder backup-export (v2)

usage: cinder --os-volume-api-version 2 backup-export <backup>
Copy to Clipboard Toggle word wrap
导出备份元数据记录。

positional 参数

<backup>
要导出的备份的 ID。

5.4.6. cinder backup-import (v2)

usage: cinder --os-volume-api-version 2 backup-import <backup_service> <backup_url>
Copy to Clipboard Toggle word wrap
导入备份元数据记录。

positional 参数

<backup_service>
用于导入备份的备份服务。
<backup_url>
用于导入备份元数据的备份 URL。

5.4.7. cinder backup-list (v2)

usage: cinder --os-volume-api-version 2 backup-list [--all-tenants [<all_tenants>]] [--name <name>] [--status <status>] [--volume-id <volume-id>]
Copy to Clipboard Toggle word wrap
列出所有备份。

可选参数

--all-tenants [<all_tenants>]
显示所有租户的详细信息。仅限管理。
--name <name>
按名称过滤结果。default=None。
--status <status>
按状态过滤结果。default=None。
--volume-id <volume-id>
根据卷 ID 过滤结果。default=None。

5.4.8. cinder backup-restore (v2)

usage: cinder --os-volume-api-version 2 backup-restore [--volume <volume>] <backup>
Copy to Clipboard Toggle word wrap
恢复备份。

positional 参数

<backup>
要恢复的备份 ID。

可选参数

--volume <volume>
要恢复到的卷的名称或 ID。default=None。

5.4.9. cinder backup-show (v2)

usage: cinder --os-volume-api-version 2 backup-show <backup>
Copy to Clipboard Toggle word wrap
显示备份详情。

positional 参数

<backup>
备份的名称或 ID。

5.4.10. cinder cgsnapshot-create (v2)

usage: cinder --os-volume-api-version 2 cgsnapshot-create [--name <name>] [--description <description>] <consistencygroup>
Copy to Clipboard Toggle word wrap
创建一个 cgsnapshot。

positional 参数

<consistencygroup>
一致性组的名称或 ID。

可选参数

--name <name>
Cgsnapshot 名称。default=None。
--description <description>
Cgsnapshot 描述。default=None。

5.4.11. cinder cgsnapshot-delete (v2)

usage: cinder --os-volume-api-version 2 cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]
Copy to Clipboard Toggle word wrap
删除一个或多个 cgsnapshot。

positional 参数

<cgsnapshot>
要删除的一个或多个 cgsnapshot 的名称或 ID。

5.4.12. cinder cgsnapshot-list (v2)

usage: cinder --os-volume-api-version 2 cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>] [--consistencygroup-id <consistencygroup_id>]
Copy to Clipboard Toggle word wrap
列出所有 cgsnapshot。

可选参数

--all-tenants [<0|1>]
显示所有租户的详细信息。仅限管理。
--status <status>
按状态过滤结果。default=None。
--consistencygroup-id <consistencygroup_id>
通过一致性组 ID 过滤结果。default=None。

5.4.13. cinder cgsnapshot-show (v2)

usage: cinder --os-volume-api-version 2 cgsnapshot-show <cgsnapshot>
Copy to Clipboard Toggle word wrap
显示 cgsnapshot 详情。

positional 参数

<cgsnapshot>
cgsnapshot 的名称或 ID。

5.4.14. Cinder consisgroup-create (v2)

usage: cinder --os-volume-api-version 2 consisgroup-create [--name <name>] [--description <description>] [--availability-zone <availability-zone>] <volume-types>
Copy to Clipboard Toggle word wrap
创建一致性组。

positional 参数

<volume-types>
卷类型。

可选参数

--name <name>
一致性组的名称。
--description <description>
一致性组的描述。default=None。
--availability-zone <availability-zone>
卷的可用区。default=None。

5.4.15. cinder consisgroup-create-from-src (v2)

usage: cinder --os-volume-api-version 2 consisgroup-create-from-src [--cgsnapshot <cgsnapshot>] [--source-cg <source-cg>] [--name <name>] [--description <description>]
Copy to Clipboard Toggle word wrap
从 cgsnapshot 或源 CG 创建一致性组。

可选参数

--cgsnapshot <cgsnapshot>
cgsnapshot 的名称或 ID。default=None。
--source-cg <source-cg>
源 CG 的名称或 ID。default=None。
--name <name>
一致性组的名称。default=None。
--description <description>
一致性组的描述。default=None。

5.4.16. Cinder consisgroup-delete (v2)

usage: cinder --os-volume-api-version 2 consisgroup-delete [--force] <consistencygroup> [<consistencygroup> ...]
Copy to Clipboard Toggle word wrap
删除一个或多个一致性组。

positional 参数

<consistencygroup>
要删除的一个或多个一致性组的名称或 ID。

可选参数

--force
允许或不允许删除一致性组。如果一致性组为空,可以在无 force 标志的情况下删除它。如果一致性组不为空,则需要删除 force 标志。

5.4.17. Cinder consisgroup-list (v2)

usage: cinder --os-volume-api-version 2 consisgroup-list [--all-tenants [<0|1>]]
Copy to Clipboard Toggle word wrap
列出所有一致性组。

可选参数

--all-tenants [<0|1>]
显示所有租户的详细信息。仅限管理。

5.4.18. Cinder consisgroup-show (v2)

usage: cinder --os-volume-api-version 2 consisgroup-show <consistencygroup>
Copy to Clipboard Toggle word wrap
显示一致性组的详细信息。

positional 参数

<consistencygroup>
一致性组的名称或 ID。

5.4.19. Cinder consisgroup-update (v2)

usage: cinder --os-volume-api-version 2 consisgroup-update [--name <name>] [--description <description>] [--add-volumes <uuid1,uuid2,......>] [--remove-volumes <uuid3,uuid4,......>] <consistencygroup>
Copy to Clipboard Toggle word wrap
更新一致性组。

positional 参数

<consistencygroup>
一致性组的名称或 ID。

可选参数

--name <name>
一致性组的新名称。default=None。
--description <description>
一致性组的新描述。default=None。
--add-volumes <uuid1,uuid2,......>
要添加到一致性组中的一个或多个卷的 UUID,用逗号分开。default=None。
--remove-volumes <uuid3,uuid4,......>
要从一致性组中删除的一个或多个卷的 UUID,用逗号分隔。default=None。

5.4.20. Cinder 创建(v2)

usage: cinder --os-volume-api-version 2 create [--consisgroup-id <consistencygroup-id>] [--snapshot-id <snapshot-id>] [--source-volid <source-volid>] [--source-replica <source-replica>] [--image-id <image-id>] [--image <image>] [--name <name>] [--description <description>] [--volume-type <volume-type>] [--availability-zone <availability-zone>] [--metadata [<key=value> [<key=value> ...]]] [--hint <key=value>] [--allow-multiattach] [<size>]
Copy to Clipboard Toggle word wrap
创建一个卷。

positional 参数

<size>
卷大小(以 GB 为单位)。(必需,除非指定了 snapshot-id /source-volid)。

可选参数

--consisgroup-id <consistencygroup-id>
新卷所属的一致性组的 ID。default=None。
--snapshot-id <snapshot-id>
从快照 ID 创建卷。default=None。
--source-volid <source-volid>
从卷 ID 创建卷。default=None。
--source-replica <source-replica>
从复制卷 ID 创建卷。default=None。
--image-id <image-id>
从镜像 ID 创建卷。default=None。
--image <image>
从镜像(ID 或名称)创建卷。default=None。
--name <name>
卷名称。default=None。
--description <description>
卷描述.default=None。
--volume-type <volume-type>
卷类型。default=None。
--availability-zone <availability-zone>
卷的可用区。default=None。
--metadata [<key=value> [<key=value> ...]]
元数据键和值对。default=None。
--hint <key=value>
调度程序提示,如 nova 中。
--allow-multiattach
允许多次连接卷。Default=False

5.4.21. Cinder 凭据(v2)

usage: cinder --os-volume-api-version 2 credentials
Copy to Clipboard Toggle word wrap
显示从 auth 返回的用户凭证。

5.4.22. Cinder 删除(v2)

usage: cinder --os-volume-api-version 2 delete <volume> [<volume> ...]
Copy to Clipboard Toggle word wrap
删除一个或多个卷。

positional 参数

<volume>
要删除的卷名称或 ID。

5.4.23. cinder encryption-type-create (v2)

usage: cinder --os-volume-api-version 2 encryption-type-create [--cipher <cipher>] [--key_size <key_size>] [--control_location <control_location>] <volume_type> <provider>
Copy to Clipboard Toggle word wrap
为卷类型创建加密类型。仅限管理。

positional 参数

<volume_type>
卷类型的名称或 ID。
<provider>
提供加密支持的类。例如,LuksEncryptor。

可选参数

--cipher <cipher>
加密算法或模式。例如: aes- xts-plain64。default=None。
--key_size <key_size>
加密密钥大小,以位为单位。例如:128 或 256。default=None。
--control_location <control_location>
执行加密的 notional 服务。有效值为 "front-end" 或 "back-end"。例如,前端=Nova。默认为"前端"。

5.4.24. cinder encryption-type-delete (v2)

usage: cinder --os-volume-api-version 2 encryption-type-delete <volume_type>
Copy to Clipboard Toggle word wrap
删除卷类型的加密类型。仅限管理。

positional 参数

<volume_type>
卷类型的名称或 ID。

5.4.25. cinder encryption-type-list (v2)

usage: cinder --os-volume-api-version 2 encryption-type-list
Copy to Clipboard Toggle word wrap
显示卷类型的加密类型详情。仅限管理。

5.4.26. cinder encryption-type-show (v2)

usage: cinder --os-volume-api-version 2 encryption-type-show <volume_type>
Copy to Clipboard Toggle word wrap
显示卷类型的加密类型详情。仅限管理。

positional 参数

<volume_type>
卷类型的名称或 ID。

5.4.27. cinder encryption-type-update (v2)

usage: cinder --os-volume-api-version 2 encryption-type-update [--provider <provider>] [--cipher [<cipher>]] [--key-size [<key-size>]] [--control-location <control-location>] <volume-type>
Copy to Clipboard Toggle word wrap
更新卷类型的加密类型信息(Admin Only)。

positional 参数

<volume-type>
卷类型的名称或 ID

可选参数

--provider <provider>
提供加密支持的类(如 LuksEncryptor)(可选)
--cipher [<cipher>]
要使用的加密算法/模式(如 aes-xts- plain64))。提供参数,但没有值设为 provider default。(可选)
--key-size [<key-size>]
加密密钥的大小,以位为单位(例如 128、256)。提供参数,但没有值设为 provider default。(可选)
--control-location <control-location>
执行加密的 notional 服务(例如,前端=Nova)。值:"前端",'back-end'(可选)

5.4.28. Cinder 端点(v2)

usage: cinder --os-volume-api-version 2 endpoints
Copy to Clipboard Toggle word wrap
发现由身份验证服务注册的端点。

5.4.29. Cinder 扩展(v2)

usage: cinder --os-volume-api-version 2 extend <volume> <new_size>
Copy to Clipboard Toggle word wrap
尝试扩展现有卷的大小。

positional 参数

<volume>
要扩展的卷的名称或 ID。
<new_size>
新卷的大小(以 GB 为单位)。

5.4.30. cinder extra-specs-list (v2)

usage: cinder --os-volume-api-version 2 extra-specs-list
Copy to Clipboard Toggle word wrap
列出当前卷类型和额外规格。

5.4.31. cinder force-delete (v2)

usage: cinder --os-volume-api-version 2 force-delete <volume> [<volume> ...]
Copy to Clipboard Toggle word wrap
无论状态如何,尝试强制删除卷。

positional 参数

<volume>
要删除的卷名称或 ID。

5.4.32. cinder get-capabilities (v2)

usage: cinder --os-volume-api-version 2 get-capabilities <host>
Copy to Clipboard Toggle word wrap
显示后端卷统计和属性。仅限管理。

positional 参数

<host>
Cinder host 以显示后端卷统计和属性;采用以下形式:host@backend-name

5.4.33. cinder get-pools (v2)

usage: cinder --os-volume-api-version 2 get-pools [--detail]
Copy to Clipboard Toggle word wrap
显示后端的池信息。仅限管理。

可选参数

--detail
显示有关池的详细信息。

5.4.34. cinder image-metadata (v2)

usage: cinder --os-volume-api-version 2 image-metadata <volume> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
设置或删除卷镜像元数据。

positional 参数

<volume>
要更新元数据的卷的名称或 ID。
<action>
该操作。有效值为 'set' 或 'unset.'
<key=value>
要设置或取消设置的元数据键和值对。对于未设置,请只指定密钥。

5.4.35. Cinder 列表(v2)

usage: cinder --os-volume-api-version 2 list [--all-tenants [<0|1>]] [--name <name>] [--status <status>] [--migration_status <migration_status>] [--metadata [<key=value> [<key=value> ...]]] [--marker <marker>] [--limit <limit>] [--sort <key>[:<direction>]] [--tenant [<tenant>]]
Copy to Clipboard Toggle word wrap
列出所有卷。

可选参数

--all-tenants [<0|1>]
显示所有租户的详细信息。仅限管理。
--name <name>
按名称过滤结果。default=None。
--status <status>
按状态过滤结果。default=None。
--migration_status <migration_status>
根据迁移状态过滤结果。default=None。仅限管理。
--metadata [<key=value> [<key=value> ...]]
通过元数据键值对过滤结果。default=None。
--marker <marker>
开始返回稍后出现在卷列表中的卷,而不是此卷 ID 表示的卷。default=None。
--limit <limit>
要返回的最大卷数。default=None。
--sort <key>[:<direction>]
以逗号分隔的排序键和方向列表,格式为 <key>[:<asc|desc>]。有效键: id, status, size, availability_zone, name, bootable, created_at.default=None。
--tenant [<tenant>]
显示来自单个租户的信息(仅限管理员)。

5.4.36. cinder list-extensions (v2)

usage: cinder --os-volume-api-version 2 list-extensions
Copy to Clipboard Toggle word wrap
列出所有可用的 os-api 扩展。

5.4.37. Cinder 管理(v2)

usage: cinder --os-volume-api-version 2 manage [--id-type <id-type>] [--name <name>] [--description <description>] [--volume-type <volume-type>] [--availability-zone <availability-zone>] [--metadata [<key=value> [<key=value> ...]]] [--bootable] <host> <identifier>
Copy to Clipboard Toggle word wrap
管理现有卷。

positional 参数

<host>
现有卷所在的 Cinder 主机 ; 采用以下形式:host@backend-name""pool
<identifier>
现有卷的名称或其他标识符

可选参数

--id-type <id-type>
提供的后端设备标识符类型,通常为 source-name 或 source-id (Default=source-name)
--name <name>
卷名称(Default=None)
--description <description>
卷描述(Default=None)
--volume-type <volume-type>
卷类型(Default=None)
--availability-zone <availability-zone>
卷的可用区(Default=None)
--metadata [<key=value> [<key=value> ...]]
metadata key=value 对(Default=None)
--bootable
指定新创建的卷应标记为可引导

5.4.38. Cinder 元数据(v2)

usage: cinder --os-volume-api-version 2 metadata <volume> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
设置或删除卷元数据。

positional 参数

<volume>
要更新元数据的卷的名称或 ID。
<action>
该操作。有效值为 "set" 或 "unset"。
<key=value>
要设置或取消设置的元数据键和值对。对于未设置,请只指定密钥。

5.4.39. cinder metadata-show (v2)

usage: cinder --os-volume-api-version 2 metadata-show <volume>
Copy to Clipboard Toggle word wrap
显示卷元数据。

positional 参数

<volume>
卷的 ID。

5.4.40. cinder metadata-update-all (v2)

usage: cinder --os-volume-api-version 2 metadata-update-all <volume> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
更新卷元数据。

positional 参数

<volume>
要更新元数据的卷 ID。
<key=value>
要更新的元数据键和值对或对。

5.4.41. Cinder 迁移(v2)

usage: cinder --os-volume-api-version 2 migrate [--force-host-copy [<True|False>]] [--lock-volume [<True|False>]] <volume> <host>
Copy to Clipboard Toggle word wrap
将卷迁移到新主机。

positional 参数

<volume>
要迁移的卷 ID。
<host>
目标主机.

可选参数

--force-host-copy [<True|False>]
启用或禁用基于主机的通用强制迁移,这样可绕过驱动程序优化。默认=False。
--lock-volume [<True|False>]
启用或禁用由其他命令导致的卷迁移终止。这个选项适用于可用的卷。true 表示它锁定卷状态,不允许迁移中止。卷状态将在迁移过程中处于维护状态。false 表示卷迁移可以被中止。卷状态仍处于原始状态。默认=False。

5.4.42. cinder qos-associate (v2)

usage: cinder --os-volume-api-version 2 qos-associate <qos_specs> <volume_type_id>
Copy to Clipboard Toggle word wrap
将 qos specs 与指定的卷类型相关联。

positional 参数

<qos_specs>
QoS 规格 ID。
<volume_type_id>
关联 QoS 规格的卷类型 ID。

5.4.43. cinder qos-create (v2)

usage: cinder --os-volume-api-version 2 qos-create <name> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
创建 qos specs。

positional 参数

<name>
新的 QoS 规格的名称。
<key=value>
QoS 规格。

5.4.44. cinder qos-delete (v2)

usage: cinder --os-volume-api-version 2 qos-delete [--force [<True|False>]] <qos_specs>
Copy to Clipboard Toggle word wrap
删除指定的 qos specs。

positional 参数

<qos_specs>
要删除的 QoS 规格的 ID。

可选参数

--force [<True|False>]
启用或禁用删除 in-use QoS 规格。默认=False。

5.4.45. cinder qos-disassociate (v2)

usage: cinder --os-volume-api-version 2 qos-disassociate <qos_specs> <volume_type_id>
Copy to Clipboard Toggle word wrap
从指定的卷类型解除 qos specs 的关联。

positional 参数

<qos_specs>
QoS 规格 ID。
<volume_type_id>
关联 QoS 规格的卷类型 ID。

5.4.46. cinder qos-disassociate-all (v2)

usage: cinder --os-volume-api-version 2 qos-disassociate-all <qos_specs>
Copy to Clipboard Toggle word wrap
从其所有关联关联关联 qos specs。

positional 参数

<qos_specs>
要操作的 QoS 规格的 ID。

5.4.47. cinder qos-get-association (v2)

usage: cinder --os-volume-api-version 2 qos-get-association <qos_specs>
Copy to Clipboard Toggle word wrap
列出指定 qos specs 的所有关联。

positional 参数

<qos_specs>
QoS 规格 ID。

5.4.48. cinder qos-key (v2)

usage: cinder --os-volume-api-version 2 qos-key <qos_specs> <action> key=value [key=value ...]
Copy to Clipboard Toggle word wrap
为 qos spec 设置或取消设置规格。

positional 参数

<qos_specs>
QoS 规格 ID。
<action>
该操作。有效值为 "set" 或 "unset"。
key=value
要设置或取消设置的元数据键和值对。对于未设置,请只指定密钥。

5.4.49. cinder qos-list (v2)

usage: cinder --os-volume-api-version 2 qos-list
Copy to Clipboard Toggle word wrap
列出 qos specs。

5.4.50. cinder qos-show (v2)

usage: cinder --os-volume-api-version 2 qos-show <qos_specs>
Copy to Clipboard Toggle word wrap
显示 qos specs 详情。

positional 参数

<qos_specs>
要显示的 QoS 规格的 ID。

5.4.51. cinder quota-class-show (v2)

usage: cinder --os-volume-api-version 2 quota-class-show <class>
Copy to Clipboard Toggle word wrap
列出配额类的配额。

positional 参数

<class>
列出配额的配额类的名称。

5.4.52. cinder quota-class-update (v2)

usage: cinder --os-volume-api-version 2 quota-class-update [--volumes <volumes>] [--snapshots <snapshots>] [--gigabytes <gigabytes>] [--volume-type <volume_type_name>] <class_name>
Copy to Clipboard Toggle word wrap
更新配额类的配额。

positional 参数

<class_name>
设置配额的配额类的名称。

可选参数

--volumes <volumes>
新的 "volumes" 配额值。default=None。
--snapshots <snapshots>
新的 "snapshots" 配额值。default=None。
--gigabytes <gigabytes>
新的"千兆字节"配额值。default=None。
--volume-type <volume_type_name>
卷类型。default=None。

5.4.53. cinder quota-defaults (v2)

usage: cinder --os-volume-api-version 2 quota-defaults <tenant_id>
Copy to Clipboard Toggle word wrap
列出租户的默认配额。

positional 参数

<tenant_id>
列出配额默认值的租户 ID。

5.4.54. cinder quota-delete (v2)

usage: cinder --os-volume-api-version 2 quota-delete <tenant_id>
Copy to Clipboard Toggle word wrap
删除租户的配额。

positional 参数

<tenant_id>
用于删除配额的租户 UUID。

5.4.55. cinder quota-show (v2)

usage: cinder --os-volume-api-version 2 quota-show <tenant_id>
Copy to Clipboard Toggle word wrap
列出租户的配额。

positional 参数

<tenant_id>
列出配额的租户 ID。

5.4.56. cinder quota-update (v2)

usage: cinder --os-volume-api-version 2 quota-update [--volumes <volumes>] [--snapshots <snapshots>] [--gigabytes <gigabytes>] [--backups <backups>] [--backup-gigabytes <backup_gigabytes>] [--consistencygroups <consistencygroups>] [--volume-type <volume_type_name>] [--per-volume-gigabytes <per_volume_gigabytes>] <tenant_id>
Copy to Clipboard Toggle word wrap
更新租户的配额。

positional 参数

<tenant_id>
设置配额的租户 ID。

可选参数

--volumes <volumes>
新的 "volumes" 配额值。default=None。
--snapshots <snapshots>
新的 "snapshots" 配额值。default=None。
--gigabytes <gigabytes>
新的"千兆字节"配额值。default=None。
--backups <backups>
新的 "backups" 配额值。default=None。
--backup-gigabytes <backup_gigabytes>
新的 "backup_gigabytes" 配额值。default=None。
--consistencygroups <consistencygroups>
新的 "consistencygroups" 配额值。default=None。
--volume-type <volume_type_name>
卷类型。default=None。
--per-volume-gigabytes <per_volume_gigabytes>
设置最大卷大小限制。default=None。

5.4.57. cinder quota-usage (v2)

usage: cinder --os-volume-api-version 2 quota-usage <tenant_id>
Copy to Clipboard Toggle word wrap
列出租户的配额使用量。

positional 参数

<tenant_id>
列出配额使用的租户 ID。

5.4.58. cinder 速率限制(v2)

usage: cinder --os-volume-api-version 2 rate-limits
Copy to Clipboard Toggle word wrap
列出用户的速率限值。

5.4.59. cinder readonly-mode-update (v2)

usage: cinder --os-volume-api-version 2 readonly-mode-update <volume> <True|true|False|false>
Copy to Clipboard Toggle word wrap
更新卷只读 access-mode 标志。

positional 参数

<volume>
要更新的卷 ID。
<True|true|False|false>
启用或禁用卷更新到只读访问模式。

5.4.60. Cinder 重命名(v2)

usage: cinder --os-volume-api-version 2 rename [--description <description>] <volume> [<name>]
Copy to Clipboard Toggle word wrap
重命名卷。

positional 参数

<volume>
要重命名的卷的名称或 ID。
<name>
卷的新名称。

可选参数

--description <description>
卷描述.default=None。

5.4.61. cinder replication-promote (v2)

usage: cinder --os-volume-api-version 2 replication-promote <volume>
Copy to Clipboard Toggle word wrap
将二级卷提升为主卷,以保持关系。

positional 参数

<volume>
要提升的卷的名称或 ID。卷应该具有使用 source-replica 参数创建的副本卷。

5.4.62. cinder replication-reenable (v2)

usage: cinder --os-volume-api-version 2 replication-reenable <volume>
Copy to Clipboard Toggle word wrap
将二级卷与主要卷同步。

positional 参数

<volume>
重新启用复制的卷的名称或 ID。卷的 replication- 状态应该不活跃。

5.4.63. cinder reset-state (v2)

usage: cinder --os-volume-api-version 2 reset-state [--state <state>] [--attach-status <attach-status>] [--reset-migration-status] <volume> [<volume> ...]
Copy to Clipboard Toggle word wrap
显式更新 Cinder 数据库中的卷状态。请注意,这不会影响卷是否实际附加到 Nova 计算主机或实例,并可能导致卷不可用。只是一个数据库更改,这不会影响卷的 true 状态,且可能与实际状态不匹配。当卷更改为 'available' 状态时,可能会导致卷不可用。

positional 参数

<volume>
要修改的卷的名称或 ID。

可选参数

--state <state>
分配给卷的状态。有效值为 "available", "error", "creating", "deleting", "in- use", "attaching", "detaching", "error_deleting" 和 "maintenance"。注意:此命令只需更改 DataBase 中的卷状态,在使用时不考虑实际状态,请谨慎操作。default=available。
--attach-status <attach-status>
要分配给 DataBase 中的卷的附加状态,其实际状态与实际状态无关。有效值为 "attached" 和 "detached"。default=None,这意味着状态保持不变。
--reset-migration-status
清除 DataBase 中卷的迁移状态,表示卷是卷迁移的来源或目标,与实际状态无关。

5.4.64. Cinder 重新类型(v2)

usage: cinder --os-volume-api-version 2 retype [--migration-policy <never|on-demand>] <volume> <volume-type>
Copy to Clipboard Toggle word wrap
更改卷的卷类型。

positional 参数

<volume>
要修改类型的卷的名称或 ID。
<volume-type>
新卷类型。

可选参数

--migration-policy <never|on-demand>
重新键入卷期间迁移策略。

5.4.65. cinder service-disable (v2)

usage: cinder --os-volume-api-version 2 service-disable [--reason <reason>] <hostname> <binary>
Copy to Clipboard Toggle word wrap
禁用服务。

positional 参数

<hostname>
主机名.
<binary>
服务二进制文件。

可选参数

--reason <reason>
禁用服务的原因。

5.4.66. cinder service-enable (v2)

usage: cinder --os-volume-api-version 2 service-enable <hostname> <binary>
Copy to Clipboard Toggle word wrap
启用服务。

positional 参数

<hostname>
主机名.
<binary>
服务二进制文件。

5.4.67. cinder service-list (v2)

usage: cinder --os-volume-api-version 2 service-list [--host <hostname>] [--binary <binary>]
Copy to Clipboard Toggle word wrap
列出所有服务。按主机和服务二进制文件过滤。

可选参数

--host <hostname>
主机名.default=None。
--binary <binary>
服务二进制文件。default=None。

5.4.68. cinder set-bootable (v2)

usage: cinder --os-volume-api-version 2 set-bootable <volume> <True|true|False|false>
Copy to Clipboard Toggle word wrap
更新卷的可引导状态。

positional 参数

<volume>
要更新的卷 ID。
<True|true|False|false>
指明卷是否可引导的标记。

5.4.69. Cinder show (v2)

usage: cinder --os-volume-api-version 2 show <volume>
Copy to Clipboard Toggle word wrap
显示卷详情。

positional 参数

<volume>
卷的名称或 ID。

5.4.70. cinder snapshot-create (v2)

usage: cinder --os-volume-api-version 2 snapshot-create [--force [<True|False>]] [--name <name>] [--description <description>] [--metadata [<key=value> [<key=value> ...]]] <volume>
Copy to Clipboard Toggle word wrap
创建快照。

positional 参数

<volume>
要快照的卷名称或 ID。

可选参数

--force [<True|False>]
当卷附加到实例时,允许或拒绝卷快照。如果设置为 True,则在尝试快照时忽略卷的当前状态,而不是强制它可用。默认=False。
--name <name>
快照名称。default=None。
--description <description>
快照描述。default=None。
--metadata [<key=value> [<key=value> ...]]
快照元数据键值对。default=None。

5.4.71. cinder snapshot-delete (v2)

usage: cinder --os-volume-api-version 2 snapshot-delete <snapshot> [<snapshot> ...]
Copy to Clipboard Toggle word wrap
删除一个或多个快照。

positional 参数

<snapshot>
要删除的快照的名称或 ID。

5.4.72. cinder snapshot-list (v2)

usage: cinder --os-volume-api-version 2 snapshot-list [--all-tenants [<0|1>]] [--name <name>] [--status <status>] [--volume-id <volume-id>]
Copy to Clipboard Toggle word wrap
列出所有快照。

可选参数

--all-tenants [<0|1>]
显示所有租户的详细信息。仅限管理。
--name <name>
按名称过滤结果。default=None。
--status <status>
按状态过滤结果。default=None。
--volume-id <volume-id>
根据卷 ID 过滤结果。default=None。

5.4.73. cinder snapshot-metadata (v2)

usage: cinder --os-volume-api-version 2 snapshot-metadata <snapshot> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
设置或删除快照元数据。

positional 参数

<snapshot>
要更新元数据的快照 ID。
<action>
该操作。有效值为 "set" 或 "unset"。
<key=value>
要设置或取消设置的元数据键和值对。对于未设置,请只指定密钥。

5.4.74. cinder snapshot-metadata-show (v2)

usage: cinder --os-volume-api-version 2 snapshot-metadata-show <snapshot>
Copy to Clipboard Toggle word wrap
显示快照元数据。

positional 参数

<snapshot>
快照 ID。

5.4.75. cinder snapshot-metadata-update-all (v2)

usage: cinder --os-volume-api-version 2 snapshot-metadata-update-all <snapshot> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
更新快照元数据。

positional 参数

<snapshot>
要更新元数据的快照 ID。
<key=value>
要更新的元数据键和值对。

5.4.76. cinder snapshot-rename (v2)

usage: cinder --os-volume-api-version 2 snapshot-rename [--description <description>] <snapshot> [<name>]
Copy to Clipboard Toggle word wrap
重命名快照。

positional 参数

<snapshot>
快照的名称或 ID。
<name>
快照的新名称。

可选参数

--description <description>
快照描述。default=None。

5.4.77. cinder snapshot-reset-state (v2)

usage: cinder --os-volume-api-version 2 snapshot-reset-state [--state <state>] <snapshot> [<snapshot> ...]
Copy to Clipboard Toggle word wrap
显式更新快照状态。

positional 参数

<snapshot>
要修改的快照的名称或 ID。

可选参数

--state <state>
分配给快照的状态。有效值为 "available", "error", "creating", "deleting", 和 "error_deleting"。注意:此命令只需更改 DataBase 中快照的状态,在使用时不考虑实际状态,请谨慎操作。default=available。

5.4.78. cinder snapshot-show (v2)

usage: cinder --os-volume-api-version 2 snapshot-show <snapshot>
Copy to Clipboard Toggle word wrap
显示快照详情。

positional 参数

<snapshot>
快照的名称或 ID。

5.4.79. cinder transfer-accept (v2)

usage: cinder --os-volume-api-version 2 transfer-accept <transfer> <auth_key>
Copy to Clipboard Toggle word wrap
接受卷转让。

positional 参数

<transfer>
要接受的转让 ID。
<auth_key>
接受转让的身份验证密钥。

5.4.80. cinder transfer-create (v2)

usage: cinder --os-volume-api-version 2 transfer-create [--name <name>] <volume>
Copy to Clipboard Toggle word wrap
创建卷转让。

positional 参数

<volume>
要转让的卷的名称或 ID。

可选参数

--name <name>
转让名称。default=None。

5.4.81. cinder transfer-delete (v2)

usage: cinder --os-volume-api-version 2 transfer-delete <transfer>
Copy to Clipboard Toggle word wrap
撤消转让。

positional 参数

<transfer>
要删除的转让的名称或 ID。

5.4.82. cinder transfer-list (v2)

usage: cinder --os-volume-api-version 2 transfer-list [--all-tenants [<0|1>]]
Copy to Clipboard Toggle word wrap
列出所有传输。

可选参数

--all-tenants [<0|1>]
显示所有租户的详细信息。仅限管理。

5.4.83. cinder transfer-show (v2)

usage: cinder --os-volume-api-version 2 transfer-show <transfer>
Copy to Clipboard Toggle word wrap
显示传输详细信息。

positional 参数

<transfer>
要接受的转让名称或 ID。

5.4.84. cinder type-access-add (v2)

usage: cinder --os-volume-api-version 2 type-access-add --volume-type <volume_type> --project-id <project_id>
Copy to Clipboard Toggle word wrap
添加给定项目的卷类型访问权限。

可选参数

--volume-type <volume_type>
为给定项目添加访问权限的卷类型名称或 ID。
--project-id <project_id>
用于添加卷类型访问权限的项目 ID。

5.4.85. cinder type-access-list (v2)

usage: cinder --os-volume-api-version 2 type-access-list --volume-type <volume_type>
Copy to Clipboard Toggle word wrap
打印有关给定卷类型的访问信息。

可选参数

--volume-type <volume_type>
根据卷类型名称或 ID 过滤结果。

5.4.86. cinder type-access-remove (v2)

usage: cinder --os-volume-api-version 2 type-access-remove --volume-type <volume_type> --project-id <project_id>
Copy to Clipboard Toggle word wrap
删除给定项目的卷类型访问权限。

可选参数

--volume-type <volume_type>
删除给定项目的卷类型名称或 ID。
--project-id <project_id>
移除卷类型访问的项目 ID。

5.4.87. cinder type-create (v2)

usage: cinder --os-volume-api-version 2 type-create [--description <description>] [--is-public <is-public>] <name>
Copy to Clipboard Toggle word wrap
创建卷类型。

positional 参数

<name>
新卷类型的名称。

可选参数

--description <description>
新卷类型的描述。
--is-public <is-public>
make 类型可以被公共访问(默认为 true)。

5.4.88. cinder type-default (v2)

usage: cinder --os-volume-api-version 2 type-default
Copy to Clipboard Toggle word wrap
列出默认卷类型。

5.4.89. cinder type-delete (v2)

usage: cinder --os-volume-api-version 2 type-delete <id>
Copy to Clipboard Toggle word wrap
删除卷类型。

positional 参数

<id>
要删除的卷类型 ID。

5.4.90. cinder type-key (v2)

usage: cinder --os-volume-api-version 2 type-key <vtype> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
为卷类型设置或取消设置 extra_spec。

positional 参数

<vtype>
卷类型的名称或 ID。
<action>
该操作。有效值为 "set" 或 "unset"。
<key=value>
要设置或取消设置的额外 specs 键和值对。对于未设置,请只指定密钥。

5.4.91. cinder type-list (v2)

usage: cinder --os-volume-api-version 2 type-list
Copy to Clipboard Toggle word wrap
列出可用的"卷类型"。(管理员将只看到私有类型。)

5.4.92. cinder type-update (v2)

usage: cinder --os-volume-api-version 2 type-update [--name <name>] [--description <description>] <id>
Copy to Clipboard Toggle word wrap
更新卷类型名称和/或描述。

positional 参数

<id>
卷类型的 ID。

可选参数

--name <name>
卷类型的名称。
--description <description>
卷类型的描述。

5.4.93. Cinder 未管理(v2)

usage: cinder --os-volume-api-version 2 unmanage <volume>
Copy to Clipboard Toggle word wrap
停止管理卷。

positional 参数

<volume>
要取消管理的卷的名称或 ID。

5.4.94. Cinder upload-to-image (v2)

usage: cinder --os-volume-api-version 2 upload-to-image [--force [<True|False>]] [--container-format <container-format>] [--disk-format <disk-format>] <volume> <image-name>
Copy to Clipboard Toggle word wrap
将卷上传到镜像服务作为镜像。

positional 参数

<volume>
要快照的卷名称或 ID。
<image-name>
新镜像名称。

可选参数

--force [<True|False>]
启用或禁用将附加到实例的卷上传。默认=False。
--container-format <container-format>
容器格式类型。默认为 bare。
--disk-format <disk-format>
磁盘格式类型。默认为 raw。

第 6 章 计算命令行客户端

nova 客户端是 OpenStack Compute API 及其扩展的命令行界面(CLI)。本章记录了 nova 版本 2.30.1
有关特定 nova 命令的帮助信息,请输入:
$ nova help COMMAND
Copy to Clipboard Toggle word wrap

6.1. Nova 用法

usage: nova [--version] [--debug] [--os-cache] [--timings] [--os-auth-token OS_AUTH_TOKEN] [--os-tenant-name <auth-tenant-name>] [--os-tenant-id <auth-tenant-id>] [--os-region-name <region-name>] [--os-auth-system <auth-system>] [--service-type <service-type>] [--service-name <service-name>] [--volume-service-name <volume-service-name>] [--os-endpoint-type <endpoint-type>] [--os-compute-api-version <compute-api-ver>] [--bypass-url <bypass-url>] [--insecure] [--os-cacert <ca-certificate>] [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>] [--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID] [--os-domain-name OS_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID] [--os-project-name OS_PROJECT_NAME] [--os-project-domain-id OS_PROJECT_DOMAIN_ID] [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] [--os-trust-id OS_TRUST_ID] [--os-user-id OS_USER_ID] [--os-user-name OS_USERNAME] [--os-user-domain-id OS_USER_DOMAIN_ID] [--os-user-domain-name OS_USER_DOMAIN_NAME] [--os-password OS_PASSWORD] <subcommand> ...
Copy to Clipboard Toggle word wrap

子命令

absolute-limits
DEPRECATED,改为使用 limits。
add-fixed-ip
将网络上的新 IP 地址添加到 server。
add-floating-ip
DEPRECATED,改为使用 floating-ip-associate。
add-secgroup
将安全组添加到服务器。
agent-create
创建新代理构建。
agent-delete
删除现有代理构建。
agent-list
列出所有构建。
agent-modify
修改现有代理构建。
aggregate-add-host
将主机添加到指定的聚合中。
aggregate-create
使用指定详情创建一个新聚合。
aggregate-delete
删除聚合。
aggregate-details
显示指定聚合的详情。
aggregate-list
打印所有聚合的列表。
aggregate-remove-host
从指定的聚合中删除指定的主机。
aggregate-set-metadata
更新与聚合关联的元数据。
aggregate-update
更新聚合的名称和可选可用性区域。
availability-zone-list
列出所有可用区。
backup
通过创建 'backup' 类型快照来备份服务器。
boot
引导新的服务器。
clear-password
清除服务器的 admin 密码。
cloudpipe-configure
更新 cloudpipe 实例的 VPN IP/端口。
cloudpipe-create
为给定项目创建一个 cloudpipe 实例。
cloudpipe-list
打印所有 cloudpipe 实例的列表。
console-log
获取服务器的控制台日志输出。
credentials
显示从 auth 返回的用户凭证。
delete
立即关闭并删除指定的服务器。
诊断
检索服务器诊断。
dns-create
为域、名称和 IP 创建 DNS 条目。
dns-create-private-domain
创建指定的 DNS 域。
dns-create-public-domain
创建指定的 DNS 域。
dns-delete
删除指定的 DNS 条目。
dns-delete-domain
删除指定的 DNS 域。
dns-domains
显示可用 dns 域列表。
dns-list
列出域和 IP 或域名的当前 DNS 条目。
端点
发现从验证服务返回的端点。
evacuate
从失败的主机撤离服务器.
fixed-ip-get
在固定 IP 上检索信息。
fixed-ip-reserve
保留固定 IP。
fixed-ip-unreserve
取消设置固定 IP。
flavor-access-add
为给定租户添加类别访问权限。
flavor-access-list
输出有关给定类别的访问权限信息。
flavor-access-remove
移除给定租户的类别访问权限。
flavor-create
创建新类别
flavor-delete
删除一个特定的类别
flavor-key
为类别设置或取消设置 extra_spec。
flavor-list
显示可用"flavors"列表(服务器大小)。
flavor-show
显示给定类别的详细信息。
floating-ip-associate
将浮动 IP 地址关联到服务器。
floating-ip-bulk-create
批量根据范围创建浮动 IP (仅限创新网络)。
floating-ip-bulk-delete
根据范围批量删除浮动 IP (仅限创新网络)。
floating-ip-bulk-list
列出所有浮动 IP (仅限nova-network)。
floating-ip-create
为当前租户分配一个浮动 IP。
floating-ip-delete
取消分配浮动 IP。
floating-ip-disassociate
从服务器取消关联浮动 IP 地址。
floating-ip-list
列出浮动 IP。
floating-ip-pool-list
列出所有浮动 IP 池。
get-password
获取服务器的 admin 密码。
get-rdp-console
向服务器获取 rdp 控制台。
get-serial-console
获取到服务器的串行控制台。
get-spice-console
向服务器获取 spice 控制台。
get-vnc-console
获取到服务器的 vnc 控制台。
host-action
对主机执行电源操作。
host-describe
描述特定主机。
host-list
按服务列出所有主机。
host-update
更新主机设置。
hypervisor-list
列出虚拟机监控程序。
hypervisor-servers
列出属于特定虚拟机监控程序的服务器。
hypervisor-show
显示指定虚拟机监控程序的详细信息。
hypervisor-stats
获取所有计算节点的虚拟机监控程序统计信息。
hypervisor-uptime
显示指定 hypervisor 的正常运行时间。
image-create
通过对正在运行的服务器执行快照来创建新镜像。
image-delete
删除指定的镜像。
image-list
输出要从中引导的可用镜像列表。
image-meta
在镜像上设置或删除元数据。
image-show
显示给定镜像的详细信息。
interface-attach
将网络接口连接到服务器。
interface-detach
从服务器分离网络接口。
interface-list
列出连接到服务器的接口。
keypair-add
创建用于服务器的新密钥对。
keypair-delete
删除其名称提供的密钥对。
keypair-list
为用户打印密钥对列表
keypair-show
显示给定密钥对的详细信息。
limits
打印速率和绝对限制。
list
列出活动服务器。
list-secgroup
列出服务器的安全组。
实时迁移
将正在运行的服务器迁移到新计算机。
lock
锁定服务器。普通的(非 admin)用户将无法对锁定的服务器执行操作。
meta
在服务器上设置或删除元数据。
migrate
迁移服务器。新主机将由调度程序选择。
network-associate-host
将主机与网络关联。
network-associate-project
将项目与网络关联。
network-create
创建网络。
network-delete
通过标签或 id 删除网络。
network-disassociate
从给定网络中解除关联主机和/或项目。
network-list
显示可用网络列表。
network-show
显示给定网络的详细信息。
pause
暂停服务器。
quota-class-show
列出配额类的配额。
quota-class-update
更新配额类的配额。
quota-defaults
列出租户的默认配额。
quota-delete
删除租户/用户的配额,以使其配额将恢复为默认状态。
quota-show
列出租户/用户的配额。
quota-update
更新租户/用户的配额。
rate-limits
DEPRECATED,改为使用 limits。
reboot
重启服务器。
重建
关闭、重新镜像并重新引导服务器。
refresh-network
刷新服务器网络信息。
remove-fixed-ip
从服务器中删除 IP 地址。
remove-floating-ip
DEPRECATED,改为使用 floating-ip-disassociate。
remove-secgroup
从服务器移除安全组。
rename
重命名服务器。
救援
将服务器重新启动进入救援模式,该模式从初始镜像或指定镜像启动计算机,并将当前引导磁盘作为辅助功能附加。
reset-network
重置服务器网络。
reset-state
重置服务器的状态。
调整大小
调整服务器大小。
resize-confirm
确认上调整大小。
resize-revert
恢复之前的大小(并返回到以前的虚拟机)。
resume
恢复服务器。
root-password
DEPRECATED,改为使用 set-password。
scrub
删除与项目关联的网络和安全组。
secgroup-add-default-rule
向规则中添加一条规则,该规则将添加到新租户的"默认"安全组中(仅限nova-network)。
secgroup-add-group-rule
向安全组添加源组规则。
secgroup-add-rule
向安全组添加规则。
secgroup-create
创建安全组。
secgroup-delete
删除安全组。
secgroup-delete-default-rule
从一组规则中删除一条规则,该规则将添加到新租户的"默认"安全组中(仅限nova-network)。
secgroup-delete-group-rule
从安全组中删除源组规则。
secgroup-delete-rule
从安全组中删除规则。
secgroup-list
列出当前租户的安全组。
secgroup-list-default-rules
列出将添加到新租户的"默认"安全组中的规则。
secgroup-list-rules
列出安全组的规则。
secgroup-update
更新安全组。
server-group-create
使用指定详情创建新服务器组。
server-group-delete
删除特定的服务器组。
server-group-get
获取特定的服务器组。
server-group-list
打印所有服务器组的列表。
service-delete
删除该服务。
service-disable
禁用服务。
service-enable
启用服务。
service-force-down
强制服务停机。(API 版本 '2.11' - '2.latest' 支持)
service-list
显示所有正在运行的服务的列表。按主机和二进制文件过滤。
set-password
更改服务器的 admin 密码。
shelve
她将服务器装置。
shelve-offload
从计算节点移除 shelved 服务器。
显示
显示给定服务器的详细信息。
ssh
SSH 到服务器。
start
启动服务器。
stop
停止服务器。
suspend
暂停服务器。
unlock
解锁服务器。
unpause
取消暂停服务器。
unrescue
再次从正常引导磁盘重新启动服务器。
unshelve
取消缩小服务器。
usage
显示单个租户的使用情况数据。
usage-list
列出所有租户的使用情况数据。
version-list
列出所有 API 版本。
volume-attach
将卷附加到服务器。
volume-create
DEPRECATED: 添加新卷。
volume-delete
DEPRECATED: 删除卷。
volume-detach
将卷从服务器分离。
volume-list
DEPRECATED :列出所有卷。
volume-show
DEPRECATED :显示卷的详细信息。
volume-snapshot-create
DEPRECATED: 添加新快照。
volume-snapshot-delete
DEPRECATED :删除快照。
volume-snapshot-list
DEPRECATED :列出所有快照。
volume-snapshot-show
DEPRECATED :显示快照的详细信息。
volume-type-create
DEPRECATED: 创建新卷类型。
volume-type-delete
DEPRECATED: 删除特定的卷类型。
volume-type-list
DEPRECATED: 打印可用"卷类型"列表。
volume-update
更新卷附加。
x509-create-cert
为租户中的用户创建 x509 证书。
x509-get-root-cert
获取 x509 根证书。
bash-completion
将所有命令和选项输出到 stdout,以便 nova.bash_completion 脚本不必硬编码它们。
帮助
显示有关该程序或其其中一个子命令的帮助。
baremetal-interface-add
将网络接口添加到裸机节点。
baremetal-interface-list
列出与裸机节点关联的网络接口。
baremetal-interface-remove
从裸机节点删除网络接口。
baremetal-node-create
创建裸机节点。
baremetal-node-delete
删除裸机节点以及任何关联的接口。
baremetal-node-list
打印可用裸机节点列表。
baremetal-node-show
显示有关裸机节点的信息。
cell-capacities
获取所有单元格或给定单元的单元容量。
cell-show
显示给定单元的详情。
force-delete
强制删除服务器。
restore
恢复软删除服务器。
host-evacuate
从失败的主机中撤离所有实例。
host-evacuate-live
将指定主机的所有实例实时迁移到其他可用的主机上。
host-servers-migrate
将指定主机的所有实例迁移到其他可用主机。
instance-action
显示操作。
instance-action-list
列出服务器上的操作。
list-extensions
列出所有可用的 os-api 扩展。
host-meta
在主机的所有实例上设置或删除元数据。
migration-list
打印迁移列表。
net
DEPRECATED,改为使用 tenant-network-show。
net-create
DEPRECATED,改为使用 tenant-network-create。
net-delete
DEPRECATED,改为使用 tenant-network-delete。
net-list
DEPRECATED,改为使用 tenant-network-list。
tenant-network-create
创建租户网络。
tenant-network-delete
删除租户网络。
tenant-network-list
列出租户网络。
tenant-network-show
显示租户网络。

6.2. Nova 可选参数

--version
显示程序的版本号并退出
--debug
打印调试输出
--os-cache
使用身份验证令牌缓存。如果没有设置 env[OS_CACHE],则默认为 False。
--timings
打印调用时间信息
--os-auth-token OS_AUTH_TOKEN
默认为 env[OS_AUTH_TOKEN]
--os-tenant-name <auth-tenant-name>
默认为 env[OS_TENANT_NAME]
--os-tenant-id <auth-tenant-id>
默认为 env[OS_TENANT_ID]
--os-region-name <region-name>
默认为 env[OS_REGION_NAME]
--os-auth-system <auth-system>
默认为 env[OS_AUTH_SYSTEM]
--service-type <service-type>
对于大多数操作,默认为 compute
--service-name <service-name>
默认为 env[NOVA_SERVICE_NAME]
--volume-service-name <volume-service-name>
默认为 env[NOVA_VOLUME_SERVICE_NAME]
--os-endpoint-type <endpoint-type>
默认为 env[NOVA_ENDPOINT_TYPE]env[OS_ENDPOINT_TYPE] 或 publicURL。
--os-compute-api-version <compute-api-ver>
接受 X, X.Y (其中 X 是主,Y 是次要部分)或 "X.latest",默认为 env[OS_COMPUTE_API_VERSION]
--bypass-url <bypass-url>
使用此 API 端点而不是服务目录。默认为 env[NOVACLIENT_BYPASS_URL]
--insecure
明确允许客户端执行"不安全"TLS (https)请求。服务器的证书不会针对任何证书颁发机构进行验证。这个选项应谨慎使用。
--os-cacert <ca-certificate>
指定用于验证 TLS (https)服务器证书中使用的 CA 捆绑包文件。默认为 env[OS_CACERT]
--os-cert <certificate>
默认为 env[OS_CERT]
--os-key <key>
默认为 env[OS_KEY]
--timeout <seconds>
设置请求超时(以秒为单位)。
--os-auth-url OS_AUTH_URL
身份验证 URL
--os-domain-id OS_DOMAIN_ID
域 ID 范围
--os-domain-name OS_DOMAIN_NAME
域名范围为
--os-project-id OS_PROJECT_ID
项目 ID 到范围
--os-project-name OS_PROJECT_NAME
项目名称到范围
--os-project-domain-id OS_PROJECT_DOMAIN_ID
包含项目的域 ID
--os-project-domain-name OS_PROJECT_DOMAIN_NAME
包含项目的域名
--os-trust-id OS_TRUST_ID
信任 ID
--os-user-id OS_USER_ID
用户 ID
--os-user-name OS_USERNAME, --os-username OS_USERNAME
用户名
--os-user-domain-id OS_USER_DOMAIN_ID
用户的域 ID
--os-user-domain-name OS_USER_DOMAIN_NAME
用户的域名
--os-password OS_PASSWORD
用户密码

6.3. nova add-fixed-ip

usage: nova add-fixed-ip <server> <network-id>
Copy to Clipboard Toggle word wrap
将网络上的新 IP 地址添加到 server。

positional 参数

<server>
服务器的名称或 ID。
<network-id>
网络 ID。

6.4. nova add-secgroup

usage: nova add-secgroup <server> <secgroup>
Copy to Clipboard Toggle word wrap
将安全组添加到服务器。

positional 参数

<server>
服务器的名称或 ID。
<secgroup>
安全组的名称。

6.5. nova agent-create

usage: nova agent-create <os> <architecture> <version> <url> <md5hash> <hypervisor>
Copy to Clipboard Toggle word wrap
创建新代理构建。

positional 参数

<os>
os 的类型。
<architecture>
架构类型
<version>
version
<url>
url
<md5hash>
md5 hash
<hypervisor>
管理程序的类型。

6.6. Nova agent-delete

usage: nova agent-delete <id>
Copy to Clipboard Toggle word wrap
删除现有代理构建。

positional 参数

<id>
agent-build 的 ID

6.7. nova agent-list

usage: nova agent-list [--hypervisor <hypervisor>]
Copy to Clipboard Toggle word wrap
列出所有构建。

可选参数

--hypervisor <hypervisor>
管理程序的类型。

6.8. nova agent-modify

usage: nova agent-modify <id> <version> <url> <md5hash>
Copy to Clipboard Toggle word wrap
修改现有代理构建。

positional 参数

<id>
agent-build 的 ID
<version>
version
<url>
url
<md5hash>
md5hash

6.9. nova aggregate-add-host

usage: nova aggregate-add-host <aggregate> <host>
Copy to Clipboard Toggle word wrap
将主机添加到指定的聚合中。

positional 参数

<aggregate>
聚合名称或 ID。
<host>
要添加到聚合的主机。

6.10. nova aggregate-create

usage: nova aggregate-create <name> [<availability-zone>]
Copy to Clipboard Toggle word wrap
使用指定详情创建一个新聚合。

positional 参数

<name>
聚合的名称。
<availability-zone>
聚合的可用区(可选)。

6.11. nova aggregate-delete

usage: nova aggregate-delete <aggregate>
Copy to Clipboard Toggle word wrap
删除聚合。

positional 参数

<aggregate>
要删除的聚合名称或 ID。

6.12. nova aggregate-details

usage: nova aggregate-details <aggregate>
Copy to Clipboard Toggle word wrap
显示指定聚合的详情。

positional 参数

<aggregate>
聚合名称或 ID。

6.13. nova aggregate-list

usage: nova aggregate-list
Copy to Clipboard Toggle word wrap
打印所有聚合的列表。

6.14. nova aggregate-remove-host

usage: nova aggregate-remove-host <aggregate> <host>
Copy to Clipboard Toggle word wrap
从指定的聚合中删除指定的主机。

positional 参数

<aggregate>
聚合名称或 ID。
<host>
从聚合中删除的主机。

6.15. nova aggregate-set-metadata

usage: nova aggregate-set-metadata <aggregate> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
更新与聚合关联的元数据。

positional 参数

<aggregate>
要更新的聚合名称或 ID。
<key=value>
为聚合添加/更新的元数据。仅指定删除元数据项目的键。

6.16. nova aggregate-update

usage: nova aggregate-update <aggregate> <name> [<availability-zone>]
Copy to Clipboard Toggle word wrap
更新聚合的名称和可选可用性区域。

positional 参数

<aggregate>
要更新的聚合名称或 ID。
<name>
聚合的名称。
<availability-zone>
聚合的可用区。

6.17. nova availability-zone-list

usage: nova availability-zone-list
Copy to Clipboard Toggle word wrap
列出所有可用区。

6.18. Nova 备份

usage: nova backup <server> <name> <backup-type> <rotation>
Copy to Clipboard Toggle word wrap
通过创建 'backup' 类型快照来备份服务器。

positional 参数

<server>
服务器的名称或 ID。
<name>
备份镜像的名称。
<backup-type>
备份类型,如 "daily" 或 "weekly"。
<rotation>
int 参数代表要保留多少个备份。

6.19. nova baremetal-interface-add

usage: nova baremetal-interface-add [--datapath_id <datapath_id>] [--port_no <port_no>] <node> <address>
Copy to Clipboard Toggle word wrap
将网络接口添加到裸机节点。

positional 参数

<node>
节点 ID
<address>
接口的 MAC 地址

可选参数

--datapath_id <datapath_id>
OpenFlow 数据路径 ID 的接口
--port_no <port_no>
OpenFlow 端口号

6.20. nova baremetal-interface-list

usage: nova baremetal-interface-list <node>
Copy to Clipboard Toggle word wrap
列出与裸机节点关联的网络接口。

positional 参数

<node>
节点 ID

6.21. nova baremetal-interface-remove

usage: nova baremetal-interface-remove <node> <address>
Copy to Clipboard Toggle word wrap
从裸机节点删除网络接口。

positional 参数

<node>
节点 ID
<address>
接口的 MAC 地址

6.22. nova baremetal-node-create

usage: nova baremetal-node-create [--pm_address <pm_address>] [--pm_user <pm_user>] [--pm_password <pm_password>] [--terminal_port <terminal_port>] <service_host> <cpus> <memory_mb> <local_gb> <prov_mac_address>
Copy to Clipboard Toggle word wrap
创建裸机节点。

positional 参数

<service_host>
将控制此裸机节点的 nova 计算主机的名称
<cpus>
节点上的 CPU 数量
<memory_mb>
节点中的 RAM 兆字节
<local_gb>
节点中的本地存储 GB
<prov_mac_address>
用于置备节点的 MAC 地址

可选参数

--pm_address <pm_address>
节点的电源管理 IP
--pm_user <pm_user>
节点的电源管理的用户名
--pm_password <pm_password>
节点的电源管理密码
--terminal_port <terminal_port>
ShellInABox port?

6.23. nova baremetal-node-delete

usage: nova baremetal-node-delete <node>
Copy to Clipboard Toggle word wrap
删除裸机节点以及任何关联的接口。

positional 参数

<node>
要删除的节点的 ID。

6.24. nova baremetal-node-list

usage: nova baremetal-node-list
Copy to Clipboard Toggle word wrap
打印可用裸机节点列表。

6.25. nova baremetal-node-show

usage: nova baremetal-node-show <node>
Copy to Clipboard Toggle word wrap
显示有关裸机节点的信息。

positional 参数

<node>
节点 ID

6.26. Nova boot

usage: nova boot [--flavor <flavor>] [--image <image>] [--image-with <key=value>] [--boot-volume <volume_id>] [--snapshot <snapshot_id>] [--min-count <number>] [--max-count <number>] [--meta <key=value>] [--file <dst-path=src-path>] [--key-name <key-name>] [--user-data <user-data>] [--availability-zone <availability-zone>] [--security-groups <security-groups>] [--block-device-mapping <dev-name=mapping>] [--block-device key1=value1[,key2=value2...]] [--swap <swap_size>] [--ephemeral size=<size>[,format=<format>]] [--hint <key=value>] [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid>] [--config-drive <value>] [--poll] [--admin-pass <value>] <name>
Copy to Clipboard Toggle word wrap
引导新的服务器。

positional 参数

<name>
新服务器的名称

可选参数

--flavor <flavor>
类别的名称或 ID (请参见"nova flavor-list"。
--image <image>
镜像名称或 ID (请参阅 'nova image-list')。
--image-with <key=value>
镜像元数据属性(请参阅"nova image- show')。
--boot-volume <volume_id>
从中引导的卷 ID。
--snapshot <snapshot_id>
从中引导的快照 ID (将创建卷)。
--min-count <number>
至少引导 <number> 服务器(配额限制)。
--max-count <number>
引导至 <number> 服务器(配额限制)。
--meta <key=value>
将任意键/值元数据记录到元数据服务器的 /meta_data.json。可多次指定。
--file <dst-path=src-path>
将来自 <src-path> 的任意文件存储在本地的新服务器上 <dst-path>。被 injected_files 配额值的限制。
--key-name <key-name>
之前创建的密钥对密钥名称应该使用命令 keypair-add 创建
--user-data <user-data>
要传递给的用户数据文件,由元数据服务器公开。
--availability-zone <availability-zone>
服务器放置的可用区。
--security-groups <security-groups>
以逗号分隔的安全组名称列表。
--block-device-mapping <dev-name=mapping>
块设备映射,格式为 <dev- name>=<id>:<type>:<size (GB)>:<delete-on- terminate>。
--block-device
key1=value1[,key2=value2..] 带有键的块设备映射:id=UUID (image_id, snapshot_id, snapshot_id or volume_id using source image, snapshot or volume) source=source type (image, snapshot, volume or blank), dest=destination type of the block device (volume 或 local), bus=device's bus (e.g. uml, uml, lxc, virtio, ...;如果省略,虚拟机监控程序驱动程序只选择合适的默认值,仅当提供设备类型时,type=device 类型(例如,磁盘、cdrom、...;默认为 'disk') device=name of the device (e.vda, xda, ...; if omitted, hypervisor driver chooses suitable device depending on selected bus), size=size of the block device of the block device (for swap) and in GB (for other format) (如果省略,hypervisor driver calculates size), format=device will be formatted (如 swap, ntfs, ...; optional), bootindex=integer 用于排序引导磁盘(用于排序引导磁盘,其等于 0,其他需要指定)和 shutdown=shutdown。对于本地目标集为 remove。
--swap <swap_size>
创建并附加一个 <swap_size> MB 的本地交换块设备。
--ephemeral
size=<size>[,format=<format>] Create and attach a local ephemeral block device of <size> GB,并将其格式化为 <format>。
--hint <key=value>
将任意键/值对发送到调度程序以供自定义使用。
--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid>
在服务器上创建 NIC。指定创建多个 NIC 多次的选项。net- id: 将 NIC 附加到带有此 UUID 的 IPv6 固定地址(必须提供 port-id 或 net-id)、v4-fixed-ip: v6-fixed-ip: 用于 NIC 的 IPv6 固定地址(可选)、port-id 或 net-id 附加到端口(必需提供 port-id 或 net-id)。
--config-drive <value>
启用配置驱动器
--poll
报告新的服务器启动进度,直到它完成为止。
--admin-pass <value>
实例的 admin 密码

6.27. Nova cell-capacities

usage: nova cell-capacities [--cell <cell-name>]
Copy to Clipboard Toggle word wrap
获取所有单元格或给定单元的单元容量。

可选参数

--cell <cell-name>
获取容量的单元的名称。

6.28. nova cell-show

usage: nova cell-show <cell-name>
Copy to Clipboard Toggle word wrap
显示给定单元的详情。

positional 参数

<cell-name>
单元的名称。

6.29. nova clear-password

usage: nova clear-password <server>
Copy to Clipboard Toggle word wrap
清除服务器的 admin 密码。

positional 参数

<server>
服务器的名称或 ID。

6.30. nova cloudpipe-configure

usage: nova cloudpipe-configure <ip address> <port>
Copy to Clipboard Toggle word wrap
更新 cloudpipe 实例的 VPN IP/端口。

positional 参数

<IP address>
新 IP 地址.
<port>
新端口.

6.31. nova cloudpipe-create

usage: nova cloudpipe-create <project_id>
Copy to Clipboard Toggle word wrap
为给定项目创建一个 cloudpipe 实例。

positional 参数

<project_id>
要创建 cloudpipe 的项目的 UUID。

6.32. nova cloudpipe-list

usage: nova cloudpipe-list
Copy to Clipboard Toggle word wrap
打印所有 cloudpipe 实例的列表。

6.33. nova console-log

usage: nova console-log [--length <length>] <server>
Copy to Clipboard Toggle word wrap
获取服务器的控制台日志输出。

positional 参数

<server>
服务器的名称或 ID。

可选参数

--length <length>
单位为尾部的长度。

6.34. Nova 凭证

usage: nova credentials [--wrap <integer>]
Copy to Clipboard Toggle word wrap
显示从 auth 返回的用户凭证。

可选参数

--wrap <integer>
将 PKI 令牌嵌套到指定的长度,或 0 代表禁用

6.35. Nova delete

usage: nova delete [--all-tenants] <server> [<server> ...]
Copy to Clipboard Toggle word wrap
立即关闭并删除指定的服务器。

positional 参数

<server>
服务器的名称或 ID。

可选参数

--all-tenants
按名称(仅限管理员)删除另一个租户中的服务器。

6.36. Nova 诊断

usage: nova diagnostics <server>
Copy to Clipboard Toggle word wrap
检索服务器诊断。

positional 参数

<server>
服务器的名称或 ID。

6.37. nova dns-create

usage: nova dns-create [--type <type>] <ip> <name> <domain>
Copy to Clipboard Toggle word wrap
为域、名称和 IP 创建 DNS 条目。

positional 参数

<ip>
IP 地址
<name>
DNS 名称
<domain>
DNS 域

可选参数

--type <type>
DNS 类型(例如"A")

6.38. nova dns-create-private-domain

usage: nova dns-create-private-domain [--availability-zone <availability-zone>] <domain>
Copy to Clipboard Toggle word wrap
创建指定的 DNS 域。

positional 参数

<domain>
DNS 域

可选参数

--availability-zone <availability-zone>
将对此域的访问权限限制为指定可用区中的服务器。

6.39. nova dns-create-public-domain

usage: nova dns-create-public-domain [--project <project>] <domain>
Copy to Clipboard Toggle word wrap
创建指定的 DNS 域。

positional 参数

<domain>
DNS 域

可选参数

--project <project>
将对此域的访问权限限制为指定项目的用户。

6.40. nova dns-delete

usage: nova dns-delete <domain> <name>
Copy to Clipboard Toggle word wrap
删除指定的 DNS 条目。

positional 参数

<domain>
DNS 域
<name>
DNS 名称

6.41. nova dns-delete-domain

usage: nova dns-delete-domain <domain>
Copy to Clipboard Toggle word wrap
删除指定的 DNS 域。

positional 参数

<domain>
DNS 域

6.42. nova dns-domains

usage: nova dns-domains
Copy to Clipboard Toggle word wrap
显示可用 dns 域列表。

6.43. nova dns-list

usage: nova dns-list [--ip <ip>] [--name <name>] <domain>
Copy to Clipboard Toggle word wrap
列出域和 IP 或域名的当前 DNS 条目。

positional 参数

<domain>
DNS 域

可选参数

--ip <ip>
IP 地址
--name <name>
DNS 名称

6.44. Nova 端点

usage: nova endpoints
Copy to Clipboard Toggle word wrap
发现从验证服务返回的端点。

6.45. Nova evacuate

usage: nova evacuate [--password <password>] [--on-shared-storage] <server> [<host>]
Copy to Clipboard Toggle word wrap
从失败的主机撤离服务器.

positional 参数

<server>
服务器的名称或 ID。
<host>
目标主机的名称或 ID。如果没有指定主机,调度程序将选择一个。

可选参数

--password <password>
在撤离服务器上设置提供的 admin 密码。不适用于 on-shared-storage 标记
--on-shared-storage
指定服务器文件是否位于共享存储中

6.46. nova fixed-ip-get

usage: nova fixed-ip-get <fixed_ip>
Copy to Clipboard Toggle word wrap
在固定 IP 上检索信息。

positional 参数

<fixed_ip>
固定 IP 地址.

6.47. nova fixed-ip-reserve

usage: nova fixed-ip-reserve <fixed_ip>
Copy to Clipboard Toggle word wrap
保留固定 IP。

positional 参数

<fixed_ip>
固定 IP 地址.

6.48. nova fixed-ip-unreserve

usage: nova fixed-ip-unreserve <fixed_ip>
Copy to Clipboard Toggle word wrap
取消设置固定 IP。

positional 参数

<fixed_ip>
固定 IP 地址.

6.49. nova flavor-access-add

usage: nova flavor-access-add <flavor> <tenant_id>
Copy to Clipboard Toggle word wrap
为给定租户添加类别访问权限。

positional 参数

<flavor>
为给定租户添加访问权限的类别名称或 ID。
<tenant_id>
用于添加类别访问权限的租户 ID。

6.50. nova flavor-access-list

usage: nova flavor-access-list [--flavor <flavor>] [--tenant <tenant_id>]
Copy to Clipboard Toggle word wrap
输出有关给定类别的访问权限信息。

可选参数

--flavor <flavor>
根据类别名称或 ID 过滤结果。
--tenant <tenant_id>
根据租户 ID 过滤结果。

6.51. nova flavor-access-remove

usage: nova flavor-access-remove <flavor> <tenant_id>
Copy to Clipboard Toggle word wrap
移除给定租户的类别访问权限。

positional 参数

<flavor>
用于移除给定租户访问权限的类别名称或 ID。
<tenant_id>
用于移除类别访问权限的租户 ID。

6.52. nova flavor-create

usage: nova flavor-create [--ephemeral <ephemeral>] [--swap <swap>] [--rxtx-factor <factor>] [--is-public <is-public>] <name> <id> <ram> <disk> <vcpus>
Copy to Clipboard Toggle word wrap
创建新类别

positional 参数

<name>
新类别的名称
<id>
新类别的唯一 ID (整数或 UUID)。如果指定 'auto',则 UUID 将生成为 id
<ram>
以 MB 为单位的内存大小
<disk>
以 GB 为单位的磁盘大小
<vcpus>
vcpus 数量

可选参数

--ephemeral <ephemeral>
以 GB 为单位的临时空间大小(默认值 0)
--swap <swap>
以 MB 为单位的交换空间大小(默认值 0)
--rxtx-factor <factor>
RX/TX 因素(默认值 1)
--is-public <is-public>
使类别可供公共访问(默认为 true)

6.53. nova flavor-delete

usage: nova flavor-delete <flavor>
Copy to Clipboard Toggle word wrap
删除一个特定的类别

positional 参数

<flavor>
要删除的类别的名称或 ID

6.54. nova flavor-key

usage: nova flavor-key <flavor> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
为类别设置或取消设置 extra_spec。

positional 参数

<flavor>
类别的名称或 ID
<action>
actions: 'set' 或 'unset'
<key=value>
to set/unset 的 extra_specs (只在未设置时才需要密钥)

6.55. nova flavor-list

usage: nova flavor-list [--extra-specs] [--all]
Copy to Clipboard Toggle word wrap
显示可用"flavors"列表(服务器大小)。

可选参数

--extra-specs
获取每个类别的额外检查。
--all
显示所有类别(仅限管理员)。

6.56. nova flavor-show

usage: nova flavor-show <flavor>
Copy to Clipboard Toggle word wrap
显示给定类别的详细信息。

positional 参数

<flavor>
类别的名称或 ID

6.57. nova floating-ip-associate

usage: nova floating-ip-associate [--fixed-address <fixed_address>] <server> <address>
Copy to Clipboard Toggle word wrap
将浮动 IP 地址关联到服务器。

positional 参数

<server>
服务器的名称或 ID。
<address>
IP 地址.

可选参数

--fixed-address <fixed_address>
修复了要与之关联的 IP 地址。

6.58. nova floating-ip-bulk-create

usage: nova floating-ip-bulk-create [--pool <pool>] [--interface <interface>] <range>
Copy to Clipboard Toggle word wrap
批量根据范围创建浮动 IP (仅限nova-network)。

positional 参数

<range>
要创建的地址范围

可选参数

--pool <pool>
新浮动 IP 池
--interface <interface>
用于新浮动 IP 的接口

6.59. nova floating-ip-bulk-delete

usage: nova floating-ip-bulk-delete <range>
Copy to Clipboard Toggle word wrap
按范围(仅限nova-network)批量删除浮动 IP。

positional 参数

<range>
要删除的地址范围

6.60. nova floating-ip-bulk-list

usage: nova floating-ip-bulk-list [--host <host>]
Copy to Clipboard Toggle word wrap
列出所有浮动 IP (仅限nova-network)。

可选参数

--host <host>
按主机过滤

6.61. nova floating-ip-create

usage: nova floating-ip-create [<floating-ip-pool>]
Copy to Clipboard Toggle word wrap
为当前租户分配一个浮动 IP。

positional 参数

<floating-ip-pool>
浮动 IP 池的名称。(可选)

6.62. nova floating-ip-delete

usage: nova floating-ip-delete <address>
Copy to Clipboard Toggle word wrap
取消分配浮动 IP。

positional 参数

<address>
浮动 IP 地址。

6.63. nova floating-ip-disassociate

usage: nova floating-ip-disassociate <server> <address>
Copy to Clipboard Toggle word wrap
从服务器取消关联浮动 IP 地址。

positional 参数

<server>
服务器的名称或 ID。
<address>
IP 地址.

6.64. nova floating-ip-list

usage: nova floating-ip-list
Copy to Clipboard Toggle word wrap
列出浮动 IP。

6.65. nova floating-ip-pool-list

usage: nova floating-ip-pool-list
Copy to Clipboard Toggle word wrap
列出所有浮动 IP 池。

6.66. nova force-delete

usage: nova force-delete <server>
Copy to Clipboard Toggle word wrap
强制删除服务器。

positional 参数

<server>
服务器的名称或 ID。

6.67. nova get-password

usage: nova get-password <server> [<private-key>]
Copy to Clipboard Toggle word wrap
获取服务器的 admin 密码。

positional 参数

<server>
服务器的名称或 ID。
<private-key>
私钥(用于本地解密密码)(可选)。指定后,命令会显示明文(解密)虚拟机密码。如果没有指定,则会显示密码的虚拟机密码。

6.68. nova get-rdp-console

usage: nova get-rdp-console <server> <console-type>
Copy to Clipboard Toggle word wrap
向服务器获取 rdp 控制台。

positional 参数

<server>
服务器的名称或 ID。
<console-type>
rdp 控制台的类型("rdp-html5")。

6.69. nova get-serial-console

usage: nova get-serial-console [--console_type CONSOLE_TYPE] <server>
Copy to Clipboard Toggle word wrap
获取到服务器的串行控制台。

positional 参数

<server>
服务器的名称或 ID。

可选参数

--console_type CONSOLE_TYPE
串行控制台的类型,默认为="serial"。

6.70. nova get-spice-console

usage: nova get-spice-console <server> <console-type>
Copy to Clipboard Toggle word wrap
向服务器获取 spice 控制台。

positional 参数

<server>
服务器的名称或 ID。
<console-type>
spice 控制台类型("spice-html5")。

6.71. nova get-vnc-console

usage: nova get-vnc-console <server> <console-type>
Copy to Clipboard Toggle word wrap
获取到服务器的 vnc 控制台。

positional 参数

<server>
服务器的名称或 ID。
<console-type>
vnc 控制台的类型("novnc"或"xvpvnc").

6.72. nova host-action

usage: nova host-action [--action <action>] <hostname>
Copy to Clipboard Toggle word wrap
对主机执行电源操作。

positional 参数

<hostname>
主机的名称。

可选参数

--action <action>
电源操作:启动、重启或关闭。

6.73. nova host-describe

usage: nova host-describe <hostname>
Copy to Clipboard Toggle word wrap
描述特定主机。

positional 参数

<hostname>
主机的名称。

6.74. nova host-evacuate

usage: nova host-evacuate [--target_host <target_host>] [--on-shared-storage] <host>
Copy to Clipboard Toggle word wrap
从失败的主机中撤离所有实例。

positional 参数

<host>
主机的名称。

可选参数

--target_host <target_host>
目标主机的名称。如果没有指定主机,调度程序将选择一个目标。
--on-shared-storage
指定所有实例文件是否在共享存储中

6.75. nova host-evacuate-live

usage: nova host-evacuate-live [--target-host <target_host>] [--block-migrate] [--disk-over-commit] [--max-servers <max_servers>] <host>
Copy to Clipboard Toggle word wrap
将指定主机的所有实例实时迁移到其他可用的主机上。

positional 参数

<host>
主机的名称。

可选参数

--target-host <target_host>
目标主机的名称。
--block-migrate
启用块迁移。
--disk-over-commit
启用磁盘过量使用。
--max-servers <max_servers>
同时迁移的最大服务器数量

6.76. nova host-list

usage: nova host-list [--zone <zone>]
Copy to Clipboard Toggle word wrap
按服务列出所有主机。

可选参数

--zone <zone>
过滤列表,仅返回可用区 <zone> 中的那些主机。

6.77. nova host-meta

usage: nova host-meta <host> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
在主机的所有实例上设置或删除元数据。

positional 参数

<host>
主机的名称。
<action>
actions: 'set' 或 'delete'
<key=value>
设置或删除元数据(删除时仅需要密钥)

6.78. nova host-servers-migrate

usage: nova host-servers-migrate <host>
Copy to Clipboard Toggle word wrap
将指定主机的所有实例迁移到其他可用主机。

positional 参数

<host>
主机的名称。

6.79. nova host-update

usage: nova host-update [--status <enable|disable>] [--maintenance <enable|disable>] <hostname>
Copy to Clipboard Toggle word wrap
更新主机设置。

positional 参数

<hostname>
主机的名称。

可选参数

--status <enable|disable>
启用或禁用主机。
--maintenance <enable|disable>
将主机移入/从维护中恢复。

6.80. nova hypervisor-list

usage: nova hypervisor-list [--matching <hostname>]
Copy to Clipboard Toggle word wrap
列出虚拟机监控程序。

可选参数

--matching <hostname>
列出与给定 <hostname> 匹配的 hypervisor。

6.81. nova hypervisor-servers

usage: nova hypervisor-servers <hostname>
Copy to Clipboard Toggle word wrap
列出属于特定虚拟机监控程序的服务器。

positional 参数

<hostname>
要搜索的虚拟机监控程序主机名(或模式)。

6.82. nova hypervisor-show

usage: nova hypervisor-show [--wrap <integer>] <hypervisor>
Copy to Clipboard Toggle word wrap
显示指定虚拟机监控程序的详细信息。

positional 参数

<hypervisor>
用于显示详细信息的管理程序名称或 ID。

可选参数

--wrap <integer>
将输出嵌套到指定的长度。默认值为 40 或 0 来禁用

6.83. nova hypervisor-stats

usage: nova hypervisor-stats
Copy to Clipboard Toggle word wrap
获取所有计算节点的虚拟机监控程序统计信息。
警告
在将 Red Hat Ceph 用作临时存储的后端时,计算服务不会正确计算可用存储量。具体来说,计算只是添加可用存储量,而不需要复制。这会导致过度使用的存储,这会导致意外的存储超额订阅。
要确定正确的临时存储容量,请直接查询 Ceph 服务。如需更多信息,请参阅 BZ resources36473

6.84. nova hypervisor-uptime

usage: nova hypervisor-uptime <hypervisor>
Copy to Clipboard Toggle word wrap
显示指定 hypervisor 的正常运行时间。

positional 参数

<hypervisor>
hypervisor 的名称或 ID 以显示正常运行时间。

6.85. nova image-create

usage: nova image-create [--show] [--poll] <server> <name>
Copy to Clipboard Toggle word wrap
通过对正在运行的服务器执行快照来创建新镜像。

positional 参数

<server>
服务器的名称或 ID。
<name>
快照的名称。

可选参数

--show
打印图像信息.
--poll
报告快照进度并轮询到镜像创建完成为止。

6.86. nova image-delete

usage: nova image-delete <image> [<image> ...]
Copy to Clipboard Toggle word wrap
删除指定的镜像。

positional 参数

<image>
镜像的名称或 ID。

6.87. nova image-list

usage: nova image-list [--limit <limit>]
Copy to Clipboard Toggle word wrap
输出要从中引导的可用镜像列表。

可选参数

--limit <limit>
每个请求返回的镜像数。

6.88. nova image-meta

usage: nova image-meta <image> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
在镜像上设置或删除元数据。

positional 参数

<image>
镜像的名称或 ID
<action>
actions: 'set' 或 'delete'
<key=value>
添加/更新或删除元数据(删除时仅需要密钥)

6.89. nova image-show

usage: nova image-show <image>
Copy to Clipboard Toggle word wrap
显示给定镜像的详细信息。

positional 参数

<image>
镜像的名称或 ID

6.90. nova instance-action

usage: nova instance-action <server> <request_id>
Copy to Clipboard Toggle word wrap
显示操作。

positional 参数

<server>
要显示某个操作的服务器的名称或 UUID。
<request_id>
要获得的操作的请求 ID。

6.91. nova instance-action-list

usage: nova instance-action-list <server>
Copy to Clipboard Toggle word wrap
列出服务器上的操作。

positional 参数

<server>
用于列出操作的服务器的名称或 UUID。

6.92. nova interface-attach

usage: nova interface-attach [--port-id <port_id>] [--net-id <net_id>] [--fixed-ip <fixed_ip>] <server>
Copy to Clipboard Toggle word wrap
将网络接口连接到服务器。

positional 参数

<server>
服务器的名称或 ID。

可选参数

--port-id <port_id>
端口 ID.
--net-id <net_id>
网络 ID
--fixed-ip <fixed_ip>
请求固定的 IP。

6.93. nova interface-detach

usage: nova interface-detach <server> <port_id>
Copy to Clipboard Toggle word wrap
从服务器分离网络接口。

positional 参数

<server>
服务器的名称或 ID。
<port_id>
端口 ID.

6.94. nova interface-list

usage: nova interface-list <server>
Copy to Clipboard Toggle word wrap
列出连接到服务器的接口。

positional 参数

<server>
服务器的名称或 ID。

6.95. nova keypair-add

usage: nova keypair-add [--pub-key <pub-key>] [--key-type <key-type>] <name>
Copy to Clipboard Toggle word wrap
创建用于服务器的新密钥对。

positional 参数

<name>
键的名称。

可选参数

--pub-key <pub-key>
到公共 ssh 密钥的路径。
--key-type <key-type>
密钥对类型。可以是 ssh 或 x509.(API 版本 '2.2' - '2.latest' 支持)

6.96. nova keypair-delete

usage: nova keypair-delete <name>
Copy to Clipboard Toggle word wrap
删除其名称提供的密钥对。

positional 参数

<name>
要删除的密钥对名称。

6.97. nova keypair-list

usage: nova keypair-list
Copy to Clipboard Toggle word wrap
为用户打印密钥对列表

6.98. nova keypair-show

usage: nova keypair-show <keypair>
Copy to Clipboard Toggle word wrap
显示给定密钥对的详细信息。

positional 参数

<keypair>
密钥对的名称。

6.99. Nova 限制

usage: nova limits [--tenant [<tenant>]] [--reserved]
Copy to Clipboard Toggle word wrap
打印速率和绝对限制。

可选参数

--tenant [<tenant>]
显示来自单个租户的信息(仅限管理员)。
--reserved
包括保留计数。

6.100. Nova 列表

usage: nova list [--reservation-id <reservation-id>] [--ip <ip-regexp>] [--ip6 <ip6-regexp>] [--name <name-regexp>] [--instance-name <name-regexp>] [--status <status>] [--flavor <flavor>] [--image <image>] [--host <hostname>] [--all-tenants [<0|1>]] [--tenant [<tenant>]] [--user [<user>]] [--deleted] [--fields <fields>] [--minimal] [--sort <key>[:<direction>]] [--marker <marker>] [--limit <limit>]
Copy to Clipboard Toggle word wrap
列出活动服务器。

可选参数

--reservation-id <reservation-id>
仅返回与 reservation-id 匹配的服务器。
--ip <ip-regexp>
按照 IP 地址搜索正则表达式匹配。
--ip6 <ip6-regexp>
按照 IPv6 地址搜索正则表达式匹配。
--name <name-regexp>
按名称带有正则表达式匹配搜索
--instance-name <name-regexp>
按照服务器名称搜索正则表达式匹配。
--status <status>
根据服务器状态搜索
--flavor <flavor>
根据类别名称或 ID 搜索
--image <image>
根据镜像名称或 ID 搜索
--host <hostname>
按主机名搜索服务器(仅限管理员)。
--all-tenants [<0|1>]
显示所有租户的信息(仅限管理员)。
--tenant [<tenant>]
显示来自单个租户的信息(仅限管理员)。
--user [<user>]
显示单个用户的信息(仅限管理员)。
--deleted
仅显示已删除的服务器(仅限管理员)。
--fields <fields>
要显示的字段的逗号分隔列表。使用 show 命令查看哪些字段可用。
--minimal
仅获取 uuid 和 name。
--sort <key>[:<direction>]
以逗号分隔的排序键和方向列表,格式为 <key>[:<asc|desc>]。如果没有指定,方向默认为降序。
--marker <marker>
上一页的最后一个 server uuid;显示"marker"后的服务器列表。
--limit <limit>
要显示的最大服务器数。如果限制 == -1,则会显示所有服务器。如果限制大于 Nova API 的 'osapi_max_limit' 选项,则将改为使用限制 'osapi_max_limit'。

6.101. nova list-extensions

usage: nova list-extensions
Copy to Clipboard Toggle word wrap
列出所有可用的 os-api 扩展。

6.102. nova list-secgroup

usage: nova list-secgroup <server>
Copy to Clipboard Toggle word wrap
列出服务器的安全组。

positional 参数

<server>
服务器的名称或 ID。

6.103. Nova 实时迁移

usage: nova live-migration [--block-migrate] [--disk-over-commit] <server> [<host>]
Copy to Clipboard Toggle word wrap
将正在运行的服务器迁移到新计算机。

positional 参数

<server>
服务器的名称或 ID。
<host>
目标主机名。

可选参数

--block-migrate
block_migration 时为 true。(默认值=False:live_migration)
--disk-over-commit
允许过量使用。(Default=False)

6.104. nova lock

usage: nova lock <server>
Copy to Clipboard Toggle word wrap
锁定服务器。普通的(非 admin)用户将无法对锁定的服务器执行操作。

positional 参数

<server>
服务器的名称或 ID。

6.105. Nova meta

usage: nova meta <server> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
在服务器上设置或删除元数据。

positional 参数

<server>
服务器的名称或 ID
<action>
actions: 'set' 或 'delete'
<key=value>
设置或删除元数据(删除时仅需要密钥)

6.106. Nova 迁移

usage: nova migrate [--poll] <server>
Copy to Clipboard Toggle word wrap
迁移服务器。新主机将由调度程序选择。

positional 参数

<server>
服务器的名称或 ID。

可选参数

--poll
报告服务器迁移进度,直到它完成为止。

6.107. nova migration-list

usage: nova migration-list [--host <host>] [--status <status>] [--cell_name <cell_name>]
Copy to Clipboard Toggle word wrap
打印迁移列表。

可选参数

--host <host>
获取给定主机的迁移。
--status <status>
获取给定状态的迁移。
--cell_name <cell_name>
获取给定 cell_name 的迁移。

6.108. nova network-associate-host

usage: nova network-associate-host <network> <host>
Copy to Clipboard Toggle word wrap
将主机与网络关联。

positional 参数

<network>
网络的 UUID
<host>
主机的名称

6.109. nova network-associate-project

usage: nova network-associate-project <network>
Copy to Clipboard Toggle word wrap
将项目与网络关联。

positional 参数

<network>
网络的 UUID

6.110. nova network-create

usage: nova network-create [--fixed-range-v4 <x.x.x.x/yy>] [--fixed-range-v6 CIDR_V6] [--vlan <vlan id>] [--vlan-start <vlan start>] [--vpn <vpn start>] [--gateway GATEWAY] [--gateway-v6 GATEWAY_V6] [--bridge <bridge>] [--bridge-interface <bridge interface>] [--multi-host <'T'|'F'>] [--dns1 <DNS Address>] [--dns2 <DNS Address>] [--uuid <network uuid>] [--fixed-cidr <x.x.x.x/yy>] [--project-id <project id>] [--priority <number>] [--mtu MTU] [--enable-dhcp <'T'|'F'>] [--dhcp-server DHCP_SERVER] [--share-address <'T'|'F'>] [--allowed-start ALLOWED_START] [--allowed-end ALLOWED_END] <network_label>
Copy to Clipboard Toggle word wrap
创建网络。

positional 参数

<network_label>
网络的标签

可选参数

--fixed-range-v4 <x.x.x.x/yy>
IPv4 子网(ex: 10.0.0.0/8)
--fixed-range-v6
CIDR_V6 IPv6 子网(例如:fe80::/64)
--vlan <vlan id>
要分配给项目的 vlan ID。
--VLAN-start <vlan start>
要分配给该项目的第一个 vlan ID。后续 vlan ID 将以递增方式分配。
--vpn <vpn start>
VPN 启动
--gateway GATEWAY
gateway
--gateway-v6
GATEWAY_V6 IPv6 网关
--bridge <bridge>
此网络上的 VIFs 连接到此网桥。
--bridge-interface <bridge interface>
网桥连接到此接口。
--multi-host <'T'|'F'>
多主机
--dns1 <DNS Address>
第一个 DNS
--dns2 <DNS Address>
第二个 DNS
--UUID <network uuid>
网络 UUID
--fixed-cidr <x.x.x.x/yy>
固定 IP 的 IPv4 子网(例如: 10.20.0.0/16)
--project-id <project id>
项目 ID
--priority <number>
网络接口优先级
--mtu MTU
网络 MTU
--enable-dhcp <'T'|'F'>
启用 dhcp
--dhcp-server DHCP_SERVER
dhcp-server (默认为网关地址)
--share-address <'T'|'F'>
共享地址
--allowed-start ALLOWED_START
实例允许的地址开始
--allowed-end ALLOWED_END
实例允许的地址结束

6.111. nova network-delete

usage: nova network-delete <network>
Copy to Clipboard Toggle word wrap
通过标签或 id 删除网络。

positional 参数

<network>
网络的 UUID 或标签

6.112. nova network-disassociate

usage: nova network-disassociate [--host-only [<0|1>]] [--project-only [<0|1>]] <network>
Copy to Clipboard Toggle word wrap
从给定网络中解除关联主机和/或项目。

positional 参数

<network>
网络的 UUID

可选参数

--host-only [<0|1>]
--project-only [<0|1>]

6.113. nova network-list

usage: nova network-list [--fields <fields>]
Copy to Clipboard Toggle word wrap
显示可用网络列表。

可选参数

--fields <fields>
要显示的字段的逗号分隔列表。使用 show 命令查看哪些字段可用。

6.114. nova network-show

usage: nova network-show <network>
Copy to Clipboard Toggle word wrap
显示给定网络的详细信息。

positional 参数

<network>
网络的 UUID 或标签

6.115. Nova pause

usage: nova pause <server>
Copy to Clipboard Toggle word wrap
暂停服务器。

positional 参数

<server>
服务器的名称或 ID。

6.116. nova quota-class-show

usage: nova quota-class-show <class>
Copy to Clipboard Toggle word wrap
列出配额类的配额。

positional 参数

<class>
列出配额的配额类的名称。

6.117. nova quota-class-update

usage: nova quota-class-update [--instances <instances>] [--cores <cores>] [--ram <ram>] [--floating-ips <floating-ips>] [--fixed-ips <fixed-ips>] [--metadata-items <metadata-items>] [--injected-files <injected-files>] [--injected-file-content-bytes <injected-file-content-bytes>] [--injected-file-path-bytes <injected-file-path-bytes>] [--key-pairs <key-pairs>] [--security-groups <security-groups>] [--security-group-rules <security-group-rules>] [--server-groups <server-groups>] [--server-group-members <server-group-members>] <class>
Copy to Clipboard Toggle word wrap
更新配额类的配额。

positional 参数

<class>
设置配额的配额类的名称。

可选参数

--instances <instances>
"instances"配额的新值。
--cores <cores>
"cores" 配额的新值。
--ram <ram>
"ram" 配额的新值。
--floating-ips <floating-ips>
"floating-ips"配额的新值。
--fixed-ips <fixed-ips>
"fixed-ips" 配额的新值。
--metadata-items <metadata-items>
"metadata-items"配额的新值。
--injected-files <injected-files>
"injected-files" 配额的新值。
--injected-file-content-bytes <injected-file-content-bytes>
"injected-file-content- bytes" 配额的新值。
--injected-file-path-bytes <injected-file-path-bytes>
"injected-file-path-bytes" 配额的新值。
--key-pairs <key-pairs>
"key-pairs"配额的新值。
--security-groups <security-groups>
"security-groups"配额的新值。
--security-group-rules <security-group-rules>
"security-group-rules" 配额的新值。
--server-groups <server-groups>
"server-groups" 配额的新值。
--server-group-members <server-group-members>
"server-group-members" 配额的新值。

6.118. nova quota-defaults

usage: nova quota-defaults [--tenant <tenant-id>]
Copy to Clipboard Toggle word wrap
列出租户的默认配额。

可选参数

--tenant <tenant-id>
用于列出默认配额的租户 ID。

6.119. nova quota-delete

usage: nova quota-delete --tenant <tenant-id> [--user <user-id>]
Copy to Clipboard Toggle word wrap
删除租户/用户的配额,以使其配额将恢复为默认状态。

可选参数

--tenant <tenant-id>
用于删除配额的租户 ID。
--user <user-id>
删除配额的用户 ID。

6.120. nova quota-show

usage: nova quota-show [--tenant <tenant-id>] [--user <user-id>]
Copy to Clipboard Toggle word wrap
列出租户/用户的配额。

可选参数

--tenant <tenant-id>
列出配额的租户 ID。
--user <user-id>
列出配额的用户 ID。

6.121. nova quota-update

usage: nova quota-update [--user <user-id>] [--instances <instances>] [--cores <cores>] [--ram <ram>] [--floating-ips <floating-ips>] [--fixed-ips <fixed-ips>] [--metadata-items <metadata-items>] [--injected-files <injected-files>] [--injected-file-content-bytes <injected-file-content-bytes>] [--injected-file-path-bytes <injected-file-path-bytes>] [--key-pairs <key-pairs>] [--security-groups <security-groups>] [--security-group-rules <security-group-rules>] [--server-groups <server-groups>] [--server-group-members <server-group-members>] [--force] <tenant-id>
Copy to Clipboard Toggle word wrap
更新租户/用户的配额。

positional 参数

<tenant-id>
设置配额的租户 ID。

可选参数

--user <user-id>
设置配额的用户 ID。
--instances <instances>
"instances"配额的新值。
--cores <cores>
"cores" 配额的新值。
--ram <ram>
"ram" 配额的新值。
--floating-ips <floating-ips>
"floating-ips"配额的新值。
--fixed-ips <fixed-ips>
"fixed-ips" 配额的新值。
--metadata-items <metadata-items>
"metadata-items"配额的新值。
--injected-files <injected-files>
"injected-files" 配额的新值。
--injected-file-content-bytes <injected-file-content-bytes>
"injected-file-content- bytes" 配额的新值。
--injected-file-path-bytes <injected-file-path-bytes>
"injected-file-path-bytes" 配额的新值。
--key-pairs <key-pairs>
"key-pairs"配额的新值。
--security-groups <security-groups>
"security-groups"配额的新值。
--security-group-rules <security-group-rules>
"security-group-rules" 配额的新值。
--server-groups <server-groups>
"server-groups" 配额的新值。
--server-group-members <server-group-members>
"server-group-members" 配额的新值。
--force
即使已经使用和保留超过新配额,是否强制更新配额

6.122. nova reboot

usage: nova reboot [--hard] [--poll] <server> [<server> ...]
Copy to Clipboard Toggle word wrap
重启服务器。

positional 参数

<server>
服务器的名称或 ID。

可选参数

--hard
执行硬重启(而不是软重启)。
--poll
轮询直到重新引导完成。

6.123. Nova 重建

usage: nova rebuild [--rebuild-password <rebuild-password>] [--poll] [--minimal] [--preserve-ephemeral] [--name <name>] [--meta <key=value>] [--file <dst-path=src-path>] <server> <image>
Copy to Clipboard Toggle word wrap
关闭、重新镜像并重新引导服务器。

positional 参数

<server>
服务器的名称或 ID。
<image>
新镜像的名称或 ID。

可选参数

--rebuild-password <rebuild-password>
在重新构建服务器上设置提供的 admin 密码。
--poll
报告服务器重建进度,直到它完成为止。
--minimal
显示服务器时跳过类别/镜像查找
--preserve-ephemeral
在重建时保留默认的临时存储分区。
--name <name>
新服务器的名称
--meta <key=value>
将任意键/值元数据记录到元数据服务器的 /meta_data.json。可多次指定。
--file <dst-path=src-path>
将来自 <src-path> 的任意文件存储在本地的新服务器上 <dst-path>。您可以存储最多 5 个文件。

6.124. nova refresh-network

usage: nova refresh-network <server>
Copy to Clipboard Toggle word wrap
刷新服务器网络信息。

positional 参数

<server>
应该从 neutron 刷新网络缓存的服务器的名称或 ID (仅限管理员)。

6.125. nova remove-fixed-ip

usage: nova remove-fixed-ip <server> <address>
Copy to Clipboard Toggle word wrap
从服务器中删除 IP 地址。

positional 参数

<server>
服务器的名称或 ID。
<address>
IP 地址.

6.126. nova remove-secgroup

usage: nova remove-secgroup <server> <secgroup>
Copy to Clipboard Toggle word wrap
从服务器移除安全组。

positional 参数

<server>
服务器的名称或 ID。
<secgroup>
安全组的名称。

6.127. Nova rename

usage: nova rename <server> <name>
Copy to Clipboard Toggle word wrap
重命名服务器。

positional 参数

<server>
服务器的名称(旧名称)或 ID。
<name>
服务器的新名称。

6.128. nova rescue

usage: nova rescue [--password <password>] [--image <image>] <server>
Copy to Clipboard Toggle word wrap
将服务器重新启动进入救援模式,该模式从初始镜像或指定镜像启动计算机,并将当前引导磁盘作为辅助功能附加。

positional 参数

<server>
服务器的名称或 ID。

可选参数

--password <password>
要在救援环境中设置的 admin 密码。
--image <image>
要使用以下内容进行救援的镜像。

6.129. nova reset-network

usage: nova reset-network <server>
Copy to Clipboard Toggle word wrap
重置服务器网络。

positional 参数

<server>
服务器的名称或 ID。

6.130. nova reset-state

usage: nova reset-state [--active] <server> [<server> ...]
Copy to Clipboard Toggle word wrap
重置服务器的状态。

positional 参数

<server>
服务器的名称或 ID。

可选参数

--active
请求服务器重置为"主动"状态,而不是"错误"状态(默认)。

6.131. Nova 调整大小

usage: nova resize [--poll] <server> <flavor>
Copy to Clipboard Toggle word wrap
调整服务器大小。

positional 参数

<server>
服务器的名称或 ID。
<flavor>
新类别的名称或 ID。

可选参数

--poll
报告服务器调整大小的进度,直到完成为止。

6.132. nova resize-confirm

usage: nova resize-confirm <server>
Copy to Clipboard Toggle word wrap
确认上调整大小。

positional 参数

<server>
服务器的名称或 ID。

6.133. nova resize-revert

usage: nova resize-revert <server>
Copy to Clipboard Toggle word wrap
恢复之前的大小(并返回到以前的虚拟机)。

positional 参数

<server>
服务器的名称或 ID。

6.134. Nova 恢复

usage: nova restore <server>
Copy to Clipboard Toggle word wrap
恢复软删除服务器。

positional 参数

<server>
服务器的名称或 ID。

6.135. Nova 恢复

usage: nova resume <server>
Copy to Clipboard Toggle word wrap
恢复服务器。

positional 参数

<server>
服务器的名称或 ID。

6.136. Nova scrub

usage: nova scrub <project_id>
Copy to Clipboard Toggle word wrap
删除与项目关联的网络和安全组。

positional 参数

<project_id>
项目的 ID。

6.137. nova secgroup-add-default-rule

usage: nova secgroup-add-default-rule <ip-proto> <from-port> <to-port> <cidr>
Copy to Clipboard Toggle word wrap
向规则中添加一条规则,该规则将添加到新租户的"默认"安全组中(仅限nova-network)。

positional 参数

<ip-proto>
IP 协议(icmp、tcp、udp)。
<from-port>
端口范围开头.
<to-port>
端口在范围的末尾。
<cidr>
地址范围的 CIDR。

6.138. nova secgroup-add-group-rule

usage: nova secgroup-add-group-rule <secgroup> <source-group> <ip-proto> <from-port> <to-port>
Copy to Clipboard Toggle word wrap
向安全组添加源组规则。

positional 参数

<secgroup>
ID 或安全组的名称。
<source-group>
源组的 ID 或名称。
<ip-proto>
IP 协议(icmp、tcp、udp)。
<from-port>
端口范围开头.
<to-port>
端口在范围的末尾。

6.139. nova secgroup-add-rule

usage: nova secgroup-add-rule <secgroup> <ip-proto> <from-port> <to-port> <cidr>
Copy to Clipboard Toggle word wrap
向安全组添加规则。

positional 参数

<secgroup>
ID 或安全组的名称。
<ip-proto>
IP 协议(icmp、tcp、udp)。
<from-port>
端口范围开头.
<to-port>
端口在范围的末尾。
<cidr>
地址范围的 CIDR。

6.140. nova secgroup-create

usage: nova secgroup-create <name> <description>
Copy to Clipboard Toggle word wrap
创建安全组。

positional 参数

<name>
安全组的名称。
<description>
安全组的描述。

6.141. nova secgroup-delete

usage: nova secgroup-delete <secgroup>
Copy to Clipboard Toggle word wrap
删除安全组。

positional 参数

<secgroup>
ID 或安全组的名称。

6.142. nova secgroup-delete-default-rule

usage: nova secgroup-delete-default-rule <ip-proto> <from-port> <to-port> <cidr>
Copy to Clipboard Toggle word wrap
从一组规则中删除一条规则,该规则将添加到新租户的"默认"安全组中(仅限nova-network)。

positional 参数

<ip-proto>
IP 协议(icmp、tcp、udp)。
<from-port>
端口范围开头.
<to-port>
端口在范围的末尾。
<cidr>
地址范围的 CIDR。

6.143. nova secgroup-delete-group-rule

usage: nova secgroup-delete-group-rule <secgroup> <source-group> <ip-proto> <from-port> <to-port>
Copy to Clipboard Toggle word wrap
从安全组中删除源组规则。

positional 参数

<secgroup>
ID 或安全组的名称。
<source-group>
源组的 ID 或名称。
<ip-proto>
IP 协议(icmp、tcp、udp)。
<from-port>
端口范围开头.
<to-port>
端口在范围的末尾。

6.144. nova secgroup-delete-rule

usage: nova secgroup-delete-rule <secgroup> <ip-proto> <from-port> <to-port> <cidr>
Copy to Clipboard Toggle word wrap
从安全组中删除规则。

positional 参数

<secgroup>
ID 或安全组的名称。
<ip-proto>
IP 协议(icmp、tcp、udp)。
<from-port>
端口范围开头.
<to-port>
端口在范围的末尾。
<cidr>
地址范围的 CIDR。

6.145. nova secgroup-list

usage: nova secgroup-list [--all-tenants [<0|1>]]
Copy to Clipboard Toggle word wrap
列出当前租户的安全组。

可选参数

--all-tenants [<0|1>]
显示所有租户的信息(仅限管理员)。

6.146. nova secgroup-list-default-rules

usage: nova secgroup-list-default-rules
Copy to Clipboard Toggle word wrap
列出将添加到新租户的"默认"安全组中的规则。

6.147. nova secgroup-list-rules

usage: nova secgroup-list-rules <secgroup>
Copy to Clipboard Toggle word wrap
列出安全组的规则。

positional 参数

<secgroup>
ID 或安全组的名称。

6.148. nova secgroup-update

usage: nova secgroup-update <secgroup> <name> <description>
Copy to Clipboard Toggle word wrap
更新安全组。

positional 参数

<secgroup>
ID 或安全组的名称。
<name>
安全组的名称。
<description>
安全组的描述。

6.149. nova server-group-create

usage: nova server-group-create <name> [<policy> [<policy> ...]]
Copy to Clipboard Toggle word wrap
使用指定详情创建新服务器组。

positional 参数

<name>
服务器组名称。
<policy>
服务器组("关联性"或"反关联性")的策略

6.150. nova server-group-delete

usage: nova server-group-delete <id> [<id> ...]
Copy to Clipboard Toggle word wrap
删除特定的服务器组。

positional 参数

<id>
要删除的服务器组的唯一 ID

6.151. nova server-group-get

usage: nova server-group-get <id>
Copy to Clipboard Toggle word wrap
获取特定的服务器组。

positional 参数

<id>
要获取的服务器组的唯一 ID

6.152. nova server-group-list

usage: nova server-group-list [--all-projects]
Copy to Clipboard Toggle word wrap
打印所有服务器组的列表。

可选参数

--all-projects
显示所有项目中的服务器组(仅限管理员)。

6.153. nova service-delete

usage: nova service-delete <id>
Copy to Clipboard Toggle word wrap
删除该服务。

positional 参数

<id>
服务 ID。

6.154. nova service-disable

usage: nova service-disable [--reason <reason>] <hostname> <binary>
Copy to Clipboard Toggle word wrap
禁用服务。

positional 参数

<hostname>
主机的名称。
<binary>
服务二进制文件。

可选参数

--reason <reason>
禁用服务的原因。

6.155. nova service-enable

usage: nova service-enable <hostname> <binary>
Copy to Clipboard Toggle word wrap
启用服务。

positional 参数

<hostname>
主机的名称。
<binary>
服务二进制文件。

6.156. nova service-force-down

usage: nova service-force-down [--unset] <hostname> <binary>
Copy to Clipboard Toggle word wrap
强制服务停机。(API 版本 '2.11' - '2.latest' 支持)

positional 参数

<hostname>
主机的名称。
<binary>
服务二进制文件。

可选参数

--unset
取消设置服务的强制状态下线

6.157. nova service-list

usage: nova service-list [--host <hostname>] [--binary <binary>]
Copy to Clipboard Toggle word wrap
显示所有正在运行的服务的列表。按主机和二进制文件过滤。

可选参数

--host <hostname>
主机的名称。
--binary <binary>
服务二进制文件。

6.158. nova set-password

usage: nova set-password <server>
Copy to Clipboard Toggle word wrap
更改服务器的 admin 密码。

positional 参数

<server>
服务器的名称或 ID。

6.159. Nova shelve

usage: nova shelve <server>
Copy to Clipboard Toggle word wrap
她将服务器装置。

positional 参数

<server>
服务器的名称或 ID。

6.160. Nova shelve-offload

usage: nova shelve-offload <server>
Copy to Clipboard Toggle word wrap
从计算节点移除 shelved 服务器。

positional 参数

<server>
服务器的名称或 ID。

6.161. Nova 显示

usage: nova show [--minimal] <server>
Copy to Clipboard Toggle word wrap
显示给定服务器的详细信息。

positional 参数

<server>
服务器的名称或 ID。

可选参数

--minimal
显示服务器时跳过类别/镜像查找

6.162. Nova ssh

usage: nova ssh [--port PORT] [--address-type ADDRESS_TYPE] [--network <network>] [--ipv6] [--login <login>] [-i IDENTITY] [--extra-opts EXTRA] <server>
Copy to Clipboard Toggle word wrap
SSH 到服务器。

positional 参数

<server>
服务器的名称或 ID。

可选参数

--port PORT
可选标志,用于指示 ssh 使用哪个端口。(default=22)
--address-type ADDRESS_TYPE
用于指示要使用的 IP 类型的可选标志。可能的值包括 fixed 和 floating (默认值)。
--network <network>
用于 ssh 的网络。
--ipv6
可选标志,指示是否使用附加到服务器的 IPv6 地址。(默认为 IPv4 地址)
--login <login>
登录以使用。
-i IDENTITY, --identity IDENTITY
私钥文件,与 ssh 命令的 -i 选项相同。
--extra-opts EXTRA
传递给 ssh 的额外选项。请参阅:man ssh

6.163. Nova start

usage: nova start <server> [<server> ...]
Copy to Clipboard Toggle word wrap
启动服务器。

positional 参数

<server>
服务器的名称或 ID。

6.164. Nova 停止

usage: nova stop <server> [<server> ...]
Copy to Clipboard Toggle word wrap
停止服务器。

positional 参数

<server>
服务器的名称或 ID。

6.165. Nova suspend

usage: nova suspend <server>
Copy to Clipboard Toggle word wrap
暂停服务器。

positional 参数

<server>
服务器的名称或 ID。

6.166. nova tenant-network-create

usage: nova tenant-network-create <network_label> <cidr>
Copy to Clipboard Toggle word wrap
创建租户网络。

positional 参数

<network_label>
网络标签(例如,my_new_network)
<cidr>
要从中分配的 IP 块(例如172.16.0.0/24 或 2001:DB8::/64)

6.167. nova tenant-network-delete

usage: nova tenant-network-delete <network_id>
Copy to Clipboard Toggle word wrap
删除租户网络。

positional 参数

<network_id>
网络 ID

6.168. nova tenant-network-list

usage: nova tenant-network-list
Copy to Clipboard Toggle word wrap
列出租户网络。

6.169. nova tenant-network-show

usage: nova tenant-network-show <network_id>
Copy to Clipboard Toggle word wrap
显示租户网络。

positional 参数

<network_id>
网络 ID

6.170. nova unlock

usage: nova unlock <server>
Copy to Clipboard Toggle word wrap
解锁服务器。

positional 参数

<server>
服务器的名称或 ID。

6.171. Nova unpause

usage: nova unpause <server>
Copy to Clipboard Toggle word wrap
取消暂停服务器。

positional 参数

<server>
服务器的名称或 ID。

6.172. nova unrescue

usage: nova unrescue <server>
Copy to Clipboard Toggle word wrap
再次从正常引导磁盘重新启动服务器。

positional 参数

<server>
服务器的名称或 ID。

6.173. Nova unshelve

usage: nova unshelve <server>
Copy to Clipboard Toggle word wrap
取消缩小服务器。

positional 参数

<server>
服务器的名称或 ID。

6.174. Nova 用法

usage: nova usage [--start <start>] [--end <end>] [--tenant <tenant-id>]
Copy to Clipboard Toggle word wrap
显示单个租户的使用情况数据。

可选参数

--start <start>
使用范围开始日期 2012-01-20 (默认值:4 周前)
--end <end>
使用范围结束日期,ex 2012-01-20 (默认值:明天)
--tenant <tenant-id>
用于获取使用的租户的 UUID。

6.175. nova usage-list

usage: nova usage-list [--start <start>] [--end <end>]
Copy to Clipboard Toggle word wrap
列出所有租户的使用情况数据。

可选参数

--start <start>
使用范围开始日期 2012-01-20 (默认值:4 周前)
--end <end>
使用范围结束日期,ex 2012-01-20 (默认值:明天)

6.176. nova version-list

usage: nova version-list
Copy to Clipboard Toggle word wrap
列出所有 API 版本。

6.177. nova volume-attach

usage: nova volume-attach <server> <volume> [<device>]
Copy to Clipboard Toggle word wrap
将卷附加到服务器。

positional 参数

<server>
服务器的名称或 ID。
<volume>
要连接的卷的 ID。
<device>
设备的名称,如 /dev/vdb。将"auto"用于自动分配(如果支持)

6.178. nova volume-detach

usage: nova volume-detach <server> <volume>
Copy to Clipboard Toggle word wrap
将卷从服务器分离。

positional 参数

<server>
服务器的名称或 ID。
<volume>
要分离的卷 ID。

6.179. nova volume-update

usage: nova volume-update <server> <attachment> <volume>
Copy to Clipboard Toggle word wrap
更新卷附加。

positional 参数

<server>
服务器的名称或 ID。
<attachment>
卷的附加 ID。
<volume>
要连接的卷的 ID。

6.180. nova x509-create-cert

usage: nova x509-create-cert [<private-key-filename>] [<x509-cert-filename>]
Copy to Clipboard Toggle word wrap
为租户中的用户创建 x509 证书。

positional 参数

<private-key-filename>
私钥的文件名 [Default: pk.pem]
<x509-cert-filename>
X.509 证书的文件名 [Default: cert.pem]

6.181. nova x509-get-root-cert

usage: nova x509-get-root-cert [<filename>]
Copy to Clipboard Toggle word wrap
获取 x509 根证书。

positional 参数

<filename>
编写 x509 root 证书的文件名。

第 7 章 Identity 服务命令行客户端

警告
keystone CLI 已被弃用,而是使用 python-openstackclient。有关 python-openstackclient 的更多信息,请参阅 第 3.3 节 “子命令”。对于 Python 库,继续使用 python-keystoneclient。
keystone 客户端是 Identity 服务 API 及其扩展的命令行界面(CLI)。本章记录了 keystone 版本 1.7.2
有关特定 keystone 命令的帮助信息,请输入:
$ keystone help COMMAND
Copy to Clipboard Toggle word wrap

7.1. Keystone 用法

usage: keystone [--version] [--debug] [--os-username <auth-user-name>] [--os-password <auth-password>] [--os-tenant-name <auth-tenant-name>] [--os-tenant-id <tenant-id>] [--os-auth-url <auth-url>] [--os-region-name <region-name>] [--os-identity-api-version <identity-api-version>] [--os-token <service-token>] [--os-endpoint <service-endpoint>] [--os-cache] [--force-new-token] [--stale-duration <seconds>] [--insecure] [--os-cacert <ca-certificate>] [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>] <subcommand> ...
Copy to Clipboard Toggle word wrap

子命令

catalog
列出服务目录,可以按服务过滤。
ec2-credentials-create
为每个租户的用户创建 EC2 兼容凭据。
ec2-credentials-delete
删除 EC2 兼容凭据。
ec2-credentials-get
显示 EC2 兼容凭据。
ec2-credentials-list
列出用户兼容 EC2 的凭据。
endpoint-create
创建与服务关联的新端点。
endpoint-delete
删除服务端点。
endpoint-get
查找根据特定属性或服务类型过滤的端点。
endpoint-list
列出配置的服务端点。
password-update
更新自己的密码。
role-create
创建新角色。
role-delete
删除角色.
role-get
显示角色详细信息.
role-list
列出所有角色。
service-create
将服务添加到服务目录。
service-delete
从 Service Catalog 删除服务。
service-get
显示服务目录中的服务。
service-list
列出 Service Catalog 中的所有服务。
tenant-create
创建新租户。
tenant-delete
删除租户。
tenant-get
显示租户详细信息。
tenant-list
列出所有租户。
tenant-update
更新租户名称、描述、启用的状态。
token-get
显示当前用户令牌。
user-create
创建新用户。
user-delete
删除用户。
user-get
显示用户详情。
user-list
列出用户。
user-password-update
更新用户密码。
user-role-add
为用户添加角色。
user-role-list
列出授予用户的角色。
user-role-remove
从用户中删除角色。
user-update
更新用户的名称、电子邮件和启用的状态。
discover
发现 Keystone 服务器、受支持的 API 版本和扩展。
bootstrap
在创建了每个租户后,为新租户上的新用户授予新角色。
bash-completion
将所有命令和选项输出到 stdout。
帮助
显示有关该程序或其其中一个子命令的帮助。

7.2. Keystone 可选参数

--version
显示客户端版本并退出。
--debug
在控制台上打印调试输出,其中包括 curl 请求和响应调用。有助于调试和理解 API 调用。
--os-username <auth-user-name>
用于与 OpenStack Identity 服务进行身份验证的名称。默认为 env[OS_USERNAME]
--os-password <auth-password>
用于与 OpenStack Identity 服务进行身份验证的密码。默认为 env[OS_PASSWORD]
--os-tenant-name <auth-tenant-name>
用于请求授权的租户。默认为 env[OS_TENANT_NAME]
--os-tenant-id <tenant-id>
用于请求授权的租户。默认为 env[OS_TENANT_ID]
--os-auth-url <auth-url>
指定要用于身份验证的身份端点。默认为 env[OS_AUTH_URL]
--os-region-name <region-name>
指定要使用的区域。默认为 env[OS_REGION_NAME]
--os-identity-api-version <identity-api-version>
指定要使用的 Identity API 版本。默认为 env[OS_IDENTITY_API_VERSION] 或 2.0。
--os-token <service-token>
指定要使用的现有令牌,而不是通过身份验证检索令牌(例如,使用用户名和密码)。默认为 env[OS_SERVICE_TOKEN]
--os-endpoint <service-endpoint>
指定要使用的端点,而不是从服务目录检索端点(通过身份验证)。默认为 env[OS_SERVICE_ENDPOINT]
--os-cache
使用身份验证令牌缓存。默认为 env[OS_CACHE]
--force-new-token
如果密钥环可用且正在使用中,则令牌将始终从密钥环存储并获取,直到令牌已过期。使用此选项请求新令牌并替换密钥环中的现有令牌。
--stale-duration <seconds>
过时的持续时间(以秒为单位),用于确定令牌是否在从密钥环检索时过期。这可用于减少进程或网络延迟。默认值为 30 秒。
--insecure
明确允许客户端执行"不安全"TLS (https)请求。服务器的证书不会针对任何证书颁发机构进行验证。这个选项应谨慎使用。
--os-cacert <ca-certificate>
指定用于验证 TLS (https)服务器证书中使用的 CA 捆绑包文件。默认为 env[OS_CACERT]
--os-cert <certificate>
默认为 env[OS_CERT]
--os-key <key>
默认为 env[OS_KEY]
--timeout <seconds>
设置请求超时(以秒为单位)。

7.3. Keystone bootstrap

usage: keystone bootstrap [--user-name <user-name>] --pass <password> [--role-name <role-name>] [--tenant-name <tenant-name>]
Copy to Clipboard Toggle word wrap
在创建了每个租户后,为新租户上的新用户授予新角色。

参数

--user-name <user-name>
要创建的用户的名称(default="admin")。
--pass <password>
新用户的密码。
--role-name <role-name>
要创建并授予用户的角色的名称(default="admin")。
--tenant-name <tenant-name>
要创建的租户的名称(default="admin")。

7.4. Keystone 目录

usage: keystone catalog [--service <service-type>]
Copy to Clipboard Toggle word wrap
列出服务目录,可以按服务过滤。

参数

--service <service-type>
要返回的服务类型。

7.5. Keystone discover

usage: keystone discover
Copy to Clipboard Toggle word wrap
发现 Keystone 服务器、受支持的 API 版本和扩展。

7.6. Keystone ec2-credentials-create

usage: keystone ec2-credentials-create [--user-id <user-id>] [--tenant-id <tenant-id>]
Copy to Clipboard Toggle word wrap
为每个租户的用户创建 EC2 兼容凭据。

参数

--user-id <user-id>
创建凭据的用户 ID。如果未指定,则使用经过身份验证的用户。
--tenant-id <tenant-id>
创建凭证的租户 ID。如果未指定,则使用经过身份验证的租户 ID。

7.7. keystone ec2-credentials-delete

usage: keystone ec2-credentials-delete [--user-id <user-id>] --access <access-key>
Copy to Clipboard Toggle word wrap
删除 EC2 兼容凭据。

参数

--user-id <user-id>
用户 ID。
--access <access-key>
访问密钥.

7.8. Keystone ec2-credentials-get

usage: keystone ec2-credentials-get [--user-id <user-id>] --access <access-key>
Copy to Clipboard Toggle word wrap
显示 EC2 兼容凭据。

参数

--user-id <user-id>
用户 ID。
--access <access-key>
访问密钥.

7.9. keystone ec2-credentials-list

usage: keystone ec2-credentials-list [--user-id <user-id>]
Copy to Clipboard Toggle word wrap
列出用户兼容 EC2 的凭据。

参数

--user-id <user-id>
用户 ID。

7.10. Keystone endpoint-create

usage: keystone endpoint-create [--region <endpoint-region>] --service <service> --publicurl <public-url> [--adminurl <admin-url>] [--internalurl <internal-url>]
Copy to Clipboard Toggle word wrap
创建与服务关联的新端点。

参数

--region <endpoint-region>
端点区域。
--service <service>, --service-id <service>, --service_id <service>
与端点关联的服务名称或 ID。
--publicurl <public-url>
公共 URL 端点.
--adminurl <admin-url>
管理 URL 端点。
--internalurl <internal-url>
内部 URL 端点.

7.11. Keystone endpoint-delete

usage: keystone endpoint-delete <endpoint-id>
Copy to Clipboard Toggle word wrap
删除服务端点。

参数

<endpoint-id>
要删除的端点 ID。

7.12. Keystone endpoint-get

usage: keystone endpoint-get --service <service-type> [--endpoint-type <endpoint-type>] [--attr <service-attribute>] [--value <value>]
Copy to Clipboard Toggle word wrap
查找根据特定属性或服务类型过滤的端点。

参数

--service <service-type>
要选择的服务类型。
--endpoint-type <endpoint-type>
要选择的端点类型。
--attr <service-attribute>
要选择的服务属性。
--value <value>
要匹配的属性值。

7.13. Keystone endpoint-list

usage: keystone endpoint-list
Copy to Clipboard Toggle word wrap
列出配置的服务端点。

7.14. Keystone password-update

usage: keystone password-update [--current-password <current-password>] [--new-password <new-password>]
Copy to Clipboard Toggle word wrap
更新自己的密码。

参数

--current-password <current-password>
当前密码,默认为 --os-password 或 env[OS_PASSWORD] 设置的密码。
--new-password <new-password>
所需的新密码。

7.15. Keystone role-create

usage: keystone role-create --name <role-name>
Copy to Clipboard Toggle word wrap
创建新角色。

参数

--name <role-name>
新角色的名称。

7.16. Keystone role-delete

usage: keystone role-delete <role>
Copy to Clipboard Toggle word wrap
删除角色.

参数

<role>
要删除的角色的名称或 ID。

7.17. Keystone role-get

usage: keystone role-get <role>
Copy to Clipboard Toggle word wrap
显示角色详细信息.

参数

<role>
要显示的角色名称或 ID。

7.18. Keystone role-list

usage: keystone role-list
Copy to Clipboard Toggle word wrap
列出所有角色。

7.19. Keystone service-create

usage: keystone service-create --type <type> [--name <name>] [--description <service-description>]
Copy to Clipboard Toggle word wrap
将服务添加到服务目录。

参数

--type <type>
服务类型(一种: identity、compute、network、image、object-store 或其他服务标识符字符串)。
--name <name>
新服务的名称(必须唯一)。
--description <service-description>
服务描述。

7.20. Keystone service-delete

usage: keystone service-delete <service>
Copy to Clipboard Toggle word wrap
从 Service Catalog 删除服务。

参数

<service>
要删除的服务名称或 ID。

7.21. Keystone service-get

usage: keystone service-get <service>
Copy to Clipboard Toggle word wrap
显示服务目录中的服务。

参数

<service>
要显示的服务的名称或 ID。

7.22. Keystone service-list

usage: keystone service-list
Copy to Clipboard Toggle word wrap
列出 Service Catalog 中的所有服务。

7.23. Keystone tenant-create

usage: keystone tenant-create --name <tenant-name> [--description <tenant-description>] [--enabled <true|false>]
Copy to Clipboard Toggle word wrap
创建新租户。

参数

--name <tenant-name>
新租户名称(必须唯一)。
--description <tenant-description>
新租户的描述。默认为 none。
--enabled <true|false>
启用初始租户的状态。默认为 true。

7.24. Keystone tenant-delete

usage: keystone tenant-delete <tenant>
Copy to Clipboard Toggle word wrap
删除租户。

参数

<tenant>
要删除的租户的名称或 ID。

7.25. Keystone tenant-get

usage: keystone tenant-get <tenant>
Copy to Clipboard Toggle word wrap
显示租户详细信息。

参数

<tenant>
要显示的租户的名称或 ID。

7.26. Keystone tenant-list

usage: keystone tenant-list
Copy to Clipboard Toggle word wrap
列出所有租户。

7.27. Keystone tenant-update

usage: keystone tenant-update [--name <tenant_name>] [--description <tenant-description>] [--enabled <true|false>] <tenant>
Copy to Clipboard Toggle word wrap
更新租户名称、描述、启用的状态。

参数

--name <tenant_name>
所需的租户新名称。
--description <tenant-description>
租户所需的新描述。
--enabled <true|false>
启用或禁用租户。
<tenant>
要更新的租户的名称或 ID。

7.28. Keystone token-get

usage: keystone token-get [--wrap <integer>]
Copy to Clipboard Toggle word wrap
显示当前用户令牌。

参数

--wrap <integer>
将 PKI 令牌嵌套到指定的长度,或将 0 嵌套到要禁用的长度。

7.29. Keystone user-create

usage: keystone user-create --name <user-name> [--tenant <tenant>] [--pass [<pass>]] [--email <email>] [--enabled <true|false>]
Copy to Clipboard Toggle word wrap
创建新用户。

参数

--name <user-name>
新用户名(必须唯一)。
--tenant <tenant>, --tenant-id <tenant>
新用户默认租户。
--pass [<pass>]
新用户密码;某些身份验证后端是必需的。
--email <email>
新用户电子邮件地址。
--enabled <true|false>
初始用户启用状态。默认为 true。

7.30. Keystone user-delete

usage: keystone user-delete <user>
Copy to Clipboard Toggle word wrap
删除用户。

参数

<user>
要删除的用户的名称或 ID。

7.31. Keystone user-get

usage: keystone user-get <user>
Copy to Clipboard Toggle word wrap
显示用户详情。

参数

<user>
要显示的用户的名称或 ID。

7.32. Keystone user-list

usage: keystone user-list [--tenant <tenant>]
Copy to Clipboard Toggle word wrap
列出用户。

参数

--tenant <tenant>, --tenant-id <tenant>
租户;如果没有指定,则列出所有用户。

7.33. Keystone user-password-update

usage: keystone user-password-update [--pass <password>] <user>
Copy to Clipboard Toggle word wrap
更新用户密码。

参数

--pass <password>
所需的新密码。
<user>
要更新密码的用户名称或 ID。

7.34. Keystone user-role-add

usage: keystone user-role-add --user <user> --role <role> [--tenant <tenant>]
Copy to Clipboard Toggle word wrap
为用户添加角色。

参数

--user <user>, --user-id <user>, --user_id <user>
用户名称或 ID。
--role <role>, --role-id <role>, --role_id <role>
角色的名称或 ID。
--tenant <tenant>, --tenant-id <tenant>
租户的名称或 ID。

7.35. Keystone user-role-list

usage: keystone user-role-list [--user <user>] [--tenant <tenant>]
Copy to Clipboard Toggle word wrap
列出授予用户的角色。

参数

--user <user>, --user-id <user>
列出授予指定用户的角色。
--tenant <tenant>, --tenant-id <tenant>
仅列出在指定租户上授予的角色。

7.36. Keystone user-role-remove

usage: keystone user-role-remove --user <user> --role <role> [--tenant <tenant>]
Copy to Clipboard Toggle word wrap
从用户中删除角色。

参数

--user <user>, --user-id <user>, --user_id <user>
用户名称或 ID。
--role <role>, --role-id <role>, --role_id <role>
角色的名称或 ID。
--tenant <tenant>, --tenant-id <tenant>
租户的名称或 ID。

7.37. Keystone user-update

usage: keystone user-update [--name <user-name>] [--email <email>] [--enabled <true|false>] <user>
Copy to Clipboard Toggle word wrap
更新用户的名称、电子邮件和启用的状态。

参数

--name <user-name>
所需的新用户名。
--email <email>
需要的新电子邮件地址。
--enabled <true|false>
启用或禁用用户。
<user>
要更新的用户的名称或 ID。

第 8 章 镜像服务命令行客户端

glance 客户端是镜像服务 API 及其扩展的命令行界面(CLI)。本章记录了 glance 版本 1.1.0。
有关特定 glance 命令的帮助信息,请输入:
$ glance help COMMAND
Copy to Clipboard Toggle word wrap

8.1. Glance 用法

usage: glance [--version] [-d] [-v] [--get-schema] [--timeout TIMEOUT] [--no-ssl-compression] [-f] [--os-image-url OS_IMAGE_URL] [--os-image-api-version OS_IMAGE_API_VERSION] [--profile HMAC_KEY] [-k] [--os-cert OS_CERT] [--cert-file OS_CERT] [--os-key OS_KEY] [--key-file OS_KEY] [--os-cacert <ca-certificate-file>] [--ca-file OS_CACERT] [--os-username OS_USERNAME] [--os-user-id OS_USER_ID] [--os-user-domain-id OS_USER_DOMAIN_ID] [--os-user-domain-name OS_USER_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID] [--os-project-name OS_PROJECT_NAME] [--os-project-domain-id OS_PROJECT_DOMAIN_ID] [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] [--os-password OS_PASSWORD] [--os-tenant-id OS_TENANT_ID] [--os-tenant-name OS_TENANT_NAME] [--os-auth-url OS_AUTH_URL] [--os-region-name OS_REGION_NAME] [--os-auth-token OS_AUTH_TOKEN] [--os-service-type OS_SERVICE_TYPE] [--os-endpoint-type OS_ENDPOINT_TYPE] <subcommand> ...
Copy to Clipboard Toggle word wrap

8.2. Glance 可选参数

--version
显示程序的版本号并退出
-d, --debug
默认为 env[GLANCECLIENT_DEBUG]
-v, --verbose
打印更详细的输出
--get-schema
忽略缓存的复制,并强制检索生成帮助文本的部分模式。API 版本 1 忽略。
--timeout TIMEOUT
等待响应的秒数
--no-ssl-compression
弃用!这个选项已弃用,不再使用。系统 SSL 库应默认禁用 SSL 压缩。
-f, --force
防止选择操作请求用户确认。
--os-image-url OS_IMAGE_URL
默认为 env[OS_IMAGE_URL]。如果提供的镜像 url 包含版本号,并且忽略了 '--os-image-api- version',则将选择 URL 版本作为要使用的镜像 api 版本。
--os-image-api-version OS_IMAGE_API_VERSION
默认为 env[OS_IMAGE_API_VERSION] 或 2。
--profile HMAC_KEY
HMAC 密钥用于加密上下文数据以进行操作性能分析。这个键应该是在 glance 中在 osprofiler 中间件中配置的 HMAC 键的值,它在 /etc/glance/api-paste.ini 和 /etc/glance/registry-paste.ini 中指定。如果没有键,即使服务器端启用了 osprofiler,也不会触发性能分析。
-k, --insecure
明确允许 glanceclient 执行"不安全 SSL" (https)请求。服务器的证书不会针对任何证书颁发机构进行验证。这个选项应谨慎使用。
--os-cert OS_CERT
SSL 连接中使用的证书文件的路径。此文件可以选择使用私钥前添加。
--cert-file OS_CERT
弃用!使用 --os-cert。
--os-key OS_KEY
SSL 连接中使用的客户端密钥的路径。如果您的密钥在您的证书文件前面添加,则不需要这个选项。
--key-file OS_KEY
弃用!使用 --os-key。
--os-cacert <ca-certificate-file>
用于验证远程服务器证书的 CA TLS 证书的路径。如果没有此选项,则 glance 会查找默认的系统 CA 证书。
--ca-file OS_CACERT
弃用!使用 --os-cacert。
--os-username OS_USERNAME
默认为 env[OS_USERNAME]
--os-user-id OS_USER_ID
默认为 env[OS_USER_ID]
--os-user-domain-id OS_USER_DOMAIN_ID
默认为 env[OS_USER_DOMAIN_ID]
--os-user-domain-name OS_USER_DOMAIN_NAME
默认为 env[OS_USER_DOMAIN_NAME]
--os-project-id OS_PROJECT_ID
指定租户 ID 的另一种方式。这个选项与 --os-tenant-id 相互排斥。默认为 env[OS_PROJECT_ID]
--os-project-name OS_PROJECT_NAME
指定租户名称的另一种方法。这个选项与 --os-tenant-name 相互排斥。默认为 env[OS_PROJECT_NAME]
--os-project-domain-id OS_PROJECT_DOMAIN_ID
默认为 env[OS_PROJECT_DOMAIN_ID]
--os-project-domain-name OS_PROJECT_DOMAIN_NAME
默认为 env[OS_PROJECT_DOMAIN_NAME]
--os-password OS_PASSWORD
默认为 env[OS_PASSWORD]
--os-tenant-id OS_TENANT_ID
默认为 env[OS_TENANT_ID]
--os-tenant-name OS_TENANT_NAME
默认为 env[OS_TENANT_NAME]
--os-auth-url OS_AUTH_URL
默认为 env[OS_AUTH_URL]
--os-region-name OS_REGION_NAME
默认为 env[OS_REGION_NAME]
--os-auth-token OS_AUTH_TOKEN
默认为 env[OS_AUTH_TOKEN]
--os-service-type OS_SERVICE_TYPE
默认为 env[OS_SERVICE_TYPE]
--os-endpoint-type OS_ENDPOINT_TYPE
默认为 env[OS_ENDPOINT_TYPE]

8.3. 镜像服务 API v1 命令

8.3.1. glance image-create (v1)

usage: glance --os-image-api-version 1 image-create [--id <IMAGE_ID>] [--name <NAME>] [--store <STORE>] [--disk-format <DISK_FORMAT>] [--container-format <CONTAINER_FORMAT>] [--owner <TENANT_ID>] [--size <SIZE>] [--min-disk <DISK_GB>] [--min-ram <DISK_RAM>] [--location <IMAGE_URL>] [--file <FILE>] [--checksum <CHECKSUM>] [--copy-from <IMAGE_URL>] [--is-public {True,False}] [--is-protected {True,False}] [--property <key=value>] [--human-readable] [--progress]
Copy to Clipboard Toggle word wrap

可选参数

--id <IMAGE_ID>
要保留的镜像 ID。
--name <NAME>
镜像名称。
--store <STORE>
存储以上传映像到.
--disk-format <DISK_FORMAT>
镜像的磁盘格式。可接受的格式: ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, 和 iso。
--Container-format <CONTAINER_FORMAT>
容器镜像格式。可接受的格式: ami、ari、aki、bare 和 ovf。
--owner <TENANT_ID>
应该拥有镜像的租户。
--size <SIZE>
镜像数据的大小(以字节为单位)。仅用于 '-- location' 和 '--copy_from'。
--min-disk <DISK_GB>
引导镜像所需的最小磁盘大小(以 GB 为单位)。
--min-ram <DISK_RAM>
引导镜像所需的最小 RAM 量(以 MB 为单位)。
--location <IMAGE_URL>
此镜像的数据已驻留的 URL。例如,如果镜像数据存储在 swift 中,您可以指定 'swift+http://tenant%3Aaccount:key@auth_ url/v2.0/container/obj'。(注:'%3A' is ':' URL encoded.)
--file <FILE>
包含要在创建过程中上传的磁盘镜像的本地文件。或者,可以通过 stdin 传递给客户端。
--checksum <CHECKSUM>
使用 Glance 的镜像数据的哈希可用于验证。此处提供 md5 checksum。
--copy-from <IMAGE_URL>
与使用中的"-location"类似,但这表明 Glance 服务器应立即复制数据并将其存储在其配置的映像存储中。
注意
Red Hat OpenStack Platform 8 版本的 glance v2 弃用了 -copy-from 选项,并将在以后的 Red Hat OpenStack Platform 版本中弃用 v1。
--is-public {True,False}
使镜像可以被公共访问。
--is-protected {True,False}
防止镜像被删除。
--property <key=value>
与镜像关联的任意属性。可以多次使用。
--human-readable
以人类可读格式打印镜像大小。
--progress
显示上传进度条。

8.3.2. Glance image-delete (v1)

usage: glance --os-image-api-version 1 image-delete <IMAGE> [<IMAGE> ...]
Copy to Clipboard Toggle word wrap
删除指定的镜像。

positional 参数

<IMAGE>
要删除的镜像的名称或 ID。

8.3.3. Glance image-download (v1)

usage: glance --os-image-api-version 1 image-download [--file <FILE>] [--progress] <IMAGE>
Copy to Clipboard Toggle word wrap
下载特定镜像。

positional 参数

<IMAGE>
要下载的镜像的名称或 ID。

可选参数

--file <FILE>
将下载的镜像数据保存到的本地文件。如果没有指定,且没有保存镜像数据。
--progress
显示下载进度条。

8.3.4. glance image-list (v1)

usage: glance --os-image-api-version 1 image-list [--name <NAME>] [--status <STATUS>] [--changes-since <CHANGES_SINCE>] [--container-format <CONTAINER_FORMAT>] [--disk-format <DISK_FORMAT>] [--size-min <SIZE>] [--size-max <SIZE>] [--property-filter <KEY=VALUE>] [--page-size <SIZE>] [--human-readable] [--sort-key {name,status,container_format,disk_format,size,id,created_at,updated_at}] [--sort-dir {asc,desc}] [--is-public {True,False}] [--owner <TENANT_ID>] [--all-tenants]
Copy to Clipboard Toggle word wrap
列出您可以访问的镜像。

可选参数

--name <NAME>
将镜像过滤为具有此名称的镜像。
--status <STATUS>
将镜像过滤为具有此状态的镜像。
--changes-since <CHANGES_SINCE>
将镜像过滤到自给定时间起更改的镜像,其中包括已删除的镜像。
--Container-format <CONTAINER_FORMAT>
将镜像过滤为具有此容器格式的镜像。可接受的格式: ami、ari、aki、bare 和 ovf。
--disk-format <DISK_FORMAT>
将镜像过滤为具有此磁盘格式的镜像。可接受的格式: ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, 和 iso。
--size-min <SIZE>
将镜像过滤为大于这个大小的镜像。
--size-max <SIZE>
将镜像过滤为小于这个大小的镜像。
--property-filter <KEY=VALUE>
根据用户定义的镜像属性过滤镜像。
--page-size <SIZE>
每个分页请求中请求的镜像数。
--human-readable
以人类可读格式打印镜像大小。
--sort-key {name,status,container_format,disk_format,size,id,created_at,updated_at}
根据指定字段对镜像列表进行排序。
--sort-dir {asc,desc}
在指定方向排序镜像列表。
--is-public {True,False}
允许用户选择公共或非公共镜像的列表。
--owner <TENANT_ID>
仅显示此租户 id 拥有的镜像。过滤在客户端中进行,因此可能效率低下。此选项主要用于管理员使用。使用空字符串('')列出没有所有者的镜像。注意:此选项会覆盖 --is-public 参数(如果存在)。注: v2 API 支持更有效地基于服务器端所有者的过滤。
--all-tenants
允许 admin 用户列出与镜像的所有者或 is_public 值无关的所有镜像。

8.3.5. glance image-show (v1)

usage: glance --os-image-api-version 1 image-show [--human-readable] [--max-column-width <integer>] <IMAGE>
Copy to Clipboard Toggle word wrap
描述特定镜像。

positional 参数

<IMAGE>
要描述的镜像的名称或 ID。

可选参数

--human-readable
以人类可读格式打印镜像大小。
--max-column-width <integer>
打印表的最大列宽度。

8.3.6. glance image-update (v1)

usage: glance --os-image-api-version 1 image-update [--name <NAME>] [--disk-format <DISK_FORMAT>] [--container-format <CONTAINER_FORMAT>] [--owner <TENANT_ID>] [--size <SIZE>] [--min-disk <DISK_GB>] [--min-ram <DISK_RAM>] [--location <IMAGE_URL>] [--file <FILE>] [--checksum <CHECKSUM>] [--copy-from <IMAGE_URL>] [--is-public {True,False}] [--is-protected {True,False}] [--property <key=value>] [--purge-props] [--human-readable] [--progress] <IMAGE>
Copy to Clipboard Toggle word wrap
更新特定镜像。

positional 参数

<IMAGE>
要修改的镜像的名称或 ID。

可选参数

--name <NAME>
镜像名称。
--disk-format <DISK_FORMAT>
镜像的磁盘格式。可接受的格式: ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, 和 iso。
--Container-format <CONTAINER_FORMAT>
容器镜像格式。可接受的格式: ami、ari、aki、bare 和 ovf。
--owner <TENANT_ID>
应该拥有镜像的租户。
--size <SIZE>
镜像数据的大小(以字节为单位)。
--min-disk <DISK_GB>
引导镜像所需的最小磁盘大小(以 GB 为单位)。
--min-ram <DISK_RAM>
引导镜像所需的最小 RAM 量(以 MB 为单位)。
--location <IMAGE_URL>
此镜像的数据已驻留的 URL。例如,如果镜像数据存储在 swift 中,您可以指定 'swift+http://tenant%3Aaccount:key@auth_ url/v2.0/container/obj'。(注:'%3A' is ':' URL encoded.)这个选项只适用于 'queued' 状态中的镜像。
--file <FILE>
包含要在更新期间上传的磁盘镜像的本地文件。或者,可以通过 stdin 传递给客户端。
--checksum <CHECKSUM>
使用 Glance 的镜像数据的哈希可用于验证。
--copy-from <IMAGE_URL>
与使用中的"-location"类似,但这表明 Glance 服务器应立即复制数据并将其存储在其配置的映像存储中。这个选项只适用于 'queued' 状态中的镜像。
注意
Red Hat OpenStack Platform 8 版本的 glance v2 弃用了 -copy-from 选项,并将在以后的 Red Hat OpenStack Platform 版本中弃用 v1。
--is-public {True,False}
使镜像可以被公共访问。
--is-protected {True,False}
防止镜像被删除。
--property <key=value>
与镜像关联的任意属性。可以多次使用。
--purge-props
如果存在此标志,请删除更新请求中未明确设置的所有镜像属性。否则,未引用的属性会被保留。
--human-readable
以人类可读格式打印镜像大小。
--progress
显示上传进度条。

8.3.7. glance member-create (v1)

usage: glance --os-image-api-version 1 member-create [--can-share] <IMAGE> <TENANT_ID>
Copy to Clipboard Toggle word wrap
与租户共享特定镜像。

positional 参数

<IMAGE>
要添加成员的镜像。
<TENANT_ID>
添加为成员的租户

可选参数

--can-share
允许指定的租户共享此镜像。

8.3.8. Glance member-delete (v1)

usage: glance --os-image-api-version 1 member-delete <IMAGE> <TENANT_ID>
Copy to Clipboard Toggle word wrap
从租户移除共享镜像。

positional 参数

<IMAGE>
从中删除成员的镜像。
<TENANT_ID>
要作为成员删除的租户。

8.3.9. glance member-list (v1)

usage: glance --os-image-api-version 1 member-list [--image-id <IMAGE_ID>] [--tenant-id <TENANT_ID>]
Copy to Clipboard Toggle word wrap
描述镜像或租户的共享权限。

可选参数

--image-id <IMAGE_ID>
根据镜像 ID 过滤结果。
--tenant-id <TENANT_ID>
根据租户 ID 过滤结果。

8.4. 镜像服务 API v2 命令

您可以通过添加 -os-image-api-version 参数或设置对应的 环境变量来选择要使用的 API 版本:
$ export OS_IMAGE_API_VERSION=2
Copy to Clipboard Toggle word wrap

8.4.1. Glance explain (v2)

usage: glance --os-image-api-version 2 explain <MODEL>
Copy to Clipboard Toggle word wrap
描述特定模型。

positional 参数

<MODEL>
要描述的型号名称。

8.4.2. glance image-create (v2)

usage: glance --os-image-api-version 2 image-create [--architecture <ARCHITECTURE>] [--protected [True|False]] [--name <NAME>] [--instance-uuid <INSTANCE_UUID>] [--min-disk <MIN_DISK>] [--visibility <VISIBILITY>] [--kernel-id <KERNEL_ID>] [--tags <TAGS> [<TAGS> ...]] [--os-version <OS_VERSION>] [--disk-format <DISK_FORMAT>] [--self <SELF>] [--os-distro <OS_DISTRO>] [--id <ID>] [--owner <OWNER>] [--ramdisk-id <RAMDISK_ID>] [--min-ram <MIN_RAM>] [--container-format <CONTAINER_FORMAT>] [--property <key=value>] [--file <FILE>] [--progress]
Copy to Clipboard Toggle word wrap

可选参数

--architecture <ARCHITECTURE>
如 http://docs.openstack.org/trunk/openstack- compute/admin/content/adding-images.html 中指定的操作系统架构
--protected [True|False]
如果为 true,则镜像将无法被删除。
--name <NAME>
镜像的描述性名称
--instance-uuid <INSTANCE_UUID>
用于创建此镜像的实例 ID。
--min-disk <MIN_DISK>
引导镜像所需的磁盘空间(以 GB 为单位)。
--visibility <VISIBILITY>
镜像可访问性有效值范围:public, private
--kernel-id <KERNEL_ID>
存储在 Glance 中的映像 ID,在引导 AMI 式镜像时应用作内核。
--tags <TAGS> [<TAGS> ...]
与镜像相关的字符串列表
--os-version <OS_VERSION>
根据经销商指定的操作系统版本
--disk-format <DISK_FORMAT>
磁盘 Valid 值的格式: ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, iso
--self <SELF>
(只读)
--os-distro <OS_DISTRO>
在 http://docs.openstack.org/trunk /openstack-compute/admin/content/adding-images.html 中指定的常用操作系统分发名称
--id <ID>
镜像的标识符
--owner <OWNER>
镜像的所有者
--ramdisk-id <RAMDISK_ID>
存储在 Glance 中的映像 ID,在引导 AMI 式镜像时应用作 ramdisk。
--min-ram <MIN_RAM>
引导镜像所需的 RAM 量(以 MB 为单位)。
--Container-format <CONTAINER_FORMAT>
容器 Valid 值的格式: ami, ari, aki, bare, ovf, ova
--property <key=value>
与镜像关联的任意属性。可以多次使用。
--file <FILE>
包含要在创建过程中上传的磁盘镜像的本地文件。如果镜像没有通过 stdin 传递给客户端,则必须存在。
--progress
显示上传进度条。

8.4.3. glance image-delete (v2)

usage: glance --os-image-api-version 2 image-delete <IMAGE_ID>
Copy to Clipboard Toggle word wrap
删除指定的镜像。

positional 参数

<IMAGE_ID>
要删除的镜像的 ID。

8.4.4. Glance image-download (v2)

usage: glance --os-image-api-version 2 image-download [--file <FILE>] [--progress] <IMAGE_ID>
Copy to Clipboard Toggle word wrap
下载特定镜像。

positional 参数

<IMAGE_ID>
要下载的镜像的 ID。

可选参数

--file <FILE>
将下载的镜像数据保存到的本地文件。如果没有指定,且没有保存镜像数据。
--progress
显示下载进度条。

8.4.5. glance image-list (v2)

usage: glance --os-image-api-version 2 image-list [--limit <LIMIT>] [--page-size <SIZE>] [--visibility <VISIBILITY>] [--member-status <MEMBER_STATUS>] [--owner <OWNER>] [--property-filter <KEY=VALUE>] [--checksum <CHECKSUM>] [--tag <TAG>] [--sort-key {name,status,container_format,disk_format,size,id,created_at,updated_at}] [--sort-dir {asc,desc}] [--sort <key>[:<direction>]]
Copy to Clipboard Toggle word wrap
列出您可以访问的镜像。

可选参数

--limit <LIMIT>
要获取的最大镜像数。
--page-size <SIZE>
每个分页请求中请求的镜像数。
--visibility <VISIBILITY>
要显示的镜像的可见性。
--member-status <MEMBER_STATUS>
要显示的镜像状态。
--owner <OWNER>
显示由 <OWNER> 所有的镜像。
--property-filter <KEY=VALUE>
根据用户定义的镜像属性过滤镜像。
--checksum <CHECKSUM>
显示与校验和匹配的镜像。
--tag <TAG>
根据用户定义的标签过滤镜像。
--sort-key {name,status,container_format,disk_format,size,id,created_at,updated_at}
根据指定字段对镜像列表进行排序。
--sort-dir {asc,desc}
在指定方向排序镜像列表。
--sort <key>[:<direction>]
以逗号分隔的排序键和方向列表,格式为 <key>[:<asc|desc>]。有效键: name, status, container_format, disk_format, size, id, created_at, updated_at.可选。

8.4.6. glance image-show (v2)

usage: glance --os-image-api-version 2 image-show [--human-readable] [--max-column-width <integer>] <IMAGE_ID>
Copy to Clipboard Toggle word wrap
描述特定镜像。

positional 参数

<IMAGE_ID>
要描述的镜像 ID。

可选参数

--human-readable
以人类可读格式打印镜像大小。
--max-column-width <integer>
打印表的最大列宽度。

8.4.7. Glance image-tag-delete (v2)

usage: glance --os-image-api-version 2 image-tag-delete <IMAGE_ID> <TAG_VALUE>
Copy to Clipboard Toggle word wrap
删除与给定镜像关联的标签。

positional 参数

<IMAGE_ID>
要从中删除标签的镜像 ID。
<TAG_VALUE>
标签的值。

8.4.8. glance image-tag-update (v2)

usage: glance --os-image-api-version 2 image-tag-update <IMAGE_ID> <TAG_VALUE>
Copy to Clipboard Toggle word wrap
使用给定标签更新镜像。

positional 参数

<IMAGE_ID>
要使用给定标签更新的镜像。
<TAG_VALUE>
标签的值。

8.4.9. glance image-update (v2)

usage: glance --os-image-api-version 2 image-update [--architecture <ARCHITECTURE>] [--protected [True|False]] [--name <NAME>] [--instance-uuid <INSTANCE_UUID>] [--min-disk <MIN_DISK>] [--visibility <VISIBILITY>] [--kernel-id <KERNEL_ID>] [--os-version <OS_VERSION>] [--disk-format <DISK_FORMAT>] [--self <SELF>] [--os-distro <OS_DISTRO>] [--owner <OWNER>] [--ramdisk-id <RAMDISK_ID>] [--min-ram <MIN_RAM>] [--container-format <CONTAINER_FORMAT>] [--property <key=value>] [--remove-property key] <IMAGE_ID>
Copy to Clipboard Toggle word wrap
更新现有镜像。

positional 参数

<IMAGE_ID>
要更新的镜像的 ID。

可选参数

--architecture <ARCHITECTURE>
如 http://docs.openstack.org/trunk/openstack- compute/admin/content/adding-images.html 中指定的操作系统架构
--protected [True|False]
如果为 true,则镜像将无法被删除。
--name <NAME>
镜像的描述性名称
--instance-uuid <INSTANCE_UUID>
用于创建此镜像的实例 ID。
--min-disk <MIN_DISK>
引导镜像所需的磁盘空间(以 GB 为单位)。
--visibility <VISIBILITY>
镜像可访问性有效值范围:public, private
--kernel-id <KERNEL_ID>
存储在 Glance 中的映像 ID,在引导 AMI 式镜像时应用作内核。
--os-version <OS_VERSION>
根据经销商指定的操作系统版本
--disk-format <DISK_FORMAT>
磁盘 Valid 值的格式: ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, iso
--self <SELF>
(只读)
--os-distro <OS_DISTRO>
在 http://docs.openstack.org/trunk /openstack-compute/admin/content/adding-images.html 中指定的常用操作系统分发名称
--owner <OWNER>
镜像的所有者
--ramdisk-id <RAMDISK_ID>
存储在 Glance 中的映像 ID,在引导 AMI 式镜像时应用作 ramdisk。
--min-ram <MIN_RAM>
引导镜像所需的 RAM 量(以 MB 为单位)。
--Container-format <CONTAINER_FORMAT>
容器 Valid 值的格式: ami, ari, aki, bare, ovf, ova
--property <key=value>
与镜像关联的任意属性。可以多次使用。
--remove-property
从镜像中删除的任意属性的关键名称。

8.4.10. Glance image-upload (v2)

usage: glance --os-image-api-version 2 image-upload [--file <FILE>] [--size <IMAGE_SIZE>] [--progress] <IMAGE_ID>
Copy to Clipboard Toggle word wrap
上传特定镜像的数据。

positional 参数

<IMAGE_ID>
要上传数据的镜像的 ID。

可选参数

--file <FILE>
包含要上传的磁盘镜像的本地文件。或者,可以通过 stdin 传递给客户端。
--size <IMAGE_SIZE>
要上传的镜像的大小(以字节为单位)。默认为从提供的数据对象获取大小,但在无法推断大小时被支持。
--progress
显示上传进度条。

8.4.11. glance location-add (v2)

usage: glance --os-image-api-version 2 location-add --url <URL> [--metadata <STRING>] <ID>
Copy to Clipboard Toggle word wrap
向镜像添加位置(和相关元数据)。

positional 参数

<ID>
要添加位置的镜像 ID。

可选参数

--url <URL>
要添加的位置的 URL。
--metadata <STRING>
与位置关联的元数据。必须是有效的 JSON 对象(默认:{})

8.4.12. glance location-delete (v2)

usage: glance --os-image-api-version 2 location-delete --url <URL> <ID>
Copy to Clipboard Toggle word wrap
从镜像中删除位置(和相关元数据)。

positional 参数

<ID>
要删除其位置的镜像 ID。

可选参数

--url <URL>
要删除的位置的 URL。可以多次使用。

8.4.13. glance location-update (v2)

usage: glance --os-image-api-version 2 location-update --url <URL> [--metadata <STRING>] <ID>
Copy to Clipboard Toggle word wrap
更新镜像位置的元数据。

positional 参数

<ID>
要更新位置的镜像 ID。

可选参数

--url <URL>
要更新的位置 URL。
--metadata <STRING>
与位置关联的元数据。必须是有效的 JSON 对象(默认:{})

8.4.14. glance md-namespace-create (v2)

usage: glance --os-image-api-version 2 md-namespace-create <NAMESPACE> <unavailable>
Copy to Clipboard Toggle word wrap
创建新的元数据定义命名空间。

positional 参数

<NAMESPACE>
命名空间的名称。
<unavailable>
请使用设置连接参数运行,以检索用于为此命令生成帮助的模式

8.4.15. glance md-namespace-delete (v2)

usage: glance --os-image-api-version 2 md-namespace-delete <NAMESPACE>
Copy to Clipboard Toggle word wrap
使用其内容删除指定的元数据定义命名空间。

positional 参数

<NAMESPACE>
要删除的命名空间的名称。

8.4.16. glance md-namespace-import (v2)

usage: glance --os-image-api-version 2 md-namespace-import [--file <FILEPATH>]
Copy to Clipboard Toggle word wrap
从文件或标准输入中导入元数据定义命名空间。

可选参数

--file <FILEPATH>
带有要导入的命名空间模式的文件路径。另外,命名空间架构可以通过 stdin 传递给客户端。

8.4.17. glance md-namespace-list (v2)

usage: glance --os-image-api-version 2 md-namespace-list [--resource-types <RESOURCE_TYPES>] [--visibility <VISIBILITY>] [--page-size <SIZE>]
Copy to Clipboard Toggle word wrap
列出元数据定义命名空间。

可选参数

--resource-types <RESOURCE_TYPES>
用于过滤命名空间的资源类型。
--visibility <VISIBILITY>
过滤命名空间的可见性参数。
--page-size <SIZE>
在每个分页请求中请求的命名空间数量。

8.4.18. glance md-namespace-objects-delete (v2)

usage: glance --os-image-api-version 2 md-namespace-objects-delete <NAMESPACE>
Copy to Clipboard Toggle word wrap
删除特定命名空间中的所有元数据定义对象。

positional 参数

<NAMESPACE>
命名空间的名称。

8.4.19. glance md-namespace-properties-delete (v2)

usage: glance --os-image-api-version 2 md-namespace-properties-delete <NAMESPACE>
Copy to Clipboard Toggle word wrap
删除特定命名空间中的所有元数据定义属性。

positional 参数

<NAMESPACE>
命名空间的名称。

8.4.20. glance md-namespace-resource-type-list (v2)

usage: glance --os-image-api-version 2 md-namespace-resource-type-list <NAMESPACE>
Copy to Clipboard Toggle word wrap
列出与特定命名空间关联的资源类型。

positional 参数

<NAMESPACE>
命名空间的名称。

8.4.21. glance md-namespace-show (v2)

usage: glance --os-image-api-version 2 md-namespace-show [--resource-type <RESOURCE_TYPE>] [--max-column-width <integer>] <NAMESPACE>
Copy to Clipboard Toggle word wrap
描述特定的元数据定义命名空间。也列出命名空间属性、对象和资源类型关联。

positional 参数

<NAMESPACE>
要描述的命名空间的名称。

可选参数

--resource-type <RESOURCE_TYPE>
将与命名空间关联的资源类型的前缀应用到命名空间的所有属性。
--max-column-width <integer>
打印表的最大列宽度。

8.4.22. glance md-namespace-tags-delete (v2)

usage: glance --os-image-api-version 2 md-namespace-tags-delete <NAMESPACE>
Copy to Clipboard Toggle word wrap
删除特定命名空间中的所有元数据定义标签。

positional 参数

<NAMESPACE>
命名空间的名称。

8.4.23. glance md-namespace-update (v2)

usage: glance --os-image-api-version 2 md-namespace-update <NAMESPACE> <unavailable>
Copy to Clipboard Toggle word wrap
更新现有元数据定义命名空间。

positional 参数

<NAMESPACE>
要更新的命名空间名称。
<unavailable>
请使用设置连接参数运行,以检索用于为此命令生成帮助的模式

8.4.24. glance md-object-create (v2)

usage: glance --os-image-api-version 2 md-object-create --name <NAME> --schema <SCHEMA> <NAMESPACE>
Copy to Clipboard Toggle word wrap
在命名空间内创建新的元数据定义对象。

positional 参数

<NAMESPACE>
对象将属于的命名空间的名称。

可选参数

--name <NAME>
对象的内部名称。
--schema <SCHEMA>
对象的有效 JSON 模式。

8.4.25. Glance md-object-delete (v2)

usage: glance --os-image-api-version 2 md-object-delete <NAMESPACE> <OBJECT>
Copy to Clipboard Toggle word wrap
删除命名空间中的特定元数据定义对象。

positional 参数

<NAMESPACE>
对象所属命名空间的名称。
<OBJECT>
对象的名称。

8.4.26. glance md-object-list (v2)

usage: glance --os-image-api-version 2 md-object-list <NAMESPACE>
Copy to Clipboard Toggle word wrap
列出特定命名空间中的元数据定义对象。

positional 参数

<NAMESPACE>
命名空间的名称。

8.4.27. glance md-object-property-show (v2)

usage: glance --os-image-api-version 2 md-object-property-show [--max-column-width <integer>] <NAMESPACE> <OBJECT> <PROPERTY>
Copy to Clipboard Toggle word wrap
描述对象中的特定元数据定义属性。

positional 参数

<NAMESPACE>
对象所属命名空间的名称。
<OBJECT>
对象的名称。
<PROPERTY>
属性的名称。

可选参数

--max-column-width <integer>
打印表的最大列宽度。

8.4.28. glance md-object-show (v2)

usage: glance --os-image-api-version 2 md-object-show [--max-column-width <integer>] <NAMESPACE> <OBJECT>
Copy to Clipboard Toggle word wrap
描述命名空间中的特定元数据定义对象。

positional 参数

<NAMESPACE>
对象所属命名空间的名称。
<OBJECT>
对象的名称。

可选参数

--max-column-width <integer>
打印表的最大列宽度。

8.4.29. glance md-object-update (v2)

usage: glance --os-image-api-version 2 md-object-update [--name <NAME>] [--schema <SCHEMA>] <NAMESPACE> <OBJECT>
Copy to Clipboard Toggle word wrap
更新命名空间内的元数据定义对象。

positional 参数

<NAMESPACE>
对象所属命名空间的名称。
<OBJECT>
对象的名称。

可选参数

--name <NAME>
对象的新名称。
--schema <SCHEMA>
对象的有效 JSON 模式。

8.4.30. glance md-property-create (v2)

usage: glance --os-image-api-version 2 md-property-create --name <NAME> --title <TITLE> --schema <SCHEMA> <NAMESPACE>
Copy to Clipboard Toggle word wrap
在命名空间内创建新的元数据定义属性。

positional 参数

<NAMESPACE>
属性将属于的命名空间的名称。

可选参数

--name <NAME>
属性的内部名称。
--title <TITLE>
显示给用户的属性名称。
--schema <SCHEMA>
属性的有效 JSON 模式。

8.4.31. glance md-property-delete (v2)

usage: glance --os-image-api-version 2 md-property-delete <NAMESPACE> <PROPERTY>
Copy to Clipboard Toggle word wrap
删除命名空间中的特定元数据定义属性。

positional 参数

<NAMESPACE>
属性所属命名空间的名称。
<PROPERTY>
属性的名称。

8.4.32. glance md-property-list (v2)

usage: glance --os-image-api-version 2 md-property-list <NAMESPACE>
Copy to Clipboard Toggle word wrap
列出特定命名空间中的元数据定义属性。

positional 参数

<NAMESPACE>
命名空间的名称。

8.4.33. glance md-property-show (v2)

usage: glance --os-image-api-version 2 md-property-show [--max-column-width <integer>] <NAMESPACE> <PROPERTY>
Copy to Clipboard Toggle word wrap
描述命名空间中的特定元数据定义属性。

positional 参数

<NAMESPACE>
属性所属命名空间的名称。
<PROPERTY>
属性的名称。

可选参数

--max-column-width <integer>
打印表的最大列宽度。

8.4.34. glance md-property-update (v2)

usage: glance --os-image-api-version 2 md-property-update [--name <NAME>] [--title <TITLE>] [--schema <SCHEMA>] <NAMESPACE> <PROPERTY>
Copy to Clipboard Toggle word wrap
更新命名空间中的元数据定义属性。

positional 参数

<NAMESPACE>
属性所属命名空间的名称。
<PROPERTY>
属性的名称。

可选参数

--name <NAME>
属性的新名称。
--title <TITLE>
显示给用户的属性名称。
--schema <SCHEMA>
属性的有效 JSON 模式。

8.4.35. Glance md-resource-type-associate (v2)

usage: glance --os-image-api-version 2 md-resource-type-associate <NAMESPACE> <unavailable>
Copy to Clipboard Toggle word wrap
将资源类型与元数据定义命名空间关联。

positional 参数

<NAMESPACE>
命名空间的名称。
<unavailable>
请使用设置连接参数运行,以检索用于为此命令生成帮助的模式

8.4.36. glance md-resource-type-deassociate (v2)

usage: glance --os-image-api-version 2 md-resource-type-deassociate <NAMESPACE> <RESOURCE_TYPE>
Copy to Clipboard Toggle word wrap
将资源类型与元数据定义命名空间关联。

positional 参数

<NAMESPACE>
命名空间的名称。
<RESOURCE_TYPE>
资源类型的名称。

8.4.37. glance md-resource-type-list (v2)

usage: glance --os-image-api-version 2 md-resource-type-list
Copy to Clipboard Toggle word wrap
列出可用的资源类型名称。为 v1 help 运行 'glance --os-image-api-version 1 help md-resource-type-list'

8.4.38. Glance md-tag-create (v2)

usage: glance --os-image-api-version 2 md-tag-create --name <NAME> <NAMESPACE>
Copy to Clipboard Toggle word wrap
在命名空间中添加新的元数据定义标签。

positional 参数

<NAMESPACE>
标签所属命名空间的名称。

可选参数

--name <NAME>
要添加的新标签的名称。

8.4.39. glance md-tag-create-multiple (v2)

usage: glance --os-image-api-version 2 md-tag-create-multiple --names <NAMES> [--delim <DELIM>] <NAMESPACE>
Copy to Clipboard Toggle word wrap
在命名空间内创建新的元数据定义标签。

positional 参数

<NAMESPACE>
标签要属于的命名空间的名称。

可选参数

--names <NAMES>
以逗号分隔的标签名称列表。
--delim <DELIM>
用于分隔名称的分隔符(如果没有提供,则默认为逗号)。

8.4.40. Glance md-tag-delete (v2)

usage: glance --os-image-api-version 2 md-tag-delete <NAMESPACE> <TAG>
Copy to Clipboard Toggle word wrap
删除命名空间中的特定元数据定义标签。

positional 参数

<NAMESPACE>
标签所属命名空间的名称。
<TAG>
标签的名称。

8.4.41. glance md-tag-list (v2)

usage: glance --os-image-api-version 2 md-tag-list <NAMESPACE>
Copy to Clipboard Toggle word wrap
列出特定命名空间中的元数据定义标签。

positional 参数

<NAMESPACE>
命名空间的名称。

8.4.42. Glance md-tag-show (v2)

usage: glance --os-image-api-version 2 md-tag-show <NAMESPACE> <TAG>
Copy to Clipboard Toggle word wrap
描述命名空间中的特定元数据定义标签。

positional 参数

<NAMESPACE>
标签所属命名空间的名称。
<TAG>
标签的名称。

8.4.43. Glance md-tag-update (v2)

usage: glance --os-image-api-version 2 md-tag-update --name <NAME> <NAMESPACE> <TAG>
Copy to Clipboard Toggle word wrap
重命名命名空间中的元数据定义标签。

positional 参数

<NAMESPACE>
标签所属命名空间的名称。
<TAG>
旧标签的名称。

可选参数

--name <NAME>
新标签的新名称。

8.4.44. glance member-create (v2)

usage: glance --os-image-api-version 2 member-create <IMAGE_ID> <MEMBER_ID>
Copy to Clipboard Toggle word wrap
为给定镜像创建成员。

positional 参数

<IMAGE_ID>
要创建成员的镜像。
<MEMBER_ID>
要添加为成员的租户。

8.4.45. Glance member-delete (v2)

usage: glance --os-image-api-version 2 member-delete <IMAGE_ID> <MEMBER_ID>
Copy to Clipboard Toggle word wrap
删除镜像成员。

positional 参数

<IMAGE_ID>
从中删除成员的镜像。
<MEMBER_ID>
要作为成员删除的租户。

8.4.46. glance member-list (v2)

usage: glance --os-image-api-version 2 member-list --image-id <IMAGE_ID>
Copy to Clipboard Toggle word wrap
描述镜像共享权限。

可选参数

--image-id <IMAGE_ID>
镜像以显示.

8.4.47. Glance member-update (v2)

usage: glance --os-image-api-version 2 member-update <IMAGE_ID> <MEMBER_ID> <MEMBER_STATUS>
Copy to Clipboard Toggle word wrap
更新给定镜像的成员的状态。

positional 参数

<IMAGE_ID>
从中更新成员的镜像。
<MEMBER_ID>
要更新的租户。
<MEMBER_STATUS>
更新了成员状态。有效值: accepted, rejected, pending

8.4.48. glance task-create (v2)

usage: glance --os-image-api-version 2 task-create [--type <TYPE>] [--input <STRING>]
Copy to Clipboard Toggle word wrap
创建新任务。

可选参数

--type <TYPE>
任务类型。请参阅 Glance 架构或文档,以了解支持哪些任务。
--input <STRING>
要启动的任务的参数

8.4.49. glance task-list (v2)

usage: glance --os-image-api-version 2 task-list [--sort-key {id,type,status}] [--sort-dir {asc,desc}] [--page-size <SIZE>] [--type <TYPE>] [--status <STATUS>]
Copy to Clipboard Toggle word wrap
列出您可以访问的任务。

可选参数

--sort-key {id,type,status}
根据指定字段对任务列表进行排序。
--sort-dir {asc,desc}
在指定方向排序任务列表。
--page-size <SIZE>
每个分页请求中请求的任务数量。
--type <TYPE>
将任务过滤为具有此类型的那些任务。
--status <STATUS>
将任务过滤到具有此状态的用户。

8.4.50. glance task-show (v2)

usage: glance --os-image-api-version 2 task-show <TASK_ID>
Copy to Clipboard Toggle word wrap
描述特定任务。

positional 参数

<TASK_ID>
要描述的任务 ID。

8.5. 镜像服务属性键

以下键与特定于它们的组件一起可用于 glance image-updateglance image-create 命令的 property 选项。例如:
$ glance image-update IMG-UUID --property architecture=x86_64
Copy to Clipboard Toggle word wrap
注意
使用镜像属性设置的行为会覆盖使用类别设置的行为。如需更多信息,请参阅 Red Hat OpenStack Platform Cloud Admin Guide
Expand
表 8.1. 属性键
特定于 描述 支持的值
All 架构 管理程序必须支持的 CPU 架构。例如,x86_64,arm, 或 ppc64。运行 uname -m 以获取机器的架构。我们强烈建议您使用 libosinfo 项目 定义的架构数据词汇。
All hypervisor_type 管理程序类型。 Xen,qemu,kvm,lxc,uml,vmware, 或 hyperv
All instance_uuid 对于快照镜像,这是用于创建此镜像的服务器的 UUID。 有效服务器 UUID
All kernel_id 存储在镜像服务中的镜像的 ID,在引导 AMI 风格镜像时应用作内核。 有效镜像 ID
All os_distro 小写的操作系统分布的通用名称(使用与 libosinfo 项目相同的数据词汇)。仅为此字段指定可识别的值。列出已弃用的值,以帮助您搜索可识别的值。
  • 存档Linux.不要使用 archlinuxorg.archlinux
  • CentOS-Community 企业操作系统.不要使用 org.centosCentOS
  • Debian-Debian.不要使用 Debianorg.debian
  • Fedora-Fedora.不要使用 Fedoraorg.fedoraorg.fedoraproject
  • FreeBSD-FreeBSD。不要使用 org.freebsdfreeBSDFreeBSD
  • gentoo-Gentoo Linux。不要使用 Gentooorg.gentoo
  • mandrake-Mandrakelinux (MandrakeSoft)发行版.不要使用 mandrakelinuxMandrakeLinux
  • mandriva-Mandriva Linux.不要使用 mandrivalinux
  • mes-Mandriva Enterprise Server.不要使用 mandrivaentmandrivaES
  • msdos-Microsoft Disc Operating System.不要使用 ms-dos
  • netbsd—NetBSD.不要使用 NetBSDorg.netbsd
  • Netware-Novell NetWare.不要使用 novellNetWare
  • openbsd- 打开BSD。不要使用 OpenBSDorg.openbsd
  • Open optimize-OpenSolaris.不要使用 Open swig org.open swig
  • OpenSuse-openSUSE.不要使用 suseSuSEorg.opensuse
  • rhel-Red Hat Enterprise Linux.不要使用 redhat、RedHatcom.redhat
  • SLED-SUSE Linux Enterprise Desktop.不要使用 com.suse
  • Ubuntu-Ubuntu.不要使用 Ubuntucom.ubuntuorg.ubuntu规范
  • Windows-Microsoft Windows.不要使用 com.microsoft.server
All os_version 根据经销商指定的操作系统版本。 版本号(例如:"11.10")
All ramdisk_id 存储在镜像服务中的镜像的 ID,在引导 AMI 风格镜像时应用作 ramdisk。 有效镜像 ID
All vm_mode 虚拟机模式。这代表了用于虚拟机的主机/guest ABI (应用程序二进制接口)。
  • Hvm-完全虚拟化.这是 QEMU 和 KVM 使用的模式。
  • Xen-Xen 3.0 半虚拟化.
  • UML-User 模式 Linux 半虚拟化.
  • 容器中的 exe-Executables。这是 LXC 使用的模式。
libvirt API 驱动程序 hw_disk_bus 指定要附加磁盘设备的磁盘控制器类型。 scsi 之一:virtioumlxenideusb
libvirt API 驱动程序
hw_rng_model
在镜像的实例中添加随机数生成器设备。云管理员可通过配置实例的类别来启用和控制设备行为。默认情况下:
  • 生成器设备被禁用。
  • /dev/random 用作默认熵源。要指定物理 HW RNG 设备,在 nova.conf 文件中使用以下选项:
    rng_dev_path=/dev/hwrng
    Copy to Clipboard Toggle word wrap
VirtIO,或其他支持的设备。
libvirt API 驱动程序 hw_machine_type 启用使用指定的机器类型引导 ARM 系统。默认情况下,如果使用 ARM 镜像并且未指定类型,Compute 将使用 vexpress-a15 (ARMv7)或 virt (用于 AArch64)机器类型。 libvirt 机器类型。可以使用 virsh capabilities 命令查看有效类型(机器标签中会显示 机器类型 )。
libvirt API 驱动程序 hw_scsi_model 启用 VirtIO SCSI (virtio-scsi)来为计算实例提供块设备访问;默认情况下,实例使用 VirtIO 块(virtio-blk)。VirtIO SCSI 是一个半虚拟化 SCSI 控制器设备,它提高了可扩展性和性能,并支持高级 SCSI 硬件。 virtio-scsi
libvirt API 驱动程序 hw_video_model 使用的视频图像驱动程序。 VGA,cirrus,vmvga,xen, 或 qxl
libvirt API 驱动程序 hw_video_ram 视频镜像的最大 RAM。仅在类别的 extra_specs 中设置 hw_video:ram_max_mb 值并且该值高于 hw_video_ram 中设置的值时使用。 以 MB 为单位的整数(例如 '64')
libvirt API 驱动程序 hw_watchdog_action 启用虚拟硬件 watchdog 设备,在服务器挂起时执行指定操作。watchdog 使用 i6300esb 设备(模拟 PCI Intel 6300ESB)。如果没有指定 hw_watchdog_action,则禁用 watchdog。
  • disabled-(default)该设备没有附加。允许用户禁用镜像的 watchdog,即使已使用镜像的类别启用了它。
  • 重置客户机。
  • poweroff-Forcefully 关闭客户机。
  • 暂停 guest。
  • none-Only 启用 watchdog;如果服务器挂起,什么都不做。
libvirt API 驱动程序 os_command_line libvirt 驱动程序使用的内核命令行,而不是默认。对于 Linux 容器(LXC),其值用作初始化的参数。这个密钥只适用于 Amazon 内核、ramdisk 或机器镜像(aki、ari 或 ami)。
libvirt API 驱动程序和 VMware API 驱动程序 hw_vif_model 指定要使用的虚拟网络接口设备的型号。
有效选项取决于配置的虚拟机监控程序。
  • KVM 和 QEMU: e1000ne2k_pcipcnetrtl8139virtio.
  • VMware: e1000e1000eVirtualE1000 e、VirtualE1000eVirtualPCNet32VirtualSriovEthernetCard、和 VirtualVmxnet.
  • Xen: e1000,netfront,ne2k_pci,pcnet, 和 rtl8139.
VMware API 驱动程序 vmware_adaptertype 管理程序使用的虚拟 SCSI 或 IDE 控制器。 lsiLogic,busLogic, 或 ide
VMware API 驱动程序 vmware_ostype VMware GuestID,用于描述在镜像中安装的操作系统。这个值在创建虚拟机时传递给虚拟机监控程序。如果没有指定,则密钥默认为 otherGuest 请参见 thinkvirt.com
VMware API 驱动程序 vmware_image_version 当前未使用。 1
xenapi 驱动程序 auto_disk_config 如果为 true,则在实例引导前,磁盘上的根分区会自动调整大小。只有使用带有 XenAPI 驱动程序的基于 Xen 的 hypervisor 时,计算服务才会考虑该值。只有映像上只有一个分区,并且仅当分区采用 ext3ext4 格式时,计算服务才会尝试调整大小。 true | false
xenapi 驱动程序 os_type 在镜像上安装的操作系统。XenAPI 驱动程序包含根据镜像的 os_type 参数的值来采取不同操作的逻辑。例如,对于 os_type=windows 镜像,它会创建一个基于 FAT32 的交换分区而不是 Linux swap 分区,并将注入的主机名限制为小于 16 个字符。 linuxwindows

第 9 章 网络服务命令行客户端

neutron 客户端是网络服务 API 及其扩展的命令行界面(CLI)。本章记录了 neutron 版本 3.1.0
如需特定 neutron 命令的帮助信息,请输入:
$ neutron help COMMAND
Copy to Clipboard Toggle word wrap

9.1. Neutron 用法

usage: neutron [--version] [-v] [-q] [-h] [-r NUM] [--os-service-type <os-service-type>] [--os-endpoint-type <os-endpoint-type>] [--service-type <service-type>] [--endpoint-type <endpoint-type>] [--os-auth-strategy <auth-strategy>] [--os-auth-url <auth-url>] [--os-tenant-name <auth-tenant-name> | --os-project-name <auth-project-name>] [--os-tenant-id <auth-tenant-id> | --os-project-id <auth-project-id>] [--os-username <auth-username>] [--os-user-id <auth-user-id>] [--os-user-domain-id <auth-user-domain-id>] [--os-user-domain-name <auth-user-domain-name>] [--os-project-domain-id <auth-project-domain-id>] [--os-project-domain-name <auth-project-domain-name>] [--os-cert <certificate>] [--os-cacert <ca-certificate>] [--os-key <key>] [--os-password <auth-password>] [--os-region-name <auth-region-name>] [--os-token <token>] [--http-timeout <seconds>] [--os-url <url>] [--insecure]
Copy to Clipboard Toggle word wrap

9.2. Neutron 可选参数

--version
显示程序的版本号并退出
-v, --verbose, --debug
提高输出的详细程度,并显示错误的回溯。您可以重复这个选项。
-q, --quiet
抑制输出,除了警告和错误外。
-h, --help
显示帮助信息并退出。
-r NUM, --retries NUM
如果请求失败,应该重试对 Neutron 服务器的请求的次数。
--os-service-type <os-service-type>
默认为 env[OS_NETWORK_SERVICE_TYPE] 或网络。
--os-endpoint-type <os-endpoint-type>
默认为 env[OS_ENDPOINT_TYPE] 或 publicURL。
--service-type <service-type>
弃用!使用 --os-service-type。
--endpoint-type <endpoint-type>
弃用!使用 --os-endpoint-type。
--os-auth-strategy <auth-strategy>
弃用!仅支持 keystone。
--os-auth-url <auth-url>
身份验证 URL,默认为 env[OS_AUTH_URL]
--os-tenant-name <auth-tenant-name>
身份验证租户名称,默认为 env[OS_TENANT_NAME]
--os-project-name <auth-project-name>
指定租户名称的另一种方法。这个选项与 --os-tenant-name 相互排斥。默认为 env[OS_PROJECT_NAME]
--os-tenant-id <auth-tenant-id>
身份验证租户 ID,默认为 env[OS_TENANT_ID]
--os-project-id <auth-project-id>
指定租户 ID 的另一种方式。这个选项与 --os-tenant-id 相互排斥。默认为 env[OS_PROJECT_ID]
--os-username <auth-username>
身份验证用户名,默认为 env[OS_USERNAME]
--os-user-id <auth-user-id>
身份验证用户 ID (Env: OS_USER_ID)
--os-user-domain-id <auth-user-domain-id>
OpenStack 用户域 ID。默认为 env[OS_USER_DOMAIN_ID]
--os-user-domain-name <auth-user-domain-name>
OpenStack 用户域名。默认为 env[OS_USER_DOMAIN_NAME]
--os-project-domain-id <auth-project-domain-id>
默认为 env[OS_PROJECT_DOMAIN_ID]
--os-project-domain-name <auth-project-domain-name>
默认为 env[OS_PROJECT_DOMAIN_NAME]
--os-cert <certificate>
SSL 连接中使用的证书文件的路径。此文件可以选择使用私钥前添加。默认为 env[OS_CERT]
--os-cacert <ca-certificate>
指定用于验证 TLS (https)服务器证书中使用的 CA 捆绑包文件。默认为 env[OS_CACERT]
--os-key <key>
SSL 连接中使用的客户端密钥的路径。如果您的密钥在您的证书文件前面添加,则不需要这个选项。默认为 env[OS_KEY]
--os-password <auth-password>
身份验证密码,默认为 env[OS_PASSWORD]
--os-region-name <auth-region-name>
身份验证区域名称,默认为 env[OS_REGION_NAME]
--os-token <token>
身份验证令牌,默认为 env[OS_TOKEN]
--http-timeout <seconds>
等待 HTTP 响应超时(以秒为单位)。如果没有指定,则默认为 env[OS_NETWORK_TIMEOUT] 或 None。
--os-url <url>
默认为 env[OS_URL]
--insecure
明确允许 neutronclient 执行"不安全"SSL (https)请求。服务器的证书不会针对任何证书颁发机构进行验证。这个选项应谨慎使用。

9.3. Neutron API v2.0 命令

address-scope-create
为给定租户创建地址范围。
address-scope-delete
删除地址范围。
address-scope-list
列出属于给定租户的地址范围。
address-scope-show
显示有关地址范围的信息。
address-scope-update
更新地址范围。
agent-delete
删除给定的代理。
agent-list
列出代理。
agent-show
显示给定代理的信息。
agent-update
更新指定代理的 admin 状态和描述。
bash-completion
打印 bash 补全的所有命令和选项。
cisco-credential-create
创建凭证。
cisco-credential-delete
删除给定凭证。
cisco-credential-list
列出属于给定租户的凭据。
cisco-credential-show
显示给定凭证的信息。
cisco-network-profile-create
创建网络配置文件。
cisco-network-profile-delete
删除给定的网络配置文件。
cisco-network-profile-list
列出属于给定租户的网络配置文件。
cisco-network-profile-show
显示给定网络配置文件的信息。
cisco-network-profile-update
更新网络配置文件的信息。
cisco-policy-profile-list
列出属于给定租户的策略配置文件。
cisco-policy-profile-show
显示给定策略配置文件的信息。
cisco-policy-profile-update
更新策略配置文件的信息。
dhcp-agent-list-hosting-net
列出托管网络的 DHCP 代理。
dhcp-agent-network-add
将网络添加到 DHCP 代理。
dhcp-agent-network-remove
从 DHCP 代理中删除网络。
ext-list
列出所有扩展。
ext-show
显示给定资源的信息。
firewall-create
创建防火墙。
firewall-delete
删除给定防火墙。
firewall-list
列出属于给定租户的防火墙。
firewall-policy-create
创建防火墙策略。
firewall-policy-delete
删除给定的防火墙策略。
firewall-policy-insert-rule
将规则插入到给定的防火墙策略中。
firewall-policy-list
列出属于给定租户的防火墙策略。
firewall-policy-remove-rule
从给定的防火墙策略中删除规则。
firewall-policy-show
显示给定防火墙策略的信息。
firewall-policy-update
更新给定的防火墙策略。
firewall-rule-create
创建防火墙规则。
firewall-rule-delete
删除给定的防火墙规则。
firewall-rule-list
列出属于给定租户的防火墙规则。
firewall-rule-show
显示给定防火墙规则的信息。
firewall-rule-update
更新给定的防火墙规则。
firewall-show
显示给定防火墙的信息。
firewall-update
更新给定防火墙。
floatingip-associate
在浮动 IP 和固定 IP 之间创建映射。
floatingip-create
为给定租户创建一个浮动 IP。
floatingip-delete
删除给定的浮动 IP。
floatingip-disassociate
移除从浮动 IP 到固定 IP 的映射。
floatingip-list
列出属于给定租户的浮动 IP。
floatingip-show
显示给定浮动 IP 的信息。
gateway-device-create
创建网络网关设备。
gateway-device-delete
删除给定的网络网关设备。
gateway-device-list
列出给定租户的网络网关设备。
gateway-device-show
显示给定网络网关设备的信息。
gateway-device-update
更新网络网关设备。
帮助
输出另一个命令的详细帮助信息
ipsec-site-connection-create
创建 IPsec 站点连接。
ipsec-site-connection-delete
删除给定的 IPsec 站点连接。
ipsec-site-connection-list
列出属于给定租户的 IPsec 站点连接。
ipsec-site-connection-show
显示给定 IPsec 站点连接的信息。
ipsec-site-connection-update
更新给定的 IPsec 站点连接。
l3-agent-list-hosting-router
列出托管路由器的 L3 代理。
l3-agent-router-add
将路由器添加到 L3 代理。
l3-agent-router-remove
从 L3 代理移除路由器。
lb-agent-hosting-pool
获取托管池的 loadbalancer 代理。
lb-healthmonitor-associate
在运行状况监视器和池之间创建映射。
lb-healthmonitor-create
创建运行状况监控器。
lb-healthmonitor-delete
删除给定的运行状况监控器。
lb-healthmonitor-disassociate
从运行状况监视器删除到池的映射。
lb-healthmonitor-list
列出属于给定租户的运行状况监视器。
lb-healthmonitor-show
显示给定运行状况监视器的信息。
lb-healthmonitor-update
更新给定的运行状况监控器。
lb-member-create
创建成员。
lb-member-delete
删除给定成员。
lb-member-list
列出属于给定租户的成员。
lb-member-show
显示给定成员的信息。
lb-member-update
更新给定成员。
lb-pool-create
创建池。
lb-pool-delete
删除给定池。
lb-pool-list
列出属于给定租户的池。
lb-pool-list-on-agent
列出 loadbalancer 代理上的池。
lb-pool-show
显示给定池的信息。
lb-pool-stats
检索给定池的统计信息。
lb-pool-update
更新给定池。
lb-vip-create
创建 vip。
lb-vip-delete
删除给定的 vip。
lb-vip-list
列出属于给定租户的 vips。
lb-vip-show
显示给定 vip 的信息。
lb-vip-update
更新给定 vip。
lbaas-agent-hosting-loadbalancer
获取托管 loadbalancer 的 lbaas v2 代理。
lbaas-healthmonitor-create
LBaaS v2 创建运行状况monitor。
lbaas-healthmonitor-delete
LBaaS v2 删除给定的运行状况监视器。
lbaas-healthmonitor-list
LBaaS v2 列出属于给定租户的运行状况监视器。
LBaaS-healthmonitor-show
LBaaS v2 显示给定运行状况监视器的信息。
lbaas-healthmonitor-update
LBaaS v2 更新给定的运行状况监视器。
lbaas-listener-create
LBaaS v2 创建侦听器.
lbaas-listener-delete
LBaaS v2 删除给定的监听程序.
lbaas-listener-list
属于给定租户的 LBaaS v2 列表监听程序。
lbaas-listener-show
LBaaS v2 显示给定监听器的信息。
lbaas-listener-update
LBaaS v2 更新给定的监听程序。
lbaas-loadbalancer-create
LBaaS v2 创建负载均衡器.
lbaas-loadbalancer-delete
LBaaS v2 删除给定的负载均衡器。
lbaas-loadbalancer-list
属于给定租户的 LBaaS v2 列表负载均衡器。
lbaas-loadbalancer-list-on-agent
列出 loadbalancer v2 代理上的 loadbalancers。
lbaas-loadbalancer-show
LBaaS v2 显示给定负载均衡器的信息。
lbaas-loadbalancer-update
LBaaS v2 更新给定的负载均衡器。
lbaas-member-create
LBaaS v2 创建成员.
lbaas-member-delete
LBaaS v2 删除给定成员.
lbaas-member-list
属于给定池的 LBaaS v2 列表成员。
LBaaS-member-show
LBaaS v2 显示给定成员的信息。
lbaas-member-update
LBaaS v2 更新给定成员。
lbaas-pool-create
LBaaS v2 创建池.
lbaas-pool-delete
LBaaS v2 删除给定池。
lbaas-pool-list
属于给定租户的 LBaaS v2 列表池。
lbaas-pool-show
LBaaS v2 显示给定池的信息。
lbaas-pool-update
LBaaS v2 更新给定池。
meter-label-create
为给定租户创建 metering 标签。
meter-label-delete
删除给定的 metering 标签。
meter-label-list
列出属于给定租户的 metering 标签。
meter-label-rule-create
为给定标签创建 metering 标签规则。
meter-label-rule-delete
删除给定的 metering 标签。
meter-label-rule-list
列出属于给定标签的 metering 标签。
meter-label-rule-show
显示给定 metering 标签规则的信息。
meter-label-show
显示给定 metering 标签的信息。
net-create
为给定租户创建网络。
net-delete
删除给定网络。
net-external-list
列出属于给定租户的外部网络。
net-gateway-connect
添加内部网络接口到路由器。
net-gateway-create
创建网络网关。
net-gateway-delete
删除给定的网络网关。
net-gateway-disconnect
从网络网关移除网络。
net-gateway-list
列出给定租户的网络网关。
net-gateway-show
显示给定网络网关的信息。
net-gateway-update
更新网络网关的名称。
net-list
列出属于给定租户的网络。
net-list-on-dhcp-agent
列出 DHCP 代理上的网络。
net-show
显示给定网络的信息。
net-update
更新网络的信息。
nuage-netpartition-create
为给定租户创建 netpartition。
nuage-netpartition-delete
删除给定的 netpartition。
nuage-netpartition-list
列出属于给定租户的 netpartitions。
nuage-netpartition-show
显示给定 netpartition 的信息。
port-create
为给定租户创建端口。
port-delete
删除给定端口。
port-list
列出属于给定租户的端口。
port-show
显示给定端口的信息。
port-update
更新端口的信息。
qos-available-rule-types
列出可用的 qos 规则类型。
qos-bandwidth-limit-rule-create
创建 qos 带宽限制规则。
qos-bandwidth-limit-rule-delete
删除给定的 qos 带宽限制规则。
qos-bandwidth-limit-rule-list
列出属于指定策略的所有 qos 带宽限制规则。
qos-bandwidth-limit-rule-show
显示有关给定 qos 带宽限制规则的信息。
qos-bandwidth-limit-rule-update
更新给定的 qos 带宽限制规则。
qos-policy-create
创建 qos 策略。
qos-policy-delete
删除给定的 qos 策略。
qos-policy-list
列出属于给定租户连接的 QoS 策略。
qos-policy-show
显示给定 qos 策略的信息。
qos-policy-update
更新给定的 qos 策略。
queue-create
创建队列。
queue-delete
删除给定队列。
queue-list
列出属于给定租户的队列。
queue-show
显示给定队列的信息。
quota-delete
删除给定租户定义的配额。
quota-list
列出所有具有非默认配额值的租户的配额。
quota-show
显示给定租户的配额。
quota-update
定义租户的配额不使用默认值。
rbac-create
为给定租户创建 RBAC 策略。
rbac-delete
删除 RBAC 策略。
rbac-list
列出属于给定租户的 RBAC 策略。
rbac-show
显示给定 RBAC 策略的信息。
rbac-update
更新给定租户的 RBAC 策略。
router-create
为给定租户创建路由器。
router-delete
删除给定的路由器。
router-gateway-clear
从路由器移除外部网络网关。
router-gateway-set
设置路由器的外部网络网关。
router-interface-add
添加内部网络接口到路由器。
router-interface-delete
从路由器移除内部网络接口。
router-list
列出属于给定租户的路由器。
router-list-on-l3-agent
列出 L3 代理上的路由器。
router-port-list
列出属于给定租户的端口,具有指定路由器。
router-show
显示给定路由器的信息。
router-update
更新路由器的信息。
security-group-create
创建安全组。
security-group-delete
删除给定的安全组。
security-group-list
列出属于给定租户的安全组。
security-group-rule-create
创建安全组规则。
security-group-rule-delete
删除给定的安全组规则。
security-group-rule-list
列出属于给定租户的安全组规则。
security-group-rule-show
显示给定安全组规则的信息。
security-group-show
显示给定安全组的信息。
security-group-update
更新给定的安全组。
service-provider-list
列出服务供应商。
subnet-create
为给定租户创建子网。
subnet-delete
删除给定子网。
subnet-list
列出属于给定租户的子网。
subnet-show
显示给定子网的信息。
subnet-update
更新子网的信息。
subnetpool-create
为给定租户创建一个 subnetpool。
subnetpool-delete
删除给定的 subnetpool。
subnetpool-list
列出属于给定租户的 subnetpools。
subnetpool-show
显示给定 subnetpool 的信息。
subnetpool-update
更新 subnetpool 的信息。
vpn-ikepolicy-create
创建 IKE 策略。
vpn-ikepolicy-delete
删除给定的 IKE 策略。
vpn-ikepolicy-list
列出属于租户的 IKE 策略。
vpn-ikepolicy-show
显示给定 IKE 策略的信息。
vpn-ikepolicy-update
更新给定的 IKE 策略。
vpn-ipsecpolicy-create
创建 IPsec 策略。
vpn-ipsecpolicy-delete
删除给定的 IPsec 策略。
vpn-ipsecpolicy-list
列出属于给定租户连接的 IPsec 策略。
vpn-ipsecpolicy-show
显示给定 IPsec 策略的信息。
vpn-ipsecpolicy-update
更新给定的 IPsec 策略。
vpn-service-create
创建 VPN 服务。
vpn-service-delete
删除给定的 VPN 服务。
vpn-service-list
列出属于给定租户的 VPN 服务配置。
VPN-service-show
显示给定 VPN 服务的信息。
vpn-service-update
更新给定的 VPN 服务。

9.4. neutron address-scope-create

usage: neutron address-scope-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--shared] name
Copy to Clipboard Toggle word wrap
为给定租户创建地址范围。

positional 参数

名称
指定地址范围的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--shared
将地址范围设置为 shared。

9.5. neutron address-scope-delete

usage: neutron address-scope-delete [-h] [--request-format {json,xml}] ADDRESS_SCOPE
Copy to Clipboard Toggle word wrap
删除地址范围。

positional 参数

ADDRESS_SCOPE
要删除的 address_scope 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.6. neutron address-scope-list

usage: neutron address-scope-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
列出属于给定租户的地址范围。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.7. neutron address-scope-show

usage: neutron address-scope-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] ADDRESS_SCOPE
Copy to Clipboard Toggle word wrap
显示有关地址范围的信息。

positional 参数

ADDRESS_SCOPE
要查找的 ID 或 address_scope 的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.8. neutron address-scope-update

usage: neutron address-scope-update [-h] [--request-format {json,xml}] [--name NAME] ADDRESS_SCOPE
Copy to Clipboard Toggle word wrap
更新地址范围。

positional 参数

ADDRESS_SCOPE
要更新的 address_scope 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--name NAME
要更新的地址范围的名称。

9.9. neutron agent-delete

usage: neutron agent-delete [-h] [--request-format {json,xml}] AGENT
Copy to Clipboard Toggle word wrap
删除给定的代理。

positional 参数

AGENT
要删除的代理 ID。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.10. neutron agent-list

usage: neutron agent-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
列出代理。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.11. neutron agent-show

usage: neutron agent-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] AGENT
Copy to Clipboard Toggle word wrap
显示给定代理的信息。

positional 参数

AGENT
要查找的代理 ID。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.12. neutron agent-update

usage: neutron agent-update [-h] [--request-format {json,xml}] [--admin-state-down] [--description DESCRIPTION] AGENT
Copy to Clipboard Toggle word wrap
更新指定代理的 admin 状态和描述。

positional 参数

AGENT
要更新的代理 ID。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--admin-state-down
将代理的 admin 状态设置为 false。
--description DESCRIPTION
代理的描述。

9.13. neutron cisco-credential-create

usage: neutron cisco-credential-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--username USERNAME] [--password PASSWORD] credential_name credential_type
Copy to Clipboard Toggle word wrap
创建凭证。

positional 参数

credential_name
凭证的名称/IP 地址。
credential_type
凭据的类型。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--username USERNAME
凭证的用户名。
--password PASSWORD
凭据的密码。

9.14. neutron cisco-credential-delete

usage: neutron cisco-credential-delete [-h] [--request-format {json,xml}] CREDENTIAL
Copy to Clipboard Toggle word wrap
删除给定凭证。

positional 参数

凭证
要删除的凭证的 ID。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.15. neutron cisco-credential-list

usage: neutron cisco-credential-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD]
Copy to Clipboard Toggle word wrap
列出属于给定租户的凭据。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.16. neutron cisco-credential-show

usage: neutron cisco-credential-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] CREDENTIAL
Copy to Clipboard Toggle word wrap
显示给定凭证的信息。

positional 参数

凭证
要查找的凭证 ID。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.17. neutron cisco-network-profile-create

usage: neutron cisco-network-profile-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--sub_type SUB_TYPE] [--segment_range SEGMENT_RANGE] [--physical_network PHYSICAL_NETWORK] [--multicast_ip_range MULTICAST_IP_RANGE] [--add-tenant ADD_TENANTS] name {vlan,overlay,multi-segment,trunk}
Copy to Clipboard Toggle word wrap
创建网络配置文件。

positional 参数

名称
网络配置文件的名称。
{vlan,overlay,multi-segment,trunk}
片段类型。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--sub_type SUB_TYPE
片段的子类型。适用于 overlay 片段的可用子类型:原生的增强;对于中继片段:vlan、overlay。
--segment_range SEGMENT_RANGE
网段的范围。
--physical_network PHYSICAL_NETWORK
物理网络的名称。
--multicast_ip_range MULTICAST_IP_RANGE
多播 IPv4 范围。
--add-tenant ADD_TENANTS
将租户添加到网络配置文件。您可以重复这个选项。

9.18. neutron cisco-network-profile-delete

usage: neutron cisco-network-profile-delete [-h] [--request-format {json,xml}] NETWORK_PROFILE
Copy to Clipboard Toggle word wrap
删除给定的网络配置文件。

positional 参数

NETWORK_PROFILE
要删除的 network_profile 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.19. neutron cisco-network-profile-list

usage: neutron cisco-network-profile-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD]
Copy to Clipboard Toggle word wrap
列出属于给定租户的网络配置文件。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.20. neutron cisco-network-profile-show

usage: neutron cisco-network-profile-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] NETWORK_PROFILE
Copy to Clipboard Toggle word wrap
显示给定网络配置文件的信息。

positional 参数

NETWORK_PROFILE
要查找的 network_profile 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.21. neutron cisco-network-profile-update

usage: neutron cisco-network-profile-update [-h] [--request-format {json,xml}] [--remove-tenant REMOVE_TENANTS] [--add-tenant ADD_TENANTS] NETWORK_PROFILE
Copy to Clipboard Toggle word wrap
更新网络配置文件的信息。

positional 参数

NETWORK_PROFILE
要更新的 network_profile 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--remove-tenant REMOVE_TENANTS
从网络配置文件移除租户。您可以重复这个选项。
--add-tenant ADD_TENANTS
将租户添加到网络配置文件。您可以重复这个选项。

9.22. neutron cisco-policy-profile-list

usage: neutron cisco-policy-profile-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD]
Copy to Clipboard Toggle word wrap
列出属于给定租户的策略配置文件。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.23. neutron cisco-policy-profile-show

usage: neutron cisco-policy-profile-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] POLICY_PROFILE
Copy to Clipboard Toggle word wrap
显示给定策略配置文件的信息。

positional 参数

POLICY_PROFILE
要查找的 policy_profile 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.24. neutron cisco-policy-profile-update

usage: neutron cisco-policy-profile-update [-h] [--request-format {json,xml}] POLICY_PROFILE
Copy to Clipboard Toggle word wrap
更新策略配置文件的信息。

positional 参数

POLICY_PROFILE
要更新的 policy_profile 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.25. neutron dhcp-agent-list-hosting-net

usage: neutron dhcp-agent-list-hosting-net [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] network
Copy to Clipboard Toggle word wrap
列出托管网络的 DHCP 代理。

positional 参数

network
要查询的网络。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.26. neutron dhcp-agent-network-add

usage: neutron dhcp-agent-network-add [-h] [--request-format {json,xml}] dhcp_agent network
Copy to Clipboard Toggle word wrap
将网络添加到 DHCP 代理。

positional 参数

dhcp_agent
DHCP 代理的 ID。
network
要添加的网络。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.27. neutron dhcp-agent-network-remove

usage: neutron dhcp-agent-network-remove [-h] [--request-format {json,xml}] dhcp_agent network
Copy to Clipboard Toggle word wrap
从 DHCP 代理中删除网络。

positional 参数

dhcp_agent
DHCP 代理的 ID。
network
要删除的网络。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.28. neutron ext-list

usage: neutron ext-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD]
Copy to Clipboard Toggle word wrap
列出所有扩展。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.29. neutron ext-show

usage: neutron ext-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] EXTENSION
Copy to Clipboard Toggle word wrap
显示给定资源的信息。

positional 参数

EXTENSION
要查找的扩展 ID。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.30. neutron firewall-create

usage: neutron firewall-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--name NAME] [--description DESCRIPTION] [--admin-state-down] [--router ROUTER] POLICY
Copy to Clipboard Toggle word wrap
创建防火墙。

positional 参数

POLICY
防火墙策略名称或 ID。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--name NAME
防火墙的名称。
--description DESCRIPTION
防火墙规则的描述。
--admin-state-down
将 admin state up 设置为 false。
--router ROUTER
防火墙关联的路由器名称或 ID (需要 FWaaS 路由器插入扩展,此选项可以重复)

9.31. neutron firewall-delete

usage: neutron firewall-delete [-h] [--request-format {json,xml}] FIREWALL
Copy to Clipboard Toggle word wrap
删除给定防火墙。

positional 参数

FIREWALL
要删除的防火墙的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.32. neutron firewall-list

usage: neutron firewall-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
列出属于给定租户的防火墙。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.33. neutron firewall-policy-create

usage: neutron firewall-policy-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--description DESCRIPTION] [--shared] [--firewall-rules FIREWALL_RULES] [--audited] NAME
Copy to Clipboard Toggle word wrap
创建防火墙策略。

positional 参数

NAME
防火墙策略的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--description DESCRIPTION
防火墙策略的描述。
--shared
创建共享策略。
--firewall-rules FIREWALL_RULES
空格分隔的防火墙规则名称或 ID 列表;例如,--firewall-rules "rule1 rule2"
--audited
将 audited 设置为 True。

9.34. neutron firewall-policy-delete

usage: neutron firewall-policy-delete [-h] [--request-format {json,xml}] FIREWALL_POLICY
Copy to Clipboard Toggle word wrap
删除给定的防火墙策略。

positional 参数

FIREWALL_POLICY
要删除的 firewall_policy 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.35. neutron firewall-policy-insert-rule

usage: neutron firewall-policy-insert-rule [-h] [--request-format {json,xml}] [--insert-before FIREWALL_RULE] [--insert-after FIREWALL_RULE] FIREWALL_POLICY FIREWALL_RULE
Copy to Clipboard Toggle word wrap
将规则插入到给定的防火墙策略中。

positional 参数

FIREWALL_POLICY
要更新的 firewall_policy 的 ID 或名称。
FIREWALL_RULE
要插入的新规则。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--insert-before FIREWALL_RULE
在此规则前插入。
--insert-after FIREWALL_RULE
在此规则后插入。

9.36. neutron firewall-policy-list

usage: neutron firewall-policy-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
列出属于给定租户的防火墙策略。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.37. neutron firewall-policy-remove-rule

usage: neutron firewall-policy-remove-rule [-h] [--request-format {json,xml}] FIREWALL_POLICY FIREWALL_RULE
Copy to Clipboard Toggle word wrap
从给定的防火墙策略中删除规则。

positional 参数

FIREWALL_POLICY
要更新的 firewall_policy 的 ID 或名称。
FIREWALL_RULE
从策略中删除的防火墙规则。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.38. neutron firewall-policy-show

usage: neutron firewall-policy-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] FIREWALL_POLICY
Copy to Clipboard Toggle word wrap
显示给定防火墙策略的信息。

positional 参数

FIREWALL_POLICY
要查找的 id 或 firewall_policy 的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.39. neutron firewall-policy-update

usage: neutron firewall-policy-update [-h] [--request-format {json,xml}] [--firewall-rules FIREWALL_RULES] FIREWALL_POLICY
Copy to Clipboard Toggle word wrap
更新给定的防火墙策略。

positional 参数

FIREWALL_POLICY
要更新的 firewall_policy 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--firewall-rules FIREWALL_RULES
空格分隔的防火墙规则名称或 ID 列表;例如,--firewall-rules "rule1 rule2"

9.40. neutron firewall-rule-create

usage: neutron firewall-rule-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--name NAME] [--description DESCRIPTION] [--shared] [--source-ip-address SOURCE_IP_ADDRESS] [--destination-ip-address DESTINATION_IP_ADDRESS] [--source-port SOURCE_PORT] [--destination-port DESTINATION_PORT] [--enabled {True,False}] --protocol {tcp,udp,icmp,any} --action {allow,deny,reject}
Copy to Clipboard Toggle word wrap
创建防火墙规则。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--name NAME
防火墙规则的名称。
--description DESCRIPTION
防火墙规则的描述。
--shared
将 shared 设置为 True (默认为 False)。
--source-ip-address SOURCE_IP_ADDRESS
源 IP 地址或子网。
--destination-ip-address DESTINATION_IP_ADDRESS
目标 IP 地址或子网。
--source-port SOURCE_PORT
源端口(整数为 [1, 65535] 或 range in a:b)。
--destination-port DESTINATION_PORT
目的地端口(整数为 [1, 65535] 或 a:b 范围)。
--enabled {True,False}
是否启用或禁用此规则。
--protocol {tcp,udp,icmp,any}
防火墙规则的协议。
--action {allow,deny,reject}
对防火墙规则的操作。

9.41. neutron firewall-rule-delete

usage: neutron firewall-rule-delete [-h] [--request-format {json,xml}] FIREWALL_RULE
Copy to Clipboard Toggle word wrap
删除给定的防火墙规则。

positional 参数

FIREWALL_RULE
要删除的 firewall_rule 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.42. neutron firewall-rule-list

usage: neutron firewall-rule-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
列出属于给定租户的防火墙规则。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.43. neutron firewall-rule-show

usage: neutron firewall-rule-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] FIREWALL_RULE
Copy to Clipboard Toggle word wrap
显示给定防火墙规则的信息。

positional 参数

FIREWALL_RULE
要查找的 firewall_rule 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.44. neutron firewall-rule-update

usage: neutron firewall-rule-update [-h] [--request-format {json,xml}] [--protocol {tcp,udp,icmp,any}] FIREWALL_RULE
Copy to Clipboard Toggle word wrap
更新给定的防火墙规则。

positional 参数

FIREWALL_RULE
要更新的 firewall_rule 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--protocol {tcp,udp,icmp,any}
防火墙规则的协议。

9.45. neutron firewall-show

usage: neutron firewall-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] FIREWALL
Copy to Clipboard Toggle word wrap
显示给定防火墙的信息。

positional 参数

FIREWALL
要查找的防火墙的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.46. neutron firewall-update

usage: neutron firewall-update [-h] [--request-format {json,xml}] [--policy POLICY] [--router ROUTER | --no-routers] FIREWALL
Copy to Clipboard Toggle word wrap
更新给定防火墙。

positional 参数

FIREWALL
要更新的防火墙的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--policy POLICY
防火墙策略名称或 ID。
--router ROUTER
防火墙关联的路由器名称或 ID (需要 FWaaS 路由器插入扩展,此选项可以重复)
--no-routers
将没有路由器与防火墙关联(需要 FWaaS 路由器插入扩展)

9.47. neutron floatingip-associate

usage: neutron floatingip-associate [-h] [--request-format {json,xml}] [--fixed-ip-address FIXED_IP_ADDRESS] FLOATINGIP_ID PORT
Copy to Clipboard Toggle word wrap
在浮动 IP 和固定 IP 之间创建映射。

positional 参数

FLOATIP_ID
要关联的浮动 IP 的 ID。
PORT
与浮动 IP 关联的端口的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--fixed-ip-address FIXED_IP_ADDRESS
端口上的 IP 地址(仅在端口有多个 IP 时才需要)。

9.48. neutron floatingip-create

usage: neutron floatingip-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--port-id PORT_ID] [--fixed-ip-address FIXED_IP_ADDRESS] [--floating-ip-address FLOATING_IP_ADDRESS] FLOATING_NETWORK
Copy to Clipboard Toggle word wrap
为给定租户创建一个浮动 IP。

positional 参数

FLOATING_NETWORK
从中分配浮动 IP 的网络名称或 ID。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--port-id PORT_ID
与浮动 IP 关联的端口 ID。
--fixed-ip-address FIXED_IP_ADDRESS
端口上的 IP 地址(仅在端口有多个 IP 时才需要)。
--floating-ip-address FLOATING_IP_ADDRESS
浮动 IP 的 IP 地址

9.49. neutron floatingip-delete

usage: neutron floatingip-delete [-h] [--request-format {json,xml}] FLOATINGIP
Copy to Clipboard Toggle word wrap
删除给定的浮动 IP。

positional 参数

FLOATINGIP
要删除的 floatingip 的 ID。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.50. neutron floatingip-disassociate

usage: neutron floatingip-disassociate [-h] [--request-format {json,xml}] FLOATINGIP_ID
Copy to Clipboard Toggle word wrap
移除从浮动 IP 到固定 IP 的映射。

positional 参数

FLOATIP_ID
要解除关联的浮动 IP 的 ID。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.51. neutron floatingip-list

usage: neutron floatingip-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
列出属于给定租户的浮动 IP。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.52. neutron floatingip-show

usage: neutron floatingip-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] FLOATINGIP
Copy to Clipboard Toggle word wrap
显示给定浮动 IP 的信息。

positional 参数

FLOATINGIP
要查找的 floatingip 的 ID。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.53. neutron gateway-device-create

usage: neutron gateway-device-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--connector-type {stt,gre,ipsecgre,ipsecstt,bridge,ipsec_gre,ipsec_stt}] --connector-ip CONNECTOR_IP (--client-certificate CERT_DATA | --client-certificate-file CERT_FILE) NAME
Copy to Clipboard Toggle word wrap
创建网络网关设备。

positional 参数

NAME
要创建的网络网关设备名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--connector-type {stt,gre,ipsecgre,ipsecstt,bridge,ipsec_gre,ipsec_stt}
用于此设备的传输区连接器的类型。有效值为 gre、stt、ipsec_gre、ipsec_stt 和 bridge。默认为 stt. ipsecgre 和 ipsecstt 作为替代名称
--connector-ip CONNECTOR_IP
此设备的传输连接器的 IP 地址。它必须与 NSX 网关节点上租户流量的接口的 IP 地址对应。
--client-certificate CERT_DATA
NSX 网关传输节点使用的 PEM 证书,以便与 NSX 控制器进行身份验证。
--client-certificate-file CERT_FILE
包含 NSX 网关传输节点使用的 PEM 证书的文件,以便与 NSX 控制器进行身份验证。

9.54. neutron gateway-device-delete

usage: neutron gateway-device-delete [-h] [--request-format {json,xml}] GATEWAY_DEVICE
Copy to Clipboard Toggle word wrap
删除给定的网络网关设备。

positional 参数

GATEWAY_DEVICE
要删除的 gateway_device 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.55. neutron gateway-device-list

usage: neutron gateway-device-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD]
Copy to Clipboard Toggle word wrap
列出给定租户的网络网关设备。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.56. neutron gateway-device-show

usage: neutron gateway-device-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] GATEWAY_DEVICE
Copy to Clipboard Toggle word wrap
显示给定网络网关设备的信息。

positional 参数

GATEWAY_DEVICE
要查找的 gateway_device 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.57. neutron gateway-device-update

usage: neutron gateway-device-update [-h] [--request-format {json,xml}] [--name NAME] [--connector-type {stt,gre,ipsecgre,ipsecstt,bridge,ipsec_gre,ipsec_stt}] [--connector-ip CONNECTOR_IP] [--client-certificate CERT_DATA | --client-certificate-file CERT_FILE] GATEWAY_DEVICE
Copy to Clipboard Toggle word wrap
更新网络网关设备。

positional 参数

GATEWAY_DEVICE
要更新的 gateway_device 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--name NAME
网络网关设备的新名称。
--connector-type {stt,gre,ipsecgre,ipsecstt,bridge,ipsec_gre,ipsec_stt}
用于此设备的传输区连接器的类型。有效值为 gre、stt、ipsec_gre、ipsec_stt 和 bridge。默认为 stt. ipsecgre 和 ipsecstt 作为替代名称
--connector-ip CONNECTOR_IP
此设备的传输连接器的 IP 地址。它必须与 NSX 网关节点上租户流量的接口的 IP 地址对应。
--client-certificate CERT_DATA
NSX 网关传输节点使用的 PEM 证书,以便与 NSX 控制器进行身份验证。
--client-certificate-file CERT_FILE
包含 NSX 网关传输节点使用的 PEM 证书的文件,以便与 NSX 控制器进行身份验证。

9.58. neutron ipsec-site-connection-create

usage: neutron ipsec-site-connection-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--admin-state-down] [--name NAME] [--description DESCRIPTION] [--mtu MTU] [--initiator {bi-directional,response-only}] [--dpd action=ACTION,interval=INTERVAL,timeout=TIMEOUT] --vpnservice-id VPNSERVICE --ikepolicy-id IKEPOLICY --ipsecpolicy-id IPSECPOLICY --peer-address PEER_ADDRESS --peer-id PEER_ID --peer-cidr PEER_CIDRS --psk PSK
Copy to Clipboard Toggle word wrap
创建 IPsec 站点连接。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--admin-state-down
将 admin state up 设置为 false。
--name NAME
为连接设置友好名称。
--description DESCRIPTION
为连接设置描述。
--mtu MTU
连接的 MTU 大小,默认为:1500
--initiator {bi-directional,response-only}
小写的 initiator 状态,默认为双向
--dpd
action=ACTION,interval=INTERVAL,timeout=TIMEOUT Ipsec 连接。死对等检测属性。'action'-hold,clear,disabled,restart,restart-by-peer. 'interval' 和 'timeout' 是非负整数。'interval' 应该小于 'timeout', default:hold 'interval', default:30, 'timeout', default:120.
--vpnservice-id VPNSERVICE
与此连接关联的 VPN 服务实例 ID。
--ikepolicy-id IKEPOLICY
与此连接关联的 IKE 策略 ID。
--ipsecpolicy-id IPSECPOLICY
与此连接关联的 IPsec 策略 ID。
--peer-address PEER_ADDRESS
对等网关公共 IPv4/IPv6 地址或 FQDN.
--peer-id PEER_ID
用于身份验证的对等路由器身份。可以是 IPv4/IPv6 地址、电子邮件地址、密钥 ID 或 FQDN。
--peer-cidr PEER_CIDRS
CIDR 格式的远程子网。
--psk PSK
预共享密钥字符串。

9.59. neutron ipsec-site-connection-delete

usage: neutron ipsec-site-connection-delete [-h] [--request-format {json,xml}] IPSEC_SITE_CONNECTION
Copy to Clipboard Toggle word wrap
删除给定的 IPsec 站点连接。

positional 参数

IPSEC_SITE_CONNECTION
要删除的 ipsec_site_connection 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.60. neutron ipsec-site-connection-list

usage: neutron ipsec-site-connection-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
列出属于给定租户的 IPsec 站点连接。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.61. neutron ipsec-site-connection-show

usage: neutron ipsec-site-connection-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] IPSEC_SITE_CONNECTION
Copy to Clipboard Toggle word wrap
显示给定 IPsec 站点连接的信息。

positional 参数

IPSEC_SITE_CONNECTION
要查找的 ipsec_site_connection 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.62. neutron ipsec-site-connection-update

usage: neutron ipsec-site-connection-update [-h] [--request-format {json,xml}] [--dpd action=ACTION,interval=INTERVAL,timeout=TIMEOUT] IPSEC_SITE_CONNECTION
Copy to Clipboard Toggle word wrap
更新给定的 IPsec 站点连接。

positional 参数

IPSEC_SITE_CONNECTION
要更新的 ipsec_site_connection 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--dpd
action=ACTION,interval=INTERVAL,timeout=TIMEOUT Ipsec 连接。死对等检测属性。'action'-hold,clear,disabled,restart,restart-by-peer. 'interval' 和 'timeout' 是非负整数。'interval' 应该小于 'timeout', default:hold 'interval', default:30, 'timeout', default:120.

9.63. neutron l3-agent-list-hosting-router

usage: neutron l3-agent-list-hosting-router [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] router
Copy to Clipboard Toggle word wrap
列出托管路由器的 L3 代理。

positional 参数

路由器
要查询的路由器。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.64. neutron l3-agent-router-add

usage: neutron l3-agent-router-add [-h] [--request-format {json,xml}] l3_agent router
Copy to Clipboard Toggle word wrap
将路由器添加到 L3 代理。

positional 参数

l3_agent
L3 代理的 ID。
路由器
要添加的路由器。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.65. Neutron l3-agent-router-remove

usage: neutron l3-agent-router-remove [-h] [--request-format {json,xml}] l3_agent router
Copy to Clipboard Toggle word wrap
从 L3 代理移除路由器。

positional 参数

l3_agent
L3 代理的 ID。
路由器
要删除的路由器。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.66. neutron lb-agent-hosting-pool

usage: neutron lb-agent-hosting-pool [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] pool
Copy to Clipboard Toggle word wrap
获取托管池的 loadbalancer 代理。从 ListCommand 开始,但服务器只返回一个代理,以保留所有代理调度程序的通用输出格式

positional 参数

pool
要查询的池。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.67. neutron lb-healthmonitor-associate

usage: neutron lb-healthmonitor-associate [-h] [--request-format {json,xml}] HEALTH_MONITOR_ID POOL
Copy to Clipboard Toggle word wrap
在运行状况监视器和池之间创建映射。

positional 参数

HEALTH_MONITOR_ID
要关联的运行状况监视器。
POOL
与运行状况监视器关联的池的 ID。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.68. neutron lb-healthmonitor-create

usage: neutron lb-healthmonitor-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--admin-state-down] [--expected-codes EXPECTED_CODES] [--http-method HTTP_METHOD] [--url-path URL_PATH] --delay DELAY --max-retries MAX_RETRIES --timeout TIMEOUT --type {PING,TCP,HTTP,HTTPS}
Copy to Clipboard Toggle word wrap
创建运行状况监控器。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--admin-state-down
将 admin state up 设置为 false。
--expected-codes EXPECTED_CODES
从成员响应中预期的 HTTP 状态代码列表,以声明它处于健康状态。此属性可以包含一个值,或者以逗号分隔的值列表,或者值范围(例如。"200-299").如果没有指定此属性,则默认为 "200"。
--http-method HTTP_METHOD
HTTP 方法,供监控器类型为 HTTP 的请求的 HTTP 方法。
--url-path URL_PATH
monitor 用来测试成员健康状况的 HTTP 请求中使用的 HTTP 路径。这必须是以 / (正斜杠)开头的字符串。
--delay DELAY
将探测发送到成员之间的时间(以秒为单位)。
--max-retries MAX_RETRIES
在将成员状态更改为 INACTIVE 之前,允许的连接失败的数量 [1..10]
--timeout TIMEOUT
monitor 在超时前等待连接建立连接的最大秒数。该值必须小于延迟值。
--type {PING,TCP,HTTP,HTTPS}
其中一个预定义的运行状况监视器类型。

9.69. neutron lb-healthmonitor-delete

usage: neutron lb-healthmonitor-delete [-h] [--request-format {json,xml}] HEALTH_MONITOR
Copy to Clipboard Toggle word wrap
删除给定的运行状况监控器。

positional 参数

HEALTH_MONITOR
要删除的 health_monitor 的 ID。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.70. neutron lb-healthmonitor-disassociate

usage: neutron lb-healthmonitor-disassociate [-h] [--request-format {json,xml}] HEALTH_MONITOR_ID POOL
Copy to Clipboard Toggle word wrap
从运行状况监视器删除到池的映射。

positional 参数

HEALTH_MONITOR_ID
要关联的运行状况监视器。
POOL
与运行状况监视器关联的池的 ID。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.71. neutron lb-healthmonitor-list

usage: neutron lb-healthmonitor-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
列出属于给定租户的运行状况监视器。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.72. neutron lb-healthmonitor-show

usage: neutron lb-healthmonitor-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] HEALTH_MONITOR
Copy to Clipboard Toggle word wrap
显示给定运行状况监视器的信息。

positional 参数

HEALTH_MONITOR
要查找的 health_monitor 的 ID。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.73. neutron lb-healthmonitor-update

usage: neutron lb-healthmonitor-update [-h] [--request-format {json,xml}] HEALTH_MONITOR
Copy to Clipboard Toggle word wrap
更新给定的运行状况监控器。

positional 参数

HEALTH_MONITOR
要更新的 health_monitor 的 ID。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.74. neutron lb-member-create

usage: neutron lb-member-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--admin-state-down] [--weight WEIGHT] --address ADDRESS --protocol-port PROTOCOL_PORT POOL
Copy to Clipboard Toggle word wrap
创建成员。

positional 参数

POOL
池 ID 或此 vip 所属的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--admin-state-down
将 admin state up 设置为 false。
--weight WEIGHT
池中池成员的权重(默认为:1,[0..256])。
--address ADDRESS
池网络上池成员的 IP 地址。
--protocol-port PROTOCOL_PORT
池成员在其上侦听请求或连接的端口。

9.75. neutron lb-member-delete

usage: neutron lb-member-delete [-h] [--request-format {json,xml}] MEMBER
Copy to Clipboard Toggle word wrap
删除给定成员。

positional 参数

成员
要删除的成员 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.76. neutron lb-member-list

usage: neutron lb-member-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
列出属于给定租户的成员。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.77. neutron lb-member-show

usage: neutron lb-member-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] MEMBER
Copy to Clipboard Toggle word wrap
显示给定成员的信息。

positional 参数

成员
要查找的成员 ID。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.78. neutron lb-member-update

usage: neutron lb-member-update [-h] [--request-format {json,xml}] MEMBER
Copy to Clipboard Toggle word wrap
更新给定成员。

positional 参数

成员
要更新的成员的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.79. neutron lb-pool-create

usage: neutron lb-pool-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--admin-state-down] [--description DESCRIPTION] --lb-method {ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP} --name NAME --protocol {HTTP,HTTPS,TCP} --subnet-id SUBNET [--provider PROVIDER]
Copy to Clipboard Toggle word wrap
创建池。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--admin-state-down
将 admin state up 设置为 false。
--description DESCRIPTION
池的描述。
--lb-method {ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP}
用于在池成员之间分发负载的算法。
--name NAME
池的名称。
--protocol {HTTP,HTTPS,TCP}
用于平衡的协议。
--subnet-id SUBNET
池成员所在的子网。
--provider PROVIDER
负载均衡器服务的供应商名称。

9.80. neutron lb-pool-delete

usage: neutron lb-pool-delete [-h] [--request-format {json,xml}] POOL
Copy to Clipboard Toggle word wrap
删除给定池。

positional 参数

POOL
要删除的池的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.81. neutron lb-pool-list

usage: neutron lb-pool-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
列出属于给定租户的池。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.82. neutron lb-pool-list-on-agent

usage: neutron lb-pool-list-on-agent [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] lbaas_agent
Copy to Clipboard Toggle word wrap
列出 loadbalancer 代理上的池。

positional 参数

lbaas_agent
要查询的 loadbalancer 代理的 ID。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.83. neutron lb-pool-show

usage: neutron lb-pool-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] POOL
Copy to Clipboard Toggle word wrap
显示给定池的信息。

positional 参数

POOL
要查找的池的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.84. neutron lb-pool-stats

usage: neutron lb-pool-stats [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] POOL
Copy to Clipboard Toggle word wrap
检索给定池的统计信息。

positional 参数

POOL
要查找的池的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.85. neutron lb-pool-update

usage: neutron lb-pool-update [-h] [--request-format {json,xml}] POOL
Copy to Clipboard Toggle word wrap
更新给定池。

positional 参数

POOL
要更新的池的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.86. neutron lb-vip-create

usage: neutron lb-vip-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--address ADDRESS] [--admin-state-down] [--connection-limit CONNECTION_LIMIT] [--description DESCRIPTION] --name NAME --protocol-port PROTOCOL_PORT --protocol {TCP,HTTP,HTTPS} --subnet-id SUBNET POOL
Copy to Clipboard Toggle word wrap
创建 vip。

positional 参数

POOL
池 ID 或此 vip 所属的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--address ADDRESS
vip 的 IP 地址。
--admin-state-down
将 admin state up 设置为 false。
--connection-limit CONNECTION_LIMIT
vip 允许每秒允许的最大连接数。正整数或 -1 代表无限(默认)。
--description DESCRIPTION
vip 的描述。
--name NAME
vip 的名称。
--protocol-port PROTOCOL_PORT
侦听与 vip 地址关联的客户端流量的 TCP 端口。
--protocol {TCP,HTTP,HTTPS}
用于平衡的协议。
--subnet-id SUBNET
要分配 vip 地址的子网。

9.87. neutron lb-vip-delete

usage: neutron lb-vip-delete [-h] [--request-format {json,xml}] VIP
Copy to Clipboard Toggle word wrap
删除给定的 vip。

positional 参数

VIP
要删除的 vip 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.88. neutron lb-vip-list

usage: neutron lb-vip-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
列出属于给定租户的 vips。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.89. neutron lb-vip-show

usage: neutron lb-vip-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] VIP
Copy to Clipboard Toggle word wrap
显示给定 vip 的信息。

positional 参数

VIP
要查找的 ID 或 vip 的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.90. neutron lb-vip-update

usage: neutron lb-vip-update [-h] [--request-format {json,xml}] VIP
Copy to Clipboard Toggle word wrap
更新给定 vip。

positional 参数

VIP
要更新的 vip 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.91. neutron lbaas-agent-hosting-loadbalancer

usage: neutron lbaas-agent-hosting-loadbalancer [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] loadbalancer
Copy to Clipboard Toggle word wrap
获取托管 loadbalancer 的 lbaas v2 代理。从 ListCommand 开始,但服务器只返回一个代理,以保留所有代理调度程序的通用输出格式

positional 参数

LoadBalancer
要查询的 LoadBalancer。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.92. neutron lbaas-healthmonitor-create

usage: neutron lbaas-healthmonitor-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--admin-state-down] [--expected-codes EXPECTED_CODES] [--http-method HTTP_METHOD] [--url-path URL_PATH] --delay DELAY --max-retries MAX_RETRIES --timeout TIMEOUT --type {PING,TCP,HTTP,HTTPS} --pool POOL
Copy to Clipboard Toggle word wrap
LBaaS v2 创建运行状况monitor。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--admin-state-down
将 admin state up 设置为 false。
--expected-codes EXPECTED_CODES
从成员响应中预期的 HTTP 状态代码列表,以声明它处于健康状态。此属性可以包含一个值,或者以逗号分隔的值列表,或者值范围(例如。"200-299").如果没有指定此属性,则默认为 "200"。
--http-method HTTP_METHOD
HTTP 方法,供监控器类型为 HTTP 的请求的 HTTP 方法。
--url-path URL_PATH
monitor 用来测试成员健康状况的 HTTP 请求中使用的 HTTP 路径。这必须是以 / (正斜杠)开头的字符串。
--delay DELAY
将探测发送到成员之间的时间(以秒为单位)。
--max-retries MAX_RETRIES
在将成员状态更改为 INACTIVE 之前,允许的连接失败的数量 [1..10]。
--timeout TIMEOUT
monitor 在超时前等待连接建立连接的最大秒数。该值必须小于延迟值。
--type {PING,TCP,HTTP,HTTPS}
其中一个预定义的运行状况监视器类型。
--pool POOL
此 healthmonitor 将监控的池 ID 或名称。

9.93. neutron lbaas-healthmonitor-delete

usage: neutron lbaas-healthmonitor-delete [-h] [--request-format {json,xml}] HEALTHMONITOR
Copy to Clipboard Toggle word wrap
LBaaS v2 删除给定的运行状况监视器。

positional 参数

HEALTHMONITOR
要删除的 ID 或 healthmonitor 的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.94. Neutron lbaas-healthmonitor-list

usage: neutron lbaas-healthmonitor-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
LBaaS v2 列出属于给定租户的运行状况监视器。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.95. Neutron lbaas-healthmonitor-show

usage: neutron lbaas-healthmonitor-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] HEALTHMONITOR
Copy to Clipboard Toggle word wrap
LBaaS v2 显示给定运行状况监视器的信息。

positional 参数

HEALTHMONITOR
要查找的 ID 或 healthmonitor 的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.96. neutron lbaas-healthmonitor-update

usage: neutron lbaas-healthmonitor-update [-h] [--request-format {json,xml}] HEALTHMONITOR
Copy to Clipboard Toggle word wrap
LBaaS v2 更新给定的运行状况监视器。

positional 参数

HEALTHMONITOR
要更新的 healthmonitor 的 ID。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.97. neutron lbaas-listener-create

usage: neutron lbaas-listener-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--admin-state-down] [--connection-limit CONNECTION_LIMIT] [--description DESCRIPTION] [--name NAME] [--default-tls-container-ref DEFAULT_TLS_CONTAINER_REF] [--sni-container-refs SNI_CONTAINER_REFS [SNI_CONTAINER_REFS ...]] --loadbalancer LOADBALANCER --protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS} --protocol-port PORT
Copy to Clipboard Toggle word wrap
LBaaS v2 创建侦听器.

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--admin-state-down
将 admin state up 设置为 false。
--connection-limit CONNECTION_LIMIT
vip 允许每秒允许的最大连接数。正整数或 -1 代表无限(默认)。
--description DESCRIPTION
侦听器的描述。
--name NAME
侦听器的名称。
--default-tls-container-ref DEFAULT_TLS_CONTAINER_REF
默认 TLS 容器引用以检索 TLS 信息。
--SNI-container-refs SNI_CONTAINER_REFS [SNI_CONTAINER_REFS ...]
SNI 的 TLS 容器引用列表。
--LoadBalancer LOADBALANCER
负载均衡器的 ID 或名称。
--protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS}
侦听器的协议。
--protocol-port PORT
侦听器的协议端口。

9.98. neutron lbaas-listener-delete

usage: neutron lbaas-listener-delete [-h] [--request-format {json,xml}] LISTENER
Copy to Clipboard Toggle word wrap
LBaaS v2 删除给定的监听程序.

positional 参数

LISTENER
要删除的监听程序的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.99. neutron lbaas-listener-list

usage: neutron lbaas-listener-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
属于给定租户的 LBaaS v2 列表监听程序。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.100. neutron lbaas-listener-show

usage: neutron lbaas-listener-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] LISTENER
Copy to Clipboard Toggle word wrap
LBaaS v2 显示给定监听器的信息。

positional 参数

LISTENER
要查找的监听程序的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.101. neutron lbaas-listener-update

usage: neutron lbaas-listener-update [-h] [--request-format {json,xml}] LISTENER
Copy to Clipboard Toggle word wrap
LBaaS v2 更新给定的监听程序。

positional 参数

LISTENER
要更新的监听程序的 ID。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.102. neutron lbaas-loadbalancer-create

usage: neutron lbaas-loadbalancer-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--description DESCRIPTION] [--admin-state-down] [--name NAME] [--provider PROVIDER] [--vip-address VIP_ADDRESS] VIP_SUBNET
Copy to Clipboard Toggle word wrap
LBaaS v2 创建负载均衡器.

positional 参数

VIP_SUBNET
负载均衡器 VIP 子网。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--description DESCRIPTION
负载均衡器的描述。
--admin-state-down
将 admin state up 设置为 false。
--name NAME
负载均衡器的名称。
--provider PROVIDER
负载均衡器服务的供应商名称。
--VIP-address VIP_ADDRESS
负载均衡器的 VIP 地址。

9.103. neutron lbaas-loadbalancer-delete

usage: neutron lbaas-loadbalancer-delete [-h] [--request-format {json,xml}] LOADBALANCER
Copy to Clipboard Toggle word wrap
LBaaS v2 删除给定的负载均衡器。

positional 参数

LOADBALANCER
要删除的负载均衡器的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.104. neutron lbaas-loadbalancer-list

usage: neutron lbaas-loadbalancer-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
属于给定租户的 LBaaS v2 列表负载均衡器。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.105. neutron lbaas-loadbalancer-list-on-agent

usage: neutron lbaas-loadbalancer-list-on-agent [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] lbaas_agent
Copy to Clipboard Toggle word wrap
列出 loadbalancer v2 代理上的 loadbalancers。

positional 参数

lbaas_agent
要查询的 loadbalancer 代理的 ID。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.106. neutron lbaas-loadbalancer-show

usage: neutron lbaas-loadbalancer-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] LOADBALANCER
Copy to Clipboard Toggle word wrap
LBaaS v2 显示给定负载均衡器的信息。

positional 参数

LOADBALANCER
要查找的负载均衡器的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.107. neutron lbaas-loadbalancer-update

usage: neutron lbaas-loadbalancer-update [-h] [--request-format {json,xml}] LOADBALANCER
Copy to Clipboard Toggle word wrap
LBaaS v2 更新给定的负载均衡器。

positional 参数

LOADBALANCER
要更新的负载均衡器的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.108. neutron lbaas-member-create

usage: neutron lbaas-member-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--admin-state-down] [--weight WEIGHT] --subnet SUBNET --address ADDRESS --protocol-port PROTOCOL_PORT POOL
Copy to Clipboard Toggle word wrap
LBaaS v2 创建成员.

positional 参数

POOL
此成员所属池的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--admin-state-down
将 admin state up 设置为 false
--weight WEIGHT
池中成员的权重(默认为:1、[0..256])。
--subnet SUBNET
成员的子网 ID 或名称。
--address ADDRESS
池中池成员的 IP 地址。
--protocol-port PROTOCOL_PORT
池成员在其上侦听请求或连接的端口。

9.109. neutron lbaas-member-delete

usage: neutron lbaas-member-delete [-h] [--request-format {json,xml}] MEMBER POOL
Copy to Clipboard Toggle word wrap
LBaaS v2 删除给定成员.

positional 参数

成员
要删除的成员 ID 或名称。
POOL
此成员所属池的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.110. neutron lbaas-member-list

usage: neutron lbaas-member-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}] POOL
Copy to Clipboard Toggle word wrap
属于给定池的 LBaaS v2 列表成员。

positional 参数

POOL
此成员所属池的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.111. neutron lbaas-member-show

usage: neutron lbaas-member-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] MEMBER POOL
Copy to Clipboard Toggle word wrap
LBaaS v2 显示给定成员的信息。

positional 参数

成员
要查找的成员的 ID 或名称。
POOL
此成员所属池的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.112. neutron lbaas-member-update

usage: neutron lbaas-member-update [-h] [--request-format {json,xml}] [--admin-state-down] [--weight WEIGHT] MEMBER POOL
Copy to Clipboard Toggle word wrap
LBaaS v2 更新给定成员。

positional 参数

成员
要更新的成员的 ID 或名称。
POOL
此成员所属池的 ID 或名称

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--admin-state-down
将 admin state up 设置为 false
--weight WEIGHT
池中成员的权重(默认为:1、[0..256])

9.113. neutron lbaas-pool-create

usage: neutron lbaas-pool-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--admin-state-down] [--description DESCRIPTION] [--session-persistence type=TYPE[,cookie_name=COOKIE_NAME]] [--name NAME] --lb-algorithm {ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP} --listener LISTENER --protocol {HTTP,HTTPS,TCP}
Copy to Clipboard Toggle word wrap
LBaaS v2 创建池.

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--admin-state-down
将 admin state up 设置为 false。
--description DESCRIPTION
池的描述。
--session-persistence
type=TYPE[,cookie_name=COOKIE_NAME] 要使用和关联的 Cookie 名称的会话持久性类型
--name NAME
池的名称。
--lb-algorithm {ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP}
用于在池成员之间分发负载的算法。
--listener LISTENER
与池关联的监听程序
--protocol {HTTP,HTTPS,TCP}
用于平衡的协议。

9.114. neutron lbaas-pool-delete

usage: neutron lbaas-pool-delete [-h] [--request-format {json,xml}] POOL
Copy to Clipboard Toggle word wrap
LBaaS v2 删除给定池。

positional 参数

POOL
要删除的池的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.115. neutron lbaas-pool-list

usage: neutron lbaas-pool-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
属于给定租户的 LBaaS v2 列表池。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.116. neutron lbaas-pool-show

usage: neutron lbaas-pool-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] POOL
Copy to Clipboard Toggle word wrap
LBaaS v2 显示给定池的信息。

positional 参数

POOL
要查找的池的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.117. neutron lbaas-pool-update

usage: neutron lbaas-pool-update [-h] [--request-format {json,xml}] POOL
Copy to Clipboard Toggle word wrap
LBaaS v2 更新给定池。

positional 参数

POOL
要更新的池的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.118. neutron meter-label-create

usage: neutron meter-label-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--description DESCRIPTION] [--shared] NAME
Copy to Clipboard Toggle word wrap
为给定租户创建 metering 标签。

positional 参数

NAME
要创建的 metering 标签的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--description DESCRIPTION
要创建的 metering 标签的描述。
--shared
将标签设置为 shared。

9.119. neutron meter-label-delete

usage: neutron meter-label-delete [-h] [--request-format {json,xml}] METERING_LABEL
Copy to Clipboard Toggle word wrap
删除给定的 metering 标签。

positional 参数

METERING_LABEL
要删除的 metering_label 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.120. neutron meter-label-list

usage: neutron meter-label-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
列出属于给定租户的 metering 标签。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.121. neutron meter-label-rule-create

usage: neutron meter-label-rule-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--direction {ingress,egress}] [--excluded] LABEL REMOTE_IP_PREFIX
Copy to Clipboard Toggle word wrap
为给定标签创建 metering 标签规则。

positional 参数

LABEL
标签的 ID 或名称。
REMOTE_IP_PREFIX
要匹配的 CIDR。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--direction {ingress,egress}
流量方向,default:ingress。
--excluded
从标签中排除此 CIDR,default: not excluded.

9.122. neutron meter-label-rule-delete

usage: neutron meter-label-rule-delete [-h] [--request-format {json,xml}] METERING_LABEL_RULE
Copy to Clipboard Toggle word wrap
删除给定的 metering 标签。

positional 参数

METERING_LABEL_RULE
要删除的 metering_label_rule 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.123. neutron meter-label-rule-list

usage: neutron meter-label-rule-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
列出属于给定标签的 metering 标签。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.124. neutron meter-label-rule-show

usage: neutron meter-label-rule-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] METERING_LABEL_RULE
Copy to Clipboard Toggle word wrap
显示给定 metering 标签规则的信息。

positional 参数

METERING_LABEL_RULE
要查找的 metering_label_rule 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.125. neutron meter-label-show

usage: neutron meter-label-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] METERING_LABEL
Copy to Clipboard Toggle word wrap
显示给定 metering 标签的信息。

positional 参数

METERING_LABEL
要查找的 metering_label 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.126. neutron net-create

usage: neutron net-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--admin-state-down] [--shared] [--provider:network_type <network_type>] [--provider:physical_network <physical_network_name>] [--provider:segmentation_id <segmentation_id>] [--vlan-transparent {True,False}] [--qos-policy QOS_POLICY] NAME
Copy to Clipboard Toggle word wrap
为给定租户创建网络。

positional 参数

NAME
要创建的网络的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--admin-state-down
将 admin state up 设置为 false。
--shared
将网络设置为共享。
--provider:network_type <network_type>
实施虚拟网络的物理机制。
--provider:physical_network <physical_network_name>
实施虚拟网络的物理网络的名称。
--provider:segmentation_id <segmentation_id>
用于 VLAN 网络的 VLAN ID 或 GRE/VXLAN 网络的隧道 ID。
--vlan-transparent {True,False}
创建 vlan 透明网络。
--qos-policy QOS_POLICY
为资源附加 QoS 策略 ID 或名称。

9.127. neutron net-delete

usage: neutron net-delete [-h] [--request-format {json,xml}] NETWORK
Copy to Clipboard Toggle word wrap
删除给定网络。

positional 参数

网络
要删除的网络的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.128. neutron net-external-list

usage: neutron net-external-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
列出属于给定租户的外部网络。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.129. neutron net-gateway-connect

usage: neutron net-gateway-connect [-h] [--request-format {json,xml}] [--segmentation-type SEGMENTATION_TYPE] [--segmentation-id SEGMENTATION_ID] NET-GATEWAY-ID NETWORK-ID
Copy to Clipboard Toggle word wrap
添加内部网络接口到路由器。

positional 参数

NET-GATEWAY-ID
网络网关的 ID。
NETWORK-ID
要在网关上连接的内部网络的 ID。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--segmentation-type SEGMENTATION_TYPE
网关外部端的 L2 分段策略(例如:VLAN、FLAT)。
--segmentation-id SEGMENTATION_ID
网关外部端的 L2 段的标识符。

9.130. neutron net-gateway-create

usage: neutron net-gateway-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--device id=ID,interface_name=NAME_OR_ID] NAME
Copy to Clipboard Toggle word wrap
创建网络网关。

positional 参数

NAME
要创建的网络网关的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--device
id=id,interface_name=NAME_OR_ID Device info 用于此网关。您可以为 HA 网关多个设备重复这个选项。

9.131. neutron net-gateway-delete

usage: neutron net-gateway-delete [-h] [--request-format {json,xml}] NETWORK_GATEWAY
Copy to Clipboard Toggle word wrap
删除给定的网络网关。

positional 参数

NETWORK_GATEWAY
要删除的 network_gateway 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.132. neutron net-gateway-disconnect

usage: neutron net-gateway-disconnect [-h] [--request-format {json,xml}] [--segmentation-type SEGMENTATION_TYPE] [--segmentation-id SEGMENTATION_ID] NET-GATEWAY-ID NETWORK-ID
Copy to Clipboard Toggle word wrap
从网络网关移除网络。

positional 参数

NET-GATEWAY-ID
网络网关的 ID。
NETWORK-ID
要在网关上连接的内部网络的 ID。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--segmentation-type SEGMENTATION_TYPE
网关外部端的 L2 分段策略(例如:VLAN、FLAT)。
--segmentation-id SEGMENTATION_ID
网关外部端的 L2 段的标识符。

9.133. neutron net-gateway-list

usage: neutron net-gateway-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD]
Copy to Clipboard Toggle word wrap
列出给定租户的网络网关。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.134. neutron net-gateway-show

usage: neutron net-gateway-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] NETWORK_GATEWAY
Copy to Clipboard Toggle word wrap
显示给定网络网关的信息。

positional 参数

NETWORK_GATEWAY
要查找的 network_gateway 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.135. neutron net-gateway-update

usage: neutron net-gateway-update [-h] [--request-format {json,xml}] NETWORK_GATEWAY
Copy to Clipboard Toggle word wrap
更新网络网关的名称。

positional 参数

NETWORK_GATEWAY
要更新的 network_gateway 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.136. neutron net-list

usage: neutron net-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
列出属于给定租户的网络。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.137. neutron net-list-on-dhcp-agent

usage: neutron net-list-on-dhcp-agent [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}] dhcp_agent
Copy to Clipboard Toggle word wrap
列出 DHCP 代理上的网络。

positional 参数

dhcp_agent
DHCP 代理的 ID。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.138. neutron net-show

usage: neutron net-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] NETWORK
Copy to Clipboard Toggle word wrap
显示给定网络的信息。

positional 参数

网络
要查找的网络 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.139. neutron net-update

usage: neutron net-update [-h] [--request-format {json,xml}] [--qos-policy QOS_POLICY | --no-qos-policy] NETWORK
Copy to Clipboard Toggle word wrap
更新网络的信息。

positional 参数

网络
要更新的网络的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--qos-policy QOS_POLICY
为资源附加 QoS 策略 ID 或名称。
--no-qos-policy
从资源中分离 QoS 策略。

9.140. neutron nuage-netpartition-create

usage: neutron nuage-netpartition-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] name
Copy to Clipboard Toggle word wrap
为给定租户创建 netpartition。

positional 参数

名称
要创建的 netpartition 的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。

9.141. neutron nuage-netpartition-delete

usage: neutron nuage-netpartition-delete [-h] [--request-format {json,xml}] NET_PARTITION
Copy to Clipboard Toggle word wrap
删除给定的 netpartition。

positional 参数

NET_PARTITION
要删除的 net_partition 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.142. neutron nuage-netpartition-list

usage: neutron nuage-netpartition-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD]
Copy to Clipboard Toggle word wrap
列出属于给定租户的 netpartitions。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.143. neutron nuage-netpartition-show

usage: neutron nuage-netpartition-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] NET_PARTITION
Copy to Clipboard Toggle word wrap
显示给定 netpartition 的信息。

positional 参数

NET_PARTITION
要查找的 net_partition 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.144. neutron port-create

usage: neutron port-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--name NAME] [--fixed-ip subnet_id=SUBNET,ip_address=IP_ADDR] [--device-id DEVICE_ID] [--device-owner DEVICE_OWNER] [--admin-state-down] [--mac-address MAC_ADDRESS] [--vnic-type <direct | macvtap | normal>] [--binding-profile BINDING_PROFILE] [--security-group SECURITY_GROUP | --no-security-groups] [--extra-dhcp-opt EXTRA_DHCP_OPTS] [--qos-policy QOS_POLICY] NETWORK
Copy to Clipboard Toggle word wrap
为给定租户创建端口。

positional 参数

网络
此端口所属网络 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--name NAME
此端口的名称。
--fixed-ip
subnet_id=SUBNET,ip_address=IP_ADDR Desired IP 和/或子网:subnet_id=<name_or_id>,ip_address=<ip>。您可以重复这个选项。
--device-id DEVICE_ID
此端口的设备 ID。
--device-owner DEVICE_OWNER
此端口的设备所有者。
--admin-state-down
将 admin state up 设置为 false。
--MAC-address MAC_ADDRESS
此端口的 MAC 地址。
--vnic-type <direct | macvtap | normal>
此端口的 VNIC 类型。
--binding-profile BINDING_PROFILE
要传递的自定义数据作为 binding:profile。
--security-group SECURITY_GROUP
与端口关联的安全组。您可以重复这个选项。
--no-security-groups
将没有安全组与端口关联。
--extra-dhcp-opt EXTRA_DHCP_OPTS
要分配给这个端口的额外 dhcp 选项: opt_na me=<dhcp_option_name>,opt_value=<value>,ip_version={4, 6}。您可以重复这个选项。
--qos-policy QOS_POLICY
为资源附加 QoS 策略 ID 或名称。

9.145. neutron port-delete

usage: neutron port-delete [-h] [--request-format {json,xml}] PORT
Copy to Clipboard Toggle word wrap
删除给定端口。

positional 参数

PORT
要删除的端口 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.146. neutron port-list

usage: neutron port-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
列出属于给定租户的端口。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.147. neutron port-show

usage: neutron port-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] PORT
Copy to Clipboard Toggle word wrap
显示给定端口的信息。

positional 参数

PORT
要查找的端口的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.148. neutron port-update

usage: neutron port-update [-h] [--request-format {json,xml}] [--name NAME] [--fixed-ip subnet_id=SUBNET,ip_address=IP_ADDR] [--device-id DEVICE_ID] [--device-owner DEVICE_OWNER] [--admin-state-up {True,False}] [--security-group SECURITY_GROUP | --no-security-groups] [--extra-dhcp-opt EXTRA_DHCP_OPTS] [--qos-policy QOS_POLICY | --no-qos-policy] PORT
Copy to Clipboard Toggle word wrap
更新端口的信息。

positional 参数

PORT
更新的 ID 或端口名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--name NAME
此端口的名称。
--fixed-ip
subnet_id=SUBNET,ip_address=IP_ADDR Desired IP 和/或子网:subnet_id=<name_or_id>,ip_address=<ip>。您可以重复这个选项。
--device-id DEVICE_ID
此端口的设备 ID。
--device-owner DEVICE_OWNER
此端口的设备所有者。
--admin-state-up {True,False}
为端口设置 admin 状态。
--security-group SECURITY_GROUP
与端口关联的安全组。您可以重复这个选项。
--no-security-groups
将没有安全组与端口关联。
--extra-dhcp-opt EXTRA_DHCP_OPTS
要分配给这个端口的额外 dhcp 选项: opt_na me=<dhcp_option_name>,opt_value=<value>,ip_version={4, 6}。您可以重复这个选项。
--qos-policy QOS_POLICY
为资源附加 QoS 策略 ID 或名称。
--no-qos-policy
从资源中分离 QoS 策略。

9.149. neutron qos-available-rule-types

usage: neutron qos-available-rule-types [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
列出可用的 qos 规则类型。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.150. neutron qos-bandwidth-limit-rule-create

usage: neutron qos-bandwidth-limit-rule-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--max-kbps MAX_KBPS] [--max-burst-kbps MAX_BURST_KBPS] QOS_POLICY
Copy to Clipboard Toggle word wrap
创建 qos 带宽限制规则。

positional 参数

QOS_POLICY
QoS 策略的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--max-kbps MAX_KBPS
kbps 最大带宽。
--max-burst-kbps MAX_BURST_KBPS
kbps 最大突发带宽。

9.151. neutron qos-bandwidth-limit-rule-delete

usage: neutron qos-bandwidth-limit-rule-delete [-h] [--request-format {json,xml}] BANDWIDTH_LIMIT_RULE QOS_POLICY
Copy to Clipboard Toggle word wrap
删除给定的 qos 带宽限制规则。

positional 参数

BANDWIDTH_LIMIT_RULE
要删除的 bandwidth_limit_rule 的 ID。
QOS_POLICY
QoS 策略的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.152. neutron qos-bandwidth-limit-rule-list

usage: neutron qos-bandwidth-limit-rule-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}] QOS_POLICY
Copy to Clipboard Toggle word wrap
列出属于指定策略的所有 qos 带宽限制规则。

positional 参数

QOS_POLICY
QoS 策略的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.153. neutron qos-bandwidth-limit-rule-show

usage: neutron qos-bandwidth-limit-rule-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] BANDWIDTH_LIMIT_RULE QOS_POLICY
Copy to Clipboard Toggle word wrap
显示有关给定 qos 带宽限制规则的信息。

positional 参数

BANDWIDTH_LIMIT_RULE
要查找的 bandwidth_limit_rule 的 ID。
QOS_POLICY
QoS 策略的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.154. neutron qos-bandwidth-limit-rule-update

usage: neutron qos-bandwidth-limit-rule-update [-h] [--request-format {json,xml}] [--max-kbps MAX_KBPS] [--max-burst-kbps MAX_BURST_KBPS] BANDWIDTH_LIMIT_RULE QOS_POLICY
Copy to Clipboard Toggle word wrap
更新给定的 qos 带宽限制规则。

positional 参数

BANDWIDTH_LIMIT_RULE
要更新的 bandwidth_limit_rule 的 ID。
QOS_POLICY
QoS 策略的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--max-kbps MAX_KBPS
kbps 最大带宽。
--max-burst-kbps MAX_BURST_KBPS
kbps 最大突发带宽。

9.155. neutron qos-policy-create

usage: neutron qos-policy-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--description DESCRIPTION] [--shared] NAME
Copy to Clipboard Toggle word wrap
创建 qos 策略。

positional 参数

NAME
要创建的 QoS 策略的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--description DESCRIPTION
QoS 策略的描述。
--shared
由其他租户访问。将 shared 设置为 True (默认为 False)。

9.156. neutron qos-policy-delete

usage: neutron qos-policy-delete [-h] [--request-format {json,xml}] POLICY
Copy to Clipboard Toggle word wrap
删除给定的 qos 策略。

positional 参数

POLICY
要删除的策略 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.157. neutron qos-policy-list

usage: neutron qos-policy-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
列出属于给定租户连接的 QoS 策略。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.158. neutron qos-policy-show

usage: neutron qos-policy-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] POLICY
Copy to Clipboard Toggle word wrap
显示给定 qos 策略的信息。

positional 参数

POLICY
要查找的策略 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.159. neutron qos-policy-update

usage: neutron qos-policy-update [-h] [--request-format {json,xml}] [--name NAME] [--description DESCRIPTION] [--shared] POLICY
Copy to Clipboard Toggle word wrap
更新给定的 qos 策略。

positional 参数

POLICY
要更新的策略 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--name NAME
QoS 策略的名称。
--description DESCRIPTION
QoS 策略的描述。
--shared
由其他租户访问。将 shared 设置为 True (默认为 False)。

9.160. neutron queue-create

usage: neutron queue-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--min MIN] [--max MAX] [--qos-marking QOS_MARKING] [--default DEFAULT] [--dscp DSCP] NAME
Copy to Clipboard Toggle word wrap
创建队列。

positional 参数

NAME
队列的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--min MIN
最小率。
--max MAX
最大率。
--QoS-marking QOS_MARKING
QOS 标记为不受信任的或可信。
--default DEFAULT
如果为 true,如果没有指定队列,则所有创建的端口都将是此队列的大小。
--dscp DSCP
差异化服务代码点.

9.161. neutron queue-delete

usage: neutron queue-delete [-h] [--request-format {json,xml}] QOS_QUEUE
Copy to Clipboard Toggle word wrap
删除给定队列。

positional 参数

QOS_QUEUE
要删除的 qos_queue 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.162. neutron queue-list

usage: neutron queue-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD]
Copy to Clipboard Toggle word wrap
列出属于给定租户的队列。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.163. neutron queue-show

usage: neutron queue-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] QOS_QUEUE
Copy to Clipboard Toggle word wrap
显示给定队列的信息。

positional 参数

QOS_QUEUE
要查找的 ID 或 qos_queue 的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.164. neutron quota-delete

usage: neutron quota-delete [-h] [--request-format {json,xml}] [--tenant-id tenant-id]
Copy to Clipboard Toggle word wrap
删除给定租户定义的配额。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id
tenant-id 所有者租户 ID。

9.165. neutron quota-list

usage: neutron quota-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}]
Copy to Clipboard Toggle word wrap
列出所有具有非默认配额值的租户的配额。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.166. neutron quota-show

usage: neutron quota-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id tenant-id]
Copy to Clipboard Toggle word wrap
显示给定租户的配额。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id
tenant-id 所有者租户 ID。

9.167. neutron quota-update

usage: neutron quota-update [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id tenant-id] [--network networks] [--subnet subnets] [--port ports] [--router routers] [--floatingip floatingips] [--security-group security_groups] [--security-group-rule security_group_rules] [--vip vips] [--pool pools] [--member members] [--health-monitor health_monitors]
Copy to Clipboard Toggle word wrap
定义租户的配额不使用默认值。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id
tenant-id 所有者租户 ID。
--network
网络限制。
--subnet
子网子网的限制。
--port
端口的限值。
--router
路由器限制路由器。
--floatingip
floatingips 浮动 IP 的限制。
--security-group
security_groups 安全组的限值。
--security-group-rule
security_group_rules 安全组规则的限制。
--vip
VIP 的限制。
--pool
池 的限制。
--member
成员是池成员的限值。
--health-monitor
health_monitors 运行状况监视器的限制。

9.168. neutron rbac-create

usage: neutron rbac-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] --type {network} [--target-tenant TARGET_TENANT] --action {access_as_external,access_as_shared} RBAC_OBJECT
Copy to Clipboard Toggle word wrap
为给定租户创建 RBAC 策略。

positional 参数

RBAC_OBJECT
RBAC 对象的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--type {network}
RBAC 策略影响的对象类型。
--target-tenant TARGET_TENANT
强制 RBAC 策略的租户 ID。
--action {access_as_external,access_as_shared}
RBAC 策略的操作。

9.169. neutron rbac-delete

usage: neutron rbac-delete [-h] [--request-format {json,xml}] RBAC_POLICY
Copy to Clipboard Toggle word wrap
删除 RBAC 策略。

positional 参数

RBAC_POLICY
要删除的 rbac_policy 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.170. neutron rbac-list

usage: neutron rbac-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
列出属于给定租户的 RBAC 策略。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.171. neutron rbac-show

usage: neutron rbac-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] RBAC_POLICY
Copy to Clipboard Toggle word wrap
显示给定 RBAC 策略的信息。

positional 参数

RBAC_POLICY
要查找的 ID 或 rbac_policy 的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.172. neutron rbac-update

usage: neutron rbac-update [-h] [--request-format {json,xml}] [--target-tenant TARGET_TENANT] RBAC_POLICY
Copy to Clipboard Toggle word wrap
更新给定租户的 RBAC 策略。

positional 参数

RBAC_POLICY
要更新的 rbac_policy 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--target-tenant TARGET_TENANT
强制 RBAC 策略的租户 ID。

9.173. neutron router-create

usage: neutron router-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--admin-state-down] [--distributed {True,False}] [--ha {True,False}] NAME
Copy to Clipboard Toggle word wrap
为给定租户创建路由器。

positional 参数

NAME
要创建的路由器的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--admin-state-down
将 admin state up 设置为 false。
--distributed {True,False}
创建分布式路由器。
--ha {True,False}
创建高度可用的路由器。

9.174. neutron router-delete

usage: neutron router-delete [-h] [--request-format {json,xml}] ROUTER
Copy to Clipboard Toggle word wrap
删除给定的路由器。

positional 参数

路由器
要删除的路由器的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.175. neutron router-gateway-clear

usage: neutron router-gateway-clear [-h] [--request-format {json,xml}] ROUTER
Copy to Clipboard Toggle word wrap
从路由器移除外部网络网关。

positional 参数

路由器
路由器的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.176. neutron router-gateway-set

usage: neutron router-gateway-set [-h] [--request-format {json,xml}] [--disable-snat] [--fixed-ip FIXED_IP] ROUTER EXTERNAL-NETWORK
Copy to Clipboard Toggle word wrap
设置路由器的外部网络网关。

positional 参数

路由器
路由器的 ID 或名称。
EXTERNAL-NETWORK
网关的外部网络 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--disable-snat
禁用路由器网关上的源 NAT。
--fixed-ip FIXED_IP
外部网络上所需的 IP 和/或子网:subnet_id=<name_or_id>,ip_address=<ip>。您可以重复这个选项。

9.177. neutron router-interface-add

usage: neutron router-interface-add [-h] [--request-format {json,xml}] ROUTER INTERFACE
Copy to Clipboard Toggle word wrap
添加内部网络接口到路由器。

positional 参数

路由器
路由器的 ID 或名称。
INTERFACE
格式为 "SUBNET|subnet=SUBNET|port=PORT"。必须指定子网或端口。ID 和名称都接受为 SUBNET 或 PORT。请注意,指定子网时可以省略 "subnet="。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.178. neutron router-interface-delete

usage: neutron router-interface-delete [-h] [--request-format {json,xml}] ROUTER INTERFACE
Copy to Clipboard Toggle word wrap
从路由器移除内部网络接口。

positional 参数

路由器
路由器的 ID 或名称。
INTERFACE
格式为 "SUBNET|subnet=SUBNET|port=PORT"。必须指定子网或端口。ID 和名称都接受为 SUBNET 或 PORT。请注意,指定子网时可以省略 "subnet="。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.179. neutron router-list

usage: neutron router-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
列出属于给定租户的路由器。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.180. neutron router-list-on-l3-agent

usage: neutron router-list-on-l3-agent [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] l3_agent
Copy to Clipboard Toggle word wrap
列出 L3 代理上的路由器。

positional 参数

l3_agent
要查询的 L3 代理的 ID。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.181. neutron router-port-list

usage: neutron router-port-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}] router
Copy to Clipboard Toggle word wrap
列出属于给定租户的端口,具有指定路由器。

positional 参数

路由器
要查找的路由器的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.182. neutron router-show

usage: neutron router-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] ROUTER
Copy to Clipboard Toggle word wrap
显示给定路由器的信息。

positional 参数

路由器
要查找的路由器的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.183. neutron router-update

usage: neutron router-update [-h] [--request-format {json,xml}] [--name NAME] [--admin-state-up {True,False}] [--distributed {True,False}] ROUTER
Copy to Clipboard Toggle word wrap
更新路由器的信息。

positional 参数

路由器
要更新的路由器的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--name NAME
此路由器的名称。
--admin-state-up {True,False}
指定路由器的管理状态(True 表示"启用")
--distributed {True,False}
true 表示此路由器应在分布式模式下运行。

9.184. neutron security-group-create

usage: neutron security-group-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--description DESCRIPTION] NAME
Copy to Clipboard Toggle word wrap
创建安全组。

positional 参数

NAME
安全组的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--description DESCRIPTION
安全组的描述。

9.185. neutron security-group-delete

usage: neutron security-group-delete [-h] [--request-format {json,xml}] SECURITY_GROUP
Copy to Clipboard Toggle word wrap
删除给定的安全组。

positional 参数

SECURITY_GROUP
要删除的 security_group 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.186. neutron security-group-list

usage: neutron security-group-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
列出属于给定租户的安全组。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.187. neutron security-group-rule-create

usage: neutron security-group-rule-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--direction {ingress,egress}] [--ethertype ETHERTYPE] [--protocol PROTOCOL] [--port-range-min PORT_RANGE_MIN] [--port-range-max PORT_RANGE_MAX] [--remote-ip-prefix REMOTE_IP_PREFIX] [--remote-group-id REMOTE_GROUP] SECURITY_GROUP
Copy to Clipboard Toggle word wrap
创建安全组规则。

positional 参数

SECURITY_GROUP
用于添加规则的安全组名称或 ID。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--direction {ingress,egress}
流量方向:入站/出口.
--ethertype ETHERTYPE
IPv4/IPv6
--protocol PROTOCOL
数据包协议.
--port-range-min PORT_RANGE_MIN
启动端口范围.
--port-range-max PORT_RANGE_MAX
结束端口范围。
--remote-ip-prefix REMOTE_IP_PREFIX
要匹配的 CIDR。
--remote-group-id REMOTE_GROUP
要应用规则的远程安全组名称或 ID。

9.188. neutron security-group-rule-delete

usage: neutron security-group-rule-delete [-h] [--request-format {json,xml}] SECURITY_GROUP_RULE
Copy to Clipboard Toggle word wrap
删除给定的安全组规则。

positional 参数

SECURITY_GROUP_RULE
要删除的 security_group_rule 的 ID。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.189. neutron security-group-rule-list

usage: neutron security-group-rule-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}] [--no-nameconv]
Copy to Clipboard Toggle word wrap
列出属于给定租户的安全组规则。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。
--no-nameconv
不要将安全组 ID 转换为其名称。

9.190. neutron security-group-rule-show

usage: neutron security-group-rule-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] SECURITY_GROUP_RULE
Copy to Clipboard Toggle word wrap
显示给定安全组规则的信息。

positional 参数

SECURITY_GROUP_RULE
要查找的 security_group_rule 的 ID。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.191. neutron security-group-show

usage: neutron security-group-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] SECURITY_GROUP
Copy to Clipboard Toggle word wrap
显示给定安全组的信息。

positional 参数

SECURITY_GROUP
要查找的 id 或 security_group 的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.192. neutron security-group-update

usage: neutron security-group-update [-h] [--request-format {json,xml}] [--name NAME] [--description DESCRIPTION] SECURITY_GROUP
Copy to Clipboard Toggle word wrap
更新给定的安全组。

positional 参数

SECURITY_GROUP
要更新的 security_group 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--name NAME
安全组的名称。
--description DESCRIPTION
安全组的描述。

9.193. neutron service-provider-list

usage: neutron service-provider-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
列出服务供应商。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.194. neutron subnet-create

usage: neutron subnet-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--name NAME] [--gateway GATEWAY_IP | --no-gateway] [--allocation-pool start=IP_ADDR,end=IP_ADDR] [--host-route destination=CIDR,nexthop=IP_ADDR] [--dns-nameserver DNS_NAMESERVER] [--disable-dhcp] [--enable-dhcp] [--ip-version {4,6}] [--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}] [--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}] [--subnetpool SUBNETPOOL] [--prefixlen PREFIX_LENGTH] NETWORK [CIDR]
Copy to Clipboard Toggle word wrap
为给定租户创建子网。

positional 参数

网络
此子网所属的网络 ID 或名称。
CIDR
要创建的子网 CIDR。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--name NAME
此子网的名称。
--gateway GATEWAY_IP
此子网的网关 IP。
--no-gateway
没有网关的分发。
--allocation-pool
start=IP_ADDR,end=IP_ADDR 分配池 IP 地址这个子网(这个选项可以重复)。
--host-route
destination=CIDR,nexthop=IP_ADDR Additional route (这个选项可以重复)。
--dns-nameserver DNS_NAMESERVER
此子网的 DNS 名称服务器(此选项可以重复)。
--disable-dhcp
禁用这个子网的 DHCP。
--enable-dhcp
为此子网启用 DHCP。
--ip-version {4,6} IP
要使用的版本,默认为 4。请注意,当指定 subnetpool 时,IP 版本由 subnetpool 决定,这个选项将被忽略。
--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}
IPv6 RA (路由公告)模式.
--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}
IPv6 地址模式。
--subnetpool SUBNETPOOL
此子网将从中获取 CIDR 的 id 或 subnetpool 的名称。
--prefixlen PREFIX_LENGTH
来自 subnetpool 的子网分配的前缀长度。

9.195. neutron subnet-delete

usage: neutron subnet-delete [-h] [--request-format {json,xml}] SUBNET
Copy to Clipboard Toggle word wrap
删除给定子网。

positional 参数

SUBNET
要删除的子网的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.196. neutron subnet-list

usage: neutron subnet-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
列出属于给定租户的子网。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.197. neutron subnet-show

usage: neutron subnet-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] SUBNET
Copy to Clipboard Toggle word wrap
显示给定子网的信息。

positional 参数

SUBNET
要查找的子网 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.198. neutron subnet-update

usage: neutron subnet-update [-h] [--request-format {json,xml}] [--name NAME] [--gateway GATEWAY_IP | --no-gateway] [--allocation-pool start=IP_ADDR,end=IP_ADDR] [--host-route destination=CIDR,nexthop=IP_ADDR] [--dns-nameserver DNS_NAMESERVER] [--disable-dhcp] [--enable-dhcp] SUBNET
Copy to Clipboard Toggle word wrap
更新子网的信息。

positional 参数

SUBNET
要更新的子网的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--name NAME
此子网的名称。
--gateway GATEWAY_IP
此子网的网关 IP。
--no-gateway
没有网关的分发。
--allocation-pool
start=IP_ADDR,end=IP_ADDR 分配池 IP 地址这个子网(这个选项可以重复)。
--host-route
destination=CIDR,nexthop=IP_ADDR Additional route (这个选项可以重复)。
--dns-nameserver DNS_NAMESERVER
此子网的 DNS 名称服务器(此选项可以重复)。
--disable-dhcp
禁用这个子网的 DHCP。
--enable-dhcp
为此子网启用 DHCP。

9.199. neutron subnetpool-create

usage: neutron subnetpool-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--min-prefixlen MIN_PREFIXLEN] [--max-prefixlen MAX_PREFIXLEN] [--default-prefixlen DEFAULT_PREFIXLEN] [--pool-prefix PREFIXES] [--shared] [--address-scope ADDRSCOPE] name
Copy to Clipboard Toggle word wrap
为给定租户创建一个 subnetpool。

positional 参数

名称
要创建的 subnetpool 的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--min-prefixlen MIN_PREFIXLEN
Subnetpool 最小前缀长度。
--max-prefixlen MAX_PREFIXLEN
Subnetpool 最大前缀长度.
--default-prefixlen DEFAULT_PREFIXLEN
Subnetpool 默认前缀长度.
--pool-prefix PREFIXES
Subnetpool 前缀(此选项可以重复)。
--shared
将 subnetpool 设置为 shared。
--address-scope ADDRSCOPE
与 subnetpool 关联的地址范围的 ID 或名称。前缀在地址范围之间必须是唯一的

9.200. neutron subnetpool-delete

usage: neutron subnetpool-delete [-h] [--request-format {json,xml}] SUBNETPOOL
Copy to Clipboard Toggle word wrap
删除给定的 subnetpool。

positional 参数

SUBNETPOOL
要删除的 subnetpool 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.201. neutron subnetpool-list

usage: neutron subnetpool-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
列出属于给定租户的 subnetpools。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.202. neutron subnetpool-show

usage: neutron subnetpool-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] SUBNETPOOL
Copy to Clipboard Toggle word wrap
显示给定 subnetpool 的信息。

positional 参数

SUBNETPOOL
要查找的 subnetpool 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.203. neutron subnetpool-update

usage: neutron subnetpool-update [-h] [--request-format {json,xml}] [--min-prefixlen MIN_PREFIXLEN] [--max-prefixlen MAX_PREFIXLEN] [--default-prefixlen DEFAULT_PREFIXLEN] [--pool-prefix PREFIXES] [--name NAME] [--address-scope ADDRSCOPE | --no-address-scope] SUBNETPOOL
Copy to Clipboard Toggle word wrap
更新 subnetpool 的信息。

positional 参数

SUBNETPOOL
要更新的 subnetpool 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--min-prefixlen MIN_PREFIXLEN
Subnetpool 最小前缀长度。
--max-prefixlen MAX_PREFIXLEN
Subnetpool 最大前缀长度.
--default-prefixlen DEFAULT_PREFIXLEN
Subnetpool 默认前缀长度.
--pool-prefix PREFIXES
Subnetpool 前缀(此选项可以重复)。
--name NAME
要更新的 subnetpool 的名称。
--address-scope ADDRSCOPE
与 subnetpool 关联的地址范围的 ID 或名称。前缀在地址范围之间必须是唯一的
--no-address-scope
从地址范围中分离 subnetpool

9.204. neutron vpn-ikepolicy-create

usage: neutron vpn-ikepolicy-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--description DESCRIPTION] [--auth-algorithm {sha1}] [--encryption-algorithm ENCRYPTION_ALGORITHM] [--phase1-negotiation-mode {main}] [--ike-version {v1,v2}] [--pfs {group2,group5,group14}] [--lifetime units=UNITS,value=VALUE] NAME
Copy to Clipboard Toggle word wrap
创建 IKE 策略。

positional 参数

NAME
IKE 策略的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--description DESCRIPTION
IKE 策略的描述
--auth-algorithm {sha1}
小写的验证算法。Default:sha1
--encryption-algorithm ENCRYPTION_ALGORITHM
小写的加密算法,默认为:aes-128
--phase1-negotiation-mode {main}
IKE Phase1 协商模式为小写,默认为:main
--ike-version {v1,v2}
小写的 IKE 版本为 default:v1
--pfs {group2,group5,group14}
以小写的完美转发机制,默认为:group5
--lifetime
units=UNITS,value=VALUE IKE 生命周期属性。'units'-seconds, default:seconds. 'value'-non negative integer, default:3600.

9.205. neutron vpn-ikepolicy-delete

usage: neutron vpn-ikepolicy-delete [-h] [--request-format {json,xml}] IKEPOLICY
Copy to Clipboard Toggle word wrap
删除给定的 IKE 策略。

positional 参数

IKEPOLICY
要删除的 ID 或 ikepolicy 的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.206. neutron vpn-ikepolicy-list

usage: neutron vpn-ikepolicy-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
列出属于租户的 IKE 策略。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.207. neutron vpn-ikepolicy-show

usage: neutron vpn-ikepolicy-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] IKEPOLICY
Copy to Clipboard Toggle word wrap
显示给定 IKE 策略的信息。

positional 参数

IKEPOLICY
要查找的 ID 或 ikepolicy 的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.208. neutron vpn-ikepolicy-update

usage: neutron vpn-ikepolicy-update [-h] [--request-format {json,xml}] [--lifetime units=UNITS,value=VALUE] IKEPOLICY
Copy to Clipboard Toggle word wrap
更新给定的 IKE 策略。

positional 参数

IKEPOLICY
要更新的 ID 或 ikepolicy 的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--lifetime
units=UNITS,value=VALUE IKE 生命周期属性。'units'-seconds, default:seconds. 'value'-non negative integer, default:3600.

9.209. neutron vpn-ipsecpolicy-create

usage: neutron vpn-ipsecpolicy-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--description DESCRIPTION] [--transform-protocol {esp,ah,ah-esp}] [--auth-algorithm {sha1}] [--encryption-algorithm ENCRYPTION_ALGORITHM] [--encapsulation-mode {tunnel,transport}] [--pfs {group2,group5,group14}] [--lifetime units=UNITS,value=VALUE] NAME
Copy to Clipboard Toggle word wrap
创建 IPsec 策略。

positional 参数

NAME
IPsec 策略的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--description DESCRIPTION
IPsec 策略的描述。
--transform-protocol {esp,ah,ah-esp}
以小写、默认转换协议:esp
--auth-algorithm {sha1}
小写的验证算法,默认为:sha1
--encryption-algorithm ENCRYPTION_ALGORITHM
小写的加密算法,默认为:aes-128
--encapsulation-mode {tunnel,transport}
小写的封装模式,默认:tunnel
--pfs {group2,group5,group14}
以小写的完美转发机制,默认为:group5
--lifetime
units=UNITS,value=VALUE IPsec 生命周期属性。'units'-seconds, default:seconds. 'value'-non negative integer, default:3600.

9.210. neutron vpn-ipsecpolicy-delete

usage: neutron vpn-ipsecpolicy-delete [-h] [--request-format {json,xml}] IPSECPOLICY
Copy to Clipboard Toggle word wrap
删除给定的 IPsec 策略。

positional 参数

IPSECPOLICY
要删除的 ID 或 ipsecpolicy 的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.211. neutron vpn-ipsecpolicy-list

usage: neutron vpn-ipsecpolicy-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
列出属于给定租户连接的 IPsec 策略。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.212. neutron vpn-ipsecpolicy-show

usage: neutron vpn-ipsecpolicy-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] IPSECPOLICY
Copy to Clipboard Toggle word wrap
显示给定 IPsec 策略的信息。

positional 参数

IPSECPOLICY
要查找的 ID 或 ipsecpolicy 的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.213. neutron vpn-ipsecpolicy-update

usage: neutron vpn-ipsecpolicy-update [-h] [--request-format {json,xml}] [--lifetime units=UNITS,value=VALUE] IPSECPOLICY
Copy to Clipboard Toggle word wrap
更新给定的 IPsec 策略。

positional 参数

IPSECPOLICY
要更新的 ID 或 ipsecpolicy 的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--lifetime
units=UNITS,value=VALUE IPsec 生命周期属性。'units'-seconds, default:seconds. 'value'-non negative integer, default:3600.

9.214. neutron vpn-service-create

usage: neutron vpn-service-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--admin-state-down] [--name NAME] [--description DESCRIPTION] ROUTER SUBNET
Copy to Clipboard Toggle word wrap
创建 VPN 服务。

positional 参数

路由器
VPN 服务的路由器唯一标识符。
SUBNET
VPN 服务部署的子网唯一标识符。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
--tenant-id TENANT_ID
所有者租户 ID。
--admin-state-down
将 admin state up 设置为 false。
--name NAME
为 VPN 服务设置名称。
--description DESCRIPTION
为 VPN 服务设置描述。

9.215. neutron vpn-service-delete

usage: neutron vpn-service-delete [-h] [--request-format {json,xml}] VPNSERVICE
Copy to Clipboard Toggle word wrap
删除给定的 VPN 服务。

positional 参数

VPNSERVICE
要删除的 vpnservice 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

9.216. neutron vpn-service-list

usage: neutron vpn-service-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json,xml}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
Copy to Clipboard Toggle word wrap
列出属于给定租户的 VPN 服务配置。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。
-p SIZE, --page-size SIZE
指定每个请求的检索单元,然后将一个请求分成多个请求。
--sort-key FIELD
根据指定方向中的指定字段对列表进行排序。您可以重复这个选项,但您必须指定相等的 sort_dir 和 sort_key 值。额外的 sort_dir 选项将被忽略。缺少 sort_dir 选项使用默认 asc 值。
--sort-dir {asc,desc}
按照指定方向对列表进行排序。您可以重复这个选项。

9.217. neutron vpn-service-show

usage: neutron vpn-service-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json,xml}] [-D] [-F FIELD] VPNSERVICE
Copy to Clipboard Toggle word wrap
显示给定 VPN 服务的信息。

positional 参数

VPNSERVICE
要查找的 ID 或 vpnservice 的名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。
-d, --show-details
显示详细信息。
-f FIELD, --field FIELD
指定要由 server 返回的字段。您可以重复这个选项。

9.218. neutron vpn-service-update

usage: neutron vpn-service-update [-h] [--request-format {json,xml}] VPNSERVICE
Copy to Clipboard Toggle word wrap
更新给定的 VPN 服务。

positional 参数

VPNSERVICE
要更新的 vpnservice 的 ID 或名称。

可选参数

-h, --help
显示帮助信息并退出
--request-format {json,xml}
XML 或 JSON 请求格式。

第 10 章 neutron-debug 命令行客户端

neutron-debug 客户端是 OpenStack neutron -debug 工具的 neutron 命令行界面(CLI)的扩展。本章记录了 neutron-debug 版本 2.3.0。
有关特定 neutron-debug 命令的帮助信息,请输入:
$ neutron-debug help COMMAND
Copy to Clipboard Toggle word wrap

10.1. neutron-debug 用法

 [--os-password <auth-password>] [--os-tenant-name <auth-tenant-name>] [--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>] [--os-region-name <region-name>] [--service-type <service-type>] [--service-name <service-name>] [--volume-service-name <volume-service-name>] [--endpoint-type <endpoint-type>] [--os-volume-api-version <volume-api-ver>] [--os-cacert <ca-certificate>] [--retries <retries>] <subcommand> ... 
Copy to Clipboard Toggle word wrap

子命令

probe-create
创建探测端口 - 在网络命名空间内创建端口和接口。
probe-list
列出所有探测。
probe-clear
清除所有探测。
probe-delete
删除探测 - 删除端口,然后删除命名空间。
probe-exec
在探测的命名空间中执行命令。
ping-all
ping-all 是一体化命令,用于 ping 指定网络中所有固定 IP。

10.2. neutron-debug 可选参数

--version
显示版本号并退出。
-v, --verbose, --debug
提高输出的详细程度,并显示错误的回溯。可以重复。
-q, --quiet
抑制输出,除了警告和错误
-h, --help
显示帮助信息并退出
--os-auth-strategy <auth-strategy>
身份验证策略(Env: OS_AUTH_STRATEGY,默认 keystone)。现在,任何其他值将禁用身份验证
--os-auth-url <auth-url>
身份验证 URL (Env: OS_AUTH_URL)
--os-tenant-name <auth-tenant-name>
身份验证租户名称(Env: OS_TENANT_NAME)
--os-tenant-id <auth-tenant-id>
身份验证租户名称(Env: OS_TENANT_ID)
--os-username <auth-username>
身份验证用户名(Env: OS_USERNAME)
--os-password <auth-password>
身份验证密码(Env: OS_PASSWORD)
--os-region-name <auth-region-name>
身份验证区域名称(Env: OS_REGION_NAME)
--os-token <token>
默认为 env[OS_TOKEN]
--endpoint-type <endpoint-type>
默认为 env[OS_ENDPOINT_TYPE] 或公共 URL。
--os-url <url>
默认为 env[OS_URL]
--os-cacert <ca-certificate>
指定用于验证 TLS (https)服务器证书中使用的 CA 捆绑包文件。默认为 env[OS_CACERT]
--insecure
明确允许 neutron-debug 执行"不安全"SSL (https)请求。服务器的证书不会针对任何证书颁发机构进行验证。这个选项应谨慎使用。
--config-file CONFIG_FILE
接口驱动程序的配置文件(您可能也使用 l3_agent.ini)

10.3. neutron-debug probe-create 命令

usage: neutron-debug probe-create NET
Copy to Clipboard Toggle word wrap
创建探测端口 - 创建端口和接口,然后将其放入创建的网络命名空间。

positional 参数

网络 ID
创建探测的网络 ID。

10.4. neutron-debug probe-list 命令

usage: neutron-debug probe-list
Copy to Clipboard Toggle word wrap
列出探测。

10.5. neutron-debug probe-clear 命令

usage: neutron-debug probe-clear
Copy to Clipboard Toggle word wrap
清除所有探测。

10.6. neutron-debug probe-delete 命令

usage: neutron-debug probe-delete <port-id>
Copy to Clipboard Toggle word wrap
删除探测。

positional 参数

<port-id>
要删除的探测的 ID。

10.7. neutron-debug probe-exec 命令

usage: neutron-debug probe-exec <port-id> <command>
Copy to Clipboard Toggle word wrap
在探测的命名空间中执行命令

10.8. neutron-debug ping-all 命令

usage: neutron-debug ping-all <port-id> --timeout <number
Copy to Clipboard Toggle word wrap
用于 ping 指定网络中所有固定 IP 的 all-in-one 命令。

positional 参数

<port-id>
要使用的端口的 ID。

可选参数

--timeout <timeout in seconds>
可选的 ping 超时。

10.9. neutron-debug 示例

usage: neutron-debug create-probe < NET_ID>
Copy to Clipboard Toggle word wrap
在由 NET_ID 标识的网络中创建探测命名空间。命名空间将具有探测 port> 的 qprobe-<UUID 的名称
注意
要使以下示例正常工作,可能需要修改安全组规则以允许 SSH (TCP 端口 22)或 ping (ICMP)流量到网络。
usage: neutron-debug probe-exec <probe ID> "ssh <IP of instance>"
Copy to Clipboard Toggle word wrap
SSH 到网络中的实例。
usage: neutron-debug ping-all <network ID>"
Copy to Clipboard Toggle word wrap
Ping 此网络上的所有实例,以验证它们是否响应。
usage: neutron-debug probe-exec <probe_ID> dhcping <VM_MAC address> -s <IP of DHCP server>"
Copy to Clipboard Toggle word wrap
使用 dhcping 对此网络的 DHCP 服务器发出 ping 命令,以验证它是否正常工作。

第 11 章 对象存储命令行客户端

swift 客户端是 OpenStack Object Storage API 及其扩展的命令行界面(CLI)。本章记录了 swift 版本 2.6.0
有关特定 swift 命令的帮助信息,请输入:
$ swift COMMAND --help
Copy to Clipboard Toggle word wrap

11.1. Swift 用法

Usage: swift [--version] [--help] [--os-help] [--snet] [--verbose] [--debug] [--info] [--quiet] [--auth <auth_url>] [--auth-version <auth_version>] [--user <username>] [--key <api_key>] [--retries <num_retries>] [--os-username <auth-user-name>] [--os-password <auth-password>] [--os-user-id <auth-user-id>] [--os-user-domain-id <auth-user-domain-id>] [--os-user-domain-name <auth-user-domain-name>] [--os-tenant-id <auth-tenant-id>] [--os-tenant-name <auth-tenant-name>] [--os-project-id <auth-project-id>] [--os-project-name <auth-project-name>] [--os-project-domain-id <auth-project-domain-id>] [--os-project-domain-name <auth-project-domain-name>] [--os-auth-url <auth-url>] [--os-auth-token <auth-token>] [--os-storage-url <storage-url>] [--os-region-name <region-name>] [--os-service-type <service-type>] [--os-endpoint-type <endpoint-type>] [--os-cacert <ca-certificate>] [--insecure] [--no-ssl-compression] <subcommand> [--help] [<subcommand options>]
Copy to Clipboard Toggle word wrap

子命令

delete
删除容器内的容器或对象。
下载
从容器下载对象。
list
列出容器用于帐户或容器的对象。
POST
更新帐户、容器或对象的元信息;如果不存在,则创建容器。
stat
显示帐户、容器或对象的信息。
上传
将文件或目录上传到给定容器。
功能
列出集群功能。
tempurl
创建临时 URL。
auth
显示与身份验证相关的环境变量。

11.2. Swift 示例

 swift download --help swift -A https://auth.api.rackspacecloud.com/v1.0 -U user -K api_key stat -v swift --os-auth-url https://api.example.com/v2.0 --os-tenant-name tenant \ --os-username user --os-password password list swift --os-auth-url https://api.example.com/v3 --auth-version 3\ --os-project-name project1 --os-project-domain-name domain1 \ --os-username user --os-user-domain-name domain1 \ --os-password password list swift --os-auth-url https://api.example.com/v3 --auth-version 3\ --os-project-id 0123456789abcdef0123456789abcdef \ --os-user-id abcdef0123456789abcdef0123456789 \ --os-password password list swift --os-auth-token 6ee5eb33efad4e45ab46806eac010566 \ --os-storage-url https://10.1.5.2:8080/v1/AUTH_ced809b6a4baea7aeab61a \ list swift list --lh
Copy to Clipboard Toggle word wrap

11.3. Swift 可选参数

--version
显示程序的版本号并退出
-h, --help
显示帮助信息并退出
--os-help
显示 OpenStack 身份验证选项。
-s, --snet
使用 SERVICENET 内部网络。
-v, --verbose
打印更多信息.
--debug
显示 curl 命令以及所有 http 查询的结果,而不考虑结果状态。
--info
显示 curl 命令和返回错误的所有 http 查询的结果。
-q, --quiet
抑制状态输出。
-a AUTH, --auth=AUTH URL
用于获取身份验证令牌。
-v AUTH_VERSION, --auth-version=AUTH_VERSION
指定用于身份验证的版本。默认值为 1.0。
-u USER, --user=USER
用于获取身份验证令牌的用户名。
-k KEY, --key=KEY
获取身份验证令牌的密钥。
-r RETRIES, --retries=RETRIES
重新尝试失败的连接的次数。
--insecure
允许 swiftclient 在无需验证 SSL 证书的情况下访问服务器。默认为 env[SWIFTCLIENT_INSECURE] (设置为 'true' 来启用)。
--no-ssl-compression
这个选项已弃用,不再使用。系统 SSL 库应默认禁用 SSL 压缩。

11.4. Swift auth

Usage: swift auth
Copy to Clipboard Toggle word wrap
以 shell 友好格式显示与身份验证相关的身份验证变量。
运行将存储 url 和 auth 令牌导出到 OS_STORAGE_URL 和 OS_AUTH_TOKEN 的命令:
swift auth
Copy to Clipboard Toggle word wrap
附加到 runcom 文件(如 ~/.bashrc/etc/profile)的命令用于自动身份验证:
swift auth -v -U test:tester -K testing           -A http://localhost:8080/auth/v1.0
Copy to Clipboard Toggle word wrap

11.5. Swift 功能

Usage: swift capabilities
Copy to Clipboard Toggle word wrap
检索代理的功能。

可选位置参数

<proxy_url>
用于检索功能的集群的代理 URL。

11.6. Swift 删除

Usage: swift delete
Copy to Clipboard Toggle word wrap
删除容器内的容器或对象。

positional 参数

<container>
要从中删除的容器的名称。
[object]
要删除的对象名称。为多个对象指定多次。

可选参数

-a, --all
删除所有容器和对象。
--leave-segments
不要删除清单对象的片段。
--object-threads <threads>
用于删除对象的线程数量。默认值为 10。
--container-threads <threads>
用于删除容器的线程数量。默认值为 10。

11.7. Swift 下载

Usage: swift download
Copy to Clipboard Toggle word wrap
从容器下载对象。

positional 参数

<container>
要从中下载的容器的名称。要下载整个帐户,请省略它并指定 --all。
<object>
要下载的对象名称。为多个对象指定多次。省略此项以从容器中下载所有对象。

可选参数

-a, --all
表示您真正想下载帐户中的所有内容。
-m, --marker
启动容器或帐户下载时要使用的标记。
-p, --prefix <prefix>
仅下载以 <prefix> 开头的项目
-r, --remove-prefix
--prefix <prefix> 的可选标志,使用这个选项下载没有 <prefix> 的项目
-o, --output <out_file>
对于单个文件下载,将输出流传输到 <out_file>。将 "-" 指定为 <out_file> 将重定向到 stdout。
-D, --output-dir <out_directory>
用于存储对象的可选目录。默认情况下,所有对象都会在当前目录中重新创建。
--object-threads <threads>
用于下载对象的线程数量。默认值为 10。
--container-threads <threads>
用于下载容器的线程数量。默认值为 10。
--no-download
执行下载,但并不实际写入磁盘。
-H, --header <header:value>
在查询中添加自定义请求标头,如 "Range" 或 "If-Match"。此选项可能重复。示例 --header "content-type:text/plain"
--skip-identical
跳过两个端上相同的下载文件。
--no-shuffle
默认情况下,当下载完整的帐户或容器时,下载顺序是随机的,以便在多个客户端同时执行多个客户端时减少单个驱动器的负载,以下载同一组对象(例如,每日自动下载脚本到多个服务器)。启用此选项,按对象存储中列出的顺序将下载作业提交到线程池。

11.8. Swift 列表

Usage: swift list
Copy to Clipboard Toggle word wrap
列出容器用于帐户或容器的对象。

positional 参数

[container]
列出对象所在的容器的名称。

可选参数

-l,--long
长列表格式,类似于 ls -l。
--lh
以人类可读的格式报告大小,类似于 ls -lh。
-t, --totals
与 -l 或 --lh 一起使用,仅报告总计。
-p, --prefix
仅列出以前缀开头的项目。
-d, --delimiter
使用给定的分隔符汇总项目。仅限容器。有关这一含义,请参阅 OpenStack Swift API 文档。

11.9. Swift post

Usage: swift post
Copy to Clipboard Toggle word wrap
更新帐户、容器或对象的元信息。如果没有找到容器,则会自动创建容器。

positional 参数

[container]
要发布到的容器的名称。
[object]
要发布的对象名称。

可选参数

-r, --read-acl <acl>
容器读取 ACL。ACL 语法快速摘要:.r:*, .r:-.example.com, .r:www.example.com, account1, account2:user2
-w, --write-acl <acl>
为容器写入 ACL。ACL 语法快速摘要:account1 account2:user2
-t, --sync-to <sync-to>
为容器同步,用于多集群复制。
-k, --sync-key <sync-key>
容器同步密钥,用于多集群复制。
-m, --meta <name:value>
设置 meta 数据项。此选项可能重复。示例: -m Color:Blue -m Size:Large
-H, --header <header:value>
添加自定义请求标头。此选项可能重复。示例 -H "content-type:text/plain" -H "Content-Length: 4000"

11.10. Swift stat

Usage: swift stat
Copy to Clipboard Toggle word wrap
显示帐户、容器或对象的信息。

positional 参数

[container]
从其中指出的容器的名称。
[object]
要 stat 的对象名称。

可选参数

--lh
以人类可读的格式报告大小,类似于 ls -lh。

11.11. Swift tempurl

Usage: swift tempurl
Copy to Clipboard Toggle word wrap
为 Swift 对象生成临时 URL。

positional 参数

<method>
允许此临时 URL 的 HTTP 方法。通常为 'GET' 或 'PUT'。
<seconds>
临时 URL 有效的时间(以秒为单位);或者,如果传递 --absolute,则临时 URL 过期时 Unix 时间戳的时间(以秒为单位)。
<path>
Swift 对象的完整路径。示例:/v1/AUTH_account/c/o.
<key>
Swift 集群上设置的 secret 临时 URL 密钥。要设置密钥,请运行 'swift post -m "Temp-URL-Key:b3968d0207b54ece87cc06515a89d4"'

可选参数

--absolute
将 <seconds> 位置参数作为 Unix 时间戳而不是将来的秒数。

11.12. Swift 上传

Usage: swift upload
Copy to Clipboard Toggle word wrap
将指定的文件和目录上传到给定容器。

positional 参数

<container>
要上传到的容器的名称。
<file_or_directory>
要上传的文件或目录的名称。多次指定多次进行多次上传。

可选参数

-c,--changed
仅上传自上次上传以来更改的文件。
--skip-identical
跳过上传两端上相同文件的上传文件。
-s, --segment-size <size>
在片段中上传文件不大于 <size> (在 Bytes 中),然后创建一个"manifest"文件,它将下载所有片段,就像它是原始文件一样。
--segment-container <container>
将片段上传到指定的容器中。如果没有指定,则片段将上传到 <container>_segments 容器,以不轮询主 <container> 列表。
--leave-segments
表示您希望单独保留了旧的清单对象片段(当覆盖时)。
--object-threads <threads>
用于上传完整对象的线程数量。默认值为 10。
--segment-threads <threads>
用于上传对象片段的线程数量。默认值为 10。
-H, --header <header:value>
添加自定义请求标头。此选项可能重复。示例 -H "content-type:text/plain" -H "Content-Length: 4000"。
--use-slo
与 --segment-size 一起使用时,它将创建一个静态 Large 对象,而不是默认的 Dynamic Large 对象。
--object-name <object-name>
将 file 和 name 对象上传到 <object-name> 或 upload dir,并使用 <object-name> 作为对象前缀,而不是文件夹名称。
--ignore-checksum
关闭 checksum 验证以上传。

第 12 章 编配服务命令行客户端

heat 客户端是编排服务 API 及其扩展命令行界面(CLI)。本章记录了 heat 版本 0.8.0
有关特定 heat 命令的帮助信息,请输入:
$ heat help COMMAND
Copy to Clipboard Toggle word wrap

12.1. Heat 用法

usage: heat [--version] [-d] [-v] [--api-timeout API_TIMEOUT] [--os-no-client-auth] [--heat-url HEAT_URL] [--heat-api-version HEAT_API_VERSION] [--include-password] [-k] [--os-cert OS_CERT] [--cert-file OS_CERT] [--os-key OS_KEY] [--key-file OS_KEY] [--os-cacert <ca-certificate-file>] [--ca-file OS_CACERT] [--os-username OS_USERNAME] [--os-user-id OS_USER_ID] [--os-user-domain-id OS_USER_DOMAIN_ID] [--os-user-domain-name OS_USER_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID] [--os-project-name OS_PROJECT_NAME] [--os-project-domain-id OS_PROJECT_DOMAIN_ID] [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] [--os-password OS_PASSWORD] [--os-tenant-id OS_TENANT_ID] [--os-tenant-name OS_TENANT_NAME] [--os-auth-url OS_AUTH_URL] [--os-region-name OS_REGION_NAME] [--os-auth-token OS_AUTH_TOKEN] [--os-service-type OS_SERVICE_TYPE] [--os-endpoint-type OS_ENDPOINT_TYPE] [--profile HMAC_KEY] <subcommand> ...
Copy to Clipboard Toggle word wrap

子命令

action-check
检查堆栈资源是否处于预期状态。
action-resume
恢复堆栈。
action-suspend
暂停堆栈。
build-info
检索构建信息。
config-create
创建软件配置。
config-delete
删除软件配置。
config-show
查看软件配置的详细信息。
deployment-create
创建软件部署。
deployment-delete
删除软件部署。
deployment-list
列出软件部署。
deployment-metadata-show
获取指定服务器的部署配置元数据。
deployment-output-show
显示特定的部署输出。
deployment-show
显示软件部署的详细信息。
event
弃用!改为使用 event-show。
event-list
列出堆栈的事件。
event-show
描述事件。
hook-clear
清除给定堆栈上的 hook。
hook-poll
列出堆栈的待处理 hook 资源。
output-list
显示可用的输出。
output-show
显示特定的堆栈输出。
resource-list
显示属于堆栈的资源列表。
resource-metadata
列出资源元数据。
resource-show
描述资源。
resource-signal
发送信号到资源。
resource-template
弃用!改为使用 resource-type-template。
resource-type-list
列出可用的资源类型。
resource-type-show
显示资源类型。
resource-type-template
根据资源类型生成模板。
service-list
列出 Heat 引擎。
snapshot-delete
删除堆栈的快照。
snapshot-list
列出堆栈的快照。
snapshot-show
显示堆栈的快照。
stack-abandon
取消堆栈。
stack-adopt
采用堆栈。
stack-cancel-update
取消当前运行堆栈的更新。
stack-create
创建堆栈。
stack-delete
删除堆栈。
stack-list
列出用户的堆栈。
stack-preview
堆栈预览。
stack-restore
恢复堆栈的快照。
stack-show
描述堆栈。
stack-snapshot
生成堆栈的快照。
stack-update
更新堆栈。
template-function-list
列出可用的功能。
template-show
获取指定堆栈的模板。
template-validate
使用参数验证模板。
template-version-list
列出可用的模板版本。
bash-completion
将所有命令和选项输出到 stdout。
帮助
显示有关该程序或其其中一个子命令的帮助。

12.2. Heat 可选参数

--version
显示客户端版本并退出。
-d, --debug
默认为 env[HEATCLIENT_DEBUG]
-v, --verbose
打印更详细的输出。
--api-timeout API_TIMEOUT
等待 API 响应的秒数,默认为系统套接字超时
--os-no-client-auth
不要联系令牌的 keystone。默认为 env[OS_NO_CLIENT_AUTH]
--Heat-url HEAT_URL
默认为 env[HEAT_URL]
--Heat-api-version HEAT_API_VERSION
默认为 env[HEAT_API_VERSION] 或 1。
--include-password
将 os-username 和 os-password 发送到 heat。
-k, --insecure
明确允许 heatclient 执行"不安全 SSL" (https)请求。服务器的证书不会针对任何证书颁发机构进行验证。这个选项应谨慎使用。
--os-cert OS_CERT
SSL 连接中使用的证书文件的路径。此文件可以选择使用私钥前添加。
--cert-file OS_CERT
弃用!使用 --os-cert。
--os-key OS_KEY
SSL 连接中使用的客户端密钥的路径。如果您的密钥在您的证书文件前面添加,则不需要这个选项。
--key-file OS_KEY
弃用!使用 --os-key。
--os-cacert <ca-certificate-file>
用于验证远程服务器证书的 CA TLS 证书的路径。如果没有此选项,则 glance 会查找默认的系统 CA 证书。
--ca-file OS_CACERT
弃用!使用 --os-cacert。
--os-username OS_USERNAME
默认为 env[OS_USERNAME]
--os-user-id OS_USER_ID
默认为 env[OS_USER_ID]
--os-user-domain-id OS_USER_DOMAIN_ID
默认为 env[OS_USER_DOMAIN_ID]
--os-user-domain-name OS_USER_DOMAIN_NAME
默认为 env[OS_USER_DOMAIN_NAME]
--os-project-id OS_PROJECT_ID
指定租户 ID 的另一种方式。这个选项与 --os-tenant-id 相互排斥。默认为 env[OS_PROJECT_ID]
--os-project-name OS_PROJECT_NAME
指定租户名称的另一种方法。这个选项与 --os-tenant-name 相互排斥。默认为 env[OS_PROJECT_NAME]
--os-project-domain-id OS_PROJECT_DOMAIN_ID
默认为 env[OS_PROJECT_DOMAIN_ID]
--os-project-domain-name OS_PROJECT_DOMAIN_NAME
默认为 env[OS_PROJECT_DOMAIN_NAME]
--os-password OS_PASSWORD
默认为 env[OS_PASSWORD]
--os-tenant-id OS_TENANT_ID
默认为 env[OS_TENANT_ID]
--os-tenant-name OS_TENANT_NAME
默认为 env[OS_TENANT_NAME]
--os-auth-url OS_AUTH_URL
默认为 env[OS_AUTH_URL]
--os-region-name OS_REGION_NAME
默认为 env[OS_REGION_NAME]
--os-auth-token OS_AUTH_TOKEN
默认为 env[OS_AUTH_TOKEN]
--os-service-type OS_SERVICE_TYPE
默认为 env[OS_SERVICE_TYPE]
--os-endpoint-type OS_ENDPOINT_TYPE
默认为 env[OS_ENDPOINT_TYPE]
--profile HMAC_KEY
HMAC 密钥用于加密上下文数据以进行操作性能分析。这个键应该是 heat 中 osprofiler 中间件中配置的 HMAC 键的值,它在粘贴配置(/etc/heat/api-paste.ini)中指定。如果没有密钥,即使服务器端启用了 osprofiler,也不会触发性能分析。

12.3. heat action-check

usage: heat action-check <NAME or ID>
Copy to Clipboard Toggle word wrap
检查堆栈资源是否处于预期状态。

positional 参数

<NAME 或 ID>
要检查的堆栈的名称或 ID。

12.4. heat action-resume

usage: heat action-resume <NAME or ID>
Copy to Clipboard Toggle word wrap
恢复堆栈。

positional 参数

<NAME 或 ID>
要恢复的堆栈的名称或 ID。

12.5. heat action-suspend

usage: heat action-suspend <NAME or ID>
Copy to Clipboard Toggle word wrap
暂停堆栈。

positional 参数

<NAME 或 ID>
要暂停的堆栈的名称或 ID。

12.6. Heat build-info

usage: heat build-info
Copy to Clipboard Toggle word wrap
检索构建信息。

12.7. heat config-create

usage: heat config-create [-f <FILE or URL>] [-c <FILE or URL>] [-g <GROUP_NAME>] <CONFIG_NAME>
Copy to Clipboard Toggle word wrap
创建软件配置。

positional 参数

<CONFIG_NAME>
要创建的配置的名称。

可选参数

-f <FILE 或 URL>, --definition-file <FILE 或 URL>
包含定义 <inputs>、<outputs> 和 <options> 的映射的 JSON/YAML 的路径。
-c <FILE 或 URL>, --config-file <FILE 或 URL>
配置脚本/数据的路径。
-g <GROUP_NAME>, --group <GROUP_NAME>
配置预期的配置工具的组名称。

12.8. heat config-delete

usage: heat config-delete <ID> [<ID> ...]
Copy to Clipboard Toggle word wrap
删除软件配置。

positional 参数

<ID>
要删除的配置 ID。

12.9. heat config-show

usage: heat config-show [-c] <ID>
Copy to Clipboard Toggle word wrap
查看软件配置的详细信息。

positional 参数

<ID>
配置的 ID。

可选参数

-c, --config-only
仅显示 <config> 属性的值。

12.10. heat deployment-create

usage: heat deployment-create [-i <KEY=VALUE>] [-a <ACTION>] [-c <CONFIG>] -s <SERVER> [-t <TRANSPORT>] [--container <CONTAINER_NAME>] [--timeout <TIMEOUT>] <DEPLOY_NAME>
Copy to Clipboard Toggle word wrap
创建软件部署。

positional 参数

<DEPLOY_NAME>
与此部署关联的派生配置的名称。这用于将排序顺序应用到当前部署到服务器的配置列表中。

可选参数

-i <KEY=VALUE>, --input-value <KEY=VALUE>
要在部署上设置的输入值。这可以多次指定。
-a <ACTION>, --action <ACTION>
此部署的操作名称。可以是自定义操作,也可以是以下之一: CREATE、UPDATE、DELETE、SUSPEND、RESUME
-c <CONFIG>, --config <CONFIG>
要部署的配置的 ID。
-s <SERVER>, --server <SERVER>
要部署到的服务器 ID。
-t <TRANSPORT>, --signal-transport <TRANSPORT>
服务器如何通过部署输出值向 heat 发出信号。TEMP_URL_SIGNAL 将创建一个 Swift TempURL,以通过 HTTP PUT 发出信号。NO_SIGNAL 将导致资源进入 COMPLETE 状态,而不等待任何信号。
--Container <CONTAINER_NAME>
要存储 TEMP_SIGNAL 对象的容器名称。如果没有指定容器,则会使用从 DEPLOY_NAME 派生的名称创建容器
--timeout <TIMEOUT>
部署超时(以分钟为单位)。

12.11. Heat deployment-delete

usage: heat deployment-delete <ID> [<ID> ...]
Copy to Clipboard Toggle word wrap
删除软件部署。

positional 参数

<ID>
要删除的部署 ID。

12.12. heat deployment-list

usage: heat deployment-list [-s <SERVER>]
Copy to Clipboard Toggle word wrap
列出软件部署。

可选参数

-s <SERVER>, --server <SERVER>
要获取部署的服务器的 ID。

12.13. heat deployment-metadata-show

usage: heat deployment-metadata-show <ID>
Copy to Clipboard Toggle word wrap
获取指定服务器的部署配置元数据。

positional 参数

<ID>
要获取部署的服务器的 ID。

12.14. heat deployment-output-show

usage: heat deployment-output-show [-a] [-F <FORMAT>] <ID> [<OUTPUT NAME>]
Copy to Clipboard Toggle word wrap
显示特定的部署输出。

positional 参数

<ID>
显示输出的 ID 部署。
<OUTPUT NAME>
要显示的输出名称。

可选参数

-a, --all
显示所有部署输出。
-F <FORMAT>, --format <FORMAT>
输出格式,其中一个:raw、json

12.15. heat deployment-show

usage: heat deployment-show <ID>
Copy to Clipboard Toggle word wrap
显示软件部署的详细信息。

positional 参数

<ID>
部署的 ID。

12.16. heat event-list

usage: heat event-list [-r <RESOURCE>] [-f <KEY1=VALUE1;KEY2=VALUE2...>] [-l <LIMIT>] [-m <ID>] [-n <DEPTH>] [-F <FORMAT>] <NAME or ID>
Copy to Clipboard Toggle word wrap
列出堆栈的事件。

positional 参数

<NAME 或 ID>
用于显示事件的堆栈的名称或 ID。

可选参数

-r <RESOURCE>, --resource <RESOURCE>
用于过滤事件的资源名称。
-f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2..>
过滤要应用到返回的事件的参数。这可以多次指定,或使用以分号分开的参数一次指定。
-L <LIMIT>, --limit <LIMIT>
限制返回的事件数量。
-m <ID>, --marker <ID>
仅返回给定事件 ID 后出现的事件。
-n <DEPTH>, --nested-depth <DEPTH>
从中显示事件的嵌套堆栈的深度。请注意,这无法通过 --resource 指定。
-F <FORMAT>, --format <FORMAT>
输出格式,其中之一: log, table

12.17. heat event-show

usage: heat event-show <NAME or ID> <RESOURCE> <EVENT>
Copy to Clipboard Toggle word wrap
描述事件。

positional 参数

<NAME 或 ID>
用于显示事件的堆栈的名称或 ID。
<RESOURCE>
事件所属的资源名称。
<EVENT>
显示详情的事件 ID。

12.18. heat hook-clear

usage: heat hook-clear [--pre-create] [--pre-update] <NAME or ID> <RESOURCE> [<RESOURCE> ...]
Copy to Clipboard Toggle word wrap
清除给定堆栈上的 hook。

positional 参数

<NAME 或 ID>
这些资源所属堆栈的名称或 ID。
<RESOURCE>
带有 hook 的资源名称需要清除。可以使用斜杠作为分隔符来设置嵌套堆栈中的资源: nested_stack/another/my_resource。您可以使用通配符来匹配多个堆栈或资源: nested_stack/an* configured_resource

可选参数

--pre-create
清除 pre-create hook (可选)
--pre-update
清除 pre-update hook (可选)

12.19. heat hook-poll

usage: heat hook-poll [-n <DEPTH>] <NAME or ID>
Copy to Clipboard Toggle word wrap
列出堆栈的待处理 hook 资源。

positional 参数

<NAME 或 ID>
堆栈的名称或 ID,以显示待处理的 hook。

可选参数

-n <DEPTH>, --nested-depth <DEPTH>
深度显示 hook 的嵌套堆栈。

12.20. heat output-list

usage: heat output-list <NAME or ID>
Copy to Clipboard Toggle word wrap
显示可用的输出。

positional 参数

<NAME 或 ID>
要查询的堆栈的名称或 ID。

12.21. heat output-show

usage: heat output-show [-a] [-F <FORMAT>] <NAME or ID> [<OUTPUT NAME>]
Copy to Clipboard Toggle word wrap
显示特定的堆栈输出。

positional 参数

<NAME 或 ID>
要查询的堆栈的名称或 ID。
<OUTPUT NAME>
要显示的输出名称。

可选参数

-a, --all
显示所有堆栈输出。
-F <FORMAT>, --format <FORMAT>
输出格式,其中一个: json、raw

12.22. heat resource-list

usage: heat resource-list [-n <DEPTH>] [--with-detail] <NAME or ID>
Copy to Clipboard Toggle word wrap
显示属于堆栈的资源列表。

positional 参数

<NAME 或 ID>
用于显示其资源的堆栈名称或 ID。

可选参数

-n <DEPTH>, --nested-depth <DEPTH>
从中显示资源的嵌套堆栈的深度。
--with-detail
启用为资源列表中显示的每个资源的详细信息。

12.23. heat resource-metadata

usage: heat resource-metadata <NAME or ID> <RESOURCE>
Copy to Clipboard Toggle word wrap
列出资源元数据。

positional 参数

<NAME 或 ID>
用于显示资源元数据的堆栈名称或 ID。
<RESOURCE>
显示元数据的资源名称。

12.24. heat resource-show

usage: heat resource-show [-a <ATTRIBUTE>] <NAME or ID> <RESOURCE>
Copy to Clipboard Toggle word wrap
描述资源。

positional 参数

<NAME 或 ID>
用于显示其资源的堆栈名称或 ID。
<RESOURCE>
要显示详细信息的资源的名称。

可选参数

-a <ATTRIBUTE>, --with-attr <ATTRIBUTE>
要显示的属性,可以多次指定。

12.25. heat resource-signal

usage: heat resource-signal [-D <DATA>] [-f <FILE>] <NAME or ID> <RESOURCE>
Copy to Clipboard Toggle word wrap
发送信号到资源。

positional 参数

<NAME 或 ID>
资源所属的堆栈的名称或 ID。
<RESOURCE>
要信号的资源的名称。

可选参数

-d <DATA>, --data <DATA>
要发送到信号处理程序的 JSON 数据。
-f <FILE>, --data-file <FILE>
包含要发送到信号处理程序的 JSON 数据的文件。

12.26. heat resource-type-list

usage: heat resource-type-list [-f <KEY1=VALUE1;KEY2=VALUE2...>]
Copy to Clipboard Toggle word wrap
列出可用的资源类型。

可选参数

-f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2..>
过滤要应用到返回的资源类型的参数。这可以多次指定,或使用以分号分开的参数一次指定。它可以是任何 name、version 和 support_status

12.27. heat resource-type-show

usage: heat resource-type-show <RESOURCE_TYPE>
Copy to Clipboard Toggle word wrap
显示资源类型。

positional 参数

<RESOURCE_TYPE>
用于获取.

12.28. heat resource-type-template

usage: heat resource-type-template [-t <TEMPLATE_TYPE>] [-F <FORMAT>] <RESOURCE_TYPE>
Copy to Clipboard Toggle word wrap
根据资源类型生成模板。

positional 参数

<RESOURCE_TYPE>
生成模板的资源类型。

可选参数

-T <TEMPLATE_TYPE>, --template-type <TEMPLATE_TYPE>
要生成、热或 cfn 的模板类型。
-F <FORMAT>, --format <FORMAT>
模板输出格式,其中之一: yaml、json。

12.29. heat service-list

usage: heat service-list
Copy to Clipboard Toggle word wrap
列出 Heat 引擎。

12.30. heat snapshot-delete

usage: heat snapshot-delete <NAME or ID> <SNAPSHOT>
Copy to Clipboard Toggle word wrap
删除堆栈的快照。

positional 参数

<NAME 或 ID>
包含快照的堆栈的名称或 ID。
<SNAPSHOT>
要删除的快照的 ID。

12.31. heat snapshot-list

usage: heat snapshot-list <NAME or ID>
Copy to Clipboard Toggle word wrap
列出堆栈的快照。

positional 参数

<NAME 或 ID>
包含快照的堆栈的名称或 ID。

12.32. heat snapshot-show

usage: heat snapshot-show <NAME or ID> <SNAPSHOT>
Copy to Clipboard Toggle word wrap
显示堆栈的快照。

positional 参数

<NAME 或 ID>
包含快照的堆栈的名称或 ID。
<SNAPSHOT>
要显示的快照 ID。

12.33. heat stack-abandon

usage: heat stack-abandon [-O <FILE>] <NAME or ID>
Copy to Clipboard Toggle word wrap
取消堆栈。这将从 Heat 中删除堆栈的记录,但不会删除任何底层资源。将堆栈采用的 JSON 表示打印到 stdout 或成功文件时的文件。

positional 参数

<NAME 或 ID>
带给的堆栈名称或 ID。

可选参数

-o <FILE>, --output-file <FILE>
输出带外结果的文件。如果指定了该选项,则结果将输出到 <FILE>。

12.34. heat stack-adopt

usage: heat stack-adopt [-e <FILE or URL>] [-c <TIMEOUT>] [-t <TIMEOUT>] [-a <FILE or URL>] [-r] [-P <KEY1=VALUE1;KEY2=VALUE2...>] <STACK_NAME>
Copy to Clipboard Toggle word wrap
采用堆栈。

positional 参数

<STACK_NAME>
要采用的堆栈的名称。

可选参数

-e <FILE 或 URL>, --environment-file <FILE 或 URL>
环境的路径,可以多次指定。
-c <TIMEOUT>, --create-timeout <TIMEOUT>
堆栈创建超时(以分钟为单位)。DEPRECATED 使用 --timeout 替代。
-t <TIMEOUT>, --timeout <TIMEOUT>
堆栈创建超时(以分钟为单位)。
-a <FILE 或 URL>, --adopt-file <FILE 或 URL>
采用堆栈数据文件的路径。
-r, --enable-rollback
在 create/update 失败时启用回滚。
-p <KEY1=VALUE1;KEY2=VALUE2...>, --parameters <KEY1=VALUE1;KEY2=VALUE2..>
用于创建堆栈的参数值。这可以多次指定,或使用以分号分开的参数一次指定。

12.35. heat stack-cancel-update

usage: heat stack-cancel-update <NAME or ID>
Copy to Clipboard Toggle word wrap
取消当前运行堆栈的更新。

positional 参数

<NAME 或 ID>
要取消更新的堆栈的名称或 ID。

12.36. heat stack-create

usage: heat stack-create [-f <FILE>] [-e <FILE or URL>] [--pre-create <RESOURCE>] [-u <URL>] [-o <URL>] [-c <TIMEOUT>] [-t <TIMEOUT>] [-r] [-P <KEY1=VALUE1;KEY2=VALUE2...>] [-Pf <KEY=FILE>] [--poll [SECONDS]] [--tags <TAG1,TAG2>] <STACK_NAME>
Copy to Clipboard Toggle word wrap
创建堆栈。

positional 参数

<STACK_NAME>
要创建的堆栈的名称。

可选参数

-f <FILE>, --template-file <FILE>
模板的路径。
-e <FILE 或 URL>, --environment-file <FILE 或 URL>
环境的路径,可以多次指定。
--pre-create <RESOURCE>
将预先创建 hook 设置为的资源的名称。可以使用斜杠作为分隔符来设置嵌套堆栈中的资源: nested_stack/another/my_resource。您可以使用通配符来匹配多个堆栈或资源: nested_stack/an* configured_resource。这可以多次指定
-u <URL>, --template-url <URL>
模板的 URL。
-o <URL>, --template-object <URL>
检索模板对象的 URL (如从 swift)。
-c <TIMEOUT>, --create-timeout <TIMEOUT>
堆栈创建超时(以分钟为单位)。DEPRECATED 使用 --timeout 替代。
-t <TIMEOUT>, --timeout <TIMEOUT>
堆栈创建超时(以分钟为单位)。
-r, --enable-rollback
在 create/update 失败时启用回滚。
-p <KEY1=VALUE1;KEY2=VALUE2...>, --parameters <KEY1=VALUE1;KEY2=VALUE2..>
用于创建堆栈的参数值。这可以多次指定,或使用以分号分开的参数一次指定。
-PF <KEY=FILE>, --parameter-file <KEY=FILE>
用于创建堆栈的 文件中的参数值。这可以多次指定。参数值将是文件的内容
--poll [SECONDS]
轮询和报告事件,直到堆栈完成。可选的轮询间隔(以秒为单位)作为参数提供,默认 5。
--tags <TAG1,TAG2>
与堆栈关联的标签列表。

12.37. heat stack-delete

usage: heat stack-delete <NAME or ID> [<NAME or ID> ...]
Copy to Clipboard Toggle word wrap
删除堆栈。

positional 参数

<NAME 或 ID>
要删除的堆栈名称或 ID。

12.38. heat stack-list

usage: heat stack-list [-s] [-n] [-a] [-f <KEY1=VALUE1;KEY2=VALUE2...>] [-t <TAG1,TAG2...>] [--tags-any <TAG1,TAG2...>] [--not-tags <TAG1,TAG2...>] [--not-tags-any <TAG1,TAG2...>] [-l <LIMIT>] [-m <ID>] [-k <KEY1,KEY2...>] [-d [asc|desc]] [-g] [-o]
Copy to Clipboard Toggle word wrap
列出用户的堆栈。

可选参数

-s, --show-deleted
在堆栈列表中包括软删除堆栈。
-n,--show-nested
在堆栈列表中包括嵌套堆栈。
-a, --show-hidden
在堆栈列表中包括隐藏的堆栈。
-f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2..>
过滤要应用到返回的堆栈的参数。这可以多次指定,或使用以分号分开的参数一次指定。
-t <TAG1,TAG2..>, --tags <TAG1,TAG2..>
显示包含这些标签的堆栈,使用布尔值 AND 表达式组合多个标签
--tags- any <TAG1,TAG2..>
显示包含这些标签的堆栈,使用布尔值 OR 表达式组合多个标签
--not-tags <TAG1,TAG2...>
显示堆栈不包含这些标签,使用布尔值 AND 表达式组合多个标签
--not-tags-any <TAG1,TAG2...>
显示堆栈不包含这些标签,使用布尔值 OR 表达式组合多个标签
-L <LIMIT>, --limit <LIMIT>
限制返回的堆栈数量。
-m <ID>, --marker <ID>
仅返回给定堆栈 ID 后显示的堆栈。
-k <KEY1,KEY2..>, --sort-keys <KEY1,KEY2..>
用于排序返回的堆栈的键列表。这可以多次指定,或使用以分号分开的键一次指定。有效排序键包括 "stack_name", "stack_status", "creation_time" 和 "updated_time"。
-d [asc|desc], --sort-dir [asc|desc]
为排序键排序方向(asc"或"desc")。
-g, --global-tenant
显示来自所有租户的堆栈。仅针对与 heat 的 policy.json 中策略匹配的用户执行操作。
-o, --show-owner
显示堆栈所有者信息。使用 --global-tenant 时会自动启用。

12.39. heat stack-preview

usage: heat stack-preview [-f <FILE>] [-e <FILE or URL>] [-u <URL>] [-o <URL>] [-t <TIMEOUT>] [-r] [-P <KEY1=VALUE1;KEY2=VALUE2...>] [-Pf <KEY=FILE>] [--tags <TAG1,TAG2>] <STACK_NAME>
Copy to Clipboard Toggle word wrap
堆栈预览。

positional 参数

<STACK_NAME>
要预览的堆栈的名称。

可选参数

-f <FILE>, --template-file <FILE>
模板的路径。
-e <FILE 或 URL>, --environment-file <FILE 或 URL>
环境的路径,可以多次指定。
-u <URL>, --template-url <URL>
模板的 URL。
-o <URL>, --template-object <URL>
检索模板对象的 URL (如从 swift)
-t <TIMEOUT>, --timeout <TIMEOUT>
堆栈创建超时(以分钟为单位)。这只在预览过程中使用。
-r, --enable-rollback
失败时启用回滚。这个选项在preview 期间不使用,且仅适用于带有 stack- create 的 symmetry。
-p <KEY1=VALUE1;KEY2=VALUE2...>, --parameters <KEY1=VALUE1;KEY2=VALUE2..>
用于预览堆栈的参数值。这可以多次指定,或使用以分号分开的参数一次指定。
-PF <KEY=FILE>, --parameter-file <KEY=FILE>
用于创建堆栈的 文件中的参数值。这可以多次指定。参数值将是文件的内容
--tags <TAG1,TAG2>
与堆栈关联的标签列表。

12.40. heat stack-restore

usage: heat stack-restore <NAME or ID> <SNAPSHOT>
Copy to Clipboard Toggle word wrap
恢复堆栈的快照。

positional 参数

<NAME 或 ID>
包含快照的堆栈的名称或 ID。
<SNAPSHOT>
要恢复的快照 ID。

12.41. heat stack-show

usage: heat stack-show <NAME or ID>
Copy to Clipboard Toggle word wrap
描述堆栈。

positional 参数

<NAME 或 ID>
要描述的堆栈的名称或 ID。

12.42. heat stack-snapshot

usage: heat stack-snapshot [-n <NAME>] <NAME or ID>
Copy to Clipboard Toggle word wrap
生成堆栈的快照。

positional 参数

<NAME 或 ID>
要快照的堆栈名称或 ID。

可选参数

-n <NAME>, --name <NAME>
如果指定,则提供给快照的名称。

12.43. heat stack-update

usage: heat stack-update [-f <FILE>] [-e <FILE or URL>] [--pre-update <RESOURCE>] [-u <URL>] [-o <URL>] [-t <TIMEOUT>] [-r] [--rollback <VALUE>] [-y] [-P <KEY1=VALUE1;KEY2=VALUE2...>] [-Pf <KEY=FILE>] [-x] [-c <PARAMETER>] [--tags <TAG1,TAG2>] <NAME or ID>
Copy to Clipboard Toggle word wrap
更新堆栈。

positional 参数

<NAME 或 ID>
要更新的堆栈的名称或 ID。

可选参数

-f <FILE>, --template-file <FILE>
模板的路径。
-e <FILE 或 URL>, --environment-file <FILE 或 URL>
环境的路径,可以多次指定。
--pre-update <RESOURCE>
将 pre-update hook 设置为的资源名称。可以使用斜杠作为分隔符来设置嵌套堆栈中的资源: nested_stack/another/my_resource。您可以使用通配符来匹配多个堆栈或资源: nested_stack/an* configured_resource。这可以多次指定
-u <URL>, --template-url <URL>
模板的 URL。
-o <URL>, --template-object <URL>
检索模板对象的 URL (如从 swift)。
-t <TIMEOUT>, --timeout <TIMEOUT>
堆栈更新超时(以分钟为单位)。
-r, --enable-rollback
弃用!改为使用 --rollback 参数。在堆栈更新失败时启用回滚。注意:默认行为是使用现有堆栈的回滚值。
--rollback <VALUE>
在更新失败时设置回滚。值('1', 't', 'true', 'on', 'y', 'yes')将回滚设置为 enabled。值('0', 'f', 'false', 'off', 'n', 'no')将回滚设置为 disabled。默认为使用要更新的现有堆栈的值。
-y, --dry-run
不要实际执行堆栈更新,但显示要更改的内容
-p <KEY1=VALUE1;KEY2=VALUE2...>, --parameters <KEY1=VALUE1;KEY2=VALUE2..>
用于创建堆栈的参数值。这可以多次指定,或使用以分号分开的参数一次指定。
-PF <KEY=FILE>, --parameter-file <KEY=FILE>
用于创建堆栈的 文件中的参数值。这可以多次指定。参数值将是文件的内容
-x,--existing
重新使用当前堆栈的模板、参数和环境。如果省略 template 参数,则使用现有的模板。如果没有指定 --environment-file,则使用现有的环境。在 --parameters 中指定的参数将修补当前堆栈中的现有值。省略的参数将保留现有的值。
-c <PARAMETER>, --clear-parameter <PARAMETER>
从 stack-update 的当前堆栈的参数集合中移除参数。将使用模板中的默认值。这可以多次指定。
--tags <TAG1,TAG2>
与堆栈关联的更新的标签列表。

12.44. heat template-function-list

usage: heat template-function-list <TEMPLATE_VERSION>
Copy to Clipboard Toggle word wrap
列出可用的功能。

positional 参数

<TEMPLATE_VERSION>
获取以下功能的模板版本。

12.45. heat template-show

usage: heat template-show <NAME or ID>
Copy to Clipboard Toggle word wrap
获取指定堆栈的模板。

positional 参数

<NAME 或 ID>
用于获取模板的堆栈名称或 ID。

12.46. heat template-validate

usage: heat template-validate [-u <URL>] [-f <FILE>] [-e <FILE or URL>] [-o <URL>] [-n]
Copy to Clipboard Toggle word wrap
使用参数验证模板。

可选参数

-u <URL>, --template-url <URL>
模板的 URL。
-f <FILE>, --template-file <FILE>
模板的路径。
-e <FILE 或 URL>, --environment-file <FILE 或 URL>
环境的路径,可以多次指定。
-o <URL>, --template-object <URL>
检索模板对象的 URL (如从 swift)。
-n,--show-nested
也从嵌套模板解析参数。

12.47. heat template-version-list

usage: heat template-version-list
Copy to Clipboard Toggle word wrap
列出可用的模板版本。

第 13 章 Telemetry 服务命令行客户端

ceilometer 客户端是用于 Telemetry 服务 API 及其扩展的命令行界面(CLI)。本章记录了 ceilometer 版本 1.5.0
有关特定 ceilometer 命令的帮助信息,请输入:
$ ceilometer help COMMAND
Copy to Clipboard Toggle word wrap

13.1. Ceilometer 用法

usage: ceilometer [--version] [-d] [-v] [--timeout TIMEOUT] [--ceilometer-url <CEILOMETER_URL>] [--ceilometer-api-version CEILOMETER_API_VERSION] [--os-tenant-id <tenant-id>] [--os-region-name <region-name>] [--os-auth-token <auth-token>] [--os-service-type <service-type>] [--os-endpoint-type <endpoint-type>] [--os-cacert <cacert>] [--os-insecure <insecure>] [--os-cert-file <cert-file>] [--os-key-file <key-file>] [--os-cert <cert>] [--os-key <key>] [--os-project-name <project-name>] [--os-project-id <project-id>] [--os-project-domain-id <project-domain-id>] [--os-project-domain-name <project-domain-name>] [--os-user-id <user-id>] [--os-user-domain-id <user-domain-id>] [--os-user-domain-name <user-domain-name>] [--os-endpoint <endpoint>] [--os-auth-system <auth-system>] [--os-username <username>] [--os-password <password>] [--os-tenant-name <tenant-name>] [--os-token <token>] [--os-auth-url <auth-url>] <subcommand> ...
Copy to Clipboard Toggle word wrap

子命令

alarm-combination-create
根据其他警报的状态创建新警报。
alarm-combination-update
根据其他警报的状态更新现有警报。
alarm-create
创建新警报(已弃用)。改为使用 alarm- threshold-create。
alarm-delete
删除警报。
alarm-event-create
根据事件创建新警报。
alarm-event-update
根据事件更新现有警报。
alarm-gnocchi-aggregation-by-metrics-threshold-create
根据计算的统计数据,创建一个新警报。
alarm-gnocchi-aggregation-by-metrics-threshold-update
根据计算的统计信息更新现有警报。
alarm-gnocchi-aggregation-by-resources-threshold-create
根据计算的统计数据,创建一个新警报。
alarm-gnocchi-aggregation-by-resources-threshold-update
根据计算的统计信息更新现有警报。
alarm-gnocchi-resources-threshold-create
根据计算的统计数据,创建一个新警报。
alarm-gnocchi-resources-threshold-update
根据计算的统计信息更新现有警报。
alarm-history
显示警报的更改历史记录。
alarm-list
列出用户的警报。
alarm-show
显示警报。
alarm-state-get
获取警报的状态。
alarm-state-set
设置警报的状态。
alarm-threshold-create
根据计算的统计数据,创建一个新警报。
alarm-threshold-update
根据计算的统计信息更新现有警报。
alarm-update
更新现有警报(已弃用)。
功能
打印 Ceilometer 功能.
event-list
列出事件。
event-show
显示特定事件。
event-type-list
列出事件类型。
meter-list
列出用户的量表。
query-alarm-history
查询警报历史.
query-alarms
查询警报.
query-samples
查询示例。
resource-list
列出资源。
resource-show
显示资源。
sample-create
创建示例。
sample-create-list
创建一个示例列表。
sample-list
列出示例(如果设置了 -m/-meter),则返回 OldSample 对象。
sample-show
显示示例。
statistics
列出量表的统计信息。
trait-description-list
列出事件类型的特征信息。
trait-list
列出名为 <trait_name> 用于 Event Type <event_type> 的所有特征。
bash-completion
将所有命令和选项输出到 stdout。
帮助
显示有关该程序或其其中一个子命令的帮助。

13.2. Ceilometer 可选参数

--version
显示程序的版本号并退出
-d, --debug
默认为 env[CEILOMETERCLIENT_DEBUG]
-v, --verbose
打印更详细的输出。
--timeout TIMEOUT
等待响应的秒数。
--Ceilometer-url <CEILOMETER_URL>
DEPRECATED,改为使用 --os-endpoint。默认为 env[CEILOMETER_URL]
--Ceilometer-api-version CEILOMETER_API_VERSION
默认为 env[CEILOMETER_API_VERSION] 或 2。
--os-tenant-id <tenant-id>
默认为 env[OS_TENANT_ID]
--os-region-name <region-name>
默认为 env[OS_REGION_NAME]
--os-auth-token <auth-token>
默认为 env[OS_AUTH_TOKEN]
--os-service-type <service-type>
默认为 env[OS_SERVICE_TYPE]
--os-endpoint-type <endpoint-type>
默认为 env[OS_ENDPOINT_TYPE]
--os-cacert <cacert>
默认为 env[OS_CACERT]
--os-insecure <insecure>
默认为 env[OS_INSECURE]
--os-cert-file <cert-file>
默认为 env[OS_CERT_FILE]
--os-key-file <key-file>
默认为 env[OS_KEY_FILE]
--os-cert <cert>
默认为 env[OS_CERT]
--os-key <key>
默认为 env[OS_KEY]
--os-project-name <project-name>
默认为 env[OS_PROJECT_NAME]
--os-project-id <project-id>
默认为 env[OS_PROJECT_ID]
--os-project-domain-id <project-domain-id>
默认为 env[OS_PROJECT_DOMAIN_ID]
--os-project-domain-name <project-domain-name>
默认为 env[OS_PROJECT_DOMAIN_NAME]
--os-user-id <user-id>
默认为 env[OS_USER_ID]
--os-user-domain-id <user-domain-id>
默认为 env[OS_USER_DOMAIN_ID]
--os-user-domain-name <user-domain-name>
默认为 env[OS_USER_DOMAIN_NAME]
--os-endpoint <endpoint>
默认为 env[OS_ENDPOINT]
--os-auth-system <auth-system>
默认为 env[OS_AUTH_SYSTEM]
--os-username <username>
默认为 env[OS_USERNAME]
--os-password <password>
默认为 env[OS_PASSWORD]
--os-tenant-name <tenant-name>
默认为 env[OS_TENANT_NAME]
--os-token <token>
默认为 env[OS_TOKEN]
--os-auth-url <auth-url>
默认为 env[OS_AUTH_URL]

13.3. ceilometer alarm-combination-create

usage: ceilometer alarm-combination-create --name <NAME> [--project-id <ALARM_PROJECT_ID>] [--user-id <ALARM_USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] [--insufficient-data-action <Webhook URL>] [--time-constraint <Time Constraint>] [--repeat-actions {True|False}] --alarm_ids <ALARM IDS> [--operator <OPERATOR>]
Copy to Clipboard Toggle word wrap
根据其他警报的状态创建新警报。

可选参数

--name <NAME>
警报的名称(每个租户必须是唯一的)。必需。
--project-id <ALARM_PROJECT_ID>
与警报关联的租户(仅由 admin 用户设置)。
--user-id <ALARM_USER_ID>
与警报关联的用户(仅由 admin 用户设置)。
--description <DESCRIPTION>
警报的空闲文本描述。
--state <STATE>
警报的状态,其中之一: ['ok', 'alarm', 'insufficient data']
--severity <SEVERITY>
警报的严重性,其中之一: ['low', 'moderate', 'critical']
--enabled {True|False}
如果启用了警报评估/操作,则为 true。
--alarm-action <Webhook URL>
在状态过渡到 alarm 时调用的 URL。可以多次使用。默认值为 None。
--OK-action <Webhook URL>
当状态转换为 OK 时调用的 URL。可以多次使用。默认值为 None。
--insufficient-data-action <Webhook URL>
当状态过渡到 insufficient data 时要调用的 URL。可以多次使用。默认值为 None。
--time-constraint <Time Constraint>
仅在评估时间在此时间约束内评估警报。约束的起点使用 cron 表达式指定,而其持续时间以秒为单位。可以多次指定多个时间限制,格式为: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.
--repeat-actions {True|False}
如果为在警报保持目标状态时重复通知,则为 true。默认值为 False。
--alarm_ids <ALARM IDS>
警报 ID 列表。必需。
--Operator <OPERATOR>
要比较的运算符,其中之一: ['and', 'or']。

13.4. Ceilometer alarm-combination-update

usage: ceilometer alarm-combination-update [--name <NAME>] [--project-id <ALARM_PROJECT_ID>] [--user-id <ALARM_USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] [--insufficient-data-action <Webhook URL>] [--time-constraint <Time Constraint>] [--repeat-actions {True|False}] [--remove-time-constraint <Constraint names>] [--alarm_ids <ALARM IDS>] [--operator <OPERATOR>] [<ALARM_ID>]
Copy to Clipboard Toggle word wrap
根据其他警报的状态更新现有警报。

positional 参数

<ALARM_ID>
要更新的警报 ID。

可选参数

--name <NAME>
警报的名称(每个租户必须是唯一的)。
--project-id <ALARM_PROJECT_ID>
与警报关联的租户(仅由 admin 用户设置)。
--user-id <ALARM_USER_ID>
与警报关联的用户(仅由 admin 用户设置)。
--description <DESCRIPTION>
警报的空闲文本描述。
--state <STATE>
警报的状态,其中之一: ['ok', 'alarm', 'insufficient data']
--severity <SEVERITY>
警报的严重性,其中之一: ['low', 'moderate', 'critical']
--enabled {True|False}
如果启用了警报评估/操作,则为 true。
--alarm-action <Webhook URL>
在状态过渡到 alarm 时调用的 URL。可以多次使用。默认值为 None。
--OK-action <Webhook URL>
当状态转换为 OK 时调用的 URL。可以多次使用。默认值为 None。
--insufficient-data-action <Webhook URL>
当状态过渡到 insufficient data 时要调用的 URL。可以多次使用。默认值为 None。
--time-constraint <Time Constraint>
仅在评估时间在此时间约束内评估警报。约束的起点使用 cron 表达式指定,而其持续时间以秒为单位。可以多次指定多个时间限制,格式为: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.
--repeat-actions {True|False}
如果为在警报保持目标状态时重复通知,则为 true。默认值为 False。
--remove-time-constraint <Constraint name>
要删除的时间限制的名称或列表。
--alarm_ids <ALARM IDS>
警报 ID 列表。
--Operator <OPERATOR>
要比较的运算符,其中之一: ['and', 'or']。

13.5. Ceilometer alarm-delete

usage: ceilometer alarm-delete [<ALARM_ID>]
Copy to Clipboard Toggle word wrap
删除警报。

positional 参数

<ALARM_ID>
要删除的警报的 ID。

13.6. ceilometer alarm-event-create

usage: ceilometer alarm-event-create --name <NAME> [--project-id <ALARM_PROJECT_ID>] [--user-id <ALARM_USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] [--insufficient-data-action <Webhook URL>] [--time-constraint <Time Constraint>] [--repeat-actions {True|False}] [--event-type <EVENT_TYPE>] [-q <QUERY>]
Copy to Clipboard Toggle word wrap
根据事件创建新警报。

可选参数

--name <NAME>
警报的名称(每个租户必须是唯一的)。必需。
--project-id <ALARM_PROJECT_ID>
与警报关联的租户(仅由 admin 用户设置)。
--user-id <ALARM_USER_ID>
与警报关联的用户(仅由 admin 用户设置)。
--description <DESCRIPTION>
警报的空闲文本描述。
--state <STATE>
警报的状态,其中之一: ['ok', 'alarm', 'insufficient data']
--severity <SEVERITY>
警报的严重性,其中之一: ['low', 'moderate', 'critical']
--enabled {True|False}
如果启用了警报评估/操作,则为 true。
--alarm-action <Webhook URL>
在状态过渡到 alarm 时调用的 URL。可以多次使用。默认值为 None。
--OK-action <Webhook URL>
当状态转换为 OK 时调用的 URL。可以多次使用。默认值为 None。
--insufficient-data-action <Webhook URL>
当状态过渡到 insufficient data 时要调用的 URL。可以多次使用。默认值为 None。
--time-constraint <Time Constraint>
仅在评估时间在此时间约束内评估警报。约束的起点使用 cron 表达式指定,而其持续时间以秒为单位。可以多次指定多个时间限制,格式为: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.
--repeat-actions {True|False}
如果为在警报保持目标状态时重复通知,则为 true。默认值为 False。
--event-type <EVENT_TYPE>
事件警报的事件类型。
-Q <QUERY>, --query <QUERY>
key[op]data_type::value; 列表用于过滤 events。data_type 是可选的,但如果提供的字符串、整数、float 或 datetime。

13.7. Ceilometer alarm-event-update

usage: ceilometer alarm-event-update [--name <NAME>] [--project-id <ALARM_PROJECT_ID>] [--user-id <ALARM_USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] [--insufficient-data-action <Webhook URL>] [--time-constraint <Time Constraint>] [--repeat-actions {True|False}] [--event-type <EVENT_TYPE>] [-q <QUERY>] [<ALARM_ID>]
Copy to Clipboard Toggle word wrap
根据事件更新现有警报。

positional 参数

<ALARM_ID>
要更新的警报 ID。

可选参数

--name <NAME>
警报的名称(每个租户必须是唯一的)。
--project-id <ALARM_PROJECT_ID>
与警报关联的租户(仅由 admin 用户设置)。
--user-id <ALARM_USER_ID>
与警报关联的用户(仅由 admin 用户设置)。
--description <DESCRIPTION>
警报的空闲文本描述。
--state <STATE>
警报的状态,其中之一: ['ok', 'alarm', 'insufficient data']
--severity <SEVERITY>
警报的严重性,其中之一: ['low', 'moderate', 'critical']
--enabled {True|False}
如果启用了警报评估/操作,则为 true。
--alarm-action <Webhook URL>
在状态过渡到 alarm 时调用的 URL。可以多次使用。默认值为 None。
--OK-action <Webhook URL>
当状态转换为 OK 时调用的 URL。可以多次使用。默认值为 None。
--insufficient-data-action <Webhook URL>
当状态过渡到 insufficient data 时要调用的 URL。可以多次使用。默认值为 None。
--time-constraint <Time Constraint>
仅在评估时间在此时间约束内评估警报。约束的起点使用 cron 表达式指定,而其持续时间以秒为单位。可以多次指定多个时间限制,格式为: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.
--repeat-actions {True|False}
如果为在警报保持目标状态时重复通知,则为 true。默认值为 False。
--event-type <EVENT_TYPE>
事件警报的事件类型。
-Q <QUERY>, --query <QUERY>
key[op]data_type::value; 列表用于过滤 events。data_type 是可选的,但如果提供的字符串、整数、float 或 datetime。
usage: ceilometer alarm-gnocchi-aggregation-by-metrics-threshold-create --name <NAME> [--project-id <ALARM_PROJECT_ID>] [--user-id <ALARM_USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] [--insufficient-data-action <Webhook URL>] [--time-constraint <Time Constraint>] [--repeat-actions {True|False}] [--granularity <GRANULARITY>] [--evaluation-periods <COUNT>] [--aggregation-method <AGGREATION>] [--comparison-operator <OPERATOR>] --threshold <THRESHOLD> -m <METRICS>
Copy to Clipboard Toggle word wrap
根据计算的统计数据,创建一个新警报。

可选参数

--name <NAME>
警报的名称(每个租户必须是唯一的)。必需。
--project-id <ALARM_PROJECT_ID>
与警报关联的租户(仅由 admin 用户设置)。
--user-id <ALARM_USER_ID>
与警报关联的用户(仅由 admin 用户设置)。
--description <DESCRIPTION>
警报的空闲文本描述。
--state <STATE>
警报的状态,其中之一: ['ok', 'alarm', 'insufficient data']
--severity <SEVERITY>
警报的严重性,其中之一: ['low', 'moderate', 'critical']
--enabled {True|False}
如果启用了警报评估/操作,则为 true。
--alarm-action <Webhook URL>
在状态过渡到 alarm 时调用的 URL。可以多次使用。默认值为 None。
--OK-action <Webhook URL>
当状态转换为 OK 时调用的 URL。可以多次使用。默认值为 None。
--insufficient-data-action <Webhook URL>
当状态过渡到 insufficient data 时要调用的 URL。可以多次使用。默认值为 None。
--time-constraint <Time Constraint>
仅在评估时间在此时间约束内评估警报。约束的起点使用 cron 表达式指定,而其持续时间以秒为单位。可以多次指定多个时间限制,格式为: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.
--repeat-actions {True|False}
如果为在警报保持目标状态时重复通知,则为 true。默认值为 False。
--granularity <GRANULARITY>
要评估的每个时间段(秒)的长度。
--evaluation-periods <COUNT>
评估的期间数。
--aggregation-method <AGGREATION>
要使用的聚合方法之一: ['max', 'min', 'avg', 'sum', 'count']。
--comparison-operator <OPERATOR>
要比较的 operator,其中之一: ['lt', 'le', 'eq', 'ne', 'ge', 'gt']。
--threshold <THRESHOLD>
评估的阈值。必需。
-m <METRICS>, --metrics <METRICS>
要评估的指标。必需。
usage: ceilometer alarm-gnocchi-aggregation-by-metrics-threshold-update [--name <NAME>] [--project-id <ALARM_PROJECT_ID>] [--user-id <ALARM_USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] [--insufficient-data-action <Webhook URL>] [--time-constraint <Time Constraint>] [--repeat-actions {True|False}] [--granularity <GRANULARITY>] [--evaluation-periods <COUNT>] [--aggregation-method <AGGREATION>] [--comparison-operator <OPERATOR>] [--threshold <THRESHOLD>] [-m <METRICS>] [--remove-time-constraint <Constraint names>] [<ALARM_ID>]
Copy to Clipboard Toggle word wrap
根据计算的统计信息更新现有警报。

positional 参数

<ALARM_ID>
要更新的警报 ID。

可选参数

--name <NAME>
警报的名称(每个租户必须是唯一的)。
--project-id <ALARM_PROJECT_ID>
与警报关联的租户(仅由 admin 用户设置)。
--user-id <ALARM_USER_ID>
与警报关联的用户(仅由 admin 用户设置)。
--description <DESCRIPTION>
警报的空闲文本描述。
--state <STATE>
警报的状态,其中之一: ['ok', 'alarm', 'insufficient data']
--severity <SEVERITY>
警报的严重性,其中之一: ['low', 'moderate', 'critical']
--enabled {True|False}
如果启用了警报评估/操作,则为 true。
--alarm-action <Webhook URL>
在状态过渡到 alarm 时调用的 URL。可以多次使用。默认值为 None。
--OK-action <Webhook URL>
当状态转换为 OK 时调用的 URL。可以多次使用。默认值为 None。
--insufficient-data-action <Webhook URL>
当状态过渡到 insufficient data 时要调用的 URL。可以多次使用。默认值为 None。
--time-constraint <Time Constraint>
仅在评估时间在此时间约束内评估警报。约束的起点使用 cron 表达式指定,而其持续时间以秒为单位。可以多次指定多个时间限制,格式为: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.
--repeat-actions {True|False}
如果为在警报保持目标状态时重复通知,则为 true。默认值为 False。
--granularity <GRANULARITY>
要评估的每个时间段(秒)的长度。
--evaluation-periods <COUNT>
评估的期间数。
--aggregation-method <AGGREATION>
要使用的聚合方法之一: ['max', 'min', 'avg', 'sum', 'count']。
--comparison-operator <OPERATOR>
要比较的 operator,其中之一: ['lt', 'le', 'eq', 'ne', 'ge', 'gt']。
--threshold <THRESHOLD>
评估的阈值。
-m <METRICS>, --metrics <METRICS>
要评估的指标。
--remove-time-constraint <Constraint name>
要删除的时间限制的名称或列表。
usage: ceilometer alarm-gnocchi-aggregation-by-resources-threshold-create --name <NAME> [--project-id <ALARM_PROJECT_ID>] [--user-id <ALARM_USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] [--insufficient-data-action <Webhook URL>] [--time-constraint <Time Constraint>] [--repeat-actions {True|False}] [--granularity <GRANULARITY>] [--evaluation-periods <COUNT>] [--aggregation-method <AGGREATION>] [--comparison-operator <OPERATOR>] --threshold <THRESHOLD> -m <METRIC> --resource-type <RESOURCE_TYPE> --query <QUERY>
Copy to Clipboard Toggle word wrap
根据计算的统计数据,创建一个新警报。

可选参数

--name <NAME>
警报的名称(每个租户必须是唯一的)。必需。
--project-id <ALARM_PROJECT_ID>
与警报关联的租户(仅由 admin 用户设置)。
--user-id <ALARM_USER_ID>
与警报关联的用户(仅由 admin 用户设置)。
--description <DESCRIPTION>
警报的空闲文本描述。
--state <STATE>
警报的状态,其中之一: ['ok', 'alarm', 'insufficient data']
--severity <SEVERITY>
警报的严重性,其中之一: ['low', 'moderate', 'critical']
--enabled {True|False}
如果启用了警报评估/操作,则为 true。
--alarm-action <Webhook URL>
在状态过渡到 alarm 时调用的 URL。可以多次使用。默认值为 None。
--OK-action <Webhook URL>
当状态转换为 OK 时调用的 URL。可以多次使用。默认值为 None。
--insufficient-data-action <Webhook URL>
当状态过渡到 insufficient data 时要调用的 URL。可以多次使用。默认值为 None。
--time-constraint <Time Constraint>
仅在评估时间在此时间约束内评估警报。约束的起点使用 cron 表达式指定,而其持续时间以秒为单位。可以多次指定多个时间限制,格式为: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.
--repeat-actions {True|False}
如果为在警报保持目标状态时重复通知,则为 true。默认值为 False。
--granularity <GRANULARITY>
要评估的每个时间段(秒)的长度。
--evaluation-periods <COUNT>
评估的期间数。
--aggregation-method <AGGREATION>
要使用的聚合方法之一: ['max', 'min', 'avg', 'sum', 'count']。
--comparison-operator <OPERATOR>
要比较的 operator,其中之一: ['lt', 'le', 'eq', 'ne', 'ge', 'gt']。
--threshold <THRESHOLD>
评估的阈值。必需。
-m <METRIC>, --metric <METRIC>
要评估的指标。必需。
--resource-type <RESOURCE_TYPE>
要评估的 resource_type。必需。
--query <QUERY>
Gnocchi 资源搜索查询过滤器必填。
usage: ceilometer alarm-gnocchi-aggregation-by-resources-threshold-update [--name <NAME>] [--project-id <ALARM_PROJECT_ID>] [--user-id <ALARM_USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] [--insufficient-data-action <Webhook URL>] [--time-constraint <Time Constraint>] [--repeat-actions {True|False}] [--granularity <GRANULARITY>] [--evaluation-periods <COUNT>] [--aggregation-method <AGGREATION>] [--comparison-operator <OPERATOR>] [--threshold <THRESHOLD>] [-m <METRIC>] [--resource-type <RESOURCE_TYPE>] [--query <QUERY>] [--remove-time-constraint <Constraint names>] [<ALARM_ID>]
Copy to Clipboard Toggle word wrap
根据计算的统计信息更新现有警报。

positional 参数

<ALARM_ID>
要更新的警报 ID。

可选参数

--name <NAME>
警报的名称(每个租户必须是唯一的)。
--project-id <ALARM_PROJECT_ID>
与警报关联的租户(仅由 admin 用户设置)。
--user-id <ALARM_USER_ID>
与警报关联的用户(仅由 admin 用户设置)。
--description <DESCRIPTION>
警报的空闲文本描述。
--state <STATE>
警报的状态,其中之一: ['ok', 'alarm', 'insufficient data']
--severity <SEVERITY>
警报的严重性,其中之一: ['low', 'moderate', 'critical']
--enabled {True|False}
如果启用了警报评估/操作,则为 true。
--alarm-action <Webhook URL>
在状态过渡到 alarm 时调用的 URL。可以多次使用。默认值为 None。
--OK-action <Webhook URL>
当状态转换为 OK 时调用的 URL。可以多次使用。默认值为 None。
--insufficient-data-action <Webhook URL>
当状态过渡到 insufficient data 时要调用的 URL。可以多次使用。默认值为 None。
--time-constraint <Time Constraint>
仅在评估时间在此时间约束内评估警报。约束的起点使用 cron 表达式指定,而其持续时间以秒为单位。可以多次指定多个时间限制,格式为: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.
--repeat-actions {True|False}
如果为在警报保持目标状态时重复通知,则为 true。默认值为 False。
--granularity <GRANULARITY>
要评估的每个时间段(秒)的长度。
--evaluation-periods <COUNT>
评估的期间数。
--aggregation-method <AGGREATION>
要使用的聚合方法之一: ['max', 'min', 'avg', 'sum', 'count']。
--comparison-operator <OPERATOR>
要比较的 operator,其中之一: ['lt', 'le', 'eq', 'ne', 'ge', 'gt']。
--threshold <THRESHOLD>
评估的阈值。
-m <METRIC>, --metric <METRIC>
要评估的指标。
--resource-type <RESOURCE_TYPE>
要评估的 resource_type。
--query <QUERY>
Gnocchi 资源搜索查询过滤器
--remove-time-constraint <Constraint name>
要删除的时间限制的名称或列表。

13.12. ceilometer alarm-gnocchi-resources-threshold-create

usage: ceilometer alarm-gnocchi-resources-threshold-create --name <NAME> [--project-id <ALARM_PROJECT_ID>] [--user-id <ALARM_USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] [--insufficient-data-action <Webhook URL>] [--time-constraint <Time Constraint>] [--repeat-actions {True|False}] [--granularity <GRANULARITY>] [--evaluation-periods <COUNT>] [--aggregation-method <AGGREATION>] [--comparison-operator <OPERATOR>] --threshold <THRESHOLD> -m <METRIC> --resource-type <RESOURCE_TYPE> --resource-id <RESOURCE_ID>
Copy to Clipboard Toggle word wrap
根据计算的统计数据,创建一个新警报。

可选参数

--name <NAME>
警报的名称(每个租户必须是唯一的)。必需。
--project-id <ALARM_PROJECT_ID>
与警报关联的租户(仅由 admin 用户设置)。
--user-id <ALARM_USER_ID>
与警报关联的用户(仅由 admin 用户设置)。
--description <DESCRIPTION>
警报的空闲文本描述。
--state <STATE>
警报的状态,其中之一: ['ok', 'alarm', 'insufficient data']
--severity <SEVERITY>
警报的严重性,其中之一: ['low', 'moderate', 'critical']
--enabled {True|False}
如果启用了警报评估/操作,则为 true。
--alarm-action <Webhook URL>
在状态过渡到 alarm 时调用的 URL。可以多次使用。默认值为 None。
--OK-action <Webhook URL>
当状态转换为 OK 时调用的 URL。可以多次使用。默认值为 None。
--insufficient-data-action <Webhook URL>
当状态过渡到 insufficient data 时要调用的 URL。可以多次使用。默认值为 None。
--time-constraint <Time Constraint>
仅在评估时间在此时间约束内评估警报。约束的起点使用 cron 表达式指定,而其持续时间以秒为单位。可以多次指定多个时间限制,格式为: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.
--repeat-actions {True|False}
如果为在警报保持目标状态时重复通知,则为 true。默认值为 False。
--granularity <GRANULARITY>
要评估的每个时间段(秒)的长度。
--evaluation-periods <COUNT>
评估的期间数。
--aggregation-method <AGGREATION>
要使用的聚合方法之一: ['max', 'min', 'avg', 'sum', 'count']。
--comparison-operator <OPERATOR>
要比较的 operator,其中之一: ['lt', 'le', 'eq', 'ne', 'ge', 'gt']。
--threshold <THRESHOLD>
评估的阈值。必需。
-m <METRIC>, --metric <METRIC>
要评估的指标。必需。
--resource-type <RESOURCE_TYPE>
要评估的 resource_type。必需。
--resource-id <RESOURCE_ID>
要针对需要评估的资源 ID。

13.13. ceilometer alarm-gnocchi-resources-threshold-update

usage: ceilometer alarm-gnocchi-resources-threshold-update [--name <NAME>] [--project-id <ALARM_PROJECT_ID>] [--user-id <ALARM_USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] [--insufficient-data-action <Webhook URL>] [--time-constraint <Time Constraint>] [--repeat-actions {True|False}] [--granularity <GRANULARITY>] [--evaluation-periods <COUNT>] [--aggregation-method <AGGREATION>] [--comparison-operator <OPERATOR>] [--threshold <THRESHOLD>] [-m <METRIC>] [--resource-type <RESOURCE_TYPE>] [--resource-id <RESOURCE_ID>] [--remove-time-constraint <Constraint names>] [<ALARM_ID>]
Copy to Clipboard Toggle word wrap
根据计算的统计信息更新现有警报。

positional 参数

<ALARM_ID>
要更新的警报 ID。

可选参数

--name <NAME>
警报的名称(每个租户必须是唯一的)。
--project-id <ALARM_PROJECT_ID>
与警报关联的租户(仅由 admin 用户设置)。
--user-id <ALARM_USER_ID>
与警报关联的用户(仅由 admin 用户设置)。
--description <DESCRIPTION>
警报的空闲文本描述。
--state <STATE>
警报的状态,其中之一: ['ok', 'alarm', 'insufficient data']
--severity <SEVERITY>
警报的严重性,其中之一: ['low', 'moderate', 'critical']
--enabled {True|False}
如果启用了警报评估/操作,则为 true。
--alarm-action <Webhook URL>
在状态过渡到 alarm 时调用的 URL。可以多次使用。默认值为 None。
--OK-action <Webhook URL>
当状态转换为 OK 时调用的 URL。可以多次使用。默认值为 None。
--insufficient-data-action <Webhook URL>
当状态过渡到 insufficient data 时要调用的 URL。可以多次使用。默认值为 None。
--time-constraint <Time Constraint>
仅在评估时间在此时间约束内评估警报。约束的起点使用 cron 表达式指定,而其持续时间以秒为单位。可以多次指定多个时间限制,格式为: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.
--repeat-actions {True|False}
如果为在警报保持目标状态时重复通知,则为 true。默认值为 False。
--granularity <GRANULARITY>
要评估的每个时间段(秒)的长度。
--evaluation-periods <COUNT>
评估的期间数。
--aggregation-method <AGGREATION>
要使用的聚合方法之一: ['max', 'min', 'avg', 'sum', 'count']。
--comparison-operator <OPERATOR>
要比较的 operator,其中之一: ['lt', 'le', 'eq', 'ne', 'ge', 'gt']。
--threshold <THRESHOLD>
评估的阈值。
-m <METRIC>, --metric <METRIC>
要评估的指标。
--resource-type <RESOURCE_TYPE>
要评估的 resource_type。
--resource-id <RESOURCE_ID>
要评估的资源 ID
--remove-time-constraint <Constraint name>
要删除的时间限制的名称或列表。

13.14. Ceilometer alarm-history

usage: ceilometer alarm-history [-q <QUERY>] [<ALARM_ID>]
Copy to Clipboard Toggle word wrap
显示警报的更改历史记录。

positional 参数

<ALARM_ID>
显示历史记录的警报 ID。

可选参数

-Q <QUERY>, --query <QUERY>
key[op]data_type::value; list. data_type 是可选的,但如果提供,则必须为字符串、整数、浮点或布尔值。

13.15. ceilometer alarm-list

usage: ceilometer alarm-list [-q <QUERY>]
Copy to Clipboard Toggle word wrap
列出用户的警报。

可选参数

-Q <QUERY>, --query <QUERY>
key[op]data_type::value; list. data_type 是可选的,但如果提供,则必须为字符串、整数、浮点或布尔值。

13.16. ceilometer alarm-show

usage: ceilometer alarm-show [<ALARM_ID>]
Copy to Clipboard Toggle word wrap
显示警报。

positional 参数

<ALARM_ID>
要显示的警报 ID。

13.17. ceilometer alarm-state-get

usage: ceilometer alarm-state-get [<ALARM_ID>]
Copy to Clipboard Toggle word wrap
获取警报的状态。

positional 参数

<ALARM_ID>
要显示的警报状态的 ID。

13.18. ceilometer alarm-state-set

usage: ceilometer alarm-state-set --state <STATE> [<ALARM_ID>]
Copy to Clipboard Toggle word wrap
设置警报的状态。

positional 参数

<ALARM_ID>
要设置的警报状态的 ID。

可选参数

--state <STATE>
警报的状态,其中之一: ['ok', 'alarm', 'insufficient data']。必需。

13.19. ceilometer alarm-threshold-create

usage: ceilometer alarm-threshold-create --name <NAME> [--project-id <ALARM_PROJECT_ID>] [--user-id <ALARM_USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] [--insufficient-data-action <Webhook URL>] [--time-constraint <Time Constraint>] [--repeat-actions {True|False}] -m <METRIC> [--period <PERIOD>] [--evaluation-periods <COUNT>] [--statistic <STATISTIC>] [--comparison-operator <OPERATOR>] --threshold <THRESHOLD> [-q <QUERY>]
Copy to Clipboard Toggle word wrap
根据计算的统计数据,创建一个新警报。

可选参数

--name <NAME>
警报的名称(每个租户必须是唯一的)。必需。
--project-id <ALARM_PROJECT_ID>
与警报关联的租户(仅由 admin 用户设置)。
--user-id <ALARM_USER_ID>
与警报关联的用户(仅由 admin 用户设置)。
--description <DESCRIPTION>
警报的空闲文本描述。
--state <STATE>
警报的状态,其中之一: ['ok', 'alarm', 'insufficient data']
--severity <SEVERITY>
警报的严重性,其中之一: ['low', 'moderate', 'critical']
--enabled {True|False}
如果启用了警报评估/操作,则为 true。
--alarm-action <Webhook URL>
在状态过渡到 alarm 时调用的 URL。可以多次使用。默认值为 None。
--OK-action <Webhook URL>
当状态转换为 OK 时调用的 URL。可以多次使用。默认值为 None。
--insufficient-data-action <Webhook URL>
当状态过渡到 insufficient data 时要调用的 URL。可以多次使用。默认值为 None。
--time-constraint <Time Constraint>
仅在评估时间在此时间约束内评估警报。约束的起点使用 cron 表达式指定,而其持续时间以秒为单位。可以多次指定多个时间限制,格式为: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.
--repeat-actions {True|False}
如果为在警报保持目标状态时重复通知,则为 true。默认值为 False。
-m <METRIC>, --meter-name <METRIC>
要评估的指标。必需。
--period <PERIOD>
要评估的每个时间段(秒)的长度。
--evaluation-periods <COUNT>
评估的期间数。
--statistic <STATISTIC>
评估的统计数据: ['max', 'min', 'avg', 'sum', 'count']。
--comparison-operator <OPERATOR>
要比较的 operator,其中之一: ['lt', 'le', 'eq', 'ne', 'ge', 'gt']。
--threshold <THRESHOLD>
评估的阈值。必需。
-Q <QUERY>, --query <QUERY>
key[op]data_type::value; list. data_type 是可选的,但如果提供,则必须为字符串、整数、浮点或布尔值。

13.20. ceilometer alarm-threshold-update

usage: ceilometer alarm-threshold-update [--name <NAME>] [--project-id <ALARM_PROJECT_ID>] [--user-id <ALARM_USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] [--insufficient-data-action <Webhook URL>] [--time-constraint <Time Constraint>] [--repeat-actions {True|False}] [--remove-time-constraint <Constraint names>] [-m <METRIC>] [--period <PERIOD>] [--evaluation-periods <COUNT>] [--statistic <STATISTIC>] [--comparison-operator <OPERATOR>] [--threshold <THRESHOLD>] [-q <QUERY>] [<ALARM_ID>]
Copy to Clipboard Toggle word wrap
根据计算的统计信息更新现有警报。

positional 参数

<ALARM_ID>
要更新的警报 ID。

可选参数

--name <NAME>
警报的名称(每个租户必须是唯一的)。
--project-id <ALARM_PROJECT_ID>
与警报关联的租户(仅由 admin 用户设置)。
--user-id <ALARM_USER_ID>
与警报关联的用户(仅由 admin 用户设置)。
--description <DESCRIPTION>
警报的空闲文本描述。
--state <STATE>
警报的状态,其中之一: ['ok', 'alarm', 'insufficient data']
--severity <SEVERITY>
警报的严重性,其中之一: ['low', 'moderate', 'critical']
--enabled {True|False}
如果启用了警报评估/操作,则为 true。
--alarm-action <Webhook URL>
在状态过渡到 alarm 时调用的 URL。可以多次使用。默认值为 None。
--OK-action <Webhook URL>
当状态转换为 OK 时调用的 URL。可以多次使用。默认值为 None。
--insufficient-data-action <Webhook URL>
当状态过渡到 insufficient data 时要调用的 URL。可以多次使用。默认值为 None。
--time-constraint <Time Constraint>
仅在评估时间在此时间约束内评估警报。约束的起点使用 cron 表达式指定,而其持续时间以秒为单位。可以多次指定多个时间限制,格式为: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.
--repeat-actions {True|False}
如果为在警报保持目标状态时重复通知,则为 true。默认值为 False。
--remove-time-constraint <Constraint name>
要删除的时间限制的名称或列表。
-m <METRIC>, --meter-name <METRIC>
要评估的指标。
--period <PERIOD>
要评估的每个时间段(秒)的长度。
--evaluation-periods <COUNT>
评估的期间数。
--statistic <STATISTIC>
评估的统计数据: ['max', 'min', 'avg', 'sum', 'count']。
--comparison-operator <OPERATOR>
要比较的 operator,其中之一: ['lt', 'le', 'eq', 'ne', 'ge', 'gt']。
--threshold <THRESHOLD>
评估的阈值。
-Q <QUERY>, --query <QUERY>
key[op]data_type::value; list. data_type 是可选的,但如果提供,则必须为字符串、整数、浮点或布尔值。

13.21. Ceilometer 功能

usage: ceilometer capabilities
Copy to Clipboard Toggle word wrap
打印 Ceilometer 功能.

13.22. ceilometer event-list

usage: ceilometer event-list [-q <QUERY>] [--no-traits] [-l <NUMBER>]
Copy to Clipboard Toggle word wrap
列出事件。

可选参数

-Q <QUERY>, --query <QUERY>
key[op]data_type::value; list. data_type 是可选的,但如果提供,则必须为字符串、整数、浮点时间。
--no-traits
如果指定,则不会打印特征。
-L <NUMBER>, --limit <NUMBER>
要返回的最大事件数。

13.23. ceilometer event-show

usage: ceilometer event-show <message_id>
Copy to Clipboard Toggle word wrap
显示特定事件。

positional 参数

<message_id>
事件的 ID。应该是 UUID。

13.24. ceilometer event-type-list

usage: ceilometer event-type-list
Copy to Clipboard Toggle word wrap
列出事件类型。

13.25. ceilometer meter-list

usage: ceilometer meter-list [-q <QUERY>] [-l <NUMBER>]
Copy to Clipboard Toggle word wrap
列出用户的量表。

可选参数

-Q <QUERY>, --query <QUERY>
key[op]data_type::value; list. data_type 是可选的,但如果提供,则必须为字符串、整数、浮点或布尔值。
-L <NUMBER>, --limit <NUMBER>
要返回的最大量表数。

13.26. ceilometer query-alarm-history

usage: ceilometer query-alarm-history [-f <FILTER>] [-o <ORDERBY>] [-l <LIMIT>]
Copy to Clipboard Toggle word wrap
查询警报历史.

可选参数

-f <FILTER>, --filter <FILTER>
{complex_op: [{simple_op: {field_name: value}}]} The complex_op 是:['and', 'or'], simple_op 之一:['=', '!=', '<', '<=', '>', '>=']。
-o <ORDERBY>, --orderby <ORDERBY>
[{field_name: direction}, {field_name: direction}] 方向是其中之一: ['asc', 'desc']。
-L <LIMIT>, --limit <LIMIT>
要返回的最大警报历史记录项数。

13.27. ceilometer query-alarms

usage: ceilometer query-alarms [-f <FILTER>] [-o <ORDERBY>] [-l <LIMIT>]
Copy to Clipboard Toggle word wrap
查询警报.

可选参数

-f <FILTER>, --filter <FILTER>
{complex_op: [{simple_op: {field_name: value}}]} The complex_op 是:['and', 'or'], simple_op 之一:['=', '!=', '<', '<=', '>', '>=']。
-o <ORDERBY>, --orderby <ORDERBY>
[{field_name: direction}, {field_name: direction}] 方向是其中之一: ['asc', 'desc']。
-L <LIMIT>, --limit <LIMIT>
要返回的最大警报数。

13.28. ceilometer query-samples

usage: ceilometer query-samples [-f <FILTER>] [-o <ORDERBY>] [-l <LIMIT>]
Copy to Clipboard Toggle word wrap
查询示例。

可选参数

-f <FILTER>, --filter <FILTER>
{complex_op: [{simple_op: {field_name: value}}]} The complex_op 是:['and', 'or'], simple_op 之一:['=', '!=', '<', '<=', '>', '>=']。
-o <ORDERBY>, --orderby <ORDERBY>
[{field_name: direction}, {field_name: direction}] 方向是其中之一: ['asc', 'desc']。
-L <LIMIT>, --limit <LIMIT>
要返回的最大示例数。

13.29. ceilometer resource-list

usage: ceilometer resource-list [-q <QUERY>] [-l <NUMBER>]
Copy to Clipboard Toggle word wrap
列出资源。

可选参数

-Q <QUERY>, --query <QUERY>
key[op]data_type::value; list. data_type 是可选的,但如果提供,则必须为字符串、整数、浮点或布尔值。
-L <NUMBER>, --limit <NUMBER>
要返回的资源的最大数量。

13.30. ceilometer resource-show

usage: ceilometer resource-show <RESOURCE_ID>
Copy to Clipboard Toggle word wrap
显示资源。

positional 参数

<RESOURCE_ID>
要显示的资源 ID。

13.31. ceilometer sample-create

usage: ceilometer sample-create [--project-id <SAMPLE_PROJECT_ID>] [--user-id <SAMPLE_USER_ID>] -r <RESOURCE_ID> -m <METER_NAME> --meter-type <METER_TYPE> --meter-unit <METER_UNIT> --sample-volume <SAMPLE_VOLUME> [--resource-metadata <RESOURCE_METADATA>] [--timestamp <TIMESTAMP>] [--direct <DIRECT>]
Copy to Clipboard Toggle word wrap
创建示例。

可选参数

--project-id <SAMPLE_PROJECT_ID>
与示例关联的租户(仅由 admin 用户设置)。
--user-id <SAMPLE_USER_ID>
与示例关联的用户(仅由 admin 用户设置)。
-r <RESOURCE_ID>, --resource-id <RESOURCE_ID>
资源的 ID。必需。
-m <METER_NAME>, --meter-name <METER_NAME>
计量名称。必需。
--meter-type <METER_TYPE>
计量类型。必需。
--meter-unit <METER_UNIT>
计量单元。必需。
--sample-volume <SAMPLE_VOLUME>
示例卷。必需。
--resource-metadata <RESOURCE_METADATA>
资源元数据.提供的值应当是一组键值对,如 {"key":"value"}。
--timestamp <TIMESTAMP>
示例时间戳。
--direct <DIRECT>
直接将示例发布到存储。默认值为 False。

13.32. ceilometer sample-create-list

usage: ceilometer sample-create-list [--direct <DIRECT>] <SAMPLES_LIST>
Copy to Clipboard Toggle word wrap
创建一个示例列表。

positional 参数

<SAMPLES_LIST>
带有要创建的示例的 JSON 数组。

可选参数

--direct <DIRECT>
直接将示例发布到存储。默认值为 False。

13.33. ceilometer sample-list

usage: ceilometer sample-list [-q <QUERY>] [-m <NAME>] [-l <NUMBER>]
Copy to Clipboard Toggle word wrap
列出示例(如果设置了 -m/-meter),则返回 OldSample 对象。

可选参数

-Q <QUERY>, --query <QUERY>
key[op]data_type::value; list. data_type 是可选的,但如果提供,则必须为字符串、整数、浮点或布尔值。
-m <NAME>, --meter <NAME>
显示示例的计量名称。
-L <NUMBER>, --limit <NUMBER>
要返回的最大示例数。

13.34. ceilometer sample-show

usage: ceilometer sample-show <SAMPLE_ID>
Copy to Clipboard Toggle word wrap
显示示例。

positional 参数

<SAMPLE_ID>
要显示的示例 ID (也称为消息 ID)。

13.35. Ceilometer 统计

usage: ceilometer statistics [-q <QUERY>] -m <NAME> [-p <PERIOD>] [-g <FIELD>] [-a <FUNC>[<-<PARAM>]]
Copy to Clipboard Toggle word wrap
列出量表的统计信息。

可选参数

-Q <QUERY>, --query <QUERY>
key[op]data_type::value; list. data_type 是可选的,但如果提供,则必须为字符串、整数、浮点或布尔值。
-m <NAME>, --meter <NAME>
列出统计信息的计量名称。必需。
-p <PERIOD>, --period <PERIOD>
对样本进行分组的期间(以秒为单位)。
-g <FIELD>, --groupby <FIELD>
组的字段按以下项:
-a <FUNC>[<-<PARAM>], --aggregate <FUNC>[<-<PARAM>]
数据聚合功能。可用的聚合有:count, cardinality, min, max, sum, stddev, avg.默认为 []。

13.36. ceilometer trait-description-list

usage: ceilometer trait-description-list -e <EVENT_TYPE>
Copy to Clipboard Toggle word wrap
列出事件类型的特征信息。

可选参数

-e <EVENT_TYPE>, --event_type <EVENT_TYPE>
显示特征的事件类型。必需。

13.37. ceilometer trait-list

usage: ceilometer trait-list -e <EVENT_TYPE> -t <TRAIT_NAME>
Copy to Clipboard Toggle word wrap
列出名为 <trait_name> 用于 Event Type <event_type> 的所有特征。

可选参数

-e <EVENT_TYPE>, --event_type <EVENT_TYPE>
列出特征的事件类型。必需。
-T <TRAIT_NAME>, --trait_name <TRAIT_NAME>
要列出的特征的名称。必需。

第 14 章 数据处理服务命令行客户端

sahara 客户端是数据处理服务 API 及其扩展命令行界面(CLI)。本章记录了 0.11.1 版本 sahara
有关特定 sahara 命令的帮助信息,请输入:
$ sahara help COMMAND
Copy to Clipboard Toggle word wrap

14.1. sahara usage

usage: sahara [--version] [--debug] [--os-cache] [--region-name <region-name>] [--service-type <service-type>] [--endpoint-type <endpoint-type>] [--sahara-api-version <sahara-api-ver>] [--bypass-url <bypass-url>] [--os-tenant-name OS_TENANT_NAME] [--os-tenant-id OS_TENANT_ID] [--os-auth-system OS_AUTH_SYSTEM] [--os-auth-token OS_AUTH_TOKEN] [--insecure] [--os-cacert <ca-certificate>] [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>] [--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID] [--os-domain-name OS_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID] [--os-project-name OS_PROJECT_NAME] [--os-project-domain-id OS_PROJECT_DOMAIN_ID] [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] [--os-trust-id OS_TRUST_ID] [--os-user-id OS_USER_ID] [--os-user-name OS_USERNAME] [--os-user-domain-id OS_USER_DOMAIN_ID] [--os-user-domain-name OS_USER_DOMAIN_NAME] [--os-password OS_PASSWORD] <subcommand> ...
Copy to Clipboard Toggle word wrap

子命令

cluster-create
创建集群。
cluster-delete
删除集群。
cluster-list
打印可用集群列表。
cluster-scale
扩展集群。
cluster-show
显示集群详情。
cluster-template-create
创建集群模板。
cluster-template-delete
删除集群模板。
cluster-template-list
显示可用集群模板列表。
cluster-template-show
显示集群模板的详情。
cluster-template-update
更新集群模板。
data-source-create
创建提供作业输入或接收作业输出的数据源。
data-source-delete
删除数据源。
data-source-list
打印可用数据源列表。
data-source-show
显示数据源的详细信息。
data-source-update
更新数据源。
image-add-tag
添加标签到镜像。
image-list
打印可用镜像列表。
image-register
从镜像索引注册镜像。
image-remove-tag
从镜像中删除标签。
image-show
显示镜像的详细信息。
image-unregister
取消镜像注册。
job-binary-create
记录作业二进制文件。
job-binary-data-create
将数据存储在内部数据库中。使用 'swift upload' 而不是此命令。仅在 Swift 不可用时使用此命令。
job-binary-data-delete
删除内部存储的作业二进制数据。
job-binary-data-list
打印内部存储作业二进制数据的列表。
job-binary-delete
删除作业二进制文件。
job-binary-list
打印作业二进制文件列表。
job-binary-show
显示作业二进制文件的详细信息。
job-binary-update
更新作业二进制文件。
job-create
创建作业。
job-delete
删除作业。
job-list
打印作业列表。
job-show
显示作业的详细信息。
job-template-create
创建作业模板。
job-template-delete
删除作业模板。
job-template-list
打印作业模板列表。
job-template-show
显示作业模板的详细信息。
job-type-list
显示支持的作业类型。
node-group-template-create
创建节点组模板。
node-group-template-delete
删除节点组模板。
node-group-template-list
显示可用节点组模板列表。
node-group-template-show
显示节点组模板的详细信息。
node-group-template-update
更新节点组模板。
plugin-list
打印可用插件列表。
plugin-show
显示插件的详情。
bash-completion
为 bash 补全打印参数。将所有命令和选项输出到 stdout,以便 sahara.bash_completion 脚本不必硬编码它们。
帮助
显示有关该程序或其其中一个子命令的帮助。

14.2. sahara 可选参数

--version
显示程序的版本号并退出
--debug
打印调试输出。
--os-cache
使用身份验证令牌缓存。如果没有设置 env[OS_CACHE],则默认为 False。
--region-name <region-name>
默认为 env[OS_REGION_NAME]
--service-type <service-type>
默认为所有操作的数据处理。
--endpoint-type <endpoint-type>
默认为 env[SAHARA_ENDPOINT_TYPE]env[OS_ENDPOINT_TYPE] 或 publicURL。
--sahara-api-version <sahara-api-ver>
接受 "api",默认为 env[SAHARA_API_VERSION]
--bypass-url <bypass-url>
使用此 API 端点而不是服务目录。
--os-tenant-name OS_TENANT_NAME
默认为 env[OS_TENANT_NAME]
--os-tenant-id OS_TENANT_ID
默认为 env[OS_TENANT_ID]
--os-auth-system OS_AUTH_SYSTEM
默认为 env[OS_AUTH_SYSTEM]
--os-auth-token OS_AUTH_TOKEN
默认为 env[OS_AUTH_TOKEN]
--insecure
明确允许客户端执行"不安全"TLS (https)请求。服务器的证书不会针对任何证书颁发机构进行验证。这个选项应谨慎使用。
--os-cacert <ca-certificate>
指定用于验证 TLS (https)服务器证书中使用的 CA 捆绑包文件。默认为 env[OS_CACERT]
--os-cert <certificate>
默认为 env[OS_CERT]
--os-key <key>
默认为 env[OS_KEY]
--timeout <seconds>
设置请求超时(以秒为单位)。
--os-auth-url OS_AUTH_URL
身份验证 URL
--os-domain-id OS_DOMAIN_ID
域 ID 范围
--os-domain-name OS_DOMAIN_NAME
域名范围为
--os-project-id OS_PROJECT_ID
项目 ID 到范围
--os-project-name OS_PROJECT_NAME
项目名称到范围
--os-project-domain-id OS_PROJECT_DOMAIN_ID
包含项目的域 ID
--os-project-domain-name OS_PROJECT_DOMAIN_NAME
包含项目的域名
--os-trust-id OS_TRUST_ID
信任 ID
--os-user-id OS_USER_ID
用户 ID
--os-user-name OS_USERNAME, --os-username OS_USERNAME
用户名
--os-user-domain-id OS_USER_DOMAIN_ID
用户的域 ID
--os-user-domain-name OS_USER_DOMAIN_NAME
用户的域名
--os-password OS_PASSWORD
用户密码

14.3. sahara cluster-create

usage: sahara cluster-create [--json JSON] [--count COUNT]
Copy to Clipboard Toggle word wrap
创建集群。

可选参数

--json JSON
集群的 JSON 表示。
--count COUNT
要创建的集群数量。

14.4. sahara cluster-delete

usage: sahara cluster-delete [--name NAME] [--id <cluster_id>]
Copy to Clipboard Toggle word wrap
删除集群。

可选参数

--name NAME
集群的名称。
--id <cluster_id>
要删除的集群的 ID。

14.5. sahara cluster-list

usage: sahara cluster-list
Copy to Clipboard Toggle word wrap
打印可用集群列表。

14.6. sahara cluster-scale

usage: sahara cluster-scale [--name NAME] [--id <cluster_id>] [--json JSON]
Copy to Clipboard Toggle word wrap
扩展集群。

可选参数

--name NAME
集群的名称。
--id <cluster_id>
集群的 ID。
--json JSON
集群扩展的 JSON 表示。

14.7. sahara cluster-show

usage: sahara cluster-show [--name NAME] [--id <cluster_id>] [--show-progress SHOW_PROGRESS] [--json]
Copy to Clipboard Toggle word wrap
显示集群详情。

可选参数

--name NAME
集群的名称。
--id <cluster_id>
要显示的集群 ID。
--show-progress SHOW_PROGRESS
显示集群的置备进度事件。
--json
输出集群的 JSON 表示。

14.8. sahara cluster-template-create

usage: sahara cluster-template-create [--json JSON]
Copy to Clipboard Toggle word wrap
创建集群模板。

可选参数

--json JSON
集群模板的 JSON 表示。

14.9. sahara cluster-template-delete

usage: sahara cluster-template-delete [--name NAME] [--id <template_id>]
Copy to Clipboard Toggle word wrap
删除集群模板。

可选参数

--name NAME
集群模板的名称。
--id <template_id>
要删除的集群模板的 ID。

14.10. sahara cluster-template-list

usage: sahara cluster-template-list
Copy to Clipboard Toggle word wrap
显示可用集群模板列表。

14.11. sahara cluster-template-show

usage: sahara cluster-template-show [--name NAME] [--id <template_id>] [--json]
Copy to Clipboard Toggle word wrap
显示集群模板的详情。

可选参数

--name NAME
集群模板的名称。
--id <template_id>
要显示的集群模板的 ID。
--json
输出集群模板的 JSON 表示。

14.12. sahara cluster-template-update

usage: sahara cluster-template-update [--name NAME] [--id <template_id>] [--json JSON]
Copy to Clipboard Toggle word wrap
更新集群模板。

可选参数

--name NAME
要更新的集群模板的名称。
--id <template_id>
要更新的集群模板的 ID。
--json JSON
集群模板更新的 JSON 表示。

14.13. sahara data-source-create

usage: sahara data-source-create --name NAME --type TYPE --url URL [--description DESCRIPTION] [--user USER] [--password PASSWORD]
Copy to Clipboard Toggle word wrap
创建提供作业输入或接收作业输出的数据源。

可选参数

--name NAME
数据源的名称。
--type TYPE
数据源的类型。
--url URL
数据源的 URL。
--description DESCRIPTION
数据源的描述。
--user USER
用于访问数据源 URL 的用户名。
--password PASSWORD
用于访问数据源 URL 的密码。

14.14. sahara data-source-delete

usage: sahara data-source-delete [--name NAME] [--id ID]
Copy to Clipboard Toggle word wrap
删除数据源。

可选参数

--name NAME
数据源的名称。
--id ID
要删除的数据源的 ID。

14.15. sahara data-source-list

usage: sahara data-source-list
Copy to Clipboard Toggle word wrap
打印可用数据源列表。

14.16. sahara data-source-show

usage: sahara data-source-show [--name NAME] [--id ID]
Copy to Clipboard Toggle word wrap
显示数据源的详细信息。

可选参数

--name NAME
数据源的名称。
--id ID
数据源的 ID。

14.17. sahara data-source-update

usage: sahara data-source-update [--name NAME] [--id ID] [--json JSON]
Copy to Clipboard Toggle word wrap
更新数据源。

可选参数

--name NAME
要更新的数据源的名称。
--id ID
要更新的数据源的 ID。
--json JSON
包含要更新的数据源字段的 JSON。

14.18. sahara image-add-tag

usage: sahara image-add-tag [--name NAME] [--id <image_id>] --tag <tag>
Copy to Clipboard Toggle word wrap
添加标签到镜像。

可选参数

--name NAME
镜像的名称。
--id <image_id>
要标记的镜像 ID。
--tag <tag>
要添加的标签。

14.19. sahara image-list

usage: sahara image-list
Copy to Clipboard Toggle word wrap
打印可用镜像列表。

14.20. sahara image-register

usage: sahara image-register --id <image_id> [--username <name>] [--description <desc>]
Copy to Clipboard Toggle word wrap
从镜像索引注册镜像。

可选参数

--id <image_id>
镜像 ID,运行 "glance image-list" 来查看所有 ID。
--username <name>
镜像中特权用户的用户名。
--description <desc>
镜像的描述。

14.21. sahara image-remove-tag

usage: sahara image-remove-tag [--name NAME] [--id <image_id>] --tag <tag>
Copy to Clipboard Toggle word wrap
从镜像中删除标签。

可选参数

--name NAME
镜像的名称。
--id <image_id>
要标记的镜像。
--tag <tag>
要移除的标签。

14.22. sahara image-show

usage: sahara image-show [--name NAME] [--id <image_id>]
Copy to Clipboard Toggle word wrap
显示镜像的详细信息。

可选参数

--name NAME
镜像的名称。
--id <image_id>
镜像的 ID。

14.23. sahara image-unregister

usage: sahara image-unregister [--name NAME] [--id <image_id>]
Copy to Clipboard Toggle word wrap
取消镜像注册。

可选参数

--name NAME
镜像的名称。
--id <image_id>
要取消注册的镜像 ID。

14.24. sahara job-binary-create

usage: sahara job-binary-create --name NAME --url URL [--description DESCRIPTION] [--user USER] [--password PASSWORD]
Copy to Clipboard Toggle word wrap
记录作业二进制文件。

可选参数

--name NAME
作业二进制文件的名称。
--url URL
作业二进制文件的 URL。
--description DESCRIPTION
作业二进制文件的描述。
--user USER
用于访问作业二进制 URL 的用户名。
--password PASSWORD
用于访问作业二进制 URL 的密码。

14.25. sahara job-binary-data-create

usage: sahara job-binary-data-create [--file FILE] [--name NAME]
Copy to Clipboard Toggle word wrap
将数据存储在内部数据库中。使用 'swift upload' 而不是此命令。仅在 Swift 不可用时使用此命令。

可选参数

--file FILE
要存储的数据。
--name NAME
作业二进制文件内部的名称。

14.26. sahara job-binary-data-delete

usage: sahara job-binary-data-delete --id ID
Copy to Clipboard Toggle word wrap
删除内部存储的作业二进制数据。

可选参数

--id ID
内部存储作业二进制数据的 ID。

14.27. sahara job-binary-data-list

usage: sahara job-binary-data-list
Copy to Clipboard Toggle word wrap
打印内部存储作业二进制数据的列表。

14.28. sahara job-binary-delete

usage: sahara job-binary-delete [--name NAME] [--id ID]
Copy to Clipboard Toggle word wrap
删除作业二进制文件。

可选参数

--name NAME
作业二进制文件的名称。
--id ID
要删除的作业二进制文件的 ID。

14.29. sahara job-binary-list

usage: sahara job-binary-list
Copy to Clipboard Toggle word wrap
打印作业二进制文件列表。

14.30. sahara job-binary-show

usage: sahara job-binary-show [--name NAME] [--id ID]
Copy to Clipboard Toggle word wrap
显示作业二进制文件的详细信息。

可选参数

--name NAME
作业二进制文件的名称。
--id ID
作业二进制文件的 ID。

14.31. sahara job-binary-update

usage: sahara job-binary-update [--name NAME] [--id <job_binary_id>] [--json JSON]
Copy to Clipboard Toggle word wrap
更新作业二进制文件。

可选参数

--name NAME
要更新的作业二进制文件的名称。
--id <job_binary_id>
要更新的作业二进制文件的 ID。
--json JSON
作业二进制更新的 JSON 表示。

14.32. sahara job-create

usage: sahara job-create --job-template JOB_TEMPLATE [--cluster CLUSTER] [--input-data INPUT_DATA] [--output-data OUTPUT_DATA] [--param name=value] [--arg ARG] [--config name=value] [--json JSON]
Copy to Clipboard Toggle word wrap
创建作业。

可选参数

--job-template JOB_TEMPLATE
要运行的作业模板的 ID。
--cluster CLUSTER
运行作业的集群 ID。
--input-data INPUT_DATA
输入数据源的 ID。
--output-data OUTPUT_DATA
输出数据源的 ID。
--param
要添加到作业的 name=value 参数,可重复使用。
--arg ARG
要添加到作业的参数,可重复使用。
--config
要添加到作业的 name=value 配置参数,可重复使用。
--json JSON
作业的 JSON 表示。

14.33. sahara job-delete

usage: sahara job-delete --id ID
Copy to Clipboard Toggle word wrap
删除作业。

可选参数

--id ID
作业的 ID。

14.34. sahara job-list

usage: sahara job-list
Copy to Clipboard Toggle word wrap
打印作业列表。

14.35. sahara job-show

usage: sahara job-show --id ID
Copy to Clipboard Toggle word wrap
显示作业的详细信息。

可选参数

--id ID
作业的 ID。

14.36. sahara job-template-create

usage: sahara job-template-create [--name NAME] [--type TYPE] [--main MAIN] [--lib LIB] [--description DESCRIPTION] [--json JSON]
Copy to Clipboard Toggle word wrap
创建作业模板。

可选参数

--name NAME
作业模板的名称。
--type TYPE
作业模板的类型。
--main MAIN
作业主作业主二进制的 ID。
--lib LIB
作业的 lib job-binary 的 ID,可重复使用。
--description DESCRIPTION
作业模板的描述。
--json JSON
作业模板的 JSON 表示。

14.37. sahara job-template-delete

usage: sahara job-template-delete [--name NAME] [--id ID]
Copy to Clipboard Toggle word wrap
删除作业模板。

可选参数

--name NAME
作业模板的名称。
--id ID
作业模板的 ID。

14.38. sahara job-template-list

usage: sahara job-template-list
Copy to Clipboard Toggle word wrap
打印作业模板列表。

14.39. sahara job-template-show

usage: sahara job-template-show [--name NAME] [--id ID]
Copy to Clipboard Toggle word wrap
显示作业模板的详细信息。

可选参数

--name NAME
作业模板的名称。
--id ID
作业模板的 ID。

14.40. sahara job-type-list

usage: sahara job-type-list [--type <job_type>] [--plugin <plugin>] [--plugin-version <plugin_version>]
Copy to Clipboard Toggle word wrap
显示支持的作业类型。

可选参数

--type <job_type>
仅报告此作业类型。
--plugin <plugin>
仅报告此插件支持的作业类型。
--plugin-version <plugin_version>
仅报告指定插件此版本所支持的作业类型。仅对 --plugin 有效。

14.41. sahara node-group-template-create

usage: sahara node-group-template-create [--json JSON]
Copy to Clipboard Toggle word wrap
创建节点组模板。

可选参数

--json JSON
节点组模板的 JSON 表示。

14.42. sahara node-group-template-delete

usage: sahara node-group-template-delete [--name NAME] [--id <template_id>]
Copy to Clipboard Toggle word wrap
删除节点组模板。

可选参数

--name NAME
节点组模板的名称。
--id <template_id>
要删除的节点组模板的 ID。

14.43. sahara node-group-template-list

usage: sahara node-group-template-list
Copy to Clipboard Toggle word wrap
显示可用节点组模板列表。

14.44. sahara node-group-template-show

usage: sahara node-group-template-show [--name NAME] [--id <template_id>] [--json]
Copy to Clipboard Toggle word wrap
显示节点组模板的详细信息。

可选参数

--name NAME
节点组模板的名称。
--id <template_id>
要显示的节点组模板的 ID。
--json
输出节点组模板的 JSON 表示。

14.45. sahara node-group-template-update

usage: sahara node-group-template-update [--name NAME] [--id <template_id>] [--json JSON]
Copy to Clipboard Toggle word wrap
更新节点组模板。

可选参数

--name NAME
要更新的节点组模板的名称。
--id <template_id>
要更新的节点组模板的 ID。
--json JSON
节点组模板更新的 JSON 表示。

14.46. sahara plugin-list

usage: sahara plugin-list
Copy to Clipboard Toggle word wrap
打印可用插件列表。

14.47. sahara plugin-show

usage: sahara plugin-show --name <plugin>
Copy to Clipboard Toggle word wrap
显示插件的详情。

可选参数

--name <plugin>
插件的名称。

第 15 章 数据库服务命令行客户端

trove 客户端是数据库服务 API 及其扩展命令行界面(CLI)。本章记录了 版本 1.3.0
有关特定 trove 命令的帮助信息,请输入:
$ trove help COMMAND
Copy to Clipboard Toggle word wrap

15.1. Trove 使用

usage: trove [--version] [--debug] [--os-auth-system <auth-system>] [--service-type <service-type>] [--service-name <service-name>] [--bypass-url <bypass-url>] [--database-service-name <database-service-name>] [--endpoint-type <endpoint-type>] [--os-database-api-version <database-api-ver>] [--retries <retries>] [--json] [--profile HMAC_KEY] [--insecure] [--os-cacert <ca-certificate>] [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>] [--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID] [--os-domain-name OS_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID] [--os-project-name OS_PROJECT_NAME] [--os-project-domain-id OS_PROJECT_DOMAIN_ID] [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] [--os-trust-id OS_TRUST_ID] [--os-user-id OS_USER_ID] [--os-user-name OS_USERNAME] [--os-user-domain-id OS_USER_DOMAIN_ID] [--os-user-domain-name OS_USER_DOMAIN_NAME] [--os-password OS_PASSWORD] [--os-tenant-name <auth-tenant-name>] [--os-tenant-id <tenant-id>] [--os-auth-token OS_AUTH_TOKEN] [--os-region-name <region-name>] <subcommand> ...
Copy to Clipboard Toggle word wrap

子命令

backup-copy
从另一个备份创建备份。
backup-create
创建实例的备份。
backup-delete
删除备份。
backup-list
列出可用的备份。
backup-list-instance
列出实例的可用备份。
backup-show
显示备份详情。
cluster-create
创建新集群。
cluster-delete
删除集群。
cluster-grow
在集群中添加更多实例。
cluster-instances
列出集群的所有实例。
cluster-list
列出所有集群。
cluster-show
显示集群详情。
cluster-shrink
从集群中丢弃实例。
configuration-attach
将配置组附加到实例。
configuration-create
创建配置组。
configuration-default
显示实例的默认配置。
configuration-delete
删除配置组。
configuration-detach
将配置组从实例分离。
configuration-instances
列出与配置组关联的所有实例。
configuration-list
列出所有配置组。
configuration-parameter-list
列出配置组的可用参数。
configuration-parameter-show
显示配置参数的详细信息。
configuration-patch
对配置组进行补丁。
configuration-show
显示配置组的详细信息。
configuration-update
更新配置组。
create
创建新实例。
database-create
在实例上创建数据库。
database-delete
从实例删除数据库。
database-list
列出实例上的可用数据库。
Datastore-list
列出可用的数据存储。
Datastore-show
显示数据存储的详细信息。
Datastore-version-list
列出数据存储的可用版本。
Datastore-version-show
显示数据存储版本的详细信息。
delete
删除实例。
detach-replica
将副本实例从其复制源中分离。
eject-replica-source
从其集合中弹出一个副本源。
flavor-list
列出可用的类别。
flavor-show
显示类别的详细信息。
limit-list
列出租户的限制。
list
列出所有实例。
metadata-create
在数据库中为 <id> 创建元数据。
metadata-delete
删除实例 <id> 的元数据。
metadata-edit
使用新值替换 metadata 值,这是非破坏性。
metadata-list
显示实例 <id> 的所有元数据。
metadata-show
显示键 <key> 和实例 <id> 的元数据条目。
metadata-update
更新元数据,这是破坏性。
promote-to-replica-source
将副本提升为集合的新副本源。
resize-instance
使用新类别重新定义实例大小。
resize-volume
调整实例的卷大小。
restart
重启实例。
root-enable
为实例启用 root,并在已存在时重置。
root-show
如果实例或集群启用了 root,则获取状态。
secgroup-add-rule
创建安全组规则。
secgroup-delete-rule
删除安全组规则。
secgroup-list
列出所有安全组。
secgroup-list-rules
列出安全组的所有规则。
secgroup-show
显示安全组的详细信息。
显示
显示实例的详细信息。
update
更新实例:编辑名称、配置或副本源。
user-create
在实例上创建用户。
user-delete
从实例删除用户。
user-grant-access
授予用户数据库的访问权限。
user-list
列出实例的用户。
user-revoke-access
撤销用户对数据库的访问权限。
user-show
显示实例用户的详细信息。
user-show-access
显示实例的用户访问详细信息。
user-update-attributes
更新实例上用户的属性。
bash-completion
输出 bash_completion 的参数。
帮助
显示关于该程序或其子命令的帮助信息。

15.2. Trove 可选参数

--version
显示程序的版本号并退出
--debug
打印调试输出。
--os-auth-system <auth-system>
默认为 env[OS_AUTH_SYSTEM]
--service-type <service-type>
对于大多数操作,默认为 database。
--service-name <service-name>
默认为 env[TROVE_SERVICE_NAME]
--bypass-url <bypass-url>
默认为 env[TROVE_BYPASS_URL]
--database-service-name <database-service-name>
默认为 env[TROVE_DATABASE_SERVICE_NAME]
--endpoint-type <endpoint-type>
默认为 env[TROVE_ENDPOINT_TYPE] 或 publicURL。
--os-database-api-version <database-api-ver>
接受 1,默认为 env[OS_DATABASE_API_VERSION]
--retries <retries>
重试次数。
--json, --os-json-output
输出 JSON 而不是 prettyprint。默认为 env[OS_JSON_OUTPUT]
--profile HMAC_KEY
在分析操作性能时,用于加密上下文数据的 HMAC 密钥。此密钥应设置为 Trove 中配置的 HMAC 密钥之一(它们位于 api-paste.ini 中,通常在 /etc/trove 中找到)。如果没有密钥,即使没有密钥,也不会触发性能分析,即使它在服务器端启用了它。默认为 env[OS_PROFILE_HMACKEY]
--insecure
明确允许客户端执行"不安全"TLS (https)请求。服务器的证书不会针对任何证书颁发机构进行验证。这个选项应谨慎使用。
--os-cacert <ca-certificate>
指定用于验证 TLS (https)服务器证书中使用的 CA 捆绑包文件。默认为 env[OS_CACERT]
--os-cert <certificate>
默认为 env[OS_CERT]
--os-key <key>
默认为 env[OS_KEY]
--timeout <seconds>
设置请求超时(以秒为单位)。
--os-auth-url OS_AUTH_URL
身份验证 URL
--os-domain-id OS_DOMAIN_ID
域 ID 范围
--os-domain-name OS_DOMAIN_NAME
域名范围为
--os-project-id OS_PROJECT_ID
项目 ID 到范围
--os-project-name OS_PROJECT_NAME
项目名称到范围
--os-project-domain-id OS_PROJECT_DOMAIN_ID
包含项目的域 ID
--os-project-domain-name OS_PROJECT_DOMAIN_NAME
包含项目的域名
--os-trust-id OS_TRUST_ID
信任 ID
--os-user-id OS_USER_ID
用户 ID
--os-user-name OS_USERNAME, --os-username OS_USERNAME
用户名
--os-user-domain-id OS_USER_DOMAIN_ID
用户的域 ID
--os-user-domain-name OS_USER_DOMAIN_NAME
用户的域名
--os-password OS_PASSWORD
用户密码
--os-tenant-name <auth-tenant-name>
用于请求授权的租户。默认为 env[OS_TENANT_NAME]
--os-tenant-id <tenant-id>
用于请求授权的租户。默认为 env[OS_TENANT_ID]
--os-auth-token OS_AUTH_TOKEN
默认为 env[OS_AUTH_TOKEN]
--os-region-name <region-name>
指定要使用的区域。默认为 env[OS_REGION_NAME]

15.3. Trove backup-copy

usage: trove backup-copy <name> <backup> [--region <region>] [--description <description>]
Copy to Clipboard Toggle word wrap
从另一个备份创建备份。

positional 参数

<name>
备份的名称。
<backup>
源备份的备份 ID。

可选参数

--region <region>
源备份所在的区域。
--description <description>
备份的可选描述。

15.4. Trove backup-create

usage: trove backup-create <instance> <name> [--description <description>] [--parent <parent>]
Copy to Clipboard Toggle word wrap
创建实例的备份。

positional 参数

<instance>
实例的 ID 或名称。
<name>
备份的名称。

可选参数

--description <description>
备份的可选描述。
--parent <parent>
从中执行增量备份的父备份的可选 ID。

15.5. Trove backup-delete

usage: trove backup-delete <backup>
Copy to Clipboard Toggle word wrap
删除备份。

positional 参数

<backup>
备份 ID。

15.6. Trove backup-list

usage: trove backup-list [--limit <limit>] [--marker <ID>] [--datastore <datastore>]
Copy to Clipboard Toggle word wrap
列出可用的备份。

可选参数

--limit <limit>
返回最新备份的 N 号。
--marker <ID>
开始显示大于指定标记的 ID 的结果。与 --limit 一起使用时,将其设置为上一个运行中显示的最后一个 ID。
--datastore <datastore>
用于列出备份的数据存储名称或 ID。

15.7. Trove backup-list-instance

usage: trove backup-list-instance [--limit <limit>] [--marker <ID>] <instance>
Copy to Clipboard Toggle word wrap
列出实例的可用备份。

positional 参数

<instance>
实例的 ID 或名称。

可选参数

--limit <limit>
返回最新备份的 N 号。
--marker <ID>
开始显示大于指定标记的 ID 的结果。与 --limit 一起使用时,将其设置为上一个运行中显示的最后一个 ID。

15.8. Trove backup-show

usage: trove backup-show <backup>
Copy to Clipboard Toggle word wrap
显示备份详情。

positional 参数

<backup>
备份 ID。

15.9. Trove cluster-create

usage: trove cluster-create <name> <datastore> <datastore_version> [--instance <flavor=flavor_name_or_id,volume=volume>]
Copy to Clipboard Toggle word wrap
创建新集群。

positional 参数

<name>
集群的名称。
<datastore>
数据存储名称或 UUID。
<datastore_version>
数据存储版本名称或 UUID。

可选参数

--instance <flavor=flavor_name_or_id,volume=volume>
为集群创建一个实例。指定多次来创建多个实例。

15.10. Trove cluster-delete

usage: trove cluster-delete <cluster>
Copy to Clipboard Toggle word wrap
删除集群。

positional 参数

<cluster>
集群的 ID 或名称。

15.11. Trove cluster-grow

usage: trove cluster-grow <cluster> [--instance <name=name,flavor=flavor_name_or_id,volume=volume>]
Copy to Clipboard Toggle word wrap
在集群中添加更多实例。

positional 参数

<cluster>
集群的 ID 或名称。

可选参数

--instance <name=name,flavor=flavor_name_or_id,volume=volume>
在集群中添加实例。指定多次来创建多个实例。

15.12. Trove cluster-instances

usage: trove cluster-instances <cluster>
Copy to Clipboard Toggle word wrap
列出集群的所有实例。

positional 参数

<cluster>
集群的 ID 或名称。

15.13. Trove cluster-list

usage: trove cluster-list [--limit <limit>] [--marker <ID>]
Copy to Clipboard Toggle word wrap
列出所有集群。

可选参数

--limit <limit>
限制所显示的结果数量。
--marker <ID>
开始显示大于指定标记的 ID 的结果。与 --limit 一起使用时,将其设置为上一个运行中显示的最后一个 ID。

15.14. Trove cluster-show

usage: trove cluster-show <cluster>
Copy to Clipboard Toggle word wrap
显示集群详情。

positional 参数

<cluster>
集群的 ID 或名称。

15.15. Trove cluster-shrink

usage: trove cluster-shrink <cluster> <instance> [<instance> ...]
Copy to Clipboard Toggle word wrap
从集群中丢弃实例。

positional 参数

<cluster>
集群的 ID 或名称。
<instance>
从集群中删除实例。指定多个 id 来丢弃多个实例。

15.16. Trove configuration-attach

usage: trove configuration-attach <instance> <configuration>
Copy to Clipboard Toggle word wrap
将配置组附加到实例。

positional 参数

<instance>
实例的 ID 或名称。
<configuration>
要附加到实例的配置组的 ID。

15.17. Trove configuration-create

usage: trove configuration-create <name> <values> [--datastore <datastore>] [--datastore_version <datastore_version>] [--description <description>]
Copy to Clipboard Toggle word wrap
创建配置组。

positional 参数

<name>
配置组的名称。
<values>
要设置的值的字典。

可选参数

--datastore <datastore>
分配给配置组的数据存储。如果没有配置默认数据存储,则需要此项。
--datastore_version <datastore_version>
分配给配置组的数据存储版本 ID。
--description <description>
配置组的可选描述。

15.18. Trove configuration-default

usage: trove configuration-default <instance>
Copy to Clipboard Toggle word wrap
显示实例的默认配置。

positional 参数

<instance>
实例的 ID 或名称。

15.19. Trove configuration-delete

usage: trove configuration-delete <configuration_group>
Copy to Clipboard Toggle word wrap
删除配置组。

positional 参数

<configuration_group>
配置组的 ID。

15.20. Trove configuration-detach

usage: trove configuration-detach <instance>
Copy to Clipboard Toggle word wrap
将配置组从实例分离。

positional 参数

<instance>
实例的 ID 或名称。

15.21. Trove configuration-instances

usage: trove configuration-instances <configuration_group>
Copy to Clipboard Toggle word wrap
列出与配置组关联的所有实例。

positional 参数

<configuration_group>
配置组的 ID。

15.22. Trove configuration-list

usage: trove configuration-list
Copy to Clipboard Toggle word wrap
列出所有配置组。

15.23. Trove configuration-parameter-list

usage: trove configuration-parameter-list <datastore_version> [--datastore <datastore>]
Copy to Clipboard Toggle word wrap
列出配置组的可用参数。

positional 参数

<datastore_version>
分配给配置组的数据存储版本名称或 ID。

可选参数

--datastore <datastore>
用于列出配置参数的数据存储的 ID 或名称。如果提供了 datastore_version 的 ID,则可选。

15.24. Trove configuration-parameter-show

usage: trove configuration-parameter-show <datastore_version> <parameter> [--datastore <datastore>]
Copy to Clipboard Toggle word wrap
显示配置参数的详细信息。

positional 参数

<datastore_version>
分配给配置组的数据存储版本名称或 ID。
<parameter>
配置参数的名称。

可选参数

--datastore <datastore>
用于列出配置参数的数据存储的 ID 或名称。如果提供了 datastore_version 的 ID,则可选。

15.25. Trove configuration-patch

usage: trove configuration-patch <configuration_group> <values>
Copy to Clipboard Toggle word wrap
对配置组进行补丁。

positional 参数

<configuration_group>
配置组的 ID。
<values>
要设置的值的字典。

15.26. Trove configuration-show

usage: trove configuration-show <configuration_group>
Copy to Clipboard Toggle word wrap
显示配置组的详细信息。

positional 参数

<configuration_group>
配置组的 ID。

15.27. Trove configuration-update

usage: trove configuration-update <configuration_group> <values> [--name <name>] [--description <description>]
Copy to Clipboard Toggle word wrap
更新配置组。

positional 参数

<configuration_group>
配置组的 ID。
<values>
要设置的值的字典。

可选参数

--name <name>
配置组的名称。
--description <description>
配置组的可选描述。

15.28. Trove create

usage: trove create <name> <flavor> [--size <size>] [--databases <databases> [<databases> ...]] [--users <users> [<users> ...]] [--backup <backup>] [--availability_zone <availability_zone>] [--datastore <datastore>] [--datastore_version <datastore_version>] [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,port-id=port-uuid>] [--configuration <configuration>] [--replica_of <source_instance>] [--replica_count <count>]
Copy to Clipboard Toggle word wrap
创建新实例。

positional 参数

<name>
实例的名称。
<flavor>
实例的类别 ID 或名称。

可选参数

--size <size>
以 GB 为单位的实例磁盘卷的大小。启用卷支持时需要。
--databases <databases> [<databases> ...]
可选的数据库列表。
--users <users> [<users> ...]
以 user:password 格式的可选用户列表。
--backup <backup>
备份 ID。
--availability_zone <availability_zone>
要提供给 nova 的 Zone hint。
--datastore <datastore>
数据存储名称或 ID。
--datastore_version <datastore_version>
数据存储版本名称或 ID。
--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,port-id=port-uuid>
在实例上创建 NIC。多次指定创建多个 NIC 的选项。net- id: 将 NIC 附加到带有此 ID 的网络(必须指定 port-id 或 net-id)、v4-fixed-ip: 用于 NIC 的 IPv4 固定地址(可选)、port-id: 将 NIC 附加到带有此 ID 的端口(必须指定 port-id 或 net-id)。
--configuration <configuration>
要附加到实例的配置组的 ID。
--replica_of <source_instance>
要从中复制的现有实例的 ID 或名称。
--replica_count <count>
要创建的副本数(默认为 1)。

15.29. Trove database-create

usage: trove database-create <instance> <name> [--character_set <character_set>] [--collate <collate>]
Copy to Clipboard Toggle word wrap
在实例上创建数据库。

positional 参数

<instance>
实例的 ID 或名称。
<name>
数据库的名称。

可选参数

--character_set <character_set>
数据库的可选字符集。
--ollate <collate>
数据库的可选协调类型。

15.30. Trove database-delete

usage: trove database-delete <instance> <database>
Copy to Clipboard Toggle word wrap
从实例删除数据库。

positional 参数

<instance>
实例的 ID 或名称。
<database>
数据库的名称。

15.31. Trove database-list

usage: trove database-list <instance>
Copy to Clipboard Toggle word wrap
列出实例上的可用数据库。

positional 参数

<instance>
实例的 ID 或名称。

15.32. Trove datastore-list

usage: trove datastore-list
Copy to Clipboard Toggle word wrap
列出可用的数据存储。

15.33. Trove datastore-show

usage: trove datastore-show <datastore>
Copy to Clipboard Toggle word wrap
显示数据存储的详细信息。

positional 参数

<datastore>
数据存储的 ID。

15.34. Trove datastore-version-list

usage: trove datastore-version-list <datastore>
Copy to Clipboard Toggle word wrap
列出数据存储的可用版本。

positional 参数

<datastore>
数据存储的 ID 或名称。

15.35. Trove datastore-version-show

usage: trove datastore-version-show <datastore_version> [--datastore <datastore>]
Copy to Clipboard Toggle word wrap
显示数据存储版本的详细信息。

positional 参数

<datastore_version>
数据存储版本的 ID 或名称。

可选参数

--datastore <datastore>
数据存储的 ID 或名称。如果提供了 datastore_version 的 ID,则可选。

15.36. Trove delete

usage: trove delete <instance>
Copy to Clipboard Toggle word wrap
删除实例。

positional 参数

<instance>
实例的 ID 或名称。

15.37. Trove detach-replica

usage: trove detach-replica <instance>
Copy to Clipboard Toggle word wrap
将副本实例从其复制源中分离。

positional 参数

<instance>
实例的 ID 或名称。

15.38. Trove eject-replica-source

usage: trove eject-replica-source <instance>
Copy to Clipboard Toggle word wrap
从其集合中弹出一个副本源。

positional 参数

<instance>
实例的 ID 或名称。

15.39. Trove flavor-list

usage: trove flavor-list [--datastore_type <datastore_type>] [--datastore_version_id <datastore_version_id>]
Copy to Clipboard Toggle word wrap
列出可用的类别。

可选参数

--datastore_type <datastore_type>
数据存储的类型。例如:mysql。
--datastore_version_id <datastore_version_id>
数据存储版本的 ID。

15.40. Trove flavor-show

usage: trove flavor-show <flavor>
Copy to Clipboard Toggle word wrap
显示类别的详细信息。

positional 参数

<flavor>
类别的 ID 或名称。

15.41. Trove limit-list

usage: trove limit-list
Copy to Clipboard Toggle word wrap
列出租户的限制。

15.42. Trove list

usage: trove list [--limit <limit>] [--marker <ID>] [--include-clustered]
Copy to Clipboard Toggle word wrap
列出所有实例。

可选参数

--limit <limit>
限制所显示的结果数量。
--marker <ID>
开始显示大于指定标记的 ID 的结果。与 --limit 一起使用时,将其设置为上一个运行中显示的最后一个 ID。
--include-clustered
包括属于集群一部分的实例(默认 false)。

15.43. Trove metadata-create

usage: trove metadata-create <instance_id> <key> <value>
Copy to Clipboard Toggle word wrap
在数据库中为 <id> 创建元数据。

positional 参数

<instance_id>
实例的 UUID。
<key>
分配的密钥。
<value>
要分配给 <key> 的值。

15.44. Trove metadata-delete

usage: trove metadata-delete <instance_id> <key>
Copy to Clipboard Toggle word wrap
删除实例 <id> 的元数据。

positional 参数

<instance_id>
实例的 UUID。
<key>
要删除的元数据密钥。

15.45. Trove metadata-edit

usage: trove metadata-edit <instance_id> <key> <value>
Copy to Clipboard Toggle word wrap
使用新值替换 metadata 值,这是非破坏性。

positional 参数

<instance_id>
实例的 UUID。
<key>
要替换的关键。
<value>
分配给 <key> 的新值。

15.46. Trove metadata-list

usage: trove metadata-list <instance_id>
Copy to Clipboard Toggle word wrap
显示实例 <id> 的所有元数据。

positional 参数

<instance_id>
实例的 UUID。

15.47. Trove metadata-show

usage: trove metadata-show <instance_id> <key>
Copy to Clipboard Toggle word wrap
显示键 <key> 和实例 <id> 的元数据条目。

positional 参数

<instance_id>
实例的 UUID。
<key>
要显示的密钥。

15.48. Trove metadata-update

usage: trove metadata-update <instance_id> <key> <newkey> <value>
Copy to Clipboard Toggle word wrap
更新元数据,这是破坏性。

positional 参数

<instance_id>
实例的 UUID。
<key>
要更新的密钥。
<newkey>
新密钥。
<value>
要分配给 <newkey> 的值。

15.49. Trove promote-to-replica-source

usage: trove promote-to-replica-source <instance>
Copy to Clipboard Toggle word wrap
将副本提升为集合的新副本源。

positional 参数

<instance>
实例的 ID 或名称。

15.50. Trove resize-instance

usage: trove resize-instance <instance> <flavor>
Copy to Clipboard Toggle word wrap
使用新类别重新定义实例大小。

positional 参数

<instance>
实例的 ID 或名称。
<flavor>
实例的新类别。

15.51. Trove resize-volume

usage: trove resize-volume <instance> <size>
Copy to Clipboard Toggle word wrap
调整实例的卷大小。

positional 参数

<instance>
实例的 ID 或名称。
<size>
实例磁盘卷的新大小(以 GB 为单位)。

15.52. Trove restart

usage: trove restart <instance>
Copy to Clipboard Toggle word wrap
重启实例。

positional 参数

<instance>
实例的 ID 或名称。

15.53. Trove root-enable

usage: trove root-enable <instance_or_cluster> [--root_password <root_password>]
Copy to Clipboard Toggle word wrap
为实例启用 root,并在已存在时重置。

positional 参数

<instance_or_cluster>
实例或集群的 ID 或名称。

可选参数

--root_password <root_password>
要设置的 root 密码。

15.54. Trove root-show

usage: trove root-show <instance_or_cluster>
Copy to Clipboard Toggle word wrap
如果实例或集群启用了 root,则获取状态。

positional 参数

<instance_or_cluster>
实例或集群的 ID 或名称。

15.55. Trove secgroup-add-rule

usage: trove secgroup-add-rule <security_group> <cidr>
Copy to Clipboard Toggle word wrap
创建安全组规则。

positional 参数

<security_group>
安全组 ID。
<cidr>
CIDR 地址。

15.56. Trove secgroup-delete-rule

usage: trove secgroup-delete-rule <security_group_rule>
Copy to Clipboard Toggle word wrap
删除安全组规则。

positional 参数

<security_group_rule>
安全组规则的名称。

15.57. Trove secgroup-list

usage: trove secgroup-list
Copy to Clipboard Toggle word wrap
列出所有安全组。

15.58. Trove secgroup-list-rules

usage: trove secgroup-list-rules <security_group>
Copy to Clipboard Toggle word wrap
列出安全组的所有规则。

positional 参数

<security_group>
安全组 ID。

15.59. Trove secgroup-show

usage: trove secgroup-show <security_group>
Copy to Clipboard Toggle word wrap
显示安全组的详细信息。

positional 参数

<security_group>
安全组 ID。

15.60. Trove 显示

usage: trove show <instance>
Copy to Clipboard Toggle word wrap
显示实例的详细信息。

positional 参数

<instance>
实例的 ID 或名称。

15.61. Trove 更新

usage: trove update <instance> [--name <name>] [--configuration <configuration>] [--detach-replica-source] [--remove_configuration]
Copy to Clipboard Toggle word wrap
更新实例:编辑名称、配置或副本源。

positional 参数

<instance>
实例的 ID 或名称。

可选参数

--name <name>
实例的名称。
--configuration <configuration>
要附加的配置引用的 ID。
--detach-replica-source
将副本实例从其复制源中分离。
--remove_configuration
丢弃当前的配置参考。

15.62. Trove user-create

usage: trove user-create <instance> <name> <password> [--host <host>] [--databases <databases> [<databases> ...]]
Copy to Clipboard Toggle word wrap
在实例上创建用户。

positional 参数

<instance>
实例的 ID 或名称。
<name>
用户名称。
<password>
用户的密码。

可选参数

--host <host>
用户的可选主机。
--databases <databases> [<databases> ...]
可选的数据库列表。

15.63. Trove user-delete

usage: trove user-delete [--host <host>] <instance> <name>
Copy to Clipboard Toggle word wrap
从实例删除用户。

positional 参数

<instance>
实例的 ID 或名称。
<name>
用户名称。

可选参数

--host <host>
用户的可选主机。

15.64. Trove user-grant-access

usage: trove user-grant-access <instance> <name> <databases> [<databases> ...] [--host <host>]
Copy to Clipboard Toggle word wrap
授予用户数据库的访问权限。

positional 参数

<instance>
实例的 ID 或名称。
<name>
用户名称。
<databases>
数据库列表。

可选参数

--host <host>
用户的可选主机。

15.65. Trove user-list

usage: trove user-list <instance>
Copy to Clipboard Toggle word wrap
列出实例的用户。

positional 参数

<instance>
实例的 ID 或名称。

15.66. Trove user-revoke-access

usage: trove user-revoke-access [--host <host>] <instance> <name> <database>
Copy to Clipboard Toggle word wrap
撤销用户对数据库的访问权限。

positional 参数

<instance>
实例的 ID 或名称。
<name>
用户名称。
<database>
单个数据库。

可选参数

--host <host>
用户的可选主机。

15.67. Trove user-show

usage: trove user-show [--host <host>] <instance> <name>
Copy to Clipboard Toggle word wrap
显示实例用户的详细信息。

positional 参数

<instance>
实例的 ID 或名称。
<name>
用户名称。

可选参数

--host <host>
用户的可选主机。

15.68. Trove user-show-access

usage: trove user-show-access [--host <host>] <instance> <name>
Copy to Clipboard Toggle word wrap
显示实例的用户访问详细信息。

positional 参数

<instance>
实例的 ID 或名称。
<name>
用户名称。

可选参数

--host <host>
用户的可选主机。

15.69. Trove user-update-attributes

usage: trove user-update-attributes <instance> <name> [--host <host>] [--new_name <new_name>] [--new_password <new_password>] [--new_host <new_host>]
Copy to Clipboard Toggle word wrap
更新实例上用户的属性。必须至少提供一个可选参数。

positional 参数

<instance>
实例的 ID 或名称。
<name>
用户名称。

可选参数

--host <host>
用户的可选主机。
--new_name <new_name>
可选的 user 名称。
--new_password <new_password>
用户的可选新密码。
--new_host <new_host>
用户的可选新主机。

第 16 章 数据库服务管理命令行客户端

trove-manage 客户端是数据库管理实用程序及其扩展命令行界面(CLI)。本章记录了 管理 版本 "oslo_config.cfg" 4.0.0
有关特定 trove-manage 命令的帮助信息,请输入:
$ trove-manage COMMAND --help
Copy to Clipboard Toggle word wrap

16.1. Trove-manage usage

usage: trove-manage [-h] [--config-dir DIR] [--config-file PATH] [--debug] [--log-config-append PATH] [--log-date-format DATE_FORMAT] [--log-dir LOG_DIR] [--log-file PATH] [--log-format FORMAT] [--nodebug] [--nouse-syslog] [--nouse-syslog-rfc-format] [--noverbose] [--syslog-log-facility SYSLOG_LOG_FACILITY] [--use-syslog] [--use-syslog-rfc-format] [--verbose] [--version] {db_sync,db_upgrade,db_downgrade,datastore_update,datastore_version_update,db_recreate,db_load_datastore_config_parameters,datastore_version_flavor_add,datastore_version_flavor_delete} ...
Copy to Clipboard Toggle word wrap

16.2. Trove-manage 可选参数

-h, --help
显示帮助信息并退出
--config-dir DIR
从中拉取.<conf 文件的 config 目录的路径。此文件集是排序的,因此如果单个选项过高,提供可预测的解析顺序。这个集合会在之前 --config-file 指定的文件后面解析,因此目录中的过量选项具有优先权。
--config-file PATH
要使用的配置文件的路径。可以指定多个配置文件,并将值放在后续文件中具有优先权。使用的默认文件为: None。
--debug, -d
打印调试输出(将日志级别设置为 DEBUG 而不是默认的 INFO 级别)。
--log-config-append PATH, --log_config PATH
日志配置文件的名称。此文件附加到任何现有日志记录配置文件中。有关日志记录配置文件的详情,请查看 Python 日志记录模块文档。
--log-date-format DATE_FORMAT
记录中 %(asctime) s 的格式字符串。默认:无。
--log-dir LOG_DIR, --logdir LOG_DIR
(可选)用于相对 --log- 文件路径的基础目录。
--log-file PATH, --logfile PATH
(可选)要输出的日志文件名称。如果没有设置默认值,日志记录将进入 stdout。
--log-format FORMAT
弃用。logging.Formatter 日志消息格式字符串,它可以使用任何可用的 logging.LogRecord 属性。这个选项已弃用。请使用 logging_context_format_string 和 logging_default_format_string。
--nodebug
--debug 的 inverse
--nouse-syslog
--use-syslog 的反转
--nouse-syslog-rfc-format
--use-syslog-rfc-format 的反转
--noverbose
--verbose 的 inverse
--syslog-log-facility SYSLOG_LOG_FACILITY
syslog 工具可接收日志行。
--use-syslog
使用 syslog 进行日志记录。现有 syslog 格式为 DEPRECATED,稍后将更改为遵循 RFC5424。
--use-syslog-rfc-format
(可选)启用或禁用 syslog rfc5424 格式进行日志记录。如果启用,使用 APP-NAME (RFC5424)为 syslog 消息的 MSG 部分添加前缀。没有 APP-NAME 的格式在 Kilo 中被弃用,并将在 Mitaka 中删除,以及这个选项。
--verbose, -v
如果设置为 false,将禁用 INFO 日志级别,使 WARNING 为默认值。
--version
显示程序的版本号并退出

16.3. Trove-manage datastore_update

usage: trove-manage datastore_update [-h] datastore_name default_version
Copy to Clipboard Toggle word wrap
添加或更新数据存储。如果数据存储已存在,则会更新默认版本。

positional 参数

datastore_name
数据存储的名称。
default_version
现有数据存储版本的名称或 ID,设置为默认值。添加新数据存储时,请使用空字符串。

可选参数

-h, --help
显示帮助信息并退出

16.4. trove-manage datastore_version_flavor_add

usage: trove-manage datastore_version_flavor_add [-h] datastore_name datastore_version_name flavor_ids
Copy to Clipboard Toggle word wrap
添加类别与给定数据存储和数据存储版本的关联。

positional 参数

datastore_name
数据存储的名称。
datastore_version_name
数据存储版本的名称。
flavor_ids
以逗号分隔的类别 ID 列表。

可选参数

-h, --help
显示帮助信息并退出

16.5. trove-manage datastore_version_flavor_delete

usage: trove-manage datastore_version_flavor_delete [-h] datastore_name datastore_version_name flavor_id
Copy to Clipboard Toggle word wrap
删除与给定数据存储和数据存储版本关联的类别。

positional 参数

datastore_name
数据存储的名称。
datastore_version_name
数据存储版本的名称。
flavor_id
为给定数据存储和数据存储版本删除的类别。

可选参数

-h, --help
显示帮助信息并退出

16.6. Trove-manage datastore_version_update

usage: trove-manage datastore_version_update [-h] datastore version_name manager image_id packages active
Copy to Clipboard Toggle word wrap
添加或更新数据存储版本。如果数据存储版本已存在,则除数据存储名称和版本之外的所有值都会被更新。

positional 参数

datastore
数据存储的名称。
version_name
数据存储版本的名称。
Manager
管理数据存储版本的管理器的名称。
image_id
用于创建数据存储版本实例的镜像的 ID。
软件包
在客户机镜像上安装的数据存储版本所需的软件包。
active
数据存储版本是否活跃。接受的值是 0 和 1。

可选参数

-h, --help
显示帮助信息并退出

16.7. trove-manage db_downgrade

usage: trove-manage db_downgrade [-h] [--repo_path REPO_PATH] version
Copy to Clipboard Toggle word wrap
将数据库降级到指定的版本。

positional 参数

version
目标版本。

可选参数

-h, --help
显示帮助信息并退出
--repo_path REPO_PATH
sqlalchemy Migrate repository path。

16.8. trove-manage db_load_datastore_config_parameters

usage: trove-manage db_load_datastore_config_parameters [-h] datastore datastore_version config_file_location
Copy to Clipboard Toggle word wrap
将数据存储版本的配置组参数验证规则加载到数据库中。

positional 参数

datastore
数据存储的名称。
datastore_version
数据存储版本的名称。
config_file_location
配置组参数验证规则的完全限定文件路径。

可选参数

-h, --help
显示帮助信息并退出

16.9. trove-manage db_recreate

usage: trove-manage db_recreate [-h] [--repo_path REPO_PATH]
Copy to Clipboard Toggle word wrap
丢弃数据库并重新创建它。

可选参数

-h, --help
显示帮助信息并退出
--repo_path REPO_PATH
sqlalchemy Migrate repository path。

16.10. trove-manage db_sync

usage: trove-manage db_sync [-h] [--repo_path REPO_PATH]
Copy to Clipboard Toggle word wrap
填充数据库结构

可选参数

-h, --help
显示帮助信息并退出
--repo_path REPO_PATH
sqlalchemy Migrate repository path。

16.11. Trove-manage db_upgrade

usage: trove-manage db_upgrade [-h] [--version VERSION] [--repo_path REPO_PATH]
Copy to Clipboard Toggle word wrap
将数据库升级到指定的版本。

可选参数

-h, --help
显示帮助信息并退出
--version VERSION
目标版本。默认为最新版本。
--repo_path REPO_PATH
sqlalchemy Migrate repository path。

第 17 章 裸机恢复服务命令行客户端

ironic 客户端是 Bare Metal 服务 API 及其扩展命令行界面(CLI)。本章记录了 ironic 版本 0.8.1
有关特定 ironic 命令的帮助信息,请输入:
$ ironic help COMMAND
Copy to Clipboard Toggle word wrap

17.1. Ironic 用法

usage: ironic [--insecure] [--os-cacert <ca-certificate>] [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>] [--os-user-domain-id OS_USER_DOMAIN_ID] [--os-user-domain-name OS_USER_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID] [--os-project-name OS_PROJECT_NAME] [--os-project-domain-id OS_PROJECT_DOMAIN_ID] [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] [--version] [--debug] [-v] [--cert-file OS_CERT] [--key-file OS_KEY] [--ca-file OS_CACERT] [--os-username OS_USERNAME] [--os-password OS_PASSWORD] [--os-tenant-id OS_TENANT_ID] [--os-tenant-name OS_TENANT_NAME] [--os-auth-url OS_AUTH_URL] [--os-region-name OS_REGION_NAME] [--os-auth-token OS_AUTH_TOKEN] [--ironic-url IRONIC_URL] [--ironic-api-version IRONIC_API_VERSION] [--os-service-type OS_SERVICE_TYPE] [--os-endpoint OS_ENDPOINT] [--os-endpoint-type OS_ENDPOINT_TYPE] [--max-retries MAX_RETRIES] [--retry-interval RETRY_INTERVAL] <subcommand> ...
Copy to Clipboard Toggle word wrap

子命令

chassis-create
创建新的机箱。
chassis-delete
删除机箱。
chassis-list
列出机箱。
chassis-node-list
列出机箱中包含的节点。
chassis-show
显示有关机箱的详细信息。
chassis-update
更新有关机箱的信息。
node-create
使用 Ironic 服务注册新节点。
node-delete
从 Ironic 服务取消节点注册。
node-get-boot-device
获取节点的当前引导设备。
node-get-console
如果启用,获取节点控制台的连接信息。
node-get-supported-boot-devices
获取节点支持的引导设备。
node-list
列出使用 Ironic 服务注册的节点。
node-port-list
列出与节点关联的端口。
node-set-boot-device
为节点设置引导设备。
node-set-console-mode
为节点启用或禁用串行控制台访问。
node-set-maintenance
为节点启用或禁用维护模式。
node-set-power-state
打开或关闭节点或重新引导。
node-set-provision-state
置备、重建、删除、检查、提供或管理实例。
node-show
显示节点的详细信息。
node-show-states
显示有关节点状态的信息。
node-update
更新有关注册节点的信息。
node-validate
验证节点的驱动程序接口。
node-vendor-passthru
为节点调用 vendor-passthru 扩展。
port-create
创建新端口。
port-delete
删除端口。
port-list
列出端口。
port-show
显示端口的详细信息。
port-update
更新有关端口的信息。
driver-list
列出已启用的驱动程序。
driver-properties
获取驱动程序的属性。
driver-show
显示驱动程序的相关信息。
driver-vendor-passthru
为驱动程序打电话 vendor-passthru 扩展。
bash-completion
打印 bash 补全的所有命令和选项。
帮助
显示有关该程序或其其中一个子命令的帮助。

17.2. ironic 可选参数

--insecure
明确允许客户端执行"不安全"TLS (https)请求。服务器的证书不会针对任何证书颁发机构进行验证。这个选项应谨慎使用。
--os-cacert <ca-certificate>
指定用于验证 TLS (https)服务器证书中使用的 CA 捆绑包文件。默认为 env[OS_CACERT]
--os-cert <certificate>
默认为 env[OS_CERT]
--os-key <key>
默认为 env[OS_KEY]
--timeout <seconds>
设置请求超时(以秒为单位)。
--os-user-domain-id OS_USER_DOMAIN_ID
默认为 env[OS_USER_DOMAIN_ID]
--os-user-domain-name OS_USER_DOMAIN_NAME
默认为 env[OS_USER_DOMAIN_NAME]
--os-project-id OS_PROJECT_ID
指定租户 ID 的另一种方式。这个选项与 --os-tenant-id 相互排斥。默认为 env[OS_PROJECT_ID]
--os-project-name OS_PROJECT_NAME
指定租户名称的另一种方法。这个选项与 --os-tenant-name 相互排斥。默认为 env[OS_PROJECT_NAME]
--os-project-domain-id OS_PROJECT_DOMAIN_ID
默认为 env[OS_PROJECT_DOMAIN_ID]
--os-project-domain-name OS_PROJECT_DOMAIN_NAME
默认为 env[OS_PROJECT_DOMAIN_NAME]
--version
显示程序的版本号并退出
--debug
默认为 env[IRONICCLIENT_DEBUG]
-v, --verbose
打印更详细的输出
--cert-file OS_CERT
弃用!使用 --os-cert。
--key-file OS_KEY
弃用!使用 --os-key。
--ca-file OS_CACERT
弃用!使用 --os-cacert。
--os-username OS_USERNAME
默认为 env[OS_USERNAME]
--os-password OS_PASSWORD
默认为 env[OS_PASSWORD]
--os-tenant-id OS_TENANT_ID
默认为 env[OS_TENANT_ID]
--os-tenant-name OS_TENANT_NAME
默认为 env[OS_TENANT_NAME]
--os-auth-url OS_AUTH_URL
默认为 env[OS_AUTH_URL]
--os-region-name OS_REGION_NAME
默认为 env[OS_REGION_NAME]
--os-auth-token OS_AUTH_TOKEN
默认为 env[OS_AUTH_TOKEN]
--ironic-url IRONIC_URL
默认为 env[IRONIC_URL]
--ironic-api-version IRONIC_API_VERSION
接受 1.x (其中 "x" 是微版本)或 "latest",默认为 env[IRONIC_API_VERSION] 或 1
--os-service-type OS_SERVICE_TYPE
默认为 env[OS_SERVICE_TYPE] 或 "baremetal"
--os-endpoint OS_ENDPOINT
指定要使用的端点,而不是从服务目录检索端点(通过身份验证)。默认为 env[OS_SERVICE_ENDPOINT]
--os-endpoint-type OS_ENDPOINT_TYPE
默认为 env[OS_ENDPOINT_TYPE] 或 "publicURL"
--max-retries MAX_RETRIES
冲突错误时的最大重试次数(HTTP 409)。默认为 env[IRONIC_MAX_RETRIES] 或 5。使用 0 禁用重试。
--retry-interval RETRY_INTERVAL
冲突错误时重试间隔时间(以秒为单位)(HTTP 409)。默认为 env[IRONIC_RETRY_INTERVAL] 或 2。

17.3. ironic chassis-create

usage: ironic chassis-create [-d <description>] [-e <key=value>]
Copy to Clipboard Toggle word wrap
创建新的机箱。

可选参数

-d <description>, --description <description>
机箱的描述。
-e <key=value>, --extra <key=value>
记录任意键/值元数据。可多次指定。

17.4. ironic chassis-delete

usage: ironic chassis-delete <chassis> [<chassis> ...]
Copy to Clipboard Toggle word wrap
删除机箱。

positional 参数

<chassis>
机箱的 UUID。

17.5. Ironic chassis-list

usage: ironic chassis-list [--detail] [--limit <limit>] [--marker <chassis>] [--sort-key <field>] [--sort-dir <direction>] [--fields <field> [<field> ...]]
Copy to Clipboard Toggle word wrap
列出机箱。

可选参数

--detail
显示有关机箱的详细信息。
--limit <limit>
每个请求返回的最大机箱数,0 代表没有限制。default 是 Ironic API 服务使用的最大数量。
--marker <chassis>
机箱 UUID (例如,上一个请求列表中最后一个机箱)。在此 UUID 后返回机箱列表。
--sort-key <field>
用于排序的 chassis 字段。
--sort-dir <direction>
排序方向:"asc" (默认)或"desc"。
--fields <field> [<field> ...]
一个或多个机箱字段。只有这些字段才会从服务器获取。当指定 '-- detail' 时,无法使用。

17.6. ironic chassis-node-list

usage: ironic chassis-node-list [--detail] [--limit <limit>] [--marker <node>] [--sort-key <field>] [--sort-dir <direction>] [--fields <field> [<field> ...]] <chassis>
Copy to Clipboard Toggle word wrap
列出机箱中包含的节点。

positional 参数

<chassis>
机箱的 UUID。

可选参数

--detail
显示节点的详细信息。
--limit <limit>
每个请求返回的最大节点数,0 代表没有限制。default 是 Ironic API 服务使用的最大数量。
--marker <node>
节点 UUID (例如,上一个请求列表中的最后一个节点)。在此 UUID 后返回节点列表。
--sort-key <field>
用于排序的节点字段。
--sort-dir <direction>
排序方向:"asc" (默认)或"desc"。
--fields <field> [<field> ...]
一个或多个节点字段。只有这些字段才会从服务器获取。当指定 '-- detail' 时,无法使用。

17.7. Ironic chassis-show

usage: ironic chassis-show [--fields <field> [<field> ...]] <chassis>
Copy to Clipboard Toggle word wrap
显示有关机箱的详细信息。

positional 参数

<chassis>
机箱的 UUID。

可选参数

--fields <field> [<field> ...]
一个或多个机箱字段。只有这些字段才会从服务器获取。

17.8. ironic chassis-update

usage: ironic chassis-update <chassis> <op> <path=value> [<path=value> ...]
Copy to Clipboard Toggle word wrap
更新有关机箱的信息。

positional 参数

<chassis>
机箱的 UUID。
<op>
操作:'add'、'replace' 或 'remove'。
<path=value>
要添加、替换或删除的属性。可多次指定。对于 'remove',只需要 <path>。

17.9. ironic driver-list

usage: ironic driver-list
Copy to Clipboard Toggle word wrap
列出已启用的驱动程序。

17.10. ironic driver-properties

usage: ironic driver-properties <driver>
Copy to Clipboard Toggle word wrap
获取驱动程序的属性。

positional 参数

<driver>
驱动程序的名称。

17.11. ironic driver-show

usage: ironic driver-show <driver>
Copy to Clipboard Toggle word wrap
显示驱动程序的相关信息。

positional 参数

<driver>
驱动程序的名称。

17.12. ironic driver-vendor-passthru

usage: ironic driver-vendor-passthru [--http-method <http-method>] <driver> <method> [<arg=value> [<arg=value> ...]]
Copy to Clipboard Toggle word wrap
为驱动程序打电话 vendor-passthru 扩展。

positional 参数

<driver>
驱动程序的名称。
<method>
要调用的 vendor-passthru 方法。
<arg=value>
传递给 vendor-passthru 方法的参数。可多次指定。

可选参数

--http-method <http-method>
请求中使用的 HTTP 方法。有效的 HTTP 方法有: 'POST'、'PUT'、'GET'、'DELETE' 和 'PATCH'。默认为 'POST'。

17.13. ironic node-create

usage: ironic node-create [-c <chassis>] -d <driver> [-i <key=value>] [-p <key=value>] [-e <key=value>] [-u <uuid>] [-n <name>]
Copy to Clipboard Toggle word wrap
使用 Ironic 服务注册新节点。

可选参数

-c <chassis>, --chassis <chassis>
此节点所属的机箱的 UUID。
-d <driver>, --driver <driver>
用于控制节点的驱动程序 [REQUIRED]。
-i <key=value>, --driver-info <key=value>
驱动程序使用的键/值对,如带外管理凭证。可多次指定。
-p <key=value>, --properties <key=value>
键/值对描述节点的物理特性。这会导出到 Nova,并由调度程序使用。可多次指定。
-e <key=value>, --extra <key=value>
记录任意键/值元数据。可多次指定。
-u <uuid>, --uuid <uuid>
节点的唯一 UUID。
-n <name>, --name <name>
节点的唯一名称。

17.14. Ironic node-delete

usage: ironic node-delete <node> [<node> ...]
Copy to Clipboard Toggle word wrap
从 Ironic 服务取消节点注册。

positional 参数

<node>
节点的名称或 UUID。

17.15. ironic node-get-boot-device

usage: ironic node-get-boot-device <node>
Copy to Clipboard Toggle word wrap
获取节点的当前引导设备。

positional 参数

<node>
节点的名称或 UUID。

17.16. ironic node-get-console

usage: ironic node-get-console <node>
Copy to Clipboard Toggle word wrap
如果启用,获取节点控制台的连接信息。

positional 参数

<node>
节点的名称或 UUID。

17.17. ironic node-get-supported-boot-devices

usage: ironic node-get-supported-boot-devices <node>
Copy to Clipboard Toggle word wrap
获取节点支持的引导设备。

positional 参数

<node>
节点的名称或 UUID。

17.18. Ironic node-list

usage: ironic node-list [--limit <limit>] [--marker <node>] [--sort-key <field>] [--sort-dir <direction>] [--maintenance <boolean>] [--associated <boolean>] [--provision-state <provision-state>] [--detail] [--fields <field> [<field> ...]]
Copy to Clipboard Toggle word wrap
列出使用 Ironic 服务注册的节点。

可选参数

--limit <limit>
每个请求返回的最大节点数,0 代表没有限制。default 是 Ironic API 服务使用的最大数量。
--marker <node>
节点 UUID (例如,上一个请求列表中的最后一个节点)。在此 UUID 后返回节点列表。
--sort-key <field>
用于排序的节点字段。
--sort-dir <direction>
排序方向:"asc" (默认)或"desc"。
--maintenance <boolean>
以维护模式列出节点:'true' 或 'false'。
--associated <boolean>
按实例关联列出节点: 'true' 或 'false'。
--provision-state <provision-state>
列出处于指定置备状态的节点。
--detail
显示节点的详细信息。
--fields <field> [<field> ...]
一个或多个节点字段。只有这些字段才会从服务器获取。当指定 '-- detail' 时,无法使用。

17.19. ironic node-port-list

usage: ironic node-port-list [--detail] [--limit <limit>] [--marker <port>] [--sort-key <field>] [--sort-dir <direction>] [--fields <field> [<field> ...]] <node>
Copy to Clipboard Toggle word wrap
列出与节点关联的端口。

positional 参数

<node>
节点的 UUID。

可选参数

--detail
显示有关端口的详细信息。
--limit <limit>
每个请求返回的最大端口数,0 代表没有限制。default 是 Ironic API 服务使用的最大数量。
--marker <port>
端口 UUID (例如,上一个请求列表中的最后一个端口)。返回此 UUID 后端口列表。
--sort-key <field>
用于排序的端口字段。
--sort-dir <direction>
排序方向:"asc" (默认)或"desc"。
--fields <field> [<field> ...]
一个或多个端口字段。只有这些字段才会从服务器获取。当指定 '-- detail' 时,无法使用。

17.20. ironic node-set-boot-device

usage: ironic node-set-boot-device [--persistent] <node> <boot-device>
Copy to Clipboard Toggle word wrap
为节点设置引导设备。

positional 参数

<node>
节点的名称或 UUID。
<boot-device>
'pxe', 'disk', 'cdrom', 'bios', 或 'safe'。

可选参数

--persistent
使更改在将来的所有启动都会保留。

17.21. ironic node-set-console-mode

usage: ironic node-set-console-mode <node> <enabled>
Copy to Clipboard Toggle word wrap
为节点启用或禁用串行控制台访问。

positional 参数

<node>
节点的名称或 UUID。
<enabled>
为节点启用或禁用控制台访问:'true' 或 'false'。

17.22. ironic node-set-maintenance

usage: ironic node-set-maintenance [--reason <reason>] <node> <maintenance-mode>
Copy to Clipboard Toggle word wrap
为节点启用或禁用维护模式。

positional 参数

<node>
节点的名称或 UUID。
<maintenance-mode>
'true' 或 'false'; 'on' 或 'off'。

可选参数

--reason <reason>
将维护模式设置为 'true' 或 'on' 的原因; 当设置为 'false' 或 'off' 时无效。

17.23. ironic node-set-power-state

usage: ironic node-set-power-state <node> <power-state>
Copy to Clipboard Toggle word wrap
打开或关闭节点或重新引导。

positional 参数

<node>
节点的名称或 UUID。
<power-state>
'on', 'off', 或 'reboot'。

17.24. ironic node-set-provision-state

usage: ironic node-set-provision-state [--config-drive <config-drive>] <node> <provision-state>
Copy to Clipboard Toggle word wrap
置备、重建、删除、检查、提供或管理实例。

positional 参数

<node>
节点的名称或 UUID。
<provision-state>
支持状态: 'active', 'deleted', 'rebuild', 'inspect', 'provide' 或 'manage'

可选参数

--config-drive <config-drive>
gzipped, base64 编码的配置驱动器驱动器字符串,或配置驱动器文件的路径或包含配置驱动器文件的目录的路径。如果是目录,则会从其中生成配置驱动器。这个参数仅在将 provision 状态设置为 'active' 时才有效。

17.25. ironic node-show

usage: ironic node-show [--instance] [--fields <field> [<field> ...]] <id>
Copy to Clipboard Toggle word wrap
显示节点的详细信息。

positional 参数

<id>
节点的名称或 UUID (如果指定了 --instance,则为实例 UUID)。

可选参数

--instance <id>
是实例 UUID。
--fields <field> [<field> ...]
一个或多个节点字段。只有这些字段才会从服务器获取。

17.26. ironic node-show-states

usage: ironic node-show-states <node>
Copy to Clipboard Toggle word wrap
显示有关节点状态的信息。

positional 参数

<node>
节点的名称或 UUID。

17.27. ironic node-update

usage: ironic node-update <node> <op> <path=value> [<path=value> ...]
Copy to Clipboard Toggle word wrap
更新有关注册节点的信息。

positional 参数

<node>
节点的名称或 UUID。
<op>
操作:'add'、'replace' 或 'remove'。
<path=value>
要添加、替换或删除的属性。可多次指定。对于 'remove',只需要 <path>。

17.28. ironic node-validate

usage: ironic node-validate <node>
Copy to Clipboard Toggle word wrap
验证节点的驱动程序接口。

positional 参数

<node>
节点的名称或 UUID。

17.29. ironic node-vendor-passthru

usage: ironic node-vendor-passthru [--http-method <http-method>] <node> <method> [<arg=value> [<arg=value> ...]]
Copy to Clipboard Toggle word wrap
为节点调用 vendor-passthru 扩展。

positional 参数

<node>
节点的名称或 UUID。
<method>
要调用的 vendor-passthru 方法。
<arg=value>
传递给 vendor-passthru 方法的参数。可以指定 mutiple。

可选参数

--http-method <http-method>
请求中使用的 HTTP 方法。有效的 HTTP 方法有: 'POST'、'PUT'、'GET'、'DELETE' 和 'PATCH'。默认为 'POST'。

17.30. ironic port-create

usage: ironic port-create -a <address> -n <node> [-e <key=value>]
Copy to Clipboard Toggle word wrap
创建新端口。

可选参数

-a <address>, --address <address>
此端口的 MAC 地址。
-n <node>, --node <node>, --node_uuid <node>
此端口所属节点的 UUID。
-e <key=value>, --extra <key=value>
记录任意键/值元数据。可多次指定。

17.31. ironic port-delete

usage: ironic port-delete <port> [<port> ...]
Copy to Clipboard Toggle word wrap
删除端口。

positional 参数

<port>
端口的 UUID。

17.32. ironic port-list

usage: ironic port-list [--detail] [--address <mac-address>] [--limit <limit>] [--marker <port>] [--sort-key <field>] [--sort-dir <direction>] [--fields <field> [<field> ...]]
Copy to Clipboard Toggle word wrap
列出端口。

可选参数

--detail
显示有关端口的详细信息。
--address <mac-address>
仅显示具有此 MAC 地址的端口的信息。
--limit <limit>
每个请求返回的最大端口数,0 代表没有限制。default 是 Ironic API 服务使用的最大数量。
--marker <port>
端口 UUID (例如,上一个请求列表中的最后一个端口)。返回此 UUID 后端口列表。
--sort-key <field>
用于排序的端口字段。
--sort-dir <direction>
排序方向:"asc" (默认)或"desc"。
--fields <field> [<field> ...]
一个或多个端口字段。只有这些字段才会从服务器获取。当指定 '-- detail' 时,无法使用。

17.33. ironic port-show

usage: ironic port-show [--address] [--fields <field> [<field> ...]] <id>
Copy to Clipboard Toggle word wrap
显示端口的详细信息。

positional 参数

<id>
端口的 UUID (或者指定 --address )。

可选参数

--address <id>
是端口的 MAC 地址(而不是 UUID)。
--fields <field> [<field> ...]
一个或多个端口字段。只有这些字段才会从服务器获取。

17.34. ironic port-update

usage: ironic port-update <port> <op> <path=value> [<path=value> ...]
Copy to Clipboard Toggle word wrap
更新有关端口的信息。

positional 参数

<port>
端口的 UUID。
<op>
操作:'add'、'replace' 或 'remove'。
<path=value>
要添加、替换或删除的属性。可多次指定。对于 'remove',只需要 <path>。

第 18 章 共享文件系统命令行客户端

manila 客户端是共享文件系统服务 API 及其扩展的命令行界面(CLI)。本章记录了 manila 版本 1.4.0
有关特定 manila 命令的帮助信息,请输入:
$ manila help COMMAND
Copy to Clipboard Toggle word wrap

18.1. Manila 用法

usage: manila [--version] [-d] [--os-cache] [--os-reset-cache] [--os-username <auth-user-name>] [--os-password <auth-password>] [--os-tenant-name <auth-tenant-name>] [--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>] [--os-region-name <region-name>] [--service-type <service-type>] [--service-name <service-name>] [--share-service-name <share-service-name>] [--endpoint-type <endpoint-type>] [--os-share-api-version <share-api-ver>] [--os-cacert <ca-certificate>] [--retries <retries>] <subcommand> ...
Copy to Clipboard Toggle word wrap

子命令

absolute-limits
显示用户的绝对限制列表。
access-allow
允许访问共享。
access-deny
拒绝对共享的访问。
access-list
显示共享的访问权限列表。
api-version
显示 API 版本信息。
cg-create
创建新的一致性组。
cg-delete
删除一个或多个一致性组。
cg-list
使用过滤器列出一致性组。
cg-reset-state
显式更新一致性组的状态。
cg-show
显示一致性组的详细信息。
cg-snapshot-create
创建新的一致性组。
cg-snapshot-delete
删除一个或多个一致性组快照。
cg-snapshot-list
使用过滤器列出一致性组快照。
cg-snapshot-members
获取一致性组快照的成员详情。
cg-snapshot-reset-state
显式更新一致性组的状态。
cg-snapshot-show
显示一致性组快照的详细信息。
cg-snapshot-update
更新一致性组快照。
cg-update
更新一致性组。
create
创建新共享(NFS、CIFS、GlusterFS 或 HDFS)。
credentials
显示从 auth 返回的用户凭证。
delete
删除一个或多个共享。
端点
发现从验证服务返回的端点。
扩展
增加现有共享的大小。
extra-specs-list
打印当前"共享类型和额外规格"列表(仅限管理员)。
force-delete
尝试强制删除共享,无论状态如何。
list
通过过滤器列出 NAS 共享。
管理
管理不是由 Manila 处理的共享。
metadata
设置或删除共享上的元数据。
metadata-show
显示给定共享的元数据。
metadata-update-all
更新共享的所有元数据。
migrate
将共享迁移到新主机。
pool-list
列出调度程序(仅限管理员)已知的所有后端存储池。
quota-class-show
列出配额类的配额。
quota-class-update
更新配额类的配额。
quota-defaults
列出租户的默认配额。
quota-delete
删除租户/用户的配额。配额将恢复为默认值。
quota-show
列出租户/用户的配额。
quota-update
更新租户/用户的配额。
rate-limits
显示用户的速率限值列表。
reset-state
显式更新共享状态。
security-service-create
创建租户使用的安全服务。
security-service-delete
删除安全服务。
security-service-list
获取安全服务列表。
security-service-show
显示安全服务。
security-service-update
更新安全服务。
service-list
列出所有服务。
share-instance-force-delete
尝试强制删除共享实例,而不考虑状态。
share-instance-list
列出共享实例。
share-instance-reset-state
显式更新共享实例的状态。
share-instance-show
显示共享实例的详细信息。
share-network-create
为租户使用的网络创建描述。
share-network-delete
删除共享网络。
share-network-list
获取网络信息列表。
share-network-security-service-add
将安全服务与共享网络关联。
share-network-security-service-list
获取与给定共享网络关联的安全服务列表。
share-network-security-service-remove
与共享网络解除关联安全服务.
share-network-show
获取租户使用的网络的描述。
share-network-update
更新共享网络数据。
share-server-delete
删除共享服务器。
share-server-details
显示共享服务器详细信息.
share-server-list
列出所有共享服务器。
share-server-show
显示共享服务器信息。
显示
显示 NAS 共享的详细信息。
缩小
减少现有共享的大小。
snapshot-create
添加新快照。
snapshot-delete
删除快照。
snapshot-force-delete
无论状态如何,尝试强制删除快照。
snapshot-list
列出所有快照。
snapshot-rename
重命名快照。
snapshot-reset-state
显式更新快照状态。
snapshot-show
显示快照的详细信息。
type-access-add
为给定项目添加共享类型访问权限。
type-access-list
打印有关给定共享类型的访问权限信息。
type-access-remove
删除给定项目的共享类型访问权限。
type-create
创建新共享类型。
type-delete
删除特定的共享类型。
type-key
为共享类型设置或取消设置 extra_spec。
type-list
打印可用"共享类型"列表。
unmanage
未管理共享.
update
重命名共享。
bash-completion
输出 bash_completion 的参数。将所有命令和选项输出到 stdout,以便 manila.bash_completion 脚本不必硬编码它们。
帮助
显示有关该程序或其其中一个子命令的帮助。
list-extensions
列出所有可用的 os-api 扩展。

18.2. Manila 可选参数

--version
显示程序的版本号并退出
-d, --debug
打印调试输出。
--os-cache
使用身份验证令牌缓存。默认为 env[OS_CACHE]
--os-reset-cache
删除缓存的密码和身份验证令牌。
--os-username <auth-user-name>
默认为 env[OS_USERNAME]
--os-password <auth-password>
默认为 env[OS_PASSWORD]
--os-tenant-name <auth-tenant-name>
默认为 env[OS_TENANT_NAME]
--os-tenant-id <auth-tenant-id>
默认为 env[OS_TENANT_ID]
--os-auth-url <auth-url>
默认为 env[OS_AUTH_URL]
--os-region-name <region-name>
默认为 env[OS_REGION_NAME]
--service-type <service-type>
对于大多数操作,默认为 compute。
--service-name <service-name>
默认为 env[MANILA_SERVICE_NAME]
--share-service-name <share-service-name>
默认为 env[MANILA_share_service_name]
--endpoint-type <endpoint-type>
默认为 env[MANILA_ENDPOINT_TYPE] 或 publicURL。
--os-share-api-version <share-api-ver>
接受 1.x 覆盖默认为 env[OS_SHARE_API_VERSION]
--os-cacert <ca-certificate>
指定用于验证 TLS (https)服务器证书中使用的 CA 捆绑包文件。默认为 env[OS_CACERT]
--retries <retries>
重试次数。

18.3. Manila 绝对限制

usage: manila absolute-limits
Copy to Clipboard Toggle word wrap
显示用户的绝对限制列表。

18.4. Manila access-allow

usage: manila access-allow [--access-level <access_level>] <share> <access_type> <access_to>
Copy to Clipboard Toggle word wrap
允许访问共享。

positional 参数

<share>
要修改的 NAS 共享的名称或 ID。
<access_type>
访问规则类型(仅"ip"、"user" (用户或组)和"cert"被支持。
<access_to>
定义访问权限的值。

可选参数

--access-level <access_level>, --access_level <access_level>
支持共享访问级别("rw"和"ro"访问级别)。默认值为 None。

18.5. Manila access-deny

usage: manila access-deny <share> <id>
Copy to Clipboard Toggle word wrap
拒绝对共享的访问。

positional 参数

<share>
要修改的 NAS 共享的名称或 ID。
<id>
要删除的访问规则的 ID。

18.6. Manila access-list

usage: manila access-list <share>
Copy to Clipboard Toggle word wrap
显示共享的访问权限列表。

positional 参数

<share>
共享的名称或 ID。

18.7. manila api-version

usage: manila api-version
Copy to Clipboard Toggle word wrap
显示 API 版本信息。

18.8. manila cg-create

usage: manila cg-create [--name <name>] [--description <description>] [--share-types <share_types>] [--share-network <share_network>] [--source-cgsnapshot-id <source_cgsnapshot_id>]
Copy to Clipboard Toggle word wrap
创建新的一致性组。

可选参数

--name <name>
可选一致性组名称。(default=None)
--description <description>
可选一致性组描述。(default=None)
--share-types <share_types>, --share_types <share_types>
可选的共享类型列表。(default=None)
--share-network <share_network>, --share_network <share_network>
指定 share-network name 或 id。
--source-cgsnapshot-id <source_cgsnapshot_id>, --source_cgsnapshot_id <source_cgsnapshot_id>
从中创建共享的可选快照 ID。(default=None)

18.9. manila cg-delete

usage: manila cg-delete [--force] <consistency_group> [<consistency_group> ...]
Copy to Clipboard Toggle word wrap
删除一个或多个一致性组。

positional 参数

<consistency_group>
一致性组的名称或 ID。

可选参数

--force
尝试强制删除一致性组(Default=False)。

18.10. manila cg-list

usage: manila cg-list [--all-tenants [<0|1>]] [--limit <limit>] [--offset <offset>]
Copy to Clipboard Toggle word wrap
使用过滤器列出一致性组。

可选参数

--all-tenants [<0|1>]
显示所有租户的信息(仅限管理员)。
--limit <limit>
要返回的最大一致性组数量。(default=None)
--offset <offset>
一致性组列表开始位置。

18.11. manila cg-reset-state

usage: manila cg-reset-state [--state <state>] <consistency_group>
Copy to Clipboard Toggle word wrap
显式更新一致性组的状态。

positional 参数

<consistency_group>
要修改的一致性组状态的名称或 ID。

可选参数

--state <state>
指明要分配一致性组的状态。选项包括 available、error、create、delete、error_deleting。如果未提供任何状态,则将使用 available。

18.12. manila cg-show

usage: manila cg-show <consistency_group>
Copy to Clipboard Toggle word wrap
显示一致性组的详细信息。

positional 参数

<consistency_group>
一致性组的名称或 ID。

18.13. manila cg-snapshot-create

usage: manila cg-snapshot-create [--name <name>] [--description <description>] <consistency_group>
Copy to Clipboard Toggle word wrap
创建新的一致性组。

positional 参数

<consistency_group>
一致性组的名称或 ID。

可选参数

--name <name>
可选一致性组快照名称。(default=None)
--description <description>
可选一致性组快照描述。(default=None)

18.14. manila cg-snapshot-delete

usage: manila cg-snapshot-delete [--force] <cg_snapshot> [<cg_snapshot> ...]
Copy to Clipboard Toggle word wrap
删除一个或多个一致性组快照。

positional 参数

<cg_snapshot>
一致性组快照的名称或 ID。

可选参数

--force
尝试强制删除 cg 快照(Default=False)。

18.15. manila cg-snapshot-list

usage: manila cg-snapshot-list [--all-tenants [<0|1>]] [--limit <limit>] [--offset <offset>] [--detailed DETAILED]
Copy to Clipboard Toggle word wrap
使用过滤器列出一致性组快照。

可选参数

--all-tenants [<0|1>]
显示所有租户的信息(仅限管理员)。
--limit <limit>
要返回的最大一致性组快照数量。(Default=None)
--offset <offset>
一致性组快照列表的开始位置。
--detailed DETAILED
显示有关快照的详细信息。

18.16. manila cg-snapshot-members

usage: manila cg-snapshot-members [--limit <limit>] [--offset <offset>] <cg_snapshot>
Copy to Clipboard Toggle word wrap
获取一致性组快照的成员详情。

positional 参数

<cg_snapshot>
一致性组快照的名称或 ID。

可选参数

--limit <limit>
要返回的最大共享数。(default=None)
--offset <offset>
安全服务列表开始位置。

18.17. manila cg-snapshot-reset-state

usage: manila cg-snapshot-reset-state [--state <state>] <cg_snapshot>
Copy to Clipboard Toggle word wrap
显式更新一致性组的状态。

positional 参数

<cg_snapshot>
一致性组快照的名称或 ID。

可选参数

--state <state>
指明要分配一致性组的状态。选项包括 available、error、create、delete、error_deleting。如果未提供任何状态,则将使用 available。

18.18. manila cg-snapshot-show

usage: manila cg-snapshot-show <cg_snapshot>
Copy to Clipboard Toggle word wrap
显示一致性组快照的详细信息。

positional 参数

<cg_snapshot>
一致性组快照的名称或 ID。

18.19. manila cg-snapshot-update

usage: manila cg-snapshot-update [--name <name>] [--description <description>] <cg_snapshot>
Copy to Clipboard Toggle word wrap
更新一致性组快照。

positional 参数

<cg_snapshot>
要更新的 cg 快照的名称或 ID。

可选参数

--name <name>
cg 快照的可选新名称。(default=None
--description <description>
可选的 cg 快照描述。(default=None)

18.20. manila cg-update

usage: manila cg-update [--name <name>] [--description <description>] <consistency_group>
Copy to Clipboard Toggle word wrap
更新一致性组。

positional 参数

<consistency_group>
要更新的一致性组的名称或 ID。

可选参数

--name <name>
一致性组的可选新名称。(default=None)
--description <description>
可选一致性组描述。(default=None)

18.21. Manila create

usage: manila create [--snapshot-id <snapshot-id>] [--name <name>] [--metadata [<key=value> [<key=value> ...]]] [--share-network <network-info>] [--description <description>] [--share-type <share-type>] [--public] [--availability-zone <availability-zone>] [--consistency-group <consistency-group>] <share_protocol> <size>
Copy to Clipboard Toggle word wrap
创建新共享(NFS、CIFS、GlusterFS 或 HDFS)。

positional 参数

<share_protocol>
共享类型(NFS、CIFS、GlusterFS 或 HDFS)。
<size>
以 GB 为单位的共享大小。

可选参数

--snapshot-id <snapshot-id>
从中创建共享的可选快照 ID。(default=None)
--name <name>
可选共享名称。(default=None)
--metadata [<key=value> [<key=value> ...]]
metadata key=value 对(可选,Default=None)。
--share-network <network-info>
可选的网络信息 ID 或名称。
--description <description>
可选共享描述。(default=None)
--share-type <share-type>, --share_type <share-type>, --volume-type <share-type>, --volume_type <share-type>
可选共享类型。使用可选卷类型已弃用(Default=None)
--public
共享可见性级别。定义其他租户是否可以查看它。
--availability-zone <availability-zone>, --availability_zone <availability-zone>, --az <availability-zone>
应该在其中创建共享的可用区。
--consistency-group <consistency-group>, --consistency_group <consistency-group>, --cg <consistency-group>
可选一致性组名称或 ID,在其中创建共享。(default=None)

18.22. Manila 凭证

usage: manila credentials
Copy to Clipboard Toggle word wrap
显示从 auth 返回的用户凭证。

18.23. Manila delete

usage: manila delete [--consistency-group <consistency-group>] <share> [<share> ...]
Copy to Clipboard Toggle word wrap
删除一个或多个共享。

positional 参数

<share>
共享的名称或 ID。

可选参数

--consistency-group <consistency-group>, --consistency_group <consistency-group>, --cg <consistency-group>
可选一致性组名称或包含共享的 ID。(default=None)

18.24. Manila 端点

usage: manila endpoints
Copy to Clipboard Toggle word wrap
发现从验证服务返回的端点。

18.25. Manila 扩展

usage: manila extend <share> <new_size>
Copy to Clipboard Toggle word wrap
增加现有共享的大小。

positional 参数

<share>
要扩展的共享名称或 ID。
<new_size>
新的共享大小,以 GB 为单位。

18.26. manila extra-specs-list

usage: manila extra-specs-list
Copy to Clipboard Toggle word wrap
打印当前"共享类型和额外规格"列表(仅限管理员)。

18.27. manila force-delete

usage: manila force-delete <share> [<share> ...]
Copy to Clipboard Toggle word wrap
尝试强制删除共享,无论状态如何。

positional 参数

<share>
强制删除共享的名称或 ID。

18.28. Manila list

usage: manila list [--all-tenants [<0|1>]] [--name <name>] [--status <status>] [--share-server-id <share_server_id>] [--metadata [<key=value> [<key=value> ...]]] [--extra-specs [<key=value> [<key=value> ...]]] [--share-type <share_type>] [--limit <limit>] [--offset <offset>] [--sort-key <sort_key>] [--sort-dir <sort_dir>] [--snapshot <snapshot>] [--host <host>] [--share-network <share_network>] [--project-id <project_id>] [--public] [--consistency-group <consistency_group>]
Copy to Clipboard Toggle word wrap
通过过滤器列出 NAS 共享。

可选参数

--all-tenants [<0|1>]
显示所有租户的信息(仅限管理员)。
--name <name>
按名称过滤结果。
--status <status>
根据状态过滤结果。
--share-server-id <share_server_id>, --share-server_id <share_server_id>, --share_server-id <share_server_id>, --share_server_id <share_server_id>
根据共享服务器 ID 过滤结果。
--metadata [<key=value> [<key=value> ...]]
根据元数据键和值过滤结果。OPTIONAL: Default=None
--extra-specs [<key=value> [<key=value> ...]], --extra_specs [<key=value> [<key=value> ...]]
通过用于创建共享的共享类型的额外 specs 键和值过滤结果。OPTIONAL: Default=None
--share-type <share_type>, --volume-type--share_type <share_type>, --share-type-id <share_type>, --volume-type-id <share_type>, --share-type_id <share_type>, --share_type-id <share_type>, --share_type_id <share_type>, --volume_type <share_type>, --volume_type>, --volume_type>
根据用于创建共享的共享类型 id 或名称过滤结果。
--limit <limit>
要返回的最大共享数。OPTIONAL:default=None.
--offset <offset>
设置 offset 以定义共享列表的起点。OPTIONAL:default=None.
--sort-key <sort_key>, --sort_key <sort_key>
要排序的关键,可用的键为('id', 'status', 'size', 'host', 'share_proto', 'export_location', 'availability_zone', 'user_id', 'project_id', 'created_at', 'updated_at', 'display_name', 'name', 'share_type_id', 'share_type', 'share_network_id', 'share_network', 'snapshot_id', 'snapshot')。OPTIONAL:default=None.
--sort-dir <sort_dir>, --sort_dir <sort_dir>
排序方向、可用值包括('asc', 'desc')。OPTIONAL:default=None.
--snapshot <snapshot>
按快照名称或 id 进行提交结果,用于共享。
--host <host>
按主机过滤结果。
--share-network <share_network>, --share_network <share_network>
根据 share-network name 或 id 过滤结果。
--project-id <project_id>, --project_id <project_id>
根据项目 ID 过滤结果。对于设置键 '--all-tenants' 非常有用。
--public
将来自所有租户的公共共享添加到结果。
--consistency-group <consistency_group>, --consistency_group <consistency_group>, --cg <consistency_group>
通过一致性组名称或 ID 来过滤结果。

18.29. manila list-extensions

usage: manila list-extensions
Copy to Clipboard Toggle word wrap
列出所有可用的 os-api 扩展。

18.30. Manila 管理

usage: manila manage [--name <name>] [--description <description>] [--share_type <share-type>] [--driver_options [<key=value> [<key=value> ...]]] <service_host> <protocol> <export_path>
Copy to Clipboard Toggle word wrap
管理不是由 Manila 处理的共享。

positional 参数

<service_host>
manage-share 服务 host: some.host@driver Serialpool
<protocol>
要管理的共享协议,如 NFS 或 CIFS。
<export_path>
共享导出路径,例如: 10.0.0.1:/foo_path, CIFS 共享,例如: \10.0.0.1 oo_name_of_cifs_share

可选参数

--name <name>
可选共享名称。(default=None)
--description <description>
可选共享描述。(default=None)
--share_type <share-type>, --share-type <share-type>
分配给共享的可选共享类型。(default=None)
--driver_options [<key=value> [<key=value> ...]], --driver-options [<key=value> [<key=value> ...]]
驱动程序选项 key=value 对(可选,Default=None)。

18.31. Manila 元数据

usage: manila metadata <share> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
设置或删除共享上的元数据。

positional 参数

<share>
要更新元数据的共享名称或 ID。
<action>
操作:'set' 或 'unset'。
<key=value>
要设置或取消设置的元数据(仅在未设置时需要密钥)。

18.32. Manila metadata-show

usage: manila metadata-show <share>
Copy to Clipboard Toggle word wrap
显示给定共享的元数据。

positional 参数

<share>
共享的名称或 ID。

18.33. manila metadata-update-all

usage: manila metadata-update-all <share> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
更新共享的所有元数据。

positional 参数

<share>
要更新元数据的共享名称或 ID。
<key=value>
要更新的元数据条目或条目。

18.34. Manila migrate

usage: manila migrate [--force-host-copy <True|False>] <share> <host#pool>
Copy to Clipboard Toggle word wrap
将共享迁移到新主机。

positional 参数

<share>
要迁移的共享名称或 ID。
<host#pool>
目标主机和池.

可选参数

--force-host-copy <True|False>
启用或禁用基于主机的通用强制迁移,这样可绕过驱动程序优化。默认=False。

18.35. Manila pool-list

usage: manila pool-list [--host <host>] [--backend <backend>] [--pool <pool>]
Copy to Clipboard Toggle word wrap
列出调度程序(仅限管理员)已知的所有后端存储池。

可选参数

--host <host>
按主机名过滤结果。支持正则表达式。
--backend <backend>
根据后端名称过滤结果。支持正则表达式。
--pool <pool>
根据池名称过滤结果。支持正则表达式。

18.36. Manila quota-class-show

usage: manila quota-class-show <class>
Copy to Clipboard Toggle word wrap
列出配额类的配额。

positional 参数

<class>
列出配额的配额类的名称。

18.37. manila quota-class-update

usage: manila quota-class-update [--shares <shares>] [--snapshots <snapshots>] [--gigabytes <gigabytes>] [--snapshot-gigabytes <snapshot_gigabytes>] [--share-networks <share-networks>] <class-name>
Copy to Clipboard Toggle word wrap
更新配额类的配额。

positional 参数

<class-name>
设置配额的配额类的名称。

可选参数

--shares <shares>
"shares" 配额的新值。
--snapshots <snapshots>
"snapshots" 配额的新值。
--gigabytes <gigabytes>
"gigabytes"配额的新值。
--snapshot-gigabytes <snapshot_gigabytes>, --snapshot_gigabytes <snapshot_gigabytes>
"snapshot_gigabytes" 配额的新值。
--share-networks <share-networks>
"share_networks"配额的新值。

18.38. Manila quota-defaults

usage: manila quota-defaults [--tenant <tenant-id>]
Copy to Clipboard Toggle word wrap
列出租户的默认配额。

可选参数

--tenant <tenant-id>
用于列出默认配额的租户 ID。

18.39. Manila quota-delete

usage: manila quota-delete [--tenant <tenant-id>] [--user <user-id>]
Copy to Clipboard Toggle word wrap
删除租户/用户的配额。配额将恢复为默认值。

可选参数

--tenant <tenant-id>
用于删除配额的租户 ID。
--user <user-id>
删除配额的用户 ID。

18.40. Manila quota-show

usage: manila quota-show [--tenant <tenant-id>] [--user <user-id>]
Copy to Clipboard Toggle word wrap
列出租户/用户的配额。

可选参数

--tenant <tenant-id>
列出配额的租户 ID。
--user <user-id>
列出配额的用户 ID。

18.41. Manila quota-update

usage: manila quota-update [--user <user-id>] [--shares <shares>] [--snapshots <snapshots>] [--gigabytes <gigabytes>] [--snapshot-gigabytes <snapshot_gigabytes>] [--share-networks <share-networks>] [--force] <tenant_id>
Copy to Clipboard Toggle word wrap
更新租户/用户的配额。

positional 参数

<tenant_id>
设置配额的 租户 UUID。

可选参数

--user <user-id>
设置配额的用户 ID。
--shares <shares>
"shares" 配额的新值。
--snapshots <snapshots>
"snapshots" 配额的新值。
--gigabytes <gigabytes>
"gigabytes"配额的新值。
--snapshot-gigabytes <snapshot_gigabytes>, --snapshot_gigabytes <snapshot_gigabytes>
"snapshot_gigabytes" 配额的新值。
--share-networks <share-networks>
"share_networks"配额的新值。
--force
即使已经使用和保留超过新配额,是否强制更新配额。

18.42. Manila 速率限制

usage: manila rate-limits
Copy to Clipboard Toggle word wrap
显示用户的速率限值列表。

18.43. manila reset-state

usage: manila reset-state [--state <state>] <share>
Copy to Clipboard Toggle word wrap
显式更新共享状态。

positional 参数

<share>
要修改的共享的名称或 ID。

可选参数

--state <state>
指明要分配共享的状态。选项包括 available、error、create、delete、error_deleting。如果未提供任何状态,则将使用 available。

18.44. Manila security-service-create

usage: manila security-service-create [--dns-ip <dns_ip>] [--server <server>] [--domain <domain>] [--user <user>] [--password <password>] [--name <name>] [--description <description>] <type>
Copy to Clipboard Toggle word wrap
创建租户使用的安全服务。

positional 参数

<type>
安全服务类型:'ldap'、'kerberos' 或 'active_directory'。

可选参数

--dns-ip <dns_ip>
租户网络中使用的 DNS IP 地址。
--server <server>
安全服务 IP 地址或主机名。
--domain <domain>
安全域.
--user <user>
租户使用的安全服务用户或组。
--password <password>
用户使用的密码。
--name <name>
安全服务名称。
--description <description>
安全服务描述.

18.45. manila security-service-delete

usage: manila security-service-delete <security-service>
Copy to Clipboard Toggle word wrap
删除安全服务。

positional 参数

<security-service>
要删除的安全服务名称或 ID。

18.46. Manila security-service-list

usage: manila security-service-list [--all-tenants [<0|1>]] [--share-network <share_network>] [--status <status>] [--name <name>] [--type <type>] [--user <user>] [--dns-ip <dns_ip>] [--server <server>] [--domain <domain>] [--detailed [<0|1>]] [--offset <offset>] [--limit <limit>]
Copy to Clipboard Toggle word wrap
获取安全服务列表。

可选参数

--all-tenants [<0|1>]
显示所有租户的信息(仅限管理员)。
--share-network <share_network>, --share_network <share_network>
根据共享网络 id 或 name 过滤结果。
--status <status>
根据状态过滤结果。
--name <name>
按名称过滤结果。
--type <type>
根据类型过滤结果。
--user <user>
过滤租户使用的用户或组的结果。
--dns-ip <dns_ip>, --dns_ip <dns_ip>
根据租户网络中使用的 DNS IP 地址过滤结果。
--server <server>
根据安全服务 IP 地址或主机名过滤结果。
--domain <domain>
按域过滤结果。
--detailed [<0|1>]
显示有关过滤的安全服务的详细信息。
--offset <offset>
安全服务列表开始位置。
--limit <limit>
每个请求要返回的安全服务数。

18.47. Manila security-service-show

usage: manila security-service-show <security-service>
Copy to Clipboard Toggle word wrap
显示安全服务。

positional 参数

<security-service>
要显示的安全服务名称或 ID。

18.48. manila security-service-update

usage: manila security-service-update [--dns-ip <dns-ip>] [--server <server>] [--domain <domain>] [--user <user>] [--password <password>] [--name <name>] [--description <description>] <security-service>
Copy to Clipboard Toggle word wrap
更新安全服务。

positional 参数

<security-service>
要更新的安全服务名称或 ID。

可选参数

--dns-ip <dns-ip>
租户网络中使用的 DNS IP 地址。
--server <server>
安全服务 IP 地址或主机名。
--domain <domain>
安全域.
--user <user>
租户使用的安全服务用户或组。
--password <password>
用户使用的密码。
--name <name>
安全服务名称。
--description <description>
安全服务描述.

18.49. Manila service-list

usage: manila service-list [--host <hostname>] [--binary <binary>] [--status <status>] [--state <state>] [--zone <zone>]
Copy to Clipboard Toggle word wrap
列出所有服务。

可选参数

--host <hostname>
主机的名称。
--binary <binary>
服务二进制文件。
--status <status>
根据状态过滤结果。
--state <state>
根据状态过滤结果。
--zone <zone>
可用性区域。

18.50. manila share-instance-force-delete

usage: manila share-instance-force-delete <instance> [<instance> ...]
Copy to Clipboard Toggle word wrap
尝试强制删除共享实例,而不考虑状态。

positional 参数

<instance>
要强制删除的实例的名称或 ID。

18.51. manila share-instance-list

usage: manila share-instance-list [--share-id <share_id>]
Copy to Clipboard Toggle word wrap
列出共享实例。

可选参数

--share-id <share_id>, --share_id <share_id>
根据共享 ID 过滤结果。

18.52. manila share-instance-reset-state

usage: manila share-instance-reset-state [--state <state>] <instance>
Copy to Clipboard Toggle word wrap
显式更新共享实例的状态。

positional 参数

<instance>
要修改的共享实例的名称或 ID。

可选参数

--state <state>
指明要分配实例的状态。选项包括 available、error、create、delete、error_deleting。如果未提供任何状态,则将使用 available。

18.53. manila share-instance-show

usage: manila share-instance-show <instance>
Copy to Clipboard Toggle word wrap
显示共享实例的详细信息。

positional 参数

<instance>
共享实例的名称或 ID。

18.54. manila share-network-create

usage: manila share-network-create [--nova-net-id <nova-net-id>] [--neutron-net-id <neutron-net-id>] [--neutron-subnet-id <neutron-subnet-id>] [--name <name>] [--description <description>]
Copy to Clipboard Toggle word wrap
为租户使用的网络创建描述。

可选参数

--Nova-net-id <nova-net-id>, --nova-net_id <nova-net-id>, --nova_net_id <nova-net-id>, --nova_net-id <nova-net-id>
Nova net ID。用于为共享服务器设置网络。
--Neutron-net-id <neutron-net-id>, --neutron-net_id <neutron-net-id>, --neutron_net_id <neutron-net-id>, --neutron_net-id <neutron-net-id>
Neutron 网络 ID。用于为共享服务器设置网络。
--Neutron-subnet-id <neutron-subnet-id>, --neutron-subnet_id <neutron-subnet-id>, --neutron_subnet_id <neutron-subnet-id>, --neutron_subnet-id <neutron-subnet-id>
Neutron 子网 ID。用于为共享服务器设置网络。此子网应属于指定的 neutron 网络。
--name <name>
共享网络名称。
--description <description>
共享网络描述。

18.55. Manila share-network-delete

usage: manila share-network-delete <share-network>
Copy to Clipboard Toggle word wrap
删除共享网络。

positional 参数

<share-network>
要删除的共享网络的名称或 ID。

18.56. Manila share-network-list

usage: manila share-network-list [--all-tenants [<0|1>]] [--project-id <project_id>] [--name <name>] [--created-since <created_since>] [--created-before <created_before>] [--security-service <security_service>] [--nova-net-id <nova_net_id>] [--neutron-net-id <neutron_net_id>] [--neutron-subnet-id <neutron_subnet_id>] [--network-type <network_type>] [--segmentation-id <segmentation_id>] [--cidr <cidr>] [--ip-version <ip_version>] [--offset <offset>] [--limit <limit>]
Copy to Clipboard Toggle word wrap
获取网络信息列表。

可选参数

--all-tenants [<0|1>]
显示所有租户的信息(仅限管理员)。
--project-id <project_id>, --project_id <project_id>
根据项目 ID 过滤结果。
--name <name>
按名称过滤结果。
--created-since <created_since>, --created_since <created_since>
仅返回共享自给定日期后创建的网络。日期格式为 'yyyy-mm-dd'。
--created-before <created_before>, --created_before <created_before>
仅返回在给定日期前创建的共享网络。日期格式为 'yyyy-mm-dd'。
--security-service <security_service>, --security_service <security_service>
通过附加的安全服务过滤结果。
--Nova-net-id <nova_net_id>, --nova_net_id <nova_net_id>, --nova_net-id <nova_net_id>, --nova-net_id <nova_net_id>
根据 Nova net ID 过滤结果。
--Neutron-net-id <neutron_net_id>, --neutron_net_id <neutron_net_id>, --neutron_net-id <neutron_net_id>, --neutron-net_id <neutron_net_id>
通过 neutron net ID 过滤结果。
--Neutron-subnet-id <neutron_subnet_id>, --neutron_subnet_id <neutron_subnet_id>, --neutron-subnet_id <neutron_subnet_id>, --neutron_subnet-id <neutron_subnet_id>
通过 neutron 子网 ID 过滤结果。
--network-type <network_type>, --network_type <network_type>
根据网络类型过滤结果。
--segmentation-id <segmentation_id>, --segmentation_id <segmentation_id>
根据分段 ID 过滤结果。
--cidr <cidr>
按 CIDR 过滤结果。
--ip-version <ip_version>, --ip_version <ip_version>
根据 IP 版本过滤结果。
--offset <offset>
共享网络列表开始位置。
--limit <limit>
每个请求返回的共享网络数量。

18.57. Manila share-network-security-service-add

usage: manila share-network-security-service-add <share-network> <security-service>
Copy to Clipboard Toggle word wrap
将安全服务与共享网络关联。

positional 参数

<share-network>
共享网络名称或 ID。
<security-service>
要关联的安全服务名称或 ID。

18.58. Manila share-network-security-service-list

usage: manila share-network-security-service-list <share-network>
Copy to Clipboard Toggle word wrap
获取与给定共享网络关联的安全服务列表。

positional 参数

<share-network>
共享网络名称或 ID。

18.59. Manila share-network-security-service-remove

usage: manila share-network-security-service-remove <share-network> <security-service>
Copy to Clipboard Toggle word wrap
与共享网络解除关联安全服务.

positional 参数

<share-network>
共享网络名称或 ID。
<security-service>
安全服务名称或 ID 来解除关联。

18.60. manila share-network-show

usage: manila share-network-show <share-network>
Copy to Clipboard Toggle word wrap
获取租户使用的网络的描述。

positional 参数

<share-network>
要显示的共享网络的名称或 ID。

18.61. manila share-network-update

usage: manila share-network-update [--nova-net-id <nova-net-id>] [--neutron-net-id <neutron-net-id>] [--neutron-subnet-id <neutron-subnet-id>] [--name <name>] [--description <description>] <share-network>
Copy to Clipboard Toggle word wrap
更新共享网络数据。

positional 参数

<share-network>
要更新的共享网络的名称或 ID。

可选参数

--Nova-net-id <nova-net-id>, --nova-net_id <nova-net-id>, --nova_net_id <nova-net-id>, --nova_net-id <nova-net-id>
Nova net ID。用于为共享服务器设置网络。
--Neutron-net-id <neutron-net-id>, --neutron-net_id <neutron-net-id>, --neutron_net_id <neutron-net-id>, --neutron_net-id <neutron-net-id>
Neutron 网络 ID。用于为共享服务器设置网络。
--Neutron-subnet-id <neutron-subnet-id>, --neutron-subnet_id <neutron-subnet-id>, --neutron_subnet_id <neutron-subnet-id>, --neutron_subnet-id <neutron-subnet-id>
Neutron 子网 ID。用于为共享服务器设置网络。此子网应属于指定的 neutron 网络。
--name <name>
共享网络名称。
--description <description>
共享网络描述。

18.62. manila share-server-delete

usage: manila share-server-delete <id>
Copy to Clipboard Toggle word wrap
删除共享服务器。

positional 参数

<id>
共享服务器的 ID。

18.63. manila share-server-details

usage: manila share-server-details <id>
Copy to Clipboard Toggle word wrap
显示共享服务器详细信息.

positional 参数

<id>
共享服务器的 ID。

18.64. Manila share-server-list

usage: manila share-server-list [--host <hostname>] [--status <status>] [--share-network <share_network>] [--project-id <project_id>]
Copy to Clipboard Toggle word wrap
列出所有共享服务器。

可选参数

--host <hostname>
根据主机名过滤结果。
--status <status>
根据状态过滤结果。
--share-network <share_network>
根据共享网络过滤结果。
--project-id <project_id>
根据项目 ID 过滤结果。

18.65. manila share-server-show

usage: manila share-server-show <id>
Copy to Clipboard Toggle word wrap
显示共享服务器信息。

positional 参数

<id>
共享服务器的 ID。

18.66. Manila 显示

usage: manila show <share>
Copy to Clipboard Toggle word wrap
显示 NAS 共享的详细信息。

positional 参数

<share>
NAS 共享的名称或 ID。

18.67. Manila shrink

usage: manila shrink <share> <new_size>
Copy to Clipboard Toggle word wrap
减少现有共享的大小。

positional 参数

<share>
要缩小的共享名称或 ID。
<new_size>
新的共享大小,以 GB 为单位。

18.68. manila snapshot-create

usage: manila snapshot-create [--force <True|False>] [--name <name>] [--description <description>] <share>
Copy to Clipboard Toggle word wrap
添加新快照。

positional 参数

<share>
到快照的共享的名称或 ID。

可选参数

--force <True|False>
可选标志,用来指示是否对共享进行快照,即使是忙碌的。(默认值=False)
--name <name>
可选的快照名称。(default=None)
--description <description>
可选的快照描述。(default=None)

18.69. manila snapshot-delete

usage: manila snapshot-delete <snapshot>
Copy to Clipboard Toggle word wrap
删除快照。

positional 参数

<snapshot>
要删除的快照的名称或 ID。

18.70. manila snapshot-force-delete

usage: manila snapshot-force-delete <snapshot>
Copy to Clipboard Toggle word wrap
无论状态如何,尝试强制删除快照。

positional 参数

<snapshot>
强制删除的快照的名称或 ID。

18.71. Manila snapshot-list

usage: manila snapshot-list [--all-tenants [<0|1>]] [--name <name>] [--status <status>] [--share-id <share_id>] [--usage [any|used|unused]] [--limit <limit>] [--offset <offset>] [--sort-key <sort_key>] [--sort-dir <sort_dir>]
Copy to Clipboard Toggle word wrap
列出所有快照。

可选参数

--all-tenants [<0|1>]
显示所有租户的信息(仅限管理员)。
--name <name>
按名称过滤结果。
--status <status>
根据状态过滤结果。
--share-id <share_id>, --share_id <share_id>
根据源共享 ID 过滤结果。
--usage [any|used|unused]
根据使用情况过滤或不对快照进行过滤。OPTIONAL:default=any.
--limit <limit>
要返回的最大共享快照数。OPTIONAL:default=None.
--offset <offset>
设置 offset 以定义共享快照列表的开始点。OPTIONAL:default=None.
--sort-key <sort_key>, --sort_key <sort_key>
要排序的键为:('id', 'status', 'size', 'share_id', 'user_id', 'project_id', 'progress', 'name', 'display_name')。default=None。
--sort-dir <sort_dir>, --sort_dir <sort_dir>
排序方向、可用值包括('asc', 'desc')。OPTIONAL:default=None.

18.72. manila snapshot-rename

usage: manila snapshot-rename [--description <description>] <snapshot> [<name>]
Copy to Clipboard Toggle word wrap
重命名快照。

positional 参数

<snapshot>
要重命名的快照的名称或 ID。
<name>
快照的新名称。

可选参数

--description <description>
可选的快照描述。(default=None)

18.73. manila snapshot-reset-state

usage: manila snapshot-reset-state [--state <state>] <snapshot>
Copy to Clipboard Toggle word wrap
显式更新快照状态。

positional 参数

<snapshot>
要修改的快照的名称或 ID。

可选参数

--state <state>
指明要分配快照的状态。选项包括 available、error、create、delete、error_deleting。如果未提供任何状态,则将使用 available。

18.74. manila snapshot-show

usage: manila snapshot-show <snapshot>
Copy to Clipboard Toggle word wrap
显示快照的详细信息。

positional 参数

<snapshot>
快照的名称或 ID。

18.75. manila type-access-add

usage: manila type-access-add <share_type> <project_id>
Copy to Clipboard Toggle word wrap
为给定项目添加共享类型访问权限。

positional 参数

<share_type>
为给定项目添加访问权限的共享类型名称或 ID。
<project_id>
用于添加共享类型访问权限的项目 ID。

18.76. manila type-access-list

usage: manila type-access-list <share_type>
Copy to Clipboard Toggle word wrap
打印有关给定共享类型的访问权限信息。

positional 参数

<share_type>
根据共享类型名称或 ID 过滤结果。

18.77. Manila type-access-remove

usage: manila type-access-remove <share_type> <project_id>
Copy to Clipboard Toggle word wrap
删除给定项目的共享类型访问权限。

positional 参数

<share_type>
共享类型名称或 ID 以删除对给定项目的访问权限。
<project_id>
移除共享类型访问的项目 ID。

18.78. Manila type-create

usage: manila type-create [--snapshot_support <snapshot_support>] [--is_public <is_public>] <name> <spec_driver_handles_share_servers>
Copy to Clipboard Toggle word wrap
创建新共享类型。

positional 参数

<name>
新共享类型的名称。
<spec_driver_handles_share_servers>
所需的额外规格。有效值为 'true'/'1' 和 'false'/'0'

可选参数

--snapshot_support <snapshot_support>, --snapshot-support <snapshot_support>
布尔值额外规格,用于按照其功能过滤后端,以创建共享快照。(默认为 True)。
--is_public <is_public>, --is-public <is_public>
make 类型可以被公共访问(默认为 true)。

18.79. Manila type-delete

usage: manila type-delete <id>
Copy to Clipboard Toggle word wrap
删除特定的共享类型。

positional 参数

<id>
要删除的共享类型的名称或 ID。

18.80. Manila type-key

usage: manila type-key <stype> <action> [<key=value> [<key=value> ...]]
Copy to Clipboard Toggle word wrap
为共享类型设置或取消设置 extra_spec。

positional 参数

<stype>
共享类型的名称或 ID。
<action>
操作:'set' 或 'unset'。
<key=value>
设置为 set 或 unset 的 extra_specs (只在未设置时才需要密钥)。

18.81. Manila type-list

usage: manila type-list [--all]
Copy to Clipboard Toggle word wrap
打印可用"共享类型"列表。

可选参数

--all
显示所有共享类型(仅限管理员)。

18.82. Manila unmanage

usage: manila unmanage <share>
Copy to Clipboard Toggle word wrap
未管理共享.

positional 参数

<share>
共享的名称或 ID。

18.83. Manila 更新

usage: manila update [--name <name>] [--description <description>] [--is-public <is_public>] <share>
Copy to Clipboard Toggle word wrap
重命名共享。

positional 参数

<share>
要重命名的共享的名称或 ID。

可选参数

--name <name>
共享的新名称。
--description <description>
可选共享描述。(default=None)
--is-public <is_public>, --is_public <is_public>
公共共享对所有租户可见。
gnocchi 客户端是命令行界面(CLI),用于 A 时间序列存储和资源索引服务 API 及其扩展。本章记录了 gnocchi 版本 2.0.0
有关特定 gnocchi 命令的帮助信息,请输入:
$ gnocchi help COMMAND
Copy to Clipboard Toggle word wrap

19.1. Gnocchi usage

usage: gnocchi [--version] [-v] [--log-file LOG_FILE] [-q] [-h] [--debug] [--os-region-name <auth-region-name>] [--os-interface <interface>] [--gnocchi-api-version GNOCCHI_API_VERSION] [--insecure] [--os-cacert <ca-certificate>] [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>] [--os-auth-type <name>] [--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID] [--os-domain-name OS_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID] [--os-project-name OS_PROJECT_NAME] [--os-project-domain-id OS_PROJECT_DOMAIN_ID] [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] [--os-trust-id OS_TRUST_ID] [--os-user-id OS_USER_ID] [--os-user-name OS_USERNAME] [--os-user-domain-id OS_USER_DOMAIN_ID] [--os-user-domain-name OS_USER_DOMAIN_NAME] [--os-password OS_PASSWORD] [--gnocchi-endpoint <endpoint>]
Copy to Clipboard Toggle word wrap

19.2. Gnocchi 可选参数

--version
显示程序的版本号并退出
-v, --verbose
提高输出的详细程度。可以重复。
--log-file LOG_FILE
指定要记录输出的文件。默认禁用此选项。
-q, --quiet
抑制输出,除了警告和错误外。
-h, --help
显示帮助消息并退出。
--debug
显示错误的回溯。
--os-region-name <auth-region-name>
身份验证区域名称(Env: OS_REGION_NAME)
--os-interface <interface>
选择接口类型。有效的接口类型: [admin, public, internal]。(env: OS_INTERFACE)
--gnocchi-api-version GNOCCHI_API_VERSION
默认为 env[GNOCCHI_API_VERSION] 或 1。
--insecure
明确允许客户端执行"不安全"TLS (https)请求。服务器的证书不会针对任何证书颁发机构进行验证。这个选项应谨慎使用。
--os-cacert <ca-certificate>
指定用于验证 TLS (https)服务器证书中使用的 CA 捆绑包文件。默认为 env[OS_CACERT]
--os-cert <certificate>
默认为 env[OS_CERT]
--os-key <key>
默认为 env[OS_KEY]
--timeout <seconds>
设置请求超时(以秒为单位)。
--os-auth-type <name>, --os-auth-plugin <name>
要使用的身份验证类型
--gnocchi-endpoint <endpoint>
GNOCCHI_ENDPOINT 端点(Env: GNOCCHI_ENDPOINT)

19.3. gnocchi archive-policy create

usage: gnocchi archive-policy create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [-b BACK_WINDOW] [-m AGGREGATION_METHODS] -d <DEFINITION> name
Copy to Clipboard Toggle word wrap
创建归档策略

positional 参数

名称
归档策略的名称

可选参数

-h, --help
显示帮助信息并退出
-b BACK_WINDOW, --back-window BACK_WINDOW
归档策略的后端窗口
-M AGGREGATION_METHODS, --aggregation-method AGGREGATION_METHODS
归档策略的聚合方法
-d <DEFINITION>, --definition <DEFINITION>
归档策略定义的两个属性(以 ',' 分隔),其名称和值用 ':' 分隔。

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

19.4. gnocchi archive-policy delete

usage: gnocchi archive-policy delete [-h] name
Copy to Clipboard Toggle word wrap
删除归档策略

positional 参数

名称
归档策略的名称

可选参数

-h, --help
显示帮助信息并退出

19.5. gnocchi archive-policy list

usage: gnocchi archive-policy list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
列出归档策略

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

19.6. gnocchi archive-policy-rule create

usage: gnocchi archive-policy-rule create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] -a ARCHIVE_POLICY_NAME -m METRIC_PATTERN name
Copy to Clipboard Toggle word wrap
创建归档策略规则

positional 参数

名称
运行名称

可选参数

-h, --help
显示帮助信息并退出
-a ARCHIVE_POLICY_NAME, --archive-policy-name ARCHIVE_POLICY_NAME
归档策略名称
-m METRIC_PATTERN, --metric-pattern METRIC_PATTERN
要匹配的指标名称的通配符

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

19.7. gnocchi archive-policy-rule delete

usage: gnocchi archive-policy-rule delete [-h] name
Copy to Clipboard Toggle word wrap
删除归档策略规则

positional 参数

名称
归档策略规则的名称

可选参数

-h, --help
显示帮助信息并退出

19.8. gnocchi archive-policy-rule list

usage: gnocchi archive-policy-rule list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
列出归档策略规则

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

19.9. gnocchi archive-policy-rule 显示

usage: gnocchi archive-policy-rule show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] name
Copy to Clipboard Toggle word wrap
显示归档策略规则

positional 参数

名称
归档策略规则的名称

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

19.10. gnocchi archive-policy show

usage: gnocchi archive-policy show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] name
Copy to Clipboard Toggle word wrap
显示归档策略

positional 参数

名称
归档策略的名称

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

19.11. Gnocchi 基准措施添加

usage: gnocchi benchmark measures add [-h] [--resource-id RESOURCE_ID] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--workers WORKERS] --count COUNT [--batch BATCH] [--timestamp-start TIMESTAMP_START] [--timestamp-end TIMESTAMP_END] metric
Copy to Clipboard Toggle word wrap
对添加测量进行基准测试

positional 参数

metric
指标的 ID 或名称

可选参数

-h, --help
显示帮助信息并退出
--resource-id RESOURCE_ID, -r RESOURCE_ID
资源的 ID
--workers WORKERS, -w WORKERS
要使用的 worker 数量
--count COUNT, -n COUNT
要发送的总测量结果数
--batch BATCH, -b BATCH
每个批处理中要发送的测量结果数
--timestamp-start TIMESTAMP_START, -s TIMESTAMP_START
使用的第一个时间戳
--timestamp-end TIMESTAMP_END, -e TIMESTAMP_END
使用的最后一个时间戳

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

19.12. Gnocchi 基准措施显示

usage: gnocchi benchmark measures show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--resource-id RESOURCE_ID] [--aggregation AGGREGATION] [--start START] [--stop STOP] [--workers WORKERS] --count COUNT metric
Copy to Clipboard Toggle word wrap
对测量进行基准测试显示

positional 参数

metric
指标的 ID 或名称

可选参数

-h, --help
显示帮助信息并退出
--resource-id RESOURCE_ID, -r RESOURCE_ID
资源的 ID
--aggregation AGGREGATION
用于检索的聚合
--start START
周期开始
--stop STOP
周期结束
--workers WORKERS, -w WORKERS
要使用的 worker 数量
--count COUNT, -n COUNT
要发送的总测量结果数

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

19.13. Gnocchi 基准指标创建

usage: gnocchi benchmark metric create [-h] [--resource-id RESOURCE_ID] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--archive-policy-name ARCHIVE_POLICY_NAME] [--workers WORKERS] --count COUNT [--keep]
Copy to Clipboard Toggle word wrap
对指标创建进行基准测试

可选参数

-h, --help
显示帮助信息并退出
--resource-id RESOURCE_ID, -r RESOURCE_ID
资源的 ID
--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME
归档策略的名称
--workers WORKERS, -w WORKERS
要使用的 worker 数量
--count COUNT, -n COUNT
要创建的指标数
--keep, -k
保留创建的指标

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

19.14. Gnocchi 基准指标显示

usage: gnocchi benchmark metric show [-h] [--resource-id RESOURCE_ID] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--workers WORKERS] --count COUNT metric [metric ...]
Copy to Clipboard Toggle word wrap
指标数据的基准测试是否显示

positional 参数

metric
指标的 ID 或名称

可选参数

-h, --help
显示帮助信息并退出
--resource-id RESOURCE_ID, -r RESOURCE_ID
资源的 ID
--workers WORKERS, -w WORKERS
要使用的 worker 数量
--count COUNT, -n COUNT
获取的指标数

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

19.15. Gnocchi capabilities list

usage: gnocchi capabilities list [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX]
Copy to Clipboard Toggle word wrap
列出功能

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

19.16. Gnocchi measure add

usage: gnocchi measures add [-h] [--resource-id RESOURCE_ID] -m MEASURE metric
Copy to Clipboard Toggle word wrap
为指标添加测量

positional 参数

metric
指标的 ID 或名称

可选参数

-h, --help
显示帮助信息并退出
--resource-id RESOURCE_ID, -r RESOURCE_ID
资源的 ID
-m MEASURE, --measure MEASURE
使用 '@' 分隔的测量的时间戳和值

19.17. Gnocchi 测量聚合

usage: gnocchi measures aggregation [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] -m METRIC [METRIC ...] [--aggregation AGGREGATION] [--start START] [--stop STOP] [--needed-overlap NEEDED_OVERLAP] [--query QUERY]
Copy to Clipboard Toggle word wrap
获取聚合指标的测量

可选参数

-h, --help
显示帮助信息并退出
-M METRIC [METRIC ...],--metric METRIC [METRIC [METRIC ...]
指标 ID 或指标名称
--aggregation AGGREGATION
用于检索的聚合
--start START
周期开始
--stop STOP
周期结束
--needed-overlap NEEDED_OVERLAP
每个指标中所需的数据点百分比
--query QUERY
查询

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

19.18. Gnocchi 测量显示

usage: gnocchi measures show [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--resource-id RESOURCE_ID] [--aggregation AGGREGATION] [--start START] [--stop STOP] metric
Copy to Clipboard Toggle word wrap
获取指标的测量

positional 参数

metric
指标的 ID 或名称

可选参数

-h, --help
显示帮助信息并退出
--resource-id RESOURCE_ID, -r RESOURCE_ID
资源的 ID
--aggregation AGGREGATION
用于检索的聚合
--start START
周期开始
--stop STOP
周期结束

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

19.19. gnocchi 指标创建

usage: gnocchi metric create [-h] [--resource-id RESOURCE_ID] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--archive-policy-name ARCHIVE_POLICY_NAME] [METRIC_NAME]
Copy to Clipboard Toggle word wrap
创建指标

positional 参数

METRIC_NAME
指标的名称

可选参数

-h, --help
显示帮助信息并退出
--resource-id RESOURCE_ID, -r RESOURCE_ID
资源的 ID
--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME
归档策略的名称

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

19.20. Gnocchi 指标删除

usage: gnocchi metric delete [-h] [--resource-id RESOURCE_ID] metric [metric ...]
Copy to Clipboard Toggle word wrap
删除指标

positional 参数

metric
指标的 ID 或名称

可选参数

-h, --help
显示帮助信息并退出
--resource-id RESOURCE_ID, -r RESOURCE_ID
资源的 ID

19.21. Gnocchi 指标列表

usage: gnocchi metric list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
列出指标

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

19.22. Gnocchi 指标显示

usage: gnocchi metric show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--resource-id RESOURCE_ID] metric
Copy to Clipboard Toggle word wrap
显示指标

positional 参数

metric
指标的 ID 或名称

可选参数

-h, --help
显示帮助信息并退出
--resource-id RESOURCE_ID, -r RESOURCE_ID
资源的 ID

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

19.23. Gnocchi 资源创建

usage: gnocchi resource create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--type RESOURCE_TYPE] [-a ATTRIBUTE] [-m ADD_METRIC] [-n CREATE_METRIC] [-d DELETE_METRIC] resource_id
Copy to Clipboard Toggle word wrap
创建资源

positional 参数

resource_id
资源的 ID

可选参数

-h, --help
显示帮助信息并退出
--type RESOURCE_TYPE, -t RESOURCE_TYPE
资源类型
-a ATTRIBUTE, --attribute ATTRIBUTE
使用 ':' 分隔的属性的名称和值
-m ADD_METRIC, --add-metric ADD_METRIC
要添加的指标的 name:id
-n CREATE_METRIC, --create-metric CREATE_METRIC
name:archive_policy_name of a metric created
-d DELETE_METRIC, --delete-metric DELETE_METRIC
要删除的指标的名称

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

19.24. Gnocchi 资源删除

usage: gnocchi resource delete [-h] resource_id
Copy to Clipboard Toggle word wrap
删除资源

positional 参数

resource_id
资源的 ID

可选参数

-h, --help
显示帮助信息并退出

19.25. Gnocchi 资源历史记录

usage: gnocchi resource history [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--details] [--limit <LIMIT>] [--marker <MARKER>] [--sort <SORT>] [--type RESOURCE_TYPE] resource_id
Copy to Clipboard Toggle word wrap
显示资源的历史记录

positional 参数

resource_id
资源的 ID

可选参数

-h, --help
显示帮助信息并退出
--details
显示通用资源的所有属性
--limit <LIMIT>
要返回的资源数(默认为服务器默认)
--marker <MARKER>
上一个列表的最后一项。此值后返回下一个结果
--sort <SORT>
资源属性排序(示例:user_id:desc- nullslast
--type RESOURCE_TYPE, -t RESOURCE_TYPE
资源类型

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

19.26. Gnocchi 资源列表

usage: gnocchi resource list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--details] [--history] [--limit <LIMIT>] [--marker <MARKER>] [--sort <SORT>] [--type RESOURCE_TYPE]
Copy to Clipboard Toggle word wrap
列出资源

可选参数

-h, --help
显示帮助信息并退出
--details
显示通用资源的所有属性
--history
显示资源的历史记录
--limit <LIMIT>
要返回的资源数(默认为服务器默认)
--marker <MARKER>
上一个列表的最后一项。此值后返回下一个结果
--sort <SORT>
资源属性排序(示例:user_id:desc- nullslast
--type RESOURCE_TYPE, -t RESOURCE_TYPE
资源类型

输出格式

输出格式选项
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

CSV 格式:

--quote {all,minimal,none,nonnumeric}
当包含引号时,则默认为非数字

19.28. Gnocchi 资源显示

usage: gnocchi resource show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--type RESOURCE_TYPE] resource_id
Copy to Clipboard Toggle word wrap
显示资源

positional 参数

resource_id
资源的 ID

可选参数

-h, --help
显示帮助信息并退出
--type RESOURCE_TYPE, -t RESOURCE_TYPE
资源类型

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

19.29. Gnocchi 资源更新

usage: gnocchi resource update [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--type RESOURCE_TYPE] [-a ATTRIBUTE] [-m ADD_METRIC] [-n CREATE_METRIC] [-d DELETE_METRIC] resource_id
Copy to Clipboard Toggle word wrap
更新资源

positional 参数

resource_id
资源的 ID

可选参数

-h, --help
显示帮助信息并退出
--type RESOURCE_TYPE, -t RESOURCE_TYPE
资源类型
-a ATTRIBUTE, --attribute ATTRIBUTE
使用 ':' 分隔的属性的名称和值
-m ADD_METRIC, --add-metric ADD_METRIC
要添加的指标的 name:id
-n CREATE_METRIC, --create-metric CREATE_METRIC
name:archive_policy_name of a metric created
-d DELETE_METRIC, --delete-metric DELETE_METRIC
要删除的指标的名称

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

19.30. Gnocchi 状态

usage: gnocchi status [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX]
Copy to Clipboard Toggle word wrap
显示测量处理的状态

可选参数

-h, --help
显示帮助信息并退出

输出格式

输出格式选项
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml}
输出格式,默认为 table
-c COLUMN, --column COLUMN
可以重复指定要包含的列

表格式:

--max-width <integer>
最大显示宽度,0 代表禁用

JSON 格式:

--noindent
是否禁用缩进 JSON

shell 格式:

UNIX shell 可以解析的格式(variable="value")
--prefix PREFIX
在所有变量名称中添加前缀

修订历史记录

修订历史
修订 7.0.0-1Wed Jan 20 2016Radek Bíba
Red Hat OpenStack Platform 8.0 版本。

法律通告

版权所有 © 2016 Red Hat, Inc.
本文档内容及图解由红帽根据 Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA")授权。http://creativecommons.org/licenses/by-sa/3.0/ 中提供了CC-BY-SA 的说明。根据 CC-BY-SA,如果发布本文档或提供此文档,则必须提供原始版本的 URL。
作为本文档的许可者,红帽可能会放弃强制制执行 CC-BY-SA 第4d 条款,且不声明该条款在适用条款允许的最大限度内有效。
Red Hat、Red Hat Enterprise Linux、Shadowman 徽标、红帽徽标、JBoss、OpenShift、Fedora、Infinity 徽标和 RHCE 是 Red Hat, Inc. 在美国和其他国家注册的商标。
Linux® 是 Linus Torvalds 在美国和其它国家注册的商标。
Java® 是 Oracle 和/或其附属公司注册的商标。
XFS® 是 Silicon Graphics International Corp. 或其子公司在美国和/或其他国家的商标。
MySQL® 是 MySQL AB 在美国、美国和其他国家注册的商标。
Node.js® 是 Joyent 的官方商标。红帽与官方 Joyent Node.js 开源社区或商业项目没有正式的关系或认可。
OpenStack® Word Mark 和 OpenStack 徽标是 OpenStack Foundation 在美国及其他国家注册的商标/服务标记或商标/服务标记,在 OpenStack Foundation 许可的情况下使用。我们不附属于 OpenStack Foundation 或 OpenStack 社区。
所有其他商标均由其各自所有者所有。
返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2025 Red Hat