+omit = openstackclient/tests/*

+ neutron-ndp-proxy: true

+ q-trunk: true

+ - openstack-python3-jobs

+Areg Grigoryan <argrigor@cern.ch>

+Ariel-Berkowicz <arielmb@bu.edu>

+Daniel Wilson <danielcw@bu.edu>

+Ilya Popov <ilya_p@hotmail.com>

+Jadon Naas <jadon.naas@canonical.com>

+Jiri Podivin <jpodivin@redhat.com>

+Maksim Malchuk <maksim.malchuk@gmail.com>

+Mridula Joshi <mrjoshi@redhat.com>

+Nicolas Belouin <nicolas.belouin@gandi.net>

+René Ribaud <rribaud@redhat.com>

+Shogo Saito <shogo.saito.ac@hco.ntt.co.jp>

+Snow Kim <lilac94.kim@gmail.com>

+Takashi Natsume <takanattie@gmail.com>

+Violet Kurtz <vi.kurtz@protonmail.com>

+Yang JianFeng <yjf1970231893@gmail.com>

+elajkat <lajos.katona@est.tech>

+hoosa <janghoosa@gmail.com>

+niuke <niuke19970315@163.com>

+zeze <thwjd2717@gmail.com>

+6.1.0

+-----

+

+* Add options to create volume group from source

+* Add block storage manageable list commands

+* Add block storage cleanup command

+* Add block storage log level {list, set} commands

+* Add volume revert command

+* Move network trunk commands from python-neutronclient

+* Add volume summary command

+* Excluding test code from coverage reports

+* Fix tox v4 compatibility

+* Add plugin doc page for cyborg

+* Switch server dump create to using sdk

+* Fix server list error with --long and -c options

+* Create a functional test case for hypervisor list and show

+* Fix functional-tips job

+* Migrate hypervisor stats commands to SDK

+* Fix parameter handling in server add fixed ip cmd

+* Use the SDK for server show

+* Add qos rule type filtering

+* Add image metadef namespace command

+* Updating the glanceclient reference doc

+* docs: Fix typos

+* compute: Allow users to manually specify bootable volumes

+* tests: Add test for multiple blocks devices

+* image: Fail if we can't find an image

+* image: Rename import

+* image: Add support for additional image import methods

+* Revert "Don't look up project by id if given id"

+* Use the SDK in server migration list

+* docs: Document how we manage API versions

+* docs: Describe common actions found in OSC

+* Use the compute SDK in server list

+* tests: Convert network tests to use 'parse\_output'

+* tests: Convert compute tests to use 'parse\_output'

+* tests: Convert identity tests to use 'parse\_output'

+* tests: Convert volume tests to use 'parse\_output'

+* tests: Convert image tests to use 'parse\_output'

+* Adding volume backend commands to volume v3

+* docs: Typo fix

+* docs: Small cleanup of human interface guide

+* Add test for creating volume from source

+* Change --size helptext to include backup

+* Add option to create volume from backup

+* Docstring fix for CreateVolumeAttachment class

+* Moved hypervisor to the SDK

+* image: Add 'image import' command

+* image: Add 'image stage' command

+* image: Simplify handling of data provided via stdin

+* image: Ignore '--progress' if providing image data from stdin

+* Add baremetal agent type list filtering

+* tests: Convert more functional tests to use 'parse\_output'

+* tests: Move json decoding to base test class

+* compute: Add missing microversion check for networks

+* compute: Fix '--network none/auto' handling

+* zuul: Remove nova-network tests

+* Add note about microversion 2.87 in server rescue help

+* compute: Add '--no-network', '--auto-network' flags

+* Improve \`server dump create\` helptext

+* Added "openstack image metadefs namespace list" command

+* Use the compute SDK in usage commands

+* quota: Deprecate "force" behavior for network quotas

+* quota: Fix issues with delete quota command

+* tests: Remove unnecessary nesting of volume resources

+* tests: Remove duplicate FakeImagev1Client

+* tests: Move fake clients to top of file

+* quota: Trivial style fixups

+* quota: Deprecate 'quota show --class', 'quota set --class' arguments

+* quota: Allow showing project-specific quotas

+* quota: Add 'quota show --usage' option

+* quota: Simplify logic used to list, show quotas

+* Fix server evacuate command

+* Speed up standard flavor list command

+* quota: Add support for detailed volume quotas

+* quota: Add 'quota delete' command

+* doc: Update cinder command mapping

+* Improve help text for network create --external

+* Switch to 2023.1 Python3 unit tests and generic template name

+* Update master for stable/zed

+* Fix wrong assertion methods

+* image: Add 'image task list' command

+* image: Add 'image task show' commands

+* Run swift in -tips job

+* Replace assertItemsEqual with assertCountEqual

+* Adding missing command mapping in docs

+* volume: Volume names are optional

+* compute: Add support for microversion 2.93

+* compute: Require image when rebuilding a volume-backed server

+* Add address-scope to NDP proxy tests

+* network: Add tenant project filter for RBAC list

+* Add router ndp proxy commands

+* Fix missing closing brackets in metavar

+* Remove invalid note from requirements files

+* Bump python-novaclient version

+* Microversion 2.91: Support specifying destination host to unshelve

+* remove unicode prefix from code

+

+* Fix documents for replaced configuration name

+* config: Also mask non-prefix config

+* Add authorization\_ttl for identity providers

+* docs: Add missing command mappings

+* compute: Only retrieve necessary images

+* Add trustor and trustee filtering to trusts list

+Version: 6.1.0

+python-cyborgclient>=1.2.1 # Apache-2.0

+ in that a token and an authentication

+=============

+block storage

+=============

+

+Block Storage v3

+

+.. autoprogram-cliff:: openstack.volume.v3

+ :command: block storage cleanup

+=======================

+Block Storage Log Level

+=======================

+

+Block Storage v3

+

+.. autoprogram-cliff:: openstack.volume.v3

+ :command: block storage log level *

+====================

+Block Storage Manage

+====================

+

+Block Storage v3

+

+.. autoprogram-cliff:: openstack.volume.v3

+ :command: block storage volume manageable list

+

+.. autoprogram-cliff:: openstack.volume.v3

+ :command: block storage snapshot manageable list

+=============

+network trunk

+=============

+

+A **network trunk** is a container to group logical ports from different

+networks and provide a single trunked vNIC for servers. It consists of

+one parent port which is a regular VIF and multiple subports which allow

+the server to connect to more networks.

+

+Network v2

+

+.. autoprogram-cliff:: openstack.network.v2

+ :command: network subport list

+

+.. autoprogram-cliff:: openstack.network.v2

+ :command: network trunk *

+=================

+router ndp proxy

+=================

+

+An **NDP proxy** publishes a internal IPv6 address to public network. With the

+**NDP proxy**, the IPv6 address can be accessed from external. It is similar

+to **Floating IP** of IPv4 in functionality.

+

+Network v2

+

+.. autoprogram-cliff:: openstack.network.v2

+ :command: router ndp proxy *

+

+Block Storage v3

+

+ .. autoprogram-cliff:: openstack.volume.v3

+ :command: volume summary

+

+ .. autoprogram-cliff:: openstack.volume.v3

+ :command: volume revert

+api-version,openstack versions show --service volume,Display the server API version information.

+group-create-from-src,volume group create [--source-group|--group-snapshot],Creates a group from a group snapshot or a source group. (Supported by API versions 3.14 - 3.latest)

+manageable-list,block storage volume manageable list,Lists all manageable volumes. (Supported by API versions 3.8 - 3.latest)

+quota-delete,quota delete --volume,Delete the quotas for a tenant.

+quota-usage,quota show --usage,Lists quota usage for a tenant.

+revert-to-snapshot,volume revert,Revert a volume to the specified snapshot. (Supported by API versions 3.40 - 3.latest)

+service-get-log,block storage log level list,(Supported by API versions 3.32 - 3.latest)

+service-set-log,block storage log level set,(Supported by API versions 3.32 - 3.latest)

+snapshot-manageable-list,block storage snapshot manageable list,Lists all manageable snapshots. (Supported by API versions 3.8 - 3.latest)

+summary,volume summary,Get volumes summary. (Supported by API versions 3.12 - 3.latest)

+version-list,versions show --service block-storage,List all API versions. (Supported by API versions 3.0 - 3.latest)

+work-cleanup,block storage cleanup,Request cleanup of services with optional filtering. (Supported by API versions 3.24 - 3.latest)

+cache-clear,,"Clear all images from cache, queue or both."

+cache-delete,,Delete image from cache/caching queue.

+cache-list,,Get cache state.

+cache-queue,,Queue image(s) for caching.

+image-create-via-import, image create --import,"EXPERIMENTAL: Create a new image via image import using glance-direct import method. Missing support for web-download, copy-image and glance-download import methods. The OSC command is also missing support for importing image to specified store as well as all stores (--store, --stores, --all-stores) and skip or stop processing if import fails to one of the store (--allow-failure)"

+image-import,image import,Initiate the image import taskflow.

+image-stage,image stage,Upload data for a specific image to staging.

+image-tasks,,Get tasks associated with image.

+member-get,,Show details of an image member

+member-list,image member list,Describe sharing permissions by image.

+task-create,WONTFIX,Create a new task.

+task-list,image task list,List tasks you can access.

+task-show,image task show,Describe a specific task.

+usage,,Get quota usage information.

+quota-delete,quota delete --network,Delete defined quotas of a given tenant.

+tag-replace,network set --no-tag --tag,Replace all tags on the resource.

+aggregate-cache-images,WONTFIX,Request images be cached. (Supported by API versions '2.81' - '2.latest') [hint: use '-- os-compute-api-version' flag to show help message for proper version]

+hypervisor-uptime,hypervisor show,Display the uptime of the specified hypervisor.

+migration-list,server migration list,Print a list of migrations.

+quota-delete,quota delete --compute,Delete quota for a tenant/user so their quota will Revert back to default.

+version-list,versions show --service compute,List all API versions.

+volume-attachments,server volume list,List all the volumes attached to a server.

+volume-update,server volume update,Update volume attachment.

+Additionally, it is possible to use Keystone's service token to authenticate, by setting the options :option:`--os-token` and :option:`--os-endpoint` (or the environment variables :envvar:`OS_TOKEN` and :envvar:`OS_ENDPOINT` respectively). This method takes precedence over authentication plugins.

+.. option:: --os-endpoint <service-url>

+ Service ENDPOINT, when using a service token for authentication

+When :option:`--os-token` and :option:`--os-endpoint` are both present the

+.. envvar:: OS_ENDPOINT

+ Service ENDPOINT (when using the service token)

+cyborg

+------

+

+.. autoprogram-cliff:: openstack.accelerator.v2

+ cyborg

+project = 'OpenStack Command Line Client'

+copyright = '2012-2013 OpenStack Foundation'

+ 'OpenStack Command Line Client Documentation',

+ 'OpenStack', 'manual'),

+ 'OpenStack Command Line Client',

+ ['OpenStack contributors'],

+ 'OpenStack Command Line Client Documentation',

+ 'OpenStack', 'OpenStackCommandLineClient',

+To determine a list of available commands, use the ``-h`` or

+``--help`` options:

+For help with an individual command, use the ``help`` command:

+* The top level command name is ``openstack``

+.. note::

+

+ A note on terminology. An **argument** is a positional parameter to the

+ command. As discussed later, these should be used sparingly in

+ OpenStackClient. An **option** - also known as a **flag** - is a named

+ parameter denoted with either a hyphen and a single-letter name (``-r``) or

+ a double hyphen and a multiple-letter name (``--recursive``). They may or

+ may not also include a user-specified value (``--file foo.txt`` or

+ ``--file=foo.txt``).

+

+ For more information on this topic and CLIs in general, refer to the

+ excellent `Command Line Interface Guidelines website`__.

+

+ .. __: https://clig.dev/#arguments-and-flags

+

+from the option name by dropping the leading dashes (``--``), converting each embedded

+dash (``-``) to an underscore (``_``), and converting to upper case.

+

+* All long options names shall begin with two dashes (``--``) and use a single dash

+ (``-``) internally between words (``--like-this``). Underscores (``_``) shall not

+

+For example, ``--os-username`` can be set from the environment via

+``OS_USERNAME``.

+``--help``

+++++++++++

+The standard ``--help`` global option displays the documentation for invoking

+form help option (``-h``) is also available.

+``--version``

++++++++++++++

+The standard ``--version`` option displays the name and version on standard

+Objects and Actions

+~~~~~~~~~~~~~~~~~~~

+Commands consist of an object, described by one or more words, followed by an

+action. ::

+ <object> <action>

+For example:

+* ``group create``

+* ``server set``

+* ``volume type list``

+(note that ``volume type`` is a two-word single object)

+

+Some commands require two objects. These commands have the primary object ahead of the

+action and the secondary object after the action. In badly formed English it is

+expressed as "(Take) object-1 (and perform) action (using) object-2 (to it)." ::

+

+ <object-1> <action> <object-2>

+

+For example:

+

+* ``group add user``

+* ``aggregate add host``

+* ``image remove project``

+``help``

+++++++++

+

+The ``help`` command is unique as it appears in front of a normal command

+and displays the help text for that command rather than execute it.

+

+Arguments

+~~~~~~~~~

+

+Commands that interact with a specific instance of an object should accept a

+single argument. This argument should be a name or identifier for the object.

+::

+

+ <object> <action> [<name-or-id>]

+

+For example:

+

+* ``group create <group>``

+* ``server set <server>``

+

+(note that ``volume type`` is a two-word single object)

+

+For commands that require two objects, the commands should accept two

+arguments when interacting with specific instances of the two objects. These

+arguments should appear in the same order as the objects. ::

+

+ <object-1> <action> <object-2> [<object-1-name-or-id> <object-2-name-or-id>]

+

+For example:

+

+* ``group add user <group> <user>``

+* ``aggregate add host <aggregate> <host>``

+* ``image remove project <image> <project>``

+

+Options

+~~~~~~~

+the command and any arguments the command requires.

+Command options should only have long names. The small range of available short

+names makes it hard for a single short option name to have a consistent meaning

+across multiple commands.

+* **datetime**: Datetime options shall accept a value in `ISO-8061`__ format.

+ For example, you can list servers last modified before a given date using

+ ``--changes-before``. ::

+

+ server list --changes-before 2020-01-01T12:30:00+00:00

+

+* **list**: List options shall be passed via multiple options rather than as

+ a single delimited option. For example, you can set multiple properties on a

+ compute flavor using multiple ``--property`` options. ::

+

+ flavor set --property quota:read_bytes_sec=10240000 \

+ --property quota:write_bytes_sec=10240000 \

+ <flavor>

+

+* **boolean**: Boolean options shall use a form of ``--<true>|--<false>``

+ (preferred) or ``--<option>|--no-<option>``. These must be mutually

+ exclusive and should be adjective rather than verbs. For example, the

+ ``enabled`` state of a project is set with ``--enable|--disable``. ::

+

+ project set --enable <project>

+

+.. __: https://en.wikipedia.org/wiki/ISO_8601

+``prettytable`` module.

+Machine-parsable output format may be specified with the ``--format``

+option to ``list`` and ``show`` commands. ``list`` commands

+have an option (``--format csv``) for CSV output and ``show`` commands

+have an option (``--format shell``) for the shell variable assignment

+syntax of ``var="value"``. In both cases, all data fields are quoted with ``"``

+tasks. The format of the ``help`` command therefore varies from the

+form for other commands in that the ``help`` command appears in front

+The options ``--help`` and ``-h`` display the global options and a

+versions that are in effect; i.e. if ``--os-identity-api-version=3`` is

+

+Common Actions

+==============

+

+There are a number of common actions or patterns in use across OpenStackClient.

+When adding new commands, they should aim to match one of these action formats.

+

+``create``

+----------

+

+``create`` will create a new instance of ``<object>``. Only a name should be

+accepted as an argument. All other required and optional information

+should be provided as options. If a name is not required, it can be marked as

+optional. If it is not possible to specify a name when creating a new instance,

+no arguments should be accepted. ::

+

+ <object> create <name>

+

+For example:

+

+* ``flavor create <name>`` (compute flavors require a name)

+* ``volume create [<name>] ...`` (block storage volumes don't *need* names)

+* ``consumer create ...`` (identity consumers don't have names)

+* ``container create --public <name>`` (additional information should be

+ provided as options)

+

+``show``

+--------

+

+``show`` will fetch a single instance of ``object``. Only a name or identifier

+should be accepted as a argument. Any filters or additional information should

+be provided as options. Where names are not unique or an instance is not found,

+an error must be shown so the user can try again using a unique or valid ID,

+respectively. ::

+

+ <object> show <name-or-id>

+

+For example:

+

+* ``server show <name-or-id>`` (compute servers have names or IDs and can be

+ referenced by both)

+* ``consumer show <id>`` (identity consumers only have IDs, not names)

+* ``server show --topology <name-or-id>`` (additional information should be

+ provided as options)

+

+``list``

+--------

+

+``list`` will list multiple instances of ``object``. No arguments should be

+accepted. Any filters or pagination requests should be requested via option

+arguments. ::

+

+ <object> list

+

+For example:

+

+* ``image list`` (no arguments should be accepted)

+* ``server list --status ACTIVE`` (filters should be provided as option

+ arguments)

+

+``delete``

+----------

+

+``delete`` will delete one or more instances of ``object``. Where possible,

+this command should handle deleting instances of ``object`` by either name or

+ID. Where names are not unique or an instance is not found, the command should

+continue deleting any other instances requested before returning an error

+indicating the instances that failed to delete. ::

+

+ <object> delete <name-or-id> [<name-or-id> ...]

+

+For example:

+

+* ``network delete <name-or-id>``

+* ``region delete <name-or-id>``

+

+``set``, ``unset``

+------------------

+

+``set`` and ``unset`` will add or remove one or more attributes of an instance

+of ``object``, respectively. Only a name or identifier should be accepted as a

+argument. All other information should be provided as option

+arguments. Where names are not unique or an instance is not found, an error

+must be shown so the user can try again using a unique or valid ID,

+respectively. This command may result in multiple API calls but it must not

+result in the creation or modification of child object. ::

+

+ <object> set <name-or-id>

+

+For example:

+

+* ``network set <name-or-id>``

+* ``floating ip unset --port <port> <name-or-id>`` (additional information

+ should be provided as options)

+

+``add``, ``remove``

+-------------------

+

+``add`` and ``remove`` will associate or disassociate a child object with a

+parent object. Only a name or identifier for both parent and child objects

+should be accepted as arguments. All other information should be provided as

+options. Where names are not unique or an instance is not found, an error must

+be shown so the user can try again using a unique or valid ID, respectively. ::

+

+ <parent-object> add <child-object> <parent-name-or-id> <child-name-or-id>

+ <parent-object> remove <child-object> <parent-name-or-id> <child-name-or-id>

+

+For example:

+

+* ``aggregate add host <aggregate-name-or-id> <host>``

+* ``consistency group add volume <consistency-group-name-or-id> <volume-name-or-id>``

+

+Other actions

+-------------

+

+There are other actions that do not fit neatly into any of the above actions.

+Typically, these are used where an action would create a child object but that

+child object is only exposed as part of the parent object. They are also used

+where fitting the action into one of the above actions, particularly ``set``,

+would be deemed to be confusing or otherwise inappropriate. These are permitted

+once this has been discussed among reviewers and context provided in either the

+commit message or via comments in the code.

+

+For example:

+

+* ``server ssh`` (this would not naturally fit into any of the other actions)

+* ``server migrate`` (this results in the creation of a server migration record

+ and could be implemented as ``server migration create`` but this feels

+ unnatural)

+* ``server migration confirm`` (this could be implemented as ``server migration

+ set --confirm`` but this feels unnatural)

+* ``volume backup record export`` (this could be implemented as ``volume backup

+ record show --exportable`` but this feels unnatural)

+

+.. note::

+

+ The guidelines below are best practices but exceptions do exist in

+ OpenStackClient and in various plugins. Where possible, these exceptions

+ should be addressed over time.

+

+

+API versioning

+==============

+

+OpenStackClient will strive to behave sensibly for services that version their

+API. The API versioning schemes in use vary between services and have evolved

+since the early days of OpenStack. There are two types of API versioning to

+consider: the major version and the minor version. Today, most OpenStack

+services have settled on a single major API version and have chosen to evolve

+the API without bumping the major API version any further. There are three API

+"minor" versioning schemes in common use.

+

+.. rubric:: Per-release versions

+

+This is used by the Image service (glance). All changes to the API during a

+given release cycle are gathered into a single new API version. As such, the

+API version will increase at most once per release. You can continue to request

+older versions.

+

+Example:

+

+.. list-table:: Image (glance) API versions per release

+

+ * - Release

+ - Supported 2.x API versions

+

+ * - Grizzly

+ - 2.0 - 2.1

+

+ * - Havana

+ - 2.0 - 2.2

+

+ * - Kilo

+ - 2.0 - 2.3

+

+ * - ...

+ - ...

+

+.. rubric:: Microversions

+

+This is used by multiple services including the Compute service (nova), Block

+Storage service (cinder), and Shared Filesystem service (manila). Each change

+to the API will result in a new API version. As such, the API version can

+increase multiple times per release. You can continue to request older

+versions.

+

+Example:

+

+.. list-table:: Compute (nova) API versions per release

+

+ * - Release

+ - Supported 2.x API versions

+

+ * - Kilo

+ - 2.1 - 2.3

+

+ * - Liberty

+ - 2.1 - 2.12

+

+ * - Mitaka

+ - 2.1 - 2.25

+

+ * - ...

+ - ...

+

+.. rubric:: Extensions

+

+This is used by the Networking service (neutron). It's a versioning scheme that

+doesn't use API versions. Instead, it exposes a list of available extensions.

+An extension can add, remove or modify features and vendor-specific

+functionality to the API. This can include API resources/routes as well as new

+fields in API requests and responses. If you want to depend on a feature added

+by an extension, you should check if the extension is present.

+

+Major API version support

+-------------------------

+

+Major API version support has become less important over time as the various

+OpenStack services have chosen to focus on the "minor" versioning mechanisms

+described above. However, OpenStackClient aims to support **all** OpenStack

+clouds, not just those running the most recent OpenStack release. This means it

+must aim to support older major API versions that have since been removed from

+the services in question. For example, the Volume service's (cinder) v2 API was

+deprecated in cinder 11.0.0 (Pike) and was removed in cinder 19.0.0 (Xena),

+however, OpenStackClient continues to support this API since not all OpenStack

+deployments have updated or will update to Xena or later. This should remain

+the case for as long as this support is technically feasible.

+

+.. note::

+

+ While OpenStackClient will continue to support existing command

+ implementations for older APIs, there is no requirement to add **new**

+ commands that implement support for deprecated or removed APIs.

+

+OpenStackClient provides different command implementations depending on the API

+version used. On startup, OpenStackClient will attempt to identify the API

+version using the service catalog. Where a service provides multiple API major

+versions, OpenStackClient defaults to the latest one. This can be configured by

+the user using options (``--os-{service}-api-version``), environment variables

+(``OS_{service}_API_VERSION``) or configuration in the ``clouds.yaml`` file.

+

+Minor API version and extension support

+---------------------------------------

+

+As most services implement some form of versioning and use this to both add new

+functionality and to modify or remove existing functionality, it is imperative

+that OpenStackClient provides a mechanism to configure the API version used.

+Unlike major API versions, support for API microversions or API extensions is

+implemented via logic in the command itself. OpenStackClient commands should

+indicate the minimum or maximum API microversion or the API extension required

+for given actions and options in the help string for same. Where a user

+attempts to use a feature that requires a particular microversion or extension

+that the service does not support, OpenStackClient should fail with an error

+message describing these requirements. Like API versions, the requested can be

+configured by the user using options (``--os-{service}-api-version``),

+environment variables (``OS_{service}_API_VERSION``) or configuration in

+``clouds.yaml`` file.

+

+.. important::

+

+ Historically, OpenStackClient has defaulted to the lowest supported

+ microversion for each service. This was not by design but rather a side

+ effect of relying on legacy clients who implement this behavior.

+ openstacksdk does not implement this behavior and instead auto-negotiates a

+ version based on the versions that SDK knows about. For now, this means we

+ have some commands that require explicit microversion configuration to get

+ the latest and greatest behavior, while others will handle this

+ transparently. For humans, this should not matter. For scripts, which are

+ more fragile, it is recommended that an explicit microversion is always

+ requested.

+

+

+The following examples depict common command and output formats expected to be

+produces by the OpenStackClient.

+Using the CSV output format with a list command:

+``my_`` to avoid collisions with existing environment variables:

+- python-cyborgclient

+ if parsed_args.mask:

+ for secret_opt in secret_opts:

+ if secret_opt in info:

+ info[secret_opt] = REDACTED

+

+import argparse

+NETWORK_KEYS = [

+ 'floating_ips',

+ 'networks',

+ 'rbac_policies',

+ 'routers',

+ 'ports',

+ 'security_group_rules',

+ 'security_groups',

+ 'subnet_pools',

+ 'subnets',

+]

+def get_project(app, project):

+ if project is not None:

+ identity_client = app.client_manager.identity

+ project = utils.find_resource(

+ identity_client.projects,

+ project,

+ )

+ project_id = project.id

+ project_name = project.name

+ elif app.client_manager.auth_ref:

+ # Get the project from the current auth

+ project = app.client_manager.auth_ref

+ project_id = project.project_id

+ project_name = project.project_name

+ else:

+ project_id = None

+ project_name = None

+

+ return {

+ 'id': project_id,

+ 'name': project_name,

+ }

+

+

+def get_compute_quotas(

+ app,

+ project_id,

+ *,

+ quota_class=False,

+ detail=False,

+ default=False,

+):

+ try:

+ client = app.client_manager.compute

+ if quota_class:

+ # NOTE(stephenfin): The 'project' argument here could be anything

+ # as the nova API doesn't care what you pass in. We only pass the

+ # project in to avoid weirding people out :)

+ quota = client.quota_classes.get(project_id)

+ elif default:

+ quota = client.quotas.defaults(project_id)

+ else:

+ quota = client.quotas.get(project_id, detail=detail)

+ except Exception as e:

+ if type(e).__name__ == 'EndpointNotFound':

+ return {}

+ raise

+ return quota._info

+

+

+def get_volume_quotas(

+ app,

+ project_id,

+ *,

+ quota_class=False,

+ detail=False,

+ default=False,

+):

+ try:

+ client = app.client_manager.volume

+ if quota_class:

+ quota = client.quota_classes.get(project_id)

+ elif default:

+ quota = client.quotas.defaults(project_id)

+ quota = client.quotas.get(project_id, usage=detail)

+ except Exception as e:

+ if type(e).__name__ == 'EndpointNotFound':

+ return {}

+ else:

+ raise

+ return quota._info

+

+

+def get_network_quotas(

+ app,

+ project_id,

+ *,

+ quota_class=False,

+ detail=False,

+ default=False,

+):

+ def _network_quota_to_dict(network_quota, detail=False):

+ result = {}

+ for key, values in dict_quota.items():

+ if values is None:

+ continue

+ # NOTE(slaweq): Neutron returns values with key "used" but Nova for

+ # example returns same data with key "in_use" instead. Because of

+ # that we need to convert Neutron key to the same as is returned

+ # from Nova to make result more consistent

+ if isinstance(values, dict) and 'used' in values:

+ values['in_use'] = values.pop("used")

+ result[key] = values

+ return result

+

+ # neutron doesn't have the concept of quota classes and if we're using

+ # nova-network we already fetched this

+ if quota_class:

+ return {}

+

+ # we have nothing to return if we are not using neutron

+ if not app.client_manager.is_network_endpoint_enabled():

+ return {}

+

+ client = app.client_manager.network

+ if default:

+ network_quota = client.get_quota_default(project_id)

+ network_quota = _network_quota_to_dict(network_quota)

+ else:

+ network_quota = client.get_quota(project_id, details=detail)

+ network_quota = _network_quota_to_dict(network_quota, detail=detail)

+ return network_quota

+

+

+class ListQuota(command.Lister):

+ _description = _(

+ "List quotas for all projects with non-default quota values or "

+ "list detailed quota information for requested project"

+ )

+ parser = super().get_parser(prog_name)

+ # TODO(stephenfin): Remove in OSC 8.0

+ help=_(

+ "**Deprecated** List quotas for this project <project> "

+ "(name or ID). "

+ "Use 'quota show' instead."

+ ),

+ # TODO(stephenfin): Remove in OSC 8.0

+ help=_(

+ "**Deprecated** Show details about quotas usage. "

+ "Use 'quota show --usage' instead."

+ ),

+ def _get_detailed_quotas(self, parsed_args):

+ project_info = get_project(self.app, parsed_args.project)

+ project = project_info['id']

+

+ quotas = {}

+

+ if parsed_args.compute:

+ quotas.update(

+ get_compute_quotas(

+ self.app,

+ project,

+ detail=parsed_args.detail,

+ )

+ )

+

+ if parsed_args.network:

+ quotas.update(

+ get_network_quotas(

+ self.app,

+ project,

+ detail=parsed_args.detail,

+ )

+ )

+

+ if parsed_args.volume:

+ quotas.update(

+ get_volume_quotas(

+ self.app,

+ parsed_args,

+ detail=parsed_args.detail,

+ ),

+ )

+

+ result = []

+ for resource, values in quotas.items():

+ # NOTE(slaweq): there is no detailed quotas info for some resources

+ # and it shouldn't be displayed here

+ if isinstance(values, dict):

+ result.append(

+ {

+ 'resource': resource,

+ 'in_use': values.get('in_use'),

+ 'reserved': values.get('reserved'),

+ 'limit': values.get('limit'),

+ }

+ )

+

+ columns = (

+ 'resource',

+ 'in_use',

+ 'reserved',

+ 'limit',

+ )

+ column_headers = (

+ 'Resource',

+ 'In Use',

+ 'Reserved',

+ 'Limit',

+ )

+

+ return (

+ column_headers,

+ (utils.get_dict_properties(s, columns) for s in result),

+ )

+

+ if parsed_args.detail:

+ msg = _(

+ "The --detail option has been deprecated. "

+ "Use 'openstack quota show --usage' instead."

+ )

+ self.log.warning(msg)

+ elif parsed_args.project: # elif to avoid being too noisy

+ msg = _(

+ "The --project option has been deprecated. "

+ "Use 'openstack quota show' instead."

+ )

+ self.log.warning(msg)

+

+

+ type(ex).__name__ == 'NotFound'

+ or ex.http_status >= 400

+ and ex.http_status <= 499

+ return (

+ column_headers,

+ (utils.get_dict_properties(s, columns) for s in result),

+ )

+ return self._get_detailed_quotas(parsed_args)

+

+

+ return (

+ column_headers,

+ (utils.get_dict_properties(s, columns) for s in result),

+ )

+

+ 'Subnet Pools',

+ )

+

+ return (

+ column_headers,

+ (utils.get_dict_properties(s, columns) for s in result),

+ rets = [

+ (k, v, help_fmt % v)

+ for k, v in itertools.chain(

+ COMPUTE_QUOTAS.items(),

+ VOLUME_QUOTAS.items(),

+ )

+ ]

+ [(k, v, help_fmt % v) for k, v in NETWORK_QUOTAS.items()]

+ )

+ [(k, v, help_fmt % v) for k, v in NOVA_NETWORK_QUOTAS.items()]

+ )

+ help=_('Set quotas for this project or class (name or ID)'),

+ # TODO(stephenfin): Remove in OSC 8.0

+ help=_(

+ '**Deprecated** Set quotas for <class>. '

+ 'Deprecated as quota classes were never fully implemented '

+ 'and only the default class is supported. '

+ '(compute and volume only)'

+ ),

+ force_group = parser.add_mutually_exclusive_group()

+ force_group.add_argument(

+ dest='force',

+ # TODO(stephenfin): Change the default to False in Z or later

+ default=None,

+ help=_(

+ 'Force quota update (only supported by compute and network) '

+ '(default for network)'

+ ),

+ force_group.add_argument(

+ '--no-force',

+ action='store_false',

+ dest='force',

+ default=None,

+ help=_(

+ 'Do not force quota update '

+ '(only supported by compute and network) '

+ '(default for compute)'

+ ),

+ )

+ # kept here for backwards compatibility/to keep the neutron folks happy

+ force_group.add_argument(

+ action='store_false',

+ dest='force',

+ default=None,

+ help=argparse.SUPPRESS,

+ if parsed_args.quota_class:

+ msg = _(

+ "The '--class' option has been deprecated. Quota classes were "

+ "never fully implemented and the compute and volume services "

+ "only support a single 'default' quota class while the "

+ "network service does not support quota classes at all. "

+ "Please use 'openstack quota show --default' instead."

+ )

+ self.log.warning(msg)

+ if parsed_args.force is not None:

+ compute_kwargs['force'] = parsed_args.force

+ if parsed_args.volume_type and k in IMPACT_VOLUME_TYPE_QUOTAS:

+ if parsed_args.force is True:

+ # Unlike compute, network doesn't provide a simple boolean option.

+ # Instead, it provides two options: 'force' and 'check_limit'

+ # (a.k.a. 'not force')

+ elif parsed_args.force is False:

+ network_kwargs['check_limit'] = True

+ else:

+ msg = _(

+ "This command currently defaults to '--force' when modifying "

+ "network quotas. This behavior will change in a future "

+ "release. Consider explicitly providing '--force' or "

+ "'--no-force' options to avoid changes in behavior."

+ )

+ self.log.warning(msg)

+ **compute_kwargs,

+ )

+ **volume_kwargs,

+ )

+ sys.stderr.write(

+ "Network quotas are ignored since quota classes are not "

+ "supported."

+ )

+

+ compute_client.quotas.update(project, **compute_kwargs)

+ volume_client.quotas.update(project, **volume_kwargs)

+ network_kwargs

+ and self.app.client_manager.is_network_endpoint_enabled()

+ network_client.update_quota(project, **network_kwargs)

+class ShowQuota(command.Lister):

+ "Show quotas for project or class. "

+ "Specify ``--os-compute-api-version 2.50`` or higher to see "

+ "``server-groups`` and ``server-group-members`` output for a given "

+ "quota class."

+ )

+ parser = super().get_parser(prog_name)

+ help=_(

+ 'Show quotas for this project or class (name or ID) '

+ '(defaults to current project)'

+ ),

+ # TODO(stephenfin): Remove in OSC 8.0

+ help=_(

+ '**Deprecated** Show quotas for <class>. '

+ 'Deprecated as quota classes were never fully implemented '

+ 'and only the default class is supported. '

+ 'Use --default instead which is also supported by the network '

+ 'service. '

+ '(compute and volume only)'

+ ),

+ help=_('Show default quotas for <project>'),

+ )

+ type_group.add_argument(

+ '--usage',

+ dest='usage',

+ action='store_true',

+ default=False,

+ help=_('Show details about quotas usage'),

+ )

+ service_group = parser.add_mutually_exclusive_group()

+ service_group.add_argument(

+ '--all',

+ action='store_const',

+ const='all',

+ dest='service',

+ default='all',

+ help=_('Show quotas for all services'),

+ )

+ service_group.add_argument(

+ '--compute',

+ action='store_const',

+ const='compute',

+ dest='service',

+ default='all',

+ help=_('Show compute quota'),

+ )

+ service_group.add_argument(

+ '--volume',

+ action='store_const',

+ const='volume',

+ dest='service',

+ default='all',

+ help=_('Show volume quota'),

+ )

+ service_group.add_argument(

+ '--network',

+ action='store_const',

+ const='network',

+ dest='service',

+ default='all',

+ help=_('Show network quota'),

+

+ project = parsed_args.project

+ if parsed_args.quota_class:

+ msg = _(

+ "The '--class' option has been deprecated. Quota classes were "

+ "never fully implemented and the compute and volume services "

+ "only support a single 'default' quota class while the "

+ "network service does not support quota classes at all. "

+ "Please use 'openstack quota show --default' instead."

+ )

+ self.log.warning(msg)

+ else:

+ project_info = get_project(self.app, parsed_args.project)

+ project = project_info['id']

+

+ compute_quota_info = {}

+ volume_quota_info = {}

+ network_quota_info = {}

+

+ # NOTE(stephenfin): These quota API calls do not validate the project

+ # or class arguments and return what appears to be the default quota

+ # values if the project or class does not exist. This is expected

+ # behavior. However, we have already checked for the presence of the

+ # project above so it shouldn't be an issue.

+ if parsed_args.service in {'all', 'compute'}:

+ compute_quota_info = get_compute_quotas(

+ self.app,

+ project,

+ detail=parsed_args.usage,

+ quota_class=parsed_args.quota_class,

+ default=parsed_args.default,

+ )

+ if parsed_args.service in {'all', 'volume'}:

+ volume_quota_info = get_volume_quotas(

+ self.app,

+ project,

+ detail=parsed_args.usage,

+ quota_class=parsed_args.quota_class,

+ default=parsed_args.default,

+ )

+ if parsed_args.service in {'all', 'network'}:

+ network_quota_info = get_network_quotas(

+ self.app,

+ project,

+ detail=parsed_args.usage,

+ quota_class=parsed_args.quota_class,

+ default=parsed_args.default,

+ )

+ COMPUTE_QUOTAS.items(),

+ NOVA_NETWORK_QUOTAS.items(),

+ VOLUME_QUOTAS.items(),

+ NETWORK_QUOTAS.items(),

+ ):

+ # Remove the 'id' field since it's not very useful

+ del info['id']

+

+ # Remove the 'location' field for resources from openstacksdk

+ if 'location' in info:

+ del info['location']

+

+ if not parsed_args.usage:

+ result = [{'resource': k, 'limit': v} for k, v in info.items()]

+ else:

+ result = [{'resource': k, **v} for k, v in info.items()]

+

+ columns = (

+ 'resource',

+ 'limit',

+ )

+ column_headers = (

+ 'Resource',

+ 'Limit',

+ )

+

+ if parsed_args.usage:

+ columns += (

+ 'in_use',

+ 'reserved',

+ )

+ column_headers += (

+ 'In Use',

+ 'Reserved',

+ )

+

+ return (

+ column_headers,

+ (utils.get_dict_properties(s, columns) for s in result),

+ )

+

+

+class DeleteQuota(command.Command):

+ _description = _(

+ "Delete configured quota for a project and revert to defaults."

+ )

+

+ def get_parser(self, prog_name):

+ parser = super().get_parser(prog_name)

+ parser.add_argument(

+ 'project',

+ metavar='<project>',

+ help=_('Delete quotas for this project (name or ID)'),

+ )

+ option = parser.add_mutually_exclusive_group()

+ option.add_argument(

+ '--all',

+ action='store_const',

+ const='all',

+ dest='service',

+ default='all',

+ help=_('Delete project quotas for all services (default)'),

+ )

+ option.add_argument(

+ '--compute',

+ action='store_const',

+ const='compute',

+ dest='service',

+ default='all',

+ help=_(

+ 'Delete compute quotas for the project '

+ '(including network quotas when using nova-network)'

+ ),

+ )

+ option.add_argument(

+ '--volume',

+ action='store_const',

+ const='volume',

+ dest='service',

+ default='all',

+ help=_('Delete volume quotas for the project'),

+ )

+ option.add_argument(

+ '--network',

+ action='store_const',

+ const='network',

+ dest='service',

+ default='all',

+ help=_('Delete network quotas for the project'),

+ )

+ return parser

+

+ def take_action(self, parsed_args):

+ identity_client = self.app.client_manager.identity

+ project = utils.find_resource(

+ identity_client.projects,

+ parsed_args.project,

+ )

+

+ # compute quotas

+ if parsed_args.service in {'all', 'compute'}:

+ compute_client = self.app.client_manager.compute

+ compute_client.quotas.delete(project.id)

+

+ # volume quotas

+ if parsed_args.service in {'all', 'volume'}:

+ volume_client = self.app.client_manager.volume

+ volume_client.quotas.delete(project.id)

+

+ # network quotas (but only if we're not using nova-network, otherwise

+ # we already deleted the quotas in the compute step)

+ if (

+ parsed_args.service in {'all', 'network'}

+ and self.app.client_manager.is_network_endpoint_enabled()

+ ):

+ network_client = self.app.client_manager.network

+ network_client.delete_quota(project.id)

+

+ return None

+ if parsed_args.long and not f.extra_specs:

+from openstack import utils as sdk_utils

+def _get_hypervisor_columns(item, client):

+ column_map = {'name': 'hypervisor_hostname'}

+ hidden_columns = ['location', 'servers']

+

+ if sdk_utils.supports_microversion(client, '2.88'):

+ hidden_columns.extend([

+ 'current_workload',

+ 'disk_available',

+ 'local_disk_free',

+ 'local_disk_size',

+ 'local_disk_used',

+ 'memory_free',

+ 'memory_size',

+ 'memory_used',

+ 'running_vms',

+ 'vcpus_used',

+ 'vcpus',

+ ])

+ else:

+ column_map.update({

+ 'disk_available': 'disk_available_least',

+ 'local_disk_free': 'free_disk_gb',

+ 'local_disk_size': 'local_gb',

+ 'local_disk_used': 'local_gb_used',

+ 'memory_free': 'free_ram_mb',

+ 'memory_used': 'memory_mb_used',

+ 'memory_size': 'memory_mb',

+ })

+

+ return utils.get_osc_show_columns_for_sdk_resource(

+ item, column_map, hidden_columns)

+

+

+ parser = super().get_parser(prog_name)

+ compute_client = self.app.client_manager.sdk_connection.compute

+ if not sdk_utils.supports_microversion(compute_client, '2.33'):

+ if not sdk_utils.supports_microversion(compute_client, '2.33'):

+ column_headers = (

+ columns = (

+ 'id',

+ 'name',

+ 'hypervisor_type',

+ 'host_ip',

+ 'state'

+ )

+ if not sdk_utils.supports_microversion(compute_client, '2.88'):

+ column_headers += (

+ 'vCPUs Used',

+ 'vCPUs',

+ 'Memory MB Used',

+ 'Memory MB'

+ )

+ columns += (

+ 'vcpus_used',

+ 'vcpus',

+ 'memory_used',

+ 'memory_size'

+ )

+ data = compute_client.find_hypervisor(

+ parsed_args.matching, ignore_missing=False)

+ data = compute_client.hypervisors(**list_opts, details=True)

+ column_headers,

+ parser = super().get_parser(prog_name)

+ compute_client = self.app.client_manager.sdk_connection.compute

+ hypervisor = compute_client.find_hypervisor(

+ parsed_args.hypervisor, ignore_missing=False).copy()

+

+ # Some of the properties in the hypervisor object need to be processed

+ # before they get reported to the user. We spend this section

+ # extracting the relevant details to be reported by modifying our

+ # copy of the hypervisor object.

+ aggregates = compute_client.aggregates()

+ hypervisor['aggregates'] = list()

+ service_details = hypervisor['service_details']

+ if "@" in service_details['host']:

+ cell, service_host = service_details['host'].split('@', 1)

+ service_host = service_details['host']

+ hypervisor['aggregates'] = member_of

+ if sdk_utils.supports_microversion(compute_client, '2.88'):

+ uptime = hypervisor['uptime'] or ''

+ del hypervisor['uptime']

+ else:

+ del hypervisor['uptime']

+ uptime = compute_client.get_hypervisor_uptime(

+ hypervisor['id'])['uptime']

+ uptime)

+ hypervisor['host_time'] = m.group(1)

+ hypervisor['uptime'] = m.group(2)

+ hypervisor['users'] = m.group(3)

+ hypervisor['load_average'] = m.group(4)

+ hypervisor['service_id'] = service_details['id']

+ hypervisor['service_host'] = service_details['host']

+ del hypervisor['service_details']

+ if not sdk_utils.supports_microversion(compute_client, '2.28'):

+ hypervisor['cpu_info'] = json.loads(hypervisor['cpu_info'] or '{}')

+ display_columns, columns = _get_hypervisor_columns(

+ hypervisor, compute_client)

+ return display_columns, data

+from osc_lib import utils

+def _get_hypervisor_stat_columns(item):

+ column_map = {

+ # NOTE(gtema): If we decide to use SDK names - empty this

+ 'disk_available': 'disk_available_least',

+ 'local_disk_free': 'free_disk_gb',

+ 'local_disk_size': 'local_gb',

+ 'local_disk_used': 'local_gb_used',

+ 'memory_free': 'free_ram_mb',

+ 'memory_size': 'memory_mb',

+ 'memory_used': 'memory_mb_used',

+

+ }

+ hidden_columns = ['id', 'links', 'location', 'name']

+ return utils.get_osc_show_columns_for_sdk_resource(

+ item, column_map, hidden_columns)

+

+

+ # The command is deprecated since it is being dropped in Nova.

+ self.log.warning(

+ _("This command is deprecated.")

+ )

+ compute_client = self.app.client_manager.sdk_connection.compute

+ # We do API request directly cause this deprecated method is not and

+ # will not be supported by OpenStackSDK.

+ response = compute_client.get(

+ '/os-hypervisors/statistics',

+ microversion='2.1')

+ hypervisor_stats = response.json().get('hypervisor_statistics')

+

+ display_columns, columns = _get_hypervisor_stat_columns(

+ hypervisor_stats)

+ data = utils.get_dict_properties(

+ hypervisor_stats, columns)

+ return (display_columns, data)

+class AddressesColumn(cliff_columns.FormattableColumn):

+ """Generate a formatted string of a server's addresses."""

+

+ def human_readable(self):

+ try:

+ return utils.format_dict_of_list({

+ k: [i['addr'] for i in v if 'addr' in i]

+ for k, v in self._value.items()})

+ except Exception:

+ return 'N/A'

+

+ def machine_readable(self):

+ return {k: [i['addr'] for i in v if 'addr' in i]

+ for k, v in self._value.items()}

+

+

+class HostColumn(cliff_columns.FormattableColumn):

+ """Generate a formatted string of a hostname."""

+

+ def human_readable(self):

+ if self._value is None:

+ return ''

+

+ return self._value

+

+

+ # Note: Some callers of this routine pass a novaclient server, and others

+ # pass an SDK server. Column names may be different across those cases.

+ # Some commands using this routine were originally implemented with the

+ # nova python wrappers, and were later migrated to use the SDK. Map the

+ # SDK's property names to the original property names to maintain backward

+ # compatibility for existing users. Data is duplicated under both the old

+ # and new name so users can consume the data by either name.

+ column_map = {

+ 'access_ipv4': 'accessIPv4',

+ 'access_ipv6': 'accessIPv6',

+ 'admin_password': 'adminPass',

+ 'admin_password': 'adminPass',

+ 'volumes': 'os-extended-volumes:volumes_attached',

+ 'availability_zone': 'OS-EXT-AZ:availability_zone',

+ 'block_device_mapping': 'block_device_mapping_v2',

+ 'compute_host': 'OS-EXT-SRV-ATTR:host',

+ 'created_at': 'created',

+ 'disk_config': 'OS-DCF:diskConfig',

+ 'flavor_id': 'flavorRef',

+ 'has_config_drive': 'config_drive',

+ 'host_id': 'hostId',

+ 'fault': 'fault',

+ 'hostname': 'OS-EXT-SRV-ATTR:hostname',

+ 'hypervisor_hostname': 'OS-EXT-SRV-ATTR:hypervisor_hostname',

+ 'image_id': 'imageRef',

+ 'instance_name': 'OS-EXT-SRV-ATTR:instance_name',

+ 'is_locked': 'locked',

+ 'kernel_id': 'OS-EXT-SRV-ATTR:kernel_id',

+ 'launch_index': 'OS-EXT-SRV-ATTR:launch_index',

+ 'launched_at': 'OS-SRV-USG:launched_at',

+ 'power_state': 'OS-EXT-STS:power_state',

+ 'project_id': 'tenant_id',

+ 'ramdisk_id': 'OS-EXT-SRV-ATTR:ramdisk_id',

+ 'reservation_id': 'OS-EXT-SRV-ATTR:reservation_id',

+ 'root_device_name': 'OS-EXT-SRV-ATTR:root_device_name',

+ 'scheduler_hints': 'OS-SCH-HNT:scheduler_hints',

+ 'task_state': 'OS-EXT-STS:task_state',

+ 'terminated_at': 'OS-SRV-USG:terminated_at',

+ 'updated_at': 'updated',

+ 'user_data': 'OS-EXT-SRV-ATTR:user_data',

+ 'vm_state': 'OS-EXT-STS:vm_state',

+ }

+

+ info.update({

+ column_map[column]: data for column, data in info.items()

+ if column in column_map})

+

+ if image_info and any(image_info.values()):

+ info['addresses'] = (

+ AddressesColumn(info['addresses']) if 'addresses' in info

+ else format_columns.DictListColumn(info.get('networks')))

+ 'net_id': net_id

+ if parsed_args.fixed_ip_address:

+ kwargs['fixed_ips'] = [

+ {"ip_address": parsed_args.fixed_ip_address}]

+ 'Tag for the attached interface '

+ '(supported by --os-compute-api-version 2.49 or later)'

+ 'port_id': port_id

+ 'net_id': net_id

+class NoneNICAction(argparse.Action):

+

+ def __init__(self, option_strings, dest, help=None):

+ super().__init__(

+ option_strings=option_strings,

+ dest=dest,

+ nargs=0,

+ default=[],

+ required=False,

+ help=help,

+ )

+

+ def __call__(self, parser, namespace, values, option_string=None):

+ # Make sure we have an empty dict rather than None

+ if getattr(namespace, self.dest, None) is None:

+ setattr(namespace, self.dest, [])

+

+ getattr(namespace, self.dest).append('none')

+

+

+class AutoNICAction(argparse.Action):

+

+ def __init__(self, option_strings, dest, help=None):

+ super().__init__(

+ option_strings=option_strings,

+ dest=dest,

+ nargs=0,

+ default=[],

+ required=False,

+ help=help,

+ )

+

+ def __call__(self, parser, namespace, values, option_string=None):

+ # Make sure we have an empty dict rather than None

+ if getattr(namespace, self.dest, None) is None:

+ setattr(namespace, self.dest, [])

+

+ getattr(namespace, self.dest).append('auto')

+

+

+ option_strings=option_strings,

+ dest=dest,

+ nargs=None,

+ const=None,

+ default=[],

+ type=None,

+ choices=None,

+ required=False,

+ help=help,

+ metavar=metavar,

+ else:

+ # Handle the special auto/none cases but only when a key isn't set

+ # (otherwise those could be valid values for the key)

+ if values in ('auto', 'none'):

+ getattr(namespace, self.dest).append(values)

+ return

+ k, sep, v = kv_str.partition('=')

+ disk_group = parser.add_mutually_exclusive_group()

+ metavar='<network>',

+ "For more advanced use cases, refer to the '--nic' parameter."

+ metavar='<port>',

+ '--no-network',

+ dest='nics',

+ action=NoneNICAction,

+ help=_(

+ "Do not attach a network to the server. "

+ "This is a wrapper for the '--nic none' option that provides "

+ "a simple syntax for disabling network connectivity for a new "

+ "server. "

+ "For more advanced use cases, refer to the '--nic' parameter. "

+ "(supported by --os-compute-api-version 2.37 or above)"

+ ),

+ )

+ parser.add_argument(

+ '--auto-network',

+ dest='nics',

+ action=AutoNICAction,

+ help=_(

+ "Automatically allocate a network to the server. "

+ "This is the default network allocation policy. "

+ "This is a wrapper for the '--nic auto' option that provides "

+ "a simple syntax for enabling automatic configuration of "

+ "network connectivity for a new server. "

+ "For more advanced use cases, refer to the '--nic' parameter. "

+ "(supported by --os-compute-api-version 2.37 or above)"

+ ),

+ )

+ parser.add_argument(

+ action=NICAction,

+ # NOTE(RuiChen): Add '\n' to the end of line to improve formatting;

+ # see cliff's _SmartHelpFormatter for more details.

+ 'boot_index': 0,

+ 'boot_index': 0,

+ 'boot_index': 0,

+ if not image and not any(

+ [bdm.get('boot_index') == 0 for bdm in block_device_mapping_v2]

+ ):

+ msg = _(

+ 'An image (--image, --image-property) or bootable volume '

+ '(--volume, --snapshot, --block-device) is required'

+ )

+ raise exceptions.CommandError(msg)

+

+ if compute_client.api_version < api_versions.APIVersion('2.37'):

+ msg = _(

+ '--os-compute-api-version 2.37 or greater is '

+ 'required to support explicit auto-allocation of a '

+ 'network or to disable network allocation'

+ )

+ raise exceptions.CommandError(msg)

+

+ memory, and also crash the server(s). This is contingent on guest operating

+ system support, and the location of the dump file inside the guest will

+ depend on the exact guest operating system.

+ compute_client = self.app.client_manager.sdk_connection.compute

+ for name_or_id in parsed_args.server:

+ server = compute_client.find_server(name_or_id)

+ server.trigger_crash_dump(compute_client)

+ compute_client = self.app.client_manager.sdk_connection.compute

+ flavor = compute_client.find_flavor(parsed_args.flavor)

+ if flavor is None:

+ msg = _('Unable to find flavor: %s') % parsed_args.flavor

+ raise exceptions.CommandError(msg)

+ flavor_id = flavor.id

+ 'project_id': project_id,

+ 'all_projects': parsed_args.all_projects,

+ if parsed_args.instance_name is not None:

+ search_opts['instance_name'] = parsed_args.instance_name

+

+ if not sdk_utils.supports_microversion(compute_client, '2.26'):

+ if not sdk_utils.supports_microversion(compute_client, '2.26'):

+ if not sdk_utils.supports_microversion(compute_client, '2.73'):

+ if not sdk_utils.supports_microversion(compute_client, '2.73'):

+ if parsed_args.limit is not None:

+ search_opts['limit'] = parsed_args.limit

+ search_opts['paginated'] = False

+

+ if not sdk_utils.supports_microversion(compute_client, '2.66'):

+ 'task_state',

+ 'power_state',

+ columns += ('addresses',)

+ if sdk_utils.supports_microversion(compute_client, '2.47'):

+ 'availability_zone',

+ 'hypervisor_hostname',

+ columns += ('project_id',)

+ columns += ('created_at',)

+ columns += ('task_state',)

+ columns += ('power_state',)

+ columns += ('flavor_id',)

+ columns += ('availability_zone',)

+ columns += ('hypervisor_hostname',)

+ # remove duplicates

+ column_headers = tuple(dict.fromkeys(column_headers))

+ columns = tuple(dict.fromkeys(columns))

+ if parsed_args.marker is not None:

+ marker_id = compute_client.find_server(parsed_args.marker).id

+ search_opts['marker'] = marker_id

+ data = list(compute_client.servers(**search_opts))

+ # partial responses from down cells will not have an image

+ # attribute so we use getattr

+ image_ids = {

+ s.image['id'] for s in data

+ if getattr(s, 'image', None) and s.image.get('id')

+ }

+

+ for image_id in image_ids:

+ images[image_id] = image_client.get_image(image_id)

+ # some deployments can have *loads* of images so we only

+ # want to list the ones we care about. It would be better

+ # to only retrun the *fields* we care about (name) but

+ # glance doesn't support that

+ # NOTE(stephenfin): This could result in super long URLs

+ # but it seems unlikely to cause issues. Apache supports

+ # URL lengths of up to 8190 characters by default, which

+ # should allow for more than 220 unique image ID (different

+ # servers are likely use the same image ID) in the filter.

+ # Who'd need more than that in a single command?

+ images_list = image_client.images(

+ id=f"in:{','.join(image_ids)}"

+ )

+ flavors[f_id] = compute_client.find_flavor(f_id)

+ flavors_list = compute_client.flavors(is_public=None)

+ if sdk_utils.supports_microversion(compute_client, '2.69'):

+ if 'id' in s.image and s.image.id is not None:

+ if not sdk_utils.supports_microversion(compute_client, '2.47'):

+ if hasattr(s, 'security_groups') and s.security_groups is not None:

+ sdk_utils.supports_microversion(compute_client, '2.16') and

+ if any([s.host_status is not None for s in data]):

+ 'task_state',

+ 'power_state',

+ 'availability_zone',

+ 'host',

+ 'power_state': PowerStateColumn,

+ 'addresses': AddressesColumn,

+ 'hypervisor_hostname': HostColumn,

+ _description = _("""Lock server(s)

+

+A non-admin user will not be able to execute actions.""")

+ '--reimage-boot-volume',

+ action='store_true',

+ dest='reimage_boot_volume',

+ default=None,

+ help=_(

+ 'Rebuild a volume-backed server. This will wipe the root '

+ 'volume data and overwrite it with the provided image. '

+ 'Defaults to False. '

+ '(supported by --os-compute-api-version 2.93 or above)'

+ ),

+ )

+ parser.add_argument(

+ '--no-reimage-boot-volume',

+ action='store_false',

+ dest='reimage_boot_volume',

+ default=None,

+ help=_(

+ 'Do not rebuild a volume-backed server. '

+ '(supported by --os-compute-api-version 2.93 or above)'

+ ),

+ )

+ parser.add_argument(

+ # If parsed_args.image is not set and if the instance is image backed,

+ # default to the currently used one. If the instance is volume backed,

+ # it is not trivial to fetch the current image and probably better

+ # to error out in this case and ask user to supply the image.

+ if not server.image:

+ msg = _(

+ 'The --image option is required when rebuilding a '

+ 'volume-backed server'

+ )

+ raise exceptions.CommandError(msg)

+ image = image_client.get_image(server.image['id'])

+ v2_93 = api_versions.APIVersion('2.93')

+ if parsed_args.reimage_boot_volume:

+ if compute_client.api_version < v2_93:

+ msg = _(

+ '--os-compute-api-version 2.93 or greater is required to '

+ 'support the --reimage-boot-volume option'

+ )

+ raise exceptions.CommandError(msg)

+ else:

+ # force user to explicitly request reimaging of volume-backed

+ # server

+ if not server.image:

+ if compute_client.api_version >= v2_93:

+ msg = (

+ '--reimage-boot-volume is required to rebuild a '

+ 'volume-backed server'

+ )

+ raise exceptions.CommandError(msg)

+ else: # microversion < 2.93

+ # attempts to rebuild a volume-backed server before API

+ # microversion 2.93 will fail in all cases except one: if

+ # the user attempts the rebuild with the exact same image

+ # that the server was initially built with. We can't check

+ # for this since we don't have the original image ID to

+ # hand, so we simply warn the user.

+ # TODO(stephenfin): Make this a failure in a future

+ # version

+ self.log.warning(

+ 'Attempting to rebuild a volume-backed server using '

+ '--os-compute-api-version 2.92 or earlier, which '

+ 'will only succeed if the image is identical to the '

+ 'one initially used. This will be an error in a '

+ 'future release.'

+ )

+

+ server.evacuate(**kwargs)

+ compute_client, image_client, server, refresh=True)

+ _description = _(

+ "Put server in rescue mode. "

+ "Specify ``--os-compute-api-version 2.87`` or higher to rescue a "

+ "server booted from a volume."

+ )

+ compute_client = self.app.client_manager.sdk_connection.compute

+

+ # Find by name or ID, then get the full details of the server

+ server = compute_client.find_server(

+ parsed_args.server, ignore_missing=False)

+ server = compute_client.get_server(server)

+ data = compute_client.get_server_diagnostics(server)

+ if not sdk_utils.supports_microversion(compute_client, '2.78'):

+ topology = server.fetch_topology(compute_client)

+ # TODO(dannosliwcd): Replace these clients with SDK clients after

+ # all callers of _prep_server_detail() are using the SDK.

+ self.app.client_manager.compute,

+ self.app.client_manager.image,

+ server,

+ _description = _("Start server(s)")

+ _description = _("Stop server(s)")

+ group = parser.add_mutually_exclusive_group()

+ group.add_argument(

+ group.add_argument(

+ '--no-availability-zone',

+ action='store_true',

+ default=False,

+ help=_('Unpin the availability zone of a SHELVED_OFFLOADED '

+ 'server. Server will be unshelved on a host without '

+ 'availability zone constraint (supported by '

+ '--os-compute-api-version 2.91 or above)'),

+ )

+ parser.add_argument(

+ '--host',

+ default=None,

+ help=_('Name of the destination host in which to unshelve a '

+ 'SHELVED_OFFLOADED server (supported by '

+ '--os-compute-api-version 2.91 or above)'),

+ )

+ if parsed_args.host:

+ if compute_client.api_version < api_versions.APIVersion('2.91'):

+ msg = _(

+ '--os-compute-api-version 2.91 or greater is required '

+ 'to support the --host option'

+ )

+ raise exceptions.CommandError(msg)

+

+ kwargs['host'] = parsed_args.host

+

+ if parsed_args.no_availability_zone:

+ if compute_client.api_version < api_versions.APIVersion('2.91'):

+ msg = _(

+ '--os-compute-api-version 2.91 or greater is required '

+ 'to support the --no-availability-zone option'

+ )

+ raise exceptions.CommandError(msg)

+

+ kwargs['availability_zone'] = None

+

+from openstack import utils as sdk_utils

+ 'dest_host', 'status', 'server_id', 'old_flavor_id',

+ 'new_flavor_id', 'created_at', 'updated_at',

+ if sdk_utils.supports_microversion(compute_client, "2.59"):

+ if sdk_utils.supports_microversion(compute_client, "2.23"):

+ if sdk_utils.supports_microversion(compute_client, "2.80"):

+ compute_client = self.app.client_manager.sdk_connection.compute

+ search_opts = {}

+

+ if parsed_args.host is not None:

+ search_opts['host'] = parsed_args.host

+

+ if parsed_args.status is not None:

+ search_opts['status'] = parsed_args.status

+ server = compute_client.find_server(parsed_args.server)

+ if server is None:

+ msg = _('Unable to find server: %s') % parsed_args.server

+ raise exceptions.CommandError(msg)

+ search_opts['instance_uuid'] = server.id

+ if not sdk_utils.supports_microversion(compute_client, "2.59"):

+ if not sdk_utils.supports_microversion(compute_client, "2.59"):

+ search_opts['paginated'] = False

+ if not sdk_utils.supports_microversion(compute_client, "2.59"):

+ if not sdk_utils.supports_microversion(compute_client, "2.66"):

+ if not sdk_utils.supports_microversion(compute_client, "2.80"):

+ if not sdk_utils.supports_microversion(compute_client, "2.80"):

+ migrations = list(compute_client.migrations(**search_opts))

+ return len(self._value) if self._value is not None else None

+ 'project_id': functools.partial(

+ if next_usage.project_id in usages:

+ _merge_usage(usages[next_usage.project_id], next_usage)

+ usages[next_usage.project_id] = next_usage

+ compute_client = self.app.client_manager.sdk_connection.compute

+ "project_id",

+ date_cli_format = "%Y-%m-%d"

+ date_api_format = "%Y-%m-%dT%H:%M:%S"

+ start = datetime.datetime.strptime(

+ parsed_args.start, date_cli_format)

+ end = datetime.datetime.strptime(parsed_args.end, date_cli_format)

+ usage_list = list(compute_client.usages(

+ start=start.strftime(date_api_format),

+ end=end.strftime(date_api_format),

+ detailed=True))

+ "start": start.strftime(date_cli_format),

+ "end": end.strftime(date_cli_format),

+ compute_client = self.app.client_manager.sdk_connection.compute

+ date_cli_format = "%Y-%m-%d"

+ date_api_format = "%Y-%m-%dT%H:%M:%S"

+ start = datetime.datetime.strptime(

+ parsed_args.start, date_cli_format)

+ end = datetime.datetime.strptime(parsed_args.end, date_cli_format)

+ usage = compute_client.get_usage(

+ project=project, start=start.strftime(date_api_format),

+ end=end.strftime(date_api_format))

+ "start": start.strftime(date_cli_format),

+ "end": end.strftime(date_cli_format),

+ "project_id",

+ parser.add_argument(

+ '--authorization-ttl',

+ metavar='<authorization-ttl>',

+ type=int,

+ help=_('Time to keep the role assignments for users '

+ 'authenticating via this identity provider. '

+ 'When not provided, global default configured in the '

+ 'Identity service will be used. '

+ 'Available since Identity API version 3.14 (Ussuri).'),

+ )

+ # TODO(pas-ha) actually check for 3.14 microversion

+ kwargs = {}

+ auth_ttl = parsed_args.authorization_ttl

+ if auth_ttl is not None:

+ if auth_ttl < 0:

+ msg = (_("%(param)s must be positive integer or zero."

+ ) % {"param": "authorization-ttl"})

+ raise exceptions.CommandError(msg)

+ kwargs['authorization_ttl'] = auth_ttl

+

+ enabled=parsed_args.enabled,

+ **kwargs)

+ parser.add_argument(

+ '--authorization-ttl',

+ metavar='<authorization-ttl>',

+ type=int,

+ help=_('Time to keep the role assignments for users '

+ 'authenticating via this identity provider. '

+ 'Available since Identity API version 3.14 (Ussuri).'),

+ )

+ # TODO(pas-ha) actually check for 3.14 microversion

+ # TODO(pas-ha) make it possible to reset authorization_ttl

+ # back to None value.

+ # Currently not possible as filter_kwargs decorator in

+ # keystoneclient/base.py explicitly drops the None-valued keys

+ # from kwargs, and 'update' method is wrapped in this decorator.

+ auth_ttl = parsed_args.authorization_ttl

+ if auth_ttl is not None:

+ if auth_ttl < 0:

+ msg = (_("%(param)s must be positive integer or zero."

+ ) % {"param": "authorization-ttl"})

+ raise exceptions.CommandError(msg)

+ kwargs['authorization_ttl'] = auth_ttl

+

+ def get_parser(self, prog_name):

+ parser = super().get_parser(prog_name)

+ parser.add_argument(

+ '--trustor',

+ metavar='<trustor-user>',

+ help=_('Trustor user to filter (name or ID)'),

+ )

+ parser.add_argument(

+ '--trustee',

+ metavar='<trustee-user>',

+ help=_('Trustee user to filter (name or ID)'),

+ )

+ parser.add_argument(

+ '--trustor-domain',

+ metavar='<trustor-domain>',

+ help=_('Domain that contains <trustor> (name or ID)'),

+ )

+ parser.add_argument(

+ '--trustee-domain',

+ metavar='<trustee-domain>',

+ help=_('Domain that contains <trustee> (name or ID)'),

+ )

+ parser.add_argument(

+ '--auth-user',

+ action="store_true",

+ dest='authuser',

+ help=_('Only list trusts related to the authenticated user'),

+ )

+ return parser

+

+ identity_client = self.app.client_manager.identity

+ auth_ref = self.app.client_manager.auth_ref

+

+ if parsed_args.authuser and any([

+ parsed_args.trustor,

+ parsed_args.trustor_domain,

+ parsed_args.trustee,

+ parsed_args.trustee_domain,

+ ]):

+ msg = _("--authuser cannot be used with --trustee or --trustor")

+ raise exceptions.CommandError(msg)

+

+ if parsed_args.trustee_domain and not parsed_args.trustee:

+ msg = _("Using --trustee-domain mandates the use of --trustee")

+ raise exceptions.CommandError(msg)

+

+ if parsed_args.trustor_domain and not parsed_args.trustor:

+ msg = _("Using --trustor-domain mandates the use of --trustor")

+ raise exceptions.CommandError(msg)

+

+ if parsed_args.authuser:

+ if auth_ref:

+ user = common.find_user(

+ identity_client,

+ auth_ref.user_id

+ )

+ # We need two calls here as we want trusts with

+ # either the trustor or the trustee set to current user

+ # using a single call would give us trusts with both

+ # trustee and trustor set to current user

+ data1 = identity_client.trusts.list(trustor_user=user)

+ data2 = identity_client.trusts.list(trustee_user=user)

+ data = set(data1 + data2)

+ else:

+ trustor = None

+ if parsed_args.trustor:

+ trustor = common.find_user(

+ identity_client,

+ parsed_args.trustor,

+ parsed_args.trustor_domain,

+ )

+

+ trustee = None

+ if parsed_args.trustee:

+ trustee = common.find_user(

+ identity_client,

+ parsed_args.trustor,

+ parsed_args.trustor_domain,

+ )

+

+ data = self.app.client_manager.identity.trusts.list(

+ trustor_user=trustor,

+ trustee_user=trustee,

+ )

+

+

+from openstack import exceptions as sdk_exceptions

+from openstackclient.identity import common as identity_common

+def get_data_from_stdin():

+ # distinguish cases where:

+ # (1) stdin is not valid (as in cron jobs):

+ # openstack ... <&-

+ # (2) image data is provided through stdin:

+ # openstack ... < /tmp/file

+ # (3) no image data provided

+ # openstack ...

+ try:

+ os.fstat(0)

+ except OSError:

+ # (1) stdin is not valid

+ return None

+

+ if not sys.stdin.isatty():

+ # (2) image data is provided through stdin

+ image = sys.stdin

+ if hasattr(sys.stdin, 'buffer'):

+ image = sys.stdin.buffer

+ if msvcrt:

+ msvcrt.setmode(sys.stdin.fileno(), os.O_BINARY)

+

+ return image

+ # (3)

+ return None

+ identity_common.add_project_domain_option_to_parser(parser)

+ project_id = identity_common.find_project(

+ identity_client,

+ parsed_args.project,

+ parsed_args.project_domain,

+ ).id

+ parsed_args.image,

+ ignore_missing=False,

+ dest="filename",

+ help=_(

+ "Show upload progress bar "

+ "(ignored if passing data via stdin)"

+ ),

+ identity_common.add_project_domain_option_to_parser(parser)

+ kwargs['owner_id'] = identity_common.find_project(

+ if parsed_args.filename:

+ try:

+ fp = open(parsed_args.filename, 'rb')

+ except FileNotFoundError:

+ raise exceptions.CommandError(

+ '%r is not a valid file' % parsed_args.filename,

+ )

+ else:

+ fp = get_data_from_stdin()

+ if parsed_args.progress and parsed_args.filename:

+ # NOTE(stephenfin): we only show a progress bar if the user

+ # requested it *and* we're reading from a file (not stdin)

+ filesize = os.path.getsize(parsed_args.filename)

+ else:

+ kwargs['data'] = fp

+ elif parsed_args.filename:

+ kwargs['filename'] = parsed_args.filename

+ if not parsed_args.filename:

+

+ if parsed_args.filename:

+ fp.close()

+

+ image,

+ ignore_missing=False,

+ identity_common.add_project_domain_option_to_parser(parser)

+ kwargs['marker'] = image_client.find_image(

+ parsed_args.marker,

+ ignore_missing=False,

+ ).id

+ project_id = identity_common.find_project(

+ identity_common.add_project_domain_option_to_parser(parser)

+ image_id = image_client.find_image(

+ parsed_args.image,

+ ignore_missing=False,

+ ).id

+ identity_common.add_project_domain_option_to_parser(parser)

+ project_id = identity_common.find_project(

+ identity_client,

+ parsed_args.project,

+ parsed_args.project_domain,

+ parsed_args.image,

+ ignore_missing=False,

+ dest="filename",

+ image = image_client.find_image(

+ parsed_args.image,

+ ignore_missing=False,

+ )

+ output_file = parsed_args.filename

+ identity_common.add_project_domain_option_to_parser(parser)

+ project_id = identity_common.find_project(

+ parsed_args.image,

+ ignore_missing=False,

+ parsed_args.image,

+ ignore_missing=False,

+

+

+class StageImage(command.Command):

+ _description = _(

+ "Upload data for a specific image to staging.\n"

+ "This requires support for the interoperable image import process, "

+ "which was first introduced in Image API version 2.6 "

+ "(Glance 16.0.0 (Queens))"

+ )

+

+ def get_parser(self, prog_name):

+ parser = super().get_parser(prog_name)

+

+ parser.add_argument(

+ '--file',

+ metavar='<file>',

+ dest='filename',

+ help=_(

+ 'Local file that contains disk image to be uploaded. '

+ 'Alternatively, images can be passed via stdin.'

+ ),

+ )

+ # NOTE(stephenfin): glanceclient had a --size argument but it didn't do

+ # anything so we have chosen not to port this

+ parser.add_argument(

+ '--progress',

+ action='store_true',

+ default=False,

+ help=_(

+ 'Show upload progress bar '

+ '(ignored if passing data via stdin)'

+ ),

+ )

+ parser.add_argument(

+ 'image',

+ metavar='<image>',

+ help=_('Image to upload data for (name or ID)'),

+ )

+

+ return parser

+

+ def take_action(self, parsed_args):

+ image_client = self.app.client_manager.image

+

+ image = image_client.find_image(

+ parsed_args.image,

+ ignore_missing=False,

+ )

+ # open the file first to ensure any failures are handled before the

+ # image is created. Get the file name (if it is file, and not stdin)

+ # for easier further handling.

+ if parsed_args.filename:

+ try:

+ fp = open(parsed_args.filename, 'rb')

+ except FileNotFoundError:

+ raise exceptions.CommandError(

+ '%r is not a valid file' % parsed_args.filename,

+ )

+ else:

+ fp = get_data_from_stdin()

+

+ kwargs = {}

+

+ if parsed_args.progress and parsed_args.filename:

+ # NOTE(stephenfin): we only show a progress bar if the user

+ # requested it *and* we're reading from a file (not stdin)

+ filesize = os.path.getsize(parsed_args.filename)

+ if filesize is not None:

+ kwargs['data'] = progressbar.VerboseFileWrapper(fp, filesize)

+ else:

+ kwargs['data'] = fp

+ elif parsed_args.filename:

+ kwargs['filename'] = parsed_args.filename

+ elif fp:

+ kwargs['data'] = fp

+

+ image_client.stage_image(image, **kwargs)

+

+

+class ImportImage(command.ShowOne):

+ _description = _(

+ "Initiate the image import process.\n"

+ "This requires support for the interoperable image import process, "

+ "which was first introduced in Image API version 2.6 "

+ "(Glance 16.0.0 (Queens))"

+ )

+

+ def get_parser(self, prog_name):

+ parser = super().get_parser(prog_name)

+

+ parser.add_argument(

+ 'image',

+ metavar='<image>',

+ help=_('Image to initiate import process for (name or ID)'),

+ )

+ # TODO(stephenfin): Uncomment help text when we have this command

+ # implemented

+ parser.add_argument(

+ '--method',

+ metavar='<method>',

+ default='glance-direct',

+ dest='import_method',

+ choices=[

+ 'glance-direct',

+ 'web-download',

+ 'glance-download',

+ 'copy-image',

+ ],

+ help=_(

+ "Import method used for image import process. "

+ "Not all deployments will support all methods. "

+ # "Valid values can be retrieved with the 'image import "

+ # "methods' command. "

+ "The 'glance-direct' method (default) requires images be "

+ "first staged using the 'image-stage' command."

+ ),

+ )

+ parser.add_argument(

+ '--uri',

+ metavar='<uri>',

+ help=_(

+ "URI to download the external image "

+ "(only valid with the 'web-download' import method)"

+ ),

+ )

+ parser.add_argument(

+ '--remote-image',

+ metavar='<REMOTE_IMAGE>',

+ help=_(

+ "The image of remote glance (ID only) to be imported "

+ "(only valid with the 'glance-download' import method)"

+ ),

+ )

+ parser.add_argument(

+ '--remote-region',

+ metavar='<REMOTE_GLANCE_REGION>',

+ help=_(

+ "The remote Glance region to download the image from "

+ "(only valid with the 'glance-download' import method)"

+ ),

+ )

+ parser.add_argument(

+ '--remote-service-interface',

+ metavar='<REMOTE_SERVICE_INTERFACE>',

+ help=_(

+ "The remote Glance service interface to use when importing "

+ "images "

+ "(only valid with the 'glance-download' import method)"

+ ),

+ )

+ stores_group = parser.add_mutually_exclusive_group()

+ stores_group.add_argument(

+ '--store',

+ metavar='<STORE>',

+ dest='stores',

+ nargs='*',

+ help=_(

+ "Backend store to upload image to "

+ "(specify multiple times to upload to multiple stores) "

+ "(either '--store' or '--all-stores' required with the "

+ "'copy-image' import method)"

+ ),

+ )

+ stores_group.add_argument(

+ '--all-stores',

+ help=_(

+ "Make image available to all stores "

+ "(either '--store' or '--all-stores' required with the "

+ "'copy-image' import method)"

+ ),

+ )

+ parser.add_argument(

+ '--allow-failure',

+ action='store_true',

+ dest='allow_failure',

+ default=True,

+ help=_(

+ 'When uploading to multiple stores, indicate that the import '

+ 'should be continue should any of the uploads fail. '

+ 'Only usable with --stores or --all-stores'

+ ),

+ )

+ parser.add_argument(

+ '--disallow-failure',

+ action='store_true',

+ dest='allow_failure',

+ default=True,

+ help=_(

+ 'When uploading to multiple stores, indicate that the import '

+ 'should be reverted should any of the uploads fail. '

+ 'Only usable with --stores or --all-stores'

+ ),

+ )

+ parser.add_argument(

+ '--wait',

+ action='store_true',

+ help=_('Wait for operation to complete'),

+ )

+ return parser

+

+ def take_action(self, parsed_args):

+ image_client = self.app.client_manager.image

+

+ try:

+ import_info = image_client.get_import_info()

+ except sdk_exceptions.ResourceNotFound:

+ msg = _(

+ 'The Image Import feature is not supported by this deployment'

+ )

+ raise exceptions.CommandError(msg)

+

+ import_methods = import_info.import_methods['value']

+

+ if parsed_args.import_method not in import_methods:

+ msg = _(

+ "The '%s' import method is not supported by this deployment. "

+ "Supported: %s"

+ )

+ raise exceptions.CommandError(

+ msg % (parsed_args.import_method, ', '.join(import_methods)),

+ )

+

+ if parsed_args.import_method == 'web-download':

+ if not parsed_args.uri:

+ msg = _(

+ "The '--uri' option is required when using "

+ "'--method=web-download'"

+ )

+ raise exceptions.CommandError(msg)

+ else:

+ if parsed_args.uri:

+ msg = _(

+ "The '--uri' option is only supported when using "

+ "'--method=web-download'"

+ )

+ raise exceptions.CommandError(msg)

+

+ if parsed_args.import_method == 'glance-download':

+ if not (parsed_args.remote_region and parsed_args.remote_image):

+ msg = _(

+ "The '--remote-region' and '--remote-image' options are "

+ "required when using '--method=web-download'"

+ )

+ raise exceptions.CommandError(msg)

+ else:

+ if parsed_args.remote_region:

+ msg = _(

+ "The '--remote-region' option is only supported when "

+ "using '--method=glance-download'"

+ )

+ raise exceptions.CommandError(msg)

+

+ if parsed_args.remote_image:

+ msg = _(

+ "The '--remote-image' option is only supported when using "

+ "'--method=glance-download'"

+ )

+ raise exceptions.CommandError(msg)

+

+ if parsed_args.remote_service_interface:

+ msg = _(

+ "The '--remote-service-interface' option is only "

+ "supported when using '--method=glance-download'"

+ )

+ raise exceptions.CommandError(msg)

+

+ if parsed_args.import_method == 'copy-image':

+ if not (parsed_args.stores or parsed_args.all_stores):

+ msg = _(

+ "The '--stores' or '--all-stores' options are required "

+ "when using '--method=copy-image'"

+ )

+ raise exceptions.CommandError(msg)

+

+ image = image_client.find_image(parsed_args.image)

+

+ if not image.container_format and not image.disk_format:

+ msg = _(

+ "The 'container_format' and 'disk_format' properties "

+ "must be set on an image before it can be imported"

+ )

+ raise exceptions.CommandError(msg)

+

+ if parsed_args.import_method == 'glance-direct':

+ if image.status != 'uploading':

+ msg = _(

+ "The 'glance-direct' import method can only be used with "

+ "an image in status 'uploading'"

+ )

+ raise exceptions.CommandError(msg)

+ elif parsed_args.import_method == 'web-download':

+ if image.status != 'queued':

+ msg = _(

+ "The 'web-download' import method can only be used with "

+ "an image in status 'queued'"

+ )

+ raise exceptions.CommandError(msg)

+ elif parsed_args.import_method == 'copy-image':

+ if image.status != 'active':

+ msg = _(

+ "The 'copy-image' import method can only be used with "

+ "an image in status 'active'"

+ )

+ raise exceptions.CommandError(msg)

+

+ image_client.import_image(

+ image,

+ method=parsed_args.import_method,

+ uri=parsed_args.uri,

+ remote_region=parsed_args.remote_region,

+ remote_image=parsed_args.remote_image,

+ remote_service_interface=parsed_args.remote_service_interface,

+ stores=parsed_args.stores,

+ all_stores=parsed_args.all_stores,

+ all_stores_must_succeed=not parsed_args.allow_failure,

+ )

+

+ info = _format_image(image)

+ return zip(*sorted(info.items()))

+# Copyright 2012-2013 OpenStack Foundation

+#

+# 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.

+#

+

+"""Image V2 Action Implementations"""

+

+import logging

+

+from osc_lib.cli import format_columns

+from osc_lib.command import command

+from osc_lib import exceptions

+from osc_lib import utils

+

+from openstackclient.i18n import _

+

+_formatters = {

+ 'tags': format_columns.ListColumn,

+}

+

+LOG = logging.getLogger(__name__)

+

+

+def _format_namespace(namespace):

+ info = {}

+

+ fields_to_show = [

+ 'created_at',

+ 'description',

+ 'display_name',

+ 'namespace',

+ 'owner',

+ 'protected',

+ 'schema',

+ 'visibility',

+ ]

+

+ namespace = namespace.to_dict(ignore_none=True, original_names=True)

+

+ # split out the usual key and the properties which are top-level

+ for key in namespace:

+ if key in fields_to_show:

+ info[key] = namespace.get(key)

+ elif key == "resource_type_associations":

+ info[key] = [resource_type['name']

+ for resource_type in namespace.get(key)]

+ elif key == 'properties':

+ info['properties'] = list(namespace.get(key).keys())

+

+ return info

+

+

+class CreateMetadefNameSpace(command.ShowOne):

+ _description = _("Create a metadef namespace")

+

+ def get_parser(self, prog_name):

+ parser = super().get_parser(prog_name)

+ parser.add_argument(

+ "namespace",

+ metavar="<namespace>",

+ help=_("New metadef namespace name"),

+ )

+ parser.add_argument(

+ "--display-name",

+ metavar="<display_name>",

+ help=_("A user-friendly name for the namespace."),

+ )

+ parser.add_argument(

+ "--description",

+ metavar="<description>",

+ help=_("A description of the namespace"),

+ )

+ visibility_group = parser.add_mutually_exclusive_group()

+ visibility_group.add_argument(

+ "--public",

+ action="store_const",

+ const="public",

+ dest="visibility",

+ help=_("Set namespace visibility 'public'"),

+ )

+ visibility_group.add_argument(

+ "--private",

+ action="store_const",

+ const="private",

+ dest="visibility",

+ help=_("Set namespace visibility 'private'"),

+ )

+ protected_group = parser.add_mutually_exclusive_group()

+ protected_group.add_argument(

+ "--protected",

+ action="store_const",

+ const=True,

+ dest="is_protected",

+ help=_("Prevent metadef namespace from being deleted"),

+ )

+ protected_group.add_argument(

+ "--unprotected",

+ action="store_const",

+ const=False,

+ dest="is_protected",

+ help=_("Allow metadef namespace to be deleted (default)"),

+ )

+ return parser

+

+ def take_action(self, parsed_args):

+ image_client = self.app.client_manager.image

+ filter_keys = [

+ 'namespace',

+ 'display_name',

+ 'description'

+ ]

+ kwargs = {}

+

+ for key in filter_keys:

+ argument = getattr(parsed_args, key, None)

+ if argument is not None:

+ kwargs[key] = argument

+

+ if parsed_args.is_protected is not None:

+ kwargs['protected'] = parsed_args.is_protected

+

+ if parsed_args.visibility is not None:

+ kwargs['visibility'] = parsed_args.visibility

+

+ data = image_client.create_metadef_namespace(**kwargs)

+

+ return zip(*sorted(data.items()))

+

+

+class DeleteMetadefNameSpace(command.Command):

+ _description = _("Delete metadef namespace")

+

+ def get_parser(self, prog_name):

+ parser = super().get_parser(prog_name)

+ parser.add_argument(

+ "namespace_name",

+ metavar="<namespace_name>",

+ nargs="+",

+ help=_("An identifier (a name) for the namespace"),

+ )

+ return parser

+