Merge "remove the cli-ref from openstack-manuals"
This commit is contained in:
Jenkins
Gerrit Code Review
commit
bca5b27530
@ -1,27 +0,0 @@
|
||||
[metadata]
|
||||
name = clireference
|
||||
summary = OpenStack Command-Line Interface Reference
|
||||
author = OpenStack
|
||||
author-email = openstack-docs@lists.openstack.org
|
||||
home-page = https://docs.openstack.org/
|
||||
classifier =
|
||||
Environment :: OpenStack
|
||||
Intended Audience :: Information Technology
|
||||
Intended Audience :: Cloud Architects
|
||||
License :: OSI Approved :: Apache Software License
|
||||
Operating System :: POSIX :: Linux
|
||||
Topic :: Documentation
|
||||
|
||||
[global]
|
||||
setup-hooks =
|
||||
pbr.hooks.setup_hook
|
||||
|
||||
[files]
|
||||
|
||||
[build_sphinx]
|
||||
warning-is-error = 1
|
||||
build-dir = build
|
||||
source-dir = source
|
||||
|
||||
[wheel]
|
||||
universal = 1
|
||||
@ -1,30 +0,0 @@
|
||||
#!/usr/bin/env python
|
||||
# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
# implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT
|
||||
import setuptools
|
||||
|
||||
# In python < 2.7.4, a lazy loading of package `pbr` will break
|
||||
# setuptools if some other modules registered functions in `atexit`.
|
||||
# solution from: http://bugs.python.org/issue15881#msg170215
|
||||
try:
|
||||
import multiprocessing # noqa
|
||||
except ImportError:
|
||||
pass
|
||||
|
||||
setuptools.setup(
|
||||
setup_requires=['pbr'],
|
||||
pbr=True)
|
||||
@ -1,523 +0,0 @@
|
||||
.. ###################################################
|
||||
.. ## WARNING ######################################
|
||||
.. ############## WARNING ##########################
|
||||
.. ########################## WARNING ##############
|
||||
.. ###################################### WARNING ##
|
||||
.. ###################################################
|
||||
.. ###################################################
|
||||
.. ##
|
||||
.. This file is tool-generated. Do not edit manually.
|
||||
.. http://docs.openstack.org/contributor-guide/
|
||||
.. doc-tools/cli-reference.html
|
||||
.. ##
|
||||
.. ## WARNING ######################################
|
||||
.. ############## WARNING ##########################
|
||||
.. ########################## WARNING ##############
|
||||
.. ###################################### WARNING ##
|
||||
.. ###################################################
|
||||
|
||||
=====================================================
|
||||
Telemetry Alarming service (aodh) command-line client
|
||||
=====================================================
|
||||
|
||||
The aodh client is the command-line interface (CLI) for
|
||||
the Telemetry Alarming service (aodh) API and its extensions.
|
||||
|
||||
This chapter documents :command:`aodh` version ``0.9.0``.
|
||||
|
||||
For help on a specific :command:`aodh` command, enter:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ aodh help COMMAND
|
||||
|
||||
.. _aodh_command_usage:
|
||||
|
||||
aodh usage
|
||||
~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: aodh [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]
|
||||
[--os-region-name <auth-region-name>] [--os-interface <interface>]
|
||||
[--aodh-api-version AODH_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-default-domain-id OS_DEFAULT_DOMAIN_ID]
|
||||
[--os-default-domain-name OS_DEFAULT_DOMAIN_NAME]
|
||||
[--os-user-id OS_USER_ID] [--os-username OS_USERNAME]
|
||||
[--os-user-domain-id OS_USER_DOMAIN_ID]
|
||||
[--os-user-domain-name OS_USER_DOMAIN_NAME]
|
||||
[--os-password OS_PASSWORD] [--aodh-endpoint <endpoint>]
|
||||
|
||||
.. _aodh_command_options:
|
||||
|
||||
aodh optional arguments
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
``--version``
|
||||
show program's version number and exit
|
||||
|
||||
``-v, --verbose``
|
||||
Increase verbosity of output. Can be repeated.
|
||||
|
||||
``-q, --quiet``
|
||||
Suppress output except warnings and errors.
|
||||
|
||||
``--log-file LOG_FILE``
|
||||
Specify a file to log output. Disabled by default.
|
||||
|
||||
``-h, --help``
|
||||
Show help message and exit.
|
||||
|
||||
``--debug``
|
||||
Show tracebacks on errors.
|
||||
|
||||
``--os-region-name <auth-region-name>``
|
||||
Authentication region name (Env: OS_REGION_NAME)
|
||||
|
||||
``--os-interface <interface>``
|
||||
Select an interface type. Valid interface types:
|
||||
[admin, public, internal]. (Env: OS_INTERFACE)
|
||||
|
||||
``--aodh-api-version AODH_API_VERSION``
|
||||
Defaults to ``env[AODH_API_VERSION]`` or 2.
|
||||
|
||||
``--os-auth-type <name>, --os-auth-plugin <name>``
|
||||
Authentication type to use
|
||||
|
||||
``--aodh-endpoint <endpoint>``
|
||||
Aodh endpoint (Env: AODH_ENDPOINT)
|
||||
|
||||
.. _aodh_alarm_create:
|
||||
|
||||
aodh alarm create
|
||||
-----------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: aodh alarm create [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>] [--print-empty]
|
||||
[--noindent] [--prefix PREFIX] --name <NAME> -t
|
||||
<TYPE> [--project-id <PROJECT_ID>]
|
||||
[--user-id <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}] [--query <QUERY>]
|
||||
[--comparison-operator <OPERATOR>]
|
||||
[--evaluation-periods <EVAL_PERIODS>]
|
||||
[--threshold <THRESHOLD>] [--metric <METRIC>]
|
||||
[-m <METER NAME>] [--period <PERIOD>]
|
||||
[--statistic <STATISTIC>] [--event-type <EVENT_TYPE>]
|
||||
[--granularity <GRANULARITY>]
|
||||
[--aggregation-method <AGGR_METHOD>]
|
||||
[--resource-type <RESOURCE_TYPE>]
|
||||
[--resource-id <RESOURCE_ID>] [--metrics <METRICS>]
|
||||
[--composite-rule <COMPOSITE_RULE>]
|
||||
|
||||
Create an alarm
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--name <NAME>``
|
||||
Name of the alarm
|
||||
|
||||
``-t <TYPE>, --type <TYPE>``
|
||||
Type of alarm, should be one of: threshold, event,
|
||||
composite, gnocchi_resources_threshold,
|
||||
gnocchi_aggregation_by_metrics_threshold,
|
||||
gnocchi_aggregation_by_resources_threshold.
|
||||
|
||||
``--project-id <PROJECT_ID>``
|
||||
Project to associate with alarm (configurable by admin
|
||||
users only)
|
||||
|
||||
``--user-id <USER_ID>``
|
||||
User to associate with alarm (configurable by admin
|
||||
users only)
|
||||
|
||||
``--description <DESCRIPTION>``
|
||||
Free text description of the alarm
|
||||
|
||||
``--state <STATE>``
|
||||
State of the alarm, one of: ['ok', 'alarm',
|
||||
'insufficient data']
|
||||
|
||||
``--severity <SEVERITY>``
|
||||
Severity of the alarm, one of: ['low', 'moderate',
|
||||
'critical']
|
||||
|
||||
``--enabled {True|False}``
|
||||
True if alarm evaluation is enabled
|
||||
|
||||
``--alarm-action <Webhook URL>``
|
||||
URL to invoke when state transitions to alarm. May be
|
||||
used multiple times
|
||||
|
||||
``--ok-action <Webhook URL>``
|
||||
URL to invoke when state transitions to OK. May be
|
||||
used multiple times
|
||||
|
||||
``--insufficient-data-action <Webhook URL>``
|
||||
URL to invoke when state transitions to insufficient
|
||||
data. May be used multiple times
|
||||
|
||||
``--time-constraint <Time Constraint>``
|
||||
Only evaluate the alarm if the time at evaluation is
|
||||
within this time constraint. Start point(s) of the
|
||||
constraint are specified with a cron expression,
|
||||
whereas its duration is given in seconds. Can be
|
||||
specified multiple times for multiple time
|
||||
constraints, format is: name=<CONSTRAINT_NAME>;start=<
|
||||
CRON>;duration=<SECONDS>;[description=<DESCRIPTION>;[t
|
||||
imezone=<IANA Timezone>]]
|
||||
|
||||
``--repeat-actions {True|False}``
|
||||
True if actions should be repeatedly notified while
|
||||
alarm remains in target state
|
||||
|
||||
.. _aodh_alarm_delete:
|
||||
|
||||
aodh alarm delete
|
||||
-----------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: aodh alarm delete [-h] [--name <NAME>] [<ALARM ID or NAME>]
|
||||
|
||||
Delete an alarm
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<ALARM ID or NAME>``
|
||||
ID or name of an alarm.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--name <NAME>``
|
||||
Name of the alarm
|
||||
|
||||
.. _aodh_alarm_list:
|
||||
|
||||
aodh alarm list
|
||||
---------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: aodh alarm list [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN]
|
||||
[--max-width <integer>] [--print-empty] [--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
[--query QUERY | --filter <KEY1=VALUE1;KEY2=VALUE2...>]
|
||||
[--limit <LIMIT>] [--marker <MARKER>]
|
||||
[--sort <SORT_KEY:SORT_DIR>]
|
||||
|
||||
List alarms
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--query QUERY``
|
||||
Rich query supported by aodh, e.g. project_id!=my-id
|
||||
user_id=foo or user_id=bar
|
||||
|
||||
``--filter <KEY1=VALUE1;KEY2=VALUE2...>``
|
||||
Filter parameters to apply on returned alarms.
|
||||
|
||||
``--limit <LIMIT>``
|
||||
Number of resources to return (Default is server
|
||||
default)
|
||||
|
||||
``--marker <MARKER>``
|
||||
Last item of the previous listing. Return the next
|
||||
results after this value,the supported marker is
|
||||
alarm_id.
|
||||
|
||||
``--sort <SORT_KEY:SORT_DIR>``
|
||||
Sort of resource attribute, e.g. name:asc
|
||||
|
||||
.. _aodh_alarm_show:
|
||||
|
||||
aodh alarm show
|
||||
---------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: aodh alarm show [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>] [--print-empty]
|
||||
[--noindent] [--prefix PREFIX] [--name <NAME>]
|
||||
[<ALARM ID or NAME>]
|
||||
|
||||
Show an alarm
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<ALARM ID or NAME>``
|
||||
ID or name of an alarm.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--name <NAME>``
|
||||
Name of the alarm
|
||||
|
||||
.. _aodh_alarm_state_get:
|
||||
|
||||
aodh alarm state get
|
||||
--------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: aodh alarm state get [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
[--name <NAME>]
|
||||
[<ALARM ID or NAME>]
|
||||
|
||||
Get state of an alarm
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<ALARM ID or NAME>``
|
||||
ID or name of an alarm.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--name <NAME>``
|
||||
Name of the alarm
|
||||
|
||||
.. _aodh_alarm_state_set:
|
||||
|
||||
aodh alarm state set
|
||||
--------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: aodh alarm state set [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
[--name <NAME>] --state <STATE>
|
||||
[<ALARM ID or NAME>]
|
||||
|
||||
Set state of an alarm
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<ALARM ID or NAME>``
|
||||
ID or name of an alarm.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--name <NAME>``
|
||||
Name of the alarm
|
||||
|
||||
``--state <STATE>``
|
||||
State of the alarm, one of: ['ok', 'alarm',
|
||||
'insufficient data']
|
||||
|
||||
.. _aodh_alarm_update:
|
||||
|
||||
aodh alarm update
|
||||
-----------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: aodh alarm update [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>] [--print-empty]
|
||||
[--noindent] [--prefix PREFIX] [--name <NAME>]
|
||||
[-t <TYPE>] [--project-id <PROJECT_ID>]
|
||||
[--user-id <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}] [--query <QUERY>]
|
||||
[--comparison-operator <OPERATOR>]
|
||||
[--evaluation-periods <EVAL_PERIODS>]
|
||||
[--threshold <THRESHOLD>] [--metric <METRIC>]
|
||||
[-m <METER NAME>] [--period <PERIOD>]
|
||||
[--statistic <STATISTIC>] [--event-type <EVENT_TYPE>]
|
||||
[--granularity <GRANULARITY>]
|
||||
[--aggregation-method <AGGR_METHOD>]
|
||||
[--resource-type <RESOURCE_TYPE>]
|
||||
[--resource-id <RESOURCE_ID>] [--metrics <METRICS>]
|
||||
[--composite-rule <COMPOSITE_RULE>]
|
||||
[<ALARM ID or NAME>]
|
||||
|
||||
Update an alarm
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<ALARM ID or NAME>``
|
||||
ID or name of an alarm.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--name <NAME>``
|
||||
Name of the alarm
|
||||
|
||||
``-t <TYPE>, --type <TYPE>``
|
||||
Type of alarm, should be one of: threshold, event,
|
||||
composite, gnocchi_resources_threshold,
|
||||
gnocchi_aggregation_by_metrics_threshold,
|
||||
gnocchi_aggregation_by_resources_threshold.
|
||||
|
||||
``--project-id <PROJECT_ID>``
|
||||
Project to associate with alarm (configurable by admin
|
||||
users only)
|
||||
|
||||
``--user-id <USER_ID>``
|
||||
User to associate with alarm (configurable by admin
|
||||
users only)
|
||||
|
||||
``--description <DESCRIPTION>``
|
||||
Free text description of the alarm
|
||||
|
||||
``--state <STATE>``
|
||||
State of the alarm, one of: ['ok', 'alarm',
|
||||
'insufficient data']
|
||||
|
||||
``--severity <SEVERITY>``
|
||||
Severity of the alarm, one of: ['low', 'moderate',
|
||||
'critical']
|
||||
|
||||
``--enabled {True|False}``
|
||||
True if alarm evaluation is enabled
|
||||
|
||||
``--alarm-action <Webhook URL>``
|
||||
URL to invoke when state transitions to alarm. May be
|
||||
used multiple times
|
||||
|
||||
``--ok-action <Webhook URL>``
|
||||
URL to invoke when state transitions to OK. May be
|
||||
used multiple times
|
||||
|
||||
``--insufficient-data-action <Webhook URL>``
|
||||
URL to invoke when state transitions to insufficient
|
||||
data. May be used multiple times
|
||||
|
||||
``--time-constraint <Time Constraint>``
|
||||
Only evaluate the alarm if the time at evaluation is
|
||||
within this time constraint. Start point(s) of the
|
||||
constraint are specified with a cron expression,
|
||||
whereas its duration is given in seconds. Can be
|
||||
specified multiple times for multiple time
|
||||
constraints, format is: name=<CONSTRAINT_NAME>;start=<
|
||||
CRON>;duration=<SECONDS>;[description=<DESCRIPTION>;[t
|
||||
imezone=<IANA Timezone>]]
|
||||
|
||||
``--repeat-actions {True|False}``
|
||||
True if actions should be repeatedly notified while
|
||||
alarm remains in target state
|
||||
|
||||
.. _aodh_alarm-history_search:
|
||||
|
||||
aodh alarm-history search
|
||||
-------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: aodh alarm-history search [-h] [-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
[--query QUERY]
|
||||
|
||||
Show history for all alarms based on query
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--query QUERY``
|
||||
Rich query supported by aodh, e.g. project_id!=my-id
|
||||
user_id=foo or user_id=bar
|
||||
|
||||
.. _aodh_alarm-history_show:
|
||||
|
||||
aodh alarm-history show
|
||||
-----------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: aodh alarm-history show [-h] [-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
[--limit <LIMIT>] [--marker <MARKER>]
|
||||
[--sort <SORT_KEY:SORT_DIR>]
|
||||
alarm_id
|
||||
|
||||
Show history for an alarm
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``alarm_id``
|
||||
ID of an alarm
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--limit <LIMIT>``
|
||||
Number of resources to return (Default is server
|
||||
default)
|
||||
|
||||
``--marker <MARKER>``
|
||||
Last item of the previous listing. Return the next
|
||||
results after this value,the supported marker is
|
||||
event_id.
|
||||
|
||||
``--sort <SORT_KEY:SORT_DIR>``
|
||||
Sort of resource attribute. e.g. timestamp:desc
|
||||
|
||||
.. _aodh_capabilities_list:
|
||||
|
||||
aodh capabilities list
|
||||
----------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: aodh capabilities list [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
|
||||
List capabilities of alarming service
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
@ -1,822 +0,0 @@
|
||||
.. ###################################################
|
||||
.. ## WARNING ######################################
|
||||
.. ############## WARNING ##########################
|
||||
.. ########################## WARNING ##############
|
||||
.. ###################################### WARNING ##
|
||||
.. ###################################################
|
||||
.. ###################################################
|
||||
.. ##
|
||||
.. This file is tool-generated. Do not edit manually.
|
||||
.. http://docs.openstack.org/contributor-guide/
|
||||
.. doc-tools/cli-reference.html
|
||||
.. ##
|
||||
.. ## WARNING ######################################
|
||||
.. ############## WARNING ##########################
|
||||
.. ########################## WARNING ##############
|
||||
.. ###################################### WARNING ##
|
||||
.. ###################################################
|
||||
|
||||
==================================================
|
||||
Key Manager service (barbican) command-line client
|
||||
==================================================
|
||||
|
||||
The barbican client is the command-line interface (CLI) for
|
||||
the Key Manager service (barbican) API and its extensions.
|
||||
|
||||
This chapter documents :command:`barbican` version ``4.3.0``.
|
||||
|
||||
For help on a specific :command:`barbican` command, enter:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ barbican help COMMAND
|
||||
|
||||
.. _barbican_command_usage:
|
||||
|
||||
barbican usage
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: barbican [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]
|
||||
[--no-auth] [--os-identity-api-version <identity-api-version>]
|
||||
[--os-auth-url <auth-url>] [--os-username <auth-user-name>]
|
||||
[--os-user-id <auth-user-id>] [--os-password <auth-password>]
|
||||
[--os-user-domain-id <auth-user-domain-id>]
|
||||
[--os-user-domain-name <auth-user-domain-name>]
|
||||
[--os-tenant-name <auth-tenant-name>]
|
||||
[--os-tenant-id <tenant-id>]
|
||||
[--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-token <auth-token>] [--endpoint <barbican-url>]
|
||||
[--interface <barbican-interface>]
|
||||
[--service-type <barbican-service-type>]
|
||||
[--service-name <barbican-service-name>]
|
||||
[--region-name <barbican-region-name>]
|
||||
[--barbican-api-version <barbican-api-version>] [--insecure]
|
||||
[--os-cacert <ca-certificate>] [--os-cert <certificate>]
|
||||
[--os-key <key>] [--timeout <seconds>]
|
||||
|
||||
.. _barbican_command_options:
|
||||
|
||||
barbican optional arguments
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
``--version``
|
||||
show program's version number and exit
|
||||
|
||||
``-v, --verbose``
|
||||
Increase verbosity of output. Can be repeated.
|
||||
|
||||
``-q, --quiet``
|
||||
Suppress output except warnings and errors.
|
||||
|
||||
``--log-file LOG_FILE``
|
||||
Specify a file to log output. Disabled by default.
|
||||
|
||||
``-h, --help``
|
||||
Show help message and exit.
|
||||
|
||||
``--debug``
|
||||
Show tracebacks on errors.
|
||||
|
||||
``--no-auth, -N``
|
||||
Do not use authentication.
|
||||
|
||||
``--os-identity-api-version <identity-api-version>``
|
||||
Specify Identity API version to use. Defaults to
|
||||
``env[OS_IDENTITY_API_VERSION]`` or 3.
|
||||
|
||||
``--os-auth-url <auth-url>, -A <auth-url>``
|
||||
Defaults to ``env[OS_AUTH_URL]``.
|
||||
|
||||
``--os-username <auth-user-name>, -U <auth-user-name>``
|
||||
Defaults to ``env[OS_USERNAME]``.
|
||||
|
||||
``--os-user-id <auth-user-id>``
|
||||
Defaults to ``env[OS_USER_ID]``.
|
||||
|
||||
``--os-password <auth-password>, -P <auth-password>``
|
||||
Defaults to ``env[OS_PASSWORD]``.
|
||||
|
||||
``--os-user-domain-id <auth-user-domain-id>``
|
||||
Defaults to ``env[OS_USER_DOMAIN_ID]``.
|
||||
|
||||
``--os-user-domain-name <auth-user-domain-name>``
|
||||
Defaults to ``env[OS_USER_DOMAIN_NAME]``.
|
||||
|
||||
``--os-tenant-name <auth-tenant-name>, -T <auth-tenant-name>``
|
||||
Defaults to ``env[OS_TENANT_NAME]``.
|
||||
|
||||
``--os-tenant-id <tenant-id>, -I <tenant-id>``
|
||||
Defaults to ``env[OS_TENANT_ID]``.
|
||||
|
||||
``--os-project-id <auth-project-id>``
|
||||
Another way to specify tenant ID. This option is
|
||||
mutually exclusive with --os-tenant-id. Defaults to
|
||||
``env[OS_PROJECT_ID]``.
|
||||
|
||||
``--os-project-name <auth-project-name>``
|
||||
Another way to specify tenant name. This option is
|
||||
mutually exclusive with --os-tenant-name. Defaults to
|
||||
``env[OS_PROJECT_NAME]``.
|
||||
|
||||
``--os-project-domain-id <auth-project-domain-id>``
|
||||
Defaults to ``env[OS_PROJECT_DOMAIN_ID]``.
|
||||
|
||||
``--os-project-domain-name <auth-project-domain-name>``
|
||||
Defaults to ``env[OS_PROJECT_DOMAIN_NAME]``.
|
||||
|
||||
``--os-auth-token <auth-token>``
|
||||
Defaults to ``env[OS_AUTH_TOKEN]``.
|
||||
|
||||
``--endpoint <barbican-url>, -E <barbican-url>``
|
||||
Defaults to ``env[BARBICAN_ENDPOINT]``.
|
||||
|
||||
``--interface <barbican-interface>``
|
||||
Defaults to ``env[BARBICAN_INTERFACE]``.
|
||||
|
||||
``--service-type <barbican-service-type>``
|
||||
Defaults to ``env[BARBICAN_SERVICE_TYPE]``.
|
||||
|
||||
``--service-name <barbican-service-name>``
|
||||
Defaults to ``env[BARBICAN_SERVICE_NAME]``.
|
||||
|
||||
``--region-name <barbican-region-name>``
|
||||
Defaults to ``env[BARBICAN_REGION_NAME]``.
|
||||
|
||||
``--barbican-api-version <barbican-api-version>``
|
||||
Defaults to ``env[BARBICAN_API_VERSION]``.
|
||||
|
||||
.. _barbican_acl_delete:
|
||||
|
||||
barbican acl delete
|
||||
-------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: barbican acl delete [-h] URI
|
||||
|
||||
Delete ACLs for a secret or container as identified by its href.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``URI``
|
||||
The URI reference for the secret or container.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _barbican_acl_get:
|
||||
|
||||
barbican acl get
|
||||
----------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: barbican acl get [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN]
|
||||
[--max-width <integer>] [--print-empty] [--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
URI
|
||||
|
||||
Retrieve ACLs for a secret or container by providing its href.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``URI``
|
||||
The URI reference for the secret or container.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _barbican_acl_submit:
|
||||
|
||||
barbican acl submit
|
||||
-------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: barbican acl submit [-h] [-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>] [--print-empty]
|
||||
[--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
[--user [USERS]]
|
||||
[--project-access | --no-project-access]
|
||||
[--operation-type {read}]
|
||||
URI
|
||||
|
||||
Submit ACL on a secret or container as identified by its href.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``URI``
|
||||
The URI reference for the secret or container.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--user [USERS], -u [USERS]``
|
||||
Keystone userid(s) for ACL.
|
||||
|
||||
``--project-access``
|
||||
Flag to enable project access behavior.
|
||||
|
||||
``--no-project-access``
|
||||
Flag to disable project access behavior.
|
||||
|
||||
``--operation-type {read}, -o {read}``
|
||||
Type of Barbican operation ACL is set for
|
||||
|
||||
.. _barbican_acl_user_add:
|
||||
|
||||
barbican acl user add
|
||||
---------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: barbican acl user add [-h] [-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
[--user [USERS]]
|
||||
[--project-access | --no-project-access]
|
||||
[--operation-type {read}]
|
||||
URI
|
||||
|
||||
Add ACL users to a secret or container as identified by its href.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``URI``
|
||||
The URI reference for the secret or container.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--user [USERS], -u [USERS]``
|
||||
Keystone userid(s) for ACL.
|
||||
|
||||
``--project-access``
|
||||
Flag to enable project access behavior.
|
||||
|
||||
``--no-project-access``
|
||||
Flag to disable project access behavior.
|
||||
|
||||
``--operation-type {read}, -o {read}``
|
||||
Type of Barbican operation ACL is set for
|
||||
|
||||
.. _barbican_acl_user_remove:
|
||||
|
||||
barbican acl user remove
|
||||
------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: barbican acl user remove [-h] [-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
[--user [USERS]]
|
||||
[--project-access | --no-project-access]
|
||||
[--operation-type {read}]
|
||||
URI
|
||||
|
||||
Remove ACL users from a secret or container as identified by its href.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``URI``
|
||||
The URI reference for the secret or container.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--user [USERS], -u [USERS]``
|
||||
Keystone userid(s) for ACL.
|
||||
|
||||
``--project-access``
|
||||
Flag to enable project access behavior.
|
||||
|
||||
``--no-project-access``
|
||||
Flag to disable project access behavior.
|
||||
|
||||
``--operation-type {read}, -o {read}``
|
||||
Type of Barbican operation ACL is set for
|
||||
|
||||
.. _barbican_ca_get:
|
||||
|
||||
barbican ca get
|
||||
---------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: barbican ca get [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>] [--print-empty]
|
||||
[--noindent] [--prefix PREFIX]
|
||||
URI
|
||||
|
||||
Retrieve a CA by providing its URI.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``URI``
|
||||
The URI reference for the CA.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _barbican_ca_list:
|
||||
|
||||
barbican ca list
|
||||
----------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: barbican ca list [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN]
|
||||
[--max-width <integer>] [--print-empty] [--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
[--limit LIMIT] [--offset OFFSET] [--name NAME]
|
||||
|
||||
List CAs.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--limit LIMIT, -l LIMIT``
|
||||
specify the limit to the number of items to list per
|
||||
page (default: 10; maximum: 100)
|
||||
|
||||
``--offset OFFSET, -o OFFSET``
|
||||
specify the page offset (default: 0)
|
||||
|
||||
``--name NAME, -n NAME``
|
||||
specify the ca name (default: None)
|
||||
|
||||
.. _barbican_secret_container_create:
|
||||
|
||||
barbican secret container create
|
||||
--------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: barbican secret container create [-h]
|
||||
[-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--prefix PREFIX] [--name NAME]
|
||||
[--type TYPE] [--secret SECRET]
|
||||
|
||||
Store a container in Barbican.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--name NAME, -n NAME``
|
||||
a human-friendly name.
|
||||
|
||||
``--type TYPE``
|
||||
type of container to create (default: generic).
|
||||
|
||||
``--secret SECRET, -s SECRET``
|
||||
one secret to store in a container (can be set
|
||||
multiple times). Example: --secret
|
||||
"private_key=https://url.test/v1/secrets/1-2-3-4"
|
||||
|
||||
.. _barbican_secret_container_delete:
|
||||
|
||||
barbican secret container delete
|
||||
--------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: barbican secret container delete [-h] URI
|
||||
|
||||
Delete a container by providing its href.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``URI``
|
||||
The URI reference for the container
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _barbican_secret_container_get:
|
||||
|
||||
barbican secret container get
|
||||
-----------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: barbican secret container get [-h]
|
||||
[-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--prefix PREFIX]
|
||||
URI
|
||||
|
||||
Retrieve a container by providing its URI.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``URI``
|
||||
The URI reference for the container.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _barbican_secret_container_list:
|
||||
|
||||
barbican secret container list
|
||||
------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: barbican secret container list [-h]
|
||||
[-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
[--limit LIMIT] [--offset OFFSET]
|
||||
[--name NAME] [--type TYPE]
|
||||
|
||||
List containers.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--limit LIMIT, -l LIMIT``
|
||||
specify the limit to the number of items to list per
|
||||
page (default: 10; maximum: 100)
|
||||
|
||||
``--offset OFFSET, -o OFFSET``
|
||||
specify the page offset (default: 0)
|
||||
|
||||
``--name NAME, -n NAME``
|
||||
specify the container name (default: None)
|
||||
|
||||
``--type TYPE, -t TYPE``
|
||||
specify the type filter for the list (default: None).
|
||||
|
||||
.. _barbican_secret_delete:
|
||||
|
||||
barbican secret delete
|
||||
----------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: barbican secret delete [-h] URI
|
||||
|
||||
Delete a secret by providing its URI.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``URI``
|
||||
The URI reference for the secret
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _barbican_secret_get:
|
||||
|
||||
barbican secret get
|
||||
-------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: barbican secret get [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>] [--print-empty]
|
||||
[--noindent] [--prefix PREFIX] [--decrypt]
|
||||
[--payload]
|
||||
[--payload_content_type PAYLOAD_CONTENT_TYPE]
|
||||
URI
|
||||
|
||||
Retrieve a secret by providing its URI.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``URI``
|
||||
The URI reference for the secret.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--decrypt, -d``
|
||||
if specified, retrieve the unencrypted secret data;
|
||||
the data type can be specified with
|
||||
--payload_content_type.
|
||||
|
||||
``--payload, -p``
|
||||
if specified, retrieve the unencrypted secret data;
|
||||
the data type can be specified with
|
||||
--payload_content_type. If the user wishes to only
|
||||
retrieve the value of the payload they must add "-f
|
||||
value" to format returning only the value of the
|
||||
payload
|
||||
|
||||
``--payload_content_type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE``
|
||||
the content type of the decrypted secret (default:
|
||||
text/plain).
|
||||
|
||||
.. _barbican_secret_list:
|
||||
|
||||
barbican secret list
|
||||
--------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: barbican secret list [-h] [-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
[--limit LIMIT] [--offset OFFSET] [--name NAME]
|
||||
[--algorithm ALGORITHM] [--bit-length BIT_LENGTH]
|
||||
[--mode MODE]
|
||||
|
||||
List secrets.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--limit LIMIT, -l LIMIT``
|
||||
specify the limit to the number of items to list per
|
||||
page (default: 10; maximum: 100)
|
||||
|
||||
``--offset OFFSET, -o OFFSET``
|
||||
specify the page offset (default: 0)
|
||||
|
||||
``--name NAME, -n NAME``
|
||||
specify the secret name (default: None)
|
||||
|
||||
``--algorithm ALGORITHM, -a ALGORITHM``
|
||||
the algorithm filter for the list(default: None).
|
||||
|
||||
``--bit-length BIT_LENGTH, -b BIT_LENGTH``
|
||||
the bit length filter for the list (default: 0).
|
||||
|
||||
``--mode MODE, -m MODE``
|
||||
the algorithm mode filter for the list (default:
|
||||
None).
|
||||
|
||||
.. _barbican_secret_order_create:
|
||||
|
||||
barbican secret order create
|
||||
----------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: barbican secret order create [-h]
|
||||
[-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--prefix PREFIX] [--name NAME]
|
||||
[--algorithm ALGORITHM]
|
||||
[--bit-length BIT_LENGTH] [--mode MODE]
|
||||
[--payload-content-type PAYLOAD_CONTENT_TYPE]
|
||||
[--expiration EXPIRATION]
|
||||
[--request-type REQUEST_TYPE]
|
||||
[--subject-dn SUBJECT_DN]
|
||||
[--source-container-ref SOURCE_CONTAINER_REF]
|
||||
[--ca-id CA_ID] [--profile PROFILE]
|
||||
[--request-file REQUEST_FILE]
|
||||
type
|
||||
|
||||
Create a new order.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``type``
|
||||
the type of the order (key, asymmetric, certificate)
|
||||
to create.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--name NAME, -n NAME``
|
||||
a human-friendly name.
|
||||
|
||||
``--algorithm ALGORITHM, -a ALGORITHM``
|
||||
the algorithm to be used with the requested key
|
||||
(default: aes).
|
||||
|
||||
``--bit-length BIT_LENGTH, -b BIT_LENGTH``
|
||||
the bit length of the requested secret key (default:
|
||||
256).
|
||||
|
||||
``--mode MODE, -m MODE``
|
||||
the algorithm mode to be used with the requested key
|
||||
(default: cbc).
|
||||
|
||||
``--payload-content-type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE``
|
||||
the type/format of the secret to be generated
|
||||
(default: application/octet-stream).
|
||||
|
||||
``--expiration EXPIRATION, -x EXPIRATION``
|
||||
the expiration time for the secret in ISO 8601 format.
|
||||
|
||||
``--request-type REQUEST_TYPE``
|
||||
the type of the certificate request.
|
||||
|
||||
``--subject-dn SUBJECT_DN``
|
||||
the subject of the certificate.
|
||||
|
||||
``--source-container-ref SOURCE_CONTAINER_REF``
|
||||
the source of the certificate when using stored-key
|
||||
requests.
|
||||
|
||||
``--ca-id CA_ID``
|
||||
the identifier of the CA to use for the certificate
|
||||
request.
|
||||
|
||||
``--profile PROFILE``
|
||||
the profile of certificate to use.
|
||||
|
||||
``--request-file REQUEST_FILE``
|
||||
the file containing the CSR.
|
||||
|
||||
.. _barbican_secret_order_delete:
|
||||
|
||||
barbican secret order delete
|
||||
----------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: barbican secret order delete [-h] URI
|
||||
|
||||
Delete an order by providing its href.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``URI``
|
||||
The URI reference for the order
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _barbican_secret_order_get:
|
||||
|
||||
barbican secret order get
|
||||
-------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: barbican secret order get [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--prefix PREFIX]
|
||||
URI
|
||||
|
||||
Retrieve an order by providing its URI.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``URI``
|
||||
The URI reference order.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _barbican_secret_order_list:
|
||||
|
||||
barbican secret order list
|
||||
--------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: barbican secret order list [-h] [-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
[--limit LIMIT] [--offset OFFSET]
|
||||
|
||||
List orders.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--limit LIMIT, -l LIMIT``
|
||||
specify the limit to the number of items to list per
|
||||
page (default: 10; maximum: 100)
|
||||
|
||||
``--offset OFFSET, -o OFFSET``
|
||||
specify the page offset (default: 0)
|
||||
|
||||
.. _barbican_secret_store:
|
||||
|
||||
barbican secret store
|
||||
---------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: barbican secret store [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
[--name NAME] [--payload PAYLOAD]
|
||||
[--secret-type SECRET_TYPE]
|
||||
[--payload-content-type PAYLOAD_CONTENT_TYPE]
|
||||
[--payload-content-encoding PAYLOAD_CONTENT_ENCODING]
|
||||
[--algorithm ALGORITHM] [--bit-length BIT_LENGTH]
|
||||
[--mode MODE] [--expiration EXPIRATION]
|
||||
|
||||
Store a secret in Barbican.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--name NAME, -n NAME``
|
||||
a human-friendly name.
|
||||
|
||||
``--payload PAYLOAD, -p PAYLOAD``
|
||||
the unencrypted secret; if provided, you must also
|
||||
provide a payload_content_type
|
||||
|
||||
``--secret-type SECRET_TYPE, -s SECRET_TYPE``
|
||||
the secret type; must be one of symmetric, public,
|
||||
private, certificate, passphrase, opaque (default)
|
||||
|
||||
``--payload-content-type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE``
|
||||
the type/format of the provided secret data;
|
||||
"text/plain" is assumed to be UTF-8; required when
|
||||
--payload is supplied.
|
||||
|
||||
``--payload-content-encoding PAYLOAD_CONTENT_ENCODING, -e PAYLOAD_CONTENT_ENCODING``
|
||||
required if --payload-content-type is "application
|
||||
/octet-stream".
|
||||
|
||||
``--algorithm ALGORITHM, -a ALGORITHM``
|
||||
the algorithm (default: aes).
|
||||
|
||||
``--bit-length BIT_LENGTH, -b BIT_LENGTH``
|
||||
the bit length (default: 256).
|
||||
|
||||
``--mode MODE, -m MODE``
|
||||
the algorithm mode; used only for reference (default:
|
||||
cbc)
|
||||
|
||||
``--expiration EXPIRATION, -x EXPIRATION``
|
||||
the expiration time for the secret in ISO 8601 format.
|
||||
|
||||
.. _barbican_secret_update:
|
||||
|
||||
barbican secret update
|
||||
----------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: barbican secret update [-h] URI payload
|
||||
|
||||
Update a secret with no payload in Barbican.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``URI``
|
||||
The URI reference for the secret.
|
||||
|
||||
``payload``
|
||||
the unencrypted secret
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -1,9 +0,0 @@
|
||||
===========================================
|
||||
Compute service (nova) command-line clients
|
||||
===========================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
nova
|
||||
nova-manage
|
||||
@ -1,299 +0,0 @@
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
# implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
# This file is execfile()d with the current directory set to its
|
||||
# containing dir.
|
||||
#
|
||||
# Note that not all possible configuration values are present in this
|
||||
# autogenerated file.
|
||||
#
|
||||
# All configuration values have a default; values that are commented out
|
||||
# serve to show the default.
|
||||
|
||||
import os
|
||||
import sys
|
||||
|
||||
sys.path.append(os.path.dirname(__file__))
|
||||
|
||||
# Increase the maximum depth of the Python interpreter stack to solve the
|
||||
# "RuntimeError: maximum recursion depth exceeded in cmp" issue.
|
||||
sys.setrecursionlimit(4000)
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
# needs_sphinx = '1.0'
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = ['openstackdocstheme']
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
# templates_path = ['_templates']
|
||||
|
||||
# The suffix of source filenames.
|
||||
source_suffix = '.rst'
|
||||
|
||||
# The encoding of source files.
|
||||
# source_encoding = 'utf-8-sig'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
repository_name = "openstack/openstack-manuals"
|
||||
bug_project = 'openstack-manuals'
|
||||
project = u'Command-Line Interface Reference'
|
||||
bug_tag = u'cli-reference'
|
||||
copyright = u'2015-2017, OpenStack contributors'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = '15.0'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '15.0.0'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
# language = None
|
||||
|
||||
# There are two options for replacing |today|: either, you set today to some
|
||||
# non-false value, then it is used:
|
||||
# today = ''
|
||||
# Else, today_fmt is used as the format for a strftime call.
|
||||
# today_fmt = '%B %d, %Y'
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
exclude_patterns = []
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all
|
||||
# documents.
|
||||
# default_role = None
|
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||
# add_function_parentheses = True
|
||||
|
||||
# If true, the current module name will be prepended to all description
|
||||
# unit titles (such as .. function::).
|
||||
# add_module_names = True
|
||||
|
||||
# If true, sectionauthor and moduleauthor directives will be shown in the
|
||||
# output. They are ignored by default.
|
||||
# show_authors = False
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
|
||||
# A list of ignored prefixes for module index sorting.
|
||||
# modindex_common_prefix = []
|
||||
|
||||
# If true, keep warnings as "system message" paragraphs in the built documents.
|
||||
# keep_warnings = False
|
||||
|
||||
|
||||
# -- Options for HTML output ----------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
html_theme = 'openstackdocs'
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
# html_theme_options = {}
|
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
# html_theme_path = [openstackdocstheme.get_html_theme_path()]
|
||||
|
||||
# The name for this set of Sphinx documents. If None, it defaults to
|
||||
# "<project> v<release> documentation".
|
||||
# html_title = None
|
||||
|
||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||
# html_short_title = None
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top
|
||||
# of the sidebar.
|
||||
# html_logo = None
|
||||
|
||||
# The name of an image file (within the static path) to use as favicon of the
|
||||
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||
# pixels large.
|
||||
# html_favicon = None
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
# html_static_path = []
|
||||
|
||||
# Add any extra paths that contain custom files (such as robots.txt or
|
||||
# .htaccess) here, relative to this directory. These files are copied
|
||||
# directly to the root of the documentation.
|
||||
# html_extra_path = []
|
||||
|
||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||
# using the given strftime format.
|
||||
# So that we can enable "log-a-bug" links from each output HTML page, this
|
||||
# variable must be set to a format that includes year, month, day, hours and
|
||||
# minutes.
|
||||
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
# html_use_smartypants = True
|
||||
|
||||
# Custom sidebar templates, maps document names to template names.
|
||||
# html_sidebars = {}
|
||||
|
||||
# Additional templates that should be rendered to pages, maps page names to
|
||||
# template names.
|
||||
# html_additional_pages = {}
|
||||
|
||||
# If false, no module index is generated.
|
||||
# html_domain_indices = True
|
||||
|
||||
# If false, no index is generated.
|
||||
html_use_index = False
|
||||
|
||||
# If true, the index is split into individual pages for each letter.
|
||||
# html_split_index = False
|
||||
|
||||
# If true, links to the reST sources are added to the pages.
|
||||
html_show_sourcelink = False
|
||||
|
||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||
# html_show_sphinx = True
|
||||
|
||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||||
# html_show_copyright = True
|
||||
|
||||
# If true, an OpenSearch description file will be output, and all pages will
|
||||
# contain a <link> tag referring to it. The value of this option must be the
|
||||
# base URL from which the finished HTML is served.
|
||||
# html_use_opensearch = ''
|
||||
|
||||
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||||
# html_file_suffix = None
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'cli-reference'
|
||||
|
||||
# If true, publish source files
|
||||
html_copy_source = False
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes
|
||||
# to typographically correct entities. Default: True.
|
||||
html_use_smartypants = False
|
||||
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
|
||||
latex_engine = 'xelatex'
|
||||
|
||||
latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
# 'papersize': 'letterpaper',
|
||||
|
||||
# set font (TODO: different fonts for translated PDF document builds)
|
||||
'fontenc': '\\usepackage{fontspec}',
|
||||
'fontpkg': '''\
|
||||
\defaultfontfeatures{Scale=MatchLowercase}
|
||||
\setmainfont{Liberation Serif}
|
||||
\setsansfont{Liberation Sans}
|
||||
\setmonofont[SmallCapsFont={Liberation Mono}]{Liberation Mono}
|
||||
''',
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
# 'pointsize': '10pt',
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
# 'preamble': '',
|
||||
}
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
('index', 'CLIRef.tex', u'Command-Line Interface Reference',
|
||||
u'OpenStack contributors', 'manual'),
|
||||
]
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top of
|
||||
# the title page.
|
||||
# latex_logo = None
|
||||
|
||||
# For "manual" documents, if this is true, then toplevel headings are parts,
|
||||
# not chapters.
|
||||
# latex_use_parts = False
|
||||
|
||||
# If true, show page references after internal links.
|
||||
# latex_show_pagerefs = False
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
# latex_show_urls = False
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
# latex_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
# latex_domain_indices = True
|
||||
|
||||
|
||||
# -- Options for manual page output ---------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
('index', 'CLIRef', u'Command-Line Interface Reference',
|
||||
[u'OpenStack contributors'], 1)
|
||||
]
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
# man_show_urls = False
|
||||
|
||||
|
||||
# -- Options for Texinfo output -------------------------------------------
|
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples
|
||||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
('index', 'CLIRef', u'Command-Line Interface Reference',
|
||||
u'OpenStack contributors', 'CLIRef',
|
||||
'This guide documents the OpenStack command-line clients.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
# texinfo_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
# texinfo_domain_indices = True
|
||||
|
||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||
# texinfo_show_urls = 'footnote'
|
||||
|
||||
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
||||
# texinfo_no_detailmenu = False
|
||||
|
||||
# -- Options for Internationalization output ------------------------------
|
||||
locale_dirs = ['locale/']
|
||||
@ -1,9 +0,0 @@
|
||||
=============================================
|
||||
Database service (trove) command-line clients
|
||||
=============================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
trove
|
||||
trove-manage
|
||||
@ -1,958 +0,0 @@
|
||||
.. ###################################################
|
||||
.. ## WARNING ######################################
|
||||
.. ############## WARNING ##########################
|
||||
.. ########################## WARNING ##############
|
||||
.. ###################################### WARNING ##
|
||||
.. ###################################################
|
||||
.. ###################################################
|
||||
.. ##
|
||||
.. This file is tool-generated. Do not edit manually.
|
||||
.. http://docs.openstack.org/contributor-guide/
|
||||
.. doc-tools/cli-reference.html
|
||||
.. ##
|
||||
.. ## WARNING ######################################
|
||||
.. ############## WARNING ##########################
|
||||
.. ########################## WARNING ##############
|
||||
.. ###################################### WARNING ##
|
||||
.. ###################################################
|
||||
|
||||
===========================================
|
||||
DNS service (designate) command-line client
|
||||
===========================================
|
||||
|
||||
The designate client is the command-line interface (CLI) for
|
||||
the DNS service (designate) API and its extensions.
|
||||
|
||||
This chapter documents :command:`designate` version ``2.6.0``.
|
||||
|
||||
For help on a specific :command:`designate` command, enter:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ designate help COMMAND
|
||||
|
||||
.. _designate_command_usage:
|
||||
|
||||
designate usage
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]
|
||||
[--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-password OS_PASSWORD] [--os-tenant-name OS_TENANT_NAME]
|
||||
[--os-tenant-id OS_TENANT_ID]
|
||||
[--os-project-name OS_PROJECT_NAME]
|
||||
[--os-domain-name OS_DOMAIN_NAME]
|
||||
[--os-domain-id OS_DOMAIN_ID] [--os-project-id OS_PROJECT_ID]
|
||||
[--os-project-domain-id OS_PROJECT_DOMAIN_ID]
|
||||
[--os-project-domain-name OS_PROJECT_DOMAIN_NAME]
|
||||
[--os-auth-url OS_AUTH_URL] [--os-region-name OS_REGION_NAME]
|
||||
[--os-token OS_TOKEN] [--os-endpoint OS_ENDPOINT]
|
||||
[--os-endpoint-type OS_ENDPOINT_TYPE]
|
||||
[--os-service-type OS_SERVICE_TYPE] [--os-cacert OS_CACERT]
|
||||
[--insecure] [--all-tenants] [--edit-managed]
|
||||
|
||||
.. _designate_command_options:
|
||||
|
||||
designate optional arguments
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
``--version``
|
||||
show program's version number and exit
|
||||
|
||||
``-v, --verbose``
|
||||
Increase verbosity of output. Can be repeated.
|
||||
|
||||
``-q, --quiet``
|
||||
Suppress output except warnings and errors.
|
||||
|
||||
``--log-file LOG_FILE``
|
||||
Specify a file to log output. Disabled by default.
|
||||
|
||||
``-h, --help``
|
||||
Show help message and exit.
|
||||
|
||||
``--debug``
|
||||
Show tracebacks on errors.
|
||||
|
||||
``--os-username OS_USERNAME``
|
||||
Name used for authentication with the OpenStack
|
||||
Identity service. Defaults to ``env[OS_USERNAME]``.
|
||||
|
||||
``--os-user-id OS_USER_ID``
|
||||
User ID used for authentication with the OpenStack
|
||||
Identity service. Defaults to ``env[OS_USER_ID]``.
|
||||
|
||||
``--os-user-domain-id OS_USER_DOMAIN_ID``
|
||||
Defaults to ``env[OS_USER_DOMAIN_ID]``.
|
||||
|
||||
``--os-user-domain-name OS_USER_DOMAIN_NAME``
|
||||
Defaults to ``env[OS_USER_DOMAIN_NAME]``.
|
||||
|
||||
``--os-password OS_PASSWORD``
|
||||
Password used for authentication with the OpenStack
|
||||
Identity service. Defaults to ``env[OS_PASSWORD]``.
|
||||
|
||||
``--os-tenant-name OS_TENANT_NAME``
|
||||
Tenant to request authorization on. Defaults to
|
||||
``env[OS_TENANT_NAME]``.
|
||||
|
||||
``--os-tenant-id OS_TENANT_ID``
|
||||
Tenant to request authorization on. Defaults to
|
||||
``env[OS_TENANT_ID]``.
|
||||
|
||||
``--os-project-name OS_PROJECT_NAME``
|
||||
Project to request authorization on. Defaults to
|
||||
``env[OS_PROJECT_NAME]``.
|
||||
|
||||
``--os-domain-name OS_DOMAIN_NAME``
|
||||
Project to request authorization on. Defaults to
|
||||
``env[OS_DOMAIN_NAME]``.
|
||||
|
||||
``--os-domain-id OS_DOMAIN_ID``
|
||||
Defaults to ``env[OS_DOMAIN_ID]``.
|
||||
|
||||
``--os-project-id OS_PROJECT_ID``
|
||||
Project to request authorization on. Defaults to
|
||||
``env[OS_PROJECT_ID]``.
|
||||
|
||||
``--os-project-domain-id OS_PROJECT_DOMAIN_ID``
|
||||
Defaults to ``env[OS_PROJECT_DOMAIN_ID]``.
|
||||
|
||||
``--os-project-domain-name OS_PROJECT_DOMAIN_NAME``
|
||||
Defaults to ``env[OS_PROJECT_DOMAIN_NAME]``.
|
||||
|
||||
``--os-auth-url OS_AUTH_URL``
|
||||
Specify the Identity endpoint to use for
|
||||
authentication. Defaults to ``env[OS_AUTH_URL]``.
|
||||
|
||||
``--os-region-name OS_REGION_NAME``
|
||||
Specify the region to use. Defaults to
|
||||
``env[OS_REGION_NAME]``.
|
||||
|
||||
``--os-token OS_TOKEN``
|
||||
Specify an existing token to use instead of retrieving
|
||||
one via authentication (e.g. with username &
|
||||
password). Defaults to ``env[OS_SERVICE_TOKEN]``.
|
||||
|
||||
``--os-endpoint OS_ENDPOINT``
|
||||
Specify an endpoint to use instead of retrieving one
|
||||
from the service catalog (via authentication).
|
||||
Defaults to ``env[OS_DNS_ENDPOINT]``.
|
||||
|
||||
``--os-endpoint-type OS_ENDPOINT_TYPE``
|
||||
Defaults to ``env[OS_ENDPOINT_TYPE]``.
|
||||
|
||||
``--os-service-type OS_SERVICE_TYPE``
|
||||
Defaults to ``env[OS_DNS_SERVICE_TYPE]``, or 'dns'.
|
||||
|
||||
``--os-cacert OS_CACERT``
|
||||
CA certificate bundle file. Defaults to
|
||||
``env[OS_CACERT]``.
|
||||
|
||||
``--insecure``
|
||||
Explicitly allow 'insecure' SSL requests.
|
||||
|
||||
``--all-tenants``
|
||||
Allows to list all domains from all tenants.
|
||||
|
||||
``--edit-managed``
|
||||
Allows to edit records that are marked as managed.
|
||||
|
||||
.. _designate_diagnostics-ping:
|
||||
|
||||
designate diagnostics-ping
|
||||
--------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate diagnostics-ping [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--prefix PREFIX] --service SERVICE --host
|
||||
HOST
|
||||
|
||||
Ping a service on a given host
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--service SERVICE``
|
||||
Service name (e.g. central)
|
||||
|
||||
``--host HOST``
|
||||
Hostname
|
||||
|
||||
.. _designate_domain-create:
|
||||
|
||||
designate domain-create
|
||||
-----------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate domain-create [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
--name NAME --email EMAIL [--ttl TTL]
|
||||
[--description DESCRIPTION]
|
||||
|
||||
Create Domain
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--name NAME``
|
||||
Domain name.
|
||||
|
||||
``--email EMAIL``
|
||||
Domain email.
|
||||
|
||||
``--ttl TTL``
|
||||
Time to live (seconds).
|
||||
|
||||
``--description DESCRIPTION``
|
||||
Description.
|
||||
|
||||
.. _designate_domain-delete:
|
||||
|
||||
designate domain-delete
|
||||
-----------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate domain-delete [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
id
|
||||
|
||||
Delete Domain
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``id``
|
||||
Domain ID or name.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _designate_domain-get:
|
||||
|
||||
designate domain-get
|
||||
--------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate domain-get [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
id
|
||||
|
||||
Get Domain
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``id``
|
||||
Domain ID or name.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _designate_domain-list:
|
||||
|
||||
designate domain-list
|
||||
---------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate domain-list [-h] [-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
|
||||
List Domains
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _designate_domain-servers-list:
|
||||
|
||||
designate domain-servers-list
|
||||
-----------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate domain-servers-list [-h]
|
||||
[-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
id
|
||||
|
||||
List Domain Servers
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``id``
|
||||
Domain ID or name.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _designate_domain-update:
|
||||
|
||||
designate domain-update
|
||||
-----------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate domain-update [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
[--name NAME] [--email EMAIL] [--ttl TTL]
|
||||
[--description DESCRIPTION | --no-description]
|
||||
id
|
||||
|
||||
Update Domain
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``id``
|
||||
Domain ID or name.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--name NAME``
|
||||
Domain name.
|
||||
|
||||
``--email EMAIL``
|
||||
Domain email.
|
||||
|
||||
``--ttl TTL``
|
||||
Time to live (seconds).
|
||||
|
||||
``--description DESCRIPTION``
|
||||
Description.
|
||||
|
||||
``--no-description``
|
||||
|
||||
.. _designate_quota-get:
|
||||
|
||||
designate quota-get
|
||||
-------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate quota-get [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>] [--print-empty]
|
||||
[--noindent] [--prefix PREFIX]
|
||||
tenant_id
|
||||
|
||||
Get Quota
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``tenant_id``
|
||||
Tenant ID
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _designate_quota-reset:
|
||||
|
||||
designate quota-reset
|
||||
---------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate quota-reset [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
tenant_id
|
||||
|
||||
Reset Quota
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``tenant_id``
|
||||
Tenant ID.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _designate_quota-update:
|
||||
|
||||
designate quota-update
|
||||
----------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate quota-update [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
[--domains DOMAINS]
|
||||
[--domain-recordsets DOMAIN_RECORDSETS]
|
||||
[--recordset-records RECORDSET_RECORDS]
|
||||
[--domain-records DOMAIN_RECORDS]
|
||||
[--api-export-size API_EXPORT_SIZE]
|
||||
tenant_id
|
||||
|
||||
Update Quota
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``tenant_id``
|
||||
Tenant ID.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--domains DOMAINS``
|
||||
Allowed domains.
|
||||
|
||||
``--domain-recordsets DOMAIN_RECORDSETS``
|
||||
Allowed domain records.
|
||||
|
||||
``--recordset-records RECORDSET_RECORDS``
|
||||
Allowed recordset records.
|
||||
|
||||
``--domain-records DOMAIN_RECORDS``
|
||||
Allowed domain records.
|
||||
|
||||
``--api-export-size API_EXPORT_SIZE``
|
||||
Allowed zone export recordsets.
|
||||
|
||||
.. _designate_record-create:
|
||||
|
||||
designate record-create
|
||||
-----------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate record-create [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
--name NAME --type TYPE --data DATA [--ttl TTL]
|
||||
[--priority PRIORITY]
|
||||
[--description DESCRIPTION]
|
||||
domain_id
|
||||
|
||||
Create Record
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``domain_id``
|
||||
Domain ID or name.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--name NAME``
|
||||
Record (relative|absolute) name.
|
||||
|
||||
``--type TYPE``
|
||||
Record type.
|
||||
|
||||
``--data DATA``
|
||||
Record data.
|
||||
|
||||
``--ttl TTL``
|
||||
Record TTL.
|
||||
|
||||
``--priority PRIORITY``
|
||||
Record priority.
|
||||
|
||||
``--description DESCRIPTION``
|
||||
Description.
|
||||
|
||||
.. _designate_record-delete:
|
||||
|
||||
designate record-delete
|
||||
-----------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate record-delete [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
domain_id id
|
||||
|
||||
Delete Record
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``domain_id``
|
||||
Domain ID or name.
|
||||
|
||||
``id``
|
||||
Record ID.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _designate_record-get:
|
||||
|
||||
designate record-get
|
||||
--------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate record-get [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
domain_id id
|
||||
|
||||
Get Record
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``domain_id``
|
||||
Domain ID or name.
|
||||
|
||||
``id``
|
||||
Record ID.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _designate_record-list:
|
||||
|
||||
designate record-list
|
||||
---------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate record-list [-h] [-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
domain_id
|
||||
|
||||
List Records
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``domain_id``
|
||||
Domain ID or name.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _designate_record-update:
|
||||
|
||||
designate record-update
|
||||
-----------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate record-update [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
[--name NAME] [--type TYPE] [--data DATA]
|
||||
[--description DESCRIPTION | --no-description]
|
||||
[--ttl TTL | --no-ttl]
|
||||
[--priority PRIORITY | --no-priority]
|
||||
domain_id id
|
||||
|
||||
Update Record
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``domain_id``
|
||||
Domain ID or name.
|
||||
|
||||
``id``
|
||||
Record ID.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--name NAME``
|
||||
Record name.
|
||||
|
||||
``--type TYPE``
|
||||
Record type.
|
||||
|
||||
``--data DATA``
|
||||
Record data.
|
||||
|
||||
``--description DESCRIPTION``
|
||||
Description.
|
||||
|
||||
``--no-description``
|
||||
|
||||
``--ttl TTL``
|
||||
Record time to live (seconds).
|
||||
|
||||
``--no-ttl``
|
||||
|
||||
``--priority PRIORITY``
|
||||
Record priority.
|
||||
|
||||
``--no-priority``
|
||||
|
||||
.. _designate_report-count-all:
|
||||
|
||||
designate report-count-all
|
||||
--------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate report-count-all [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--prefix PREFIX]
|
||||
|
||||
Get count totals for all tenants, domains and records
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _designate_report-count-domains:
|
||||
|
||||
designate report-count-domains
|
||||
------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate report-count-domains [-h]
|
||||
[-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--prefix PREFIX]
|
||||
|
||||
Get counts for total domains
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _designate_report-count-records:
|
||||
|
||||
designate report-count-records
|
||||
------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate report-count-records [-h]
|
||||
[-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--prefix PREFIX]
|
||||
|
||||
Get counts for total records
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _designate_report-count-tenants:
|
||||
|
||||
designate report-count-tenants
|
||||
------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate report-count-tenants [-h]
|
||||
[-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--prefix PREFIX]
|
||||
|
||||
Get counts for total tenants
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _designate_report-tenant-domains:
|
||||
|
||||
designate report-tenant-domains
|
||||
-------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate report-tenant-domains [-h]
|
||||
[-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
--report-tenant-id REPORT_TENANT_ID
|
||||
|
||||
Get a list of domains for given tenant
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--report-tenant-id REPORT_TENANT_ID``
|
||||
The tenant_id being reported on.
|
||||
|
||||
.. _designate_report-tenants-all:
|
||||
|
||||
designate report-tenants-all
|
||||
----------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate report-tenants-all [-h] [-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
|
||||
Get list of tenants and domain count for each
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _designate_server-create:
|
||||
|
||||
designate server-create
|
||||
-----------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate server-create [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
--name NAME
|
||||
|
||||
Create Server
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--name NAME``
|
||||
Server name.
|
||||
|
||||
.. _designate_server-delete:
|
||||
|
||||
designate server-delete
|
||||
-----------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate server-delete [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
id
|
||||
|
||||
Delete Server
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``id``
|
||||
Server ID.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _designate_server-get:
|
||||
|
||||
designate server-get
|
||||
--------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate server-get [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
id
|
||||
|
||||
Get Server
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``id``
|
||||
Server ID.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _designate_server-list:
|
||||
|
||||
designate server-list
|
||||
---------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate server-list [-h] [-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
|
||||
List Servers
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _designate_server-update:
|
||||
|
||||
designate server-update
|
||||
-----------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate server-update [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
[--name NAME]
|
||||
id
|
||||
|
||||
Update Server
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``id``
|
||||
Server ID.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--name NAME``
|
||||
Server name.
|
||||
|
||||
.. _designate_sync-all:
|
||||
|
||||
designate sync-all
|
||||
------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate sync-all [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>] [--print-empty]
|
||||
[--noindent] [--prefix PREFIX]
|
||||
|
||||
Sync Everything
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _designate_sync-domain:
|
||||
|
||||
designate sync-domain
|
||||
---------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate sync-domain [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
domain_id
|
||||
|
||||
Sync a single Domain
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``domain_id``
|
||||
Domain ID
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _designate_sync-record:
|
||||
|
||||
designate sync-record
|
||||
---------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate sync-record [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
domain_id record_id
|
||||
|
||||
Sync a single Record
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``domain_id``
|
||||
Domain ID
|
||||
|
||||
``record_id``
|
||||
Record ID
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _designate_touch-domain:
|
||||
|
||||
designate touch-domain
|
||||
----------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: designate touch-domain [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
domain_id
|
||||
|
||||
Touch a single Domain
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``domain_id``
|
||||
Domain ID
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
@ -1,822 +0,0 @@
|
||||
.. ###################################################
|
||||
.. ## WARNING ######################################
|
||||
.. ############## WARNING ##########################
|
||||
.. ########################## WARNING ##############
|
||||
.. ###################################### WARNING ##
|
||||
.. ###################################################
|
||||
.. ###################################################
|
||||
.. ##
|
||||
.. This file is tool-generated. Do not edit manually.
|
||||
.. http://docs.openstack.org/contributor-guide/
|
||||
.. doc-tools/cli-reference.html
|
||||
.. ##
|
||||
.. ## WARNING ######################################
|
||||
.. ############## WARNING ##########################
|
||||
.. ########################## WARNING ##############
|
||||
.. ###################################### WARNING ##
|
||||
.. ###################################################
|
||||
|
||||
============================================================================
|
||||
Backup, Restore, and Disaster Recovery service (freezer) command-line client
|
||||
============================================================================
|
||||
|
||||
The freezer client is the command-line interface (CLI) for
|
||||
the Backup, Restore, and Disaster Recovery service (freezer) API
|
||||
and its extensions.
|
||||
|
||||
This chapter documents :command:`freezer` version ``1.4.1``.
|
||||
|
||||
For help on a specific :command:`freezer` command, enter:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ freezer help COMMAND
|
||||
|
||||
.. _freezer_command_usage:
|
||||
|
||||
freezer usage
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]
|
||||
[--os-auth-url OS_AUTH_URL] [--os-backup-url OS_BACKUP_URL]
|
||||
[--os-endpoint-type OS_ENDPOINT_TYPE]
|
||||
[--os-identity-api-version OS_IDENTITY_API_VERSION]
|
||||
[--os-password OS_PASSWORD] [--os-username OS_USERNAME]
|
||||
[--os-token OS_TOKEN]
|
||||
[--os-project-domain-name OS_PROJECT_DOMAIN_NAME]
|
||||
[--os-project-domain-id OS_PROJECT_DOMAIN_ID]
|
||||
[--os-project-name OS_PROJECT_NAME]
|
||||
[--os-region-name OS_REGION_NAME] [--os-tenant-id OS_TENANT_ID]
|
||||
[--os-tenant-name OS_TENANT_NAME]
|
||||
[--os-user-domain-name OS_USER_DOMAIN_NAME]
|
||||
[--os-user-domain-id OS_USER_DOMAIN_ID] [-k]
|
||||
[--os-cacert OS_CACERT] [--os-cert OS_CERT]
|
||||
|
||||
.. _freezer_command_options:
|
||||
|
||||
freezer optional arguments
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
``--version``
|
||||
show program's version number and exit
|
||||
|
||||
``-v, --verbose``
|
||||
Increase verbosity of output. Can be repeated.
|
||||
|
||||
``-q, --quiet``
|
||||
Suppress output except warnings and errors.
|
||||
|
||||
``--log-file LOG_FILE``
|
||||
Specify a file to log output. Disabled by default.
|
||||
|
||||
``-h, --help``
|
||||
Show help message and exit.
|
||||
|
||||
``--debug``
|
||||
Show tracebacks on errors.
|
||||
|
||||
``--os-auth-url OS_AUTH_URL``
|
||||
Specify identity endpoint
|
||||
|
||||
``--os-backup-url OS_BACKUP_URL``
|
||||
Specify the Freezer backup service endpoint to use
|
||||
|
||||
``--os-endpoint-type OS_ENDPOINT_TYPE``
|
||||
Endpoint type to select. Valid endpoint types:
|
||||
"public" or "publicURL", "internal" or "internalURL",
|
||||
"admin" or "adminURL"
|
||||
|
||||
``--os-identity-api-version OS_IDENTITY_API_VERSION``
|
||||
Identity API version: 2.0 or 3
|
||||
|
||||
``--os-password OS_PASSWORD``
|
||||
Password used for authentication with the OpenStack
|
||||
Identity service
|
||||
|
||||
``--os-username OS_USERNAME``
|
||||
Name used for authentication with the OpenStack
|
||||
Identity service
|
||||
|
||||
``--os-token OS_TOKEN``
|
||||
Specify an existing token to use instead of retrieving
|
||||
one via authentication
|
||||
|
||||
``--os-project-domain-name OS_PROJECT_DOMAIN_NAME``
|
||||
Domain name containing project
|
||||
|
||||
``--os-project-domain-id OS_PROJECT_DOMAIN_ID``
|
||||
OpenStack project domain ID. Defaults to
|
||||
``env[OS_PROJECT_ID]``.
|
||||
|
||||
``--os-project-name OS_PROJECT_NAME``
|
||||
Project name to scope to
|
||||
|
||||
``--os-region-name OS_REGION_NAME``
|
||||
Specify the region to use
|
||||
|
||||
``--os-tenant-id OS_TENANT_ID``
|
||||
Tenant to request authorization on
|
||||
|
||||
``--os-tenant-name OS_TENANT_NAME``
|
||||
Tenant to request authorization on
|
||||
|
||||
``--os-user-domain-name OS_USER_DOMAIN_NAME``
|
||||
User domain name
|
||||
|
||||
``--os-user-domain-id OS_USER_DOMAIN_ID``
|
||||
OpenStack user domain ID. Defaults to
|
||||
``env[OS_USER_DOMAIN_ID]``.
|
||||
|
||||
``-k, --insecure``
|
||||
use python-freezerclient with insecure connections
|
||||
|
||||
``--os-cacert OS_CACERT``
|
||||
Path of CA TLS certificate(s) used to verify the
|
||||
remote server's certificate. Without this option
|
||||
freezer looks for the default system CA certificates.
|
||||
|
||||
``--os-cert OS_CERT``
|
||||
Path of CERT TLS certificate(s) used to verify the
|
||||
remote server's certificate.1
|
||||
|
||||
.. _freezer_action-create:
|
||||
|
||||
freezer action-create
|
||||
---------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer action-create [-h] --file FILE
|
||||
|
||||
Create an action from a file
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--file FILE``
|
||||
Path to json file with the action
|
||||
|
||||
.. _freezer_action-delete:
|
||||
|
||||
freezer action-delete
|
||||
---------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer action-delete [-h] action_id
|
||||
|
||||
Delete an action from the api
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``action_id``
|
||||
ID of the action
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _freezer_action-list:
|
||||
|
||||
freezer action-list
|
||||
-------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer action-list [-h] [-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>] [--print-empty]
|
||||
[--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
[--limit LIMIT] [--offset OFFSET] [--search SEARCH]
|
||||
|
||||
List all actions for your user
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--limit LIMIT``
|
||||
Specify a limit for search query
|
||||
|
||||
``--offset OFFSET``
|
||||
|
||||
``--search SEARCH``
|
||||
Define a filter for the query
|
||||
|
||||
.. _freezer_action-show:
|
||||
|
||||
freezer action-show
|
||||
-------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer action-show [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>] [--print-empty]
|
||||
[--noindent] [--prefix PREFIX]
|
||||
action_id
|
||||
|
||||
Show a single action
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``action_id``
|
||||
ID of the action
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _freezer_action-update:
|
||||
|
||||
freezer action-update
|
||||
---------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer action-update [-h] action_id file
|
||||
|
||||
Update an action from a file
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``action_id``
|
||||
ID of the session
|
||||
|
||||
``file``
|
||||
Path to json file with the action
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _freezer_backup-delete:
|
||||
|
||||
freezer backup-delete
|
||||
---------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer backup-delete [-h] backup_uuid
|
||||
|
||||
Delete a backup from the api
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``backup_uuid``
|
||||
UUID of the backup
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _freezer_backup-list:
|
||||
|
||||
freezer backup-list
|
||||
-------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer backup-list [-h] [-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>] [--print-empty]
|
||||
[--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
[--limit LIMIT] [--offset OFFSET] [--search SEARCH]
|
||||
|
||||
List all backups for your user
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--limit LIMIT``
|
||||
Specify a limit for search query
|
||||
|
||||
``--offset OFFSET``
|
||||
|
||||
``--search SEARCH``
|
||||
Define a filter for the query
|
||||
|
||||
.. _freezer_backup-show:
|
||||
|
||||
freezer backup-show
|
||||
-------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer backup-show [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>] [--print-empty]
|
||||
[--noindent] [--prefix PREFIX]
|
||||
backup_uuid
|
||||
|
||||
Show the metadata of a single backup
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``backup_uuid``
|
||||
ID of the backup
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _freezer_client-delete:
|
||||
|
||||
freezer client-delete
|
||||
---------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer client-delete [-h] client_id
|
||||
|
||||
Delete a client from the api
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``client_id``
|
||||
ID of the client
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _freezer_client-list:
|
||||
|
||||
freezer client-list
|
||||
-------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer client-list [-h] [-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>] [--print-empty]
|
||||
[--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
[--limit LIMIT] [--offset OFFSET] [--search SEARCH]
|
||||
|
||||
List of clients registered in the api
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--limit LIMIT``
|
||||
Specify a limit for search query
|
||||
|
||||
``--offset OFFSET``
|
||||
|
||||
``--search SEARCH``
|
||||
Define a filter for the query
|
||||
|
||||
.. _freezer_client-register:
|
||||
|
||||
freezer client-register
|
||||
-----------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer client-register [-h] --file FILE
|
||||
|
||||
Register a new client
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--file FILE``
|
||||
Path to json file with the client
|
||||
|
||||
.. _freezer_client-show:
|
||||
|
||||
freezer client-show
|
||||
-------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer client-show [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>] [--print-empty]
|
||||
[--noindent] [--prefix PREFIX]
|
||||
client_id
|
||||
|
||||
Show a single client
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``client_id``
|
||||
ID of the client
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _freezer_job-abort:
|
||||
|
||||
freezer job-abort
|
||||
-----------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer job-abort [-h] job_id
|
||||
|
||||
Abort a running job
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``job_id``
|
||||
ID of the job
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _freezer_job-create:
|
||||
|
||||
freezer job-create
|
||||
------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer job-create [-h] --file FILE --client CLIENT_ID
|
||||
|
||||
Create a new job from a file
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--file FILE``
|
||||
Path to json file with the job
|
||||
|
||||
``--client CLIENT_ID, -C``
|
||||
CLIENT_ID
|
||||
Select a client for this job
|
||||
|
||||
.. _freezer_job-delete:
|
||||
|
||||
freezer job-delete
|
||||
------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer job-delete [-h] job_id
|
||||
|
||||
Delete a job from the api
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``job_id``
|
||||
ID of the job
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _freezer_job-get:
|
||||
|
||||
freezer job-get
|
||||
---------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer job-get [-h] [--no-format] job_id
|
||||
|
||||
Download a job as a json file
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``job_id``
|
||||
ID of the job
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--no-format``
|
||||
Return a job in json without pretty print
|
||||
|
||||
.. _freezer_job-list:
|
||||
|
||||
freezer job-list
|
||||
----------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer job-list [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN]
|
||||
[--max-width <integer>] [--print-empty] [--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
[--limit LIMIT] [--offset OFFSET] [--search SEARCH]
|
||||
[--client CLIENT_ID]
|
||||
|
||||
List all the jobs for your user
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--limit LIMIT``
|
||||
Specify a limit for search query
|
||||
|
||||
``--offset OFFSET``
|
||||
|
||||
``--search SEARCH``
|
||||
Define a filter for the query
|
||||
|
||||
``--client CLIENT_ID, -C``
|
||||
CLIENT_ID
|
||||
Get jobs for a specific client
|
||||
|
||||
.. _freezer_job-show:
|
||||
|
||||
freezer job-show
|
||||
----------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer job-show [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>] [--print-empty]
|
||||
[--noindent] [--prefix PREFIX]
|
||||
job_id
|
||||
|
||||
Show a single job
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``job_id``
|
||||
ID of the job
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _freezer_job-start:
|
||||
|
||||
freezer job-start
|
||||
-----------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer job-start [-h] job_id
|
||||
|
||||
Send a start signal for a job
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``job_id``
|
||||
ID of the job
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _freezer_job-stop:
|
||||
|
||||
freezer job-stop
|
||||
----------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer job-stop [-h] job_id
|
||||
|
||||
Send a stop signal for a job
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``job_id``
|
||||
ID of the job
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _freezer_job-update:
|
||||
|
||||
freezer job-update
|
||||
------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer job-update [-h] job_id file
|
||||
|
||||
Update a job from a file
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``job_id``
|
||||
ID of the job
|
||||
|
||||
``file``
|
||||
Path to json file with the job
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _freezer_session-add-job:
|
||||
|
||||
freezer session-add-job
|
||||
-----------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer session-add-job [-h] --session-id SESSION_ID --job-id JOB_ID
|
||||
|
||||
Add a job to a session
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--session-id SESSION_ID``
|
||||
ID of the session
|
||||
|
||||
``--job-id JOB_ID``
|
||||
ID of the job to add
|
||||
|
||||
.. _freezer_session-create:
|
||||
|
||||
freezer session-create
|
||||
----------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer session-create [-h] --file FILE
|
||||
|
||||
Create a session from a file
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--file FILE``
|
||||
Path to json file with the job
|
||||
|
||||
.. _freezer_session-delete:
|
||||
|
||||
freezer session-delete
|
||||
----------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer session-delete [-h] session_id
|
||||
|
||||
Delete a session
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``session_id``
|
||||
ID of the session
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _freezer_session-list:
|
||||
|
||||
freezer session-list
|
||||
--------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer session-list [-h] [-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
[--limit LIMIT] [--offset OFFSET]
|
||||
[--search SEARCH]
|
||||
|
||||
List all the sessions for your user
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--limit LIMIT``
|
||||
Specify a limit for search query
|
||||
|
||||
``--offset OFFSET``
|
||||
|
||||
``--search SEARCH``
|
||||
Define a filter for the query
|
||||
|
||||
.. _freezer_session-remove-job:
|
||||
|
||||
freezer session-remove-job
|
||||
--------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer session-remove-job [-h] --session-id SESSION_ID --job-id JOB_ID
|
||||
|
||||
Remove a job from a session
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--session-id SESSION_ID``
|
||||
ID of the session
|
||||
|
||||
``--job-id JOB_ID``
|
||||
ID of the job to add
|
||||
|
||||
.. _freezer_session-show:
|
||||
|
||||
freezer session-show
|
||||
--------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer session-show [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
session_id
|
||||
|
||||
Show a single session
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``session_id``
|
||||
ID of the session
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _freezer_session-start:
|
||||
|
||||
freezer session-start
|
||||
---------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer session-start [-h] --session-id SESSION_ID --job-id JOB_ID
|
||||
--job-tag JOB_TAG
|
||||
|
||||
Start a session
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--session-id SESSION_ID``
|
||||
ID of the session
|
||||
|
||||
``--job-id JOB_ID``
|
||||
ID of the job
|
||||
|
||||
``--job-tag JOB_TAG``
|
||||
Job tag value
|
||||
|
||||
.. _freezer_session-update:
|
||||
|
||||
freezer session-update
|
||||
----------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: freezer session-update [-h] session_id file
|
||||
|
||||
Update a session from a file
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``session_id``
|
||||
ID of the session
|
||||
|
||||
``file``
|
||||
Path to json file with the session
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
@ -1,340 +0,0 @@
|
||||
===========================
|
||||
Image service property keys
|
||||
===========================
|
||||
|
||||
The following keys, together with the components to which they are specific,
|
||||
can be used with the property option for both the
|
||||
:command:`openstack image set` and :command:`openstack image create` commands.
|
||||
For example:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack image set IMG-UUID --property architecture=x86_64
|
||||
|
||||
.. note::
|
||||
|
||||
Behavior set using image properties overrides behavior set using flavors.
|
||||
For more information, refer to the `Manage images
|
||||
<https://docs.openstack.org/admin-guide/common/cli-manage-images.html>`_
|
||||
in the OpenStack Administrator Guide.
|
||||
|
||||
.. list-table:: Image service property keys
|
||||
:widths: 15 35 50 90
|
||||
:header-rows: 1
|
||||
|
||||
* - Specific to
|
||||
- Key
|
||||
- Description
|
||||
- Supported values
|
||||
* - All
|
||||
- ``architecture``
|
||||
- The CPU architecture that must be supported by the hypervisor. For
|
||||
example, ``x86_64``, ``arm``, or ``ppc64``. Run :command:`uname -m`
|
||||
to get the architecture of a machine. We strongly recommend using
|
||||
the architecture data vocabulary defined by the `libosinfo project
|
||||
<http://libosinfo.org/>`_ for this purpose.
|
||||
- * ``alpha`` - `DEC 64-bit RISC
|
||||
<https://en.wikipedia.org/wiki/DEC_Alpha>`_
|
||||
* ``armv7l`` - `ARM Cortex-A7 MPCore
|
||||
<https://en.wikipedia.org/wiki/ARM_architecture>`_
|
||||
* ``cris`` - `Ethernet, Token Ring, AXis—Code Reduced Instruction
|
||||
Set <https://en.wikipedia.org/wiki/ETRAX_CRIS>`_
|
||||
* ``i686`` - `Intel sixth-generation x86 (P6 micro architecture)
|
||||
<https://en.wikipedia.org/wiki/X86>`_
|
||||
* ``ia64`` - `Itanium <https://en.wikipedia.org/wiki/Itanium>`_
|
||||
* ``lm32`` - `Lattice Micro32
|
||||
<https://en.wikipedia.org/wiki/Milkymist>`_
|
||||
* ``m68k`` - `Motorola 68000
|
||||
<https://en.wikipedia.org/wiki/Motorola_68000_family>`_
|
||||
* ``microblaze`` - `Xilinx 32-bit FPGA (Big Endian)
|
||||
<https://en.wikipedia.org/wiki/MicroBlaze>`_
|
||||
* ``microblazeel`` - `Xilinx 32-bit FPGA (Little Endian)
|
||||
<https://en.wikipedia.org/wiki/MicroBlaze>`_
|
||||
* ``mips`` - `MIPS 32-bit RISC (Big Endian)
|
||||
<https://en.wikipedia.org/wiki/MIPS_architecture>`_
|
||||
* ``mipsel`` - `MIPS 32-bit RISC (Little Endian)
|
||||
<https://en.wikipedia.org/wiki/MIPS_architecture>`_
|
||||
* ``mips64`` - `MIPS 64-bit RISC (Big Endian)
|
||||
<https://en.wikipedia.org/wiki/MIPS_architecture>`_
|
||||
* ``mips64el`` - `MIPS 64-bit RISC (Little Endian)
|
||||
<https://en.wikipedia.org/wiki/MIPS_architecture>`_
|
||||
* ``openrisc`` - `OpenCores RISC
|
||||
<https://en.wikipedia.org/wiki/OpenRISC#QEMU_support>`_
|
||||
* ``parisc`` - `HP Precision Architecture RISC
|
||||
<https://en.wikipedia.org/wiki/PA-RISC>`_
|
||||
* parisc64 - `HP Precision Architecture 64-bit RISC
|
||||
<https://en.wikipedia.org/wiki/PA-RISC>`_
|
||||
* ppc - `PowerPC 32-bit <https://en.wikipedia.org/wiki/PowerPC>`_
|
||||
* ppc64 - `PowerPC 64-bit <https://en.wikipedia.org/wiki/PowerPC>`_
|
||||
* ppcemb - `PowerPC (Embedded 32-bit)
|
||||
<https://en.wikipedia.org/wiki/PowerPC>`_
|
||||
* s390 - `IBM Enterprise Systems Architecture/390
|
||||
<https://en.wikipedia.org/wiki/S390>`_
|
||||
* s390x - `S/390 64-bit <https://en.wikipedia.org/wiki/S390x>`_
|
||||
* sh4 - `SuperH SH-4 (Little Endian)
|
||||
<https://en.wikipedia.org/wiki/SuperH>`_
|
||||
* sh4eb - `SuperH SH-4 (Big Endian)
|
||||
<https://en.wikipedia.org/wiki/SuperH>`_
|
||||
* sparc - `Scalable Processor Architecture, 32-bit
|
||||
<https://en.wikipedia.org/wiki/Sparc>`_
|
||||
* sparc64 - `Scalable Processor Architecture, 64-bit
|
||||
<https://en.wikipedia.org/wiki/Sparc>`_
|
||||
* unicore32 - `Microprocessor Research and Development Center RISC
|
||||
Unicore32 <https://en.wikipedia.org/wiki/Unicore>`_
|
||||
* x86_64 - `64-bit extension of IA-32
|
||||
<https://en.wikipedia.org/wiki/X86>`_
|
||||
* xtensa - `Tensilica Xtensa configurable microprocessor core
|
||||
<https://en.wikipedia.org/wiki/Xtensa#Processor_Cores>`_
|
||||
* xtensaeb - `Tensilica Xtensa configurable microprocessor core
|
||||
<https://en.wikipedia.org/wiki/Xtensa#Processor_Cores>`_ (Big Endian)
|
||||
* - All
|
||||
- ``hypervisor_type``
|
||||
- The hypervisor type. Note that ``qemu`` is used for both QEMU and KVM
|
||||
hypervisor types.
|
||||
- ``hyperv``, ``ironic``, ``lxc``, ``qemu``, ``uml``, ``vmware``, or
|
||||
``xen``.
|
||||
* - All
|
||||
- ``instance_type_rxtx_factor``
|
||||
- Optional property allows created servers to have a different bandwidth
|
||||
cap than that defined in the network they are attached to. This factor
|
||||
is multiplied by the ``rxtx_base`` property of the network. The
|
||||
``rxtx_base`` property defaults to ``1.0``, which is the same as the
|
||||
attached network. This parameter is only available for Xen or NSX based
|
||||
systems.
|
||||
- Float (default value is ``1.0``)
|
||||
* - All
|
||||
- ``instance_uuid``
|
||||
- For snapshot images, this is the UUID of the server used to create this
|
||||
image.
|
||||
- Valid server UUID
|
||||
* - All
|
||||
- ``img_config_drive``
|
||||
- Specifies whether the image needs a config drive.
|
||||
- ``mandatory`` or ``optional`` (default if property is not used).
|
||||
* - All
|
||||
- ``kernel_id``
|
||||
- The ID of an image stored in the Image service that should be used as
|
||||
the kernel when booting an AMI-style image.
|
||||
- Valid image ID
|
||||
* - All
|
||||
- ``os_distro``
|
||||
- The common name of the operating system distribution in lowercase
|
||||
(uses the same data vocabulary as the
|
||||
`libosinfo project`_). Specify only a recognized
|
||||
value for this field. Deprecated values are listed to assist you in
|
||||
searching for the recognized value.
|
||||
- * ``arch`` - Arch Linux. Do not use ``archlinux`` or ``org.archlinux``.
|
||||
* ``centos`` - Community Enterprise Operating System. Do not use
|
||||
``org.centos`` or ``CentOS``.
|
||||
* ``debian`` - Debian. Do not use ``Debian` or ``org.debian``.
|
||||
* ``fedora`` - Fedora. Do not use ``Fedora``, ``org.fedora``, or
|
||||
``org.fedoraproject``.
|
||||
* ``freebsd`` - FreeBSD. Do not use ``org.freebsd``, ``freeBSD``, or
|
||||
``FreeBSD``.
|
||||
* ``gentoo`` - Gentoo Linux. Do not use ``Gentoo`` or ``org.gentoo``.
|
||||
* ``mandrake`` - Mandrakelinux (MandrakeSoft) distribution. Do not use
|
||||
``mandrakelinux`` or ``MandrakeLinux``.
|
||||
* ``mandriva`` - Mandriva Linux. Do not use ``mandrivalinux``.
|
||||
* ``mes`` - Mandriva Enterprise Server. Do not use ``mandrivaent`` or
|
||||
``mandrivaES``.
|
||||
* ``msdos`` - Microsoft Disc Operating System. Do not use ``ms-dos``.
|
||||
* ``netbsd`` - NetBSD. Do not use ``NetBSD`` or ``org.netbsd``.
|
||||
* ``netware`` - Novell NetWare. Do not use ``novell`` or ``NetWare``.
|
||||
* ``openbsd`` - OpenBSD. Do not use ``OpenBSD`` or ``org.openbsd``.
|
||||
* ``opensolaris`` - OpenSolaris. Do not use ``OpenSolaris`` or
|
||||
``org.opensolaris``.
|
||||
* ``opensuse`` - openSUSE. Do not use ``suse``, ``SuSE``, or
|
||||
`` org.opensuse``.
|
||||
* ``rhel`` - Red Hat Enterprise Linux. Do not use ``redhat``, ``RedHat``,
|
||||
or ``com.redhat``.
|
||||
* ``sled`` - SUSE Linux Enterprise Desktop. Do not use ``com.suse``.
|
||||
* ``ubuntu`` - Ubuntu. Do not use ``Ubuntu``, ``com.ubuntu``,
|
||||
``org.ubuntu``, or ``canonical``.
|
||||
* ``windows`` - Microsoft Windows. Do not use ``com.microsoft.server``
|
||||
or ``windoze``.
|
||||
* - All
|
||||
- ``os_version``
|
||||
- The operating system version as specified by the distributor.
|
||||
- Valid version number (for example, ``11.10``).
|
||||
* - All
|
||||
- ``os_secure_boot``
|
||||
- Secure Boot is a security standard. When the instance starts,
|
||||
Secure Boot first examines software such as firmware and OS by their
|
||||
signature and only allows them to run if the signatures are valid.
|
||||
|
||||
For Hyper-V: Images must be prepared as Generation 2 VMs. Instance must
|
||||
also contain ``hw_machine_type=hyperv-gen2`` image property. Linux
|
||||
guests will also require bootloader's digital signature provided as
|
||||
``os_secure_boot_signature`` and
|
||||
``hypervisor_version_requires'>=10.0'`` image properties.
|
||||
- * ``required`` - Enable the Secure Boot feature.
|
||||
* ``disabled`` or ``optional`` - (default) Disable the Secure Boot
|
||||
feature.
|
||||
* - All
|
||||
- ``ramdisk_id``
|
||||
- The ID of image stored in the Image service that should be used as the
|
||||
ramdisk when booting an AMI-style image.
|
||||
- Valid image ID.
|
||||
* - All
|
||||
- ``vm_mode``
|
||||
- The virtual machine mode. This represents the host/guest ABI
|
||||
(application binary interface) used for the virtual machine.
|
||||
- * ``hvm`` - Fully virtualized. This is the mode used by QEMU and KVM.
|
||||
* ``xen`` - Xen 3.0 paravirtualized.
|
||||
* ``uml`` - User Mode Linux paravirtualized.
|
||||
* ``exe`` - Executables in containers. This is the mode used by LXC.
|
||||
* - libvirt API driver
|
||||
- ``hw_cpu_sockets``
|
||||
- The preferred number of sockets to expose to the guest.
|
||||
- Integer.
|
||||
* - libvirt API driver
|
||||
- ``hw_cpu_cores``
|
||||
- The preferred number of cores to expose to the guest.
|
||||
- Integer.
|
||||
* - libvirt API driver
|
||||
- ``hw_cpu_threads``
|
||||
- The preferred number of threads to expose to the guest.
|
||||
- Integer.
|
||||
* - libvirt API driver
|
||||
- ``hw_disk_bus``
|
||||
- Specifies the type of disk controller to attach disk devices to.
|
||||
- One of ``scsi``, ``virtio``, ``uml``, ``xen``, ``ide``, or ``usb``.
|
||||
* - libvirt API driver
|
||||
- ``hw_rng_model``
|
||||
- Adds a random-number generator device to the image's instances. The
|
||||
cloud administrator can enable and control device behavior by
|
||||
configuring the instance's flavor. By default:
|
||||
|
||||
* The generator device is disabled.
|
||||
* ``/dev/random`` is used as the default entropy source. To specify a
|
||||
physical HW RNG device, use the following option in the nova.conf
|
||||
file:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
rng_dev_path=/dev/hwrng
|
||||
|
||||
- ``virtio``, or other supported device.
|
||||
* - libvirt API driver, Hyper-V driver
|
||||
- ``hw_machine_type``
|
||||
- For libvirt: Enables booting an ARM system using the specified machine
|
||||
type. By default, if an ARM image is used and its type is not specified,
|
||||
Compute uses ``vexpress-a15`` (for ARMv7) or ``virt`` (for AArch64)
|
||||
machine types.
|
||||
|
||||
For Hyper-V: Specifies whether the Hyper-V instance will be a generation
|
||||
1 or generation 2 VM. By default, if the property is not provided, the
|
||||
instances will be generation 1 VMs. If the image is specific for
|
||||
generation 2 VMs but the property is not provided accordingly, the
|
||||
instance will fail to boot.
|
||||
- For libvirt: Valid types can be viewed by using the
|
||||
:command:`virsh capabilities` command (machine types are displayed in
|
||||
the ``machine`` tag).
|
||||
|
||||
For hyper-V: Acceptable values are either ``hyperv-gen1`` or
|
||||
``hyperv-gen2``.
|
||||
* - libvirt API driver, XenAPI driver
|
||||
- ``os_type``
|
||||
- The operating system installed on the image. The ``libvirt`` API driver
|
||||
and ``XenAPI`` driver contains logic that takes different actions
|
||||
depending on the value of the ``os_type`` parameter of the image.
|
||||
For example, for ``os_type=windows`` images, it creates a FAT32-based
|
||||
swap partition instead of a Linux swap partition, and it limits the
|
||||
injected host name to less than 16 characters.
|
||||
- ``linux`` or ``windows``.
|
||||
|
||||
* - libvirt API driver
|
||||
- ``hw_scsi_model``
|
||||
- Enables the use of VirtIO SCSI (``virtio-scsi``) to provide block
|
||||
device access for compute instances; by default, instances use VirtIO
|
||||
Block (``virtio-blk``). VirtIO SCSI is a para-virtualized SCSI
|
||||
controller device that provides improved scalability and performance,
|
||||
and supports advanced SCSI hardware.
|
||||
- ``virtio-scsi``
|
||||
* - libvirt API driver
|
||||
- ``hw_serial_port_count``
|
||||
- Specifies the count of serial ports that should be provided. If
|
||||
``hw:serial_port_count`` is not set in the flavor's extra_specs, then
|
||||
any count is permitted. If ``hw:serial_port_count`` is set, then this
|
||||
provides the default serial port count. It is permitted to override the
|
||||
default serial port count, but only with a lower value.
|
||||
- Integer
|
||||
* - libvirt API driver
|
||||
- ``hw_video_model``
|
||||
- The video image driver used.
|
||||
- ``vga``, ``cirrus``, ``vmvga``, ``xen``, or ``qxl``.
|
||||
* - libvirt API driver
|
||||
- ``hw_video_ram``
|
||||
- Maximum RAM for the video image. Used only if a ``hw_video:ram_max_mb``
|
||||
value has been set in the flavor's extra_specs and that value is higher
|
||||
than the value set in ``hw_video_ram``.
|
||||
- Integer in MB (for example, ``64``).
|
||||
* - libvirt API driver
|
||||
- ``hw_watchdog_action``
|
||||
- Enables a virtual hardware watchdog device that carries out the
|
||||
specified action if the server hangs. The watchdog uses the
|
||||
``i6300esb`` device (emulating a PCI Intel 6300ESB). If
|
||||
``hw_watchdog_action`` is not specified, the watchdog is disabled.
|
||||
- * ``disabled`` - (default) The device is not attached. Allows the user to
|
||||
disable the watchdog for the image, even if it has been enabled using
|
||||
the image's flavor.
|
||||
* ``reset`` - Forcefully reset the guest.
|
||||
* ``poweroff`` - Forcefully power off the guest.
|
||||
* ``pause`` - Pause the guest.
|
||||
* ``none`` - Only enable the watchdog; do nothing if the server hangs.
|
||||
* - libvirt API driver
|
||||
- ``os_command_line``
|
||||
- The kernel command line to be used by the ``libvirt`` driver, instead
|
||||
of the default. For Linux Containers (LXC), the value is used as
|
||||
arguments for initialization. This key is valid only for Amazon kernel,
|
||||
``ramdisk``, or machine images (``aki``, ``ari``, or ``ami``).
|
||||
-
|
||||
* - libvirt API driver and VMware API driver
|
||||
- ``hw_vif_model``
|
||||
- Specifies the model of virtual network interface device to use.
|
||||
- The valid options depend on the configured hypervisor.
|
||||
* ``KVM`` and ``QEMU``: ``e1000``, ``ne2k_pci``, ``pcnet``,
|
||||
``rtl8139``, and ``virtio``.
|
||||
* VMware: ``e1000``, ``e1000e``, ``VirtualE1000``, ``VirtualE1000e``,
|
||||
``VirtualPCNet32``, ``VirtualSriovEthernetCard``, and
|
||||
``VirtualVmxnet``.
|
||||
* Xen: ``e1000``, ``netfront``, ``ne2k_pci``, ``pcnet``, and
|
||||
``rtl8139``.
|
||||
* - libvirt API driver
|
||||
- ``hw_vif_multiqueue_enabled``
|
||||
- If ``true``, this enables the ``virtio-net multiqueue`` feature. In
|
||||
this case, the driver sets the number of queues equal to the number
|
||||
of guest vCPUs. This makes the network performance scale across a
|
||||
number of vCPUs.
|
||||
- ``true`` | ``false``
|
||||
* - libvirt API driver
|
||||
- ``hw_boot_menu``
|
||||
- If ``true``, enables the BIOS bootmenu. In cases where both the image
|
||||
metadata and Extra Spec are set, the Extra Spec setting is used. This
|
||||
allows for flexibility in setting/overriding the default behavior as
|
||||
needed.
|
||||
- ``true`` or ``false``
|
||||
* - VMware API driver
|
||||
- ``vmware_adaptertype``
|
||||
- The virtual SCSI or IDE controller used by the hypervisor.
|
||||
- ``lsiLogic``, ``lsiLogicsas``, ``busLogic``, ``ide``, or
|
||||
``paraVirtual``.
|
||||
* - VMware API driver
|
||||
- ``vmware_ostype``
|
||||
- A VMware GuestID which describes the operating system installed in
|
||||
the image. This value is passed to the hypervisor when creating a
|
||||
virtual machine. If not specified, the key defaults to ``otherGuest``.
|
||||
- See `thinkvirt.com <http://www.thinkvirt.com/?q=node/181>`_.
|
||||
* - VMware API driver
|
||||
- ``vmware_image_version``
|
||||
- Currently unused.
|
||||
- ``1``
|
||||
* - XenAPI driver
|
||||
- ``auto_disk_config``
|
||||
- If ``true``, the root partition on the disk is automatically resized
|
||||
before the instance boots. This value is only taken into account by
|
||||
the Compute service when using a Xen-based hypervisor with the
|
||||
``XenAPI`` driver. The Compute service will only attempt to resize if
|
||||
there is a single partition on the image, and only if the partition
|
||||
is in ``ext3`` or ``ext4`` format.
|
||||
- ``true`` or ``false``
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -1,9 +0,0 @@
|
||||
===========================================
|
||||
Image service (glance) command-line clients
|
||||
===========================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
glance
|
||||
glance-property-keys
|
||||
@ -1,60 +0,0 @@
|
||||
==========================================
|
||||
OpenStack Command-Line Interface Reference
|
||||
==========================================
|
||||
|
||||
Abstract
|
||||
~~~~~~~~
|
||||
|
||||
This guide provides information about OpenStack command-line client commands.
|
||||
For more information about installing and using command-line clients,
|
||||
see the `OpenStack command-line clients
|
||||
<https://docs.openstack.org/user-guide/cli.html>`_
|
||||
in the OpenStack End User Guide.
|
||||
|
||||
Contents
|
||||
~~~~~~~~
|
||||
|
||||
.. important::
|
||||
|
||||
OpenStackClient is a command-line client for OpenStack that brings
|
||||
the command set for the various APIs together in a single shell
|
||||
with a uniform command structure.
|
||||
|
||||
Presently,
|
||||
Data Processing service (sahara),
|
||||
Identity service (keystone),
|
||||
and Messaging service (zaqar)
|
||||
only use the OpenStackClient command set.
|
||||
|
||||
For more information about OpenStackClient and the command list,
|
||||
see the `OpenStackClient documentation
|
||||
<https://docs.openstack.org/developer/python-openstackclient/>`_.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
murano
|
||||
freezer
|
||||
ironic
|
||||
cinder
|
||||
senlin
|
||||
compute
|
||||
magnum
|
||||
database
|
||||
designate
|
||||
image
|
||||
watcher
|
||||
barbican
|
||||
monasca
|
||||
networking
|
||||
tacker
|
||||
swift
|
||||
heat
|
||||
cloudkitty
|
||||
vitrage
|
||||
manila
|
||||
solum
|
||||
aodh
|
||||
ceilometer
|
||||
gnocchi
|
||||
mistral
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,901 +0,0 @@
|
||||
.. ###################################################
|
||||
.. ## WARNING ######################################
|
||||
.. ############## WARNING ##########################
|
||||
.. ########################## WARNING ##############
|
||||
.. ###################################### WARNING ##
|
||||
.. ###################################################
|
||||
.. ###################################################
|
||||
.. ##
|
||||
.. This file is tool-generated. Do not edit manually.
|
||||
.. http://docs.openstack.org/contributor-guide/
|
||||
.. doc-tools/cli-reference.html
|
||||
.. ##
|
||||
.. ## WARNING ######################################
|
||||
.. ############## WARNING ##########################
|
||||
.. ########################## WARNING ##############
|
||||
.. ###################################### WARNING ##
|
||||
.. ###################################################
|
||||
|
||||
========================================================================
|
||||
Container Infrastructure Management service (magnum) command-line client
|
||||
========================================================================
|
||||
|
||||
The magnum client is the command-line interface (CLI) for
|
||||
the Container Infrastructure Management service (magnum) API
|
||||
and its extensions.
|
||||
|
||||
This chapter documents :command:`magnum` version ``2.6.0``.
|
||||
|
||||
For help on a specific :command:`magnum` command, enter:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ magnum help COMMAND
|
||||
|
||||
.. _magnum_command_usage:
|
||||
|
||||
magnum usage
|
||||
~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: magnum [--version] [--debug] [--os-cache]
|
||||
[--os-region-name <region-name>] [--os-auth-url <auth-auth-url>]
|
||||
[--os-user-id <auth-user-id>] [--os-username <auth-username>]
|
||||
[--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-token <auth-token>] [--os-password <auth-password>]
|
||||
[--service-type <service-type>]
|
||||
[--os-endpoint-type <os-endpoint-type>]
|
||||
[--os-cloud <auth-cloud>]
|
||||
[--magnum-api-version <magnum-api-ver>]
|
||||
[--os-cacert <ca-certificate>]
|
||||
[--os-endpoint-override <endpoint-override>] [--insecure]
|
||||
[--profile HMAC_KEY]
|
||||
<subcommand> ...
|
||||
|
||||
**Subcommands:**
|
||||
|
||||
``baymodel-create``
|
||||
Create a baymodel. (Deprecated in favor of cluster-template-create.)
|
||||
|
||||
``baymodel-delete``
|
||||
Delete specified baymodel. (Deprecated in favor of
|
||||
cluster-template-delete.)
|
||||
|
||||
``baymodel-list``
|
||||
Print a list of baymodels. (Deprecated in favor of
|
||||
cluster-template-list.)
|
||||
|
||||
``baymodel-show``
|
||||
Show details about the given baymodel. (Deprecated in
|
||||
favor of cluster-template-show.)
|
||||
|
||||
``baymodel-update``
|
||||
Updates one or more baymodel attributes. (Deprecated
|
||||
in favor of cluster-template-update.)
|
||||
|
||||
``bay-config``
|
||||
Configure native client to access bay. You can source
|
||||
the output of this command to get the native client of
|
||||
the corresponding COE configured to access the bay.
|
||||
Example: eval $(magnum bay-config <bay-name>).
|
||||
(Deprecated in favor of cluster-config.)
|
||||
|
||||
``bay-create``
|
||||
Create a bay. (Deprecated in favor of cluster-create.)
|
||||
|
||||
``bay-delete``
|
||||
Delete specified bay. (Deprecated in favor of cluster-delete.)
|
||||
|
||||
``bay-list``
|
||||
Print a list of available bays. (Deprecated in favor
|
||||
of cluster-list.)
|
||||
|
||||
``bay-show``
|
||||
Show details about the given bay. (Deprecated in favor
|
||||
of cluster-show.)
|
||||
|
||||
``bay-update``
|
||||
Update information about the given bay. (Deprecated in
|
||||
favor of cluster-update.)
|
||||
|
||||
``ca-rotate``
|
||||
Rotate the CA certificate for a bay or cluster to
|
||||
revoke access.
|
||||
|
||||
``ca-show``
|
||||
Show details about the CA certificate for a bay or
|
||||
cluster.
|
||||
|
||||
``ca-sign``
|
||||
Generate the CA certificate for a bay or cluster.
|
||||
|
||||
``cluster-config``
|
||||
Configure native client to access cluster. You can
|
||||
source the output of this command to get the native
|
||||
client of the corresponding COE configured to access
|
||||
the cluster. Example: eval $(magnum cluster-config
|
||||
<cluster-name>).
|
||||
|
||||
``cluster-create``
|
||||
Create a cluster.
|
||||
|
||||
``cluster-delete``
|
||||
Delete specified cluster.
|
||||
|
||||
``cluster-list``
|
||||
Print a list of available clusters.
|
||||
|
||||
``cluster-show``
|
||||
Show details about the given cluster.
|
||||
|
||||
``cluster-update``
|
||||
Update information about the given cluster.
|
||||
|
||||
``cluster-template-create``
|
||||
Create a cluster template.
|
||||
|
||||
``cluster-template-delete``
|
||||
Delete specified cluster template.
|
||||
|
||||
``cluster-template-list``
|
||||
Print a list of cluster templates.
|
||||
|
||||
``cluster-template-show``
|
||||
Show details about the given cluster template.
|
||||
|
||||
``cluster-template-update``
|
||||
Updates one or more cluster template attributes.
|
||||
|
||||
``service-list``
|
||||
Print a list of magnum services.
|
||||
|
||||
``stats-list``
|
||||
Show stats for the given project_id
|
||||
|
||||
``quotas-create``
|
||||
Create a quota.
|
||||
|
||||
``quotas-delete``
|
||||
Delete specified resource quota.
|
||||
|
||||
``quotas-list``
|
||||
Print a list of available quotas.
|
||||
|
||||
``quotas-show``
|
||||
Show details about the given project resource quota.
|
||||
|
||||
``quotas-update``
|
||||
Update information about the given project resource
|
||||
quota.
|
||||
|
||||
``bash-completion``
|
||||
Prints arguments for bash-completion. Prints all of
|
||||
the commands and options to stdout so that the
|
||||
magnum.bash_completion script doesn't have to hard
|
||||
code them.
|
||||
|
||||
``help``
|
||||
Display help about this program or one of its
|
||||
subcommands.
|
||||
|
||||
.. _magnum_command_options:
|
||||
|
||||
magnum optional arguments
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
``--version``
|
||||
show program's version number and exit
|
||||
|
||||
``--debug``
|
||||
Print debugging output.
|
||||
|
||||
``--os-cache``
|
||||
Use the auth token cache. Defaults to False if
|
||||
``env[OS_CACHE]`` is not set.
|
||||
|
||||
``--os-region-name <region-name>``
|
||||
Region name. Default= ``env[OS_REGION_NAME]``.
|
||||
|
||||
``--os-auth-url <auth-auth-url>``
|
||||
Defaults to ``env[OS_AUTH_URL]``.
|
||||
|
||||
``--os-user-id <auth-user-id>``
|
||||
Defaults to ``env[OS_USER_ID]``.
|
||||
|
||||
``--os-username <auth-username>``
|
||||
Defaults to ``env[OS_USERNAME]``.
|
||||
|
||||
``--os-user-domain-id <auth-user-domain-id>``
|
||||
Defaults to ``env[OS_USER_DOMAIN_ID]``.
|
||||
|
||||
``--os-user-domain-name <auth-user-domain-name>``
|
||||
Defaults to ``env[OS_USER_DOMAIN_NAME]``.
|
||||
|
||||
``--os-project-id <auth-project-id>``
|
||||
Defaults to ``env[OS_PROJECT_ID]``.
|
||||
|
||||
``--os-project-name <auth-project-name>``
|
||||
Defaults to ``env[OS_PROJECT_NAME]``.
|
||||
|
||||
``--os-project-domain-id <auth-project-domain-id>``
|
||||
Defaults to ``env[OS_PROJECT_DOMAIN_ID]``.
|
||||
|
||||
``--os-project-domain-name <auth-project-domain-name>``
|
||||
Defaults to ``env[OS_PROJECT_DOMAIN_NAME]``.
|
||||
|
||||
``--os-token <auth-token>``
|
||||
Defaults to ``env[OS_TOKEN]``.
|
||||
|
||||
``--os-password <auth-password>``
|
||||
Defaults to ``env[OS_PASSWORD]``.
|
||||
|
||||
``--service-type <service-type>``
|
||||
Defaults to container-infra for all actions.
|
||||
|
||||
``--os-endpoint-type <os-endpoint-type>``
|
||||
Defaults to ``env[OS_ENDPOINT_TYPE]``
|
||||
|
||||
``--os-cloud <auth-cloud>``
|
||||
Defaults to ``env[OS_CLOUD]``.
|
||||
|
||||
``--magnum-api-version <magnum-api-ver>``
|
||||
Accepts "api", defaults to ``env[MAGNUM_API_VERSION]``.
|
||||
|
||||
``--os-cacert <ca-certificate>``
|
||||
Specify a CA bundle file to use in verifying a TLS
|
||||
(https) server certificate. Defaults to
|
||||
``env[OS_CACERT]``.
|
||||
|
||||
``--os-endpoint-override <endpoint-override>``
|
||||
Use this API endpoint instead of the Service Catalog.
|
||||
|
||||
``--insecure``
|
||||
Do not verify https connections
|
||||
|
||||
``--profile HMAC_KEY``
|
||||
HMAC key to use for encrypting context data for
|
||||
performance profiling of operation. This key should be
|
||||
the value of the HMAC key configured for the
|
||||
OSprofiler middleware in magnum; it is specified in
|
||||
the Magnum configuration file at
|
||||
"/etc/magnum/magnum.conf". Without the key, profiling
|
||||
will not be triggered even if OSprofiler is enabled on
|
||||
the server side.
|
||||
|
||||
.. _magnum_ca-rotate:
|
||||
|
||||
magnum ca-rotate
|
||||
----------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: magnum ca-rotate --cluster <cluster>
|
||||
|
||||
Rotate the CA certificate for a bay or cluster to revoke access.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``--cluster <cluster>``
|
||||
ID or name of the cluster.
|
||||
|
||||
.. _magnum_ca-show:
|
||||
|
||||
magnum ca-show
|
||||
--------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: magnum ca-show [--bay <bay>] [--cluster <cluster>]
|
||||
|
||||
Show details about the CA certificate for a bay or cluster.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``--bay <bay>``
|
||||
ID or name of the bay.
|
||||
|
||||
``--cluster <cluster>``
|
||||
ID or name of the cluster.
|
||||
|
||||
.. _magnum_ca-sign:
|
||||
|
||||
magnum ca-sign
|
||||
--------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: magnum ca-sign [--csr <csr>] [--bay <bay>] [--cluster <cluster>]
|
||||
|
||||
Generate the CA certificate for a bay or cluster.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``--csr <csr>``
|
||||
File path of the csr file to send to Magnum to get
|
||||
signed.
|
||||
|
||||
``--bay <bay>``
|
||||
ID or name of the bay.
|
||||
|
||||
``--cluster <cluster>``
|
||||
ID or name of the cluster.
|
||||
|
||||
.. _magnum_cluster-config:
|
||||
|
||||
magnum cluster-config
|
||||
---------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: magnum cluster-config [--dir <dir>] [--force] <cluster>
|
||||
|
||||
Configure native client to access cluster. You can source the output of this
|
||||
command to get the native client of the corresponding COE configured to access
|
||||
the cluster. Example: eval $(magnum cluster-config <cluster-name>).
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<cluster>``
|
||||
ID or name of the cluster to retrieve config.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``--dir <dir>``
|
||||
Directory to save the certificate and config files.
|
||||
|
||||
``--force``
|
||||
Overwrite files if existing.
|
||||
|
||||
.. _magnum_cluster-create:
|
||||
|
||||
magnum cluster-create
|
||||
---------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: magnum cluster-create [--keypair-id <keypair> | --keypair <keypair>]
|
||||
[--name <name>] --cluster-template
|
||||
<cluster_template> [--node-count <node-count>]
|
||||
[--master-count <master-count>]
|
||||
[--discovery-url <discovery-url>]
|
||||
[--timeout <timeout>]
|
||||
[<name>]
|
||||
|
||||
Create a cluster.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<name>``
|
||||
Name of the cluster to create.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``--keypair-id <keypair>``
|
||||
Name of the keypair to use for this cluster. This
|
||||
parameter is deprecated and will be removed in a
|
||||
future release. Use --keypair instead.
|
||||
|
||||
``--keypair <keypair>``
|
||||
Name of the keypair to use for this cluster.
|
||||
|
||||
``--name <name>``
|
||||
Name of the cluster to create. The --name parameter is
|
||||
deprecated and will be removed in a future release.
|
||||
Use the <name> positional parameter instead.
|
||||
|
||||
``--cluster-template <cluster_template>``
|
||||
ID or name of the cluster template.
|
||||
|
||||
``--node-count <node-count>``
|
||||
The cluster node count.
|
||||
|
||||
``--master-count <master-count>``
|
||||
The number of master nodes for the cluster.
|
||||
|
||||
``--discovery-url <discovery-url>``
|
||||
Specifies custom discovery url for node discovery.
|
||||
|
||||
``--timeout <timeout>``
|
||||
The timeout for cluster creation in minutes. The
|
||||
default is 60 minutes.
|
||||
|
||||
.. _magnum_cluster-delete:
|
||||
|
||||
magnum cluster-delete
|
||||
---------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: magnum cluster-delete <cluster> [<cluster> ...]
|
||||
|
||||
Delete specified cluster.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<cluster>``
|
||||
ID or name of the (cluster)s to delete.
|
||||
|
||||
.. _magnum_cluster-list:
|
||||
|
||||
magnum cluster-list
|
||||
-------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: magnum cluster-list [--marker <marker>] [--limit <limit>]
|
||||
[--sort-key <sort-key>] [--sort-dir <sort-dir>]
|
||||
[--fields <fields>]
|
||||
|
||||
Print a list of available clusters.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``--marker <marker>``
|
||||
The last cluster UUID of the previous page; displays
|
||||
list of clusters after "marker".
|
||||
|
||||
``--limit <limit>``
|
||||
Maximum number of clusters to return.
|
||||
|
||||
``--sort-key <sort-key>``
|
||||
Column to sort results by.
|
||||
|
||||
``--sort-dir <sort-dir>``
|
||||
Direction to sort. "asc" or "desc".
|
||||
|
||||
``--fields <fields>``
|
||||
Comma-separated list of fields to display. Available
|
||||
fields: uuid, name, cluster_template_id, stack_id,
|
||||
status, master_count, node_count, links,
|
||||
create_timeout
|
||||
|
||||
.. _magnum_cluster-show:
|
||||
|
||||
magnum cluster-show
|
||||
-------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: magnum cluster-show [--long] <cluster>
|
||||
|
||||
Show details about the given cluster.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<cluster>``
|
||||
ID or name of the cluster to show.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``--long``
|
||||
Display extra associated cluster template info.
|
||||
|
||||
.. _magnum_cluster-template-create:
|
||||
|
||||
magnum cluster-template-create
|
||||
------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: magnum cluster-template-create
|
||||
[--keypair-id <keypair> | --keypair <keypair>]
|
||||
(--external-network-id <external-network> | --external-network <external-network>)
|
||||
[--master-flavor-id <master-flavor> | --master-flavor <master-flavor>]
|
||||
[--flavor-id <flavor> | --flavor <flavor>]
|
||||
(--image-id <image> | --image <image>)
|
||||
[--name <name>] --coe <coe>
|
||||
[--fixed-network <fixed-network>]
|
||||
[--fixed-subnet <fixed-subnet>]
|
||||
[--network-driver <network-driver>]
|
||||
[--volume-driver <volume-driver>]
|
||||
[--dns-nameserver <dns-nameserver>]
|
||||
[--docker-volume-size <docker-volume-size>]
|
||||
[--docker-storage-driver <docker-storage-driver>]
|
||||
[--http-proxy <http-proxy>]
|
||||
[--https-proxy <https-proxy>]
|
||||
[--no-proxy <no-proxy>]
|
||||
[--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3...>]
|
||||
[--tls-disabled] [--public]
|
||||
[--registry-enabled]
|
||||
[--server-type <server-type>]
|
||||
[--master-lb-enabled]
|
||||
[--floating-ip-enabled]
|
||||
[--insecure-registry <insecure-registry>]
|
||||
[<name>]
|
||||
|
||||
Create a cluster template.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<name>``
|
||||
Name of the cluster template to create.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``--keypair-id <keypair>``
|
||||
The name of the SSH keypair to load into the Cluster
|
||||
nodes. This parameter is deprecated and will be
|
||||
removed in a future release. Use --keypair instead.
|
||||
|
||||
``--keypair <keypair>``
|
||||
The name of the SSH keypair to load into the Cluster
|
||||
nodes.
|
||||
|
||||
``--external-network-id <external-network>``
|
||||
The external Neutron network name or UUID to connect
|
||||
to this Cluster Template. This parameter is deprecated
|
||||
and will be removed in a future release. Use
|
||||
--external-network instead.
|
||||
|
||||
``--external-network <external-network>``
|
||||
The external Neutron network name or UUID to connect
|
||||
to this Cluster Template.
|
||||
|
||||
``--master-flavor-id <master-flavor>``
|
||||
The nova flavor name or UUID to use when launching the
|
||||
master node of the Cluster. This parameter is
|
||||
deprecated and will be removed in a future release.
|
||||
Use --master-flavor instead.
|
||||
|
||||
``--master-flavor <master-flavor>``
|
||||
The nova flavor name or UUID to use when launching the
|
||||
master node of the Cluster.
|
||||
|
||||
``--flavor-id <flavor>``
|
||||
The nova flavor name or UUID to use when launching the
|
||||
Cluster. This parameter is deprecated and will be
|
||||
removed in a future release. Use --flavor instead.
|
||||
|
||||
``--flavor <flavor>``
|
||||
The nova flavor name or UUID to use when launching the
|
||||
Cluster.
|
||||
|
||||
``--image-id <image>``
|
||||
The name or UUID of the base image to customize for
|
||||
the Cluster. This parameter is deprecated and will be
|
||||
removed in a future release. Use --image instead.
|
||||
|
||||
``--image <image>``
|
||||
The name or UUID of the base image to customize for
|
||||
the Cluster.
|
||||
|
||||
``--name <name>``
|
||||
Name of the cluster template to create. The --name
|
||||
parameter is deprecated and will be removed in a
|
||||
future release. Use the <name> positional parameter
|
||||
instead.
|
||||
|
||||
``--coe <coe>``
|
||||
Specify the Container Orchestration Engine to use.
|
||||
|
||||
``--fixed-network <fixed-network>``
|
||||
The private Neutron network name to connect to this
|
||||
Cluster model.
|
||||
|
||||
``--fixed-subnet <fixed-subnet>``
|
||||
The private Neutron subnet name to connect to Cluster.
|
||||
|
||||
``--network-driver <network-driver>``
|
||||
The network driver name for instantiating container
|
||||
networks.
|
||||
|
||||
``--volume-driver <volume-driver>``
|
||||
The volume driver name for instantiating container
|
||||
volume.
|
||||
|
||||
``--dns-nameserver <dns-nameserver>``
|
||||
The DNS nameserver to use for this cluster template.
|
||||
|
||||
``--docker-volume-size <docker-volume-size>``
|
||||
Specify the number of size in GB for the docker volume
|
||||
to use.
|
||||
|
||||
``--docker-storage-driver <docker-storage-driver>``
|
||||
Select a docker storage driver. Supported:
|
||||
devicemapper, overlay. Default: devicemapper
|
||||
|
||||
``--http-proxy <http-proxy>``
|
||||
The http_proxy address to use for nodes in Cluster.
|
||||
|
||||
``--https-proxy <https-proxy>``
|
||||
The https_proxy address to use for nodes in Cluster.
|
||||
|
||||
``--no-proxy <no-proxy>``
|
||||
The no_proxy address to use for nodes in Cluster.
|
||||
|
||||
``--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3...>``
|
||||
Arbitrary labels in the form of key=value pairs to
|
||||
associate with a cluster template. May be used
|
||||
multiple times.
|
||||
|
||||
``--tls-disabled``
|
||||
Disable TLS in the Cluster.
|
||||
|
||||
``--public``
|
||||
Make cluster template public.
|
||||
|
||||
``--registry-enabled``
|
||||
Enable docker registry in the Cluster
|
||||
|
||||
``--server-type <server-type>``
|
||||
Specify the server type to be used for example vm. For
|
||||
this release default server type will be vm.
|
||||
|
||||
``--master-lb-enabled``
|
||||
Indicates whether created Clusters should have a load
|
||||
balancer for master nodes or not.
|
||||
|
||||
``--floating-ip-enabled``
|
||||
Indicates whether created Clusters should have a
|
||||
floating ip or not.
|
||||
|
||||
``--insecure-registry <insecure-registry>``
|
||||
url of docker registry
|
||||
|
||||
.. _magnum_cluster-template-delete:
|
||||
|
||||
magnum cluster-template-delete
|
||||
------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: magnum cluster-template-delete <cluster_templates>
|
||||
[<cluster_templates> ...]
|
||||
|
||||
Delete specified cluster template.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<cluster_templates>``
|
||||
ID or name of the (cluster template)s to delete.
|
||||
|
||||
.. _magnum_cluster-template-list:
|
||||
|
||||
magnum cluster-template-list
|
||||
----------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: magnum cluster-template-list [--limit <limit>] [--sort-key <sort-key>]
|
||||
[--sort-dir <sort-dir>]
|
||||
[--fields <fields>] [--detail]
|
||||
|
||||
Print a list of cluster templates.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``--limit <limit>``
|
||||
Maximum number of cluster templates to return
|
||||
|
||||
``--sort-key <sort-key>``
|
||||
Column to sort results by
|
||||
|
||||
``--sort-dir <sort-dir>``
|
||||
Direction to sort. "asc" or "desc".
|
||||
|
||||
``--fields <fields>``
|
||||
Comma-separated list of fields to display. Available
|
||||
fields: uuid, name, coe, image_id, public, link,
|
||||
apiserver_port, server_type, tls_disabled,
|
||||
registry_enabled
|
||||
|
||||
``--detail``
|
||||
Show detailed information about the cluster templates.
|
||||
|
||||
.. _magnum_cluster-template-show:
|
||||
|
||||
magnum cluster-template-show
|
||||
----------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: magnum cluster-template-show <cluster_template>
|
||||
|
||||
Show details about the given cluster template.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<cluster_template>``
|
||||
ID or name of the cluster template to show.
|
||||
|
||||
.. _magnum_cluster-template-update:
|
||||
|
||||
magnum cluster-template-update
|
||||
------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: magnum cluster-template-update <cluster_template> <op> <path=value>
|
||||
[<path=value> ...]
|
||||
|
||||
Updates one or more cluster template attributes.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<cluster_template>``
|
||||
UUID or name of cluster template
|
||||
|
||||
``<op>``
|
||||
Operations: 'add', 'replace' or 'remove'
|
||||
|
||||
``<path=value>``
|
||||
Attributes to add/replace or remove (only PATH is
|
||||
necessary on remove)
|
||||
|
||||
.. _magnum_cluster-update:
|
||||
|
||||
magnum cluster-update
|
||||
---------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: magnum cluster-update [--rollback]
|
||||
<cluster> <op> <path=value> [<path=value> ...]
|
||||
|
||||
Update information about the given cluster.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<cluster>``
|
||||
UUID or name of cluster
|
||||
|
||||
``<op>``
|
||||
Operations: 'add', 'replace' or 'remove'
|
||||
|
||||
``<path=value>``
|
||||
Attributes to add/replace or remove (only PATH is necessary on
|
||||
remove)
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``--rollback``
|
||||
Rollback cluster on update failure.
|
||||
|
||||
.. _magnum_quotas-create:
|
||||
|
||||
magnum quotas-create
|
||||
--------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: magnum quotas-create --project-id <project-id> --resource <resource>
|
||||
[--hard-limit <hard-limit>]
|
||||
|
||||
Create a quota.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``--project-id <project-id>``
|
||||
Project Id.
|
||||
|
||||
``--resource <resource>``
|
||||
Resource name.
|
||||
|
||||
``--hard-limit <hard-limit>``
|
||||
Max resource limit.
|
||||
|
||||
.. _magnum_quotas-delete:
|
||||
|
||||
magnum quotas-delete
|
||||
--------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: magnum quotas-delete --project-id <project-id> --resource <resource>
|
||||
|
||||
Delete specified resource quota.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``--project-id <project-id>``
|
||||
Project ID.
|
||||
|
||||
``--resource <resource>``
|
||||
Resource name
|
||||
|
||||
.. _magnum_quotas-list:
|
||||
|
||||
magnum quotas-list
|
||||
------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: magnum quotas-list [--marker <marker>] [--limit <limit>]
|
||||
[--sort-key <sort-key>] [--sort-dir <sort-dir>]
|
||||
[--all-tenants]
|
||||
|
||||
Print a list of available quotas.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``--marker <marker>``
|
||||
The last quota UUID of the previous page; displays
|
||||
list of quotas after "marker".
|
||||
|
||||
``--limit <limit>``
|
||||
Maximum number of quotas to return.
|
||||
|
||||
``--sort-key <sort-key>``
|
||||
Column to sort results by.
|
||||
|
||||
``--sort-dir <sort-dir>``
|
||||
Direction to sort. "asc" or "desc".
|
||||
|
||||
``--all-tenants``
|
||||
Flag to indicate list all tenant quotas.
|
||||
|
||||
.. _magnum_quotas-show:
|
||||
|
||||
magnum quotas-show
|
||||
------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: magnum quotas-show --project-id <project-id> --resource <resource>
|
||||
|
||||
Show details about the given project resource quota.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``--project-id <project-id>``
|
||||
Project ID.
|
||||
|
||||
``--resource <resource>``
|
||||
Resource name
|
||||
|
||||
.. _magnum_quotas-update:
|
||||
|
||||
magnum quotas-update
|
||||
--------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: magnum quotas-update --project-id <project-id> --resource <resource>
|
||||
[--hard-limit <hard-limit>]
|
||||
|
||||
Update information about the given project resource quota.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``--project-id <project-id>``
|
||||
Project Id.
|
||||
|
||||
``--resource <resource>``
|
||||
Resource name.
|
||||
|
||||
``--hard-limit <hard-limit>``
|
||||
Max resource limit.
|
||||
|
||||
.. _magnum_service-list:
|
||||
|
||||
magnum service-list
|
||||
-------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: magnum service-list
|
||||
|
||||
Print a list of magnum services.
|
||||
|
||||
.. _magnum_stats-list:
|
||||
|
||||
magnum stats-list
|
||||
-----------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: magnum stats-list [--project-id <project-id>]
|
||||
|
||||
Show stats for the given project_id
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``--project-id <project-id>``
|
||||
Project ID
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -1,10 +0,0 @@
|
||||
=================================================
|
||||
Networking service (neutron) command-line clients
|
||||
=================================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
neutron
|
||||
neutron-debug
|
||||
neutron-sanity-check
|
||||
@ -1,309 +0,0 @@
|
||||
.. This file is manually generated, unlike many of the other chapters.
|
||||
|
||||
=================================
|
||||
neutron-debug command-line client
|
||||
=================================
|
||||
|
||||
The :command:`neutron-debug` client is an extension to the :command:`neutron`
|
||||
command-line interface (CLI) for the OpenStack neutron-debug tool.
|
||||
|
||||
This chapter documents :command:`neutron-debug` version ``2.3.0``.
|
||||
|
||||
For help on a specific :command:`neutron-debug` command, enter:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ neutron-debug help COMMAND
|
||||
|
||||
.. _neutron-debug_usage:
|
||||
|
||||
neutron-debug usage
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: neutron-debug [--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-cloud <cloud>]
|
||||
[--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] [--config-file CONFIG_FILE]
|
||||
<subcommand> ...
|
||||
|
||||
Subcommands
|
||||
-----------
|
||||
|
||||
``probe-create``
|
||||
Create probe port - create port and interface within a network namespace.
|
||||
|
||||
``probe-list``
|
||||
List all probes.
|
||||
|
||||
``probe-clear``
|
||||
Clear all probes.
|
||||
|
||||
``probe-delete``
|
||||
Delete probe - delete port then delete the namespace.
|
||||
|
||||
``probe-exec``
|
||||
Execute commands in the namespace of the probe.
|
||||
|
||||
``ping-all``
|
||||
``ping-all`` is an all-in-one command to ping all fixed IPs in a specified
|
||||
network.
|
||||
|
||||
.. _neutron-debug_optional:
|
||||
|
||||
neutron-debug optional arguments
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
``--version``
|
||||
Show program's version number and exit
|
||||
|
||||
``-v, --verbose, --debug``
|
||||
Increase verbosity of output and show tracebacks on
|
||||
errors. You can repeat this option.
|
||||
|
||||
``-q, --quiet``
|
||||
Suppress output except warnings and errors.
|
||||
|
||||
``-h, --help``
|
||||
Show this help message and exit
|
||||
|
||||
``-r NUM, --retries NUM``
|
||||
How many times the request to the Neutron server
|
||||
should be retried if it fails.
|
||||
|
||||
``--os-service-type <os-service-type>``
|
||||
Defaults to env[OS_NETWORK_SERVICE_TYPE] or network.
|
||||
|
||||
``--os-endpoint-type <os-endpoint-type>``
|
||||
Defaults to ``env[OS_ENDPOINT_TYPE]`` or public.
|
||||
|
||||
``--service-type <service-type>``
|
||||
DEPRECATED! Use --os-service-type.
|
||||
|
||||
``--endpoint-type <endpoint-type>``
|
||||
DEPRECATED! Use --os-endpoint-type.
|
||||
|
||||
``--os-auth-strategy <auth-strategy>``
|
||||
DEPRECATED! Only keystone is supported.
|
||||
|
||||
``os-cloud <cloud>``
|
||||
Defaults to env[OS_CLOUD].
|
||||
|
||||
``--os-auth-url <auth-url>``
|
||||
Authentication URL, defaults to env[OS_AUTH_URL].
|
||||
|
||||
``--os-tenant-name <auth-tenant-name>``
|
||||
Authentication tenant name, defaults to
|
||||
env[OS_TENANT_NAME].
|
||||
|
||||
``--os-project-name <auth-project-name>``
|
||||
Another way to specify tenant name. This option is
|
||||
mutually exclusive with --os-tenant-name. Defaults to
|
||||
env[OS_PROJECT_NAME].
|
||||
|
||||
``--os-tenant-id <auth-tenant-id>``
|
||||
Authentication tenant ID, defaults to
|
||||
env[OS_TENANT_ID].
|
||||
|
||||
``--os-project-id <auth-project-id>``
|
||||
Another way to specify tenant ID. This option is
|
||||
mutually exclusive with --os-tenant-id. Defaults to
|
||||
env[OS_PROJECT_ID].
|
||||
|
||||
``--os-username <auth-username>``
|
||||
Authentication username, defaults to env[OS_USERNAME].
|
||||
|
||||
``--os-user-id <auth-user-id>``
|
||||
Authentication user ID (Env: OS_USER_ID)
|
||||
|
||||
``--os-user-domain-id <auth-user-domain-id>``
|
||||
OpenStack user domain ID. Defaults to
|
||||
env[OS_USER_DOMAIN_ID].
|
||||
|
||||
``--os-user-domain-name <auth-user-domain-name>``
|
||||
OpenStack user domain name. Defaults to
|
||||
env[OS_USER_DOMAIN_NAME].
|
||||
|
||||
``--os-project-domain-id <auth-project-domain-id>``
|
||||
Defaults to env[OS_PROJECT_DOMAIN_ID].
|
||||
|
||||
``--os-project-domain-name <auth-project-domain-name>``
|
||||
Defaults to env[OS_PROJECT_DOMAIN_NAME].
|
||||
|
||||
``--os-cert <certificate>``
|
||||
Path of certificate file to use in SSL connection.
|
||||
This file can optionally be prepended with the private
|
||||
key. Defaults to env[OS_CERT].
|
||||
|
||||
``--os-cacert <ca-certificate>``
|
||||
Specify a CA bundle file to use in verifying a TLS
|
||||
(https) server certificate. Defaults to
|
||||
env[OS_CACERT].
|
||||
|
||||
``--os-key <key>``
|
||||
Path of client key to use in SSL connection. This
|
||||
option is not necessary if your key is prepended to
|
||||
your certificate file. Defaults to env[OS_KEY].
|
||||
|
||||
``--os-password <auth-password>``
|
||||
Authentication password, defaults to env[OS_PASSWORD].
|
||||
|
||||
``--os-region-name <auth-region-name>``
|
||||
Authentication region name, defaults to
|
||||
env[OS_REGION_NAME].
|
||||
|
||||
``--os-token <token>``
|
||||
Authentication token, defaults to env[OS_TOKEN].
|
||||
|
||||
``--http-timeout <seconds>``
|
||||
Timeout in seconds to wait for an HTTP response.
|
||||
Defaults to env[OS_NETWORK_TIMEOUT] or None if not
|
||||
specified.
|
||||
|
||||
``--os-url <url>``
|
||||
Defaults to env[OS_URL]
|
||||
|
||||
``--insecure``
|
||||
Explicitly allow neutronclient to perform "insecure"
|
||||
SSL (https) requests. The server's certificate will
|
||||
not be verified against any certificate authorities.
|
||||
This option should be used with caution.
|
||||
|
||||
``--config-file CONFIG_FILE``
|
||||
Config file for interface driver (You may also use l3_agent.ini)
|
||||
|
||||
neutron-debug probe-create command
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: neutron-debug probe-create NET
|
||||
|
||||
Create probe port - create port and interface,
|
||||
then place it into the created network namespace.
|
||||
|
||||
Positional arguments
|
||||
--------------------
|
||||
|
||||
``NET ID``
|
||||
ID of the network in which the probe will be created.
|
||||
|
||||
neutron-debug probe-list command
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: neutron-debug probe-list
|
||||
|
||||
List probes.
|
||||
|
||||
neutron-debug probe-clear command
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: neutron-debug probe-clear
|
||||
|
||||
Clear all probes.
|
||||
|
||||
neutron-debug probe-delete command
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: neutron-debug probe-delete <port-id>
|
||||
|
||||
Remove a probe.
|
||||
|
||||
Positional arguments
|
||||
--------------------
|
||||
|
||||
``<port-id>``
|
||||
ID of the probe to delete.
|
||||
|
||||
neutron-debug probe-exec command
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: neutron-debug probe-exec <port-id> <command>
|
||||
|
||||
Execute commands in the namespace of the probe
|
||||
|
||||
neutron-debug ping-all command
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: neutron-debug ping-all <port-id> --timeout <number>
|
||||
|
||||
All-in-one command to ping all fixed IPs in a specified network.
|
||||
A probe creation is not needed for this command.
|
||||
A new probe is created automatically.
|
||||
It will, however, need to be deleted manually when it is no longer needed.
|
||||
When there are multiple networks, the newly created probe will be attached
|
||||
to a random network and thus the ping will take place from within that
|
||||
random network.
|
||||
|
||||
Positional arguments
|
||||
--------------------
|
||||
|
||||
``<port-id>``
|
||||
ID of the port to use.
|
||||
|
||||
Optional arguments
|
||||
------------------
|
||||
|
||||
``--timeout <timeout in seconds>``
|
||||
Optional ping timeout.
|
||||
|
||||
neutron-debug example
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: neutron-debug create-probe <NET_ID>
|
||||
|
||||
Create a probe namespace within the network identified by ``NET_ID``.
|
||||
The namespace will have the name of qprobe-<UUID of the probe port>
|
||||
|
||||
.. note::
|
||||
|
||||
For the following examples to function, the security group rules
|
||||
may need to be modified to allow the SSH (TCP port 22) or ping
|
||||
(ICMP) traffic into network.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: neutron-debug probe-exec <probe ID> "ssh <IP of instance>"
|
||||
|
||||
SSH to an instance within the network.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: neutron-debug ping-all <network ID>
|
||||
|
||||
Ping all instances on this network to verify they are responding.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: neutron-debug probe-exec <probe_ID> dhcping <VM_MAC address> -s <IP of DHCP server>
|
||||
|
||||
Ping the DHCP server for this network using dhcping to verify it is working.
|
||||
@ -1,258 +0,0 @@
|
||||
.. This file is manually generated, unlike many of the other chapters.
|
||||
|
||||
========================================
|
||||
neutron-sanity-check command-line client
|
||||
========================================
|
||||
|
||||
The :command:`neutron-sanity-check` client is a tool that checks various
|
||||
sanity about the Networking service.
|
||||
|
||||
This chapter documents :command:`neutron-sanity-check` version ``10.0.0``.
|
||||
|
||||
neutron-sanity-check usage
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: neutron-sanity-check [-h] [--arp_header_match] [--arp_responder]
|
||||
[--bridge_firewalling] [--config-dir DIR]
|
||||
[--config-file PATH] [--debug] [--dhcp_release6]
|
||||
[--dibbler_version] [--dnsmasq_version]
|
||||
[--ebtables_installed] [--icmpv6_header_match]
|
||||
[--ip6tables_installed] [--ip_nonlocal_bind]
|
||||
[--iproute2_vxlan] [--ipset_installed]
|
||||
[--keepalived_ipv6_support]
|
||||
[--log-config-append PATH]
|
||||
[--log-date-format DATE_FORMAT]
|
||||
[--log-dir LOG_DIR] [--log-file PATH]
|
||||
[--noarp_header_match] [--noarp_responder]
|
||||
[--nobridge_firewalling] [--nodebug]
|
||||
[--nodhcp_release6] [--nodibbler_version]
|
||||
[--nodnsmasq_version] [--noebtables_installed]
|
||||
[--noicmpv6_header_match]
|
||||
[--noip6tables_installed] [--noip_nonlocal_bind]
|
||||
[--noiproute2_vxlan] [--noipset_installed]
|
||||
[--nokeepalived_ipv6_support] [--nonova_notify]
|
||||
[--noovs_conntrack] [--noovs_geneve]
|
||||
[--noovs_patch] [--noovs_vxlan] [--noovsdb_native]
|
||||
[--noread_netns] [--nouse-syslog] [--nova_notify]
|
||||
[--noverbose] [--novf_extended_management]
|
||||
[--novf_management] [--nowatch-log-file]
|
||||
[--ovs_conntrack] [--ovs_geneve] [--ovs_patch]
|
||||
[--ovs_vxlan] [--ovsdb_native] [--read_netns]
|
||||
[--state_path STATE_PATH]
|
||||
[--syslog-log-facility SYSLOG_LOG_FACILITY]
|
||||
[--use-syslog] [--verbose] [--version]
|
||||
[--vf_extended_management] [--vf_management]
|
||||
[--watch-log-file]
|
||||
|
||||
neutron-sanity-check optional arguments
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--arp_header_match``
|
||||
Check for ARP header match support
|
||||
|
||||
``--arp_responder``
|
||||
Check for ARP responder support
|
||||
|
||||
``--bridge_firewalling``
|
||||
Check bridge firewalling
|
||||
|
||||
``--ip_nonlocal_bind``
|
||||
Check ip_nonlocal_bind kernel option works with network namespaces.
|
||||
|
||||
``--config-dir DIR``
|
||||
Path to a config directory to pull ``*.conf`` files from.
|
||||
This file set is sorted, so as to provide a predictable parse order
|
||||
if individual options are over-ridden. The set is parsed after the file(s)
|
||||
specified via previous --config-file, arguments hence
|
||||
over-ridden options in the directory take precedence.
|
||||
|
||||
``--config-file PATH``
|
||||
Path to a config file to use. Multiple config files can be specified,
|
||||
with values in later files taking precedence. Dafaults to ``None``.
|
||||
|
||||
``--debug, -d``
|
||||
Print debugging output (set logging level to ``DEBUG`` instead of default
|
||||
``INFO`` level).
|
||||
|
||||
``--dhcp_release6``
|
||||
Check dhcp_release6 installation
|
||||
|
||||
``--dibbler_version``
|
||||
Check minimal dibbler version
|
||||
|
||||
``--dnsmasq_version``
|
||||
Check minimal dnsmasq version
|
||||
|
||||
``--ebtables_installed``
|
||||
Check ebtables installation
|
||||
|
||||
``--icmpv6_header_match``
|
||||
Check for ICMPv6 header match support
|
||||
|
||||
``--ip6tables_installed``
|
||||
Check ip6tables installation
|
||||
|
||||
``--iproute2_vxlan``
|
||||
Check for iproute2 vxlan support
|
||||
|
||||
``--ipset_installed``
|
||||
Check ipset installation
|
||||
|
||||
``--keepalived_ipv6_support``
|
||||
Check keepalived IPv6 support
|
||||
|
||||
``--log-config-append PATH, --log_config PATH``
|
||||
The name of a logging configuration file. This file is appended to any
|
||||
existing logging configuration files. For details about logging
|
||||
configuration files, see the Python logging module documentation.
|
||||
Note that when logging configuration files are used then all logging
|
||||
configuration is set in the configuration file and other logging
|
||||
configuration options are ignored (for example,
|
||||
``logging_context_format_string``).
|
||||
|
||||
``--log-date-format DATE_FORMAT``
|
||||
Format string for %(asctime)s in log records. Default: None.
|
||||
This option is ignored if ``log_config_append`` is set.
|
||||
|
||||
``--log-dir LOG_DIR, --logdir LOG_DIR``
|
||||
(Optional) The base directory used for relative ``log-file`` paths.
|
||||
This option is ignored if ``log_config_append`` is set.
|
||||
|
||||
``--log-file PATH, --logfile PATH``
|
||||
(Optional) Name of log file to output to. If no default is set,
|
||||
logging will go to stderr as defined by ``use_stderr``.
|
||||
This option is ignored if ``log_config_append`` is set.
|
||||
|
||||
``--noarp_header_match``
|
||||
The inverse of --arp_header_match
|
||||
|
||||
``--noarp_responder``
|
||||
The inverse of --arp_responder
|
||||
|
||||
``--nobridge_firewalling``
|
||||
The inverse of --bridge_firewalling
|
||||
|
||||
``--nodebug``
|
||||
The inverse of --debug
|
||||
|
||||
``--nodhcp_release6``
|
||||
The inverse of --dhcp_release6
|
||||
|
||||
``--nodibbler_version``
|
||||
The inverse of --dibbler_version
|
||||
|
||||
``--nodnsmasq_version``
|
||||
The inverse of --dnsmasq_version
|
||||
|
||||
``--noebtables_installed``
|
||||
The inverse of --ebtables_installed
|
||||
|
||||
``--noicmpv6_header_match``
|
||||
The inverse of --icmpv6_header_match
|
||||
|
||||
``--noip6tables_installed``
|
||||
The inverse of --ip6tables_installed
|
||||
|
||||
``--noip_nonlocal_bind``
|
||||
The inverse of --ip_nonlocal_bind
|
||||
|
||||
``--noiproute2_vxlan``
|
||||
The inverse of --iproute2_vxlan
|
||||
|
||||
``--noipset_installed``
|
||||
The inverse of --ipset_installed
|
||||
|
||||
``--nokeepalived_ipv6_support``
|
||||
The inverse of --keepalived_ipv6_support
|
||||
|
||||
``--nonova_notify``
|
||||
The inverse of --nova_notify
|
||||
|
||||
``--noovs_conntrack``
|
||||
The inverse of --ovs_conntrack
|
||||
|
||||
``--noovs_geneve``
|
||||
The inverse of --ovs_geneve
|
||||
|
||||
``--noovs_patch``
|
||||
The inverse of --ovs_patch
|
||||
|
||||
``--noovs_vxlan``
|
||||
The inverse of --ovs_vxlan
|
||||
|
||||
``--noovsdb_native``
|
||||
The inverse of --ovsdb_native
|
||||
|
||||
``--noread_netns``
|
||||
The inverse of --read_netns
|
||||
|
||||
``--nouse-syslog``
|
||||
The inverse of --use-syslog
|
||||
|
||||
``--nova_notify``
|
||||
Check for nova notification support
|
||||
|
||||
``--noverbose``
|
||||
The inverse of --verbose
|
||||
|
||||
``--novf_extended_management``
|
||||
The inverse of --vf_extended_management
|
||||
|
||||
``--novf_management``
|
||||
The inverse of --vf_management
|
||||
|
||||
``--nowatch-log-file``
|
||||
The inverse of --watch-log-file
|
||||
|
||||
``--ovs_geneve``
|
||||
Check for OVS Geneve support
|
||||
|
||||
``--ovs_patch``
|
||||
Check for patch port support
|
||||
|
||||
``--ovs_vxlan``
|
||||
Check for OVS vxlan support
|
||||
|
||||
``--ovsdb_native``
|
||||
Check ovsdb native interface support
|
||||
|
||||
``--read_netns``
|
||||
Check netns permission settings
|
||||
|
||||
``--state_path STATE_PATH``
|
||||
Where to store Neutron state files. This directory must be writable
|
||||
by the agent.
|
||||
|
||||
``--syslog-log-facility SYSLOG_LOG_FACILITY``
|
||||
Syslog facility to receive log lines.
|
||||
This option is ignored if ``log_config_append`` is set.
|
||||
|
||||
``--use-syslog``
|
||||
Use syslog for logging. Existing syslog format is
|
||||
**DEPRECATED** and will be changed later to honor RFC5424.
|
||||
This option is ignored if ``log_config_append`` is set.
|
||||
|
||||
``--verbose, -v``
|
||||
If set to ``false``, the logging level will be set to
|
||||
``WARNING`` instead of the default ``INFO`` level.
|
||||
|
||||
``--version``
|
||||
show program's version number and exit
|
||||
|
||||
``--vf_extended_management``
|
||||
Check for VF extended management support
|
||||
|
||||
``--vf_management``
|
||||
Check for VF management support
|
||||
|
||||
``--watch-log-file``
|
||||
Uses logging handler designed to watch file system.
|
||||
When log file is moved or removed this handler will open a new log
|
||||
file with specified path instantaneously. It makes sense only if
|
||||
``log_file`` option is specified and Linux platform is used.
|
||||
This option is ignored if ``log_config_append`` is set.
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,411 +0,0 @@
|
||||
.. ###################################################
|
||||
.. ## WARNING ######################################
|
||||
.. ############## WARNING ##########################
|
||||
.. ########################## WARNING ##############
|
||||
.. ###################################### WARNING ##
|
||||
.. ###################################################
|
||||
.. ###################################################
|
||||
.. ##
|
||||
.. This file is tool-generated. Do not edit manually.
|
||||
.. http://docs.openstack.org/contributor-guide/
|
||||
.. doc-tools/cli-reference.html
|
||||
.. ##
|
||||
.. ## WARNING ######################################
|
||||
.. ############## WARNING ##########################
|
||||
.. ########################## WARNING ##############
|
||||
.. ###################################### WARNING ##
|
||||
.. ###################################################
|
||||
|
||||
===============================
|
||||
nova-manage command-line client
|
||||
===============================
|
||||
|
||||
The nova-manage client is the command-line interface (CLI) for
|
||||
Compute service management utility.
|
||||
|
||||
This chapter documents :command:`nova-manage` version ``13.0.0``.
|
||||
|
||||
For help on a specific :command:`nova-manage` command, enter:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ nova-manage COMMAND --help
|
||||
|
||||
.. _nova-manage_command_usage:
|
||||
|
||||
nova-manage usage
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: nova-manage [-h] [--remote_debug-host REMOTE_DEBUG_HOST]
|
||||
[--remote_debug-port REMOTE_DEBUG_PORT] [--config-dir DIR]
|
||||
[--config-file PATH] [--debug] [--log-config-append PATH]
|
||||
[--log-date-format DATE_FORMAT] [--log-dir LOG_DIR]
|
||||
[--log-file PATH] [--nodebug] [--nouse-syslog]
|
||||
[--noverbose] [--nowatch-log-file]
|
||||
[--syslog-log-facility SYSLOG_LOG_FACILITY] [--use-syslog]
|
||||
[--verbose] [--version] [--watch-log-file]
|
||||
{version,bash-completion,project,account,shell,logs,
|
||||
service,cell_v2,db,vm,agent,cell,network,host,floating,
|
||||
fixed,vpn,api_db}
|
||||
...
|
||||
|
||||
.. _nova-manage_command_options:
|
||||
|
||||
nova-manage optional arguments
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--config-dir DIR``
|
||||
Path to a config directory to pull ``*.conf`` files from.
|
||||
This file set is sorted, so as to provide a
|
||||
predictable parse order if individual options are
|
||||
over-ridden. The set is parsed after the file(s)
|
||||
specified via previous --config-file, arguments hence
|
||||
over-ridden options in the directory take precedence.
|
||||
|
||||
``--config-file PATH``
|
||||
Path to a config file to use. Multiple config files
|
||||
can be specified, with values in later files taking
|
||||
precedence. Defaults to None.
|
||||
|
||||
``--debug, -d``
|
||||
If set to true, the logging level will be set to DEBUG
|
||||
instead of the default INFO level.
|
||||
|
||||
``--log-config-append PATH, --log_config PATH``
|
||||
The name of a logging configuration file. This file is
|
||||
appended to any existing logging configuration files.
|
||||
For details about logging configuration files, see the
|
||||
Python logging module documentation. Note that when
|
||||
logging configuration files are used then all logging
|
||||
configuration is set in the configuration file and
|
||||
other logging configuration options are ignored (for
|
||||
example, logging_context_format_string).
|
||||
|
||||
``--log-date-format DATE_FORMAT``
|
||||
Defines the format string for %(asctime)s in log
|
||||
records. Default: None . This option is ignored if
|
||||
log_config_append is set.
|
||||
|
||||
``--log-dir LOG_DIR, --logdir LOG_DIR``
|
||||
(Optional) The base directory used for relative
|
||||
log_file paths. This option is ignored if
|
||||
log_config_append is set.
|
||||
|
||||
``--log-file PATH, --logfile PATH``
|
||||
(Optional) Name of log file to send logging output to.
|
||||
If no default is set, logging will go to stderr as
|
||||
defined by use_stderr. This option is ignored if
|
||||
log_config_append is set.
|
||||
|
||||
``--nodebug``
|
||||
The inverse of --debug
|
||||
|
||||
``--nouse-syslog``
|
||||
The inverse of --use-syslog
|
||||
|
||||
``--noverbose``
|
||||
The inverse of --verbose
|
||||
|
||||
``--nowatch-log-file``
|
||||
The inverse of --watch-log-file
|
||||
|
||||
``--syslog-log-facility SYSLOG_LOG_FACILITY``
|
||||
Syslog facility to receive log lines. This option is
|
||||
ignored if log_config_append is set.
|
||||
|
||||
``--use-syslog``
|
||||
Use syslog for logging. Existing syslog format is
|
||||
**DEPRECATED** and will be changed later to honor RFC5424.
|
||||
This option is ignored if log_config_append is set.
|
||||
|
||||
``--verbose, -v``
|
||||
If set to false, the logging level will be set to
|
||||
WARNING instead of the default INFO level.
|
||||
|
||||
``--version``
|
||||
show program's version number and exit
|
||||
|
||||
``--watch-log-file``
|
||||
Uses logging handler designed to watch file system.
|
||||
When log file is moved or removed this handler will
|
||||
open a new log file with specified path
|
||||
instantaneously. It makes sense only if log_file
|
||||
option is specified and Linux platform is used. This
|
||||
option is ignored if log_config_append is set.
|
||||
|
||||
.. _nova-manage_account:
|
||||
|
||||
nova-manage account
|
||||
-------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: nova-manage account [-h] {quota,scrub} ...
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``{quota,scrub}``
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _nova-manage_agent:
|
||||
|
||||
nova-manage agent
|
||||
-----------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: nova-manage agent [-h] {create,delete,list,modify} ...
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``{create,delete,list,modify}``
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _nova-manage_api_db:
|
||||
|
||||
nova-manage api_db
|
||||
------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: nova-manage api_db [-h] {sync,version} ...
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``{sync,version}``
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _nova-manage_cell:
|
||||
|
||||
nova-manage cell
|
||||
----------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: nova-manage cell [-h] {create,delete,list} ...
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``{create,delete,list}``
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _nova-manage_cell_v2:
|
||||
|
||||
nova-manage cell_v2
|
||||
-------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: nova-manage cell_v2 [-h] {map_cell_and_hosts,map_instances} ...
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``{map_cell_and_hosts,map_instances}``
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _nova-manage_db:
|
||||
|
||||
nova-manage db
|
||||
--------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: nova-manage db [-h]
|
||||
{archive_deleted_rows,null_instance_uuid_scan,online_data_migrations,sync,version}
|
||||
...
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``{archive_deleted_rows,null_instance_uuid_scan,online_data_migrations,sync,version}``
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _nova-manage_fixed:
|
||||
|
||||
nova-manage fixed
|
||||
-----------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: nova-manage fixed [-h] {list,reserve,unreserve} ...
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``{list,reserve,unreserve}``
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _nova-manage_floating:
|
||||
|
||||
nova-manage floating
|
||||
--------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: nova-manage floating [-h] {address_to_hosts,create,delete,list} ...
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``{address_to_hosts,create,delete,list}``
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _nova-manage_host:
|
||||
|
||||
nova-manage host
|
||||
----------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: nova-manage host [-h] {list} ...
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``{list}``
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _nova-manage_logs:
|
||||
|
||||
nova-manage logs
|
||||
----------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: nova-manage logs [-h] {errors,syslog} ...
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``{errors,syslog}``
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _nova-manage_network:
|
||||
|
||||
nova-manage network
|
||||
-------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: nova-manage network [-h] {create,delete,list,modify} ...
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``{create,delete,list,modify}``
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _nova-manage_project:
|
||||
|
||||
nova-manage project
|
||||
-------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: nova-manage project [-h] {quota,scrub} ...
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``{quota,scrub}``
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _nova-manage_shell:
|
||||
|
||||
nova-manage shell
|
||||
-----------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: nova-manage shell [-h] {bpython,ipython,python,run,script} ...
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``{bpython,ipython,python,run,script}``
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _nova-manage_vm:
|
||||
|
||||
nova-manage vm
|
||||
--------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: nova-manage vm [-h] {list} ...
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``{list}``
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _nova-manage_vpn:
|
||||
|
||||
nova-manage vpn
|
||||
---------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: nova-manage vpn [-h] {change} ...
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``{change}``
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -1,110 +0,0 @@
|
||||
.. This file is manually generated, unlike many of the other chapters.
|
||||
|
||||
=============================================================================
|
||||
Software Development Lifecycle Automation service (solum) command-line client
|
||||
=============================================================================
|
||||
|
||||
The solum client is the command-line interface (CLI) for
|
||||
the Software Development Lifecycle Automation service (solum) API and its
|
||||
extensions.
|
||||
|
||||
This chapter documents :command:`solum` version ``2.4.0``.
|
||||
|
||||
.. _solum_command_usage:
|
||||
|
||||
solum usage
|
||||
~~~~~~~~~~~
|
||||
|
||||
``solum help``
|
||||
Show this help message.
|
||||
|
||||
``solum info``
|
||||
Show Solum endpoint and API release version.
|
||||
|
||||
``solum --version``
|
||||
Show current Solum client version and exit.
|
||||
|
||||
``solum lp help``
|
||||
Show a help message specific to languagepack commands.
|
||||
|
||||
``solum lp create <NAME> <GIT_REPO_URL>``
|
||||
Create a new language pack from a git repo.
|
||||
|
||||
``solum lp list``
|
||||
Print and index of all available language packs.
|
||||
|
||||
``solum lp show <NAME|UUID>``
|
||||
Print the details of a language pack.
|
||||
|
||||
``solum lp delete <NAME|UUID>``
|
||||
Destroy a language pack.
|
||||
|
||||
``solum lp logs <NAME|UUID>``
|
||||
Show logs for a language pack.
|
||||
|
||||
``solum app help``
|
||||
Show a help message specific to app commands.
|
||||
|
||||
``solum app list``
|
||||
Print an index of all deployed applications.
|
||||
|
||||
``solum app show <NAME|UUID>``
|
||||
Print detailed information about one application.
|
||||
|
||||
``solum app create``
|
||||
Register a new application with Solum.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
solum app create [--app-file <AppFile>] [--git-url <GIT_URL>]
|
||||
[--lp <LANGUAGEPACK>]
|
||||
[--param-file <PARAMFILE>]
|
||||
[--setup-trigger]
|
||||
[--trigger-workflow <CUSTOM-WORKFLOW>]
|
||||
<CUSTOM-WORKFLOW>=(unittest | build | unittest+build)
|
||||
|
||||
Without the ``--trigger-workflow`` flag, the workflow ``unittest+build+deploy``
|
||||
is triggered (this is the default workflow).
|
||||
|
||||
``solum app deploy <NAME|UUID>``
|
||||
Deploy an application, building any applicable artifacts first.
|
||||
du-id is optional flag. It can be used to pass in ID of a previously
|
||||
created deployment unit. If passed, this command will deploy the du
|
||||
referenced by the provided ``du-id`` instead of building one first.
|
||||
|
||||
``solum app delete <NAME|UUID>``
|
||||
Delete an application and all related artifacts.
|
||||
|
||||
``solum app logs <NAME|UUID> [--wf-id <wf-id>]``
|
||||
Show the logs of an application for all the workflows.
|
||||
``wf-id`` is optional flag which can be used to pass in ID of one of
|
||||
the existing workflows. If provided, the logs only for that workflow
|
||||
are displayed.
|
||||
|
||||
``solum app scale <APP_NAME|UUID> <target>``
|
||||
|
||||
``solum workflow list <APP_NAME|UUID>``
|
||||
List all application workflows.
|
||||
|
||||
``solum workflow show <APP_NAME|UUID> <WORKFLOW_ID|UUID>``
|
||||
Print the details of a workflow.
|
||||
|
||||
``solum workflow logs <APP_NAME|UUID> <WORKFLOW_ID|UUID>``
|
||||
List all the logs of a given workflow.
|
||||
|
||||
**SOON TO BE DEPRECATED:**
|
||||
|
||||
``solum oldapp create``
|
||||
Register a new application with Solum.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
solum oldapp create [--plan-file <PLANFILE>] [--git-url <GIT_URL>]
|
||||
[--lp <LANGUAGEPACK>] [--run-cmd <RUN_CMD>]
|
||||
[--unittest-cmd <UNITTEST_CMD>]
|
||||
[--name <NAME>] [--port <PORT>]
|
||||
[--param-file <PARAMFILE>]
|
||||
[--desc <DESCRIPTION>]
|
||||
[--setup-trigger]
|
||||
[--private-repo]
|
||||
[--trigger-workflow <WORKFLOW>]
|
||||
@ -1,641 +0,0 @@
|
||||
.. ## WARNING #####################################
|
||||
.. This file is tool-generated. Do not edit manually.
|
||||
.. Because of a tool bug, temporary edited manually.
|
||||
.. ##################################################
|
||||
|
||||
==================================================
|
||||
Object Storage service (swift) command-line client
|
||||
==================================================
|
||||
|
||||
The swift client is the command-line interface (CLI) for
|
||||
the Object Storage service API and its extensions.
|
||||
|
||||
This chapter documents :command:`swift` version ``3.3.0``.
|
||||
|
||||
For help on a specific :command:`swift` command, enter:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ swift COMMAND --help
|
||||
|
||||
.. _swift_command_usage:
|
||||
|
||||
swift usage
|
||||
~~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
Usage: swift [--version] [--help] [--os-help] [--snet] [--verbose]
|
||||
[--debug] [--info] [--quiet] [--auth <auth_url>]
|
||||
[--auth-version <auth_version> |
|
||||
--os-identity-api-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]
|
||||
[--os-cert <client-certificate-file>]
|
||||
[--os-key <client-certificate-key-file>]
|
||||
[--no-ssl-compression]
|
||||
<subcommand> [--help] [<subcommand options>]
|
||||
|
||||
**Subcommands:**
|
||||
|
||||
``delete``
|
||||
Delete a container or objects within a container.
|
||||
|
||||
``download``
|
||||
Download objects from containers.
|
||||
|
||||
``list``
|
||||
Lists the containers for the account or the objects
|
||||
for a container.
|
||||
|
||||
``post``
|
||||
Updates meta information for the account, container,
|
||||
or object; creates containers if not present.
|
||||
|
||||
``copy``
|
||||
Copies object, optionally adds meta
|
||||
|
||||
``stat``
|
||||
Displays information for the account, container,
|
||||
or object.
|
||||
|
||||
``upload``
|
||||
Uploads files or directories to the given container.
|
||||
|
||||
``capabilities``
|
||||
List cluster capabilities.
|
||||
|
||||
``tempurl``
|
||||
Create a temporary URL.
|
||||
|
||||
``auth``
|
||||
Display auth related environment variables.
|
||||
|
||||
.. _swift_examples:
|
||||
|
||||
swift examples
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
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
|
||||
|
||||
.. _swift_command_options:
|
||||
|
||||
swift optional arguments
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
``--version``
|
||||
show program's version number and exit
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--os-help``
|
||||
Show OpenStack authentication options.
|
||||
|
||||
``-s, --snet``
|
||||
Use SERVICENET internal network.
|
||||
|
||||
``-v, --verbose``
|
||||
Print more info.
|
||||
|
||||
``--debug``
|
||||
Show the curl commands and results of all http queries
|
||||
regardless of result status.
|
||||
|
||||
``--info``
|
||||
Show the curl commands and results of all http queries
|
||||
which return an error.
|
||||
|
||||
``-q, --quiet``
|
||||
Suppress status output.
|
||||
|
||||
``-A AUTH, --auth=AUTH``
|
||||
URL for obtaining an auth token.
|
||||
|
||||
``-V AUTH_VERSION, --auth-version=AUTH_VERSION, --os-identity-api-version=AUTH_VERSION``
|
||||
Specify a version for authentication. Defaults to
|
||||
``env[ST_AUTH_VERSION]``, ``env[OS_AUTH_VERSION]``,
|
||||
``env[OS_IDENTITY_API_VERSION]`` or 1.0.
|
||||
|
||||
``-U USER, --user=USER``
|
||||
User name for obtaining an auth token.
|
||||
|
||||
``-K KEY, --key=KEY``
|
||||
Key for obtaining an auth token.
|
||||
|
||||
``-R RETRIES, --retries=RETRIES``
|
||||
The number of times to retry a failed connection.
|
||||
|
||||
``--insecure``
|
||||
Allow swiftclient to access servers without having to
|
||||
verify the SSL certificate. Defaults to
|
||||
``env[SWIFTCLIENT_INSECURE]`` (set to 'true' to enable).
|
||||
|
||||
``--no-ssl-compression``
|
||||
This option is deprecated and not used anymore. SSL
|
||||
compression should be disabled by default by the
|
||||
system SSL library.
|
||||
|
||||
.. _swift_auth:
|
||||
|
||||
swift auth
|
||||
----------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
Usage: swift auth
|
||||
|
||||
Display auth related authentication variables in shell friendly format.
|
||||
|
||||
Commands to run to export storage url and auth token into
|
||||
``OS_STORAGE_URL`` and ``OS_AUTH_TOKEN``:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ swift auth
|
||||
|
||||
Commands to append to a runcom file (e.g. ~/.bashrc, /etc/profile) for
|
||||
automatic authentication:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ swift auth -v -U test:tester -K testing -A http://localhost:8080/auth/v1.0
|
||||
|
||||
.. _swift_capabilities:
|
||||
|
||||
swift capabilities
|
||||
------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
Usage: swift capabilities [--json] [<proxy_url>]
|
||||
|
||||
Retrieve capability of the proxy.
|
||||
|
||||
**Optional positional arguments:**
|
||||
|
||||
``<proxy_url>``
|
||||
Proxy URL of the cluster to retrieve capabilities.
|
||||
|
||||
``--json``
|
||||
Print the cluster capabilities in JSON format.
|
||||
|
||||
.. _swift_copy:
|
||||
|
||||
swift copy
|
||||
----------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
Usage: swift copy [--destination </container/object>] [--fresh-metadata]
|
||||
[--meta <name:value>] [--header <header>] <container>
|
||||
<object> [<object>] [...]
|
||||
|
||||
Copies object to new destination, optionally updates objects metadata.
|
||||
If destination is not set, will update metadata of object
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<container>``
|
||||
Name of container to copy from.
|
||||
|
||||
``<object>``
|
||||
Name of object to copy. Specify multiple times for multiple objects
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-d, --destination </container[/object]>``
|
||||
The container and name of the destination object. Name
|
||||
of destination object can be omitted, then will be
|
||||
same as name of source object. Supplying multiple
|
||||
objects and destination with object name is invalid.
|
||||
|
||||
``-M, --fresh-metadata``
|
||||
Copy the object without any existing metadata,
|
||||
If not set, metadata will be preserved or appended
|
||||
|
||||
``-m, --meta <name:value>``
|
||||
Sets a meta data item. This option may be repeated.
|
||||
|
||||
Example: -m Color:Blue -m Size:Large
|
||||
|
||||
``-H, --header <header:value>``
|
||||
Adds a customized request header. This option may be repeated.
|
||||
|
||||
Example: -H "content-type:text/plain" -H "Content-Length: 4000"
|
||||
|
||||
.. _swift_delete:
|
||||
|
||||
swift delete
|
||||
------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
Usage: swift delete [--all] [--leave-segments]
|
||||
[--object-threads <threads>]
|
||||
[--container-threads <threads>]
|
||||
[--header <header:value>]
|
||||
[<container> [<object>] [...]]
|
||||
|
||||
Delete a container or objects within a container.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``[<container>]``
|
||||
Name of container to delete from.
|
||||
|
||||
``[<object>]``
|
||||
Name of object to delete. Specify multiple times
|
||||
for multiple objects.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-a, --all``
|
||||
Delete all containers and objects.
|
||||
|
||||
``--leave-segments``
|
||||
Do not delete segments of manifest objects.
|
||||
|
||||
``-H, --header <header:value>``
|
||||
Adds a custom request header to use for deleting
|
||||
objects or an entire container.
|
||||
|
||||
|
||||
``--object-threads <threads>``
|
||||
Number of threads to use for deleting objects.
|
||||
Default is 10.
|
||||
|
||||
``--container-threads <threads>``
|
||||
Number of threads to use for deleting containers.
|
||||
Default is 10.
|
||||
|
||||
.. _swift_download:
|
||||
|
||||
swift download
|
||||
--------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
Usage: swift download [--all] [--marker <marker>] [--prefix <prefix>]
|
||||
[--output <out_file>] [--output-dir <out_directory>]
|
||||
[--object-threads <threads>] [--ignore-checksum]
|
||||
[--container-threads <threads>] [--no-download]
|
||||
[--skip-identical] [--remove-prefix]
|
||||
[--header <header:value>] [--no-shuffle]
|
||||
[<container> [<object>] [...]]
|
||||
|
||||
Download objects from containers.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<container>``
|
||||
Name of container to download from. To download a
|
||||
whole account, omit this and specify --all.
|
||||
|
||||
``<object>``
|
||||
Name of object to download. Specify multiple times
|
||||
for multiple objects. Omit this to download all
|
||||
objects from the container.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-a, --all``
|
||||
Indicates that you really want to download
|
||||
everything in the account.
|
||||
|
||||
``-m, --marker <marker>``
|
||||
Marker to use when starting a container or account
|
||||
download.
|
||||
|
||||
``-p, --prefix <prefix>``
|
||||
Only download items beginning with <prefix>
|
||||
|
||||
``-r, --remove-prefix``
|
||||
An optional flag for --prefix <prefix>, use this
|
||||
option to download items without <prefix>
|
||||
|
||||
``-o, --output <out_file>``
|
||||
For a single file download, stream the output to
|
||||
<out_file>. Specifying "-" as <out_file> will
|
||||
redirect to stdout.
|
||||
|
||||
``-D, --output-dir <out_directory>``
|
||||
An optional directory to which to store objects.
|
||||
By default, all objects are recreated in the current
|
||||
directory.
|
||||
|
||||
``--object-threads <threads>``
|
||||
Number of threads to use for downloading objects.
|
||||
Default is 10.
|
||||
|
||||
``--container-threads <threads>``
|
||||
Number of threads to use for downloading containers.
|
||||
Default is 10.
|
||||
|
||||
``--no-download``
|
||||
Perform download(s), but don't actually write anything
|
||||
to disk.
|
||||
|
||||
``-H, --header <header:value>``
|
||||
Adds a customized request header to the query, like
|
||||
"Range" or "If-Match". This option may be repeated.
|
||||
|
||||
Example: --header "content-type:text/plain"
|
||||
|
||||
``--skip-identical``
|
||||
Skip downloading files that are identical on both
|
||||
sides.
|
||||
|
||||
``--ignore-checksum``
|
||||
Turn off checksum validation for downloads.
|
||||
|
||||
``--no-shuffle``
|
||||
By default, when downloading a complete account or
|
||||
container, download order is randomised in order to
|
||||
reduce the load on individual drives when multiple
|
||||
clients are executed simultaneously to download the
|
||||
same set of objects (e.g. a nightly automated download
|
||||
script to multiple servers). Enable this option to
|
||||
submit download jobs to the thread pool in the order
|
||||
they are listed in the object store.
|
||||
|
||||
.. _swift_list:
|
||||
|
||||
swift list
|
||||
----------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
Usage: swift list [--long] [--lh] [--totals] [--prefix <prefix>]
|
||||
[--delimiter <delimiter>] [--header <header:value>]
|
||||
[<container>]
|
||||
|
||||
Lists the containers for the account or the objects for a container.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``[container]``
|
||||
Name of container to list object in.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-l, --long``
|
||||
Long listing format, similar to ls -l.
|
||||
|
||||
``--lh``
|
||||
Report sizes in human readable format similar to
|
||||
ls -lh.
|
||||
|
||||
``-t, --totals``
|
||||
Used with -l or --lh, only report totals.
|
||||
|
||||
``-p <prefix>, --prefix <prefix>``
|
||||
Only list items beginning with the prefix.
|
||||
|
||||
``-d <delim>, --delimiter <delim>``
|
||||
Roll up items with the given delimiter. For containers
|
||||
only. See OpenStack Swift API documentation for what
|
||||
this means.
|
||||
|
||||
``-H, --header <header:value>``
|
||||
Adds a custom request header to use for listing.
|
||||
|
||||
.. _swift_post:
|
||||
|
||||
swift post
|
||||
----------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
Usage: swift post [--read-acl <acl>] [--write-acl <acl>] [--sync-to]
|
||||
[--sync-key <sync-key>] [--meta <name:value>]
|
||||
[--header <header>]
|
||||
[<container> [<object>]]
|
||||
|
||||
Updates meta information for the account, container, or object.
|
||||
If the container is not found, it will be created automatically.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``[container]``
|
||||
Name of container to post to.
|
||||
|
||||
``[object]``
|
||||
Name of object to post.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-r, --read-acl <acl>``
|
||||
Read ACL for containers. Quick summary of ACL syntax:
|
||||
``.r:*``, ``.r:-.example.com``, ``.r:www.example.com``,
|
||||
``account1`` (v1.0 identity API only),
|
||||
``account1:*``, ``account2:user2`` (v2.0+ identity API).
|
||||
|
||||
``-w, --write-acl <acl>``
|
||||
Write ACL for containers. Quick summary of ACL syntax:
|
||||
``account1`` (v1.0 identity API only),
|
||||
``account1:*``, ``account2:user2`` (v2.0+ identity API).
|
||||
|
||||
``-t, --sync-to <sync-to>``
|
||||
Sync To for containers, for multi-cluster replication.
|
||||
|
||||
``-k, --sync-key <sync-key>``
|
||||
Sync Key for containers, for multi-cluster replication.
|
||||
|
||||
``-m, --meta <name:value>``
|
||||
Sets a meta data item. This option may be repeated.
|
||||
|
||||
Example: -m Color:Blue -m Size:Large
|
||||
|
||||
``-H, --header <header:value>``
|
||||
Adds a customized request header.
|
||||
This option may be repeated.
|
||||
|
||||
Example: -H "content-type:text/plain" -H "Content-Length: 4000"
|
||||
|
||||
.. _swift_stat:
|
||||
|
||||
swift stat
|
||||
----------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
Usage: swift stat [--lh] [--header <header:value>]
|
||||
[<container> [<object>]]
|
||||
|
||||
Displays information for the account, container, or object.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``[container]``
|
||||
Name of container to stat from.
|
||||
|
||||
``[object]``
|
||||
Name of object to stat.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``--lh``
|
||||
Report sizes in human readable format similar to
|
||||
ls -lh.
|
||||
|
||||
``-H, --header <header:value>``
|
||||
Adds a custom request header to use for stat.
|
||||
|
||||
.. _swift_tempurl:
|
||||
|
||||
swift tempurl
|
||||
-------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
Usage: swift tempurl [--absolute] [--prefix-based]
|
||||
<method> <seconds> <path> <key>
|
||||
|
||||
Generates a temporary URL for a Swift object.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<method>``
|
||||
An HTTP method to allow for this temporary URL.
|
||||
Usually 'GET' or 'PUT'.
|
||||
|
||||
``<seconds>``
|
||||
The amount of time in seconds the temporary URL will be
|
||||
valid for; or, if --absolute is passed, the Unix
|
||||
timestamp when the temporary URL will expire.
|
||||
|
||||
``<path>``
|
||||
The full path to the Swift object.
|
||||
|
||||
Example: /v1/AUTH_account/c/o
|
||||
or: http://saio:8080/v1/AUTH_account/c/o
|
||||
|
||||
``<key>``
|
||||
The secret temporary URL key set on the Swift cluster.
|
||||
To set a key, run 'swift post -m
|
||||
"Temp-URL-Key:b3968d0207b54ece87cccc06515a89d4"'
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``--absolute``
|
||||
Interpret the <seconds> positional argument as a Unix
|
||||
timestamp rather than a number of seconds in the
|
||||
future.
|
||||
|
||||
``--prefix-based``
|
||||
If present, a prefix-based tempURL will be generated.
|
||||
|
||||
.. _swift_upload:
|
||||
|
||||
swift upload
|
||||
------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
Usage: swift upload [--changed] [--skip-identical] [--segment-size <size>]
|
||||
[--segment-container <container>] [--leave-segments]
|
||||
[--object-threads <thread>] [--segment-threads <threads>]
|
||||
[--header <header>] [--use-slo] [--ignore-checksum]
|
||||
[--object-name <object-name>]
|
||||
<container> <file_or_directory> [<file_or_directory>] [...]
|
||||
|
||||
Uploads specified files and directories to the given container.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<container>``
|
||||
Name of container to upload to.
|
||||
|
||||
``<file_or_directory>``
|
||||
Name of file or directory to upload. Specify multiple
|
||||
times for multiple uploads.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-c, --changed``
|
||||
Only upload files that have changed since the last
|
||||
upload.
|
||||
|
||||
``--skip-identical``
|
||||
Skip uploading files that are identical on both sides.
|
||||
|
||||
``-S, --segment-size <size>``
|
||||
Upload files in segments no larger than <size> (in
|
||||
Bytes) and then create a "manifest" file that will
|
||||
download all the segments as if it were the original
|
||||
file.
|
||||
|
||||
``--segment-container <container>``
|
||||
Upload the segments into the specified container. If
|
||||
not specified, the segments will be uploaded to a
|
||||
<container>_segments container to not pollute the
|
||||
main <container> listings.
|
||||
|
||||
``--leave-segments``
|
||||
Indicates that you want the older segments of manifest
|
||||
objects left alone (in the case of overwrites).
|
||||
|
||||
``--object-threads <threads>``
|
||||
Number of threads to use for uploading full objects.
|
||||
Default is 10.
|
||||
|
||||
``--segment-threads <threads>``
|
||||
Number of threads to use for uploading object segments.
|
||||
Default is 10.
|
||||
|
||||
``-H, --header <header:value>``
|
||||
Adds a customized request header. This option may be
|
||||
repeated. Example: -H "content-type:text/plain"
|
||||
-H "Content-Length: 4000".
|
||||
|
||||
``--use-slo``
|
||||
When used in conjunction with --segment-size it will
|
||||
create a Static Large Object instead of the default
|
||||
Dynamic Large Object.
|
||||
|
||||
``--object-name <object-name>``
|
||||
Upload file and name object to <object-name> or upload
|
||||
dir and use <object-name> as object prefix instead of
|
||||
folder name.
|
||||
|
||||
``--ignore-checksum``
|
||||
Turn off checksum validation for uploads.
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,340 +0,0 @@
|
||||
.. This file is manually generated, unlike many of the other chapters.
|
||||
|
||||
================================
|
||||
trove-manage command-line client
|
||||
================================
|
||||
|
||||
The :command:`trove-manage` client is the command-line interface (CLI)
|
||||
for the Database Management Utility API and its extensions.
|
||||
|
||||
This chapter documents :command:`trove-manage` version ``5.0.1``.
|
||||
|
||||
For help on a specific :command:`trove-manage` command, enter:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ trove-manage COMMAND --help
|
||||
|
||||
.. _trove-manage_command_usage:
|
||||
|
||||
trove-manage usage
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
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] [--nodebug]
|
||||
[--nouse-syslog] [--noverbose] [--nowatch-log-file]
|
||||
[--syslog-log-facility SYSLOG_LOG_FACILITY] [--use-syslog]
|
||||
[--verbose] [--version] [--watch-log-file]
|
||||
|
||||
{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}
|
||||
...
|
||||
|
||||
.. _trove-manage_command_options:
|
||||
|
||||
trove-manage optional arguments
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--config-dir DIR``
|
||||
Path to a config directory to pull ``*.conf`` files from.
|
||||
This file set is sorted, so as to provide a predictable parse order
|
||||
if individual options are over-ridden. The set is parsed after
|
||||
the file(s) specified via previous --config-file,
|
||||
arguments hence over-ridden options in the directory take precedence.
|
||||
|
||||
``--config-file PATH``
|
||||
Path to a config file to use. Multiple config files can be specified,
|
||||
with values in later files taking precedence.
|
||||
The default files used are: ``None``.
|
||||
|
||||
``--debug, -d``
|
||||
Print debugging output (set logging level to ``DEBUG``
|
||||
instead of default ``INFO`` level).
|
||||
|
||||
``--log-config-append PATH, --log_config PATH``
|
||||
The name of a logging configuration file.
|
||||
This file is appended to any existing logging configuration files.
|
||||
For details about logging configuration files, see the Python logging
|
||||
module documentation. Note that when logging configuration files are
|
||||
used then all logging configuration is set in the configuration file
|
||||
and other logging configuration options are ignored (for example,
|
||||
``logging_context_format_string``).
|
||||
|
||||
``--log-date-format DATE_FORMAT``
|
||||
Format string for ``%(asctime)s`` in log records. Default: ``None``.
|
||||
This option is ignored if ``log_config_append`` is set.
|
||||
|
||||
``--log-dir LOG_DIR, --logdir LOG_DIR``
|
||||
(Optional) The base directory used for relative ``--log-file`` paths.
|
||||
This option is ignored if ``log_config_append`` is set.
|
||||
|
||||
``--log-file PATH, --logfile PATH``
|
||||
(Optional) Name of log file to send logging output to. If no default
|
||||
is set, logging will go to stderr as defined by ``use_stderr``.
|
||||
This option is ignored if ``log_config_append`` is set.
|
||||
|
||||
``--nodebug``
|
||||
The inverse of --debug
|
||||
|
||||
``--nouse-syslog``
|
||||
The inverse of --use-syslog
|
||||
|
||||
``--nouse-syslog-rfc-format``
|
||||
The inverse of --use-syslog-rfc-format
|
||||
|
||||
``--noverbose``
|
||||
The inverse of --verbose
|
||||
|
||||
``--syslog-log-facility SYSLOG_LOG_FACILITY``
|
||||
Syslog facility to receive log lines.
|
||||
This option is ignored if ``log_config_append`` is set.
|
||||
|
||||
``--use-syslog``
|
||||
Use syslog for logging. Existing syslog format is
|
||||
**DEPRECATED** and will be changed later to honor RFC5424.
|
||||
This option is ignored if ``log_config_append`` is set.
|
||||
|
||||
``--verbose, -v``
|
||||
If set to false, the logging level will be set to ``WARNING``
|
||||
instead of the default ``INFO`` level.
|
||||
|
||||
``--version``
|
||||
show program's version number and exit
|
||||
|
||||
``--watch-log-file``
|
||||
Uses logging handler designed to watch file system.
|
||||
When log file is moved or removed this handler will open a new log
|
||||
file with specified path instantaneously. It makes sense only if
|
||||
``log_file`` option is specified and Linux platform is used.
|
||||
This option is ignored if ``log_config_append`` is set.
|
||||
|
||||
trove-manage datastore_update
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: trove-manage datastore_update [-h] datastore_name default_version
|
||||
|
||||
Add or update a datastore.
|
||||
If the datastore already exists, the default version will be updated.
|
||||
|
||||
**positional arguments:**
|
||||
|
||||
``datastore_name``
|
||||
Name of the datastore.
|
||||
|
||||
``default_version``
|
||||
Name or ID of an existing datastore version to set as the default.
|
||||
When adding a new datastore, use an empty string.
|
||||
|
||||
**optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
trove-manage datastore_version_flavor_add
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: trove-manage datastore_version_flavor_add [-h]
|
||||
datastore_name
|
||||
datastore_version_name
|
||||
flavor_ids
|
||||
|
||||
**positional arguments:**
|
||||
|
||||
``datastore_name``
|
||||
Name of the datastore.
|
||||
|
||||
``datastore_version_name``
|
||||
Name of the datastore version.
|
||||
|
||||
``flavor_ids``
|
||||
Comma separated list of flavor ids.
|
||||
|
||||
**optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
trove-manage datastore_version_flavor_delete
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: trove-manage datastore_version_flavor_delete [-h]
|
||||
datastore_name
|
||||
datastore_version_name
|
||||
flavor_id
|
||||
|
||||
**positional arguments:**
|
||||
|
||||
``datastore_name``
|
||||
Name of the datastore.
|
||||
|
||||
``datastore_version_name``
|
||||
Name of the datastore version.
|
||||
|
||||
``flavor_id``
|
||||
The flavor to be deleted for a given datastore and datastore version.
|
||||
|
||||
**optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
trove-manage datastore_version_update
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: trove-manage datastore_version_update [-h]
|
||||
datastore version_name manager
|
||||
image_id packages active
|
||||
|
||||
Add or update a datastore version. If the datastore version already exists,
|
||||
all values except the datastore name and version will be updated.
|
||||
|
||||
**positional arguments:**
|
||||
|
||||
``datastore``
|
||||
Name of the datastore.
|
||||
|
||||
``version_name``
|
||||
Name of the datastore version.
|
||||
|
||||
``manager``
|
||||
Name of the manager that will administer the datastore version.
|
||||
|
||||
``image_id``
|
||||
ID of the image used to create an instance of the datastore version.
|
||||
|
||||
``packages``
|
||||
Packages required by the datastore version that are installed on
|
||||
the guest image.
|
||||
|
||||
``active``
|
||||
Whether the datastore version is active or not.
|
||||
Accepted values are ``0`` and ``1``.
|
||||
|
||||
**optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
trove-manage db_downgrade
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: trove-manage db_downgrade [-h] [--repo_path REPO_PATH] version
|
||||
|
||||
Downgrade the database to the specified version.
|
||||
|
||||
**positional arguments:**
|
||||
|
||||
``version``
|
||||
Target version.
|
||||
|
||||
**optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--repo_path REPO_PATH``
|
||||
SQLAlchemy Migrate repository path.
|
||||
|
||||
trove-manage db_load_datastore_config_parameters
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: trove-manage db_load_datastore_config_parameters [-h]
|
||||
datastore
|
||||
datastore_version
|
||||
config_file_location
|
||||
|
||||
Loads configuration group parameter validation rules for a datastore version
|
||||
into the database.
|
||||
|
||||
**positional arguments:**
|
||||
|
||||
``datastore``
|
||||
Name of the datastore.
|
||||
|
||||
``datastore_version``
|
||||
Name of the datastore version.
|
||||
|
||||
``config_file_location``
|
||||
Fully qualified file path to the configuration group
|
||||
parameter validation rules.
|
||||
|
||||
**optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
trove-manage db_recreate
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: trove-manage db_recreate [-h] [--repo_path REPO_PATH]
|
||||
|
||||
Drop the database and recreate it.
|
||||
|
||||
**optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--repo_path REPO_PATH``
|
||||
SQLAlchemy Migrate repository path.
|
||||
|
||||
trove-manage db_sync
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: trove-manage db_sync [-h] [--repo_path REPO_PATH]
|
||||
|
||||
Populate the database structure
|
||||
|
||||
**optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--repo_path REPO_PATH``
|
||||
SQLAlchemy Migrate repository path.
|
||||
|
||||
trove-manage db_upgrade
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: trove-manage db_upgrade [-h] [--version VERSION]
|
||||
[--repo_path REPO_PATH]
|
||||
|
||||
Upgrade the database to the specified version.
|
||||
|
||||
**optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--version VERSION``
|
||||
Target version. Defaults to the latest version.
|
||||
|
||||
``--repo_path REPO_PATH``
|
||||
SQLAlchemy Migrate repository path.
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,347 +0,0 @@
|
||||
.. ###################################################
|
||||
.. ## WARNING ######################################
|
||||
.. ############## WARNING ##########################
|
||||
.. ########################## WARNING ##############
|
||||
.. ###################################### WARNING ##
|
||||
.. ###################################################
|
||||
.. ###################################################
|
||||
.. ##
|
||||
.. This file is tool-generated. Do not edit manually.
|
||||
.. http://docs.openstack.org/contributor-guide/
|
||||
.. doc-tools/cli-reference.html
|
||||
.. ##
|
||||
.. ## WARNING ######################################
|
||||
.. ############## WARNING ##########################
|
||||
.. ########################## WARNING ##############
|
||||
.. ###################################### WARNING ##
|
||||
.. ###################################################
|
||||
|
||||
===============================================================
|
||||
RCA (Root Cause Analysis) service (vitrage) command-line client
|
||||
===============================================================
|
||||
|
||||
The vitrage client is the command-line interface (CLI) for
|
||||
the RCA (Root Cause Analysis) service (vitrage) API and its extensions.
|
||||
|
||||
This chapter documents :command:`vitrage` version ``1.2.0``.
|
||||
|
||||
For help on a specific :command:`vitrage` command, enter:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ vitrage help COMMAND
|
||||
|
||||
.. _vitrage_command_usage:
|
||||
|
||||
vitrage usage
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: vitrage [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]
|
||||
[--os-region-name <auth-region-name>]
|
||||
[--os-interface <interface>] [--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-default-domain-id OS_DEFAULT_DOMAIN_ID]
|
||||
[--os-default-domain-name OS_DEFAULT_DOMAIN_NAME]
|
||||
[--os-user-id OS_USER_ID] [--os-username OS_USERNAME]
|
||||
[--os-user-domain-id OS_USER_DOMAIN_ID]
|
||||
[--os-user-domain-name OS_USER_DOMAIN_NAME]
|
||||
[--os-password OS_PASSWORD]
|
||||
[--vitrage-api-version VITRAGE_API_VERSION]
|
||||
[--endpoint ENDPOINT]
|
||||
|
||||
.. _vitrage_command_options:
|
||||
|
||||
vitrage optional arguments
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
``--version``
|
||||
show program's version number and exit
|
||||
|
||||
``-v, --verbose``
|
||||
Increase verbosity of output. Can be repeated.
|
||||
|
||||
``-q, --quiet``
|
||||
Suppress output except warnings and errors.
|
||||
|
||||
``--log-file LOG_FILE``
|
||||
Specify a file to log output. Disabled by default.
|
||||
|
||||
``-h, --help``
|
||||
Show help message and exit.
|
||||
|
||||
``--debug``
|
||||
Show tracebacks on errors.
|
||||
|
||||
``--os-region-name <auth-region-name>``
|
||||
Authentication region name (Env: OS_REGION_NAME)
|
||||
|
||||
``--os-interface <interface>``
|
||||
Select an interface type. Valid interface types:
|
||||
[admin, public, internal]. (Env: OS_INTERFACE)
|
||||
|
||||
``--os-auth-type <name>, --os-auth-plugin <name>``
|
||||
Authentication type to use
|
||||
|
||||
``--vitrage-api-version VITRAGE_API_VERSION``
|
||||
Defaults to ``env[VITRAGE_API_VERSION]`` or 1.
|
||||
|
||||
``--endpoint ENDPOINT``
|
||||
Vitrage endpoint (Env: VITRAGE_ENDPOINT)
|
||||
|
||||
.. _vitrage_alarm_list:
|
||||
|
||||
vitrage alarm list
|
||||
------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: vitrage alarm list [-h] [-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>] [--print-empty]
|
||||
[--noindent] [--quote {all,minimal,none,nonnumeric}]
|
||||
[--all-tenants]
|
||||
[<vitrage id>]
|
||||
|
||||
List alarms on entity
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<vitrage id>``
|
||||
Vitrage id of the affected resource
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--all-tenants``
|
||||
Shows alarms of all the tenants in the entity graph
|
||||
|
||||
.. _vitrage_event_post:
|
||||
|
||||
vitrage event post
|
||||
------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: vitrage event post [-h] [--type TYPE] [--time TIME] [--details DETAILS]
|
||||
|
||||
Show the event of the system
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--type TYPE``
|
||||
The type of the event
|
||||
|
||||
``--time TIME``
|
||||
The
|
||||
timestamp
|
||||
of
|
||||
the
|
||||
event
|
||||
in
|
||||
ISO
|
||||
8601
|
||||
format:
|
||||
YYYY-MM-DDTHH:MM:SS.mmmmmm.
|
||||
If
|
||||
not
|
||||
specified,
|
||||
the
|
||||
current
|
||||
time
|
||||
is
|
||||
used
|
||||
|
||||
``--details DETAILS``
|
||||
A json string with the event details
|
||||
|
||||
.. _vitrage_rca_show:
|
||||
|
||||
vitrage rca show
|
||||
----------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: vitrage rca show [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>] [--print-empty]
|
||||
[--noindent] [--prefix PREFIX] [--all-tenants]
|
||||
alarm_vitrage_id
|
||||
|
||||
Show an RCA
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``alarm_vitrage_id``
|
||||
ID of an alarm
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--all-tenants``
|
||||
Shows alarms of all the tenants for the RCA
|
||||
|
||||
.. _vitrage_resource_list:
|
||||
|
||||
vitrage resource list
|
||||
---------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: vitrage resource list [-h] [-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
[--type <resource type>] [--all-tenants]
|
||||
|
||||
List resources
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--type <resource type>``
|
||||
Type of resource
|
||||
|
||||
``--all-tenants``
|
||||
Shows resources of all the tenants
|
||||
|
||||
.. _vitrage_resource_show:
|
||||
|
||||
vitrage resource show
|
||||
---------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: vitrage resource show [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
vitrage_id
|
||||
|
||||
Show a resource
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``vitrage_id``
|
||||
vitrage_id of a resource
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _vitrage_template_list:
|
||||
|
||||
vitrage template list
|
||||
---------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: vitrage template list [-h] [-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
|
||||
Template list
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _vitrage_template_show:
|
||||
|
||||
vitrage template show
|
||||
---------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: vitrage template show [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
uuid
|
||||
|
||||
Template show
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``uuid``
|
||||
Template UUID
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _vitrage_template_validate:
|
||||
|
||||
vitrage template validate
|
||||
-------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: vitrage template validate [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--prefix PREFIX] [--path PATH]
|
||||
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--path PATH``
|
||||
full path for template file or templates dir)
|
||||
|
||||
.. _vitrage_topology_show:
|
||||
|
||||
vitrage topology show
|
||||
---------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: vitrage topology show [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
[--filter <query>] [--limit <depth>]
|
||||
[--root ROOT] [--graph-type {tree,graph}]
|
||||
[--all-tenants]
|
||||
|
||||
Show the topology of the system
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--filter <query>``
|
||||
query for the graph)
|
||||
|
||||
``--limit <depth>``
|
||||
the depth of the topology graph
|
||||
|
||||
``--root ROOT``
|
||||
the root of the topology graph
|
||||
|
||||
``--graph-type {tree,graph}``
|
||||
graph type. Valid graph types: [tree, graph]
|
||||
|
||||
``--all-tenants``
|
||||
Shows entities of all the tenants in the entity graph
|
||||
|
||||
@ -1,981 +0,0 @@
|
||||
.. ###################################################
|
||||
.. ## WARNING ######################################
|
||||
.. ############## WARNING ##########################
|
||||
.. ########################## WARNING ##############
|
||||
.. ###################################### WARNING ##
|
||||
.. ###################################################
|
||||
.. ###################################################
|
||||
.. ##
|
||||
.. This file is tool-generated. Do not edit manually.
|
||||
.. http://docs.openstack.org/contributor-guide/
|
||||
.. doc-tools/cli-reference.html
|
||||
.. ##
|
||||
.. ## WARNING ######################################
|
||||
.. ############## WARNING ##########################
|
||||
.. ########################## WARNING ##############
|
||||
.. ###################################### WARNING ##
|
||||
.. ###################################################
|
||||
|
||||
=================================================================
|
||||
Infrastructure Optimization service (watcher) command-line client
|
||||
=================================================================
|
||||
|
||||
The watcher client is the command-line interface (CLI) for
|
||||
the Infrastructure Optimization service (watcher) API and its extensions.
|
||||
|
||||
This chapter documents :command:`watcher` version ``1.2.0``.
|
||||
|
||||
For help on a specific :command:`watcher` command, enter:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ watcher help COMMAND
|
||||
|
||||
.. _watcher_command_usage:
|
||||
|
||||
watcher usage
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: watcher [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]
|
||||
[--no-auth] [--os-identity-api-version <identity-api-version>]
|
||||
[--os-auth-url <auth-url>] [--os-region-name <region-name>]
|
||||
[--os-username <auth-user-name>] [--os-user-id <auth-user-id>]
|
||||
[--os-password <auth-password>]
|
||||
[--os-user-domain-id <auth-user-domain-id>]
|
||||
[--os-user-domain-name <auth-user-domain-name>]
|
||||
[--os-tenant-name <auth-tenant-name>]
|
||||
[--os-tenant-id <tenant-id>]
|
||||
[--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-token <auth-token>]
|
||||
[--os-watcher-api-version <os-watcher-api-version>]
|
||||
[--os-endpoint-type OS_ENDPOINT_TYPE]
|
||||
[--os-endpoint-override <endpoint-override>] [--insecure]
|
||||
[--os-cacert <ca-certificate>] [--os-cert <certificate>]
|
||||
[--os-key <key>] [--timeout <seconds>]
|
||||
|
||||
.. _watcher_command_options:
|
||||
|
||||
watcher optional arguments
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
``--version``
|
||||
show program's version number and exit
|
||||
|
||||
``-v, --verbose``
|
||||
Increase verbosity of output. Can be repeated.
|
||||
|
||||
``-q, --quiet``
|
||||
Suppress output except warnings and errors.
|
||||
|
||||
``--log-file LOG_FILE``
|
||||
Specify a file to log output. Disabled by default.
|
||||
|
||||
``-h, --help``
|
||||
Show help message and exit.
|
||||
|
||||
``--debug``
|
||||
Show tracebacks on errors.
|
||||
|
||||
``--no-auth, -N``
|
||||
Do not use authentication.
|
||||
|
||||
``--os-identity-api-version <identity-api-version>``
|
||||
Specify Identity API version to use. Defaults to
|
||||
``env[OS_IDENTITY_API_VERSION]`` or 3.
|
||||
|
||||
``--os-auth-url <auth-url>, -A <auth-url>``
|
||||
Defaults to ``env[OS_AUTH_URL]``.
|
||||
|
||||
``--os-region-name <region-name>, -R <region-name>``
|
||||
Defaults to ``env[OS_REGION_NAME]``.
|
||||
|
||||
``--os-username <auth-user-name>, -U <auth-user-name>``
|
||||
Defaults to ``env[OS_USERNAME]``.
|
||||
|
||||
``--os-user-id <auth-user-id>``
|
||||
Defaults to ``env[OS_USER_ID]``.
|
||||
|
||||
``--os-password <auth-password>, -P <auth-password>``
|
||||
Defaults to ``env[OS_PASSWORD]``.
|
||||
|
||||
``--os-user-domain-id <auth-user-domain-id>``
|
||||
Defaults to ``env[OS_USER_DOMAIN_ID]``.
|
||||
|
||||
``--os-user-domain-name <auth-user-domain-name>``
|
||||
Defaults to ``env[OS_USER_DOMAIN_NAME]``.
|
||||
|
||||
``--os-tenant-name <auth-tenant-name>, -T <auth-tenant-name>``
|
||||
Defaults to ``env[OS_TENANT_NAME]``.
|
||||
|
||||
``--os-tenant-id <tenant-id>, -I <tenant-id>``
|
||||
Defaults to ``env[OS_TENANT_ID]``.
|
||||
|
||||
``--os-project-id <auth-project-id>``
|
||||
Another way to specify tenant ID. This option is
|
||||
mutually exclusive with --os-tenant-id. Defaults to
|
||||
``env[OS_PROJECT_ID]``.
|
||||
|
||||
``--os-project-name <auth-project-name>``
|
||||
Another way to specify tenant name. This option is
|
||||
mutually exclusive with --os-tenant-name. Defaults to
|
||||
``env[OS_PROJECT_NAME]``.
|
||||
|
||||
``--os-project-domain-id <auth-project-domain-id>``
|
||||
Defaults to ``env[OS_PROJECT_DOMAIN_ID]``.
|
||||
|
||||
``--os-project-domain-name <auth-project-domain-name>``
|
||||
Defaults to ``env[OS_PROJECT_DOMAIN_NAME]``.
|
||||
|
||||
``--os-auth-token <auth-token>``
|
||||
Defaults to ``env[OS_AUTH_TOKEN]``.
|
||||
|
||||
``--os-watcher-api-version <os-watcher-api-version>``
|
||||
Defaults to ``env[OS_WATCHER_API_VERSION]``.
|
||||
|
||||
``--os-endpoint-type OS_ENDPOINT_TYPE``
|
||||
Defaults to ``env[OS_ENDPOINT_TYPE]`` or "publicURL"
|
||||
|
||||
``--os-endpoint-override <endpoint-override>``
|
||||
Use this API endpoint instead of the Service Catalog.
|
||||
|
||||
.. _watcher_action_list:
|
||||
|
||||
watcher action list
|
||||
-------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: watcher action list [-h] [-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>] [--print-empty]
|
||||
[--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
[--action-plan <action-plan>] [--audit <audit>]
|
||||
[--detail] [--limit <limit>] [--sort-key <field>]
|
||||
[--sort-dir <direction>]
|
||||
|
||||
List information on retrieved actions.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--action-plan <action-plan>``
|
||||
UUID of the action plan used for filtering.
|
||||
|
||||
``--audit <audit>``
|
||||
UUID of the audit used for filtering.
|
||||
|
||||
``--detail``
|
||||
Show detailed information about actions.
|
||||
|
||||
``--limit <limit>``
|
||||
Maximum number of actions to return per request, 0 for
|
||||
no limit. Default is the maximum number used by the
|
||||
Watcher API Service.
|
||||
|
||||
``--sort-key <field>``
|
||||
Action field that will be used for sorting.
|
||||
|
||||
``--sort-dir <direction>``
|
||||
Sort direction: "asc" (the default) or "desc".
|
||||
|
||||
.. _watcher_action_show:
|
||||
|
||||
watcher action show
|
||||
-------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: watcher action show [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>] [--print-empty]
|
||||
[--noindent] [--prefix PREFIX]
|
||||
<action>
|
||||
|
||||
Show detailed information about a given action.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<action>``
|
||||
UUID of the action
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _watcher_actionplan_create:
|
||||
|
||||
watcher actionplan create
|
||||
-------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: watcher actionplan create [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--prefix PREFIX] -a <audit_template>
|
||||
[-t <audit_type>]
|
||||
|
||||
Create new audit.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``-a <audit_template>, --audit-template <audit_template>``
|
||||
Audit template used for this audit (name or uuid).
|
||||
|
||||
``-t <audit_type>, --audit_type <audit_type>``
|
||||
Audit type. It must be ONESHOT or CONTINUOUS. Default
|
||||
is ONESHOT.
|
||||
|
||||
.. _watcher_actionplan_delete:
|
||||
|
||||
watcher actionplan delete
|
||||
-------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: watcher actionplan delete [-h] <action-plan> [<action-plan> ...]
|
||||
|
||||
Delete action plan command.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<action-plan>``
|
||||
UUID of the action plan
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _watcher_actionplan_list:
|
||||
|
||||
watcher actionplan list
|
||||
-----------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: watcher actionplan list [-h] [-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
[--audit <audit>] [--detail] [--limit <limit>]
|
||||
[--sort-key <field>] [--sort-dir <direction>]
|
||||
|
||||
List information on retrieved action plans.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--audit <audit>``
|
||||
UUID of an audit used for filtering.
|
||||
|
||||
``--detail``
|
||||
Show detailed information about action plans.
|
||||
|
||||
``--limit <limit>``
|
||||
Maximum number of action plans to return per request,
|
||||
0 for no limit. Default is the maximum number used by
|
||||
the Watcher API Service.
|
||||
|
||||
``--sort-key <field>``
|
||||
Action Plan field that will be used for sorting.
|
||||
|
||||
``--sort-dir <direction>``
|
||||
Sort direction: "asc" (the default) or "desc".
|
||||
|
||||
.. _watcher_actionplan_show:
|
||||
|
||||
watcher actionplan show
|
||||
-----------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: watcher actionplan show [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
<action-plan>
|
||||
|
||||
Show detailed information about a given action plan.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<action-plan>``
|
||||
UUID of the action plan
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _watcher_actionplan_start:
|
||||
|
||||
watcher actionplan start
|
||||
------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: watcher actionplan start [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
<action-plan>
|
||||
|
||||
Start action plan command.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<action-plan>``
|
||||
UUID of the action_plan.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _watcher_actionplan_update:
|
||||
|
||||
watcher actionplan update
|
||||
-------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: watcher actionplan update [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--prefix PREFIX]
|
||||
<action-plan> <op> <path=value>
|
||||
[<path=value> ...]
|
||||
|
||||
Update action plan command.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<action-plan>``
|
||||
UUID of the action_plan.
|
||||
|
||||
``<op>``
|
||||
Operation: 'add', 'replace', or 'remove'.
|
||||
|
||||
``<path=value>``
|
||||
Attribute to add, replace, or remove. Can be specified
|
||||
multiple times. For 'remove', only <path> is
|
||||
necessary.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _watcher_audit_create:
|
||||
|
||||
watcher audit create
|
||||
--------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: watcher audit create [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
[-t <audit_type>] [-p <name=value>]
|
||||
[-i <interval>] [-g <goal>] [-s <strategy>]
|
||||
[-a <audit_template>] [--auto-trigger]
|
||||
|
||||
Create new audit.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``-t <audit_type>, --audit_type <audit_type>``
|
||||
Audit type. It must be ONESHOT or CONTINUOUS. Default
|
||||
is ONESHOT.
|
||||
|
||||
``-p <name=value>, --parameter <name=value>``
|
||||
Record strategy parameter/value metadata. Can be
|
||||
specified multiple times.
|
||||
|
||||
``-i <interval>, --interval <interval>``
|
||||
Audit interval (in seconds). Only used if the audit is
|
||||
CONTINUOUS.
|
||||
|
||||
``-g <goal>, --goal <goal>``
|
||||
Goal UUID or name associated to this audit.
|
||||
|
||||
``-s <strategy>, --strategy <strategy>``
|
||||
Strategy UUID or name associated to this audit.
|
||||
|
||||
``-a <audit_template>, --audit-template <audit_template>``
|
||||
Audit template used for this audit (name or uuid).
|
||||
|
||||
``--auto-trigger``
|
||||
Trigger automatically action plan once audit is
|
||||
succeeded.
|
||||
|
||||
.. _watcher_audit_delete:
|
||||
|
||||
watcher audit delete
|
||||
--------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: watcher audit delete [-h] <audit> [<audit> ...]
|
||||
|
||||
Delete audit command.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<audit>``
|
||||
UUID of the audit
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _watcher_audit_list:
|
||||
|
||||
watcher audit list
|
||||
------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: watcher audit list [-h] [-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>] [--print-empty]
|
||||
[--noindent] [--quote {all,minimal,none,nonnumeric}]
|
||||
[--detail] [--goal <goal>] [--strategy <strategy>]
|
||||
[--limit <limit>] [--sort-key <field>]
|
||||
[--sort-dir <direction>]
|
||||
|
||||
List information on retrieved audits.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--detail``
|
||||
Show detailed information about audits.
|
||||
|
||||
``--goal <goal>``
|
||||
UUID or name of the goal used for filtering.
|
||||
|
||||
``--strategy <strategy>``
|
||||
UUID or name of the strategy used for filtering.
|
||||
|
||||
``--limit <limit>``
|
||||
Maximum number of audits to return per request, 0 for
|
||||
no limit. Default is the maximum number used by the
|
||||
Watcher API Service.
|
||||
|
||||
``--sort-key <field>``
|
||||
Audit field that will be used for sorting.
|
||||
|
||||
``--sort-dir <direction>``
|
||||
Sort direction: "asc" (the default) or "desc".
|
||||
|
||||
.. _watcher_audit_show:
|
||||
|
||||
watcher audit show
|
||||
------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: watcher audit show [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>] [--print-empty]
|
||||
[--noindent] [--prefix PREFIX]
|
||||
<audit>
|
||||
|
||||
Show detailed information about a given audit.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<audit>``
|
||||
UUID of the audit
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _watcher_audit_update:
|
||||
|
||||
watcher audit update
|
||||
--------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: watcher audit update [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
<audit> <op> <path=value> [<path=value> ...]
|
||||
|
||||
Update audit command.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<audit>``
|
||||
UUID of the audit.
|
||||
|
||||
``<op>``
|
||||
Operation: 'add', 'replace', or 'remove'.
|
||||
|
||||
``<path=value>``
|
||||
Attribute to add, replace, or remove. Can be specified
|
||||
multiple times. For 'remove', only <path> is
|
||||
necessary.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _watcher_audittemplate_create:
|
||||
|
||||
watcher audittemplate create
|
||||
----------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: watcher audittemplate create [-h]
|
||||
[-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--prefix PREFIX] [-s <strategy>]
|
||||
[-d <description>] [--scope <path>]
|
||||
<name> <goal>
|
||||
|
||||
Create new audit template.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<name>``
|
||||
Name for this audit template.
|
||||
|
||||
``<goal>``
|
||||
Goal UUID or name associated to this audit template.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``-s <strategy>, --strategy <strategy>``
|
||||
Strategy UUID or name associated to this audit
|
||||
template.
|
||||
|
||||
``-d <description>, --description <description>``
|
||||
Description of the audit template.
|
||||
|
||||
``--scope <path>``
|
||||
Part of the cluster on which an audit will be done.
|
||||
Can be provided either in yaml or json file.
|
||||
YAML example:
|
||||
---- host_aggregates:
|
||||
- id: 1
|
||||
- id: 2
|
||||
- id: 3
|
||||
- availability_zones:
|
||||
- name: AZ1
|
||||
- name: AZ2
|
||||
- exclude:
|
||||
- instances:
|
||||
- uuid: UUID1
|
||||
- uuid: UUID2
|
||||
- compute_nodes:
|
||||
- name: compute1
|
||||
|
||||
JSON example:
|
||||
[{'host_aggregates': [
|
||||
{'id': 1},
|
||||
{'id': 2},
|
||||
{'id': 3}]},
|
||||
{'availability_zones': [
|
||||
{'name': 'AZ1'},
|
||||
{'name': 'AZ2'}]},
|
||||
{'exclude': [
|
||||
{'instances': [
|
||||
{'uuid': 'UUID1'},
|
||||
{'uuid': 'UUID2'}
|
||||
]},
|
||||
{'compute_nodes': [
|
||||
{'name': 'compute1'}
|
||||
]}
|
||||
]}]
|
||||
|
||||
.. _watcher_audittemplate_delete:
|
||||
|
||||
watcher audittemplate delete
|
||||
----------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: watcher audittemplate delete [-h]
|
||||
<audit-template> [<audit-template> ...]
|
||||
|
||||
Delete audit template command.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<audit-template>``
|
||||
UUID or name of the audit template
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _watcher_audittemplate_list:
|
||||
|
||||
watcher audittemplate list
|
||||
--------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: watcher audittemplate list [-h] [-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
[--detail] [--goal <goal>]
|
||||
[--strategy <strategy>] [--limit <limit>]
|
||||
[--sort-key <field>]
|
||||
[--sort-dir <direction>]
|
||||
|
||||
List information on retrieved audit templates.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--detail``
|
||||
Show detailed information about audit templates.
|
||||
|
||||
``--goal <goal>``
|
||||
UUID or name of the goal used for filtering.
|
||||
|
||||
``--strategy <strategy>``
|
||||
UUID or name of the strategy used for filtering.
|
||||
|
||||
``--limit <limit>``
|
||||
Maximum number of audit templates to return per
|
||||
request, 0 for no limit. Default is the maximum number
|
||||
used by the Watcher API Service.
|
||||
|
||||
``--sort-key <field>``
|
||||
Audit template field that will be used for sorting.
|
||||
|
||||
``--sort-dir <direction>``
|
||||
Sort direction: "asc" (the default) or "desc".
|
||||
|
||||
.. _watcher_audittemplate_show:
|
||||
|
||||
watcher audittemplate show
|
||||
--------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: watcher audittemplate show [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--prefix PREFIX]
|
||||
<audit-template>
|
||||
|
||||
Show detailed information about a given audit template.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<audit-template>``
|
||||
UUID or name of the audit template
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _watcher_audittemplate_update:
|
||||
|
||||
watcher audittemplate update
|
||||
----------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: watcher audittemplate update [-h]
|
||||
[-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--prefix PREFIX]
|
||||
<audit-template> <op> <path=value>
|
||||
[<path=value> ...]
|
||||
|
||||
Update audit template command.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<audit-template>``
|
||||
UUID or name of the audit_template.
|
||||
|
||||
``<op>``
|
||||
Operation: 'add', 'replace', or 'remove'.
|
||||
|
||||
``<path=value>``
|
||||
Attribute to add, replace, or remove. Can be specified
|
||||
multiple times. For 'remove', only <path> is
|
||||
necessary.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _watcher_goal_list:
|
||||
|
||||
watcher goal list
|
||||
-----------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: watcher goal list [-h] [-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>] [--print-empty]
|
||||
[--noindent] [--quote {all,minimal,none,nonnumeric}]
|
||||
[--detail] [--limit <limit>] [--sort-key <field>]
|
||||
[--sort-dir <direction>]
|
||||
|
||||
List information on retrieved goals.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--detail``
|
||||
Show detailed information about each goal.
|
||||
|
||||
``--limit <limit>``
|
||||
Maximum number of goals to return per request, 0 for
|
||||
no limit. Default is the maximum number used by the
|
||||
Watcher API Service.
|
||||
|
||||
``--sort-key <field>``
|
||||
Goal field that will be used for sorting.
|
||||
|
||||
``--sort-dir <direction>``
|
||||
Sort direction: "asc" (the default) or "desc".
|
||||
|
||||
.. _watcher_goal_show:
|
||||
|
||||
watcher goal show
|
||||
-----------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: watcher goal show [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>] [--print-empty]
|
||||
[--noindent] [--prefix PREFIX]
|
||||
<goal>
|
||||
|
||||
Show detailed information about a given goal.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<goal>``
|
||||
UUID or name of the goal
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _watcher_scoringengine_list:
|
||||
|
||||
watcher scoringengine list
|
||||
--------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: watcher scoringengine list [-h] [-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
[--detail] [--limit <limit>]
|
||||
[--sort-key <field>]
|
||||
[--sort-dir <direction>]
|
||||
|
||||
List information on retrieved scoring engines.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--detail``
|
||||
Show detailed information about scoring engines.
|
||||
|
||||
``--limit <limit>``
|
||||
Maximum number of actions to return per request, 0 for
|
||||
no limit. Default is the maximum number used by the
|
||||
Watcher API Service.
|
||||
|
||||
``--sort-key <field>``
|
||||
Action field that will be used for sorting.
|
||||
|
||||
``--sort-dir <direction>``
|
||||
Sort direction: "asc" (the default) or "desc".
|
||||
|
||||
.. _watcher_scoringengine_show:
|
||||
|
||||
watcher scoringengine show
|
||||
--------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: watcher scoringengine show [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--prefix PREFIX]
|
||||
<scoring_engine>
|
||||
|
||||
Show detailed information about a given scoring engine.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<scoring_engine>``
|
||||
Name of the scoring engine
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _watcher_service_list:
|
||||
|
||||
watcher service list
|
||||
--------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: watcher service list [-h] [-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}] [--detail]
|
||||
[--limit <limit>] [--sort-key <field>]
|
||||
[--sort-dir <direction>]
|
||||
|
||||
List information on retrieved services.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--detail``
|
||||
Show detailed information about each service.
|
||||
|
||||
``--limit <limit>``
|
||||
Maximum number of services to return per request, 0
|
||||
for no limit. Default is the maximum number used by
|
||||
the Watcher API Service.
|
||||
|
||||
``--sort-key <field>``
|
||||
Goal field that will be used for sorting.
|
||||
|
||||
``--sort-dir <direction>``
|
||||
Sort direction: "asc" (the default) or "desc".
|
||||
|
||||
.. _watcher_service_show:
|
||||
|
||||
watcher service show
|
||||
--------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: watcher service show [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
<service>
|
||||
|
||||
Show detailed information about a given service.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<service>``
|
||||
ID or name of the service
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
.. _watcher_strategy_list:
|
||||
|
||||
watcher strategy list
|
||||
---------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: watcher strategy list [-h] [-f {csv,html,json,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent]
|
||||
[--quote {all,minimal,none,nonnumeric}]
|
||||
[--goal <goal>] [--detail] [--limit <limit>]
|
||||
[--sort-key <field>] [--sort-dir <direction>]
|
||||
|
||||
List information on retrieved strategies.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
``--goal <goal>``
|
||||
UUID or name of the goal
|
||||
|
||||
``--detail``
|
||||
Show detailed information about each strategy.
|
||||
|
||||
``--limit <limit>``
|
||||
Maximum number of strategies to return per request, 0
|
||||
for no limit. Default is the maximum number used by
|
||||
the Watcher API Service.
|
||||
|
||||
``--sort-key <field>``
|
||||
Goal field that will be used for sorting.
|
||||
|
||||
``--sort-dir <direction>``
|
||||
Sort direction: "asc" (the default) or "desc".
|
||||
|
||||
.. _watcher_strategy_show:
|
||||
|
||||
watcher strategy show
|
||||
---------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usage: watcher strategy show [-h] [-f {html,json,shell,table,value,yaml}]
|
||||
[-c COLUMN] [--max-width <integer>]
|
||||
[--print-empty] [--noindent] [--prefix PREFIX]
|
||||
<strategy>
|
||||
|
||||
Show detailed information about a given strategy.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<strategy>``
|
||||
UUID or name of the strategy
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
@ -32,7 +32,7 @@ PDF_TARGETS=( 'arch-design'\
|
||||
'ops-guide' 'user-guide' )
|
||||
|
||||
# Note that these guides are only build for master branch
|
||||
for guide in admin-guide arch-design cli-reference contributor-guide \
|
||||
for guide in admin-guide arch-design contributor-guide \
|
||||
ha-guide image-guide ops-guide user-guide; do
|
||||
if [[ ${PDF_TARGETS[*]} =~ $guide ]]; then
|
||||
tools/build-rst.sh doc/$guide --build build \
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user