コマンドラインインターフェイスリファレンス


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 は、メソッド、URI、メディアタイプ、応答コードなど、HTTP プロトコルを使用する RESTful API です。
これらのオープンソースの Python クライアントは、Linux または Mac OS X システムで実行され、学習し、使いやすいです。各 OpenStack サービスには、独自のコマンドラインクライアントがあります。一部のクライアントコマンドでは、debug パラメーターを指定して、コマンドの基礎となる API 要求を表示できます。これは、OpenStack API 呼び出しについて理解するのに適した方法です。
以下の表は、各 OpenStack サービスのコマンドラインクライアントとそのパッケージ名および説明を示しています。
Expand
表1.1 OpenStack サービスとクライアント
サービス クライアント パッケージ 説明
Block Storage cinder python-cinderclient ボリュームを作成および管理します。
コンピュート nova python-novaclient イメージ、インスタンス、およびフレーバーを作成および管理します。
データベースサービス trove python-troveclient データベースを作成および管理します。
Identity keystone python-keystoneclient ユーザー、テナント、ロール、エンドポイント、および認証情報を作成および管理します。
Image サービス glance python-glanceclient イメージを作成および管理します。
ネットワーク neutron python-neutronclient ゲストサーバーのネットワークを設定する。このクライアントは、以前はクォ ンタム と呼ばれていました。
オブジェクトストレージ swift python-swiftclient Object Storage サービスによって保存されたファイルの統計、項目の一覧表示、メタデータの更新、アップロード、ダウンロード、および削除を行います。アドホック処理用の Object Storage インストールへのアクセスを取得します。
Orchestration heat python-heatclient テンプレートからスタックを起動し、イベントやリソースを含む実行中のスタックの詳細を表示し、スタックを更新および削除します。
テレメトリー ceilometer python-ceilometerclient OpenStack 全体で測定値を作成して収集します。
OpenStack 共通 クライアントが開発中です。
クライアントのインストール手順は、「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 を検索し、インストールパッケージを検索します。見つからない場合は、setuptools パッケージを http://pypi.python.org/pypi/setuptools から直接ダウンロードします。

1.2.2. クライアントのインストール

このセクションの手順に従う場合は、PROJECT を、インストールするクライアントの小文字名に置き換えます(例: nova )。各クライアントに対して繰り返します。次の値が有効です。
  • ceilometer - Telemetry API
  • Cinder - Block Storage API と拡張機能
  • Glance - Image サービス 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. 次のステップ

クライアントコマンドを実行する前に、PROJECT-openrc.sh ファイルを作成してソースし、環境変数を設定する必要があります。「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 Dashboard からファイルをダウンロードできます。このプロジェクト固有の環境ファイルには、すべての OpenStack サービスが使用する認証情報が含まれます。
ファイルのソース時に、環境変数が現在のシェルに設定されます。変数により、OpenStack クライアントコマンドはクラウドで実行される OpenStack サービスと通信することができます。
注記
環境ファイルを使用して環境変数を定義することは、Microsoft Windows での一般的な方法ではありません。環境変数は、通常 System Properties ダイアログボックスの Advanced タブで定義されます。

1.4.1. OpenStack RC ファイルのダウンロードと取得

  1. OpenStack Dashboard にログインし、OpenStack RC ファイルをダウンロードするプロジェクトを選択します。続いて、Access & Security をクリックします。
  2. API Access タブで、Download OpenStack RC File をクリックしてファイルを保存します。ファイル名の形式は PROJECT-openrc.sh で、PROJECT はダウンロードしたプロジェクトの名前に置き換えます。
  3. PROJECT-openrc.sh ファイルを、OpenStack コマンドを実行するコンピューターにコピーします。
    たとえば、glance client コマンドを使用して、イメージをアップロードするコンピューターにファイルをコピーします。
  4. OpenStack コマンドを実行するシェルで、source コマンドで適切なプロジェクトの 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 ファイルの作成および取得元

Dashboard からファイルをダウンロードできない場合は、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 コマンドを実行するシェルで、source コマンドで適切なプロジェクトの PROJECT-openrc.sh ファイルを読み込みます。以下の例では、source コマンドで admin プロジェクトの admin-openrc.sh ファイルを読み込みます。
    $ source admin-openrc.sh
    Copy to Clipboard Toggle word wrap
注記
この方法では、パスワードの入力を求められません。パスワードは、PROJECT-openrc.sh ファイルのクリアテキスト形式で存在します。セキュリティーの問題を回避するために、このファイルのパーミッションを制限します。そのファイルから OS_PASSWORD 変数を削除し、代わりに OpenStack クライアントコマンドで the-- password パラメーターを使用することもできます。

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 コマンドラインクライアント

packstack クライアントは、単一ノードの概念実証のデプロイメントをインストールするためのコマンドラインインターフェイス(CLI)です。本章では、packstack バージョン 2015.1.dev1537.gba5183c について説明します。
特定の packstack コマンドのヘルプを表示するには、次のように入力します。
$ packstack help COMMAND
Copy to Clipboard Toggle word wrap

2.1. packstack の使用

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
ホストのセットを 1 つのステップでインストールします。形式は、ホストのコンマ区切りリストで、最初にコントローラーとして設定する必要があり、その他はコンピュートノードとして設定されます。単一のホストのみが指定されている場合は、1 つのインストールでだけ設定されます。応答ファイルも生成され、Packstack を 2 回実行する必要がある場合は使用する必要があります。
--allInOne
--install-hosts=<local ipaddr> --novanetwork-pubif=<dev> --novacompute-privif=lo --novanetwork-privif=lo --os-swift-install=y の省略形です。このオプションを使用して、このホスト上の 1 つの OpenStack にすべてをインストールできます。
-t TIMEOUT、--timeout=TIMEOUT
puppet Exec 呼び出しのタイムアウト
-o, --options
応答ファイル(rst 形式)で利用可能なオプションの詳細を出力します
-d、--debug
ロギングでデバッグを有効にします。
-y、--dry-run
実行しないでください。マニフェストのみを生成します

2.3. パックスタックグローバルオプション

--ssh-public-key=SSH_PUBLIC_KEY
サーバーにインストールする公開鍵へのパス。使用可能な鍵がリモートサーバーにインストールされていない場合は、パスワードの入力を求められます。この鍵をインストールするため、パスワードは再度必要ありません。
--default-password=DEFAULT_PASSWORD
あらゆる場所で使用されるデフォルトのパスワード(個々のサービスまたはユーザーに対して設定されたパスワードは上書き)。
--MariaDB-install=MARIADB_INSTALL
MariaDB をインストールする y を指定します。['y', 'n']
--os-glance-install=OS_GLANCE_INSTALL
OpenStack Image Service (glance)をインストールするには 'y' を指定します。'y', 'n']
--os-cinder-install=OS_CINDER_INSTALL
OpenStack Block Storage (cinder)をインストールする y を指定します。['y', 'n']
--os-manila-install=OS_MANILA_INSTALL
OpenStack Shared File System (manila)をインストールする y を指定します。['y', 'n']
--os-nova-install=OS_NOVA_INSTALL
OpenStack Compute (nova). ['y', 'n'] をインストールするには 'y' を指定します。
--os-neutron-install=OS_NEUTRON_INSTALL
OpenStack Networking (neutron)をインストールするには y を指定します。指定しない場合は、Compute Networking (nova)が使用されます。['y', 'n']
--os-horizon-install=OS_HORIZON_INSTALL
OpenStack Dashboard (horizon)をインストールするには 'y' を指定します。'y', 'n']
--os-swift-install=OS_SWIFT_INSTALL
OpenStack Object Storage (swift)をインストールする y を指定します。['y', 'n']
--os-ceilometer-install=OS_CEILOMETER_INSTALL
OpenStack メータリング(ceilometer)をインストールするには y を指定します。'y', 'n']
--os-heat-install=OS_HEAT_INSTALL
OpenStack Orchestration (heat)をインストールするには 'y' を指定します。'y', 'n']
--os-sahara-install=OS_SAHARA_INSTALL
y を指定して OpenStack Data Processing (sahara)をインストールします。['y', 'n']
--os-trove-install=OS_TROVE_INSTALL
OpenStack Database (trove)['y', 'n'] をインストールするには 'y' を指定します。
--os-ironic-install=OS_IRONIC_INSTALL
y を指定して OpenStack Bare Metal Provisioning (ironic)。['y', 'n'] をインストールします。
--os-client-install=OS_CLIENT_INSTALL
OpenStack Client パッケージをインストールするには y を指定します(コマンドラインツール)。管理者 rc ファイルもインストールされます。['y', 'n']
--ntp-servers=NTP_SERVERS
NTP サーバーのコンマ区切りリスト。Packstack がインスタンスに ntpd をインストールしないようにする場合はプレーンのままにします。
--exclude-servers=EXCLUDE_SERVERS
インストールから除外するサーバーのコンマ区切りの一覧。これは、同じ応答ファイルで、再度 Packstack を実行していて、Packstack でこれらのサーバーの構成を上書きしたくない場合に便利です。サーバーを除外する必要がない場合は空のままにします。
--os-debug-mode=OS_DEBUG_MODE
OpenStack サービスをデバッグモードで実行する場合は y を指定します。それ以外の場合は、'n'. ['y', 'n'] を指定します。
--os-controller-host=OS_CONTROLLER_HOST
コントローラーロール固有の OpenStack サービス(例:API サーバーまたはダッシュボード)をインストールするサーバーの IP アドレス。
--os-compute-hosts=OS_COMPUTE_HOSTS
Compute サービスをインストールするサーバーの IP アドレスのリスト。
--os-network-hosts=OS_NETWORK_HOSTS
Compute Networking (nova ネットワーク)または OpenStack Networking (neutron)などのネットワークサービスをインストールするサーバーの IP アドレスのリスト。
--os-vmware=OS_VMWARE
VMware vCenter をハイパーバイザーおよびストレージとして使用する場合は、y を指定します。それ以外の場合は、'n'. ['y', 'n'] を指定します。
--unsupported=UNSUPPORTED
サポート対象外のパラメーターを使用する場合は y を指定します。これは、自分が何をしているのかわかっている場合にのみ使用してください。サポートされていないオプションを使用することによって引き起こされる問題は、次のメジャーリリースより前に修正されません。['y', 'n']

2.4. Packstack 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 サーバーの準備設定

--use-epel=USE_EPEL
y を指定して、EPEL リポジトリーを有効にします(Extra Packages for Enterprise Linux)。['y', 'n']
--additional-repo=ADDITIONAL_REPO
インストールに使用する追加の yum リポジトリーの URL のコンマ区切りリスト。

2.6. packstack RHEL 設定

--RH-username=RH_USERNAME
Red Hat Subscription Manager で各サーバーをサブスクライブするには、CONFIG_RH_PW にこれを含めます。
--RHN-satellite-server=RHN_SATELLITE_SERVER
Satellite Server から更新を受信する各サーバーをサブスクライブするには、Satellite サーバーの URL を指定します。また、認証用のユーザー名(CONFIG_SATELLITE_USERNAME)およびパスワード(CONFIG_SATELLITE_PASSWORD)またはアクセスキー(CONFIG_SATELLITE_AKEY)も指定する必要があります。

2.7. Packstack RHN Satellite 設定

--RHN-satellite-username=RHN_SATELLITE_USERNAME
RHN Satellite サーバーで認証するためのユーザー名。Satellite 認証にアクセスキーを使用する場合は、空白のままにします。
--RHN-satellite-password=RHN_SATELLITE_PASSWORD
RHN Satellite サーバーでの認証に使用するパスワード。Satellite 認証にアクセスキーを使用する場合は、これを空白のままにします。
--RHN-satellite-activation-key=RHN_SATELLITE_ACTIVATION_KEY
Satellite サーバーのアクセスキー。Satellite 認証にユーザー名とパスワードを使用する場合は、空白のままにします。
--RHN-satellite-cacert=RHN_SATELLITE_CACERT
Satellite サーバーとの接続が安全であることを確認する認証局の証明書パスまたは URL。デプロイメントで 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. Packstack 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 サービスが検証に使用する CA 証明書のファイル名。
--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. Packstack 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 設定パラメーター

--glance-db-passwd=GLANCE_DB_PASSWD
Image サービス(glance)がデータベースへのアクセスに使用するパスワード。
--glance-ks-passwd=GLANCE_KS_PASSWD
Image サービスが Identity サービスとの認証に使用するパスワード。
--glance-backend=GLANCE_BACKEND
Image サービスのストレージバックエンド(Image サービスがディスクイメージを保存する方法の制御)。有効なオプションは、file または swift (オブジェクトストレージ)です。動作中のバックエンドとして使用するには、Object Storage サービスを有効にする必要があります。そうしないと、packsstack は 'file'. ['file', 'swift'] にフォールバックします。

2.14. Packstack Cinder Config パラメーター

--cinder-db-passwd=CINDER_DB_PASSWD
Block Storage サービス(cinder)がデータベースへのアクセスに使用するパスワード。
--cinder-ks-passwd=CINDER_KS_PASSWD
Block Storage サービスが Identity サービスとの認証に使用するパスワード。
--cinder-backend=CINDER_BACKEND
Block Storage サービスに使用するストレージバックエンド。有効なオプションは lvm、gluster、nfs、vmdk、netapp. ['lvm'、'gluster'、'nfs'、'vmdk'、'netapp'] です。

2.15. Packstack Cinder ボリュームの作成設定パラメーター

--cinder-volumes-create=CINDER_VOLUMES_CREATE
y を指定して、Block Storage ボリュームグループを作成します。つまり、Packstack は /var/lib/cinder に raw ディスクイメージを作成し、ループバックデバイスを使用してマウントします。これは、Block Storage サービスの概念実証のインストールでのテストにのみ使用する必要があります(ファイルベースのボリュームグループは、実稼働環境での使用には適していません)。['y', 'n']

2.16. Packstack Cinder ボリュームサイズの設定パラメーター

--cinder-volumes-size=CINDER_VOLUMES_SIZE
Block Storage ボリュームグループのサイズ。実際のボリュームサイズは、VG メタデータ用の 3% より多くの領域で拡張されます。ボリュームグループのサイズが、コンピュートインスタンスに公開することのできるディスク領域を制限し、/var/lib/cinder に使用するデバイス上で、指定した量が利用できる状態にする点に注意してください。

2.17. Packstack Cinder gluster Config パラメーター

--cinder-gluster-mounts=CINDER_GLUSTER_MOUNTS
マウントする Red Hat Storage (gluster)ボリューム共有の単一またはコンマ区切りリスト。例:'ip-address :/vol-name', 'domain:/vol-name'

2.18. Packstack Cinder NFS Config パラメーター

--cinder-nfs-mounts=CINDER_NFS_MOUNTS
マウントする NFS エクスポートの単一またはコンマ区切りリスト。例:'ip-address:/export-name'

2.19. Packstack Nova オプション

--nova-db-passwd=NOVA_DB_PASSWD
Compute サービス(nova)がデータベースにアクセスするために使用するパスワード。
--nova-ks-passwd=NOVA_KS_PASSWD
Compute サービスが Identity サービスとの認証に使用するパスワード。
--novasched-cpu-allocation-ratio=NOVASCHED_CPU_ALLOCATION_RATIO
仮想と物理 CPU のオーバーコミット率。CPU のオーバーコミットを無効にするには 1.0 を指定します。
--novasched-ram-allocation-ratio=NOVASCHED_RAM_ALLOCATION_RATIO
仮想から物理 RAM へのオーバーコミット率。RAM のオーバーコミットを無効にするには 1.0 を指定します。
--novacompute-migrate-protocol=NOVACOMPUTE_MIGRATE_PROTOCOL
インスタンスの移行に使用されるプロトコル。有効なオプションは tcp および ssh です。デフォルトでは、SSH プロトコルが機能しないように、Compute ユーザーが /sbin/nologin シェルで作成されることに注意してください。SSH プロトコルを有効にするには、コンピュートホストの Compute ユーザーを手動で設定する必要があります。['tcp', 'ssh']
--nova-compute-manager=NOVA_COMPUTE_MANAGER
コンピュートサービスを実行するマネージャー。

2.20. Packstack Nova ネットワークオプション

--novacompute-privif=NOVACOMPUTE_PRIVIF
Compute サーバー上のフラット DHCP 用のプライベートインターフェイス。
--novanetwork-manager=NOVANETWORK_MANAGER
コンピュートネットワークマネージャー. ['^nova\.network\.manager\.\w+Manager$']
--novanetwork-pubif=NOVANETWORK_PUBIF
Compute ネットワークサーバー上のパブリックインターフェイス。
--novanetwork-privif=NOVANETWORK_PRIVIF
コンピュートネットワークサーバー上でのフラット DHCP 用プライベートインターフェイス。
--novanetwork-fixed-range=NOVANETWORK_FIXED_RANGE
フラット DHCP の IP 範囲。['^[\:\.\da- fA-f]+(\/\d+){0,1}$']
--novanetwork-floating-range=NOVANETWORK_FLOATING_RANGE
Floating IP アドレスの IP 範囲。['^[\:\.\da- fA-f]+(\/\d+){0,1}$']
--novanetwork-auto-assign-floating-ip=NOVANETWORK_AUTO_ASSIGN_FLOATING_IP
新しいインスタンスにフローティング IP を自動的に割り当てるには、y を指定します。['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. packstack Neutron の設定

--os-neutron-ks-password=OS_NEUTRON_KS_PASSWORD
OpenStack Networking (neutron)が Identity サービスとの認証に使用するパスワード。
--os-neutron-db-password=OS_NEUTRON_DB_PASSWORD
OpenStack Networking がデータベースにアクセスするために使用するパスワード。
--os-neutron-l3-ext-bridge=OS_NEUTRON_L3_EXT_BRIDGE
OpenStack Networking L3 エージェントが外部トラフィックに使用する Open vSwitch ブリッジの名前(または linuxbridge の場合は空欄)。プロバイダーネットワークを使用して外部トラフィックを処理する場合は、provider を指定します。
--os-neutron-metadata-pw=OS_NEUTRON_METADATA_PW
OpenStack Networking のメタデータエージェントのパスワード。
--os-neutron-lbaas-install=OS_NEUTRON_LBAAS_INSTALL
y を指定して OpenStack Networking の Load- Balancing-as-a-Service (LBaaS)。['y', 'n'] をインストールします。
--os-neutron-metering-agent-install=OS_NEUTRON_METERING_AGENT_INSTALL
y を指定して OpenStack Networking の L3 メータリングエージェント ['y', 'n'] をインストールします。
--neutron-fwaas=NEUTRON_FWAAS
y を指定して、OpenStack Networking の Firewall-as-a-Service (FWaaS)を設定します。['y', 'n']

2.23. packstack Neutron LB エージェントの設定

--os-neutron-lb-interface-mappings=OS_NEUTRON_LB_INTERFACE_MAPPINGS
OpenStack Networking linuxbridge プラグインのインターフェイスマッピングのコンマ区切りリスト。リストの各タプルは、<physical_network>:<net_interface> の形式にする必要があります。例:physnet1:eth1,physnet2:eth2,physnet3:eth3

2.24. packstack Neutron OVS エージェントの設定

--os-neutron-ovs-bridge-mappings=OS_NEUTRON_OVS_BRIDGE_MAPPINGS
OpenStack Networking 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. トンネル向け packstack Neutron OVS エージェントの設定

--os-neutron-ovs-tunnel-if=OS_NEUTRON_OVS_TUNNEL_IF
Open vSwitch トンネルのインターフェイス。packstack は、このハイパーバイザーのトンネルに使用される IP アドレスを、指定されたインターフェイス(例:eth1)にある IP に上書きします。

2.26. VXLAN 用 Packstack Neutron OVS エージェントの設定

--os-neutron-ovs-vxlan-udp-port=OS_NEUTRON_OVS_VXLAN_UDP_PORT
VXLAN UDP ポート。

2.27. Packstack NOVACLIENT 設定パラメーター

2.28. Packstack OpenStack Horizon Config パラメーター

--os-horizon-ssl=OS_HORIZON_SSL
y を指定して、https 経由で Horizon 通信を設定します。['y', 'n']

2.29. Packstack SSL 設定パラメーター

--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
Object Storage サービスが Identity サービスとの認証に使用するパスワード。
--os-swift-storages=OS_SWIFT_STORAGES
Object Storage のストレージデバイスとして使用するデバイスのコンマ区切りリスト。各エントリーは、/path/to/dev の形式を使用する必要があります(たとえば、/dev/vdb を指定すると、オブジェクトストレージストレージデバイスとして /dev/vdb がインストールされます。packstack はファイルシステムを作成しないため、最初にこれを行う必要があります)。空のままにすると、Packstack はテスト用にループバックデバイスを作成します。
--os-swift-storage-zones=OS_SWIFT_STORAGE_ZONES
Object Storage ストレージゾーンの数。この数は、設定されているストレージデバイスの数より大きくすることはできません。
--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
Object Storage ループバックファイルストレージデバイスのサイズ。

2.31. Packstack Heat 設定のパラメーター

--os-heat-mysql-password=OS_HEAT_MYSQL_PASSWORD
オーケストレーションサービスユーザーがデータベースに対して認証するために使用するパスワード。
--os-heat-ks-passwd=OS_HEAT_KS_PASSWD
Orchestration サービスが 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
Orchestration の Identity ドメイン管理ユーザーの名前。
--os-heat-domain-password=OS_HEAT_DOMAIN_PASSWORD
Orchestration の Identity ドメイン管理ユーザーのパスワード。

2.32. Packstack Provisioning デモ設定

--provision-demo=PROVISION_DEMO
デモの使用状況およびテスト用にプロビジョニングする y を指定します。['y', 'n']
--provision-tempest=PROVISION_TEMPEST
y を指定して、テスト用に OpenStack Integration Test Suite (tempest)を設定します。テストスイートでは、OpenStack Networking がインストールされている必要があります。['y', 'n']

2.33. Packstack Provisioning デモ設定

--provision-demo-floatrange=PROVISION_DEMO_FLOATRANGE
Floating IP サブネットの CIDR ネットワークアドレス。
--provision-image-name=PROVISION_IMAGE_NAME
Glance で demo イメージに割り当てられる名前(デフォルトは "cirros")
--provision-image-url=PROVISION_IMAGE_URL
Glance でダウンロードしてプロビジョニングするイメージの URL またはローカルファイルの場所(デフォルトは最新のcirros イメージの URL に設定されます)。
--provision-image-format=PROVISION_IMAGE_FORMAT
demo イメージの形式(デフォルトは qcow2)。
--provision-image-ssh-user=PROVISION_IMAGE_SSH_USER
demo イメージから起動したインスタンスに接続するときに使用するユーザー。

2.34. Packstack Ceilometer Config パラメーター

--ceilometer-ks-passwd=CEILOMETER_KS_PASSWD
アイデンティティーサービスでの Telemetry 認証に使用するパスワード。

2.35. Packstack Apns Config パラメーター

--mongodb-host=uhn_HOST
MongoDB をインストールするサーバーの IP アドレス。

2.36. Packstack POSTSCRIPT Config パラメーター

2.37. Packstack Puppet 設定パラメーター

第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>
ネットワーク API バージョン、default=2 (Env: OS_NETWORK_API_VERSION)
--os-image-api-version <image-api-version>
イメージ API バージョン、デフォルトは=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>
ID API バージョン、default=2 (Env: OS_IDENTITY_API_VERSION)
--os-auth-type <auth-type>
認証タイプを選択します。利用可能なタイプ:v2token、admin_token、v2password、v3password、v3scopedsaml、v3oidcpassword、v3unscopedadfs、token、v3unscopedsaml、osc_password、token_endpointデフォルト:--os- username/--os-token (Env: OS_AUTH_TYPE)に基づいて選択されます。
--os-project-domain-id <auth-project-domain-id>
v3password: v3scopedsaml のあるプロジェクトが含まれるドメイン ID: v3unscopedadfs が含まれるプロジェクトが含まれるドメイン ID: v3unscopedadfs が含まれるプロジェクトが含まれるドメイン ID:v3token: プロジェクトのプロジェクトを含むドメイン ID: v3unscopedsaml のプロジェクトが含まれるドメイン ID: osc_password が含まれるプロジェクトを含むドメイン ID (Env: OS_PROJECT_DOMAIN_ID)
--os-protocol <auth-protocol>
v3oidcpassword: フェデレーション認証に使用されるフェデレーションプロトコルの名前。keystone サービスプロバイダーで設定した対応する名前と一致する必要があります。通常、値は 'saml2' または oidc です。(env: OS_PROTOCOL)
--os-project-name <auth-project-name>
v3password: プロジェクト名のスコープが v3scopedsaml: プロジェクト名を With v3oidcpassword: Project name to scope to with v3unscopedadfs: Project name to scope to With token: Project name to scope to With v3token: Project name to scope to With v3unscopedsaml: Project name to scope to With osc_password: Project name to scope to (Env: OS_PROJECT_NAME)
--os-trust-id <auth-trust-id>
v2token: v2password による信頼 ID: v2password を使用した信頼 ID: v3scopedsaml による信頼 ID: v3oidcpassword による信頼 ID: 信頼 ID: v3unscopedadfs を使用した信頼 ID: 信頼 ID: v3unscopedsaml を使用した信頼 ID: パスワードの信頼 ID: osc_password: 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 with v3scopedsaml: Domain name to scope to scope to with v3unscopedadfs: Domain name to scope to With token: Domain name to scope to scope to With v3token: Domain name to scope to With password: Domain name to scope to with v3unscopedsaml: Domain name to scope to scope to this osc_password: Domain name to scope to (Env: OS_DOMAIN_NAME)
--os-user-domain-id <auth-user-domain-id>
v3password: ユーザーのドメイン ID (パスワード付き): ユーザーのドメイン ID と osc_password: ユーザーのドメイン ID (Env: OS_USER_DOMAIN_ID)
--os-identity-provider-url <auth-identity-provider-url>
v3unscopedadfs の場合:v3unscopedsaml を使用したアイデンティティープロバイダーの URL: アイデンティティープロバイダーの URL (Env: OS_IDENTITY_PROVIDER_URL)
--os-access-token-endpoint <auth-access-token-endpoint>
v3oidcpassword: OpenID Connect プロバイダートークンエンドポイント(Env: OS_ACCESS_TOKEN_ENDPOINT)
--os-domain-id <auth-domain-id>
v3password: Domain ID to scope to v3scopedsaml: Domain ID to scope to scope to With v3unscopedadfs: Domain ID to scope to With token: Domain ID to scope to range to With v3token: Domain ID to scope to With password: Domain ID to scope to this v3unscopedsaml: Domain ID to scope to scope to this osc_password: Domain ID to scope to (Env: OS_DOMAIN_ID)
--os-user-domain-name <auth-user-domain-name>
v3password: ユーザーのドメイン名(osc_password を使用したユーザーのドメイン名:ユーザーのドメイン名(Env: OS_USER_DOMAIN_NAME)
--os-scope <auth-scope>
v3oidcpassword: OP (Env: OS_SCOPE)から要求される OpenID Connect スコープ
--os-user-id <auth-user-id>
v2password: v3password: ユーザー ID とパスワード付きでログインするためのユーザー ID: osc_password: ユーザー ID (Env: OS_USER_ID)
--os-identity-provider <auth-identity-provider>
v3oidcpassword: v3unscopedadfs の場合のアイデンティティープロバイダーの名前:v3unscopedsaml: ID プロバイダーの名前:アイデンティティープロバイダーの名前(Env: OS_IDENTITY_PROVIDER)
--os-username <auth-username>
v2password: v3password を使用してログインするユーザー名:v3oidcpassword を使用したユーザー名:v3unscopedadfs を使用したユーザー名:パスワードのユーザー名:v3unscopedsaml を使用したユーザー名:osc_password: ユーザー名(Env: OS_USERNAME)
--os-auth-url <auth-auth-url>
v2token: v2password を使用した認証 URL: v3password による認証 URL: v3scopedsaml による認証 URL: v3unscopedadfs のある認証 URL: v3unscopedadfs: 認証 URL: v3token を使用した認証 URL: パスワードの認証 URL: v3unscopedsaml: osc_password: 認証 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>
v3password: v3scopedsaml のあるプロジェクトを含むドメイン名:v3unscopedadfs が含まれるプロジェクトが含まれるプロジェクト名:v3unscopedadfs が含まれるプロジェクトが含まれるドメイン名:トークンのプロジェクトを含むドメイン名:v3token: パスワードのプロジェクトを含むドメイン名:v3unscopedsaml: プロジェクトを含むプロジェクトを含むドメイン名(osc_password: プロジェクトを含むドメイン名(Env: OS_PROJECT_DOMAIN_NAME)を含む)
--os-password <auth-password>
v2password: v3password を使用したユーザーのパスワード:v3oidcpassword を使用したユーザーのパスワード:v3unscopedadfs が設定されたパスワード:パスワード:v3unscopedsaml のユーザーのパスワード:osc_password: ユーザーのパスワード(Env: OS_PASSWORD)
--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 の場合:admin_token 付きトークン:v3 scopesaml: トークンを使用して認証する v3 scopesaml: トークンで常に使用されるトークン:token: トークンを使用して認証するには、v3token: トークン:token_endpoint: Token で認証するトークン:token_endpoint: 使用する認証トークン(Env: OS_TOKEN)
--os-project-id <auth-project-id>
v3password: プロジェクト ID が v3scopedsaml: プロジェクト ID をスコープとしてスコープとして v3unscopedadfs: プロジェクト ID をスコープとして利用する v3unscopedadfs: プロジェクト ID を With token: Project ID to scope to With v3token: Project ID to scope to With v3unscopedsaml: プロジェクト ID to scope to With osc_password: Project ID to scope to (Env: OS_PROJECT_ID)
--os-object-api-version <object-api-version>
オブジェクト API バージョン、デフォルト=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 バージョン、デフォルト=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 aggregate add host

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
アグリゲートにホストを追加します。

位置引数

<aggregate>
集約(名前または ID)
<host>
<aggregate> に追加するホスト

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.2. openstack aggregate create

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
新規アグリゲートを作成します。

位置引数

<name>
新しいアグリゲート名

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--zone <availability-zone>
アベイラビリティーゾーン名
--property <key=value>
このアグリゲートに追加するプロパティー (複数のプロパティーを設定する場合は repeat オプション)

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.3. openstack aggregate delete

usage: openstack aggregate delete [-h] <aggregate>
Copy to Clipboard Toggle word wrap
既存のアグリゲートを削除します。

位置引数

<aggregate>
削除するアグリゲート(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.4. openstack aggregate list

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,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.5. openstack aggregate remove host

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
アグリゲートからホストを削除します。

位置引数

<aggregate>
集約(名前または ID)
<host>
<aggregate> から削除するホスト

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.6. OpenStack aggregate set

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
アグリゲートプロパティーを設定します。

位置引数

<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,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.7. openstack aggregate show

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
アグリゲートの詳細を表示します。

位置引数

<aggregate>
表示する集約(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(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,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.9. openstack backup create

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
新規バックアップの作成

位置引数

<volume>
バックアップするボリューム(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--container <container>
オプションのバックアップコンテナー名
--name <name>
バックアップの名前
--description <description>
バックアップの説明

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.10. openstack backup delete

usage: openstack backup delete [-h] <backup> [<backup> ...]
Copy to Clipboard Toggle word wrap
バックアップを削除します。

位置引数

<backup>
削除するバックアップ(ID のみ)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.11. openstack backup list

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,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.12. openstack backup restore

usage: openstack backup restore [-h] <backup> <volume>
Copy to Clipboard Toggle word wrap
復元バックアップ

位置引数

<backup>
復元するバックアップ(ID のみ)
<volume>
復元する volume (名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.13. openstack backup show

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
バックアップの詳細を表示します。

位置引数

<backup>
表示するバックアップ(ID のみ)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.14. openstack baremetal introspection rule delete

usage: openstack baremetal introspection rule delete [-h] uuid
Copy to Clipboard Toggle word wrap
イントロスペクションルールを削除します。

位置引数

uuid
ルールの UUID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.15. openstack baremetal introspection rule import

usage: openstack baremetal introspection rule import [-h] file
Copy to Clipboard Toggle word wrap
json ファイルから 1 つまたは複数のイントロスペクションルールをインポートします。

位置引数

file
インポートする JSON ファイル。1 つまたは複数のルールを含めることができます。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.16. openstack baremetal introspection rule list

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,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.17. openstack baremetal introspection rule purge

usage: openstack baremetal introspection rule purge [-h]
Copy to Clipboard Toggle word wrap
すべてのイントロスペクションルールを破棄します。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.18. openstack baremetal introspection rule show

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
イントロスペクションルールを表示します。

位置引数

uuid
ルールの UUID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(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
イントロスペクションを開始します。

位置引数

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 introspection status

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
イントロスペクションのステータスを取得します。

位置引数

uuid
ベアメタルノードの UUID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.21. openstack catalog list

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,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.22. openstack catalog show

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
サービスカタログの詳細を表示します。

位置引数

<service>
表示するサービス (タイプまたは名前)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(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,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.24. OpenStack Compute エージェントの作成

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
コンピュートエージェントコマンドを作成します。

位置引数

<os>
OS のタイプ
<architecture>
アーキテクチャーのタイプ
<version>
バージョン
<url>
URL
<md5hash>
MD5 hash
<hypervisor>
ハイパーバイザーの種別

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.25. openstack compute agent delete

usage: openstack compute agent delete [-h] <id>
Copy to Clipboard Toggle word wrap
コンピュートエージェントコマンドを削除します。

位置引数

<id>
削除するエージェントの ID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.26. openstack compute agent list

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>
ハイパーバイザーの種別

出力フォーマッター

出力フォーマット設定オプション
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.27. OpenStack compute agent set

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
コンピュートエージェントコマンドを設定します。

位置引数

<id>
エージェントの ID
<version>
エージェントのバージョン
<url>
URL
<md5hash>
MD5 hash

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.28. OpenStack Compute サービスリスト

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
サービスをリスト表示するコマンド

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--host <host>
ホスト名
--service <service>
サービスの名前

出力フォーマッター

出力フォーマット設定オプション
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.29. OpenStack compute service set

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
サービスコマンドの設定

位置引数

<host>
ホスト名
<service>
サービスの名前

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--enable
サービスの有効化
--disable
サービスの無効化

出力フォーマッター

出力フォーマット設定オプション
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.30. openstack configuration show

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,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.31. openstack console log show

usage: openstack console log show [-h] [--lines <num-lines>] <server>
Copy to Clipboard Toggle word wrap
サーバーのコンソール出力を表示します。

位置引数

<server>
コンソールログを表示するサーバー(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--lines <num-lines>
ログの末尾から表示する行数 (デフォルト=all)。

3.3.32. openstack console url show

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 を表示します。

位置引数

<server>
Server to show URL (名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--novnc
noVNC コンソール URL を表示します(デフォルト)
--xvpvnc
xpvnc コンソール URL を表示します。
--spice
SPICE コンソール URL の表示

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.33. openstack container create

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
新規コンテナーを作成します。

位置引数

<container-name>
新しいコンテナー名

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.34. openstack container delete

usage: openstack container delete [-h] <container> [<container> ...]
Copy to Clipboard Toggle word wrap
コンテナーを削除します。

位置引数

<container>
削除するコンテナー

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.35. openstack container list

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>
ページングのアンカー
--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,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.36. openstack container save

usage: openstack container save [-h] <container>
Copy to Clipboard Toggle word wrap
コンテナーのコンテンツをローカルで保存します。

位置引数

<container>
保存するコンテナー

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.37. openstack container show

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
コンテナーの詳細を表示します。

位置引数

<container>
表示するコンテナー

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.38. openstack dataprocessing data source create

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
データソースを作成します。

位置引数

<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,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.39. openstack dataprocessing data source delete

usage: openstack dataprocessing data source delete [-h] <data-source>
Copy to Clipboard Toggle word wrap
データソースの削除

位置引数

<data-source>
削除するデータソースの名前または ID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.40. OpenStack dataprocessing data source list

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、または maprfs)のデータソースを一覧表示します。

出力フォーマッター

出力フォーマット設定オプション
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.41. openstack dataprocessing data source show

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
データソースの詳細を表示します。

位置引数

<data-source>
表示するデータソースの名前または ID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.42. openstack dataprocessing プラグイン設定の取得

usage: openstack dataprocessing plugin configs get [-h] [--file <file>] <plugin> <version>
Copy to Clipboard Toggle word wrap
プラグイン設定の取得

位置引数

<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,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.44. openstack dataprocessing plugin show

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
プラグインの詳細を表示します。

位置引数

<plugin>
表示するプラグインの名前

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.45. openstack ec2 credentials create

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,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.46. openstack ec2 credentials delete

usage: openstack ec2 credentials delete [-h] [--user <user>] <access-key>
Copy to Clipboard Toggle word wrap
EC2 認証情報を削除します。

位置引数

<access-key>
認証情報アクセスキー

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--user <user>
ユーザーの認証情報を削除します(名前または ID)。

3.3.47. OpenStack ec2 credentials list

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,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.48. openstack ec2 credentials show

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 認証情報の詳細を表示します。

位置引数

<access-key>
認証情報アクセスキー

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--user <user>
ユーザーの認証情報を表示します(名前または ID)。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.49. openstack endpoint create

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
新規エンドポイントを作成します。

位置引数

<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,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.50. openstack endpoint delete

usage: openstack endpoint delete [-h] <endpoint-id>
Copy to Clipboard Toggle word wrap
エンドポイントの削除

位置引数

<endpoint-id>
削除するエンドポイント ID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.51. openstack endpoint list

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,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.52. openstack endpoint show

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
エンドポイントの詳細を表示します。

位置引数

<endpoint-id>
表示するエンドポイント ID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.53. openstack extension list

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
ネットワーク API の拡張機能を一覧表示します。
--volume
Volume API の拡張機能を一覧表示します。
--long
出力の追加フィールドをリスト表示します。

出力フォーマッター

出力フォーマット設定オプション
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,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
新規フレーバーを作成します。

位置引数

<flavor-name>
新規フレーバー名

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--id <id>
一意のフレーバー ID。auto は UUID を作成します(デフォルト:auto)
--ram <size-mb>
メモリーのサイズ(MB 単位)
--disk <size-gb>
GB 単位のディスクサイズ(デフォルトは 0G)
--ephemeral <size-gb>
GB 単位の一時ディスクサイズ(デフォルトは 0G)
--swap <size-gb>
GB 単位の swap 領域サイズ(デフォルトは 0G)
--vcpus <vcpus>
仮想 CPU の数 (デフォルトは 1)
--rxtx-factor <factor>
RX/TX 係数(デフォルトは 1)
--public
他のプロジェクトでフレーバーが利用できます (デフォルト)
--private
他のプロジェクトでフレーバーは利用できません。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.55. openstack flavor delete

usage: openstack flavor delete [-h] <flavor>
Copy to Clipboard Toggle word wrap
フレーバーを削除します。

位置引数

<flavor>
削除するフレーバー(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.56. openstack flavor list

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,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.57. openstack flavor set

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
フレーバーのプロパティーを設定します。

位置引数

<flavor>
変更するフレーバー(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--property <key=value>
このフレーバーに追加または変更する属性 (複数の属性を設定する場合はオプションを繰り返し使用します)

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(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
フレーバーの詳細を表示します。

位置引数

<flavor>
表示するフレーバー(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(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>
変更するフレーバー(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--property <key>
フレーバーから削除するプロパティー (複数プロパティーの設定を解除する場合はオプションを繰り返し使用します)

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.60. openstack host list

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
list host command

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--zone <zone>
アベイラビリティーゾーンのホストのみを返します。

出力フォーマッター

出力フォーマット設定オプション
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.61. openstack host show

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
ホストコマンドを表示します。

位置引数

<host>
ホスト名

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.62. openstack hypervisor list

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> 部分文字列を使用してハイパーバイザーをフィルタリングします

出力フォーマッター

出力フォーマット設定オプション
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.63. openstack hypervisor show

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>
表示するハイパーバイザー(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.64. openstack hypervisor stats show

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
ハイパーバイザーの統計情報を表示します。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(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
プロジェクトをイメージに関連付けます。

位置引数

<image>
共有するイメージ(名前または ID)
<project>
イメージに関連付けるプロジェクト(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--project-domain <project-domain>
プロジェクトが属するドメイン(名前または ID)。プロジェクト名の競合が発生した場合に、使用できます。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.66. openstack image create

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
イメージを作成/アップロードします。

位置引数

<image-name>
新しいイメージ名

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--id <id>
予約するイメージ ID
--container-format <container-format>
イメージコンテナー形式(デフォルト:bare)
--disk-format <disk-format>
イメージディスクの形式(デフォルト:raw)
--min-disk <disk-gb>
イメージのブートに必要な最小ディスクサイズ (ギガバイト単位)
--min-ram <ram-mb>
イメージのブートに必要な最小 RAM サイズ(メガバイト単位)
--file <file>
ローカルファイルからイメージをアップロードします。
--protected
イメージが削除されないようにします。
--unprotected
イメージの削除を許可します (デフォルト)
--public
イメージは一般に公開されます。
--private
イメージは一般に公開されません (デフォルト)。
--property <key=value>
このイメージにプロパティーを設定します (複数のプロパティーを設定する場合はオプションを繰り返し使用します)。
--tag <tag>
このイメージにタグを設定します (複数のタグを設定する場合はオプションを繰り返し使用します)。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.67. openstack image delete

usage: openstack image delete [-h] <image> [<image> ...]
Copy to Clipboard Toggle word wrap
イメージを削除します。

位置引数

<image>
削除するイメージ(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.68. openstack image list

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 または desc)で出力を並べ替えます。デフォルトは、複数のキーおよび方向をコンマで区切って指定できます。

出力フォーマッター

出力フォーマット設定オプション
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,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
イメージとプロジェクトの関連付けを解除します。

位置引数

<image>
共有解除するイメージ(名前または ID)
<project>
イメージの関連付けを解除するプロジェクト(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--project-domain <project-domain>
プロジェクトが属するドメイン(名前または ID)。プロジェクト名の競合が発生した場合に、使用できます。

3.3.70. openstack image save

usage: openstack image save [-h] [--file <filename>] <image>
Copy to Clipboard Toggle word wrap
イメージをローカルに保存します。

位置引数

<image>
保存するイメージ(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--file <filename>
ダウンロードしたイメージを保存するファイル名 (デフォルト:stdout)

3.3.71. openstack image set

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
イメージ属性を設定します。

位置引数

<image>
変更するイメージ(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--name <name>
新しいイメージ名
--architecture <architecture>
オペレーティングシステムのアーキテクチャー
--protected
イメージが削除されないようにします。
--unprotected
イメージの削除を許可します (デフォルト)
--public
イメージは一般に公開されます。
--private
イメージは一般に公開されません (デフォルト)。
--instance-uuid <instance_uuid>
このイメージの作成に使用されるインスタンスの ID
--min-disk <disk-gb>
イメージのブートに必要な最小ディスクサイズ (ギガバイト単位)
--kernel-id <kernel-id>
AMI 形式のイメージをブートする際にカーネルとして使用する必要のある Glance のイメージの ID
--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>
AMI 形式のイメージをブートする際に ramdisk として使用する必要のある Glance に保管されているイメージの ID
--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,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(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
イメージの詳細を表示します。

位置引数

<image>
表示するイメージ(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(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 コマンドの追加

位置引数

<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 コマンドを削除します。

位置引数

<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 をサーバーに追加

位置引数

<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 を作成します。

位置引数

<pool>
Floating IP の取得元のプール

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(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 の削除

位置引数

<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
Floating IP の一覧表示

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,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,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
サーバーから floating-ip を削除します。

位置引数

<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
新規公開鍵の作成

位置引数

<name>
新しい公開鍵名

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--public-key <file>
追加する公開鍵のファイル名

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.82. openstack keypair delete

usage: openstack keypair delete [-h] <key>
Copy to Clipboard Toggle word wrap
公開鍵の削除

位置引数

<key>
削除する公開鍵

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.83. openstack key 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,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
公開鍵の詳細を表示します。

位置引数

<key>
表示する公開鍵

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--public-key
ベア公開鍵のみを表示します

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.85. openstack limits show

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,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.86. openstack module list

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,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.87. openstack network create

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
新規ネットワークを作成します。

位置引数

<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,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.88. openstack network delete

usage: openstack network delete [-h] <network> [<network> ...]
Copy to Clipboard Toggle word wrap
ネットワークを削除します。

位置引数

<network>
削除するネットワーク(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.89. openstack network list

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,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.90. openstack network set

usage: openstack network set [-h] [--name <name>] [--enable | --disable] [--share | --no-share] <network>
Copy to Clipboard Toggle word wrap
ネットワークの属性を設定します。

位置引数

<network>
変更するネットワーク(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--name <name>
ネットワーク名を設定します。
--enable
ネットワークを有効有効にします。
--disable
ネットワークを無効にします。
--share
プロジェクト間でネットワークを共有します。
--no-share
プロジェクト間でネットワークを共有しません。

3.3.91. openstack network show

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
ネットワーク情報を表示します。

位置引数

<network>
表示するネットワーク(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.92. openstack object create

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
オブジェクトをコンテナーにアップロードします。

位置引数

<container>
新規オブジェクトのコンテナー
<filename>
アップロードするローカルファイル名

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.93. openstack object delete

usage: openstack object delete [-h] <container> <object> [<object> ...]
Copy to Clipboard Toggle word wrap
コンテナーからオブジェクトを削除します。

位置引数

<container>
<container> からオブジェクトを削除します。
<object>
削除するオブジェクト

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.94. openstack object list

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
オブジェクトのリスト表示

位置引数

<container>
リスト表示するコンテナー

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--prefix <prefix>
<prefix> を使用してリストをフィルタリングします
--delimiter <delimiter>
<delimiter> でアイテムをロールアップします。
--marker <marker>
ページングのアンカー
--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,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.95. openstack object save

usage: openstack object save [-h] [--file <filename>] <container> <object>
Copy to Clipboard Toggle word wrap
ローカルにオブジェクトを保存します。

位置引数

<container>
<container> から <object> をダウンロードします。
<object>
保存するオブジェクト

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--file <filename>
宛先ファイル名(デフォルトはオブジェクト名)

3.3.96. openstack object show

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
オブジェクトの詳細を表示します。

位置引数

<container>
<container> からの <object> を表示します。
<object>
表示するオブジェクト

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.97. openstack overcloud image build

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
オーバークラウドのイメージをビルドします。

オプションの引数

-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 trunk リポジトリーの使用
--Delorean-trunk-repo DELOREAN_TRUNK_REPO
トランクリポジトリーの URL
--Delorean-repo-file DELOREAN_REPO_FILE
delorean リポジトリー設定ファイルのファイル名
--overcloud-full-dib-extra-args OVERCLOUD_FULL_DIB_EXTRA_ARGS
オーバークラウドの完全な追加引数
--overcloud-full-name OVERCLOUD_FULL_NAME
オーバークラウドのフルイメージの名前
--fedora-user-name FEDORA_USER_NAME
Fedora ユーザーイメージの名前
--agent-name AGENT_NAME
IPA ramdisk イメージの名前
--deploy-name DEPLOY_NAME
デプロイメント ramdisk イメージの名前
--discovery-name DISCOVERY_NAME
Discovery 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>
Image Builderdib の 1 つ

3.3.98. openstack overcloud image upload

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
既存のイメージファイルからオーバークラウドの glance イメージを作成します。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--image-path IMAGE_PATH
イメージファイルが含まれるディレクトリーへのパス
--os-image OS_IMAGE
openstack disk image filename
--http-boot HTTP_BOOT
イメージの検出のルートディレクトリー
--update-existing
イメージがすでに存在する場合は更新します。

3.3.99. openstack overcloud netenv validate

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 node delete

usage: openstack overcloud node delete [-h] [--stack STACK] [--templates [TEMPLATES]] [-e <HEAT ENVIRONMENT FILE>] <node> [<node> ...]
Copy to Clipboard Toggle word wrap
オーバークラウドノードを削除します。

位置引数

<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 update stack

usage: openstack overcloud update stack [-h] --templates [TEMPLATES] [-i] [-a] [-e <HEAT ENVIRONMENT FILE>] [stack]
Copy to Clipboard Toggle word wrap
オーバークラウドノードのパッケージを更新する

位置引数

stack
スケーリングする 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 project create

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
新規プロジェクトを作成します。

位置引数

<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,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.103. openstack project delete

usage: openstack project delete [-h] <project> [<project> ...]
Copy to Clipboard Toggle word wrap
プロジェクトを削除します。

位置引数

<project>
削除するプロジェクト(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.104. openstack project list

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,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.105. openstack project set

usage: openstack project set [-h] [--name <name>] [--description <description>] [--enable | --disable] [--property <key=value>] <project>
Copy to Clipboard Toggle word wrap
プロジェクトの属性を設定します。

位置引数

<project>
変更するプロジェクト(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--name <name>
プロジェクト名を設定します。
--description <description>
プロジェクトの説明を設定します。
--enable
プロジェクトを有効にします。
--disable
プロジェクトを無効にします。
--property <key=value>
プロジェクトプロパティーを設定します(複数の属性を設定する場合はオプションを繰り返し使用します)

3.3.106. openstack project show

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
プロジェクトの詳細を表示します。

位置引数

<project>
表示するプロジェクト(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.107. openstack ptr record list

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,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.108. openstack ptr record set

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 レコードを設定します。

位置引数

floatingip_id
Floating IP ID
ptrdname
PTRD Name

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--description DESCRIPTION
説明
--no-description
--ttl TTL TTL
--no-ttl

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.109. openstack ptr record show

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 レコードの詳細を表示します。

位置引数

floatingip_id
Floating IP ID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.110. openstack ptr record unset

usage: openstack ptr record unset [-h] floatingip_id
Copy to Clipboard Toggle word wrap
floatingip ptr レコードの設定を解除します。

位置引数

floatingip_id
Floating IP ID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.111. openstack quota set

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
プロジェクトまたはクラスのクォータを設定します。

位置引数

<project/class>
このプロジェクトまたはクラスのクォータを設定します(名前/ID)。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--class
<class> のクォータを設定します。
--properties <properties>
properties クォータの新しい値
--ram <ram>
ram クォータの新しい値
--secgroup-rules <secgroup-rules>
secgroup-rules クォータの新しい値
--instances <instances>
instances クォータの新しい値
--key-pairs <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>
cores クォータの新しい値
--injected-path-size <injected-path-size>
injected-path-size クォータの新しい値
--gigabytes <gigabytes>
gigabytes クォータの新しい値
--volumes <volumes>
volumes クォータの新しい値
--snapshots <snapshots>
snapshots クォータの新しい値
--volume-type <volume-type>
特定の <volume-type> のクォータを設定します。

3.3.112. openstack quota show

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
プロジェクトまたはクラスのクォータを表示します。

位置引数

<project/class>
このプロジェクトまたはクラスを表示します(名前/ID)。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--class
<class> のクォータを表示します。
--default
<project> のデフォルトクォータを表示します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(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
新規レコードセットを作成します

位置引数

zone_id
ゾーン ID
name
recordset 名

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--records RECORDS [RECORDS ...]
recordset レコード
--type TYPE
recordset タイプ
--ttl TTL
Time To Live (秒)
--description DESCRIPTION
説明

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.114. openstack recordset delete

usage: openstack recordset delete [-h] zone_id id
Copy to Clipboard Toggle word wrap
レコードセットを削除します。

位置引数

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
レコードセットをリスト表示します。

位置引数

zone_id
ゾーン ID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.116. openstack recordset

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
レコードセットの属性を設定します。

位置引数

zone_id
ゾーン ID
id
recordset ID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--name NAME
recordset 名
--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,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(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
レコードセットの詳細を表示します。

位置引数

zone_id
ゾーン ID
id
recordset ID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.118. openstack role add

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
ロールを project:user に追加します。

位置引数

<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,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.119. openstack role create

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
新規ロールを作成します。

位置引数

<name>
新しいロール名

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--or-show
既存のロールを返します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.120. openstack role delete

usage: openstack role delete [-h] <role> [<role> ...]
Copy to Clipboard Toggle word wrap
ロールを削除します。

位置引数

<role>
削除するロール(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.121. openstack role list

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,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
プロジェクト:ユーザーからロールを削除します。

位置引数

<role>
削除するロール(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--project <project>
<project>を含めます(名前または ID)。
--user <user>
<user>を含めます(名前または ID)。

3.3.123. openstack role show

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
ロールの詳細を表示します。

位置引数

<role>
表示するロール(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.124. openstack security group create

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
新しいセキュリティーグループを作成します。

位置引数

<name>
新しいセキュリティーグループ名

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--description <description>
セキュリティーグループの説明

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.125. openstack security group delete

usage: openstack security group delete [-h] <group>
Copy to Clipboard Toggle word wrap
セキュリティーグループを削除します。

位置引数

<group>
削除するセキュリティーグループの名前または ID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.126. openstack security group list

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,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.127. openstack security group rule create

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
新しいセキュリティーグループルールを作成します。

位置引数

<group>
このセキュリティーグループにルールを作成します。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--proto <proto> IP
protocol (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,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.128. openstack security group rule delete

usage: openstack security group rule delete [-h] <rule>
Copy to Clipboard Toggle word wrap
セキュリティーグループルールを削除します。

位置引数

<rule>
削除するセキュリティーグループルール ID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.129. openstack security group rule list

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
セキュリティーグループルールの一覧を表示します。

位置引数

<group>
このセキュリティーグループのルールを一覧表示します。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.130. openstack security group set

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
セキュリティーグループの属性を設定します。

位置引数

<group>
変更するセキュリティーグループの名前または ID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--name <new-name>
新しいセキュリティーグループ名
--description <description>
新しいセキュリティーグループ名

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.131. openstack security group show

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
特定のセキュリティーグループを表示します。

位置引数

<group>
変更するセキュリティーグループの名前または ID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.132. openstack server add security group

usage: openstack server add security group [-h] <server> <group>
Copy to Clipboard Toggle word wrap
セキュリティーグループをサーバーに追加します。

位置引数

<server>
サーバー(名前または ID)
<group>
追加するセキュリティーグループ(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.133. openstack server add volume

usage: openstack server add volume [-h] [--device <device>] <server> <volume>
Copy to Clipboard Toggle word wrap
サーバーにボリュームを追加します。

位置引数

<server>
サーバー(名前または ID)
<volume>
追加するボリューム(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--device <device>
ボリュームのサーバーの内部デバイス名

3.3.134. openstack server create

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
新しいサーバーを作成します。

位置引数

<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>
マップブロックデバイス。map は <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: この UUID を使用して NIC をネットワークに接続します。port-id: この UUID を使用して NIC をポートにアタッチします。v4-fixed-ip: NIC 用の IPv4 固定アドレス(オプション)、v6-fixed-ip: NIC 用 IPv6 固定アドレス(オプション)。
--hint <key=value>
スケジューラーのヒント (オプションの機能拡張)
--config-drive <config-drive-volume>|True
指定されたボリュームをコンフィグドライブとして使用するか、True で一時ドライブを使用します。
--min <count>
起動するサーバーの最小数 (デフォルトは 1)
--max <count>
起動するサーバーの最大数 (デフォルトは 1)
--wait
ビルドが完了するまで待ちます。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.135. openstack server delete

usage: openstack server delete [-h] [--wait] <server> [<server> ...]
Copy to Clipboard Toggle word wrap
サーバーを削除します。

位置引数

<server>
削除するサーバー(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--wait
削除が完了するのを待ちます。

3.3.136. openstack server image create

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
稼働中のサーバーから新規ディスクイメージを作成します。

位置引数

<server>
サーバー(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--name <image-name>
新しいイメージの名前(デフォルトはサーバー名)。
--wait
イメージの作成が完了するまで待ちます。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.137. openstack server list

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,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.138. openstack server lock

usage: openstack server lock [-h] <server>
Copy to Clipboard Toggle word wrap
サーバーをロックします。管理者以外のユーザーはアクションを実行できなくなります。

位置引数

<server>
サーバー(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.139. openstack server migrate

usage: openstack server migrate [-h] [--live <hostname>] [--shared-migration | --block-migration] [--disk-overcommit | --no-disk-overcommit] [--wait] <server>
Copy to Clipboard Toggle word wrap
サーバーを異なるホストに移行します。

位置引数

<server>
サーバー(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--live <hostname>
ターゲットホスト名
--shared-migration
共有ライブマイグレーションを実行します (デフォルト)。
--block-migration
ブロックライブマイグレーションを実行します。
--disk-overcommit
移行先ホストでディスクのオーバーコミットを許可します。
--no-disk-overcommit
移行先ホストでディスクのオーバーコミットを行いません (デフォルト)。
--wait
サイズ変更が完了するまで待ちます。

3.3.140. openstack server pause

usage: openstack server pause [-h] <server>
Copy to Clipboard Toggle word wrap
サーバーの一時停止

位置引数

<server>
サーバー(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.141. openstack server reboot

usage: openstack server reboot [-h] [--hard | --soft] [--wait] <server>
Copy to Clipboard Toggle word wrap
サーバーのハードまたはソフトリブートを実行します。

位置引数

<server>
サーバー(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--hard
ハードリブートを実行します。
--soft
ソフトリブートを実行します。
--wait
リブートが完了するまで待ちます。

3.3.142. openstack server rebuild

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
サーバーを再ビルドします。

位置引数

<server>
サーバー(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--image <image>
このイメージからサーバーを再作成する
--password <password>
再ビルドしたインスタンスのパスワードを設定します。
--wait
再ビルドが完了するまで待ちます。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.143. openstack server remove security group

usage: openstack server remove security group [-h] <server> <group>
Copy to Clipboard Toggle word wrap
サーバーからセキュリティーグループを削除します。

位置引数

<server>
使用するサーバーの名前または ID
<group>
サーバーから削除するセキュリティーグループの名前または ID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.144. openstack server remove volume

usage: openstack server remove volume [-h] <server> <volume>
Copy to Clipboard Toggle word wrap
サーバーからボリュームを削除します。

位置引数

<server>
サーバー(名前または ID)
<volume>
削除するボリューム(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.145. openstack server rescue

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
サーバーをレスキューモードに切り替えます。

位置引数

<server>
サーバー(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.146. openstack server resize

usage: openstack server resize [-h] [--flavor <flavor> | --confirm | --revert] [--wait] <server>
Copy to Clipboard Toggle word wrap
サーバーを新規フレーバーにスケーリングします。

位置引数

<server>
サーバー(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--flavor <flavor>
サーバーを指定したフレーバーにサイズ変更します。
--confirm
サーバーのサイズ変更が完了したことを確認します。
--revert
サーバーの状態をサイズ変更前に復元します。
--wait
サイズ変更が完了するまで待ちます。

3.3.147. openstack server resume

usage: openstack server resume [-h] <server>
Copy to Clipboard Toggle word wrap
サーバーの再開

位置引数

<server>
サーバー(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.148. openstack server set

usage: openstack server set [-h] [--name <new-name>] [--root-password] [--property <key=value>] <server>
Copy to Clipboard Toggle word wrap
サーバー属性を設定します。

位置引数

<server>
サーバー(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--name <new-name>
新しいサーバー名
--root-password
新しい root パスワードを設定します (対話式のみ)。
--property <key=value>
このサーバーに追加/変更する属性 (複数の属性を設定する場合はオプションを繰り返し使用します)

3.3.149. openstack server show

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
サーバーの詳細を表示します。

位置引数

<server>
サーバー(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--diagnostics
サーバーの診断情報を表示します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.150. openstack server 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 で接続

位置引数

<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 server suspend

usage: openstack server suspend [-h] <server>
Copy to Clipboard Toggle word wrap
サーバーの一時停止

位置引数

<server>
サーバー(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.152. openstack server unlock

usage: openstack server unlock [-h] <server>
Copy to Clipboard Toggle word wrap
サーバーのロック解除

位置引数

<server>
サーバー(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.153. openstack server unpause

usage: openstack server unpause [-h] <server>
Copy to Clipboard Toggle word wrap
Unpause server

位置引数

<server>
サーバー(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.154. openstack server unrescue

usage: openstack server unrescue [-h] <server>
Copy to Clipboard Toggle word wrap
レスキューモードからサーバーを復元します。

位置引数

<server>
サーバー(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.155. openstack server unset

usage: openstack server unset [-h] [--property <key>] <server>
Copy to Clipboard Toggle word wrap
サーバー属性の設定を解除します。

位置引数

<server>
サーバー(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--property <key>
サーバーから削除するプロパティーキー(複数の値の設定を解除する場合は繰り返し)

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
新規サービスを作成します。

位置引数

<type>
新しいサービスの種別 (compute、image、identity、volume など)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--name <name>
新しいサービス名
--description <description>
新しいサービスの説明

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.157. openstack service delete

usage: openstack service delete [-h] <service>
Copy to Clipboard Toggle word wrap
サービスの削除

位置引数

<service>
削除するサービス(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.158. openstack service list

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,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.159. openstack service show

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
サービスの詳細を表示します。

位置引数

<service>
表示するサービス(タイプ、名前、または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--catalog
サービスカタログ情報を表示します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.160. openstack snapshot create

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
新規スナップショットの作成

位置引数

<volume>
スナップショットへのボリューム(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--name <name>
スナップショットの名前
--description <description>
スナップショットの説明
--force
インスタンスに割り当てられたスナップショットを作成します。デフォルトは False です。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.161. openstack snapshot delete

usage: openstack snapshot delete [-h] <snapshot> [<snapshot> ...]
Copy to Clipboard Toggle word wrap
スナップショットを削除します。

位置引数

<snapshot>
削除するスナップショット(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.162. openstack snapshot list

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,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.163. openstack snapshot set

usage: openstack snapshot set [-h] [--name <name>] [--description <description>] [--property <key=value>] <snapshot>
Copy to Clipboard Toggle word wrap
スナップショットプロパティーを設定します。

位置引数

<snapshot>
変更するスナップショット(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--name <name>
新しいスナップショット名
--description <description>
新しいスナップショットの説明
--property <key=value>
このスナップショットに追加/変更する属性 (複数の属性を設定する場合はオプションを繰り返し使用します)

3.3.164. openstack snapshot show

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
スナップショットの詳細を表示します。

位置引数

<snapshot>
表示するスナップショット(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.165. openstack snapshot unset

usage: openstack snapshot unset [-h] --property <key> <snapshot>
Copy to Clipboard Toggle word wrap
スナップショットプロパティーの設定を解除します。

位置引数

<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
名前
--description DESCRIPTION
説明

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.167. openstack tld delete

usage: openstack tld delete [-h] id
Copy to Clipboard Toggle word wrap
tld を削除します。

位置引数

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
tld をリスト表示します。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,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 の属性を設定します。

位置引数

id
TLD ID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--name NAME TLD
名前
--description DESCRIPTION
説明
--no-description

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(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 の詳細を表示します。

位置引数

id
TLD ID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(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,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.172. OpenStack トークンの取り消し

usage: openstack token revoke [-h] <token>
Copy to Clipboard Toggle word wrap
既存のトークンを取り消します。

位置引数

<token>
削除するトークン

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.173. openstack undercloud install

usage: openstack undercloud install [-h]
Copy to Clipboard Toggle word wrap
アンダークラウドをインストールおよび設定します。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.174. openstack usage list

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>
使用範囲の終了日 (例:2012-01-20)(デフォルト: 明日)

出力フォーマッター

出力フォーマット設定オプション
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.175. openstack usage show

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>
使用範囲の終了日 (例:2012-01-20)(デフォルト: 明日)

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.176. openstack user create

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
新規ユーザーを作成します。

位置引数

<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,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.177. openstack user delete

usage: openstack user delete [-h] <user> [<user> ...]
Copy to Clipboard Toggle word wrap
ユーザーを削除します。

位置引数

<user>
削除するユーザー(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.178. openstack user list

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,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.179. openstack user role list

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
ユーザーロール割り当ての一覧を表示します。

位置引数

<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,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.180. openstack user set

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
ユーザーの属性を設定します。

位置引数

<user>
変更するユーザー(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--name <name>
ユーザー名を設定します。
--project <project>
デフォルトのプロジェクトを設定する(名前または ID)
--password <user-password>
ユーザーのパスワードを設定します。
--password-prompt
パスワードを対話的に要求します。
--email <email-address>
ユーザーのメールアドレスを設定します。
--enable
ユーザーを有効にします (デフォルト)。
--disable
ユーザーを無効にします。

3.3.181. openstack user show

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
ユーザーの詳細を表示します。

位置引数

<user>
表示するユーザー(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.182. openstack volume create

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
新規ボリュームを作成します。

位置引数

<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>
クローンを作成する volume (名前または ID)
--property <key=value>
このボリュームに属性を設定します (複数の属性を設定する場合はオプションを繰り返し使用します)

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.183. openstack volume delete

usage: openstack volume delete [-h] [--force] <volume> [<volume> ...]
Copy to Clipboard Toggle word wrap
ボリュームを削除します。

位置引数

<volume>
削除するボリューム(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--force
状態に関係なく、ボリュームを強制的に削除しようとします (デフォルトは False)。

3.3.184. openstack volume list

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,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.185. openstack volume qos associate

usage: openstack volume qos associate [-h] <qos-spec> <volume-type>
Copy to Clipboard Toggle word wrap
QoS 仕様をボリューム種別に関連付けます。

位置引数

<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 仕様を作成します。

位置引数

<name>
新しい QoS 仕様名

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--consumer <consumer>
QoS のコンシューマー。有効なコンシューマー:バックエンド、フロントエンドの両方(デフォルトは both)
--property <key=value>
QoS 仕様プロパティーを設定します(複数の属性を設定する場合はオプションを繰り返し使用します)

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(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 仕様を削除します。

位置引数

<qos-spec>
削除する QoS 仕様(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.188. openstack volume qos disassociate

usage: openstack volume qos disassociate [-h] [--volume-type <volume-type> | --all] <qos-spec>
Copy to Clipboard Toggle word wrap
ボリューム種別から QoS 仕様の関連付けを解除します。

位置引数

<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,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 仕様の属性を設定します。

位置引数

<qos-spec>
変更する QoS 仕様(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--property <key=value>
この QoS 仕様を追加または変更するプロパティー(複数のプロパティーを設定する場合はオプションを繰り返し使用します)

3.3.191. openstack volume 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 仕様の詳細を表示します。

位置引数

<qos-spec>
表示する QoS 仕様(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(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 仕様の属性の設定を解除します。

位置引数

<qos-spec>
変更する QoS 仕様(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--property <key>
QoS 仕様から削除するプロパティー。(複数のプロパティーの設定を解除する場合はオプションを繰り返し使用します)

3.3.193. OpenStack volume set

usage: openstack volume set [-h] [--name <name>] [--description <description>] [--size <size>] [--property <key=value>] <volume>
Copy to Clipboard Toggle word wrap
ボリュームの属性を設定します。

位置引数

<volume>
変更するボリューム(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--name <name>
新規ボリューム名
--description <description>
新規ボリュームの説明
--size <size>
ボリュームサイズ(GB 単位)の拡張
--property <key=value>
このボリュームに追加または変更するための属性(複数の属性を設定する場合はオプションを繰り返し使用します)

3.3.194. openstack volume show

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
ボリュームの詳細を表示します。

位置引数

<volume>
表示するボリューム(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.195. openstack volume type 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
新規ボリューム種別を作成します。

位置引数

<name>
新しいボリューム種別名

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--property <key=value>
このボリューム種別に追加する属性(複数の属性を設定する場合はオプションを繰り返し使用します)

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.196. openstack volume type delete

usage: openstack volume type delete [-h] <volume-type>
Copy to Clipboard Toggle word wrap
ボリューム種別の削除

位置引数

<volume-type>
削除するボリューム種別(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.197. openstack volume type list

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,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

3.3.198. openstack volume type set

usage: openstack volume type set [-h] [--property <key=value>] <volume-type>
Copy to Clipboard Toggle word wrap
ボリューム種別の属性を設定します。

位置引数

<volume-type>
変更するボリューム種別(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--property <key=value>
このボリューム種別に追加または変更するための属性(複数の属性を設定する場合はオプションを繰り返し使用します)

3.3.199. openstack volume type show

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
ボリューム種別の詳細を表示します。

位置引数

<volume-type>
表示するボリューム種別(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.200. openstack volume type unset

usage: openstack volume type unset [-h] --property <key> <volume-type>
Copy to Clipboard Toggle word wrap
ボリューム種別の属性の設定を解除します。

位置引数

<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
ボリューム属性の設定を解除します。

位置引数

<volume>
変更するボリューム(名前または ID)

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--property <key>
ボリュームから削除するプロパティー(複数の属性を削除する場合はオプションを繰り返し使用します)

3.3.202. openstack zone abandon

usage: openstack zone abandon [-h] id
Copy to Clipboard Toggle word wrap
ゾーンを破棄します。

位置引数

id
ゾーン ID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.203. openstack zone axfr

usage: openstack zone axfr [-h] id
Copy to Clipboard Toggle word wrap
ゾーンの自動ゾーン転送を行います。

位置引数

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,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.205. openstack zone blacklist delete

usage: openstack zone blacklist delete [-h] id
Copy to Clipboard Toggle word wrap
ブラックリストを削除します。

位置引数

id
Black ID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

3.3.206. openstack zone blacklist list

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,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
ブラックリストの属性を設定します。

位置引数

id
Black ID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--pattern PATTERN
ブラックリストのパターン
--description DESCRIPTION
説明
--no-description

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.208. openstack zone blacklist show

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
ブラックリストの詳細を表示します。

位置引数

id
Black ID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(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
新しいゾーンを作成します。

位置引数

name
ゾーン名

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--email EMAIL
ゾーン電子メール
--type TYPE
ゾーンタイプ
--ttl TTL
Time To Live (秒)
--description DESCRIPTION
説明
--masters MASTERS [MASTERS ...]
ゾーンマスター

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

3.3.210. openstack zone delete

usage: openstack zone delete [-h] id
Copy to Clipboard Toggle word wrap
ゾーンを削除します。

位置引数

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,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
ゾーンの属性を設定します。

位置引数

id
ゾーン ID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--name NAME
ゾーン名
--email EMAIL
ゾーン電子メール
--ttl TTL
Time To Live (秒)
--description DESCRIPTION
説明
--no-description
--masters MASTERS [MASTERS ...]
ゾーンマスター

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(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
ゾーンの詳細を表示します。

位置引数

id
ゾーン ID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(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
Transfer ID
--key KEY
Transfer 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
ゾーン転送の受理を表示します。

位置引数

id
zone Tranfer Accept ID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(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
新しいゾーン転送リクエストを作成します。

位置引数

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,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(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

位置引数

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,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
転送の設定

位置引数

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
ゾーン転送の詳細を表示します。

位置引数

id
ゾーントレーダー ID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

第4章 設定ファイルエディター

openstack-config クライアントは、その拡張機能のコマンドラインインターフェイス(CLI)です。本章では、openstack-config version 0.5 について説明します。
特定の openstack-config コマンドのヘルプを表示するには、次のように入力します。
$ openstack-config help COMMAND
Copy to Clipboard Toggle word wrap

4.1. openstack-config の使用

 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 を使用した一覧値を区切る
--output=FILE
代わりに FILE に出力を書き込みます。'-' は標準出力(stdout)を意味します。
--verbose
変更が加えられた場合の stderr を示します。

第5章 Block Storage サービスのコマンドラインクライアント

cinder クライアントは、Block Storage サービス 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
1 つ以上の cgsnapshots を削除します。
cgsnapshot-list
すべての cgsnapshots を一覧表示します。
cgsnapshot-show
cgsnapshot の詳細を表示します。
consisgroup-create
整合性グループを作成する。
consisgroup-create-from-src
cgsnapshot またはソース CG から整合性グループを作成します。
consisgroup-delete
1 つ以上の整合性グループを削除します。
consisgroup-list
すべてのコンシステンシーグループを一覧表示します。
consisgroup-show
整合性グループの詳細を表示します。
consisgroup-update
整合性グループを更新します。
create
ボリュームを作成します。
credentials
認証から返されたユーザークレデンシャルを表示します。
delete
1 つまたは複数のボリュームを削除します。
encryption-type-create
ボリューム種別の暗号化種別を作成します。管理者のみ。
encryption-type-delete
ボリューム種別の暗号化種別を削除します。管理者のみ。
encryption-type-list
ボリューム種別の暗号化タイプの詳細を表示します。管理者のみ。
encryption-type-show
ボリューム種別の暗号化タイプの詳細を表示します。管理者のみ。
encryption-type-update
ボリューム種別の暗号化タイプ情報を更新します(管理者のみ)。
endpoints
認証サービスが登録したエンドポイントを検出します。
extend
既存のボリュームのサイズを拡張しようとします。
extra-specs-list
現在のボリュームタイプおよび追加スペックを一覧表示します。
force-delete
状態に関係なく、ボリュームの強制削除を試行します。
get-capabilities
バックエンドボリュームの統計とプロパティーを表示します。管理者のみ。
get-pools
バックエンドのプール情報を表示します。管理者のみ。
image-metadata
ボリュームイメージメタデータを設定または削除します。
list
すべてのボリュームを一覧表示します。
manage
既存のボリュームを管理します。
metadata
ボリュームメタデータを設定または削除します。
metadata-show
ボリュームのメタデータを表示します。
metadata-update-all
ボリュームメタデータを更新します。
migrate
ボリュームを新規ホストに移行します。
qos-associate
qos 仕様を指定されたボリュームタイプに関連付けます。
qos-create
qos 仕様を作成します。
qos-delete
指定された qos 仕様を削除します。
qos-disassociate
指定されたボリュームタイプから qos 仕様の関連付けを解除します。
qos-disassociate-all
すべての関連付けから qos 仕様の関連付けを解除します。
qos-get-association
指定した qos 仕様のすべての関連付けを一覧表示します。
qos-key
qos 仕様の仕様を設定または設定解除します。
qos-list
qos 仕様を一覧表示します。
qos-show
qos 仕様の詳細を表示します。
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 データベースのボリューム状態を明示的に更新します。
再入力
ボリュームのボリューム種別を変更します。
service-disable
サービスを無効にします。
service-enable
サービスを有効にします。
service-list
すべてのサービスを一覧表示します。ホストおよびサービスバイナリーでフィルタリングします。
set-bootable
ボリュームのブート可能ステータスを更新します。
表示
ボリュームの詳細を表示します。
snapshot-create
スナップショットを作成します。
snapshot-delete
1 つ以上のスナップショットを削除します。
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
イメージとして Image Service にボリュームをアップロードします。
bash-completion
bash_completion の引数を出力します。
help
このプログラムまたはそのサブコマンドのヘルプを表示します。
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>
Block Storage 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. Block Storage API v1 コマンド(非推奨)

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
ボリュームのバックアップを作成します。

位置引数

<volume>
バックアップするボリュームの名前または ID。

オプションの引数

--container <container>
コンテナー名をバックアップします。デフォルトは None です。
--name <name>
バックアップ名。デフォルトは None です。
--description <description>
バックアップの説明。デフォルトは 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
バックアップを削除します。

位置引数

<backup>
削除するバックアップの名前または ID。

5.3.5. cinder backup-export

usage: cinder backup-export <backup>
Copy to Clipboard Toggle word wrap
バックアップメタデータレコードをエクスポートします。

位置引数

<backup>
エクスポートするバックアップの ID。

5.3.6. cinder backup-import

usage: cinder backup-import <backup_service> <backup_url>
Copy to Clipboard Toggle word wrap
バックアップメタデータレコードをインポートします。

位置引数

<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-tenantsApnsall_tenants>]
すべてのテナントの詳細を表示します。管理者のみ。
--name <name>
名前で結果をフィルタリングします。デフォルトは None です。
--status <status>
ステータスで結果をフィルタリングします。デフォルトは None です。
--volume-id <volume-id>
ボリューム ID で結果をフィルタリングします。デフォルトは None です。

5.3.8. cinder backup-restore

usage: cinder backup-restore [--volume <volume>] <backup>
Copy to Clipboard Toggle word wrap
バックアップを復元します。

位置引数

<backup>
復元するバックアップの ID。

オプションの引数

--volume <volume>
復元するボリュームの名前または ID。デフォルトは None です。

5.3.9. cinder backup-show

usage: cinder backup-show <backup>
Copy to Clipboard Toggle word wrap
バックアップの詳細を表示します。

位置引数

<backup>
バックアップの名前または ID。

5.3.10. cinder cgsnapshot-create

usage: cinder cgsnapshot-create [--name <name>] [--description <description>] <consistencygroup>
Copy to Clipboard Toggle word wrap
cgsnapshot を作成します。

位置引数

<consistencygroup>
整合性グループの名前または ID。

オプションの引数

--name <name>
cgsnapshot 名。デフォルトは None です。
--description <description>
cgsnapshot の説明。デフォルトは None です。

5.3.11. cinder cgsnapshot-delete

usage: cinder cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]
Copy to Clipboard Toggle word wrap
1 つ以上の cgsnapshots を削除します。

位置引数

<cgsnapshot>
削除する 1 つまたは複数の cgsnapshots の名前または 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
すべての cgsnapshots を一覧表示します。

オプションの引数

--all-tenantsApns0|1>]
すべてのテナントの詳細を表示します。管理者のみ。
--status <status>
ステータスで結果をフィルタリングします。デフォルトは None です。
--consistencygroup-id <consistencygroup_id>
整合性グループ ID で結果をフィルタリングします。デフォルトは None です。

5.3.13. cinder cgsnapshot-show

usage: cinder cgsnapshot-show <cgsnapshot>
Copy to Clipboard Toggle word wrap
cgsnapshot の詳細を表示します。

位置引数

<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
整合性グループを作成する。

位置引数

<volume-types>
ボリュームタイプ

オプションの引数

--name <name>
整合性グループの名前
--description <description>
整合性グループの説明。デフォルトは None です。
--availability-zone <availability-zone>
ボリュームの可用性ゾーン。デフォルトは 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。デフォルトは None です。
--source-cg <source-cg>
ソースの CG の名前または ID。デフォルトは None です。
--name <name>
整合性グループの名前デフォルトは None です。
--description <description>
整合性グループの説明。デフォルトは None です。

5.3.16. cinder consisgroup-delete

usage: cinder consisgroup-delete [--force] <consistencygroup> [<consistencygroup> ...]
Copy to Clipboard Toggle word wrap
1 つ以上の整合性グループを削除します。

位置引数

<consistencygroup>
削除する 1 つ以上の整合性グループの名前または 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-tenantsApns0|1>]
すべてのテナントの詳細を表示します。管理者のみ。

5.3.18. cinder consisgroup-show

usage: cinder consisgroup-show <consistencygroup>
Copy to Clipboard Toggle word wrap
整合性グループの詳細を表示します。

位置引数

<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
整合性グループを更新します。

位置引数

<consistencygroup>
整合性グループの名前または ID。

オプションの引数

--name <name>
整合性グループの新しい名前デフォルトは None です。
--description <description>
整合性グループの新しい説明デフォルトは None です。
--add-volumes <uuid1,uuid2,......>
整合性グループに追加する 1 つ以上のボリュームの UUID はコンマで区切って指定します。デフォルトは None です。
--remove-volumes <uuid3,uuid4,......>
整合性グループから削除する 1 つ以上のボリュームの UUID はコンマで区切って指定します。デフォルトは None です。

5.3.20. cinder create

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
ボリュームを作成します。

位置引数

<size>
ボリュームのサイズ(GB 単位)。(snapshot-id /source-volid が指定されていない場合は必須です)。

オプションの引数

--consisgroup-id <consistencygroup-id>
新規ボリュームが属する整合性グループの IDデフォルトは None です。
--snapshot-id <snapshot-id>
スナップショット ID からボリュームを作成します。デフォルトは None です。
--source-volid <source-volid>
ボリューム ID からボリュームを作成します。デフォルトは None です。
--source-replica <source-replica>
複製されたボリューム ID からボリュームを作成します。デフォルトは None です。
--image-id <image-id>
イメージ ID からボリュームを作成します。デフォルトは None です。
--image <image>
イメージ(ID または名前)からボリュームを作成します。デフォルトは None です。
--name <name>
ボリューム名。デフォルトは None です。
--description <description>
ボリュームの説明。デフォルトは None です。
--volume-type <volume-type>
ボリュームタイプデフォルトは None です。
--availability-zone <availability-zone>
ボリュームの可用性ゾーン。デフォルトは None です。
--metadataApnskey=value>VARCHARkey=value> ...]]
メタデータのキーと値のペア。デフォルトは None です。
--hint <key=value>
nova などのスケジューラーヒント。
--allow-multiattach
ボリュームを複数回接続できるようにします。Default=False

5.3.21. Cinder の認証情報

usage: cinder credentials
Copy to Clipboard Toggle word wrap
認証から返されたユーザークレデンシャルを表示します。

5.3.22. cinder delete

usage: cinder delete <volume> [<volume> ...]
Copy to Clipboard Toggle word wrap
1 つまたは複数のボリュームを削除します。

位置引数

<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
ボリューム種別の暗号化種別を作成します。管理者のみ。

位置引数

<volume_type>
ボリュームタイプの名前または ID。
<provider>
暗号化をサポートするクラス。(例:LuksEncryptor)。

オプションの引数

--cipher <cipher>
暗号化アルゴリズムまたはモード。たとえば、aes- xts-plain64 です。デフォルトは None です。
--key_size <key_size>
暗号化キーのサイズ(ビット単位)。たとえば、128 または 256 です。デフォルトは None です。
--control_location <control_location>
暗号化が実行される概念サービス。有効な値は、front-end または "back-end" です。たとえば、front-end=Nova です。デフォルトはフロントエンドです。

5.3.24. cinder encryption-type-delete

usage: cinder encryption-type-delete <volume_type>
Copy to Clipboard Toggle word wrap
ボリューム種別の暗号化種別を削除します。管理者のみ。

位置引数

<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
ボリューム種別の暗号化タイプの詳細を表示します。管理者のみ。

位置引数

<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
ボリューム種別の暗号化タイプ情報を更新します(管理者のみ)。

位置引数

<volume-type>
ボリュームタイプの名前または ID

オプションの引数

--provider <provider>
暗号化サポートを提供するクラス(LuksEncryptor など) (オプション)
--cipherVARCHARcipher>]
使用する暗号化アルゴリズム/モード(例:aes-xts- plain64)。値なしでパラメーターをプロバイダーのデフォルトに指定します。(オプション)
--key-sizeApnskey-size>]
暗号化キーのサイズ(ビット単位(例:128、256)。値なしでパラメーターをプロバイダーのデフォルトに指定します。(オプション)
--control-location <control-location>
暗号化が実行される概念サービス(例:front-end=Nova)。値:'front-end'、'back-end'(オプション)

5.3.28. Cinder エンドポイント

usage: cinder endpoints
Copy to Clipboard Toggle word wrap
認証サービスが登録したエンドポイントを検出します。

5.3.29. cinder extend

usage: cinder extend <volume> <new_size>
Copy to Clipboard Toggle word wrap
既存のボリュームのサイズを拡張しようとします。

位置引数

<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
状態に関係なく、ボリュームの強制削除を試行します。

位置引数

<volume>
削除するボリュームの名前または ID。

5.3.32. cinder get-capabilities

usage: cinder get-capabilities <host>
Copy to Clipboard Toggle word wrap
バックエンドボリュームの統計とプロパティーを表示します。管理者のみ。

位置引数

<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
ボリュームイメージメタデータを設定または削除します。

位置引数

<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-tenantsApns0|1>]
すべてのテナントの詳細を表示します。管理者のみ。
--name <name>
名前で結果をフィルタリングします。デフォルトは None です。
--status <status>
ステータスで結果をフィルタリングします。デフォルトは None です。
--migration_status <migration_status>
移行ステータスで結果をフィルタリングします。デフォルトは None です。管理者のみ。
--metadataApnskey=value>VARCHARkey=value> ...]]
メタデータのキーおよび値のペアで結果をフィルタリングします。デフォルトは None です。
--marker <marker>
ボリューム ID で表されるボリュームを一覧表示するボリュームの一覧で、後で表示されるボリュームを返します。デフォルトは None です。
--limit <limit>
返すボリュームの最大数。デフォルトは None です。
--sort <key>[:<direction>]
<key>[:<asc|desc>] 形式の、ソートキーと方向のコンマ区切りリスト。有効なキー:id、status、size、availability_zone、name、bootable、created_atデフォルトは None です。
--tenantVARCHARtenant>]
単一のテナントからの情報を表示します(管理者のみ)。

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
既存のボリュームを管理します。

位置引数

<host>
既存のボリュームが存在する Cinder ホスト。host@backend-name#pool の形式を取ります
<identifier>
既存のボリュームの name またはその他の Identifier

オプションの引数

--id-type <id-type>
バックエンドデバイス識別子のタイプ(通常は source-name または source-id (Default=source-name))
--name <name>
ボリューム名(Default=None)
--description <description>
ボリュームの説明(デフォルト=None)
--volume-type <volume-type>
ボリュームタイプ(デフォルト=None)
--availability-zone <availability-zone>
ボリュームのアベイラビリティーゾーン(デフォルトは None)
--metadataApnskey=value>VARCHARkey=value> ...]]
メタデータ key=value ペア(Default=None)
--bootable
新規に作成されたボリュームをブート可能としてマークすることを指定します。

5.3.38. Cinder のメタデータ

usage: cinder metadata <volume> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
ボリュームメタデータを設定または削除します。

位置引数

<volume>
メタデータを更新するボリュームの名前または ID。
<action>
アクション。有効な値は set または unset です。
<key=value>
メタデータキーと値のペアを設定して設定または設定解除します。未設定の場合は、キーのみを指定します。

5.3.39. cinder metadata-show

usage: cinder metadata-show <volume>
Copy to Clipboard Toggle word wrap
ボリュームのメタデータを表示します。

位置引数

<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
ボリュームメタデータを更新します。

位置引数

<volume>
メタデータを更新するボリュームの ID。
<key=value>
更新するメタデータのキーと値のペアおよび値のペア。

5.3.41. Cinder migrate

usage: cinder migrate [--force-host-copy [<True|False>]] [--lock-volume [<True|False>]] <volume> <host>
Copy to Clipboard Toggle word wrap
ボリュームを新規ホストに移行します。

位置引数

<volume>
移行するボリュームの ID。
<host>
移行先ホスト。

オプションの引数

--force-host-copyApnsTrue|False>]
汎用的なホストベースの強制移行を有効または無効にします。これにより、ドライバーの最適化がバイパスされます。デフォルト=False。
--lock-volumeApnsTrue|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 仕様を指定されたボリュームタイプに関連付けます。

位置引数

<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 仕様を作成します。

位置引数

<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 仕様を削除します。

位置引数

<qos_specs>
削除する QoS 仕様の ID。

オプションの引数

--forceApnsTrue|False>]
使用中の QoS 仕様の削除を有効または無効にします。デフォルト=False。

5.3.45. cinder qos-disassociate

usage: cinder qos-disassociate <qos_specs> <volume_type_id>
Copy to Clipboard Toggle word wrap
指定されたボリュームタイプから qos 仕様の関連付けを解除します。

位置引数

<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 仕様の関連付けを解除します。

位置引数

<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 仕様のすべての関連付けを一覧表示します。

位置引数

<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 仕様の仕様を設定または設定解除します。

位置引数

<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 仕様を一覧表示します。

5.3.50. cinder qos-show

usage: cinder qos-show <qos_specs>
Copy to Clipboard Toggle word wrap
qos 仕様の詳細を表示します。

位置引数

<qos_specs>
表示する QoS 仕様の ID。

5.3.51. cinder quota-class-show

usage: cinder quota-class-show <class>
Copy to Clipboard Toggle word wrap
クォータクラスのクォータを一覧表示します。

位置引数

<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
クォータクラスのクォータを更新します。

位置引数

<CLASS_NAME>
クォータを設定するクォータクラスの名前。

オプションの引数

--volumes <volumes>
新規のボリュームのクォータ値。デフォルトは None です。
--snapshots <snapshots>
新しい "snapshots" クォータ値。デフォルトは None です。
--gigabytes <gigabytes>
新しいギガバイトクォータ値。デフォルトは None です。
--volume-type <volume_type_name>
ボリュームタイプデフォルトは None です。

5.3.53. cinder quota-defaults

usage: cinder quota-defaults <tenant_id>
Copy to Clipboard Toggle word wrap
テナントのデフォルトクォータを一覧表示します。

位置引数

<tenant_id>
クォータのデフォルトを一覧表示するテナントの ID。

5.3.54. cinder quota-delete

usage: cinder quota-delete <tenant_id>
Copy to Clipboard Toggle word wrap
テナントのクォータを削除します。

位置引数

<tenant_id>
クォータを削除するテナントの UUID。

5.3.55. cinder quota-show

usage: cinder quota-show <tenant_id>
Copy to Clipboard Toggle word wrap
テナントのクォータを一覧表示します。

位置引数

<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
テナントのクォータを更新します。

位置引数

<tenant_id>
クォータを設定するためのテナントの ID。

オプションの引数

--volumes <volumes>
新規のボリュームのクォータ値。デフォルトは None です。
--snapshots <snapshots>
新しい "snapshots" クォータ値。デフォルトは None です。
--gigabytes <gigabytes>
新しいギガバイトクォータ値。デフォルトは None です。
--backups <backups>
新しい backups クォータの値。デフォルトは None です。
--backup-gigabytes <backup_gigabytes>
新しい backup_gigabytes クォータ値。デフォルトは None です。
--consistencygroups <consistencygroups>
新しい consistencygroups クォータ値。デフォルトは None です。
--volume-type <volume_type_name>
ボリュームタイプデフォルトは None です。
--per-volume-gigabytes <per_volume_gigabytes>
最大ボリュームサイズ制限を設定します。デフォルトは None です。

5.3.57. cinder quota-usage

usage: cinder quota-usage <tenant_id>
Copy to Clipboard Toggle word wrap
テナントのクォータ使用状況を一覧表示します。

位置引数

<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 フラグを更新します。

位置引数

<volume>
更新するボリュームの ID。
<true|true|False|false>
ボリュームの読み取り専用モードへの更新を有効または無効にします。

5.3.60. cinder rename

usage: cinder rename [--description <description>] <volume> [<name>]
Copy to Clipboard Toggle word wrap
ボリュームの名前を変更します。

位置引数

<volume>
名前を変更するボリュームの名前または ID。
<name>
ボリュームの新しい名前。

オプションの引数

--description <description>
ボリュームの説明。デフォルトは None です。

5.3.61. cinder replication-promote

usage: cinder replication-promote <volume>
Copy to Clipboard Toggle word wrap
関係のためにセカンダリーボリュームをプライマリーにプロモートします。

位置引数

<volume>
プロモートするボリュームの名前または ID。ボリュームには、source-replica 引数で作成したレプリカボリュームが必要です。

5.3.62. cinder replication-reenable

usage: cinder replication-reenable <volume>
Copy to Clipboard Toggle word wrap
関係に対して、セカンダリーボリュームとプライマリーを同期します。

位置引数

<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 コンピューティングホストまたはインスタンスに接続されているかどうかに影響せず、ボリュームが使用できなくなる可能性があることに注意してください。データベースの変更としてのみ、これはボリュームの状態に影響を与えることはなく、実際の状態とは一致しない場合があります。これにより、available 状態への変更が発生した場合は、ボリュームが使用できなくなる可能性があります。

位置引数

<volume>
変更するボリュームの名前または ID。

オプションの引数

--state <state>
ボリュームに割り当てる状態。有効な値は、available、error、creating、deleting、in-use、attach、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
ボリュームのボリューム種別を変更します。

位置引数

<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
サービスを無効にします。

位置引数

<hostname>
Host name。
<binary>
サービスバイナリー。

オプションの引数

--reason <reason>
サービスを無効にする理由。

5.3.66. cinder service-enable

usage: cinder service-enable <hostname> <binary>
Copy to Clipboard Toggle word wrap
サービスを有効にします。

位置引数

<hostname>
Host name。
<binary>
サービスバイナリー。

5.3.67. cinder service-list

usage: cinder service-list [--host <hostname>] [--binary <binary>]
Copy to Clipboard Toggle word wrap
すべてのサービスを一覧表示します。ホストおよびサービスバイナリーでフィルタリングします。

オプションの引数

--host <hostname>
Host name。デフォルトは None です。
--binary <binary>
サービスバイナリー。デフォルトは None です。

5.3.68. cinder set-bootable

usage: cinder set-bootable <volume> <True|true|False|false>
Copy to Clipboard Toggle word wrap
ボリュームのブート可能ステータスを更新します。

位置引数

<volume>
更新するボリュームの ID。
<true|true|False|false>
ボリュームが起動可能かどうかを示すフラグ。

5.3.69. cinder show

usage: cinder show <volume>
Copy to Clipboard Toggle word wrap
ボリュームの詳細を表示します。

位置引数

<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
スナップショットを作成します。

位置引数

<volume>
スナップショットを作成するボリュームの名前または ID。

オプションの引数

--forceApnsTrue|False>]
ボリュームがインスタンスにアタッチされているときに、ボリュームのスナップショットを許可または禁止します。True に設定すると、ボリュームの現在のステータスを強制ではなく、スナップショットの試行時にそのボリュームのステータスを無視します。デフォルト=False。
--name <name>
スナップショット名。デフォルトは None です。
--description <description>
スナップショットの説明。デフォルトは None です。
--metadataApnskey=value>VARCHARkey=value> ...]]
スナップショットメタデータのキーと値のペア。デフォルトは None です。

5.3.71. cinder snapshot-delete

usage: cinder snapshot-delete <snapshot> [<snapshot> ...]
Copy to Clipboard Toggle word wrap
1 つ以上のスナップショットを削除します。

位置引数

<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-tenantsApns0|1>]
すべてのテナントの詳細を表示します。管理者のみ。
--name <name>
名前で結果をフィルタリングします。デフォルトは None です。
--status <status>
ステータスで結果をフィルタリングします。デフォルトは None です。
--volume-id <volume-id>
ボリューム ID で結果をフィルタリングします。デフォルトは None です。

5.3.73. cinder snapshot-metadata

usage: cinder snapshot-metadata <snapshot> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
スナップショットメタデータを設定または削除します。

位置引数

<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
スナップショットのメタデータを表示します。

位置引数

<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
スナップショットのメタデータを更新します。

位置引数

<snapshot>
メタデータを更新するスナップショットの ID。
<key=value>
更新するメタデータのキーと値のペア。

5.3.76. cinder snapshot-rename

usage: cinder snapshot-rename [--description <description>] <snapshot> [<name>]
Copy to Clipboard Toggle word wrap
スナップショットの名前を変更します。

位置引数

<snapshot>
スナップショットの名前または ID。
<name>
スナップショットの新しい名前。

オプションの引数

--description <description>
スナップショットの説明。デフォルトは None です。

5.3.77. cinder snapshot-reset-state

usage: cinder snapshot-reset-state [--state <state>] <snapshot> [<snapshot> ...]
Copy to Clipboard Toggle word wrap
スナップショットの状態を明示的に更新します。

位置引数

<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
スナップショットの詳細を表示します。

位置引数

<snapshot>
スナップショットの名前または ID。

5.3.79. cinder transfer-accept

usage: cinder transfer-accept <transfer> <auth_key>
Copy to Clipboard Toggle word wrap
ボリュームの譲渡を受け入れます。

位置引数

<transfer>
受け入れる転送の ID。
<auth_key>
受け入れるための認証鍵。

5.3.80. cinder transfer-create

usage: cinder transfer-create [--name <name>] <volume>
Copy to Clipboard Toggle word wrap
ボリューム譲渡を作成します。

位置引数

<volume>
譲渡するボリュームの名前または ID。

オプションの引数

--name <name>
転送名。デフォルトは None です。

5.3.81. cinder transfer-delete

usage: cinder transfer-delete <transfer>
Copy to Clipboard Toggle word wrap
転送を元に戻します。

位置引数

<transfer>
削除する転送の名前または ID。

5.3.82. cinder transfer-list

usage: cinder transfer-list [--all-tenants [<0|1>]]
Copy to Clipboard Toggle word wrap
すべての転送を一覧表示します。

オプションの引数

--all-tenantsApns0|1>]
すべてのテナントの詳細を表示します。管理者のみ。

5.3.83. cinder transfer-show

usage: cinder transfer-show <transfer>
Copy to Clipboard Toggle word wrap
転送の詳細を表示します。

位置引数

<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
ボリューム種別を作成します。

位置引数

<name>
新規ボリューム種別の名前。

オプションの引数

--description <description>
新規ボリュームタイプの説明。
--is-public <is-public>
タイプがパブリックにアクセスできるようにします (デフォルトは 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
ボリューム種別を削除します。

位置引数

<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 を設定または設定解除します。

位置引数

<vtype>
ボリュームタイプの名前または ID。
<action>
アクション。有効な値は set または unset です。
<key=value>
設定または設定解除する余分なスペックのキーと値のペアです。未設定の場合は、キーのみを指定します。

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
ボリューム種別の名前および説明を更新します。

位置引数

<id>
ボリュームタイプの ID。

オプションの引数

--name <name>
ボリュームタイプの名前。
--description <description>
ボリュームタイプの説明。

5.3.93. cinder unmanage

usage: cinder unmanage <volume>
Copy to Clipboard Toggle word wrap
ボリュームの管理を停止します。

位置引数

<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
イメージとして Image Service にボリュームをアップロードします。

位置引数

<volume>
スナップショットを作成するボリュームの名前または ID。
<image-name>
新しいイメージ名。

オプションの引数

--forceApnsTrue|False>]
インスタンスに接続されているボリュームのアップロードを有効または無効にします。デフォルト=False。
--container-format <container-format>
コンテナー形式タイプ。デフォルトはベアです。
--disk-format <disk-format>
ディスクフォーマットタイプ。デフォルトは raw です。

5.4. Block Storage API v2 コマンド

使用する API バージョンを選択するには、--os-volume-api-version パラメーターを追加するか、対応する環境変数を設定します。
$ 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
ボリュームのバックアップを作成します。

位置引数

<volume>
バックアップするボリュームの名前または ID。

オプションの引数

--container <container>
コンテナー名をバックアップします。デフォルトは None です。
--name <name>
バックアップ名。デフォルトは None です。
--description <description>
バックアップの説明。デフォルトは 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
バックアップを削除します。

位置引数

<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
バックアップメタデータレコードをエクスポートします。

位置引数

<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
バックアップメタデータレコードをインポートします。

位置引数

<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-tenantsApnsall_tenants>]
すべてのテナントの詳細を表示します。管理者のみ。
--name <name>
名前で結果をフィルタリングします。デフォルトは None です。
--status <status>
ステータスで結果をフィルタリングします。デフォルトは None です。
--volume-id <volume-id>
ボリューム ID で結果をフィルタリングします。デフォルトは 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
バックアップを復元します。

位置引数

<backup>
復元するバックアップの ID。

オプションの引数

--volume <volume>
復元するボリュームの名前または ID。デフォルトは None です。

5.4.9. cinder backup-show (v2)

usage: cinder --os-volume-api-version 2 backup-show <backup>
Copy to Clipboard Toggle word wrap
バックアップの詳細を表示します。

位置引数

<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 を作成します。

位置引数

<consistencygroup>
整合性グループの名前または ID。

オプションの引数

--name <name>
cgsnapshot 名。デフォルトは None です。
--description <description>
cgsnapshot の説明。デフォルトは 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
1 つ以上の cgsnapshots を削除します。

位置引数

<cgsnapshot>
削除する 1 つまたは複数の cgsnapshots の名前または 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
すべての cgsnapshots を一覧表示します。

オプションの引数

--all-tenantsApns0|1>]
すべてのテナントの詳細を表示します。管理者のみ。
--status <status>
ステータスで結果をフィルタリングします。デフォルトは None です。
--consistencygroup-id <consistencygroup_id>
整合性グループ ID で結果をフィルタリングします。デフォルトは 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 の詳細を表示します。

位置引数

<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
整合性グループを作成する。

位置引数

<volume-types>
ボリュームタイプ

オプションの引数

--name <name>
整合性グループの名前
--description <description>
整合性グループの説明。デフォルトは None です。
--availability-zone <availability-zone>
ボリュームの可用性ゾーン。デフォルトは 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。デフォルトは None です。
--source-cg <source-cg>
ソースの CG の名前または ID。デフォルトは None です。
--name <name>
整合性グループの名前デフォルトは None です。
--description <description>
整合性グループの説明。デフォルトは 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
1 つ以上の整合性グループを削除します。

位置引数

<consistencygroup>
削除する 1 つ以上の整合性グループの名前または 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-tenantsApns0|1>]
すべてのテナントの詳細を表示します。管理者のみ。

5.4.18. cinder consisgroup-show (v2)

usage: cinder --os-volume-api-version 2 consisgroup-show <consistencygroup>
Copy to Clipboard Toggle word wrap
整合性グループの詳細を表示します。

位置引数

<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
整合性グループを更新します。

位置引数

<consistencygroup>
整合性グループの名前または ID。

オプションの引数

--name <name>
整合性グループの新しい名前デフォルトは None です。
--description <description>
整合性グループの新しい説明デフォルトは None です。
--add-volumes <uuid1,uuid2,......>
整合性グループに追加する 1 つ以上のボリュームの UUID はコンマで区切って指定します。デフォルトは None です。
--remove-volumes <uuid3,uuid4,......>
整合性グループから削除する 1 つ以上のボリュームの UUID はコンマで区切って指定します。デフォルトは None です。

5.4.20. cinder create (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
ボリュームを作成します。

位置引数

<size>
ボリュームのサイズ(GB 単位)。(snapshot-id /source-volid が指定されていない場合は必須です)。

オプションの引数

--consisgroup-id <consistencygroup-id>
新規ボリュームが属する整合性グループの IDデフォルトは None です。
--snapshot-id <snapshot-id>
スナップショット ID からボリュームを作成します。デフォルトは None です。
--source-volid <source-volid>
ボリューム ID からボリュームを作成します。デフォルトは None です。
--source-replica <source-replica>
複製されたボリューム ID からボリュームを作成します。デフォルトは None です。
--image-id <image-id>
イメージ ID からボリュームを作成します。デフォルトは None です。
--image <image>
イメージ(ID または名前)からボリュームを作成します。デフォルトは None です。
--name <name>
ボリューム名。デフォルトは None です。
--description <description>
ボリュームの説明。デフォルトは None です。
--volume-type <volume-type>
ボリュームタイプデフォルトは None です。
--availability-zone <availability-zone>
ボリュームの可用性ゾーン。デフォルトは None です。
--metadataApnskey=value>VARCHARkey=value> ...]]
メタデータのキーと値のペア。デフォルトは 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
認証から返されたユーザークレデンシャルを表示します。

5.4.22. cinder delete (v2)

usage: cinder --os-volume-api-version 2 delete <volume> [<volume> ...]
Copy to Clipboard Toggle word wrap
1 つまたは複数のボリュームを削除します。

位置引数

<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
ボリューム種別の暗号化種別を作成します。管理者のみ。

位置引数

<volume_type>
ボリュームタイプの名前または ID。
<provider>
暗号化をサポートするクラス。(例:LuksEncryptor)。

オプションの引数

--cipher <cipher>
暗号化アルゴリズムまたはモード。たとえば、aes- xts-plain64 です。デフォルトは None です。
--key_size <key_size>
暗号化キーのサイズ(ビット単位)。たとえば、128 または 256 です。デフォルトは None です。
--control_location <control_location>
暗号化が実行される概念サービス。有効な値は、front-end または "back-end" です。たとえば、front-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
ボリューム種別の暗号化種別を削除します。管理者のみ。

位置引数

<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
ボリューム種別の暗号化タイプの詳細を表示します。管理者のみ。

位置引数

<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
ボリューム種別の暗号化タイプ情報を更新します(管理者のみ)。

位置引数

<volume-type>
ボリュームタイプの名前または ID

オプションの引数

--provider <provider>
暗号化サポートを提供するクラス(LuksEncryptor など) (オプション)
--cipherVARCHARcipher>]
使用する暗号化アルゴリズム/モード(例:aes-xts- plain64)。値なしでパラメーターをプロバイダーのデフォルトに指定します。(オプション)
--key-sizeApnskey-size>]
暗号化キーのサイズ(ビット単位(例:128、256)。値なしでパラメーターをプロバイダーのデフォルトに指定します。(オプション)
--control-location <control-location>
暗号化が実行される概念サービス(例:front-end=Nova)。値:'front-end'、'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 extend (v2)

usage: cinder --os-volume-api-version 2 extend <volume> <new_size>
Copy to Clipboard Toggle word wrap
既存のボリュームのサイズを拡張しようとします。

位置引数

<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
状態に関係なく、ボリュームの強制削除を試行します。

位置引数

<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
バックエンドボリュームの統計とプロパティーを表示します。管理者のみ。

位置引数

<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
ボリュームイメージメタデータを設定または削除します。

位置引数

<volume>
メタデータを更新するボリュームの名前または ID。
<action>
アクション。有効な値は set または unset です。
<key=value>
メタデータキーと値のペアを設定して設定または設定解除します。未設定の場合は、キーのみを指定します。

5.4.35. cinder list (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-tenantsApns0|1>]
すべてのテナントの詳細を表示します。管理者のみ。
--name <name>
名前で結果をフィルタリングします。デフォルトは None です。
--status <status>
ステータスで結果をフィルタリングします。デフォルトは None です。
--migration_status <migration_status>
移行ステータスで結果をフィルタリングします。デフォルトは None です。管理者のみ。
--metadataApnskey=value>VARCHARkey=value> ...]]
メタデータのキーおよび値のペアで結果をフィルタリングします。デフォルトは None です。
--marker <marker>
ボリューム ID で表されるボリュームを一覧表示するボリュームの一覧で、後で表示されるボリュームを返します。デフォルトは None です。
--limit <limit>
返すボリュームの最大数。デフォルトは None です。
--sort <key>[:<direction>]
<key>[:<asc|desc>] 形式の、ソートキーと方向のコンマ区切りリスト。有効なキー:id、status、size、availability_zone、name、bootable、created_atデフォルトは None です。
--tenantVARCHARtenant>]
単一のテナントからの情報を表示します(管理者のみ)。

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
既存のボリュームを管理します。

位置引数

<host>
既存のボリュームが存在する Cinder ホスト。host@backend-name#pool の形式を取ります
<identifier>
既存のボリュームの name またはその他の Identifier

オプションの引数

--id-type <id-type>
バックエンドデバイス識別子のタイプ(通常は source-name または source-id (Default=source-name))
--name <name>
ボリューム名(Default=None)
--description <description>
ボリュームの説明(デフォルト=None)
--volume-type <volume-type>
ボリュームタイプ(デフォルト=None)
--availability-zone <availability-zone>
ボリュームのアベイラビリティーゾーン(デフォルトは None)
--metadataApnskey=value>VARCHARkey=value> ...]]
メタデータ 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
ボリュームメタデータを設定または削除します。

位置引数

<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
ボリュームのメタデータを表示します。

位置引数

<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
ボリュームメタデータを更新します。

位置引数

<volume>
メタデータを更新するボリュームの ID。
<key=value>
更新するメタデータのキーと値のペアおよび値のペア。

5.4.41. Cinder migrate (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
ボリュームを新規ホストに移行します。

位置引数

<volume>
移行するボリュームの ID。
<host>
移行先ホスト。

オプションの引数

--force-host-copyApnsTrue|False>]
汎用的なホストベースの強制移行を有効または無効にします。これにより、ドライバーの最適化がバイパスされます。デフォルト=False。
--lock-volumeApnsTrue|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 仕様を指定されたボリュームタイプに関連付けます。

位置引数

<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 仕様を作成します。

位置引数

<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 仕様を削除します。

位置引数

<qos_specs>
削除する QoS 仕様の ID。

オプションの引数

--forceApnsTrue|False>]
使用中の 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 仕様の関連付けを解除します。

位置引数

<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 仕様の関連付けを解除します。

位置引数

<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 仕様のすべての関連付けを一覧表示します。

位置引数

<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 仕様の仕様を設定または設定解除します。

位置引数

<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 仕様を一覧表示します。

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 仕様の詳細を表示します。

位置引数

<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
クォータクラスのクォータを一覧表示します。

位置引数

<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
クォータクラスのクォータを更新します。

位置引数

<CLASS_NAME>
クォータを設定するクォータクラスの名前。

オプションの引数

--volumes <volumes>
新規のボリュームのクォータ値。デフォルトは None です。
--snapshots <snapshots>
新しい "snapshots" クォータ値。デフォルトは None です。
--gigabytes <gigabytes>
新しいギガバイトクォータ値。デフォルトは None です。
--volume-type <volume_type_name>
ボリュームタイプデフォルトは 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
テナントのデフォルトクォータを一覧表示します。

位置引数

<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
テナントのクォータを削除します。

位置引数

<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
テナントのクォータを一覧表示します。

位置引数

<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
テナントのクォータを更新します。

位置引数

<tenant_id>
クォータを設定するためのテナントの ID。

オプションの引数

--volumes <volumes>
新規のボリュームのクォータ値。デフォルトは None です。
--snapshots <snapshots>
新しい "snapshots" クォータ値。デフォルトは None です。
--gigabytes <gigabytes>
新しいギガバイトクォータ値。デフォルトは None です。
--backups <backups>
新しい backups クォータの値。デフォルトは None です。
--backup-gigabytes <backup_gigabytes>
新しい backup_gigabytes クォータ値。デフォルトは None です。
--consistencygroups <consistencygroups>
新しい consistencygroups クォータ値。デフォルトは None です。
--volume-type <volume_type_name>
ボリュームタイプデフォルトは None です。
--per-volume-gigabytes <per_volume_gigabytes>
最大ボリュームサイズ制限を設定します。デフォルトは 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
テナントのクォータ使用状況を一覧表示します。

位置引数

<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 フラグを更新します。

位置引数

<volume>
更新するボリュームの ID。
<true|true|False|false>
ボリュームの読み取り専用モードへの更新を有効または無効にします。

5.4.60. cinder rename (v2)

usage: cinder --os-volume-api-version 2 rename [--description <description>] <volume> [<name>]
Copy to Clipboard Toggle word wrap
ボリュームの名前を変更します。

位置引数

<volume>
名前を変更するボリュームの名前または ID。
<name>
ボリュームの新しい名前。

オプションの引数

--description <description>
ボリュームの説明。デフォルトは None です。

5.4.61. cinder replication-promote (v2)

usage: cinder --os-volume-api-version 2 replication-promote <volume>
Copy to Clipboard Toggle word wrap
関係のためにセカンダリーボリュームをプライマリーにプロモートします。

位置引数

<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
関係に対して、セカンダリーボリュームとプライマリーを同期します。

位置引数

<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 コンピューティングホストまたはインスタンスに接続されているかどうかに影響せず、ボリュームが使用できなくなる可能性があることに注意してください。データベースの変更としてのみ、これはボリュームの状態に影響を与えることはなく、実際の状態とは一致しない場合があります。これにより、available 状態への変更が発生した場合は、ボリュームが使用できなくなる可能性があります。

位置引数

<volume>
変更するボリュームの名前または ID。

オプションの引数

--state <state>
ボリュームに割り当てる状態。有効な値は、available、error、creating、deleting、in-use、attach、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
ボリュームのボリューム種別を変更します。

位置引数

<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
サービスを無効にします。

位置引数

<hostname>
Host name。
<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
サービスを有効にします。

位置引数

<hostname>
Host name。
<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>
Host name。デフォルトは None です。
--binary <binary>
サービスバイナリー。デフォルトは 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
ボリュームのブート可能ステータスを更新します。

位置引数

<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
ボリュームの詳細を表示します。

位置引数

<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
スナップショットを作成します。

位置引数

<volume>
スナップショットを作成するボリュームの名前または ID。

オプションの引数

--forceApnsTrue|False>]
ボリュームがインスタンスにアタッチされているときに、ボリュームのスナップショットを許可または禁止します。True に設定すると、ボリュームの現在のステータスを強制ではなく、スナップショットの試行時にそのボリュームのステータスを無視します。デフォルト=False。
--name <name>
スナップショット名。デフォルトは None です。
--description <description>
スナップショットの説明。デフォルトは None です。
--metadataApnskey=value>VARCHARkey=value> ...]]
スナップショットメタデータのキーと値のペア。デフォルトは 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
1 つ以上のスナップショットを削除します。

位置引数

<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-tenantsApns0|1>]
すべてのテナントの詳細を表示します。管理者のみ。
--name <name>
名前で結果をフィルタリングします。デフォルトは None です。
--status <status>
ステータスで結果をフィルタリングします。デフォルトは None です。
--volume-id <volume-id>
ボリューム ID で結果をフィルタリングします。デフォルトは 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
スナップショットメタデータを設定または削除します。

位置引数

<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
スナップショットのメタデータを表示します。

位置引数

<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
スナップショットのメタデータを更新します。

位置引数

<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
スナップショットの名前を変更します。

位置引数

<snapshot>
スナップショットの名前または ID。
<name>
スナップショットの新しい名前。

オプションの引数

--description <description>
スナップショットの説明。デフォルトは 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
スナップショットの状態を明示的に更新します。

位置引数

<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
スナップショットの詳細を表示します。

位置引数

<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
ボリュームの譲渡を受け入れます。

位置引数

<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
ボリューム譲渡を作成します。

位置引数

<volume>
譲渡するボリュームの名前または ID。

オプションの引数

--name <name>
転送名。デフォルトは None です。

5.4.81. cinder transfer-delete (v2)

usage: cinder --os-volume-api-version 2 transfer-delete <transfer>
Copy to Clipboard Toggle word wrap
転送を元に戻します。

位置引数

<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-tenantsApns0|1>]
すべてのテナントの詳細を表示します。管理者のみ。

5.4.83. cinder transfer-show (v2)

usage: cinder --os-volume-api-version 2 transfer-show <transfer>
Copy to Clipboard Toggle word wrap
転送の詳細を表示します。

位置引数

<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
ボリューム種別を作成します。

位置引数

<name>
新規ボリューム種別の名前。

オプションの引数

--description <description>
新規ボリュームタイプの説明。
--is-public <is-public>
タイプがパブリックにアクセスできるようにします (デフォルトは 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
ボリューム種別を削除します。

位置引数

<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 を設定または設定解除します。

位置引数

<vtype>
ボリュームタイプの名前または ID。
<action>
アクション。有効な値は set または unset です。
<key=value>
設定または設定解除する余分なスペックのキーと値のペアです。未設定の場合は、キーのみを指定します。

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
ボリューム種別の名前および説明を更新します。

位置引数

<id>
ボリュームタイプの ID。

オプションの引数

--name <name>
ボリュームタイプの名前。
--description <description>
ボリュームタイプの説明。

5.4.93. cinder unmanage (v2)

usage: cinder --os-volume-api-version 2 unmanage <volume>
Copy to Clipboard Toggle word wrap
ボリュームの管理を停止します。

位置引数

<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
イメージとして Image Service にボリュームをアップロードします。

位置引数

<volume>
スナップショットを作成するボリュームの名前または ID。
<image-name>
新しいイメージ名。

オプションの引数

--forceApnsTrue|False>]
インスタンスに接続されているボリュームのアップロードを有効または無効にします。デフォルト=False。
--container-format <container-format>
コンテナー形式タイプ。デフォルトはベアです。
--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
非推奨。代わりに制限を使用してください。
add-fixed-ip
ネットワーク上の新規 IP アドレスをサーバーに追加します。
add-floating-ip
非推奨。代わりに 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
バックアップタイプのスナップショットを作成して、サーバーをバックアップします。
boot
新しいサーバーを起動します。
clear-password
サーバーの管理者パスワードをクリアします。
cloudpipe-configure
cloudpipe インスタンスの VPN IP/ポートを更新します。
cloudpipe-create
指定のプロジェクトの cloudpipe インスタンスを作成します。
cloudpipe-list
すべての cloudpipe インスタンスの一覧を出力します。
console-log
サーバーのコンソールログ出力を取得します。
credentials
認証から返されたユーザーの認証情報を表示します。
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 エントリーを一覧表示します。
endpoints
認証サービスから返されたエンドポイントを検出します。
evacuate
障害が発生したホストからサーバーを退避します。
Fixed-ip-get
固定 IP の情報を取得します。
Fixed-ip-reserve
Fixed IP を予約します。
Fixed-ip-unreserve
固定 IP を維持解除します。
flavor-access-add
指定したテナントのフレーバーアクセスを追加します。
flavor-access-list
指定したフレーバーに関するアクセス情報を出力します。
flavor-access-remove
指定したテナントのフレーバーアクセスを削除します。
flavor-create
新規フレーバーの作成
flavor-delete
特定のフレーバーを削除します。
flavor-key
フレーバーの extra_spec を設定または設定解除します。
flavor-list
利用可能なflavor (サーバーのサイズ)の一覧を出力します。
flavor-show
指定したフレーバーの詳細を表示します。
floating-ip-associate
Floating IP アドレスをサーバーに割り当てます。
floating-ip-bulk-create
一括で、範囲別に Floating IP を作成します(nova- ネットワークのみ)。
floating-ip-bulk-delete
範囲別に Floating IP を一括削除します(nova- ネットワークのみ)。
floating-ip-bulk-list
すべての Floating IP を一覧表示します(nova-network のみ)。
floating-ip-create
現在のテナントの Floating IP を確保します。
floating-ip-delete
Floating IP の割り当てを解除します。
floating-ip-disassociate
サーバーから Floating IP アドレスの関連付けを解除します。
floating-ip-list
Floating IP を一覧表示します。
floating-ip-pool-list
すべての Floating IP アドレスプールを一覧表示します。
get-password
サーバーの管理者パスワードを取得します。
get-rdp-console
サーバーへの rdp コンソールを取得します。
get-serial-console
サーバーへのシリアルコンソールを取得します。
get-spice-console
サーバーへのスピンコンソールを取得します。
get-vnc-console
vnc コンソールをサーバーに取得します。
host-action
ホストで電源アクションを実行します。
host-describe
特定のホストを記述します。
host-list
サービス別にすべてのホストを一覧表示します。
host-update
ホスト設定を更新します。
hypervisor-list
ハイパーバイザーを一覧表示します。
hypervisor-servers
特定のハイパーバイザーに属するサーバーを一覧表示します。
hypervisor-show
指定したハイパーバイザーの詳細を表示します。
hypervisor-stats
すべてのコンピュートノードでのハイパーバイザーの統計値を取得します。
hypervisor-uptime
指定したハイパーバイザーの稼働時間を表示します。
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
サーバーのセキュリティーグループを一覧表示します。
live-migration
稼働中のサーバーを新しいマシンに移行します。
lock
サーバーをロックします。通常(管理者以外)ユーザーは、ロックされたサーバーでアクションを実行できません。
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
非推奨。代わりに制限を使用してください。
reboot
サーバーを再起動します。
rebuild
サーバーのシャットダウン、イメージの再作成、および再起動を行います。
refresh-network
サーバーのネットワーク情報をリフレッシュします。
remove-fixed-ip
サーバーから IP アドレスを削除します。
remove-floating-ip
非推奨。代わりに floating-ip-disassociate を使用してください。
remove-secgroup
サーバーからセキュリティーグループを削除します。
rename
サーバーの名前を変更します。
rescue
最初のイメージまたは指定されたイメージからマシンを起動するレスキューモードでサーバーを再起動し、現在のブートディスクをセカンダリーとして割り当てます。
reset-network
サーバーのネットワークをリセットします。
reset-state
サーバーの状態をリセットします。
サイズ変更
サーバーのサイズを変更します。
resize-confirm
前回のサイズ変更を確認します。
resize-revert
以前のサイズ変更を元に戻します(および以前の仮想マシンに戻ります)。
再開
サーバーを再開します。
root-password
非推奨。代わりに 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
新しいテナントの default セキュリティーグループに追加されるルールを一覧表示します。
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
サーバーの管理者パスワードを変更します。
shelve
サーバーを退避します。
shelve-offload
退避したサーバーをコンピュートノードから削除します。
表示
指定したサーバーの詳細を表示します。
ssh
サーバーに SSH を実行します。
start
サーバーを起動します。
stop
サーバーを停止します。
suspend
サーバーを一時停止します。
unlock
サーバーのロックを解除します。
unpause
サーバーの一時停止を解除します。
unrescue
通常のブートディスクからサーバーを再起動します。
復元
サーバーを復元します。
使用方法
単一のテナントの使用状況データを表示します。
usage-list
すべてのテナントの使用状況データを一覧表示します。
version-list
すべての API バージョンを一覧表示します。
volume-attach
サーバーにボリュームを接続します。
volume-create
非推奨: 新しいボリュームを追加します。
volume-delete
非推奨: ボリュームを削除します。
volume-detach
サーバーからボリュームを切断します。
volume-list
非推奨: すべてのボリュームを一覧表示します。
volume-show
非推奨: ボリュームの詳細を表示します。
volume-snapshot-create
非推奨: 新しいスナップショットを追加します。
volume-snapshot-delete
非推奨: スナップショットを削除します。
volume-snapshot-list
非推奨: すべてのスナップショットを一覧表示します。
volume-snapshot-show
非推奨: スナップショットの詳細を表示します。
volume-type-create
非推奨: 新しいボリューム種別を作成します。
volume-type-delete
非推奨: 特定のボリュームタイプを削除します。
volume-type-list
非推奨: 利用可能なボリュームタイプのリストを出力します。
volume-update
ボリュームアタッチメントを更新します。
x509-create-cert
テナント内のユーザーの x509 証明書を作成します。
x509-get-root-cert
x509 ルート証明書を取得します。
bash-completion
nova.bash_completion スクリプトでハードコードする必要がないように、すべてのコマンドおよびオプションを stdout に出力します。
help
このプログラムまたはそのサブコマンドのヘルプを表示します。
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
非推奨。代わりに tenant-network-show を使用してください。
net-create
非推奨。代わりに tenant-network-create を使用してください。
net-delete
非推奨。代わりに tenant-network-delete を使用してください。
net-list
非推奨。代わりに 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
Trust ID
--os-user-id OS_USER_ID
User ID
--os-user-name OS_USERNAME、--os-username OS_USERNAME
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>
サーバーの名前または ID。
<network-id>
ネットワーク ID。

6.4. nova add-secgroup

usage: nova add-secgroup <server> <secgroup>
Copy to Clipboard Toggle word wrap
セキュリティーグループをサーバーに追加します。

位置引数

<server>
サーバーの名前または ID。
<secgroup>
セキュリティーグループの名前。

6.5. nova agent-create

usage: nova agent-create <os> <architecture> <version> <url> <md5hash> <hypervisor>
Copy to Clipboard Toggle word wrap
新規エージェントビルドを作成します。

位置引数

<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
既存のエージェントビルドを削除します。

位置引数

<id>
エージェントビルドの 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
既存のエージェントビルドを変更します。

位置引数

<id>
エージェントビルドの 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
指定したアグリゲートにホストを追加します。

位置引数

<aggregate>
アグリゲートの名前または ID。
<host>
アグリゲートに追加するホスト。

6.10. Nova aggregate-create

usage: nova aggregate-create <name> [<availability-zone>]
Copy to Clipboard Toggle word wrap
指定された詳細で新しいアグリゲートを作成します。

位置引数

<name>
アグリゲートの名前。
<availability-zone>
アグリゲートのアベイラビリティーゾーン(オプション)。

6.11. Nova aggregate-delete

usage: nova aggregate-delete <aggregate>
Copy to Clipboard Toggle word wrap
アグリゲートを削除します。

位置引数

<aggregate>
削除するアグリゲートの名前または ID。

6.12. Nova aggregate-details

usage: nova aggregate-details <aggregate>
Copy to Clipboard Toggle word wrap
指定したアグリゲートの詳細を表示します。

位置引数

<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
指定したアグリゲートから指定のホストを削除します。

位置引数

<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
アグリゲートに関連付けられたメタデータを更新します。

位置引数

<aggregate>
更新するアグリゲートの名前または ID。
<key=value>
アグリゲートに追加/更新するメタデータ。メタデータ項目を削除するキーのみを指定します。

6.16. Nova aggregate-update

usage: nova aggregate-update <aggregate> <name> [<availability-zone>]
Copy to Clipboard Toggle word wrap
アグリゲートの名前を更新し、オプションでアベイラビリティーゾーンを更新します。

位置引数

<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
バックアップタイプのスナップショットを作成して、サーバーをバックアップします。

位置引数

<server>
サーバーの名前または ID。
<name>
バックアップイメージの名前。
<backup-type>
毎日や週単位などのバックアップタイプ。
<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
ベアメタルノードにネットワークインターフェイスを追加します。

位置引数

<node>
ノードの ID
<address>
インターフェイスの MAC アドレス

オプションの引数

--datapath_id <datapath_id>
インターフェイスの OpenFlow Datapath ID
--port_no <port_no>
OpenFlow ポート番号

6.20. nova baremetal-interface-list

usage: nova baremetal-interface-list <node>
Copy to Clipboard Toggle word wrap
ベアメタルノードに関連付けられたネットワークインターフェイスを一覧表示します。

位置引数

<node>
ノードの ID

6.21. nova baremetal-interface-remove

usage: nova baremetal-interface-remove <node> <address>
Copy to Clipboard Toggle word wrap
ベアメタルノードからネットワークインターフェイスを削除します。

位置引数

<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
ベアメタルノードを作成します。

位置引数

<SERVICE_HOST>
このベアメタルノードを制御する nova コンピュートホストの名前
<CPUs>
ノード内の CPU 数
<memory_mb>
ノード内の RAM のメガバイト
<local_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
ベアメタルノードと関連するインターフェイスを削除する。

位置引数

<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
ベアメタルノードに関する情報を表示します。

位置引数

<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
新しいサーバーを起動します。

位置引数

<name>
新しいサーバーの名前

オプションの引数

--flavor <flavor>
フレーバーの名前または ID (nova flavor-listを参照)
--image <image>
イメージの名前または ID (nova image-listを参照)。
--image-with <key=value>
Image メタデータのプロパティー(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 または volume_id のみ) source=source type (image、snapshot、volume または blank)、dest=destination タイプ(ボリュームまたはローカル)、bus=device's bus (例:uml)lxc、virtio、...; を省略すると、ハイパーバイザードライバーは適切なデフォルト(デバイスタイプが提供されている場合にのみ honed)を選択します。type=device タイプ(disk、cdrom、...、デフォルトは 'disk') device=name (vda、xda など)を選択します。省略した場合、ハイパーバイザードライバーは選択したバスに応じて適切なデバイスを選択します。ブロックデバイスの size=size (スワップ用)および GB (他の形式の場合)(省略されている場合、ハイパーバイザードライバーがサイズを計算)、format=device がフォーマットされます(例:swap、ntfs ...、任意)、ブートディスクの順序に使用される bootindex=integer (イメージをバックアップするインスタンスの場合)および shutdown=shutdown の動作(保存または削除のいずれか)と、shutdown=shutdown の動作(保存または削除など)削除するローカル宛先セットの場合)。
--swap <swap_size>
<swap_size> MB のローカルスワップブロックデバイスを作成して接続します。
--ephemeral
size=<size>[,format=<format>] ローカルの一時ブロックデバイス <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: この UUID を使用して NIC をネットワークに接続する必要があります(port-id または net-id のいずれかを指定する必要があります)。v4-fixed-ip: NIC の IPv4 固定アドレス、v6-fixed-ip: NIC の IPv6 固定アドレス(オプション)、port-id: NIC をこの UUID でポートに接続します(port-id または net-id のいずれかを指定する必要があります)。
--config-drive <value>
コンフィグドライブを有効にする
--poll
サーバーの起動が完了するまで、新しいサーバーの起動の進行状況を報告します。
--admin-pass <value>
インスタンスの管理者パスワード

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
指定したセルの詳細を表示します。

位置引数

<cell-name>
セルの名前です。

6.29. nova clear-password

usage: nova clear-password <server>
Copy to Clipboard Toggle word wrap
サーバーの管理者パスワードをクリアします。

位置引数

<server>
サーバーの名前または ID。

6.30. nova cloudpipe-configure

usage: nova cloudpipe-configure <ip address> <port>
Copy to Clipboard Toggle word wrap
cloudpipe インスタンスの VPN IP/ポートを更新します。

位置引数

<IP address>
新しい IP アドレス。
<port>
新しいポート。

6.31. nova cloudpipe-create

usage: nova cloudpipe-create <project_id>
Copy to Clipboard Toggle word wrap
指定のプロジェクトの cloudpipe インスタンスを作成します。

位置引数

<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
サーバーのコンソールログ出力を取得します。

位置引数

<server>
サーバーの名前または ID。

オプションの引数

--length <length>
テールする行の長さ。

6.34. Nova の認証情報

usage: nova credentials [--wrap <integer>]
Copy to Clipboard Toggle word wrap
認証から返されたユーザーの認証情報を表示します。

オプションの引数

--wrap <integer>
PKI トークンを指定された長さにラップ、または 0 は無効にする

6.35. nova delete

usage: nova delete [--all-tenants] <server> [<server> ...]
Copy to Clipboard Toggle word wrap
指定したサーバーをすぐにシャットダウンして削除します。

位置引数

<server>
サーバーの名前または ID。

オプションの引数

--all-tenants
名前(管理者のみ)で別のテナントのサーバーを削除します。

6.36. Nova 診断

usage: nova diagnostics <server>
Copy to Clipboard Toggle word wrap
サーバーの診断を取得します。

位置引数

<server>
サーバーの名前または ID。

6.37. nova dns-create

usage: nova dns-create [--type <type>] <ip> <name> <domain>
Copy to Clipboard Toggle word wrap
ドメイン、名前、および IP の DNS エントリーを作成します。

位置引数

<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 ドメインを作成します。

位置引数

<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 ドメインを作成します。

位置引数

<domain>
DNS ドメイン

オプションの引数

--project <project>
このドメインへのアクセスを指定されたプロジェクトのユーザーに制限します。

6.40. nova dns-delete

usage: nova dns-delete <domain> <name>
Copy to Clipboard Toggle word wrap
指定した DNS エントリーを削除します。

位置引数

<domain>
DNS ドメイン
<name>
DNS 名

6.41. nova dns-delete-domain

usage: nova dns-delete-domain <domain>
Copy to Clipboard Toggle word wrap
指定した DNS ドメインを削除します。

位置引数

<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 エントリーを一覧表示します。

位置引数

<domain>
DNS ドメイン

オプションの引数

--ip <ip>
IP アドレス
--name <name>
DNS 名

6.44. Nova エンドポイント

usage: nova endpoints
Copy to Clipboard Toggle word wrap
認証サービスから返されたエンドポイントを検出します。

6.45. Nova 退避

usage: nova evacuate [--password <password>] [--on-shared-storage] <server> [<host>]
Copy to Clipboard Toggle word wrap
障害が発生したホストからサーバーを退避します。

位置引数

<server>
サーバーの名前または ID。
<host>
ターゲットホストの名前または ID。ホストが指定されていない場合、スケジューラーは 1 つを選択します。

オプションの引数

--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 の情報を取得します。

位置引数

<fixed_ip>
Fixed IP Address。

6.47. nova fixed-ip-reserve

usage: nova fixed-ip-reserve <fixed_ip>
Copy to Clipboard Toggle word wrap
Fixed IP を予約します。

位置引数

<fixed_ip>
Fixed IP Address。

6.48. nova fixed-ip-unreserve

usage: nova fixed-ip-unreserve <fixed_ip>
Copy to Clipboard Toggle word wrap
固定 IP を維持解除します。

位置引数

<fixed_ip>
Fixed IP Address。

6.49. nova flavor-access-add

usage: nova flavor-access-add <flavor> <tenant_id>
Copy to Clipboard Toggle word wrap
指定したテナントのフレーバーアクセスを追加します。

位置引数

<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
指定したテナントのフレーバーアクセスを削除します。

位置引数

<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
新規フレーバーの作成

位置引数

<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
特定のフレーバーを削除します。

位置引数

<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 を設定または設定解除します。

位置引数

<flavor>
フレーバーの名前または ID
<action>
Actions: 'set' または 'unset'
<key=value>
設定/未設定の extra_specs (未設定の場合はキーのみが必要になります)

6.55. nova flavor-list

usage: nova flavor-list [--extra-specs] [--all]
Copy to Clipboard Toggle word wrap
利用可能なflavor (サーバーのサイズ)の一覧を出力します。

オプションの引数

--extra-specs
各フレーバーの追加スペックを取得します。
--all
すべてのフレーバーを表示します(管理者のみ)。

6.56. nova flavor-show

usage: nova flavor-show <flavor>
Copy to Clipboard Toggle word wrap
指定したフレーバーの詳細を表示します。

位置引数

<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
Floating IP アドレスをサーバーに割り当てます。

位置引数

<server>
サーバーの名前または ID。
<address>
IP Address。

オプションの引数

--fixed-address <fixed_address>
関連付ける Fixed 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
範囲別(nova-network のみ)で Floating IP を作成します。

位置引数

<range>
作成するアドレス範囲

オプションの引数

--pool <pool>
新規 Floating IP のプール
--interface <interface>
新規 Floating IP のインターフェイス

6.59. nova floating-ip-bulk-delete

usage: nova floating-ip-bulk-delete <range>
Copy to Clipboard Toggle word wrap
範囲ごとに Floating IP を一括で削除します(nova-network のみ)。

位置引数

<range>
削除するアドレス範囲

6.60. nova floating-ip-bulk-list

usage: nova floating-ip-bulk-list [--host <host>]
Copy to Clipboard Toggle word wrap
すべての Floating 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
現在のテナントの Floating IP を確保します。

位置引数

<floating-ip-pool>
Floating IP プールの名前。(オプション)

6.62. nova floating-ip-delete

usage: nova floating-ip-delete <address>
Copy to Clipboard Toggle word wrap
Floating IP の割り当てを解除します。

位置引数

<address>
Floating IP の IP

6.63. nova floating-ip-disassociate

usage: nova floating-ip-disassociate <server> <address>
Copy to Clipboard Toggle word wrap
サーバーから Floating IP アドレスの関連付けを解除します。

位置引数

<server>
サーバーの名前または ID。
<address>
IP Address。

6.64. nova floating-ip-list

usage: nova floating-ip-list
Copy to Clipboard Toggle word wrap
Floating IP を一覧表示します。

6.65. nova floating-ip-pool-list

usage: nova floating-ip-pool-list
Copy to Clipboard Toggle word wrap
すべての Floating IP アドレスプールを一覧表示します。

6.66. nova force-delete

usage: nova force-delete <server>
Copy to Clipboard Toggle word wrap
サーバーを強制的に削除します。

位置引数

<server>
サーバーの名前または ID。

6.67. nova get-password

usage: nova get-password <server> [<private-key>]
Copy to Clipboard Toggle word wrap
サーバーの管理者パスワードを取得します。

位置引数

<server>
サーバーの名前または ID。
<private-key>
秘密鍵(パスワードの復号化にローカルで使用)(オプション)。指定すると、コマンドはクリア(復号化された)VM パスワードを表示します。指定しない場合、暗号された VM パスワードが表示されます。

6.68. nova get-rdp-console

usage: nova get-rdp-console <server> <console-type>
Copy to Clipboard Toggle word wrap
サーバーへの rdp コンソールを取得します。

位置引数

<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
サーバーへのシリアルコンソールを取得します。

位置引数

<server>
サーバーの名前または ID。

オプションの引数

--console_type CONSOLE_TYPE
シリアルコンソールのタイプ(default="serial")。

6.70. nova get-spice-console

usage: nova get-spice-console <server> <console-type>
Copy to Clipboard Toggle word wrap
サーバーへのスピンコンソールを取得します。

位置引数

<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 コンソールをサーバーに取得します。

位置引数

<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
ホストで電源アクションを実行します。

位置引数

<hostname>
ホストの名前。

オプションの引数

--action <action>
電源アクション:起動、再起動、またはシャットダウン。

6.73. Nova host-describe

usage: nova host-describe <hostname>
Copy to Clipboard Toggle word wrap
特定のホストを記述します。

位置引数

<hostname>
ホストの名前。

6.74. Nova host-evacuate

usage: nova host-evacuate [--target_host <target_host>] [--on-shared-storage] <host>
Copy to Clipboard Toggle word wrap
障害が発生したホストからすべてのインスタンスを退避します。

位置引数

<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
指定したホストのインスタンスをすべて利用可能な他のホストにライブマイグレーションします。

位置引数

<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
ホストのすべてのインスタンスでメタデータを設定または削除します。

位置引数

<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
指定したホストのインスタンスをすべて利用可能な他のホストに移行します。

位置引数

<host>
ホストの名前。

6.79. Nova host-update

usage: nova host-update [--status <enable|disable>] [--maintenance <enable|disable>] <hostname>
Copy to Clipboard Toggle word wrap
ホスト設定を更新します。

位置引数

<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> に一致するハイパーバイザーを一覧表示します。

6.81. Nova hypervisor-servers

usage: nova hypervisor-servers <hostname>
Copy to Clipboard Toggle word wrap
特定のハイパーバイザーに属するサーバーを一覧表示します。

位置引数

<hostname>
検索するハイパーバイザーのホスト名(またはパターン)。

6.82. Nova hypervisor-show

usage: nova hypervisor-show [--wrap <integer>] <hypervisor>
Copy to Clipboard Toggle word wrap
指定したハイパーバイザーの詳細を表示します。

位置引数

<hypervisor>
詳細を表示するハイパーバイザーの名前または ID。

オプションの引数

--wrap <integer>
出力を指定の長さにラップします。デフォルトは 40 または 0 (無効にする)

6.83. nova hypervisor-stats

usage: nova hypervisor-stats
Copy to Clipboard Toggle word wrap
すべてのコンピュートノードでのハイパーバイザーの統計値を取得します。
警告
一時ストレージのバックエンドとして Red Hat Ceph を使用する場合、Compute サービスは利用可能なストレージの量を正しく計算しません。具体的には、Compute は、レプリケーションを考慮せずに、利用可能なストレージの量を追加します。これにより、grossly overstated の利用可能なストレージが発生し、予期しないストレージがオーバーサブスクリプションになる可能性があります。
正しい一時ストレージ容量を決定するには、代わりに Ceph サービスに直接クエリーを実行します。詳細は、BZ#1236473 を参照してください。

6.84. Nova ハイパーバイザーアップタイム

usage: nova hypervisor-uptime <hypervisor>
Copy to Clipboard Toggle word wrap
指定したハイパーバイザーの稼働時間を表示します。

位置引数

<hypervisor>
アップタイムを表示するハイパーバイザーの名前または ID。

6.85. nova image-create

usage: nova image-create [--show] [--poll] <server> <name>
Copy to Clipboard Toggle word wrap
稼働中のサーバーのスナップショットを作成して、新規イメージを作成します。

位置引数

<server>
サーバーの名前または ID。
<name>
スナップショットの名前。

オプションの引数

--show
イメージ情報を出力します。
--poll
スナップショットの作成が完了するまで、スナップショットの作成の進捗を報告し、ポーリングします。

6.86. nova image-delete

usage: nova image-delete <image> [<image> ...]
Copy to Clipboard Toggle word wrap
指定したイメージを削除します。

位置引数

<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
イメージのメタデータを設定または削除する。

位置引数

<image>
イメージの名前または ID
<action>
Actions: 'set' または 'delete'
<key=value>
追加/更新/削除するメタデータ(削除時にキーのみが必要になります)

6.89. nova image-show

usage: nova image-show <image>
Copy to Clipboard Toggle word wrap
特定のイメージの詳細を表示します。

位置引数

<image>
イメージの名前または ID

6.90. nova instance-action

usage: nova instance-action <server> <request_id>
Copy to Clipboard Toggle word wrap
アクションを表示します。

位置引数

<server>
アクションを表示するサーバーの名前または UUID。
<request_id>
取得するアクションのリクエスト ID。

6.91. nova instance-action-list

usage: nova instance-action-list <server>
Copy to Clipboard Toggle word wrap
サーバー上のアクションを一覧表示します。

位置引数

<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
ネットワークインターフェイスをサーバーに接続します。

位置引数

<server>
サーバーの名前または ID。

オプションの引数

--port-id <port_id>
Port 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
サーバーからネットワークインターフェイスを切断します。

位置引数

<server>
サーバーの名前または ID。
<port_id>
Port ID。

6.94. Nova interface-list

usage: nova interface-list <server>
Copy to Clipboard Toggle word wrap
サーバーに接続されているインターフェイスを一覧表示します。

位置引数

<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
サーバーで使用する新しいキーペアを作成します。

位置引数

<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
名前で指定されたキーペアを削除します。

位置引数

<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
指定したキーペアの詳細を表示します。

位置引数

<keypair>
キーペアの名前。

6.99. Nova の制限

usage: nova limits [--tenant [<tenant>]] [--reserved]
Copy to Clipboard Toggle word wrap
レートと絶対制限を出力します。

オプションの引数

--tenantVARCHARtenant>]
単一のテナントからの情報を表示します(管理者のみ)。
--reserved
予約数が含まれます。

6.100. Nova list

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-tenantsApns0|1>]
すべてのテナントの情報を表示します(管理者のみ)。
--tenantVARCHARtenant>]
単一のテナントからの情報を表示します(管理者のみ)。
--userApnsuser>]
単一ユーザーからの情報を表示します(管理者のみ)。
--deleted
削除されたサーバーのみを表示します(管理者のみ)。
--fields <fields>
表示するフィールドのコンマ区切りリスト。show コマンドで、どのフィールドが表示されるかを確認します。
--minimal
uuid と name のみを取得します。
--sort <key>[:<direction>]
<key>[:<asc|desc>] 形式の、ソートキーと方向のコンマ区切りリスト。指定がない場合、デフォルトで方向は降順になります。
--marker <marker>
前のページの最後のサーバーの 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
サーバーのセキュリティーグループを一覧表示します。

位置引数

<server>
サーバーの名前または ID。

6.103. Nova live-migration

usage: nova live-migration [--block-migrate] [--disk-over-commit] <server> [<host>]
Copy to Clipboard Toggle word wrap
稼働中のサーバーを新しいマシンに移行します。

位置引数

<server>
サーバーの名前または ID。
<host>
宛先ホスト名。

オプションの引数

--block-migrate
block_migration の場合は true。(default=False:live_migration)
--disk-over-commit
オーバーコミットを許可します。(Default=False)

6.104. Nova lock

usage: nova lock <server>
Copy to Clipboard Toggle word wrap
サーバーをロックします。通常(管理者以外)ユーザーは、ロックされたサーバーでアクションを実行できません。

位置引数

<server>
サーバーの名前または ID。

6.105. Nova meta

usage: nova meta <server> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
サーバーでメタデータを設定または削除 します。

位置引数

<server>
サーバーの名前または ID
<action>
Actions: 'set' または 'delete'
<key=value>
設定または削除するメタデータ(削除時にキーのみが必要になります)

6.106. Nova の移行

usage: nova migrate [--poll] <server>
Copy to Clipboard Toggle word wrap
サーバーを移行します。新規ホストはスケジューラーによって選択されます。

位置引数

<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
ホストをネットワークに関連付けます。

位置引数

<network>
ネットワークの UUID
<host>
ホスト名

6.109. nova network-associate-project

usage: nova network-associate-project <network>
Copy to Clipboard Toggle word wrap
プロジェクトとネットワークを関連付けます。

位置引数

<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
ネットワークの作成

位置引数

<network_label>
ネットワークのラベル

オプションの引数

--fixed-range-v4
IPv4 サブネット(例: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 start
--gateway GATEWAY
gateway
--gateway-v6
GATEWAY_V6 IPv6 ゲートウェイ
--bridge <bridge>
このネットワーク上の VIF は、このブリッジに接続されています。
--bridge-interface <bridge interface>
ブリッジは、このインターフェイスに接続されます。
--multi-host <'T'|'F'>
マルチホスト
--dns1 <DNS Address>
最初の DNS
--dns2 <DNS Address>
2 番目の DNS
--uuid <network uuid>
ネットワーク UUID
--fixed-cidr
固定 IP の IPv4 サブネット(例:10.20.0.0/16)
--project-id <project id>
プロジェクト ID
--priority <number>
ネットワークインターフェイスの優先度
--mtu MTU
mtu for network
--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 別にネットワークを削除します。

位置引数

<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
ホストやプロジェクトを指定のネットワークから関連付け解除します。

位置引数

<network>
ネットワークの UUID

オプションの引数

--host-onlyApns0|1>]
--project-only iwl0|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
指定したネットワークの詳細を表示します。

位置引数

<network>
ネットワークの UUID またはラベル

6.115. Nova pause

usage: nova pause <server>
Copy to Clipboard Toggle word wrap
サーバーを一時停止します。

位置引数

<server>
サーバーの名前または ID。

6.116. Nova quota-class-show

usage: nova quota-class-show <class>
Copy to Clipboard Toggle word wrap
クォータクラスのクォータを一覧表示します。

位置引数

<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
クォータクラスのクォータを更新します。

位置引数

<class>
クォータを設定するためのクォータクラスの名前。

オプションの引数

--instances <instances>
instances クォータの新しい値。
--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
テナント/ユーザーのクォータを更新します。

位置引数

<tenant-id>
クォータを設定するテナントの ID。

オプションの引数

--user <user-id>
クォータを設定するユーザーの ID。
--instances <instances>
instances クォータの新しい値。
--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
サーバーを再起動します。

位置引数

<server>
サーバーの名前または ID。

オプションの引数

--hard
ソフト再起動の代わりに(ソフトリブートの代わりに)ハードリブートを実行します。
--poll
再起動が完了するまでポーリングします。

6.123. Nova rebuild

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
サーバーのシャットダウン、イメージの再作成、および再起動を行います。

位置引数

<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
サーバーのネットワーク情報をリフレッシュします。

位置引数

<server>
ネットワークキャッシュを neutron から更新するサーバーの名前または ID (管理者のみ)。

6.125. nova remove-fixed-ip

usage: nova remove-fixed-ip <server> <address>
Copy to Clipboard Toggle word wrap
サーバーから IP アドレスを削除します。

位置引数

<server>
サーバーの名前または ID。
<address>
IP Address。

6.126. nova remove-secgroup

usage: nova remove-secgroup <server> <secgroup>
Copy to Clipboard Toggle word wrap
サーバーからセキュリティーグループを削除します。

位置引数

<server>
サーバーの名前または ID。
<secgroup>
セキュリティーグループの名前。

6.127. Nova rename

usage: nova rename <server> <name>
Copy to Clipboard Toggle word wrap
サーバーの名前を変更します。

位置引数

<server>
名前(古い名前)またはサーバー ID。
<name>
サーバーの新しい名前。

6.128. Nova rescue

usage: nova rescue [--password <password>] [--image <image>] <server>
Copy to Clipboard Toggle word wrap
最初のイメージまたは指定されたイメージからマシンを起動するレスキューモードでサーバーを再起動し、現在のブートディスクをセカンダリーとして割り当てます。

位置引数

<server>
サーバーの名前または ID。

オプションの引数

--password <password>
レスキュー環境で設定される admin パスワード。
--image <image>
レスキューするイメージ。

6.129. nova reset-network

usage: nova reset-network <server>
Copy to Clipboard Toggle word wrap
サーバーのネットワークをリセットします。

位置引数

<server>
サーバーの名前または ID。

6.130. nova reset-state

usage: nova reset-state [--active] <server> [<server> ...]
Copy to Clipboard Toggle word wrap
サーバーの状態をリセットします。

位置引数

<server>
サーバーの名前または ID。

オプションの引数

--active
サーバーをエラー状態ではなくアクティブ状態にリセットするように要求します(デフォルト)。

6.131. Nova resize

usage: nova resize [--poll] <server> <flavor>
Copy to Clipboard Toggle word wrap
サーバーのサイズを変更します。

位置引数

<server>
サーバーの名前または ID。
<flavor>
新規フレーバーの名前または ID

オプションの引数

--poll
サーバーのサイズ変更の進捗を、完了するまで報告します。

6.132. nova resize-confirm

usage: nova resize-confirm <server>
Copy to Clipboard Toggle word wrap
前回のサイズ変更を確認します。

位置引数

<server>
サーバーの名前または ID。

6.133. nova resize-revert

usage: nova resize-revert <server>
Copy to Clipboard Toggle word wrap
以前のサイズ変更を元に戻します(および以前の仮想マシンに戻ります)。

位置引数

<server>
サーバーの名前または ID。

6.134. Nova restore

usage: nova restore <server>
Copy to Clipboard Toggle word wrap
ソフト削除されたサーバーを復元します。

位置引数

<server>
サーバーの名前または ID。

6.135. Nova resume

usage: nova resume <server>
Copy to Clipboard Toggle word wrap
サーバーを再開します。

位置引数

<server>
サーバーの名前または ID。

6.136. Nova scrub

usage: nova scrub <project_id>
Copy to Clipboard Toggle word wrap
プロジェクトに関連付けられたネットワークとセキュリティーグループを削除します。

位置引数

<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 のみ)のデフォルトのセキュリティーグループに追加されるルールセットにルールを追加します。

位置引数

<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
ソースグループルールをセキュリティーグループに追加します。

位置引数

<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
セキュリティーグループにルールを追加します。

位置引数

<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
セキュリティーグループを作成します。

位置引数

<name>
セキュリティーグループの名前。
<description>
セキュリティーグループの説明。

6.141. nova secgroup-delete

usage: nova secgroup-delete <secgroup>
Copy to Clipboard Toggle word wrap
セキュリティーグループを削除します。

位置引数

<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 のみ)に対してデフォルトのセキュリティーグループに追加されるルールセットからルールを削除します。

位置引数

<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
セキュリティーグループからソースグループルールを削除します。

位置引数

<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
セキュリティーグループからルールを削除します。

位置引数

<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-tenantsApns0|1>]
すべてのテナントの情報を表示します(管理者のみ)。

6.146. nova secgroup-list-default-rules

usage: nova secgroup-list-default-rules
Copy to Clipboard Toggle word wrap
新しいテナントの default セキュリティーグループに追加されるルールを一覧表示します。

6.147. nova secgroup-list-rules

usage: nova secgroup-list-rules <secgroup>
Copy to Clipboard Toggle word wrap
セキュリティーグループのルールを一覧表示します。

位置引数

<secgroup>
セキュリティーグループの ID または名前。

6.148. nova secgroup-update

usage: nova secgroup-update <secgroup> <name> <description>
Copy to Clipboard Toggle word wrap
セキュリティーグループを更新します。

位置引数

<secgroup>
セキュリティーグループの ID または名前。
<name>
セキュリティーグループの名前。
<description>
セキュリティーグループの説明。

6.149. nova server-group-create

usage: nova server-group-create <name> [<policy> [<policy> ...]]
Copy to Clipboard Toggle word wrap
指定の詳細で新しいサーバーグループを作成します。

位置引数

<name>
サーバーグループ名。
<policy>
サーバーグループのポリシー(affinity またはanti-affinity)

6.150. nova server-group-delete

usage: nova server-group-delete <id> [<id> ...]
Copy to Clipboard Toggle word wrap
特定のサーバーグループを削除します。

位置引数

<id>
削除するサーバーグループの一意の ID

6.151. nova server-group-get

usage: nova server-group-get <id>
Copy to Clipboard Toggle word wrap
特定のサーバーグループを取得します。

位置引数

<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
サービスを削除します。

位置引数

<id>
サービスの ID。

6.154. Nova service-disable

usage: nova service-disable [--reason <reason>] <hostname> <binary>
Copy to Clipboard Toggle word wrap
サービスを無効にします。

位置引数

<hostname>
ホストの名前。
<binary>
サービスバイナリー。

オプションの引数

--reason <reason>
サービスを無効にする理由。

6.155. Nova service-enable

usage: nova service-enable <hostname> <binary>
Copy to Clipboard Toggle word wrap
サービスを有効にします。

位置引数

<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')

位置引数

<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
サーバーの管理者パスワードを変更します。

位置引数

<server>
サーバーの名前または ID。

6.159. Nova shelve

usage: nova shelve <server>
Copy to Clipboard Toggle word wrap
サーバーを退避します。

位置引数

<server>
サーバーの名前または ID。

6.160. nova shelve-offload

usage: nova shelve-offload <server>
Copy to Clipboard Toggle word wrap
退避したサーバーをコンピュートノードから削除します。

位置引数

<server>
サーバーの名前または ID。

6.161. nova show

usage: nova show [--minimal] <server>
Copy to Clipboard Toggle word wrap
指定したサーバーの詳細を表示します。

位置引数

<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 を実行します。

位置引数

<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
サーバーを起動します。

位置引数

<server>
サーバーの名前または ID。

6.164. Nova stop

usage: nova stop <server> [<server> ...]
Copy to Clipboard Toggle word wrap
サーバーを停止します。

位置引数

<server>
サーバーの名前または ID。

6.165. Nova suspend

usage: nova suspend <server>
Copy to Clipboard Toggle word wrap
サーバーを一時停止します。

位置引数

<server>
サーバーの名前または ID。

6.166. nova tenant-network-create

usage: nova tenant-network-create <network_label> <cidr>
Copy to Clipboard Toggle word wrap
テナントネットワークを作成します。

位置引数

<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
テナントネットワークを削除します。

位置引数

<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
テナントネットワークを表示します。

位置引数

<network_id>
ネットワークの ID

6.170. Nova unlock

usage: nova unlock <server>
Copy to Clipboard Toggle word wrap
サーバーのロックを解除します。

位置引数

<server>
サーバーの名前または ID。

6.171. Nova の一時停止解除

usage: nova unpause <server>
Copy to Clipboard Toggle word wrap
サーバーの一時停止を解除します。

位置引数

<server>
サーバーの名前または ID。

6.172. Nova unrescue

usage: nova unrescue <server>
Copy to Clipboard Toggle word wrap
通常のブートディスクからサーバーを再起動します。

位置引数

<server>
サーバーの名前または ID。

6.173. Nova unshelve

usage: nova unshelve <server>
Copy to Clipboard Toggle word wrap
サーバーを復元します。

位置引数

<server>
サーバーの名前または ID。

6.174. Nova の使用状況

usage: nova usage [--start <start>] [--end <end>] [--tenant <tenant-id>]
Copy to Clipboard Toggle word wrap
単一のテナントの使用状況データを表示します。

オプションの引数

--start <start>
使用範囲の開始日 ex 2012-01-20 (デフォルト:4 週間前)
--end <end>
使用範囲の終了日 (例: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>
使用範囲の開始日 ex 2012-01-20 (デフォルト:4 週間前)
--end <end>
使用範囲の終了日 (例: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
サーバーにボリュームを接続します。

位置引数

<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
サーバーからボリュームを切断します。

位置引数

<server>
サーバーの名前または ID。
<volume>
デタッチするボリュームの ID。

6.179. nova volume-update

usage: nova volume-update <server> <attachment> <volume>
Copy to Clipboard Toggle word wrap
ボリュームアタッチメントを更新します。

位置引数

<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 証明書を作成します。

位置引数

<private-key-filename>
秘密鍵のファイル名 [デフォルト:pk.pem]
X.509 証明書のファイル名 [デフォルト:cert.pem]

6.181. nova x509-get-root-cert

usage: nova x509-get-root-cert [<filename>]
Copy to Clipboard Toggle word wrap
x509 ルート証明書を取得します。

位置引数

<filename>
x509 ルート証明書を書き込むファイル名。

第7章 Identity サービスのコマンドラインクライアント

警告
keystone CLI は非推奨となり、python-openstackclient が採用されました。python-openstackclient の詳細は、「サブコマンド」 を参照してください。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 Catalog に追加します。
service-delete
サービスカタログからサービスを削除します。
service-get
サービスカタログからサービスを表示します。
service-list
サービスカタログのすべてのサービスを一覧表示します。
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 に出力します。
help
このプログラムまたはそのサブコマンドのヘルプを表示します。

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>
認証に使用する Identity エンドポイントを指定します。デフォルトは 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>
作成するユーザーの名前(デフォルトは admin)です。
--pass <password>
新しいユーザーのパスワード。
--role-name <role-name>
ユーザーに作成して付与されるロールの名前(デフォルトは admin)。
--tenant-name <tenant-name>
作成するテナントの名前(デフォルト="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>
選択について照合する service 属性。
--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
サービスを Service Catalog に追加します。

引数

--type <type>
サービスタイプ(ID、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>
削除するサービスの名前または 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
サービスカタログのすべてのサービスを一覧表示します。

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>
新規ユーザーのデフォルトテナント。
--passApnspass>]
新たなユーザーパスワード。一部の認証バックエンドに必要。
--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章 Image Service コマンドラインクライアント

glance クライアントは、Image サービス 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 証明書のパス。このオプションを指定しないと、デフォルトのシステム 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>
イメージを起動するために必要なディスクの最小サイズ(ギガバイト単位)。
--min-ram <DISK_RAM>
イメージの起動に必要な最小 RAM の量(メガバイト単位)。
--location <IMAGE_URL>
このイメージのデータがすでに存在する URL。たとえば、イメージデータが swift に保存されている場合は、swift+http://tenant%3Aaccount:key@auth_ url/v2.0/container/obj を指定できます。(注記:'%3A' は ':' URL エンコード)
--file <FILE>
作成時にアップロードされるディスクイメージを含むローカルファイル。別の方法では、標準入力(stdin)でイメージをクライアントに渡すことができます。
--checksum <CHECKSUM>
Glance を使用して検証に使用するイメージデータのハッシュ。ここで md5 チェックサムを提供します。
--copy-from <IMAGE_URL>
用途が '--location' と同様ですが、これは Glance サーバーがデータをすぐにコピーして、設定済みのイメージストアに保存する必要があることを示しています。
注記
The --copy-from オプションは、Red Hat OpenStack Platform 8 リリースの glance v2 では非推奨となり、v1 では非推奨になりました。また、Red Hat OpenStack Platform の今後のリリースでも非推奨になる予定です。
--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
指定したイメージを削除します。

位置引数

<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
特定のイメージをダウンロードします。

位置引数

<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
特定のイメージを記述します。

位置引数

<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
特定のイメージを更新します。

位置引数

<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>
イメージを起動するために必要なディスクの最小サイズ(ギガバイト単位)。
--min-ram <DISK_RAM>
イメージの起動に必要な最小 RAM の量(メガバイト単位)。
--location <IMAGE_URL>
このイメージのデータがすでに存在する URL。たとえば、イメージデータが swift に保存されている場合は、swift+http://tenant%3Aaccount:key@auth_ url/v2.0/container/obj を指定できます。(注記:'%3A' は ':' URL エンコード)このオプションは、'queued' ステータスのイメージでのみ機能します。
--file <FILE>
更新中にアップロードされるディスクイメージを含むローカルファイル。別の方法では、標準入力(stdin)でイメージをクライアントに渡すことができます。
--checksum <CHECKSUM>
Glance を使用して検証に使用するイメージデータのハッシュ。
--copy-from <IMAGE_URL>
用途が '--location' と同様ですが、これは Glance サーバーがデータをすぐにコピーして、設定済みのイメージストアに保存する必要があることを示しています。このオプションは、'queued' ステータスのイメージでのみ機能します。
注記
The --copy-from オプションは、Red Hat OpenStack Platform 8 リリースの glance v2 では非推奨となり、v1 では非推奨になりました。また、Red Hat OpenStack Platform の今後のリリースでも非推奨になる予定です。
--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
特定のイメージをテナントと共有します。

位置引数

<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
共有イメージをテナントから削除します。

位置引数

<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 コマンド

使用する API バージョンを選択するには、--os-image-api-version パラメーターを追加するか、対応する環境変数を設定します。
$ 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
特定のモデルを説明します。

位置引数

<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>
AMI 形式のイメージをブートする際にカーネルとして使用する必要のある Glance に保管されているイメージの ID
--tags <TAGS> [<TAGS> ...]
イメージに関連する文字列のリスト
--os-version <OS_VERSION>
ディストリビューターによって指定されるオペレーティングシステムのバージョン
--disk-format <DISK_FORMAT>
ディスク有効な値の形式: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>
AMI 形式のイメージをブートする際に ramdisk として使用する必要のある、Glance に保存されているイメージの ID
--min-ram <MIN_RAM>
イメージの起動に必要な ram の量(MB)。
--container-format <CONTAINER_FORMAT>
コンテナーの有効な値の形式: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
指定したイメージを削除します。

位置引数

<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
特定のイメージをダウンロードします。

位置引数

<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
特定のイメージを記述します。

位置引数

<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
指定のイメージに関連付けられたタグを削除します。

位置引数

<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
指定されたタグでイメージを更新します。

位置引数

<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
既存イメージを更新します。

位置引数

<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>
AMI 形式のイメージをブートする際にカーネルとして使用する必要のある Glance に保管されているイメージの ID
--os-version <OS_VERSION>
ディストリビューターによって指定されるオペレーティングシステムのバージョン
--disk-format <DISK_FORMAT>
ディスク有効な値の形式: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>
AMI 形式のイメージをブートする際に ramdisk として使用する必要のある、Glance に保存されているイメージの ID
--min-ram <MIN_RAM>
イメージの起動に必要な ram の量(MB)。
--container-format <CONTAINER_FORMAT>
コンテナーの有効な値の形式: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
特定のイメージのデータをアップロードします。

位置引数

<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
イメージに場所(および関連するメタデータ)を追加します。

位置引数

<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
イメージから場所(および関連するメタデータ)を削除します。

位置引数

<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
イメージの場所のメタデータを更新します。

位置引数

<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
新規メタデータ定義の namespace を作成します。

位置引数

<NAMESPACE>
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
指定されたメタデータ定義の namespace をそのコンテンツとともに削除します。

位置引数

<NAMESPACE>
削除する 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
メタデータ定義の namespace を一覧表示します。

オプションの引数

--resource-types <RESOURCE_TYPES>
namespace をフィルターするリソースタイプ。
--visibility <VISIBILITY>
namespace をフィルタリングするための visibility パラメーター。
--page-size <SIZE>
各ページネーションリクエストで要求する namespace 数。

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
特定の namespace 内のメタデータ定義オブジェクトを削除します。

位置引数

<NAMESPACE>
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
特定の名前空間内のメタデータ定義プロパティーをすべて削除します。

位置引数

<NAMESPACE>
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
特定の namespace に関連付けられているリソースタイプを一覧表示します。

位置引数

<NAMESPACE>
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
特定のメタデータ定義の名前空間を記述します。namespace プロパティー、オブジェクト、およびリソースタイプの関連付けも一覧表示します。

位置引数

<NAMESPACE>
記述する 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
特定の namespace 内のメタデータ定義タグをすべて削除します。

位置引数

<NAMESPACE>
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
既存のメタデータ定義の namespace を更新します。

位置引数

<NAMESPACE>
更新する 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
namespace 内に新規メタデータ定義オブジェクトを作成します。

位置引数

<NAMESPACE>
オブジェクトが属する 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
namespace 内の特定のメタデータ定義オブジェクトを削除します。

位置引数

<NAMESPACE>
オブジェクトが属する 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
特定の namespace 内のメタデータ定義オブジェクトを一覧表示します。

位置引数

<NAMESPACE>
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
オブジェクト内に特定のメタデータ定義プロパティーを記述します。

位置引数

<NAMESPACE>
オブジェクトが属する 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
名前空間内で特定のメタデータ定義オブジェクトを記述します。

位置引数

<NAMESPACE>
オブジェクトが属する 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
namespace 内のメタデータ定義オブジェクトを更新します。

位置引数

<NAMESPACE>
オブジェクトが属する 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
namespace 内に新しいメタデータ定義プロパティーを作成します。

位置引数

<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
名前空間内の特定のメタデータ定義プロパティーを削除します。

位置引数

<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
特定の namespace 内のメタデータ定義プロパティーを一覧表示します。

位置引数

<NAMESPACE>
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
名前空間内で特定のメタデータ定義プロパティーを記述します。

位置引数

<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
namespace 内のメタデータ定義プロパティーを更新します。

位置引数

<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
リソースタイプをメタデータ定義の namespace に関連付けます。

位置引数

<NAMESPACE>
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
リソースタイプをメタデータ定義名前空間と関連付け解除します。

位置引数

<NAMESPACE>
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
namespace 内に新規メタデータ定義タグを追加します。

位置引数

<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
namespace 内に新しいメタデータ定義タグを作成します。

位置引数

<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
namespace 内の特定のメタデータ定義タグを削除します。

位置引数

<NAMESPACE>
タグが属する 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
特定の namespace 内のメタデータ定義タグを一覧表示します。

位置引数

<NAMESPACE>
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
名前空間内の特定のメタデータ定義タグを記述します。

位置引数

<NAMESPACE>
タグが属する 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
namespace 内のメタデータ定義タグの名前を変更します。

位置引数

<NAMESPACE>
タグが属する 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
特定のイメージのメンバーを作成します。

位置引数

<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
イメージメンバーを削除します。

位置引数

<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
特定のイメージのメンバーのステータスを更新します。

位置引数

<IMAGE_ID>
メンバーを更新するイメージ。
<MEMBER_ID>
更新するテナント。
<MEMBER_STATUS>
メンバーのステータスを更新しました。有効な値:accepted、rejectd、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>
Task のタイプ。サポートされているタスクを確認するには、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
特定のタスクを記述します。

位置引数

<TASK_ID>
記述するタスクの ID。

8.5. Image Service プロパティーのキー

以下のキーは、特定のコンポーネントと共に、glance image-update および glance image-create の両コマンドの property オプションと共に使用することができます。以下に例を示します。
$ glance image-update IMG-UUID --property architecture=x86_64
Copy to Clipboard Toggle word wrap
注記
イメージのプロパティーを使用して設定した動作は、フレーバーを使用して設定した動作よりも優先されます。詳細は、『Red Hat OpenStack Platform クラウド管理ガイド を参照してください』。
Expand
表8.1 プロパティーキー
対象コンポーネント キー 説明 サポートされている値
すべて architecture ハイパーバイザーがサポートする必要のある CPU アーキテクチャー。たとえば、x86_64armppc64 等。マシンのアーキテクチャーを確認するには、uname -m を実行します。このためには、libosinfo project で定義されているアーキテクチャーデータボキャブラリーを使用することを強く推奨します。
すべて hypervisor_type ハイパーバイザーの種別 Xenqemukvmlxcumlvmware、または hyperv
すべて instance_uuid スナップショットイメージの場合、このイメージを作成するのに使用したサーバーの UUID 有効なサーバーの UUID
すべて kernel_id AMI 形式のイメージをブートする際にカーネルとして使用する必要のある Image サービスに保管されているイメージの ID 有効なイメージ ID
すべて os_distro オペレーティングシステムのディストリビューションの小文字による一般名 (libosinfo project と同じデータボキャブラリーを使用)。このフィールドには認識済みの値のみを指定します。認識済みの値の検索で役立つように、非推奨の値を示します。
  • arch-Arch Linux。archlinux および org. archlinux は使用しないでください。
  • CentOS-Community Enterprise Operating System。org.centos および CentOSは使用しないでください。
  • debian-Debian.Debian および org.debianは使用しないでください。
  • Fedora-Fedora。Fedoraorg.fedoraorg.fedoraprojectは使用しないでください。
  • freebsd: FreeBSD。org.freebsdfreeBSDFreeBSDは使用しないでください。
  • gentoo: Gentoo Linux。Gentoo および org.gentooは使用しないでください。
  • mandrake: Mandrakelinux (MandrakeSoft)ディストリビューション。mandrakelinux および MandrakeLinuxは使用しないでください。
  • mandriva: Mandriva Linux。mandrivalinuxは使用しないでください。
  • mes: Mandriva Enterprise Server。mandrivaent および mandrivaESは使用しないでください。
  • msdos: Microsoft Disc Operating System。ms-dosは使用しないでください。
  • netbsd: NetBSD。NetBSD および org.netbsdは使用しないでください。
  • netware-Novell NetWare。novell および NetWareは使用しないでください。
  • openbsd: OpenBSD。OpenBSD および org.openbsdは使用しないでください。
  • openolaris: OpenSolaris。OpenSolaris および org.opensolarisは使用しないでください。
  • opensUSE-openSUSE。suseSuSEorg.opensuseは使用しないでください。
  • rhel: Red Hat Enterprise Linux。redhatRedHatcom.redhatは使用しないでください。
  • sled: SUSE Linux Enterprise Desktop。com.suseは使用しないでください。
  • ubuntu-Ubuntu。Ubuntucom.ubuntuorg.ubuntucanonicalは使用しないでください。
  • Windows-Microsoft Windows。com.microsoft.serverは使用しないでください。
すべて os_version ディストリビューターによって指定されるオペレーティングシステムのバージョン バージョン番号 (例: "11.10")
すべて ramdisk_id AMI 形式のイメージをブートする際に ramdisk として使用する必要のある、Image サービスに保管されているイメージの ID 有効なイメージ ID
すべて vm_mode 仮想マシンのモード。仮想マシンに使用されるホスト/ゲストの ABI (アプリケーションバイナリーインターフェイス) を示します。
  • hvm: 完全仮想化。これは QEMU および KVM で使用されるモードです。
  • Xen-Xen 3.0 準仮想化。
  • UML-User モード Linux 準仮想化。
  • コンテナー内の exe-Executables。LXC で使用されるモードです。
libvirt API ドライバー hw_disk_bus ディスクデバイスの接続先となるディスクコントローラーのタイプを指定します。 scsivirtioumlxenideusb のいずれか。
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 Block (virtio-blk) を使用します。VirtIO SCSI は準仮想化 SCSI コントローラーデバイスで、より高いスケーラビリティーとパフォーマンスを提供し、高度な SCSI ハードウェアに対応します。 virtio-scsi
libvirt API ドライバー hw_video_model 使用されるビデオイメージドライバー vgacirrusvmvgaxenqxl
libvirt API ドライバー hw_video_ram ビデオイメージの最大 RAM。フレーバーの extra_specshw_video:ram_max_mb の値が設定済みで、かつその値が hw_video_ram で設定されている値を上回る場合にのみ使用されます。 整数 (MB 単位。例:64)
libvirt API ドライバー hw_watchdog_action サーバーがハングした場合に指定したアクションを実行する仮想ハードウェアウォッチドッグデバイスを有効にします。このウォッチドッグは、i6300esb デバイスを使用します (PCI Intel 6300ESB をエミュレート)。hw_watchdog_action が指定されていない場合には、ウォッチドッグは無効になります。
  • disabled: (デフォルト)デバイスは接続されていません。イメージのフレーバーを使用して有効化されている場合でも、ユーザーがイメージのウォッチドッグを無効にすることができます。
  • reset: ゲストを強制的にリセットします。
  • poweroff: ゲストの電源を強制的にオフにします。
  • pause: ゲストを一時停止します。
  • none: ウォッチドッグを有効にするのみで、サーバーがハングした場合には何もしません。
libvirt API ドライバー os_command_line デフォルトではなく、libvirt ドライバーで使用されるカーネルコマンドライン。Linux コンテナー(LXC)の場合、値は初期化の引数として使用されます。このキーは、Amazon カーネル、ramdisk、またはマシンイメージ (aki、ari、または ami) にのみ有効です。
libvirt API ドライバーおよび VMware API ドライバー hw_vif_model 使用する仮想ネットワークインターフェイスデバイスのモデルを指定します。
設定したハイパーバイザーによって有効なオプションは異なります。
  • KVM および QEMU: e1000ne2k_pcipcnetrtl8139、および virtio
  • VMware: e1000e1000eVirtualE1000VirtualE1000eVirtualPCNet32VirtualSriovEthernetCardVirtualVmxnet
  • Xen: e1000netfrontne2k_pcipcnetrtl8139.
VMware API ドライバー vmware_adaptertype ハイパーバイザーが使用する仮想 SCSI または IDE コントローラー lsiLogicbusLogic、または ide
VMware API ドライバー vmware_ostype イメージにインストールされているオペレーティングシステムを示す VMware GuestID。この値は、仮想マシンの作成時にハイパーバイザーに渡されます。指定しなかった場合には、このキーの値はデフォルトで otherGuest に設定されます。 アップストリームのドキュメント を参照してください。
VMware API ドライバー vmware_image_version 現在は使用されていません。 1
XenAPI ドライバー auto_disk_config true に指定した場合には、ディスク上の root パーティションは、インスタンスがブートする前に自動的にリサイズされます。この値は、Xen ベースのハイパーバイザーを XenAPI ドライバーと共に使用する場合にのみ Compute サービスによって考慮されます。Compute サービスは、イメージに単一のパーティションがあり、かつそのパーティションが ext3 または ext4 のフォーマットの場合にのみリサイズを試みます。 true | false
XenAPI ドライバー os_type イメージ上にインストールされるオペレーティングシステム。XenAPI ドライバーには、イメージの os_type パラメーターの値によって異なるアクションを実行するロジックが組み込まれています。たとえば、os_type=windows イメージの場合には、Linux スワップパーティションの代わりに、FAT32 ベースのスワップパーティションを作成し、挿入されるホスト名を 16 文字未満に制限します。 linux または windows

第9章 ネットワーキングサービスコマンドラインクライアント

neutron クライアントは、Networking サービス 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
指定されたエージェントの管理者ステータスと説明を更新します。
bash-completion
bash-completion のすべてのコマンドとオプションを出力します。
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
Floating IP と Fixed IP 間のマッピングを作成します。
floatingip-create
特定のテナントに Floating IP を作成します。
floatingip-delete
指定の Floating IP を削除します。
floatingip-disassociate
Floating IP から Fixed IP へのマッピングを削除します。
floatingip-list
指定のテナントに属する Floating IP を一覧表示します。
floatingip-show
指定の Floating IP の情報を表示します。
gateway-device-create
ネットワークゲートウェイデバイスを作成します。
gateway-device-delete
指定したネットワークゲートウェイデバイスを削除します。
gateway-device-list
指定したテナントのネットワークゲートウェイデバイスを一覧表示します。
gateway-device-show
特定のネットワークゲートウェイデバイスの情報を表示します。
gateway-device-update
ネットワークゲートウェイデバイスを更新します。
help
別のコマンドの詳細なヘルプを出力します。
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
プールをホストするロードバランサーエージェントを取得します。
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
ロードバランサーエージェントのプールを一覧表示します。
lb-pool-show
指定したプールの情報を表示します。
lb-pool-stats
指定のプールの統計を取得します。
lb-pool-update
指定のプールを更新します。
lb-vip-create
vip を作成します。
lb-vip-delete
指定の vip を削除します。
lb-vip-list
指定のテナントに属する仮想 IP を一覧表示します。
lb-vip-show
特定の vip の情報を表示します。
lb-vip-update
指定の vip を更新します。
LBaaS-agent-hosting-loadbalancer
ロードバランサーをホストする lbaas v2 エージェントを取得します。
LBaaS-healthmonitor-create
LBaaS v2 healthmonitor v2 の作成
LBaaS-healthmonitor-delete
LBaaS v2 特定の healthmonitor を削除します。
LBaaS-healthmonitor-list
特定のテナントに属する LBaaS v2 List healthmonitors。
LBaaS-healthmonitor-show
LBaaS v2 特定の healthmonitor の情報を表示する。
LBaaS-healthmonitor-update
LBaaS v2 は特定の healthmonitor を更新します。
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 エージェントのロードバランサーを一覧表示します。
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
指定したテナントのメータリングラベルを作成します。
meter-label-delete
指定のメータリングラベルを削除します。
meter-label-list
所定のテナントに属するメータリングラベルを一覧表示します。
meter-label-rule-create
指定されるラベルのメータリングラベルルールを作成します。
meter-label-rule-delete
指定のメータリングラベルを削除します。
meter-label-rule-list
指定されるラベルに属するメータリングラベルを一覧表示します。
meter-label-rule-show
指定したメータリングラベルルールの情報を表示します。
meter-label-show
指定したメータリングラベルの情報を表示します。
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
指定したネットパーティションの情報を表示します。
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
指定したテナントに属するサブネットプールを一覧表示します。
subnetpool-show
指定したサブネットプールの情報を表示します。
subnetpool-update
サブネットプールの情報を更新します。
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
特定のテナントのアドレススコープを作成します。

位置引数

name
アドレススコープの名前を指定します。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
--tenant-id TENANT_ID
所有者テナント ID。
--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
アドレススコープを削除します。

位置引数

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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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
アドレススコープに関する情報を表示します。

位置引数

ADDRESS_SCOPE
検索する address_scope の ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
アドレススコープを更新します。

位置引数

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
指定のエージェントを削除します。

位置引数

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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
--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
指定したエージェントの情報を表示します。

位置引数

AGENT
検索するエージェントの ID。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
指定されたエージェントの管理者ステータスと説明を更新します。

位置引数

AGENT
更新するエージェントの ID。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
--admin-state-down
エージェントの管理者状態を 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
認証情報を作成します。

位置引数

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
指定の認証情報を削除します。

位置引数

認証情報
削除する認証情報の 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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
指定された認証情報の情報を表示します。

位置引数

認証情報
検索する認証情報の ID。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
ネットワークプロファイルを作成します。

位置引数

name
ネットワークプロファイルの名前。
{VLAN,overlay,multi-segment,trunk}
セグメントタイプ。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
--tenant-id TENANT_ID
所有者テナント ID。
--sub_type SUB_TYPE
セグメントのサブタイプ。オーバーレイセグメントに使用できるサブタイプ:ネイティブ、拡張、およびトランクセグメントの場合: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
指定したネットワークプロファイルを削除します。

位置引数

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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
指定したネットワークプロファイルの情報を表示します。

位置引数

NETWORK_PROFILE
検索する network_profile の ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
ネットワークプロファイルの情報を更新します。

位置引数

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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
指定したポリシープロファイルの情報を表示します。

位置引数

POLICY_PROFILE
検索する policy_profile の ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
ポリシープロファイルの情報を更新します。

位置引数

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 エージェントを一覧表示します。

位置引数

network
問い合わせるネットワーク。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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 エージェントにネットワークを追加します。

位置引数

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 エージェントからネットワークを削除します。

位置引数

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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
特定のリソースに関する情報を表示します。

位置引数

EXTENSION
検索する拡張子の ID。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
ファイアウォールを作成します。

位置引数

POLICY
ファイアウォールポリシー名または ID。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
--tenant-id TENANT_ID
所有者テナント ID。
--name NAME
ファイアウォールの名前。
--description DESCRIPTION
ファイアウォールルールの説明。
--admin-state-down
admin 状態を 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
指定のファイアウォールを削除します。

位置引数

ファイアウォール(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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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
ファイアウォールポリシーを作成します。

位置引数

名前
ファイアウォールポリシーの名前。

オプションの引数

-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
指定したファイアウォールポリシーを削除します。

位置引数

FEWALL_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
指定したファイアウォールポリシーにルールを挿入します。

位置引数

FEWALL_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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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
指定したファイアウォールポリシーからルールを削除します。

位置引数

FEWALL_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
特定のファイアウォールポリシーの情報を表示します。

位置引数

FEWALL_POLICY
検索する firewall_policy の ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
指定したファイアウォールポリシーを更新します。

位置引数

FEWALL_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] の整数または 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
指定のファイアウォールルールを削除します。

位置引数

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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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
指定のファイアウォールルールの情報を表示します。

位置引数

FIREWALL_RULE
検索する firewall_rule の ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
指定のファイアウォールルールを更新します。

位置引数

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
指定したファイアウォールの情報を表示します。

位置引数

ファイアウォール(FIREWALL)
検索するファイアウォールの ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
指定したファイアウォールを更新します。

位置引数

ファイアウォール(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
Floating IP と Fixed IP 間のマッピングを作成します。

位置引数

FLOATINGIP_ID
関連付ける Floating IP の ID
ポート
Floating 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
特定のテナントに Floating IP を作成します。

位置引数

FLOATING_NETWORK
Floating IP を確保するネットワーク名または ID。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
--tenant-id TENANT_ID
所有者テナント ID。
--port-id PORT_ID
Floating IP に関連付けられるポートの ID。
--fixed-ip-address FIXED_IP_ADDRESS
ポートの IP アドレス(ポートに複数の IP がある場合のみ必要)。
--floating-ip-address FLOATING_IP_ADDRESS
Floating IP の IP アドレス

9.49. neutron floatingip-delete

usage: neutron floatingip-delete [-h] [--request-format {json,xml}] FLOATINGIP
Copy to Clipboard Toggle word wrap
指定の Floating IP を削除します。

位置引数

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
Floating IP から Fixed IP へのマッピングを削除します。

位置引数

FLOATINGIP_ID
関連付けを解除する Floating 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
指定のテナントに属する Floating IP を一覧表示します。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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
指定の Floating IP の情報を表示します。

位置引数

FLOATINGIP
検索する Floatingip の ID。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
ネットワークゲートウェイデバイスを作成します。

位置引数

名前
作成するネットワークゲートウェイデバイスの名前。

オプションの引数

-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 です。
--connector-ip CONNECTOR_IP
このデバイスのトランスポートコネクターの IP アドレス。NSX ゲートウェイノード上のテナントトラフィックに使用されるインターフェイスの IP アドレスに対応している必要があります。
--client-certificate CERT_DATA
NSX コントローラーで認証するために NSX ゲートウェイトランスポートノードによって使用される PEM 証明書。
--client-certificate-file CERT_FILE
NSX コントローラーで認証するために NSX ゲートウェイトランスポートノードによって使用される PEM 証明書を含むファイル。

9.54. neutron gateway-device-delete

usage: neutron gateway-device-delete [-h] [--request-format {json,xml}] GATEWAY_DEVICE
Copy to Clipboard Toggle word wrap
指定したネットワークゲートウェイデバイスを削除します。

位置引数

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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
特定のネットワークゲートウェイデバイスの情報を表示します。

位置引数

GATEWAY_DEVICE
検索する gateway_device の ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
ネットワークゲートウェイデバイスを更新します。

位置引数

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 です。
--connector-ip CONNECTOR_IP
このデバイスのトランスポートコネクターの IP アドレス。NSX ゲートウェイノード上のテナントトラフィックに使用されるインターフェイスの IP アドレスに対応している必要があります。
--client-certificate CERT_DATA
NSX コントローラーで認証するために NSX ゲートウェイトランスポートノードによって使用される PEM 証明書。
--client-certificate-file CERT_FILE
NSX コントローラーで認証するために NSX ゲートウェイトランスポートノードによって使用される PEM 証明書を含むファイル。

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 状態を false に設定します。
--name NAME
接続のフレンドリーな名前を設定します。
--description DESCRIPTION
接続の説明を設定します。
--mtu MTU
接続の MTU サイズ。デフォルトは 1500
--initiator {bi-directional,response-only}
小文字、デフォルト:bi-directional でのイニシエーターの状態
--dpd
action=ACTION,interval=INTERVAL,timeout=TIMEOUT Ipsec 接続。デッドピア検出属性。'action'-hold,clear,disabled,restart,restart-by-peer. 'interval' と 'timeout' は負の値ではない整数です。interval は 'timeout' 値よりも小さくなければなりません。action、デフォルト: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
認証用のピアルーター 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 サイト接続を削除します。

位置引数

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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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 サイト接続の情報を表示します。

位置引数

IPSEC_SITE_CONNECTION
検索する ipsec_site_connection の ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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 サイト接続を更新します。

位置引数

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' 値よりも小さくなければなりません。action、デフォルト: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 エージェントを一覧表示します。

位置引数

router
クエリーするルーター。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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 エージェントにルーターを追加します。

位置引数

l3_agent
L3 エージェントの ID。
router
追加するルーター。

オプションの引数

-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 エージェントからルーターを削除します。

位置引数

l3_agent
L3 エージェントの ID。
router
削除するルーター。

オプションの引数

-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
プールをホストするロードバランサーエージェントを取得します。サーバーがすべてのエージェントスケジューラーの一般的な出力形式を維持するために、1 つのエージェントのみを返すために ListCommand から導出する

位置引数

pool
問い合わせるプール。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
ヘルスモニターとプール間のマッピングを作成します。

位置引数

HEALTH_MONITOR_ID
関連付けるヘルスモニター。
プール
ヘルスモニターに関連付けられるプールの 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 状態を false に設定します。
--expected-codes EXPECTED_CODES
正常を宣言するためのメンバーからの応答で想定される HTTP ステータスコードの一覧。この属性には、1 つの値またはコンマ区切りの値のリスト、または値の範囲(例:"200-299").この属性が指定されていない場合、デフォルトで 200 に設定されます。
--http-method HTTP_METHOD
HTTP タイプのモニターによってリクエストに使用される HTTP メソッド。
--url-path URL_PATH
メンバーの正常性をテストするためにモニターが使用する HTTP 要求で使用される HTTP パス。これは、/(スラッシュ)で始まる文字列である必要があります。
--delay DELAY
メンバーにプローブを送信する間隔(秒単位)。
--max-retries MAX_RETRIES
メンバーのステータスを INACTIVE に変更する前に許容される接続失敗の数 [1..10]
--timeout TIMEOUT
モニターが、接続がタイムアウトする前に接続が確立されるまでの最大待機時間(秒単位)。値は delay 値よりも小さくなければなりません。
--type {PING,TCP,HTTP,HTTPS}
事前定義されたヘルスモニタータイプの 1 つ。

9.69. neutron lb-healthmonitor-delete

usage: neutron lb-healthmonitor-delete [-h] [--request-format {json,xml}] HEALTH_MONITOR
Copy to Clipboard Toggle word wrap
特定のヘルスモニターを削除します。

位置引数

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
ヘルスモニターからプールへのマッピングを削除します。

位置引数

HEALTH_MONITOR_ID
関連付けるヘルスモニター。
プール
ヘルスモニターに関連付けられるプールの 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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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
特定のヘルスモニターの情報を表示します。

位置引数

HEALTH_MONITOR
検索する health_monitor の ID。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

9.73. neutron lb-healthmonitor-update

usage: neutron lb-healthmonitor-update [-h] [--request-format {json,xml}] HEALTH_MONITOR
Copy to Clipboard Toggle word wrap
特定のヘルスモニターを更新します。

位置引数

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
メンバーを作成します。

位置引数

プール
この仮想 IP が属するプール ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
--tenant-id TENANT_ID
所有者テナント ID。
--admin-state-down
admin 状態を false に設定します。
--weight WEIGHT
プール内のプールメンバーの重み(デフォルトは 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
指定のメンバーを削除します。

位置引数

MEMBER
削除するメンバーの 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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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
特定のメンバーの情報を表示します。

位置引数

MEMBER
検索するメンバーの ID。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

9.78. neutron lb-member-update

usage: neutron lb-member-update [-h] [--request-format {json,xml}] MEMBER
Copy to Clipboard Toggle word wrap
指定されたメンバーを更新します。

位置引数

MEMBER
更新するメンバーの 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 状態を false に設定します。
--description DESCRIPTION
プールの説明。
--lb-method {ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP}
プールのメンバー間で負荷を分散するために使用されるアルゴリズム。
--name NAME
プールの名前。
--protocol {HTTP,HTTPS,TCP}
バランシングのプロトコル。
--subnet-id SUBNET
プールのメンバーが配置されているサブネット。
--provider PROVIDER
loadbalancer サービスのプロバイダー名。

9.80. neutron lb-pool-delete

usage: neutron lb-pool-delete [-h] [--request-format {json,xml}] POOL
Copy to Clipboard Toggle word wrap
指定のプールを削除します。

位置引数

プール
削除するプールの 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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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
ロードバランサーエージェントのプールを一覧表示します。

位置引数

lbaas_agent
問い合わせるロードバランサーエージェントの ID。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
指定したプールの情報を表示します。

位置引数

プール
検索するプールの ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
指定のプールの統計を取得します。

位置引数

プール
検索するプールの ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

9.85. neutron lb-pool-update

usage: neutron lb-pool-update [-h] [--request-format {json,xml}] POOL
Copy to Clipboard Toggle word wrap
指定のプールを更新します。

位置引数

プール
更新するプールの 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 を作成します。

位置引数

プール
この仮想 IP が属するプール ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
--tenant-id TENANT_ID
所有者テナント ID。
--address ADDRESS
vip の IP アドレス。
--admin-state-down
admin 状態を false に設定します。
--connection-limit CONNECTION_LIMIT
vip に許可される 1 秒あたりの最大接続数。正の整数または無制限の場合は -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 を削除します。

位置引数

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
指定のテナントに属する仮想 IP を一覧表示します。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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 の情報を表示します。

位置引数

VIP
検索する vip の ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

9.90. neutron lb-vip-update

usage: neutron lb-vip-update [-h] [--request-format {json,xml}] VIP
Copy to Clipboard Toggle word wrap
指定の vip を更新します。

位置引数

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
ロードバランサーをホストする lbaas v2 エージェントを取得します。サーバーがすべてのエージェントスケジューラーの一般的な出力形式を維持するために、1 つのエージェントのみを返すために ListCommand から導出する

位置引数

loadbalancer
クエリーを行う loadbalancer。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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 healthmonitor v2 の作成

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
--tenant-id TENANT_ID
所有者テナント ID。
--admin-state-down
admin 状態を false に設定します。
--expected-codes EXPECTED_CODES
正常を宣言するためのメンバーからの応答で想定される HTTP ステータスコードの一覧。この属性には、1 つの値またはコンマ区切りの値のリスト、または値の範囲(例:"200-299").この属性が指定されていない場合、デフォルトで 200 に設定されます。
--http-method HTTP_METHOD
HTTP タイプのモニターによってリクエストに使用される HTTP メソッド。
--url-path URL_PATH
メンバーの正常性をテストするためにモニターが使用する HTTP 要求で使用される HTTP パス。これは、/(スラッシュ)で始まる文字列である必要があります。
--delay DELAY
メンバーにプローブを送信する間隔(秒単位)。
--max-retries MAX_RETRIES
メンバーのステータスを INACTIVE に変更する前に許容される接続失敗の数 [1..10]。
--timeout TIMEOUT
モニターが、接続がタイムアウトする前に接続が確立されるまでの最大待機時間(秒単位)。値は delay 値よりも小さくなければなりません。
--type {PING,TCP,HTTP,HTTPS}
事前定義されたヘルスモニタータイプの 1 つ。
--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 特定の healthmonitor を削除します。

位置引数

HEALTHMONITOR
削除する healthmonitorの ID または名前。

オプションの引数

-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 List healthmonitors。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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 特定の healthmonitor の情報を表示する。

位置引数

HEALTHMONITOR
検索する ID またはサンドボックスの名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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 は特定の healthmonitor を更新します。

位置引数

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 状態を false に設定します。
--connection-limit CONNECTION_LIMIT
vip に許可される 1 秒あたりの最大接続数。正の整数または無制限の場合は -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 特定のリスナーを削除します。

位置引数

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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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 特定のリスナーの情報を表示する。

位置引数

LISTENER
検索するリスナーの ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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 は特定のリスナーを更新します。

位置引数

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 ロードバランサーを作成します。

位置引数

VIP_SUBNET
ロードバランサー VIP サブネット。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
--tenant-id TENANT_ID
所有者テナント ID。
--description DESCRIPTION
ロードバランサーの説明。
--admin-state-down
admin 状態を false に設定します。
--name NAME
ロードバランサーの名前。
--provider PROVIDER
ロードバランサーサービスのプロバイダー名。
--VIP-address VIP_ADDRESS
ロードバランサーの仮想 IP アドレス。

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 特定のロードバランサーを削除します。

位置引数

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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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 エージェントのロードバランサーを一覧表示します。

位置引数

lbaas_agent
問い合わせるロードバランサーエージェントの ID。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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 特定のロードバランサーの情報を表示する。

位置引数

LOADBALANCER
検索するロードバランサーの ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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 は特定のロードバランサーを更新します。

位置引数

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 はメンバーを作成します。

位置引数

プール
このメンバーが属するプールの ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
--tenant-id TENANT_ID
所有者テナント ID。
--admin-state-down
管理状態を false に設定します。
--weight WEIGHT
プール内のメンバーの重み(デフォルトは 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 特定のメンバーを削除します。

位置引数

MEMBER
削除するメンバーの ID または名前。
プール
このメンバーが属するプールの 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 は、特定のプールに属するメンバーを一覧表示します。

位置引数

プール
このメンバーが属するプールの ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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 特定のメンバーの情報を表示する。

位置引数

MEMBER
検索するメンバーの ID または名前。
プール
このメンバーが属するプールの ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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 は特定のメンバーを更新します。

位置引数

MEMBER
更新するメンバーの ID または名前。
プール
このメンバーが属するプールの ID または名前

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
--admin-state-down
管理状態を false に設定します。
--weight WEIGHT
プール内のメンバーの重み(デフォルトは 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 状態を 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 特定のプールを削除します。

位置引数

プール
削除するプールの 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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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 特定のプールの情報を表示する。

位置引数

プール
検索するプールの ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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 は特定のプールを更新します。

位置引数

プール
更新するプールの 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
指定したテナントのメータリングラベルを作成します。

位置引数

名前
作成するメータリングラベルの名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
--tenant-id TENANT_ID
所有者テナント ID。
--description DESCRIPTION
作成するメータリングラベルの説明。
--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_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
所定のテナントに属するメータリングラベルを一覧表示します。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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
指定されるラベルのメータリングラベルルールを作成します。

位置引数

LABEL
ラベルの ID または名前。
REMOTE_IP_PREFIX
一致する CIDR。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
--tenant-id TENANT_ID
所有者テナント ID。
--direction {ingress,egress}
トラフィックの方向、デフォルト:ingress。
--excluded
この CIDR をラベルから除外します。default: 除外されません。

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_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
指定されるラベルに属するメータリングラベルを一覧表示します。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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_LABEL_RULE
検索する metering_label_rule の ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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_LABEL
検索する metering_label の ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
特定のテナントのネットワークを作成します。

位置引数

名前
作成するネットワークの名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
--tenant-id TENANT_ID
所有者テナント ID。
--admin-state-down
admin 状態を false に設定します。
--shared
ネットワークを共有として設定します。
--provider:network_type <network_type>
仮想ネットワークが実装される物理メカニズム。
--provider:physical_network <physical_network_name>
仮想ネットワークが実装される物理ネットワークの名前。
--provider:segmentation_id <segmentation_id>
VLAN ネットワークの VLAN ID または GRE/VXLAN ネットワークの場合は tunnel-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
指定のネットワークを削除します。

位置引数

ネットワーク
削除するネットワークの 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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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
内部ネットワークインターフェイスをルーターに追加します。

位置引数

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
ネットワークゲートウェイを作成します。

位置引数

名前
作成するネットワークゲートウェイの名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
--tenant-id TENANT_ID
所有者テナント ID。
--device
id=ID,interface_name=NAME_OR_ID Device info for this gateway.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
指定したネットワークゲートウェイを削除します。

位置引数

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
ネットワークゲートウェイからネットワークを削除します。

位置引数

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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
特定のネットワークゲートウェイの情報を表示します。

位置引数

NETWORK_GATEWAY
検索する network_gateway の ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

9.135. neutron net-gateway-update

usage: neutron net-gateway-update [-h] [--request-format {json,xml}] NETWORK_GATEWAY
Copy to Clipboard Toggle word wrap
ネットワークゲートウェイの名前を更新します。

位置引数

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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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 エージェントのネットワークを一覧表示します。

位置引数

dhcp_agent
DHCP エージェントの ID。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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
特定のネットワークの情報を表示します。

位置引数

ネットワーク
検索するネットワークの ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
ネットワークの情報を更新します。

位置引数

ネットワーク
更新するネットワークの 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 を作成します。

位置引数

name
作成する 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 を削除します。

位置引数

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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
指定したネットパーティションの情報を表示します。

位置引数

NET_PARTITION
検索する net_partition の ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
指定したテナント用のポートを作成します。

位置引数

ネットワーク
このポートが属するネットワーク 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 状態を false に設定します。
--mac-address MAC_ADDRESS
このポートの MAC アドレス。
--vNIC-type <direct | ⚙ | 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
指定のポートを削除します。

位置引数

ポート
削除するポートの 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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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
指定したポートの情報を表示します。

位置引数

ポート
検索するポート ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
ポートの情報を更新します。

位置引数

ポート
更新するポートの 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}
ポートに管理者状態を設定します。
--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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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 帯域幅の制限ルールを作成します。

位置引数

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 帯域幅制限ルールを削除します。

位置引数

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 帯域幅制限ルールを一覧表示します。

位置引数

QOS_POLICY
QoS ポリシーの ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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 帯域幅制限ルールに関する情報を表示します。

位置引数

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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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 帯域幅制限ルールを更新します。

位置引数

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 ポリシーを作成します。

位置引数

名前
作成する 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 ポリシーを削除します。

位置引数

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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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 ポリシーの情報を表示します。

位置引数

POLICY
検索するポリシー ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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 ポリシーを更新します。

位置引数

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
キューを作成します。

位置引数

名前
キューの名前。

オプションの引数

-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
Differentiated Services Code Point。

9.161. neutron queue-delete

usage: neutron queue-delete [-h] [--request-format {json,xml}] QOS_QUEUE
Copy to Clipboard Toggle word wrap
指定のキューを削除します。

位置引数

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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
指定したキューの情報を表示します。

位置引数

QOS_QUEUE
検索する qos_queue の ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
Networks ネットワークの制限。
--subnet
subnets サブネットの制限。
--port
Port: ポートの制限。
--router
Router: ルーターの制限。
--floatingip
Floating IP の限度。
--security-group
security_groups セキュリティーグループの制限。
--security-group-rule
security_group_rules セキュリティーグループルールの制限。
--VIP
VIP vips の制限。
--pool
Pools プールの制限。
--member
members プールメンバーの制限。
--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 ポリシーを作成します。

位置引数

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 ポリシーを削除します。

位置引数

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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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 ポリシーに関する情報を表示します。

位置引数

RBAC_POLICY
検索する rbac_policy の ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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 ポリシーを更新します。

位置引数

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
特定のテナントのルーターを作成します。

位置引数

名前
作成するルーターの名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
--tenant-id TENANT_ID
所有者テナント ID。
--admin-state-down
admin 状態を 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
指定のルーターを削除します。

位置引数

ROUTER
削除するルーターの 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
ルーターから外部ネットワークゲートウェイを削除します。

位置引数

ROUTER
ルーターの 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
ルーターの外部ネットワークゲートウェイを設定します。

位置引数

ROUTER
ルーターの 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
内部ネットワークインターフェイスをルーターに追加します。

位置引数

ROUTER
ルーターの ID または名前。
INTERFACE
形式は "SUBNET|subnet=SUBNET|port=PORT" です。サブネットまたはポートのいずれかを指定する必要があります。ID と name はいずれも 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
ルーターから内部ネットワークインターフェイスを削除します。

位置引数

ROUTER
ルーターの ID または名前。
INTERFACE
形式は "SUBNET|subnet=SUBNET|port=PORT" です。サブネットまたはポートのいずれかを指定する必要があります。ID と name はいずれも 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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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 エージェント上のルーターを一覧表示します。

位置引数

l3_agent
問い合わせる L3 エージェントの ID。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
ルーターを指定した特定のテナントに属するポートを一覧表示します。

位置引数

router
検索するルーターの ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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
特定のルーターの情報を表示します。

位置引数

ROUTER
検索するルーターの ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
ルーターの情報を更新します。

位置引数

ROUTER
更新するルーターの ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
--name NAME
このルーターの名前。
--admin-state-up {True,False}
ルーターの管理状態を指定します(True の意味 Up)。
--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
セキュリティーグループを作成します。

位置引数

名前
セキュリティーグループの名前。

オプションの引数

-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
指定のセキュリティーグループを削除します。

位置引数

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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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
セキュリティーグループルールを作成します。

位置引数

SECURITY_GROUP
ルールを追加するセキュリティーグループ名または ID。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
--tenant-id TENANT_ID
所有者テナント ID。
--direction {ingress,egress}
トラフィックの方向: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
指定のセキュリティーグループルールを削除します。

位置引数

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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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
指定したセキュリティーグループルールの情報を表示します。

位置引数

SECURITY_GROUP_RULE
検索する security_group_rule の ID。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
指定したセキュリティーグループの情報を表示します。

位置引数

SECURITY_GROUP
検索する security_group の ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
指定のセキュリティーグループを更新します。

位置引数

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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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
特定のテナントのサブネットを作成します。

位置引数

ネットワーク
このサブネットが属するネットワーク 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 Allocation プール IP アドレスをこのサブネットに繰り返し使用できます(このオプションは繰り返すことができます)。
--host-route
destination=CIDR,nexthop=IP_ADDR 追加ルート(このオプションは繰り返すことができます)。
--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 または名前。
--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
指定のサブネットを削除します。

位置引数

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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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
指定したサブネットの情報を表示します。

位置引数

SUBNET
検索するサブネットの ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
サブネットの情報を更新します。

位置引数

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 Allocation プール IP アドレスをこのサブネットに繰り返し使用できます(このオプションは繰り返すことができます)。
--host-route
destination=CIDR,nexthop=IP_ADDR 追加ルート(このオプションは繰り返すことができます)。
--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 を作成します。

位置引数

name
作成するサブネットプールの名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
--tenant-id TENANT_ID
所有者テナント ID。
--min-prefixlen MIN_PREFIXLEN
サブネットプールの最小接頭辞長。
--max-prefixlen MAX_PREFIXLEN
subnetpool の最大接頭辞長。
--default-prefixlen DEFAULT_PREFIXLEN
サブネットプールのデフォルト接頭辞長。
--pool-prefix PREFIXES
サブネットプール接頭辞(このオプションは繰り返すことができます)
--shared
subnetpool を共有として設定します。
--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 を削除します。

位置引数

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
指定したテナントに属するサブネットプールを一覧表示します。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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
検索するサブネットプールの ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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
更新するサブネットプールの ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
--min-prefixlen MIN_PREFIXLEN
サブネットプールの最小接頭辞長。
--max-prefixlen MAX_PREFIXLEN
subnetpool の最大接頭辞長。
--default-prefixlen DEFAULT_PREFIXLEN
サブネットプールのデフォルト接頭辞長。
--pool-prefix PREFIXES
サブネットプール接頭辞(このオプションは繰り返すことができます)
--name NAME
更新するサブネットプールの名前。
--address-scope ADDRSCOPE
subnetpool が関連付けられているアドレススコープの ID または名前。接頭辞は、アドレススコープ全体で一意である必要があります
--no-address-scope
アドレススコープからサブネットプールの割り当てを解除する

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 ポリシーを作成します。

位置引数

名前
IKE ポリシーの名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
--tenant-id TENANT_ID
所有者テナント ID。
--description DESCRIPTION
IKE ポリシーの説明
--auth-algorithm {sha1}
小文字の認証アルゴリズム。デフォルト:sha1
--encryption-algorithm ENCRYPTION_ALGORITHM
小文字の暗号化アルゴリズム。デフォルト:aes-128
--phase1-negotiation-mode {main}
IKE Phase1 ネゴシエーションモード(小文字)。デフォルトは:main
--IKE-version {v1,v2}
小文字の IKE バージョン。デフォルトは:v1
--pfs {group2,group5,group14}
小文字の Fect Forward Secrecy (デフォルト:group5)
--lifetime
units=UNITS,value=VALUE IKE lifetime attributes. '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 ポリシーを削除します。

位置引数

IKEPOLICY
削除する ikepolicy の ID または名前。

オプションの引数

-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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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 ポリシーの情報を表示します。

位置引数

IKEPOLICY
検索する ikepolicy の ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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 ポリシーを更新します。

位置引数

IKEPOLICY
更新する ikepolicy の ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
--lifetime
units=UNITS,value=VALUE IKE lifetime attributes. '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 ポリシーを作成します。

位置引数

名前
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}
小文字の Fect Forward Secrecy (デフォルト: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 ポリシーを削除します。

位置引数

IPSECPOLICY
削除する ipsecpolicy の ID または名前。

オプションの引数

-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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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 ポリシーの情報を表示します。

位置引数

IPSECPOLICY
検索する ipsecpolicy の ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

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 ポリシーを更新します。

位置引数

IPSECPOLICY
更新する ipsecpolicy の ID または名前。

オプションの引数

-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 サービスを作成します。

位置引数

ROUTER
VPN サービスのルーターの一意識別子。
SUBNET
VPN サービスデプロイメントのサブネット固有識別子。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
--tenant-id TENANT_ID
所有者テナント ID。
--admin-state-down
admin 状態を 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 サービスを削除します。

位置引数

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
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。
-p SIZE、--page-size SIZE
各リクエストの取得ユニットを指定してから、1 つのリクエストを複数のリクエストに分割します。
--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 サービスの情報を表示します。

位置引数

VPNSERVICE
検索する vpnservice の ID または名前。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--request-format {json,xml}
XML または JSON リクエスト形式。
-d、--show-details
詳細情報を表示します。
-f FIELD、--field FIELD
サーバーによって返されるフィールドを指定します。このオプションを繰り返すことができます。

9.218. neutron vpn-service-update

usage: neutron vpn-service-update [-h] [--request-format {json,xml}] VPNSERVICE
Copy to Clipboard Toggle word wrap
特定の VPN サービスを更新します。

位置引数

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
プローブポートの作成 - ネットワーク namespace 内にポートとインターフェイスを作成します。
probe-list
すべてのプローブを一覧表示します。
probe-clear
すべてのプローブをクリアします。
probe-delete
delete probe - 次に、port を削除してから namespace を削除します。
probe-exec
プローブの namespace でコマンドを実行します。
ping-all
ping-all は、指定されたネットワーク内のすべての 固定 IP に ping を行うコマンドです。

10.2. neutron-debug オプションの引数

--version
バージョン番号を表示して終了します。
-v、--verbose、--debug
出力の詳細レベルが上がり、エラーのトレースバックを表示します。繰り返すことができます。
-q、--quiet
警告およびエラー以外の出力の抑制
-h、--help
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
プローブポートの作成 - ポートとインターフェイスを作成してから、作成されたネットワークの namespace に配置します。

位置引数

NET 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
プローブを削除します。

位置引数

<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
all-in-one コマンド:指定されたネットワーク内のすべての固定 IP に ping 送信を行います。

位置引数

<port-id>
使用するポートの ID。

オプションの引数

--timeout <timeout (秒単位)
オプションの ping タイムアウト。

10.9. neutron-debug の例

usage: neutron-debug create-probe < NET_ID>
Copy to Clipboard Toggle word wrap
NET_ID で識別されるネットワーク内にプローブ名前空間を作成します。namespace は、プローブポート の 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章 Object Storage のコマンドラインクライアント

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 usage)

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
コンテナー内のコンテナーまたはオブジェクトを削除します。
download
コンテナーからオブジェクトをダウンロードします。
list
コンテナーのアカウントまたはオブジェクトのコンテナーを一覧表示します。
post
アカウント、コンテナー、またはオブジェクトのメタ情報を更新します。存在しない場合はコンテナーを作成します。
stat
アカウント、コンテナー、またはオブジェクトの情報を表示します。
upload
ファイルまたはディレクトリーを特定コンテナーにアップロードします。
capabilities
クラスター機能を一覧表示します。
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
結果のステータスに関係なく、すべての http クエリーの curl コマンドと結果を表示します。
--info
エラーを返すすべての http クエリーの curl コマンドと結果を表示します。
-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 認証

Usage: swift auth
Copy to Clipboard Toggle word wrap
認証関連の認証変数をシェルフレンドリーな形式で表示します。
ストレージ URL および認証トークンを 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
コンテナー内のコンテナーまたはオブジェクトを削除します。

位置引数

<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
コンテナーからオブジェクトをダウンロードします。

位置引数

<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 list

Usage: swift list
Copy to Clipboard Toggle word wrap
コンテナーのアカウントまたはオブジェクトのコンテナーを一覧表示します。

位置引数

[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
アカウント、コンテナー、またはオブジェクトのメタ情報を更新します。コンテナーが見つからない場合は、自動的に作成されます。

位置引数

[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>
メタデータ項目を設定します。このオプションは繰り返すことができます。例:-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
アカウント、コンテナー、またはオブジェクトの情報を表示します。

位置引数

[container]
stat from のコンテナーの名前。
[object]
stat にするオブジェクトの名前。

オプションの引数

--lh
ls -lh のような人間が読める形式でレポートサイズ。

11.11. Swift tempurl

Usage: swift tempurl
Copy to Clipboard Toggle word wrap
Swift オブジェクトの一時 URL を生成します。

位置引数

<method>
この一時 URL を許可する HTTP メソッド。通常は GET または PUT です。
<seconds>
一時 URL が有効である期間(秒単位)。または、--absolute が渡される場合は、一時 URL が期限切れになる Unix タイムスタンプ。
<path>
Swift オブジェクトへの完全パス。例:/v1/AUTH_account/c/o。
<key>
Swift クラスターに設定されたシークレット一時 URL キー。キーを設定するには、swift post -m "Temp-URL-Key:b3968d0207b54ece87cccc06515a89d4" を実行します。

オプションの引数

--absolute
<seconds> 位置引数を、今後の秒数ではなく Unix タイムスタンプとして操作します。

11.12. Swift upload

Usage: swift upload
Copy to Clipboard Toggle word wrap
指定されたファイルおよびディレクトリーを特定コンテナーにアップロードします。

位置引数

<container>
アップロードするコンテナーの名前。
<file_or_directory>
アップロードするファイルまたはディレクトリーの名前。複数アップロードで複数回指定します。

オプションの引数

-c、--changed
最後のアップロード以降に変更されたファイルのみをアップロードします。
--skip-identical
両側で同じファイルのアップロードはスキップします。
-s、--segment-size <size>
<size> (バイト単位)より大きくないセグメントのファイルをアップロードしてから、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 と併用すると、デフォルトの Dynamic Large Object ではなく、静的な大規模オブジェクトが作成されます。
--object-name <object-name>
ファイルおよび名前オブジェクトを <object-name> または dir にアップロードし、フォルダー名ではなくオブジェクト接頭辞として <object-name> を使用します。
--ignore-checksum
アップロードのチェックサム検証をオフにします。

第12章 オーケストレーションサービスのコマンドラインクライアント

heat クライアントは、Orchestration サービス 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-poll
スタックの保留中のフックを持つリソースをリスト表示します。
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 に出力します。
help
このプログラムまたはそのサブコマンドのヘルプを表示します。

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 証明書のパス。このオプションを指定しないと、デフォルトのシステム 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
スタックリソースが予想される状態であることを確認します。

位置引数

<NAME or ID>
確認するスタックの名前または ID。

12.4. heat action-resume

usage: heat action-resume <NAME or ID>
Copy to Clipboard Toggle word wrap
スタックを再開します。

位置引数

<NAME or ID>
再開するスタックの名前または ID。

12.5. heat action-suspend

usage: heat action-suspend <NAME or ID>
Copy to Clipboard Toggle word wrap
スタックを一時停止します。

位置引数

<NAME or 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
ソフトウェア設定を作成します。

位置引数

<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
ソフトウェア設定を削除します。

位置引数

<ID>
削除する設定の ID。

12.9. heat config-show

usage: heat config-show [-c] <ID>
Copy to Clipboard Toggle word wrap
ソフトウェア設定の詳細を表示します。

位置引数

<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
ソフトウェアデプロイメントを作成します。

位置引数

<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 は、HTTP PUT 経由でシグナル送信する Swift TempURL を作成します。NO_SIGNAL を指定すると、リソースはシグナルを待たずに COMPLETE の状態に移行します。
--container <CONTAINER_NAME>
TEMP_URL_SIGNAL オブジェクトを保存するコンテナーのオプション名です。指定しない場合は、DEPLOY_NAME から派生した名前でコンテナーが作成されます。
--timeout <TIMEOUT>
デプロイメントのタイムアウト (分単位)

12.11. heat deployment-delete

usage: heat deployment-delete <ID> [<ID> ...]
Copy to Clipboard Toggle word wrap
ソフトウェアデプロイメントを削除します。

位置引数

<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
指定されたサーバーのデプロイメント設定のメタデータを取得します。

位置引数

<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
特定のデプロイメント出力を表示します。

位置引数

<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
ソフトウェアデプロイメントの詳細を表示します。

位置引数

<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
スタックのイベントを一覧表示します。

位置引数

<NAME or 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 のいずれか、テーブル

12.17. heat event-show

usage: heat event-show <NAME or ID> <RESOURCE> <EVENT>
Copy to Clipboard Toggle word wrap
イベントを記述します。

位置引数

<NAME or 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
指定のスタックのフックを消去します。

位置引数

<NAME or ID>
これらのリソースが属するスタックの名前または ID。
<RESOURCE>
クリアするフックを含むリソース名。ネストされたスタックのリソースは、スラッシュを区切り文字(nested_stack/another/my_resource)として使用して設定できます。ワイルドカードを使用して、複数のスタックまたはリソース(nested_stack/an*/*_resource)と一致することができます。

オプションの引数

--pre-create
作成前のフックをクリアします(オプション)。
--pre-update
更新前のフックをクリアします(オプション)。

12.19. heat hook-poll

usage: heat hook-poll [-n <DEPTH>] <NAME or ID>
Copy to Clipboard Toggle word wrap
スタックの保留中のフックを持つリソースをリスト表示します。

位置引数

<NAME or ID>
保留中のフックを表示するスタックの名前または ID。

オプションの引数

-n <DEPTH>, --nested-depth <DEPTH>
フックを表示するネストされたスタックの深さ。

12.20. heat output-list

usage: heat output-list <NAME or ID>
Copy to Clipboard Toggle word wrap
利用可能な出力を表示します。

位置引数

<NAME or 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
特定のスタック出力を表示します。

位置引数

<NAME or 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
スタックに属するリソースのリストを表示します。

位置引数

<NAME or 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
リソースのメタデータを一覧表示します。

位置引数

<NAME or ID>
リソースメタデータを表示するスタックの名前または ID。
<RESOURCE>
メタデータを表示するリソースの名前。

12.24. heat resource-show

usage: heat resource-show [-a <ATTRIBUTE>] <NAME or ID> <RESOURCE>
Copy to Clipboard Toggle word wrap
リソースを記述します。

位置引数

<NAME or 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
リソースにシグナルを送信します。

位置引数

<NAME or 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
リソース種別を表示します。

位置引数

<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
リソースタイプに基づいてテンプレートを生成します。

位置引数

<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
スタックのスナップショットを削除します。

位置引数

<NAME or ID>
スナップショットが含まれるスタックの名前または ID。
<SNAPSHOT>
削除するスナップショットの ID。

12.31. heat snapshot-list

usage: heat snapshot-list <NAME or ID>
Copy to Clipboard Toggle word wrap
スタックのスナップショットを一覧表示します。

位置引数

<NAME or ID>
スナップショットが含まれるスタックの名前または ID。

12.32. heat snapshot-show

usage: heat snapshot-show <NAME or ID> <SNAPSHOT>
Copy to Clipboard Toggle word wrap
スタックのスナップショットを表示します。

位置引数

<NAME or 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 またはファイルに出力します。

位置引数

<NAME or 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
スタックを受け入れます。

位置引数

<STACK_NAME>
採用するスタックの名前。

オプションの引数

-e <FILE or URL>, --environment-file <FILE or URL>
環境へのパス。複数回指定できます。
-c <TIMEOUT>, --create-timeout <TIMEOUT>
スタックの作成タイムアウト(分単位)。非推奨 代わりに --timeout を使用します。
-t <TIMEOUT>, --timeout <TIMEOUT>
スタックの作成タイムアウト(分単位)。
-a <FILE または URL>、--adopt-file <FILE または URL>
スタックデータファイルへのパス。
-r、--enable-rollback
作成/更新失敗時のロールバックを有効にします。
-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
現在実行中のスタックの更新をキャンセルします。

位置引数

<NAME or 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
スタックを作成します。

位置引数

<STACK_NAME>
作成するスタックの名前。

オプションの引数

-f <FILE>, --template-file <FILE>
テンプレートへのパスです。
-e <FILE or URL>, --environment-file <FILE or URL>
環境へのパス。複数回指定できます。
--pre-create <RESOURCE>
作成前フックを設定するリソースの名前。ネストされたスタックのリソースは、スラッシュを区切り文字(nested_stack/another/my_resource)として使用して設定できます。ワイルドカードを使用して、複数のスタックまたはリソース(nested_stack/an*/*_resource)と一致することができます。これは複数回指定できます。
-u <URL>、--template-url <URL>
テンプレートの URL。
-o <URL>、--template-object <URL>
テンプレートオブジェクトを取得する URL (例:swift から)。
-c <TIMEOUT>, --create-timeout <TIMEOUT>
スタックの作成タイムアウト(分単位)。非推奨 代わりに --timeout を使用します。
-t <TIMEOUT>, --timeout <TIMEOUT>
スタックの作成タイムアウト(分単位)。
-r、--enable-rollback
作成/更新失敗時のロールバックを有効にします。
-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
スタックを削除します。

位置引数

<NAME or 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...>
返されたスタックのソートに使用するキーのリスト。これは複数回指定することも、1 回にキーをセミコロンで区切って指定することができます。有効なソートキーには、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
スタックをプレビューします。

位置引数

<STACK_NAME>
プレビューするスタックの名前。

オプションの引数

-f <FILE>, --template-file <FILE>
テンプレートへのパスです。
-e <FILE or URL>, --environment-file <FILE or URL>
環境へのパス。複数回指定できます。
-u <URL>、--template-url <URL>
テンプレートの URL。
-o <URL>、--template-object <URL>
テンプレートオブジェクトを取得する URL (例:swift から)
-t <TIMEOUT>, --timeout <TIMEOUT>
スタックの作成タイムアウト(分単位)。これはプレビューでのみ使用されます。
-r、--enable-rollback
失敗時のロールバックを有効にします。このオプションはプレビュー中には使用されず、stack- create のシンボリックリンクにのみ存在します。
-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
スタックのスナップショットを復元します。

位置引数

<NAME or ID>
スナップショットが含まれるスタックの名前または ID。
<SNAPSHOT>
復元するスナップショットの ID。

12.41. heat stack-show

usage: heat stack-show <NAME or ID>
Copy to Clipboard Toggle word wrap
スタックを記述します。

位置引数

<NAME or ID>
記述するスタックの名前または ID。

12.42. heat stack-snapshot

usage: heat stack-snapshot [-n <NAME>] <NAME or ID>
Copy to Clipboard Toggle word wrap
スタックのスナップショットを作成します。

位置引数

<NAME or 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
スタックを更新します。

位置引数

<NAME or ID>
更新するスタックの名前または ID。

オプションの引数

-f <FILE>, --template-file <FILE>
テンプレートへのパスです。
-e <FILE or URL>, --environment-file <FILE or URL>
環境へのパス。複数回指定できます。
--pre-update <RESOURCE>
更新前フックを設定するリソースの名前。ネストされたスタックのリソースは、スラッシュを区切り文字(nested_stack/another/my_resource)として使用して設定できます。ワイルドカードを使用して、複数のスタックまたはリソース(nested_stack/an*/*_resource)と一致することができます。これは複数回指定できます。
-u <URL>、--template-url <URL>
テンプレートの URL。
-o <URL>、--template-object <URL>
テンプレートオブジェクトを取得する URL (例:swift から)。
-t <TIMEOUT>, --timeout <TIMEOUT>
スタックの更新タイムアウト(分単位)。
-r、--enable-rollback
非推奨になりました。代わりに --rollback 引数を使用してください。スタックの更新失敗時のロールバックを有効にします。注記:現在、デフォルトの動作では、既存スタックの rollback 値が使用されます。
--rollback <VALUE>
更新の失敗時にロールバックを設定します。値('1'、't'、'true'、'on'、'y'、'yes')は、ロールバックを有効に設定します。値('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
現在のスタックのテンプレート、パラメーター、および環境を再利用します。テンプレートの引数を省略すると、既存のテンプレートが使用されます。--environment-file を指定しないと、既存の環境が使用されます。--parameters で指定したパラメーターは、現在のスタックの既存の値にパッチを適用します。パラメーター省略すると、既存の値は維持されます。
-c <PARAMETER>, --clear-parameter <PARAMETER>
スタックの更新用に、現在のスタックのパラメーターセットからパラメーターを削除します。テンプレートのデフォルト値が使用されます。これは複数回指定できます。
--tags <TAG1,TAG2>
スタックに関連付ける更新されたタグのリスト。

12.44. heat template-function-list

usage: heat template-function-list <TEMPLATE_VERSION>
Copy to Clipboard Toggle word wrap
利用可能な関数をリスト表示します。

位置引数

<TEMPLATE_VERSION>
関数を取得するテンプレートのバージョン。

12.45. heat template-show

usage: heat template-show <NAME or ID>
Copy to Clipboard Toggle word wrap
指定されたスタックのテンプレートを取得します。

位置引数

<NAME or 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 or URL>, --environment-file <FILE or 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
既存のアラームを更新します(非推奨)。
capabilities
Ceilometer 機能を出力します。
event-list
イベントをリスト表示します。
event-show
特定のイベントを表示します。
event-type-list
イベントタイプを一覧表示します。
meter-list
ユーザーのメーターを一覧表示します。
query-alarm-history
Alarm History にクエリーを実行します。
query-alarms
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
イベントタイプ <event_type> の <trait_name> という名前のすべての特性を一覧表示します。
bash-completion
すべてのコマンドとオプションを stdout に出力します。
help
このプログラムまたはそのサブコマンドのヘルプを表示します。

13.2. Ceilometer オプションの引数

--version
プログラムのバージョン番号を表示して終了します。
-d、--debug
デフォルトは env[CEILOMETERCLIENT_DEBUG] です。
-v、--verbose
より詳細な出力を出力します。
--timeout TIMEOUT
レスポンスを待つ秒数。
--ceilometer-url <CEILOMETER_URL>
非推奨。代わりに --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>
アラームに関連付けるテナント(管理者ユーザーのみが設定可能)。
--user-id <ALARM_USER_ID>
アラームに関連付けるユーザー(管理者ユーザーのみが設定可能)。
--description <DESCRIPTION>
アラームのフリーテキストの説明。
--state <STATE>
アラームの状態。['ok'、'alarm'、'insufficient data'] のいずれか
--severity <SEVERITY>
アラームの重大度。['low'、'moderate'、'critical'] のいずれか
--enabled {True|False}
True を指定すると、アラームの評価/アクションが有効になります。
--alarm-action <Webhook URL>
アラームが遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--ok-action <Webhook URL>
状態が OK に遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--insufficient-data-action <Webhook URL>
状態が不十分なデータに移行する際に呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--time-constraint <Time Constraint>
評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] のデフォルトです。
--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
他のアラームの状態に基づいて、既存のアラームを更新します。

位置引数

<ALARM_ID>
更新するアラームの ID。

オプションの引数

--name <NAME>
アラームの名前(テナントごとに一意である必要があります)。
--project-id <ALARM_PROJECT_ID>
アラームに関連付けるテナント(管理者ユーザーのみが設定可能)。
--user-id <ALARM_USER_ID>
アラームに関連付けるユーザー(管理者ユーザーのみが設定可能)。
--description <DESCRIPTION>
アラームのフリーテキストの説明。
--state <STATE>
アラームの状態。['ok'、'alarm'、'insufficient data'] のいずれか
--severity <SEVERITY>
アラームの重大度。['low'、'moderate'、'critical'] のいずれか
--enabled {True|False}
True を指定すると、アラームの評価/アクションが有効になります。
--alarm-action <Webhook URL>
アラームが遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--ok-action <Webhook URL>
状態が OK に遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--insufficient-data-action <Webhook URL>
状態が不十分なデータに移行する際に呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--time-constraint <Time Constraint>
評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] のデフォルトです。
--repeat-actions {True|False}
True を指定すると、アラームがターゲット状態のままにアクションが繰り返し通知されます。デフォルトは False です。
--remove-time-constraint <Constraint names>
削除する時間制約の名前またはリスト。
--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
アラームを削除します。

位置引数

<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>
アラームに関連付けるテナント(管理者ユーザーのみが設定可能)。
--user-id <ALARM_USER_ID>
アラームに関連付けるユーザー(管理者ユーザーのみが設定可能)。
--description <DESCRIPTION>
アラームのフリーテキストの説明。
--state <STATE>
アラームの状態。['ok'、'alarm'、'insufficient data'] のいずれか
--severity <SEVERITY>
アラームの重大度。['low'、'moderate'、'critical'] のいずれか
--enabled {True|False}
True を指定すると、アラームの評価/アクションが有効になります。
--alarm-action <Webhook URL>
アラームが遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--ok-action <Webhook URL>
状態が OK に遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--insufficient-data-action <Webhook URL>
状態が不十分なデータに移行する際に呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--time-constraint <Time Constraint>
評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] のデフォルトです。
--repeat-actions {True|False}
True を指定すると、アラームがターゲット状態のままにアクションが繰り返し通知されます。デフォルトは False です。
--event-type <EVENT_TYPE>
イベントアラームのイベントタイプ。
-q <QUERY>, --query <QUERY>
key[op]data_type::value; イベントをフィルタリングするためのリスト。data_type は任意ですが、指定する場合は string、integer、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
イベントに基づいて既存のアラームを更新します。

位置引数

<ALARM_ID>
更新するアラームの ID。

オプションの引数

--name <NAME>
アラームの名前(テナントごとに一意である必要があります)。
--project-id <ALARM_PROJECT_ID>
アラームに関連付けるテナント(管理者ユーザーのみが設定可能)。
--user-id <ALARM_USER_ID>
アラームに関連付けるユーザー(管理者ユーザーのみが設定可能)。
--description <DESCRIPTION>
アラームのフリーテキストの説明。
--state <STATE>
アラームの状態。['ok'、'alarm'、'insufficient data'] のいずれか
--severity <SEVERITY>
アラームの重大度。['low'、'moderate'、'critical'] のいずれか
--enabled {True|False}
True を指定すると、アラームの評価/アクションが有効になります。
--alarm-action <Webhook URL>
アラームが遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--ok-action <Webhook URL>
状態が OK に遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--insufficient-data-action <Webhook URL>
状態が不十分なデータに移行する際に呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--time-constraint <Time Constraint>
評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] のデフォルトです。
--repeat-actions {True|False}
True を指定すると、アラームがターゲット状態のままにアクションが繰り返し通知されます。デフォルトは False です。
--event-type <EVENT_TYPE>
イベントアラームのイベントタイプ。
-q <QUERY>, --query <QUERY>
key[op]data_type::value; イベントをフィルタリングするためのリスト。data_type は任意ですが、指定する場合は string、integer、float、または datetime にする必要があります。

13.8. ceilometer alarm-gnocchi-aggregation-by-metrics-threshold-create

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>
アラームに関連付けるテナント(管理者ユーザーのみが設定可能)。
--user-id <ALARM_USER_ID>
アラームに関連付けるユーザー(管理者ユーザーのみが設定可能)。
--description <DESCRIPTION>
アラームのフリーテキストの説明。
--state <STATE>
アラームの状態。['ok'、'alarm'、'insufficient data'] のいずれか
--severity <SEVERITY>
アラームの重大度。['low'、'moderate'、'critical'] のいずれか
--enabled {True|False}
True を指定すると、アラームの評価/アクションが有効になります。
--alarm-action <Webhook URL>
アラームが遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--ok-action <Webhook URL>
状態が OK に遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--insufficient-data-action <Webhook URL>
状態が不十分なデータに移行する際に呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--time-constraint <Time Constraint>
評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] のデフォルトです。
--repeat-actions {True|False}
True を指定すると、アラームがターゲット状態のままにアクションが繰り返し通知されます。デフォルトは False です。
--granularity <GRANULARITY>
評価する各期間の長さ (秒単位)。
--evaluation-periods <COUNT>
評価する期間数です。
--aggregation-method <AGGREATION>
使用する集約メソッド。['max'、'min'、'avg'、'sum'、'count'] のいずれか。
--comparison-operator <OPERATOR>
比較する演算子:['lt'、'le'、'eq'、'ne'、'ge'、'gt'] のいずれか。
--threshold <THRESHOLD>
評価するしきい値。必須。
-m <METRICS>、--metrics <METRICS>
評価対象のメトリック。必須。

13.9. ceilometer alarm-gnocchi-aggregation-by-metrics-threshold-update

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
計算された統計に基づいて既存のアラームを更新します。

位置引数

<ALARM_ID>
更新するアラームの ID。

オプションの引数

--name <NAME>
アラームの名前(テナントごとに一意である必要があります)。
--project-id <ALARM_PROJECT_ID>
アラームに関連付けるテナント(管理者ユーザーのみが設定可能)。
--user-id <ALARM_USER_ID>
アラームに関連付けるユーザー(管理者ユーザーのみが設定可能)。
--description <DESCRIPTION>
アラームのフリーテキストの説明。
--state <STATE>
アラームの状態。['ok'、'alarm'、'insufficient data'] のいずれか
--severity <SEVERITY>
アラームの重大度。['low'、'moderate'、'critical'] のいずれか
--enabled {True|False}
True を指定すると、アラームの評価/アクションが有効になります。
--alarm-action <Webhook URL>
アラームが遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--ok-action <Webhook URL>
状態が OK に遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--insufficient-data-action <Webhook URL>
状態が不十分なデータに移行する際に呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--time-constraint <Time Constraint>
評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] のデフォルトです。
--repeat-actions {True|False}
True を指定すると、アラームがターゲット状態のままにアクションが繰り返し通知されます。デフォルトは False です。
--granularity <GRANULARITY>
評価する各期間の長さ (秒単位)。
--evaluation-periods <COUNT>
評価する期間数です。
--aggregation-method <AGGREATION>
使用する集約メソッド。['max'、'min'、'avg'、'sum'、'count'] のいずれか。
--comparison-operator <OPERATOR>
比較する演算子:['lt'、'le'、'eq'、'ne'、'ge'、'gt'] のいずれか。
--threshold <THRESHOLD>
評価するしきい値。
-m <METRICS>、--metrics <METRICS>
評価対象のメトリック。
--remove-time-constraint <Constraint names>
削除する時間制約の名前またはリスト。

13.10. ceilometer alarm-gnocchi-aggregation-by-resources-threshold-create

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>
アラームに関連付けるテナント(管理者ユーザーのみが設定可能)。
--user-id <ALARM_USER_ID>
アラームに関連付けるユーザー(管理者ユーザーのみが設定可能)。
--description <DESCRIPTION>
アラームのフリーテキストの説明。
--state <STATE>
アラームの状態。['ok'、'alarm'、'insufficient data'] のいずれか
--severity <SEVERITY>
アラームの重大度。['low'、'moderate'、'critical'] のいずれか
--enabled {True|False}
True を指定すると、アラームの評価/アクションが有効になります。
--alarm-action <Webhook URL>
アラームが遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--ok-action <Webhook URL>
状態が OK に遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--insufficient-data-action <Webhook URL>
状態が不十分なデータに移行する際に呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--time-constraint <Time Constraint>
評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] のデフォルトです。
--repeat-actions {True|False}
True を指定すると、アラームがターゲット状態のままにアクションが繰り返し通知されます。デフォルトは False です。
--granularity <GRANULARITY>
評価する各期間の長さ (秒単位)。
--evaluation-periods <COUNT>
評価する期間数です。
--aggregation-method <AGGREATION>
使用する集約メソッド。['max'、'min'、'avg'、'sum'、'count'] のいずれか。
--comparison-operator <OPERATOR>
比較する演算子:['lt'、'le'、'eq'、'ne'、'ge'、'gt'] のいずれか。
--threshold <THRESHOLD>
評価するしきい値。必須。
-M <METRIC>、--metric <METRIC>
評価対象のメトリック。必須。
--resource-type <RESOURCE_TYPE>
評価する resource_type。必須。
--query <QUERY>
Gnocchi リソース検索クエリーフィルターが必要です。

13.11. ceilometer alarm-gnocchi-aggregation-by-resources-threshold-update

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
計算された統計に基づいて既存のアラームを更新します。

位置引数

<ALARM_ID>
更新するアラームの ID。

オプションの引数

--name <NAME>
アラームの名前(テナントごとに一意である必要があります)。
--project-id <ALARM_PROJECT_ID>
アラームに関連付けるテナント(管理者ユーザーのみが設定可能)。
--user-id <ALARM_USER_ID>
アラームに関連付けるユーザー(管理者ユーザーのみが設定可能)。
--description <DESCRIPTION>
アラームのフリーテキストの説明。
--state <STATE>
アラームの状態。['ok'、'alarm'、'insufficient data'] のいずれか
--severity <SEVERITY>
アラームの重大度。['low'、'moderate'、'critical'] のいずれか
--enabled {True|False}
True を指定すると、アラームの評価/アクションが有効になります。
--alarm-action <Webhook URL>
アラームが遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--ok-action <Webhook URL>
状態が OK に遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--insufficient-data-action <Webhook URL>
状態が不十分なデータに移行する際に呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--time-constraint <Time Constraint>
評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] のデフォルトです。
--repeat-actions {True|False}
True を指定すると、アラームがターゲット状態のままにアクションが繰り返し通知されます。デフォルトは False です。
--granularity <GRANULARITY>
評価する各期間の長さ (秒単位)。
--evaluation-periods <COUNT>
評価する期間数です。
--aggregation-method <AGGREATION>
使用する集約メソッド。['max'、'min'、'avg'、'sum'、'count'] のいずれか。
--comparison-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 names>
削除する時間制約の名前またはリスト。

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>
アラームに関連付けるテナント(管理者ユーザーのみが設定可能)。
--user-id <ALARM_USER_ID>
アラームに関連付けるユーザー(管理者ユーザーのみが設定可能)。
--description <DESCRIPTION>
アラームのフリーテキストの説明。
--state <STATE>
アラームの状態。['ok'、'alarm'、'insufficient data'] のいずれか
--severity <SEVERITY>
アラームの重大度。['low'、'moderate'、'critical'] のいずれか
--enabled {True|False}
True を指定すると、アラームの評価/アクションが有効になります。
--alarm-action <Webhook URL>
アラームが遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--ok-action <Webhook URL>
状態が OK に遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--insufficient-data-action <Webhook URL>
状態が不十分なデータに移行する際に呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--time-constraint <Time Constraint>
評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] のデフォルトです。
--repeat-actions {True|False}
True を指定すると、アラームがターゲット状態のままにアクションが繰り返し通知されます。デフォルトは False です。
--granularity <GRANULARITY>
評価する各期間の長さ (秒単位)。
--evaluation-periods <COUNT>
評価する期間数です。
--aggregation-method <AGGREATION>
使用する集約メソッド。['max'、'min'、'avg'、'sum'、'count'] のいずれか。
--comparison-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
計算された統計に基づいて既存のアラームを更新します。

位置引数

<ALARM_ID>
更新するアラームの ID。

オプションの引数

--name <NAME>
アラームの名前(テナントごとに一意である必要があります)。
--project-id <ALARM_PROJECT_ID>
アラームに関連付けるテナント(管理者ユーザーのみが設定可能)。
--user-id <ALARM_USER_ID>
アラームに関連付けるユーザー(管理者ユーザーのみが設定可能)。
--description <DESCRIPTION>
アラームのフリーテキストの説明。
--state <STATE>
アラームの状態。['ok'、'alarm'、'insufficient data'] のいずれか
--severity <SEVERITY>
アラームの重大度。['low'、'moderate'、'critical'] のいずれか
--enabled {True|False}
True を指定すると、アラームの評価/アクションが有効になります。
--alarm-action <Webhook URL>
アラームが遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--ok-action <Webhook URL>
状態が OK に遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--insufficient-data-action <Webhook URL>
状態が不十分なデータに移行する際に呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--time-constraint <Time Constraint>
評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] のデフォルトです。
--repeat-actions {True|False}
True を指定すると、アラームがターゲット状態のままにアクションが繰り返し通知されます。デフォルトは False です。
--granularity <GRANULARITY>
評価する各期間の長さ (秒単位)。
--evaluation-periods <COUNT>
評価する期間数です。
--aggregation-method <AGGREATION>
使用する集約メソッド。['max'、'min'、'avg'、'sum'、'count'] のいずれか。
--comparison-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 names>
削除する時間制約の名前またはリスト。

13.14. ceilometer alarm-history

usage: ceilometer alarm-history [-q <QUERY>] [<ALARM_ID>]
Copy to Clipboard Toggle word wrap
アラームの変更履歴を表示します。

位置引数

<ALARM_ID>
履歴が表示されるアラームの ID。

オプションの引数

-q <QUERY>, --query <QUERY>
key[op]data_type::value; list. data_type は任意ですが、指定する場合は string、integer、float、または boolean にする必要があります。

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 は任意ですが、指定する場合は string、integer、float、または boolean にする必要があります。

13.16. ceilometer alarm-show

usage: ceilometer alarm-show [<ALARM_ID>]
Copy to Clipboard Toggle word wrap
アラームを表示します。

位置引数

<ALARM_ID>
表示するアラームの ID。

13.17. ceilometer alarm-state-get

usage: ceilometer alarm-state-get [<ALARM_ID>]
Copy to Clipboard Toggle word wrap
アラームの状態を取得します。

位置引数

<ALARM_ID>
表示するアラーム状態の ID。

13.18. ceilometer alarm-state-set

usage: ceilometer alarm-state-set --state <STATE> [<ALARM_ID>]
Copy to Clipboard Toggle word wrap
アラームの状態を設定します。

位置引数

<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>
アラームに関連付けるテナント(管理者ユーザーのみが設定可能)。
--user-id <ALARM_USER_ID>
アラームに関連付けるユーザー(管理者ユーザーのみが設定可能)。
--description <DESCRIPTION>
アラームのフリーテキストの説明。
--state <STATE>
アラームの状態。['ok'、'alarm'、'insufficient data'] のいずれか
--severity <SEVERITY>
アラームの重大度。['low'、'moderate'、'critical'] のいずれか
--enabled {True|False}
True を指定すると、アラームの評価/アクションが有効になります。
--alarm-action <Webhook URL>
アラームが遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--ok-action <Webhook URL>
状態が OK に遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--insufficient-data-action <Webhook URL>
状態が不十分なデータに移行する際に呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--time-constraint <Time Constraint>
評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] のデフォルトです。
--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>
比較する演算子:['lt'、'le'、'eq'、'ne'、'ge'、'gt'] のいずれか。
--threshold <THRESHOLD>
評価するしきい値。必須。
-q <QUERY>, --query <QUERY>
key[op]data_type::value; list. data_type は任意ですが、指定する場合は string、integer、float、または boolean にする必要があります。

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
計算された統計に基づいて既存のアラームを更新します。

位置引数

<ALARM_ID>
更新するアラームの ID。

オプションの引数

--name <NAME>
アラームの名前(テナントごとに一意である必要があります)。
--project-id <ALARM_PROJECT_ID>
アラームに関連付けるテナント(管理者ユーザーのみが設定可能)。
--user-id <ALARM_USER_ID>
アラームに関連付けるユーザー(管理者ユーザーのみが設定可能)。
--description <DESCRIPTION>
アラームのフリーテキストの説明。
--state <STATE>
アラームの状態。['ok'、'alarm'、'insufficient data'] のいずれか
--severity <SEVERITY>
アラームの重大度。['low'、'moderate'、'critical'] のいずれか
--enabled {True|False}
True を指定すると、アラームの評価/アクションが有効になります。
--alarm-action <Webhook URL>
アラームが遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--ok-action <Webhook URL>
状態が OK に遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--insufficient-data-action <Webhook URL>
状態が不十分なデータに移行する際に呼び出す URL。複数回の使用が可能です。デフォルトは None です。
--time-constraint <Time Constraint>
評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] のデフォルトです。
--repeat-actions {True|False}
True を指定すると、アラームがターゲット状態のままにアクションが繰り返し通知されます。デフォルトは False です。
--remove-time-constraint <Constraint names>
削除する時間制約の名前またはリスト。
-M <METRIC>、--meter-name <METRIC>
評価対象のメトリック。
--period <PERIOD>
評価する各期間の長さ (秒単位)。
--evaluation-periods <COUNT>
評価する期間数です。
--statistic <STATISTIC>
評価するための統計。['max'、'min'、'avg'、'sum'、'count'] のいずれか。
--comparison-operator <OPERATOR>
比較する演算子:['lt'、'le'、'eq'、'ne'、'ge'、'gt'] のいずれか。
--threshold <THRESHOLD>
評価するしきい値。
-q <QUERY>, --query <QUERY>
key[op]data_type::value; list. data_type は任意ですが、指定する場合は string、integer、float、または boolean にする必要があります。

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 は任意ですが、指定する場合は string、integer、floator datetime にする必要があります。
--no-traits
指定した場合、特性は出力されません。
-l <NUMBER>, --limit <NUMBER>
返すイベントの最大数。

13.23. Ceilometer event-show

usage: ceilometer event-show <message_id>
Copy to Clipboard Toggle word wrap
特定のイベントを表示します。

位置引数

<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 は任意ですが、指定する場合は string、integer、float、または boolean にする必要があります。
-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
Alarm History にクエリーを実行します。

オプションの引数

-f <FILTER>, --filter <FILTER>
{complex_op: [{simple_op: {field_name: value}}]} 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 クエリーアーム

usage: ceilometer query-alarms [-f <FILTER>] [-o <ORDERBY>] [-l <LIMIT>]
Copy to Clipboard Toggle word wrap
Alarms にクエリーします。

オプションの引数

-f <FILTER>, --filter <FILTER>
{complex_op: [{simple_op: {field_name: value}}]} 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}}]} 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 は任意ですが、指定する場合は string、integer、float、または boolean にする必要があります。
-l <NUMBER>, --limit <NUMBER>
返すリソースの最大数。

13.30. ceilometer resource-show

usage: ceilometer resource-show <RESOURCE_ID>
Copy to Clipboard Toggle word wrap
リソースを表示します。

位置引数

<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>
サンプルに関連付けるテナント(管理者ユーザーのみが設定できます)。
--user-id <SAMPLE_USER_ID>
サンプルに関連付ける user (管理者ユーザーのみが設定可能)。
-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
サンプルリストを作成します。

位置引数

<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 は任意ですが、指定する場合は string、integer、float、または boolean にする必要があります。
-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
サンプルを表示します。

位置引数

<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 は任意ですが、指定する場合は string、integer、float、または boolean にする必要があります。
-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 トレイトリスト

usage: ceilometer trait-list -e <EVENT_TYPE> -t <TRAIT_NAME>
Copy to Clipboard Toggle word wrap
イベントタイプ <event_type> の <trait_name> という名前のすべての特性を一覧表示します。

オプションの引数

-e <EVENT_TYPE>、--event_type <EVENT_TYPE>
特性を一覧表示するイベントのタイプ。必須。
-t <TRAIT_NAME>, --trait_name <TRAIT_NAME>
一覧表示する特性の名前。必須。

第14章 データ処理サービスコマンドラインクライアント

sahara クライアントは、Data Processing サービス API とその拡張機能のコマンドラインインターフェイス(CLI)です。この章では、shara バージョン 0.11.1 について説明します。
特定の sahara コマンドのヘルプを表示するには、次のコマンドを実行します。
$ sahara help COMMAND
Copy to Clipboard Toggle word wrap

14.1. Sahara の使用法

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
内部 DB にデータを保存します。このコマンドの代わりに 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-show
プラグインの詳細を表示します。
bash-completion
bash-completion の引数を出力します。sahara.bash_completion スクリプトでハードコードをハードコーディングする必要がないように、すべてのコマンドおよびオプションを stdout に出力します。
help
このプログラムまたはそのサブコマンドのヘルプを表示します。

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
Trust ID
--os-user-id OS_USER_ID
User ID
--os-user-name OS_USERNAME、--os-username OS_USERNAME
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 クラスタースケール

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>
Image to tag。
--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
内部 DB にデータを保存します。このコマンドの代わりに 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 Config パラメーター。繰り返し可能。
--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 クライアントは、Database サービス API とその拡張機能のコマンドラインインターフェイス(CLI)です。本章では、trove バージョン 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
メタデータ値を新しいものに置き換えます。これは non-destructive です。
metadata-list
インスタンス <id> のすべてのメタデータを表示します。
metadata-show
キー <key> およびインスタンス <id> のメタデータエントリーを表示します。
metadata-update
メタデータを更新します。これは破壊的です。
promote-to-replica-source
レプリカをそのセットの新しいレプリカソースにプロモートします。
resize-instance
新規フレーバーでインスタンスのサイズを変更します。
resize-volume
インスタンスのボリュームサイズを変更します。
restart
インスタンスを再起動します。
root-enable
インスタンスのルートを有効にし、すでに存在する場合はリセットします。
root-show
ルートがインスタンスまたはクラスターに対して有効にされた場合にステータスを取得します。
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 の引数を出力します。
help
このプログラムまたはそのサブコマンドのヘルプを表示します。

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
prettyprint の代わりに JSON 出力します。デフォルトは env[OS_JSON_OUTPUT] です。
--profile HMAC_KEY
操作のパフォーマンスをプロファイリングするときにコンテキストデータを暗号化するために使用される HMAC キー。このキーは、Trove で設定された HMAC キーのいずれかに設定する必要があります(通常は /etc/trove にある api-paste.ini にあります)。キーがないと、サーバー側で有効になっていてもプロファイリングはトリガーされません。デフォルトは 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
Trust ID
--os-user-id OS_USER_ID
User ID
--os-user-name OS_USERNAME、--os-username OS_USERNAME
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
別のバックアップからバックアップを作成します。

位置引数

<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
インスタンスのバックアップを作成します。

位置引数

<instance>
インスタンスの ID または名前。
<name>
バックアップの名前。

オプションの引数

--description <description>
バックアップのオプションの説明。
--parent <parent>
増分バックアップを実行するための親バックアップのオプション ID。

15.5. trove backup-delete

usage: trove backup-delete <backup>
Copy to Clipboard Toggle word wrap
バックアップを削除します。

位置引数

<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
インスタンスで利用可能なバックアップを一覧表示します。

位置引数

<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
バックアップの詳細を表示します。

位置引数

<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
新規クラスターを作成します。

位置引数

<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
クラスターを削除します。

位置引数

<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
さらにインスタンスをクラスターに追加します。

位置引数

<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
クラスターのすべてのインスタンスを一覧表示します。

位置引数

<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
クラスターの詳細を表示します。

位置引数

<cluster>
クラスターの ID または名前。

15.15. trove cluster-shrink

usage: trove cluster-shrink <cluster> <instance> [<instance> ...]
Copy to Clipboard Toggle word wrap
クラスターからインスタンスを破棄します。

位置引数

<cluster>
クラスターの ID または名前。
<instance>
クラスターからインスタンスを削除します。複数のインスタンスをドロップするために、複数の ID を指定します。

15.16. Trove 設定割り当て

usage: trove configuration-attach <instance> <configuration>
Copy to Clipboard Toggle word wrap
設定グループをインスタンスにアタッチします。

位置引数

<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
設定グループを作成します。

位置引数

<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
インスタンスのデフォルト設定を表示します。

位置引数

<instance>
インスタンスの ID または名前。

15.19. trove configuration-delete

usage: trove configuration-delete <configuration_group>
Copy to Clipboard Toggle word wrap
設定グループを削除します。

位置引数

<configuration_group>
設定グループの ID。

15.20. trove configuration-detach

usage: trove configuration-detach <instance>
Copy to Clipboard Toggle word wrap
インスタンスから設定グループを切断します。

位置引数

<instance>
インスタンスの ID または名前。

15.21. trove configuration-instances

usage: trove configuration-instances <configuration_group>
Copy to Clipboard Toggle word wrap
設定グループに関連付けられているすべてのインスタンスを一覧表示します。

位置引数

<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
設定グループに使用可能なパラメーターを一覧表示します。

位置引数

<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
設定パラメーターの詳細を表示します。

位置引数

<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
設定グループにパッチを適用します。

位置引数

<configuration_group>
設定グループの ID。
<values>
設定する値のディクショナリー。

15.26. trove configuration-show

usage: trove configuration-show <configuration_group>
Copy to Clipboard Toggle word wrap
設定グループの詳細を表示します。

位置引数

<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
設定グループを更新します。

位置引数

<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
新しいインスタンスを作成します。

位置引数

<name>
インスタンスの名前
<flavor>
インスタンスのフレーバー ID または名前。

オプションの引数

--size <size>
インスタンスディスクボリュームのサイズ(GB 単位)。ボリュームのサポートが有効になっている場合に必要です。
--databases <databases>VARCHARdatabases> ...]
データベースのオプションのリスト。
--users <users>Apnsusers> ...]
user:password 形式のユーザーのオプションリスト。
--backup <backup>
バックアップ ID
--availability_zone <availability_zone>
nova に提供する Zone ヒント。
--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: この ID で NIC をネットワークに接続する必要があります(port-id または net-id のいずれかを指定する必要があります)。v4-fixed-ip: NIC 用の IPv4 固定アドレス(オプション)、port-id: この ID でポートに NIC を割り当てます(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
インスタンスにデータベースを作成します。

位置引数

<instance>
インスタンスの ID または名前。
<name>
データベースの名前

オプションの引数

--character_set <character_set>
データベースのオプションの文字セット。
--collate <collate>
データベースのオプションの照合タイプ。

15.30. trove データベースの削除

usage: trove database-delete <instance> <database>
Copy to Clipboard Toggle word wrap
インスタンスからデータベースを削除します。

位置引数

<instance>
インスタンスの ID または名前。
<database>
データベースの名前

15.31. trove database-list

usage: trove database-list <instance>
Copy to Clipboard Toggle word wrap
インスタンスで利用可能なデータベースを一覧表示します。

位置引数

<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
データストアの詳細を表示します。

位置引数

<datastore>
データストアの ID。

15.34. trove datastore-version-list

usage: trove datastore-version-list <datastore>
Copy to Clipboard Toggle word wrap
データストアで利用可能なバージョンを一覧表示します。

位置引数

<datastore>
データストアの ID または名前。

15.35. trove datastore-version-show

usage: trove datastore-version-show <datastore_version> [--datastore <datastore>]
Copy to Clipboard Toggle word wrap
データストアバージョンの詳細を表示します。

位置引数

<datastore_version>
データストアバージョンの ID または名前。

オプションの引数

--datastore <datastore>
データストアの ID または名前。datastore_version の ID が指定されている場合はオプションになります。

15.36. trove delete

usage: trove delete <instance>
Copy to Clipboard Toggle word wrap
インスタンスを削除します。

位置引数

<instance>
インスタンスの ID または名前。

15.37. trove detach-replica

usage: trove detach-replica <instance>
Copy to Clipboard Toggle word wrap
レプリケーションソースからレプリカインスタンスを切断します。

位置引数

<instance>
インスタンスの ID または名前。

15.38. trove eject-replica-source

usage: trove eject-replica-source <instance>
Copy to Clipboard Toggle word wrap
セットからレプリカソースを取得します。

位置引数

<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
フレーバーの詳細を表示します。

位置引数

<flavor>
フレーバーの ID または名前。

15.41. trove limit-list

usage: trove limit-list
Copy to Clipboard Toggle word wrap
テナントの制限を一覧表示します。

15.42. Trove リスト

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> のデータベースにメタデータを作成します。

位置引数

<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> のメタデータを削除します。

位置引数

<instance_ID>
たとえば UUID です。
<key>
削除するメタデータキー。

15.45. trove metadata-edit

usage: trove metadata-edit <instance_id> <key> <value>
Copy to Clipboard Toggle word wrap
メタデータ値を新しいものに置き換えます。これは non-destructive です。

位置引数

<instance_ID>
たとえば UUID です。
<key>
置き換えるキー。
<value>
<key> に割り当てる新しい値。

15.46. trove metadata-list

usage: trove metadata-list <instance_id>
Copy to Clipboard Toggle word wrap
インスタンス <id> のすべてのメタデータを表示します。

位置引数

<instance_ID>
たとえば UUID です。

15.47. trove metadata-show

usage: trove metadata-show <instance_id> <key>
Copy to Clipboard Toggle word wrap
キー <key> およびインスタンス <id> のメタデータエントリーを表示します。

位置引数

<instance_ID>
たとえば UUID です。
<key>
表示するキー。

15.48. trove metadata-update

usage: trove metadata-update <instance_id> <key> <newkey> <value>
Copy to Clipboard Toggle word wrap
メタデータを更新します。これは破壊的です。

位置引数

<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
レプリカをそのセットの新しいレプリカソースにプロモートします。

位置引数

<instance>
インスタンスの ID または名前。

15.50. trove resize-instance

usage: trove resize-instance <instance> <flavor>
Copy to Clipboard Toggle word wrap
新規フレーバーでインスタンスのサイズを変更します。

位置引数

<instance>
インスタンスの ID または名前。
<flavor>
インスタンスの新規フレーバー

15.51. trove resize-volume

usage: trove resize-volume <instance> <size>
Copy to Clipboard Toggle word wrap
インスタンスのボリュームサイズを変更します。

位置引数

<instance>
インスタンスの ID または名前。
<size>
インスタンスディスクボリュームの新規サイズ(GB 単位)。

15.52. trove restart

usage: trove restart <instance>
Copy to Clipboard Toggle word wrap
インスタンスを再起動します。

位置引数

<instance>
インスタンスの ID または名前。

15.53. trove root-enable

usage: trove root-enable <instance_or_cluster> [--root_password <root_password>]
Copy to Clipboard Toggle word wrap
インスタンスのルートを有効にし、すでに存在する場合はリセットします。

位置引数

<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
ルートがインスタンスまたはクラスターに対して有効にされた場合にステータスを取得します。

位置引数

<instance_or_cluster>
インスタンスまたはクラスターの ID または名前。

15.55. trove secgroup-add-rule

usage: trove secgroup-add-rule <security_group> <cidr>
Copy to Clipboard Toggle word wrap
セキュリティーグループルールを作成します。

位置引数

<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
セキュリティーグループルールを削除します。

位置引数

<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
セキュリティーグループのすべてのルールを一覧表示します。

位置引数

<security_group>
セキュリティーグループ ID。

15.59. trove secgroup-show

usage: trove secgroup-show <security_group>
Copy to Clipboard Toggle word wrap
セキュリティーグループの詳細を表示します。

位置引数

<security_group>
セキュリティーグループ ID。

15.60. trove show

usage: trove show <instance>
Copy to Clipboard Toggle word wrap
インスタンスの詳細を表示します。

位置引数

<instance>
インスタンスの ID または名前。

15.61. trove 更新

usage: trove update <instance> [--name <name>] [--configuration <configuration>] [--detach-replica-source] [--remove_configuration]
Copy to Clipboard Toggle word wrap
インスタンスを更新します。名前、設定、またはレプリカソースを編集します。

位置引数

<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
インスタンスにユーザーを作成します。

位置引数

<instance>
インスタンスの ID または名前。
<name>
ユーザーの名前。
<password>
ユーザーのパスワード。

オプションの引数

--host <host>
ユーザーのオプションのホスト。
--databases <databases>VARCHARdatabases> ...]
データベースのオプションのリスト。

15.63. trove user-delete

usage: trove user-delete [--host <host>] <instance> <name>
Copy to Clipboard Toggle word wrap
インスタンスからユーザーを削除します。

位置引数

<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
ユーザーのデータベースへのアクセスを許可します。

位置引数

<instance>
インスタンスの ID または名前。
<name>
ユーザーの名前。
<databases>
データベースのリスト。

オプションの引数

--host <host>
ユーザーのオプションのホスト。

15.65. trove user-list

usage: trove user-list <instance>
Copy to Clipboard Toggle word wrap
インスタンスのユーザーを一覧表示します。

位置引数

<instance>
インスタンスの ID または名前。

15.66. trove user-revoke-access

usage: trove user-revoke-access [--host <host>] <instance> <name> <database>
Copy to Clipboard Toggle word wrap
ユーザーのデータベースへのアクセスを取り消します。

位置引数

<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
インスタンスのユーザーの詳細を表示します。

位置引数

<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
インスタンスのユーザーのアクセス詳細を表示します。

位置引数

<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
インスタンスのユーザーの属性を更新します。少なくとも 1 つのオプションの引数を指定する必要があります。

位置引数

<instance>
インスタンスの ID または名前。
<name>
ユーザーの名前。

オプションの引数

--host <host>
ユーザーのオプションのホスト。
--NEW_NAME <new_name>
ユーザーの任意の新しい名前。
--new_password <new_password>
(オプション)ユーザーの新しいパスワード。
--new_host <new_host>
ユーザーの任意の新規ホスト。

第16章 データベースサービス管理コマンドラインクライアント

trove-manage クライアントは、データベース管理ユーティリティーとその拡張機能のコマンドラインインターフェイス(CLI)です。本章では、trove-manage バージョン "oslo_config.cfg" 4.0.0 について説明します。
特定の trove-manage コマンドのヘルプを表示するには、次のコマンドを実行します。
$ trove-manage COMMAND --help
Copy to Clipboard Toggle word wrap

16.1. trove-manage の使用

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-file 引数を介して指定されたファイルの後に解析されます。従ってオーバーライドされたオプションが優先されます。
--config-file PATH
使用する設定ファイルへのパス。複数の設定ファイルを指定することができます。この場合、後のファイルの値が優先されます。使用されるデフォルトのファイルは None です。
--debug、-d
デバッグの出力を出力します(デフォルトの INFO レベルではなく ロギングレベルを DEBUG に設定します)。
--log-config-append PATH、--log_config PATH
ロギング設定ファイルの名前。このファイルは、既存のロギング設定ファイルに追加されます。ロギング設定ファイルの詳細は、Python のロギングモジュールのドキュメントを参照してください。
--log-date-format DATE_FORMAT
ログレコードの %(asctime) s のフォーマット文字列。デフォルト:なし(None)です。
--log-dir LOG_DIR、--logdir LOG_DIR
(オプション)--log- ファイルのパスに使用されるベースディレクトリー。
--log-file PATH、--logfile PATH
(オプション)出力先のログファイルの名前。デフォルトが設定されていない場合、ロギングは stdout に移動します。
--log-format FORMAT
非推奨。利用可能な logging.LogRecord 属性を使用することができる logging.Formatter ログメッセージ形式の文字列。このオプションは非推奨となりました。代わりに logging_context_format_string および logging_default_format_string を使用してください。
--nodeBUG
--debug の逆
--Nouse-syslog
--use-syslog の逆
--Nouse-syslog-rfc-format
--use-syslog-rfc-format の逆
--noverbose
--verbose の逆
--syslog-log-facility SYSLOG_LOG_FACILITY
ログ行を受け取る syslog ファシリティー。
--use-syslog
ロギングに syslog を使用します。既存の syslog 形式は 非推奨で あり、後で RFC5424 に従うように変更されます。
--use-syslog-rfc-format
(オプション)ロギングの syslog rfc5424 形式を有効または無効にします。有効にすると、syslog メッセージの MSG 部分の前に APP-NAME (RFC5424)を付けます。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
データストアを追加または更新します。データストアがすでに存在する場合、デフォルトのバージョンが更新されます。

位置引数

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
特定のデータストアおよびデータストアバージョンにフレーバーの関連付けを追加します。

位置引数

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
指定のデータストアおよびデータストアバージョンに関連付けられたフレーバーを削除します。

位置引数

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
データストアバージョンを追加または更新します。データストアバージョンがすでに存在する場合、データストア名とバージョンを除くすべての値が更新されます。

位置引数

datastore
データストアの名前。
version_name
データストアバージョンの名前。
manager
データストアバージョンを管理するマネージャーの名前。
image_id
データストアバージョンのインスタンスを作成するために使用されるイメージの ID。
packages
ゲストイメージにインストールされているデータストアバージョンに必要なパッケージ。
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
指定したバージョンにデータベースをダウングレードします。

位置引数

version
ターゲットのバージョン。

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--REPO_PATH REPO_PATH
SQLalchemy Migrate リポジトリーパス。

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
データストアバージョンの構成グループパラメーター検証ルールをデータベースに読み込みます。

位置引数

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 リポジトリーパス。

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 リポジトリーパス。

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 リポジトリーパス。

第17章 Bare Metal サービスのコマンドラインクライアント

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
ノードのベンダーバイパス拡張を呼び出します。
port-create
新規ポートを作成します。
port-delete
ポートを削除します。
port-list
ポートを一覧表示します。
port-show
ポートの詳細情報を表示します。
port-update
ポートに関する情報を更新します。
driver-list
有効なドライバーをリスト表示します。
driver-properties
ドライバーのプロパティーを取得します。
driver-show
ドライバーに関する情報を表示します。
driver-vendor-passthru
ドライバーのベンダーバイパス拡張機能を呼び出します。
bash-completion
bash 補完のすべてのコマンドとオプションを出力します。
help
このプログラムまたはそのサブコマンドのヘルプを表示します。

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
シャーシを削除します。

位置引数

<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 は制限なしです。デフォルトは、Ironic API サービスで使用される最大数です。
--marker <chassis>
シャーシ UUID (たとえば、以前の要求の一覧の最後のシャーシなど)。この UUID の後にシャーシのリストを返します。
--sort-key <field>
ソートに使用されるシャーシフィールド。
--sort-dir <direction>
並べ替えの方向:"asc" (デフォルト)または "desc"
--fields <field>Apnsfield> ...]
1 つ以上のシャーシフィールド。これらのフィールドのみがサーバーから取得されます。'-- 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
シャーシに含まれるノードを一覧表示します。

位置引数

<chassis>
シャーシの UUID。

オプションの引数

--detail
ノードの詳細情報を表示します。
--limit <limit>
要求ごとに返すノードの最大数。0 は制限なしです。デフォルトは、Ironic API サービスで使用される最大数です。
--marker <node>
ノードの UUID (例:以前の要求リストにある最後のノード)。UUID の後にノードのリストを返します。
--sort-key <field>
ソートに使用されるノードフィールド。
--sort-dir <direction>
並べ替えの方向:"asc" (デフォルト)または "desc"
--fields <field>Apnsfield> ...]
1 つ以上のノードフィールド。これらのフィールドのみがサーバーから取得されます。'-- detail' が指定されている場合は使用できません。

17.7. ironic chassis-show

usage: ironic chassis-show [--fields <field> [<field> ...]] <chassis>
Copy to Clipboard Toggle word wrap
シャーシに関する詳細情報を表示します。

位置引数

<chassis>
シャーシの UUID。

オプションの引数

--fields <field>Apnsfield> ...]
1 つ以上のシャーシフィールド。これらのフィールドのみがサーバーから取得されます。

17.8. ironic chassis-update

usage: ironic chassis-update <chassis> <op> <path=value> [<path=value> ...]
Copy to Clipboard Toggle word wrap
シャーシに関する情報を更新します。

位置引数

<chassis>
シャーシの UUID。
<op>
operation: '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
ドライバーのプロパティーを取得します。

位置引数

<driver>
ドライバーの名前。

17.11. Ironic driver-show

usage: ironic driver-show <driver>
Copy to Clipboard Toggle word wrap
ドライバーに関する情報を表示します。

位置引数

<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
ドライバーのベンダーバイパス拡張機能を呼び出します。

位置引数

<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 サービスからノードの登録を解除します。

位置引数

<node>
ノードの名前または UUID。

17.15. ironic node-get-boot-device

usage: ironic node-get-boot-device <node>
Copy to Clipboard Toggle word wrap
ノードの現在のブートデバイスを取得します。

位置引数

<node>
ノードの名前または UUID。

17.16. ironic node-get-console

usage: ironic node-get-console <node>
Copy to Clipboard Toggle word wrap
ノードのコンソールの接続情報を取得します(有効な場合)。

位置引数

<node>
ノードの名前または UUID。

17.17. ironic node-get-supported-boot-devices

usage: ironic node-get-supported-boot-devices <node>
Copy to Clipboard Toggle word wrap
ノードでサポートされるブートデバイスを取得します。

位置引数

<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 は制限なしです。デフォルトは、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>Apnsfield> ...]
1 つ以上のノードフィールド。これらのフィールドのみがサーバーから取得されます。'-- 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
ノードに関連付けられているポートを一覧表示します。

位置引数

<node>
ノードの UUID。

オプションの引数

--detail
ポートの詳細情報を表示します。
--limit <limit>
要求ごとに返すポートの最大数。0 は制限なしです。デフォルトは、Ironic API サービスで使用される最大数です。
--marker <port>
ポート UUID (たとえば、前のリクエストリストにある最後のポート)。この UUID の後にポートのリストを返します。
--sort-key <field>
ソートに使用されるポートフィールド。
--sort-dir <direction>
並べ替えの方向:"asc" (デフォルト)または "desc"
--fields <field>Apnsfield> ...]
1 つ以上のポートフィールド。これらのフィールドのみがサーバーから取得されます。'-- detail' が指定されている場合は使用できません。

17.20. ironic node-set-boot-device

usage: ironic node-set-boot-device [--persistent] <node> <boot-device>
Copy to Clipboard Toggle word wrap
ノードのブートデバイスを設定します。

位置引数

<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
ノードのシリアルコンソールアクセスを有効または無効にします。

位置引数

<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
ノードのメンテナンスモードを有効または無効にします。

位置引数

<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
ノードの電源をオンまたはオフまたは再起動します。

位置引数

<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
インスタンスのプロビジョニング、再ビルド、削除、検査、提供、および管理を行います。

位置引数

<node>
ノードの名前または UUID。
<provision-state>
サポートされる状態:'active'、'deleted'、'rebuild'、'inspect'、'provide' または 'manage'

オプションの引数

--config-drive <config-drive>
gzipped、base64 でエンコードされたコンフィグドライブ文字列、またはコンフィグドライブファイルを含むディレクトリーへのパス。ディレクトリーの場合には、コンフィグドライブはそのディレクトリーで生成されます。このパラメーターは、プロビジョニング状態を 'active' に設定した場合にのみ有効です。

17.25. ironic node-show

usage: ironic node-show [--instance] [--fields <field> [<field> ...]] <id>
Copy to Clipboard Toggle word wrap
ノードの詳細情報を表示します。

位置引数

<id>
ノードの名前または UUID (または --instance が指定されている場合はインスタンスの UUID)。

オプションの引数

--instance <id>
インスタンスの UUID です。
--fields <field>Apnsfield> ...]
1 つ以上のノードフィールド。これらのフィールドのみがサーバーから取得されます。

17.26. ironic node-show-states

usage: ironic node-show-states <node>
Copy to Clipboard Toggle word wrap
ノードの状態に関する情報を表示します。

位置引数

<node>
ノードの名前または UUID。

17.27. ironic node-update

usage: ironic node-update <node> <op> <path=value> [<path=value> ...]
Copy to Clipboard Toggle word wrap
登録されたノードに関する情報を更新します。

位置引数

<node>
ノードの名前または UUID。
<op>
operation: 'add'、'replace'、または 'remove'。
<path=value>
追加、置換、または削除する属性。複数回指定できます。remove の場合は、<path> のみが必要です。

17.28. ironic node-validate

usage: ironic node-validate <node>
Copy to Clipboard Toggle word wrap
ノードのドライバーインターフェイスを検証します。

位置引数

<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
ノードのベンダーバイパス拡張を呼び出します。

位置引数

<node>
ノードの名前または UUID。
<method>
呼び出される vendor-passthru メソッド。
<ARG=value>
vendor-passthru メソッドに渡される引数。変更時刻を指定できます。

オプションの引数

--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
ポートを削除します。

位置引数

<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 は制限なしです。デフォルトは、Ironic API サービスで使用される最大数です。
--marker <port>
ポート UUID (たとえば、前のリクエストリストにある最後のポート)。この UUID の後にポートのリストを返します。
--sort-key <field>
ソートに使用されるポートフィールド。
--sort-dir <direction>
並べ替えの方向:"asc" (デフォルト)または "desc"
--fields <field>Apnsfield> ...]
1 つ以上のポートフィールド。これらのフィールドのみがサーバーから取得されます。'-- detail' が指定されている場合は使用できません。

17.33. ironic port-show

usage: ironic port-show [--address] [--fields <field> [<field> ...]] <id>
Copy to Clipboard Toggle word wrap
ポートの詳細情報を表示します。

位置引数

<id>
ポートの UUID (または --address が指定されている場合は MAC アドレス)。

オプションの引数

--address <id>
ポートの(UUID ではなく) MAC アドレスです。
--fields <field>Apnsfield> ...]
1 つ以上のポートフィールド。これらのフィールドのみがサーバーから取得されます。

17.34. ironic port-update

usage: ironic port-update <port> <op> <path=value> [<path=value> ...]
Copy to Clipboard Toggle word wrap
ポートに関する情報を更新します。

位置引数

<port>
ポートの UUID
<op>
operation: 'add'、'replace'、または 'remove'。
<path=value>
追加、置換、または削除する属性。複数回指定できます。remove の場合は、<path> のみが必要です。

第18章 共有ファイルシステムのコマンドラインクライアント

manila クライアントは、Shared File Systems 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
1 つ以上の整合性グループを削除します。
cg-list
フィルターを使用した整合性グループを一覧表示します。
cg-reset-state
整合性グループの状態を明示的に更新します。
cg-show
整合性グループの詳細を表示します。
cg-snapshot-create
新規整合性グループを作成します。
cg-snapshot-delete
整合性グループのスナップショット 1 つまたは複数を削除します。
cg-snapshot-list
フィルターを使用した整合性グループのスナップショットを一覧表示します。
cg-snapshot-members
コンシステンシーグループのスナップショットのメンバーの詳細を取得します。
cg-snapshot-reset-state
整合性グループの状態を明示的に更新します。
cg-snapshot-show
整合性グループのスナップショットの詳細を表示します。
cg-snapshot-update
整合性グループのスナップショットを更新します。
cg-update
整合性グループを更新します。
create
新規共有(NFS、CIFS、GlusterFS、または HDFS)を作成します。
credentials
認証から返されたユーザーの認証情報を表示します。
delete
1 つまたは複数の共有を削除します。
endpoints
認証サービスから返されたエンドポイントを検出します。
extend
既存のファイル共有のサイズを大きくします。
extra-specs-list
現在の共有タイプと追加スペックのリストを出力します(管理者のみ)。
force-delete
状態に関係なく、共有の強制削除を試行します。
list
フィルターを使用した NAS 共有を一覧表示します。
manage
管理共有は 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 の引数を出力します。manila.bash_completion スクリプトでハードコードする必要がないように、すべてのコマンドおよびオプションを stdout に出力します。
help
このプログラムまたはそのサブコマンドのヘルプを表示します。
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>
デフォルトは env[OS_SHARE_API_VERSION] をオーバーライドする 1.x を受け入れます。
--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
共有へのアクセスを許可します。

位置引数

<share>
変更する NAS 共有の名前または ID。
<access_type>
アクセスルールタイプ(ip、"user" (user または group)、および 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
ファイル共有へのアクセスを拒否します。

位置引数

<share>
変更する NAS 共有の名前または ID。
<id>
削除するアクセスルールの ID。

18.6. manila access-list

usage: manila access-list <share>
Copy to Clipboard Toggle word wrap
共有のアクセス一覧を表示します。

位置引数

<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>
任意の整合性グループ名。(デフォルト=None)
--description <description>
任意の整合性グループの説明。(デフォルト=None)
--share-types <share_types>, --share_types <share_types>
共有タイプのオプション一覧。(デフォルト=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。(デフォルト=None)

18.9. manila cg-delete

usage: manila cg-delete [--force] <consistency_group> [<consistency_group> ...]
Copy to Clipboard Toggle word wrap
1 つ以上の整合性グループを削除します。

位置引数

<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-tenantsApns0|1>]
すべてのテナントの情報を表示します(管理者のみ)。
--limit <limit>
返す整合性グループの最大数。(デフォルト=None)
--offset <offset>
整合性グループリストの位置を開始します。

18.11. manila cg-reset-state

usage: manila cg-reset-state [--state <state>] <consistency_group>
Copy to Clipboard Toggle word wrap
整合性グループの状態を明示的に更新します。

位置引数

<consistency_group>
変更する整合性グループの状態の名前または ID。

オプションの引数

--state <state>
整合性グループを割り当てる状態を指定します。オプションには、available、error、createing、deleting、error_deleting が含まれます。状態が指定されていない場合は、利用可能な状態が使用されます。

18.12. manila cg-show

usage: manila cg-show <consistency_group>
Copy to Clipboard Toggle word wrap
整合性グループの詳細を表示します。

位置引数

<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
新規整合性グループを作成します。

位置引数

<consistency_group>
整合性グループの名前または ID。

オプションの引数

--name <name>
任意の整合性グループのスナップショット名。(デフォルト=None)
--description <description>
オプションの整合性グループのスナップショットの説明。(デフォルト=None)

18.14. manila cg-snapshot-delete

usage: manila cg-snapshot-delete [--force] <cg_snapshot> [<cg_snapshot> ...]
Copy to Clipboard Toggle word wrap
整合性グループのスナップショット 1 つまたは複数を削除します。

位置引数

<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-tenantsApns0|1>]
すべてのテナントの情報を表示します(管理者のみ)。
--limit <limit>
返す整合性グループのスナップショットの最大数(デフォルト=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
コンシステンシーグループのスナップショットのメンバーの詳細を取得します。

位置引数

<cg_snapshot>
コンシステンシーグループスナップショットの名前または ID。

オプションの引数

--limit <limit>
返す共有の最大数。(デフォルト=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
整合性グループの状態を明示的に更新します。

位置引数

<cg_snapshot>
コンシステンシーグループスナップショットの名前または ID。

オプションの引数

--state <state>
整合性グループを割り当てる状態を指定します。オプションには、available、error、createing、deleting、error_deleting が含まれます。状態が指定されていない場合は、利用可能な状態が使用されます。

18.18. manila cg-snapshot-show

usage: manila cg-snapshot-show <cg_snapshot>
Copy to Clipboard Toggle word wrap
整合性グループのスナップショットの詳細を表示します。

位置引数

<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
整合性グループのスナップショットを更新します。

位置引数

<cg_snapshot>
更新する cg スナップショットの名前または ID。

オプションの引数

--name <name>
cg スナップショットのオプションの新しい名前。(default=None)
--description <description>
オプションの cg スナップショットの説明。(デフォルト=None)

18.20. manila cg-update

usage: manila cg-update [--name <name>] [--description <description>] <consistency_group>
Copy to Clipboard Toggle word wrap
整合性グループを更新します。

位置引数

<consistency_group>
更新する整合性グループの名前または ID。

オプションの引数

--name <name>
整合性グループの新しい名前(デフォルト=None)
--description <description>
任意の整合性グループの説明。(デフォルト=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)を作成します。

位置引数

<share_protocol>
共有種別(NFS、CIFS、GlusterFS、または HDFS)。
<size>
ファイル共有のサイズ(GB)

オプションの引数

--snapshot-id <snapshot-id>
共有の作成元となる任意のスナップショット ID。(デフォルト=None)
--name <name>
オプションの共有名。(デフォルト=None)
--metadataApnskey=value>VARCHARkey=value> ...]]
メタデータ key=value ペア(オプション、デフォルトは None)。
--share-network <network-info>
オプションのネットワーク情報 ID または名前。
--description <description>
オプションの共有の説明。(デフォルト=None)
--share-type <share-type>, --share_type <share-type>, --volume-type <share-type>, --volume_type <share-type>
オプションの共有タイプ。オプションのボリュームタイプの使用は非推奨になりました(デフォルト=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。(デフォルト=None)

18.22. Manila 認証情報

usage: manila credentials
Copy to Clipboard Toggle word wrap
認証から返されたユーザーの認証情報を表示します。

18.23. manila delete

usage: manila delete [--consistency-group <consistency-group>] <share> [<share> ...]
Copy to Clipboard Toggle word wrap
1 つまたは複数の共有を削除します。

位置引数

<share>
共有の名前または ID。

オプションの引数

--consistency-group <consistency-group>, --consistency_group <consistency-group>, --cg <consistency-group>
(オプション)ファイル共有を含む整合性グループ名または ID(デフォルト=None)

18.24. Manila エンドポイント

usage: manila endpoints
Copy to Clipboard Toggle word wrap
認証サービスから返されたエンドポイントを検出します。

18.25. manila extend

usage: manila extend <share> <new_size>
Copy to Clipboard Toggle word wrap
既存のファイル共有のサイズを大きくします。

位置引数

<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
状態に関係なく、共有の強制削除を試行します。

位置引数

<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-tenantsApns0|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 で結果をフィルタリングします。
--metadataApnskey=value>VARCHARkey=value> ...]]
メタデータキーおよび値で結果をフィルタリングします。オプション:デフォルト=None
--extra-specsApnskey=value>VARCHARkey=value> ...]], --extra_specsApnskey=value>VARCHARkey=value> ...]]
ファイル共有の作成に使用された共有種別のキーおよび値によって結果をフィルタリングします。オプション:デフォルト=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-id <share_type>, --share_type_id <share_type>, --volume_type <share_type>, --volume_type_id <share_type>
ファイル共有の作成に使用された共有種別 ID または名前で結果をフィルタリングします。
--limit <limit>
返す共有の最大数。オプション: デフォルトは None です。
--offset <offset>
共有リストの開始点を定義するには、オフセットを設定します。オプション: デフォルトは 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')。オプション: デフォルトは None です。
--sort-dir <sort_dir>, --sort_dir <sort_dir>
並べ替えの方向。使用可能な値は('asc'、'desc')です。オプション: デフォルトは None です。
--snapshot <snapshot>
共有に使用されたスナップショット名または ID の結果。
--host <host>
ホスト別に結果をフィルタリングします。
--share-network <share_network>, --share_network <share_network>
共有ネットワークの名前または ID で結果をフィルタリングします。
--project-id <project_id>、--project_id <project_id>
結果をプロジェクト ID でフィルタリングします。set key '--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 で処理されません。

位置引数

<SERVICE_HOST>
manage-share サービスホスト:some.host@driver#pool
<protocol>
NFS や CIFS など、管理する共有のプロトコル。
<export_path>
ファイル共有のエクスポートパス、NFS 共有(例:10.0.0.1:/foo_path)、CIFS 共有(例:\10.0.0.1 oo_name_of_cifs_share)

オプションの引数

--name <name>
オプションの共有名。(デフォルト=None)
--description <description>
オプションの共有の説明。(デフォルト=None)
--share_type <share-type>、--share-type <share-type>
共有に割り当てられたオプションの共有タイプ。(デフォルト=None)
--driver_optionsuhnkey=value>guavakey=value> ...]], --driver-optionsguavakey=value>VARCHARkey=value> ...]]
ドライバーオプションの key=value ペア(オプション、デフォルトは None)。

18.31. Manila メタデータ

usage: manila metadata <share> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
共有のメタデータを設定または削除します。

位置引数

<share>
メタデータを更新する共有の名前または ID。
<action>
Actions: 'set' または 'unset'。
<key=value>
設定または設定解除するメタデータ(キーは未設定でのみ必要です)。

18.32. Manila metadata-show

usage: manila metadata-show <share>
Copy to Clipboard Toggle word wrap
指定したファイル共有のメタデータを表示します。

位置引数

<share>
共有の名前または ID。

18.33. Manila metadata-update-all

usage: manila metadata-update-all <share> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
ファイル共有のすべてのメタデータを更新します。

位置引数

<share>
メタデータを更新する共有の名前または ID。
<key=value>
更新するメタデータエントリーまたはエントリー。

18.34. manila 移行

usage: manila migrate [--force-host-copy <True|False>] <share> <host#pool>
Copy to Clipboard Toggle word wrap
共有を新しいホストに移行します。

位置引数

<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
クォータクラスのクォータを一覧表示します。

位置引数

<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
クォータクラスのクォータを更新します。

位置引数

<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
テナント/ユーザーのクォータを更新します。

位置引数

<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
共有の状態を明示的に更新します。

位置引数

<share>
変更するファイル共有の名前または ID。

オプションの引数

--state <state>
ファイル共有を割り当てる状態を指定します。オプションには、available、error、createing、deleting、error_deleting が含まれます。状態が指定されていない場合は、利用可能な状態が使用されます。

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
テナントが使用するセキュリティーサービスを作成します。

位置引数

<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
セキュリティーサービスを削除します。

位置引数

<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-tenantsApns0|1>]
すべてのテナントの情報を表示します(管理者のみ)。
--share-network <share_network>, --share_network <share_network>
ファイル共有のネットワーク ID または名前で結果をフィルタリングします。
--status <status>
ステータスで結果をフィルタリングします。
--name <name>
名前で結果をフィルタリングします。
--type <type>
結果をタイプでフィルタリングします。
--user <user>
テナントが使用するユーザーまたはグループで結果をフィルタリングします。
--dns-ip <dns_ip>, --dns_ip <dns_ip>
テナントのネットワークで使用される DNS IP アドレスで結果をフィルタリングします。
--server <server>
セキュリティーサービスの IP アドレスまたはホスト名で結果をフィルタリングします。
--domain <domain>
ドメインで結果をフィルタリングします。
--detailedApns0|1>]
フィルタリングされたセキュリティーサービスに関する詳細情報を表示します。
--offset <offset>
セキュリティーサービス一覧の場所を開始します。
--limit <limit>
リクエストごとに返すセキュリティーサービスの数。

18.47. manila security-service-show

usage: manila security-service-show <security-service>
Copy to Clipboard Toggle word wrap
セキュリティーサービスを表示します。

位置引数

<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
セキュリティーサービスを更新します。

位置引数

<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
状態に関係なく、共有インスタンスの強制削除を試行します。

位置引数

<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
ファイル共有インスタンスの状態を明示的に更新します。

位置引数

<instance>
変更するファイル共有インスタンスの名前または ID。

オプションの引数

--state <state>
インスタンスを割り当てる状態を指定します。オプションには、available、error、createing、deleting、error_deleting が含まれます。状態が指定されていない場合は、利用可能な状態が使用されます。

18.53. manila share-instance-show

usage: manila share-instance-show <instance>
Copy to Clipboard Toggle word wrap
ファイル共有インスタンスの詳細を表示します。

位置引数

<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
共有ネットワークを削除します。

位置引数

<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-tenantsApns0|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
セキュリティーサービスを共有ネットワークに関連付けます。

位置引数

<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
指定したファイル共有ネットワークに関連付けられたセキュリティーサービスのリストを取得します。

位置引数

<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
セキュリティーサービスを共有ネットワークから関連付け解除します。

位置引数

<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
テナントが使用するネットワークの説明を取得します。

位置引数

<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
ファイル共有ネットワークデータを更新します。

位置引数

<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
共有サーバーを削除します。

位置引数

<id>
共有サーバーの ID。

18.63. manila share-server-details

usage: manila share-server-details <id>
Copy to Clipboard Toggle word wrap
共有サーバーの詳細を表示します。

位置引数

<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
共有サーバーの情報を表示します。

位置引数

<id>
共有サーバーの ID。

18.66. manila show

usage: manila show <share>
Copy to Clipboard Toggle word wrap
NAS 共有の詳細を表示します。

位置引数

<share>
NAS 共有の名前または ID。

18.67. manila の縮小

usage: manila shrink <share> <new_size>
Copy to Clipboard Toggle word wrap
既存のファイル共有のサイズを縮小します。

位置引数

<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
新規スナップショットを追加します。

位置引数

<share>
スナップショットを作成する共有の名前または ID。

オプションの引数

--force <True|False>
共有がビジーであってもスナップショットを作成するかどうかを示すオプションのフラグ。(デフォルト=False)
--name <name>
オプションのスナップショット名。(デフォルト=None)
--description <description>
オプションでスナップショットの説明。(デフォルト=None)

18.69. manila snapshot-delete

usage: manila snapshot-delete <snapshot>
Copy to Clipboard Toggle word wrap
スナップショットを削除します。

位置引数

<snapshot>
削除するスナップショットの名前または ID。

18.70. manila snapshot-force-delete

usage: manila snapshot-force-delete <snapshot>
Copy to Clipboard Toggle word wrap
状態に関係なく、スナップショットの強制削除を試行します。

位置引数

<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-tenantsApns0|1>]
すべてのテナントの情報を表示します(管理者のみ)。
--name <name>
名前で結果をフィルタリングします。
--status <status>
ステータスで結果をフィルタリングします。
--share-id <share_id>, --share_id <share_id>
ソース共有 ID で結果をフィルタリングします。
--usage [any|used|unused]
使用状況別にフィルタリングするか、スナップショットのいずれを使用するかのいずれかです。オプション:Default=any。
--limit <limit>
返す共有スナップショットの最大数。オプション: デフォルトは None です。
--offset <offset>
共有スナップショット一覧の開始点を定義するには、オフセットを設定します。オプション: デフォルトは None です。
--sort-key <sort_key>, --sort_key <sort_key>
ソートされるキー、使用可能なキーは次のとおりです('id'、'status'、'size'、'share_id'、'user_id'、'progress'、'name'、'display_name')。デフォルトは None です。
--sort-dir <sort_dir>, --sort_dir <sort_dir>
並べ替えの方向。使用可能な値は('asc'、'desc')です。オプション: デフォルトは None です。

18.72. manila snapshot-rename

usage: manila snapshot-rename [--description <description>] <snapshot> [<name>]
Copy to Clipboard Toggle word wrap
スナップショットの名前を変更します。

位置引数

<snapshot>
名前を変更するスナップショットの名前または ID。
<name>
スナップショットの新しい名前。

オプションの引数

--description <description>
オプションでスナップショットの説明。(デフォルト=None)

18.73. manila snapshot-reset-state

usage: manila snapshot-reset-state [--state <state>] <snapshot>
Copy to Clipboard Toggle word wrap
スナップショットの状態を明示的に更新します。

位置引数

<snapshot>
変更するスナップショットの名前または ID。

オプションの引数

--state <state>
スナップショットを割り当てる状態を示します。オプションには、available、error、createing、deleting、error_deleting が含まれます。状態が指定されていない場合は、利用可能な状態が使用されます。

18.74. manila snapshot-show

usage: manila snapshot-show <snapshot>
Copy to Clipboard Toggle word wrap
スナップショットの詳細を表示します。

位置引数

<snapshot>
スナップショットの名前または ID。

18.75. manila type-access-add

usage: manila type-access-add <share_type> <project_id>
Copy to Clipboard Toggle word wrap
指定されたプロジェクトの共有種別アクセスを追加します。

位置引数

<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
指定した共有種別へのアクセス情報を出力します。

位置引数

<share_type>
共有種別名または ID で結果をフィルタリングします。

18.77. manila type-access-remove

usage: manila type-access-remove <share_type> <project_id>
Copy to Clipboard Toggle word wrap
指定のプロジェクトの共有種別アクセスを削除します。

位置引数

<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
新規共有種別を作成します。

位置引数

<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>
タイプがパブリックにアクセスできるようにします (デフォルトは true)。

18.79. manila type-delete

usage: manila type-delete <id>
Copy to Clipboard Toggle word wrap
特定の共有種別を削除します。

位置引数

<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 を設定または設定解除します。

位置引数

<stype>
共有種別の名前または ID。
<action>
Actions: 'set' または 'unset'。
<key=value>
設定または設定解除する extra_specs (キーは未設定の場合のみ必要です)。

18.81. manila type-list

usage: manila type-list [--all]
Copy to Clipboard Toggle word wrap
利用可能な共有種別の一覧を出力します。

オプションの引数

--all
すべての共有種別を表示します(管理者のみ)。

18.82. Manila の管理解除

usage: manila unmanage <share>
Copy to Clipboard Toggle word wrap
ファイル共有の管理を解除します。

位置引数

<share>
共有の名前または ID。

18.83. manila の更新

usage: manila update [--name <name>] [--description <description>] [--is-public <is_public>] <share>
Copy to Clipboard Toggle word wrap
ファイル共有の名前を変更します。

位置引数

<share>
名前を変更する共有の名前または ID。

オプションの引数

--name <name>
共有の新しい名前。
--description <description>
オプションの共有の説明。(デフォルト=None)
--is-public <is_public>, --is_public <is_public>
すべてのテナントでパブリックファイル共有が表示されます。

第19章 TDBaaS (Time Series Database as a Service)コマンドラインクライアント

gnocchi クライアントは、A 時系列ストレージおよびリソースインデックスサービス API とその拡張機能のコマンドラインインターフェイス(CLI)です。本章では、gnocchi バージョン 2.0.0 について説明します。
特定の gnocchi コマンドのヘルプを表示するには、以下のコマンドを実行します。
$ gnocchi help COMMAND
Copy to Clipboard Toggle word wrap

19.1. Gnocchi の使用

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
アーカイブポリシーの作成

位置引数

name
アーカイブポリシーの名前

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
-b BACK_WINDOW, --back-window BACK_WINDOW
アーカイブポリシーのバックウィンドウ
-m AGGREGATION_METHODS, --aggregation-method AGGREGATION_METHODS
アーカイブポリシーの集約方法
-d <DEFINITION>、--definition <DEFINITION>
名前と値が : で区切られたアーカイブポリシー定義の 2 つの属性(, で区切られます)

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

19.4. Gnocchi archive-policy delete

usage: gnocchi archive-policy delete [-h] name
Copy to Clipboard Toggle word wrap
アーカイブポリシーの削除

位置引数

name
アーカイブポリシーの名前

オプションの引数

-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,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
アーカイブポリシールールを作成する

位置引数

name
ルール名

オプションの引数

-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,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(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
アーカイブポリシールールを削除します。

位置引数

name
アーカイブポリシールールの名前

オプションの引数

-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,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 show

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
アーカイブポリシールールを表示します。

位置引数

name
アーカイブポリシールールの名前

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(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
アーカイブポリシーを表示します。

位置引数

name
アーカイブポリシーの名前

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(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
計測値の追加についてのベンチマークテストを実行します。

位置引数

metric
メトリクスの ID または名前

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--resource-id RESOURCE_ID, -r RESOURCE_ID
リソースの ID
--workers WORKERS, -w WORKERS
使用するワーカー数
--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,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(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
測定項目のベンチマークテストを行う

位置引数

metric
メトリクスの ID または名前

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--resource-id RESOURCE_ID, -r RESOURCE_ID
リソースの ID
--aggregation AGGREGATION
取得する集約
--start START
期間の開始
--stop STOP
期間の終わり
--workers WORKERS, -w WORKERS
使用するワーカー数
--count COUNT, -n COUNT
送信する合計計測値の数

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(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
使用するワーカー数
--count COUNT, -n COUNT
作成するメトリックの数
--keep, -k
作成されたメトリックを保持します。

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

19.14. Gnocchi ベンチマーク metric show

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
metric show のベンチマークテストを実行します。

位置引数

metric
メトリクスの ID または名前

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--resource-id RESOURCE_ID, -r RESOURCE_ID
リソースの ID
--workers WORKERS, -w WORKERS
使用するワーカー数
--count COUNT, -n COUNT
取得するメトリックの数

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

19.15. Gnocchi capabilities リスト

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,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(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
計測値をメトリックに追加します。

位置引数

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 ...]
メトリクス ID またはメトリクス名
--aggregation AGGREGATION
取得する集約
--start START
期間の開始
--stop STOP
期間の終わり
--needed-overlap NEEDED_OVERLAP
各メトリックのデータポイントのパーセントが必要
--query QUERY
Query

出力フォーマッター

出力フォーマット設定オプション
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

19.18. Gnocchi measure show

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
メトリックの測定値を取得します。

位置引数

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,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

19.19. Gnocchi metric create

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
メトリクスを作成します。

位置引数

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,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

19.20. Gnocchi metric delete

usage: gnocchi metric delete [-h] [--resource-id RESOURCE_ID] metric [metric ...]
Copy to Clipboard Toggle word wrap
メトリックを削除します。

位置引数

metric
メトリクスの ID または名前

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--resource-id RESOURCE_ID, -r RESOURCE_ID
リソースの ID

19.21. Gnocchi metric list

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,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

19.22. Gnocchi metric show

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
メトリックを表示します。

位置引数

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,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

19.23. Gnocchi resource create

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
リソースを作成します。

位置引数

resource_id
リソースの ID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--type RESOURCE_TYPE, -t RESOURCE_TYPE
リソースのタイプ
-a ATTRIBUTE、--attribute ATTRIBUTE
':' で区切られた属性の名前と値
-m ADD_METRIC, --add-metric ADD_METRIC
追加するメトリクスの名前:
-n CREATE_METRIC, --create-metric CREATE_METRIC
作成するメトリクスの name:archive_policy_name
-d DELETE_METRIC, --delete-metric DELETE_METRIC
削除するメトリックの名前

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

19.24. Gnocchi resource delete

usage: gnocchi resource delete [-h] resource_id
Copy to Clipboard Toggle word wrap
リソースを削除します。

位置引数

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
リソースの履歴を表示します。

位置引数

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,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

19.26. Gnocchi resource list

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,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

CSV フォーマッター:

--quote {all,minimal,none,nonnumeric}
引用符を含める場合は、デフォルトで数字以外のものになります。

19.28. Gnocchi resource show

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
リソースを表示します。

位置引数

resource_id
リソースの ID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--type RESOURCE_TYPE, -t RESOURCE_TYPE
リソースのタイプ

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(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
リソースを更新します。

位置引数

resource_id
リソースの ID

オプションの引数

-h、--help
ヘルプメッセージを表示して終了します。
--type RESOURCE_TYPE, -t RESOURCE_TYPE
リソースのタイプ
-a ATTRIBUTE、--attribute ATTRIBUTE
':' で区切られた属性の名前と値
-m ADD_METRIC, --add-metric ADD_METRIC
追加するメトリクスの名前:
-n CREATE_METRIC, --create-metric CREATE_METRIC
作成するメトリクスの name:archive_policy_name
-d DELETE_METRIC, --delete-metric DELETE_METRIC
削除するメトリックの名前

出力フォーマッター

出力フォーマット設定オプション
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(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,table,value,yaml,yaml,yaml}
出力形式。デフォルトは table です。
-c COLUMN, --column COLUMN
追加する列を指定します。繰り返すことができます。

テーブルフォーマッター:

--max-width <integer>
最大表示幅。無効にする場合は 0

JSON フォーマッター:

--noindent
JSON のインデントを無効にするかどうか

シェルフォーマッター:

UNIX シェルが解析できる形式(variable="value")
--prefix PREFIX
すべての変数名に接頭辞を追加します。

更新履歴

改訂履歴
改訂 7.0.0-1Wed Jan 20 2016Radek Bíba
Red Hat OpenStack Platform 8.0 のリリース

法律上の通知

Copyright © 2016 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA").An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/.In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent.Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission.We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2026 Red Hat
トップに戻る