OpenKeel: the sovereign French Cloud solution of the inherent group, with a European reach Discover inherent

Reverse-spec · Clients

python-openstackclient — Cli commands

CLI commands — python-openstackclient — branch stable/2026.2

Branch stable/2026.2 @ 8bb083b83829 — repository https://opendev.org/openstack/python-openstackclient — analysed on 2026-11-01

This project exposes no REST API. Its interface is the command line, so this file replaces 01-rest-api. The calls it sends are in 03 and in [_rewrite/api-surface_stable-2026.2.md](_rewrite/api-surface_stable-2026.2.md). Every argument of every command, with type, default and help, is in [_rewrite/cli-commands_stable-2026.2.json](_rewrite/cli-commands_stable-2026.2.json).

1. Shared mechanics

1.1 Loading commands

  • Declaration: commands are entry points in pyproject.toml, for example pyproject.toml:48 for openstack.common. server_add_fixed_ip becomes server add fixed ip.
  • Base modules: openstack.cli.base lists six service modules (pyproject.toml:40). External plugins register in openstack.cli.extension (openstackclient/common/clientmanager.py:273).
  • Group selection: for each module, the shell reads the requested version and adds the group openstack.<api>.v<major> (openstackclient/shell.py:150). Only commands of that major version exist in the run, so volume create is a different class under --os-volume-api-version 2.
  • Network extensions: bgpvpn, fwaas, taas, dynamic_routing and vpnaas are added as subgroups (openstackclient/network/client.py:28, openstackclient/shell.py:167).
  • Ignored modules: modules that moved into OSC are skipped when a plugin still declares them, and openstackclient.share.v2 is skipped on purpose (openstackclient/shell.py:34, cliff:cliff/commandmanager.py:109).
ServiceDefault versionClientDefined at
compute2.1sdk_connection.computeopenstackclient/compute/client.py:26, openstackclient/compute/client.py:32
identity3python-keystoneclient, and sdk_connection.identity for most commandsopenstackclient/identity/client.py:27, openstackclient/identity/client.py:44
image2sdk_connection.imageopenstackclient/image/client.py:26, openstackclient/image/client.py:32
network2.0sdk_connection.networkopenstackclient/network/client.py:24, openstackclient/network/client.py:37
object_store1openstackclient.api.object_store_v1.APIv1openstackclient/object/client.py:26, openstackclient/object/client.py:32
volume3sdk_connection.block_storageopenstackclient/volume/client.py:26, openstackclient/volume/client.py:32

1.2 Authentication

  • Default plugin: password, or admin_token when both --os-endpoint and --os-token are given (openstackclient/shell.py:84).
  • When it happens: just before the command runs, only if auth_required is true, which is the default (osc-lib:osc_lib/shell.py:101, osc-lib:osc_lib/shell.py:509).
  • Commands without authentication: command list, module list and configuration show (openstackclient/common/module.py:33, openstackclient/common/module.py:80, openstackclient/common/configuration.py:31).
  • Scope: a scoped token is required unless the command sets required_scope = False, like token issue (osc-lib:osc_lib/shell.py:529).

1.3 Name or ID resolution

Most arguments accept a name or an ID. Resolution costs requests before the real operation [observed]:

ClientRequestsExample
SDK find_*GET /resource/{value}, then a filtered list on 404GET /networks/x, GET /networks?name=x
SDK find_* on compute and block storagesame, with the detailed listGET /servers/x, GET /servers/detail?name=x
osc-lib find_resource with keystoneclientmanager.get, then manager.find (osc-lib:osc_lib/utils/__init__.py:204)users.find_resource

1.4 Microversions

A command checks an option against the service with sdk_utils.supports_microversion (openstacksdk:openstack/utils.py:242). On failure it raises a CommandError such as --os-compute-api-version 2.49 or greater is required to support the --tag option. See 03 § Microversions.

1.5 Output

command.Lister gives a table (list below), command.ShowOne gives a record (single), and command.Command prints nothing (none). The formatter options (-f table|json|yaml|csv|value, -c, --sort-column) come from cliff and are not repeated per command.

1.6 Multiple targets

delete commands accept several names and continue after a failure, then raise a summary: 2 of 2 servers failed to delete. [observed] (openstackclient/compute/v2/server.py:2309).

1.7 Global options

From osc-lib:osc_lib/shell.py:217 onwards: --os-cloud, --os-region-name, --os-cacert, --os-cert, --os-key, --verify, --insecure, --os-default-domain, --os-interface, --os-service-provider, --os-remote-project-*, --timing, --os-beta-command, --os-profile. To these, each service adds --os-<service>-api-version, and the auth plugin adds its own --os-* options (openstackclient/shell.py:80).

2. Functional description per service

2.1 Cross-service commands (openstack.common)

  • **quota show, quota set, quota list, quota delete**: the only commands that merge several services. Each service is called only if its catalog entry exists (openstackclient/common/quota.py:604, openstackclient/common/quota.py:628).
  • **limits show**: reads compute and block storage limits, skipping services missing from the catalog (openstackclient/common/limits.py:123, openstackclient/common/limits.py:129).
  • **availability zone list, extension list**: aggregate compute, network and volume answers (openstackclient/common/availability_zone.py:146, openstackclient/common/extension.py:103).
  • **versions show**: asks keystoneauth for the version documents of every service (openstackclient/common/versions.py:82).
  • **project cleanup: **destructive. It lists through the SDK, asks for confirmation unless --auto-approve is set, then deletes (openstackclient/common/project_cleanup.py:48). The work is done by connection.project_cleanup in the SDK.
  • **configuration show**: shows the resolved configuration without contacting anything; passwords are masked unless --unmask is given (openstackclient/common/configuration.py:28).

2.2 Compute (openstack.compute.v2, 100 commands)

Servers and their actions, flavors, keypairs, aggregates, hypervisors, migrations, volume and share attachments, server groups, consoles.

  • **server create** is the most complex command: it resolves image, flavor, networks and volumes, validates about 20 option combinations locally, then sends one POST /servers (openstackclient/compute/v2/server.py:1634, openstackclient/compute/v2/server.py:2257). With --wait, it polls until active or error (openstackclient/compute/v2/server.py:2264). See 04.
  • Server actions (reboot, rescue, resize, migrate, add fixed ip…) are POST /servers/{id}/action calls with the action in the body key [observed for routes].
  • Legacy calls without a proxy method go through openstackclient/api/compute_v2.py:29: os-security-groups, os-networks and os-floating-ips, pinned to microversion 2.1 (openstackclient/api/compute_v2.py:68). compute agent and host commands do the same with raw get and put [observed].
  • **server list** is costly with names enabled: it also fetches all images and flavors (openstackclient/compute/v2/server.py:3142, openstackclient/compute/v2/server.py:3172).
  • Neutron or Nova network: commands such as server add fixed ip choose a path through is_network_endpoint_enabled (openstackclient/compute/v2/server.py:424), which treats an unknown catalog as "network present" (openstackclient/common/clientmanager.py:148).

2.3 Identity (openstack.identity.v3, 128 commands; openstack.identity.v2, 34)

Users, projects, domains, groups, roles and assignments, services and endpoints, regions, credentials, application credentials, trusts, federation (identity providers, mappings, protocols, service providers), OAuth1, limits, implied roles.

  • Two stacks: most commands use sdk_connection.identity; OAuth1, EC2 credentials, endpoint groups and some lookups still use python-keystoneclient (openstackclient/identity/client.py:44).
  • **token issue and catalog list** send nothing themselves: they read the token obtained during authentication (openstackclient/identity/v3/token.py:187, openstackclient/identity/v3/catalog.py:43).
  • Password prompts: user create --password-prompt and user password set read from the terminal (openstackclient/identity/v3/user.py:303, openstackclient/identity/v3/user.py:771).
  • Rules read from files: mapping create and policy create read a local file before any request [observed: Error occurred trying to read from file x] (openstackclient/identity/v3/mapping.py:50).

2.4 Image (openstack.image.v2, 42 commands; openstack.image.v1, 6)

Images, members, tasks, metadata definitions, stores and cache.

  • **image create** creates the record and uploads in one SDK call, from --file or from stdin when stdin is not a terminal (openstackclient/image/v2/image.py:181, openstackclient/image/v2/image.py:623).
  • **image stage** and **image import** split the upload for the interoperable import workflow (openstackclient/image/v2/image.py:1710).
  • **image save** writes to a file, or to stdout by default (openstackclient/image/v2/image.py:1141).

2.5 Network (openstack.network.v2, 168 commands, plus 100 in extensions)

Networks, subnets, ports, routers, floating IPs, security groups, QoS, trunks, RBAC, agents, address scopes, subnet pools, segments, meters, plus extensions:

ExtensionCommandsModule
VPNaaS25openstackclient/network/v2/vpnaas/__init__.py
BGPVPN22openstackclient/network/v2/bgpvpn/__init__.py
FWaaS20openstackclient/network/v2/fwaas/__init__.py
Dynamic routing18openstackclient/network/v2/dynamic_routing/__init__.py
Tap as a service15openstackclient/network/v2/taas/__init__.py
  • **--extra-property**: several commands forward arbitrary fields to Neutron, with type conversion (openstackclient/network/common.py:59).
  • Feature detection: some commands read an extension before acting, for example router add gateway on GET /extensions/external-gateway-multihoming [observed].
  • No microversions: Neutron requests carry no version header [observed].

2.6 Object store (openstack.object_store.v1, 17 commands)

Containers, objects and account metadata. This is the only service with its own HTTP code rather than an SDK.

  • **object create** streams a local file in a PUT (openstackclient/api/object_store_v1.py:254). The object name defaults to the local path.
  • **object save** streams in 64 KiB chunks, to a file or stdout (openstackclient/api/object_store_v1.py:378).
  • **container save** lists the objects, then downloads each one in sequence (openstackclient/api/object_store_v1.py:148).
  • Metadata uses X-Container-Meta-*, X-Object-Meta-* and X-Account-Meta-* headers (openstackclient/api/object_store_v1.py:552).

2.7 Volume (openstack.volume.v3, 94 commands; openstack.volume.v2, 57)

Volumes, snapshots, backups, types, QoS, transfers, attachments, groups, consistency groups, services, clusters, messages, manageable resources.

  • **volume create**: after the POST, --bootable or --read-only wait for the volume, then send a second action (openstackclient/volume/v3/volume.py:447, openstackclient/volume/v3/volume.py:464). --size is required unless a source is given [observed].
  • Consistency groups have no SDK method and use openstackclient/api/volume_v3.py:29.

2.8 Lifecycle of a resource

The CLI holds no state. Status belongs to the services. The only client-side lifecycle is --wait polling, described in 05.

3. All commands

Reading the table. Args (required) counts the arguments, excluding formatter options. First requests observed are the requests sent to the stub, across its 404 and {} modes, with the microversion in brackets. Discovery and authentication requests are excluded. An empty cell does not mean that the command sends nothing: see 00 § Blind spots.

openstack.cli (2 commands)

CommandPurposeDefined atOutputArgs (required)Min. microversions in the codeFirst requests observed
command listList recognized commands by groupopenstackclient/common/module.py:30list1 (0)
module listList module versionsopenstackclient/common/module.py:77single1 (0)

openstack.common (11 commands)

CommandPurposeDefined atOutputArgs (required)Min. microversions in the codeFirst requests observed
availability zone listList availability zones and their statusopenstackclient/common/availability_zone.py:106list5 (0)GET /os-availability-zone/detail
configuration showDisplay configuration detailsopenstackclient/common/configuration.py:28single2 (0)
extension listList API extensionsopenstackclient/common/extension.py:44list5 (0)GET /extensions
extension showShow API extensionopenstackclient/common/extension.py:159single1 (1)GET /extensions/{id}; GET /extensions
limits showShow compute and block storage limitsopenstackclient/common/limits.py:55list6 (0)GET /limits; GET /limits (3.39)
project cleanupClean resources associated with a projectopenstackclient/common/project_cleanup.py:48none8 (0)GET /object/info; GET /; GET /servers/detail (2.100)
quota deleteDelete configured quota for a project and revert to defaults.openstackclient/common/quota.py:880none5 (1)GET /projects/{id}; GET /projects; DELETE /os-quota-sets/{id} (2.56)
quota listList quotas for all projects with non-default quota values.openstackclient/common/quota.py:232list3 (0)GET /projects
quota setSet quotas for project or classopenstackclient/common/quota.py:489none34 (0)
quota showShow quotas for project or class.openstackclient/common/quota.py:675list7 (0)GET /os-quota-sets/{project_id} (2.56); GET /os-quota-sets/{project_id}; GET /quotas/p
versions showShow available versions of servicesopenstackclient/common/versions.py:25list5 (0)GET /

openstack.compute.v2 (100 commands)

CommandPurposeDefined atOutputArgs (required)Min. microversions in the codeFirst requests observed
aggregate add hostAdd host to aggregateopenstackclient/compute/v2/aggregate.py:60single2 (2)GET /os-aggregates/{id} (2.81); GET /os-aggregates (2.81); POST /os-aggregates/{id}/action
aggregate cache imageRequest image caching for aggregateopenstackclient/compute/v2/aggregate.py:452none2 (2)2.81GET /os-aggregates/{id} (2.81); GET /os-aggregates (2.81); GET /images/{id}
aggregate createCreate a new aggregateopenstackclient/compute/v2/aggregate.py:95single3 (1)POST /os-aggregates (2.81)
aggregate deleteDelete existing aggregate(s)openstackclient/compute/v2/aggregate.py:145none1 (1)GET /os-aggregates/{id} (2.81); GET /os-aggregates (2.81); DELETE /os-aggregates/{id} (2.81)
aggregate listList all aggregatesopenstackclient/compute/v2/aggregate.py:188list3 (0)2.41GET /os-aggregates (2.81)
aggregate remove hostRemove host from aggregateopenstackclient/compute/v2/aggregate.py:279single2 (2)GET /os-aggregates/{id} (2.81); GET /os-aggregates (2.81); POST /os-aggregates/{id}/action
aggregate setSet aggregate propertiesopenstackclient/compute/v2/aggregate.py:314none5 (1)GET /os-aggregates/{id} (2.81); GET /os-aggregates (2.81)
aggregate showDisplay aggregate detailsopenstackclient/compute/v2/aggregate.py:386single1 (1)GET /os-aggregates/{id} (2.81); GET /os-aggregates (2.81)
aggregate unsetUnset aggregate propertiesopenstackclient/compute/v2/aggregate.py:417none2 (1)GET /os-aggregates/{id} (2.81); GET /os-aggregates (2.81)
compute agent createCreate compute agent.openstackclient/compute/v2/agent.py:33single6 (6)POST /os-agents (2.1)
compute agent deleteDelete compute agent(s).openstackclient/compute/v2/agent.py:87none1 (1)DELETE /os-agents/{id} (2.1)
compute agent listList compute agents.openstackclient/compute/v2/agent.py:129list1 (0)GET /os-agents (2.1)
compute agent setSet compute agent properties.openstackclient/compute/v2/agent.py:173none4 (1)GET /os-agents (2.1)
compute service deleteDelete compute service(s)openstackclient/compute/v2/service.py:35none1 (1)DELETE /os-services/{id} (2.69)
compute service listList compute services.openstackclient/compute/v2/service.py:82list3 (0)2.11GET /os-services (2.69)
compute service setSet compute service propertiesopenstackclient/compute/v2/service.py:152none7 (2)2.11, 2.53GET /os-services (2.69)
console connection showShow server's remote console connection informationopenstackclient/compute/v2/console_connection.py:36single1 (1)GET /os-console-auth-tokens/{id} (2.99)
console log showShow server's console outputopenstackclient/compute/v2/console.py:38none2 (1)GET /servers/{id} (2.100); GET /servers/detail (2.100); POST /servers/{id}/action (2.100)
console url showShow server's remote console URLopenstackclient/compute/v2/console.py:82single8 (1)GET /servers/{id} (2.100); GET /servers/detail (2.100); POST /servers/{id}/remote-consoles (2.99)
flavor createCreate new flavoropenstackclient/compute/v2/flavor.py:60single14 (1)2.55, 2.102POST /flavors (2.61)
flavor deleteDelete flavor(s)openstackclient/compute/v2/flavor.py:241none1 (1)GET /flavors/{id} (2.61); GET /flavors/detail (2.61); DELETE /flavors/{id} (2.61)
flavor listList flavorsopenstackclient/compute/v2/flavor.py:280list9 (0)GET /flavors/detail (2.61)
flavor setSet flavor propertiesopenstackclient/compute/v2/flavor.py:406none6 (1)2.55GET /flavors/{id} (2.61); GET /flavors/detail (2.61); GET /flavors/{id}/os-extra_specs (2.61)
flavor showDisplay flavor detailsopenstackclient/compute/v2/flavor.py:520single1 (1)GET /flavors/{id} (2.61); GET /flavors/detail (2.61); GET /flavors/{id}/os-extra_specs (2.61)
flavor unsetUnset flavor propertiesopenstackclient/compute/v2/flavor.py:571none4 (1)GET /flavors/{id} (2.61); GET /flavors/detail (2.61); GET /flavors/{id}/os-extra_specs (2.61)
host listDEPRECATED: List hostsopenstackclient/compute/v2/host.py:29list1 (0)GET /os-hosts (2.1)
host setDEPRECATED: Set host propertiesopenstackclient/compute/v2/host.py:63none5 (1)
host showDEPRECATED: Display host detailsopenstackclient/compute/v2/host.py:121list1 (1)GET /os-hosts/{id} (2.1)
hypervisor listList hypervisorsopenstackclient/compute/v2/hypervisor.py:75list5 (0)2.33, 2.88GET /os-hypervisors/detail (2.88)
hypervisor showDisplay hypervisor detailsopenstackclient/compute/v2/hypervisor.py:169single1 (1)2.28, 2.88GET /os-hypervisors/{id} (2.88); GET /os-hypervisors (2.88)
hypervisor stats showDisplay hypervisor stats detailsopenstackclient/compute/v2/hypervisor_stats.py:45single0 (0)GET /os-hypervisors/statistics (2.1)
keypair createCreate new public or private key for server ssh accessopenstackclient/compute/v2/keypair.py:82single6 (1)2.2, 2.10POST /os-keypairs (2.10)
keypair deleteDelete public or private key(s)openstackclient/compute/v2/keypair.py:220none3 (1)2.10DELETE /os-keypairs/{id} (2.10)
keypair listList key fingerprintsopenstackclient/compute/v2/keypair.py:286list7 (0)2.2, 2.10, 2.35GET /os-keypairs (2.10)
keypair showDisplay key detailsopenstackclient/compute/v2/keypair.py:411single4 (1)2.10GET /os-keypairs/{id} (2.10); GET /os-keypairs (2.10)
server add fixed ipAdd fixed IP address to serveropenstackclient/compute/v2/server.py:376single4 (2)2.49GET /servers/{id} (2.100); GET /servers/detail (2.100); GET /networks/{id}
server add floating ipAdd floating IP address to serveropenstackclient/compute/v2/server.py:476none3 (2)GET /floatingips/{id}; GET /floatingips; GET /servers/{id} (2.100)
server add networkAdd network to serveropenstackclient/compute/v2/server.py:620none3 (2)2.49GET /servers/{id} (2.100); GET /servers/detail (2.100); GET /networks/{id}
server add portAdd port to serveropenstackclient/compute/v2/server.py:566none3 (2)2.49GET /servers/{id} (2.100); GET /servers/detail (2.100); GET /ports/{id}
server add security groupAdd security group(s) to serveropenstackclient/compute/v2/server.py:675none2 (2)GET /servers/{id} (2.100); GET /servers/detail (2.100); POST /servers/{id}/action (2.100)
server add shareAdd a share to a server.openstackclient/compute/v2/server_share.py:166single3 (2)2.97GET /servers/{id} (2.100); GET /servers/detail (2.100)
server add volumeAdd volume to server.openstackclient/compute/v2/server.py:745single6 (2)2.49, 2.79GET /servers/{id} (2.100); GET /servers/detail (2.100); GET /volumes/{id} (3.71)
server backup createCreate a server backup imageopenstackclient/compute/v2/server_backup.py:30single5 (1)GET /servers/{id} (2.100); GET /servers/detail (2.100); POST /servers/{id}/action (2.45)
server createCreate a new serveropenstackclient/compute/v2/server.py:1179single39 (2)2.19, 2.37, 2.42, 2.43, 2.52, 2.57…GET /flavors/{id} (2.61); GET /flavors/detail (2.61)
server deleteDelete server(s)openstackclient/compute/v2/server.py:2309none4 (1)GET /servers/{id} (2.100); GET /servers/detail (2.100); DELETE /servers/{id} (2.100)
server dump createCreate a dump file in server(s)openstackclient/compute/v2/server.py:2278none1 (1)GET /servers/{id} (2.100); GET /servers/detail (2.100); POST /servers/{id}/action (2.100)
server evacuateEvacuate a server to a different host.openstackclient/compute/v2/server.py:3977single5 (1)2.14, 2.29, 2.96, 2.100GET /servers/{id} (2.100); GET /servers/detail (2.100); POST /servers/{id}/action (2.100)
server event listList recent events of a server.openstackclient/compute/v2/server_event.py:103list7 (1)2.58, 2.66GET /servers/{id} (2.100); GET /servers/detail (2.100); GET /servers/{id}/os-instance-actions (2.84)
server event showShow server event details.openstackclient/compute/v2/server_event.py:257single2 (2)2.58GET /servers/{id} (2.100); GET /servers/detail (2.100); GET /servers/{id}/os-instance-actions/{id} (2.84)
server group createCreate a new server group.openstackclient/compute/v2/server_group.py:61single3 (1)2.15, 2.64POST /os-server-groups (2.64)
server group deleteDelete existing server group(s).openstackclient/compute/v2/server_group.py:150none1 (1)GET /os-server-groups/{id} (2.64); GET /os-server-groups (2.64); DELETE /os-server-groups/{id} (2.64)
server group listList all server groups.openstackclient/compute/v2/server_group.py:185list5 (0)2.64GET /os-server-groups (2.64)
server group showDisplay server group details.openstackclient/compute/v2/server_group.py:266single1 (1)2.64GET /os-server-groups/{id} (2.64); GET /os-server-groups (2.64)
server image createCreate a new server disk image from an existing serveropenstackclient/compute/v2/server_image.py:35single4 (1)GET /servers/{id} (2.100); GET /servers/detail (2.100); POST /servers/{id}/action (2.45)
server listList serversopenstackclient/compute/v2/server.py:2442list35 (0)2.16, 2.26, 2.47, 2.66, 2.69, 2.73…GET /servers/detail (2.100)
server lockLock server(s)openstackclient/compute/v2/server.py:3265none2 (1)2.73GET /servers/{id} (2.100); GET /servers/detail (2.100); POST /servers/{id}/action (2.100)
server migrateMigrate server to different host.openstackclient/compute/v2/server.py:3323none8 (1)2.25, 2.30, 2.56GET /servers/{id} (2.100); GET /servers/detail (2.100); POST /servers/{id}/action (2.100)
server migrate confirmDEPRECATED: Use 'server migration confirm' instead.openstackclient/compute/v2/server.py:4530none1 (1)GET /servers/{id} (2.100); GET /servers/detail (2.100); POST /servers/{id}/action (2.100)
server migrate revertDEPRECATED: Use 'server migration revert' instead.openstackclient/compute/v2/server.py:4578none1 (1)GET /servers/{id} (2.100); GET /servers/detail (2.100); POST /servers/{id}/action (2.100)
server migration abortCancel an ongoing live migration.openstackclient/compute/v2/server_migration.py:405none2 (2)2.24, 2.59
server migration confirmConfirm server migration.openstackclient/compute/v2/server.py:4543none1 (1)GET /servers/{id} (2.100); GET /servers/detail (2.100); POST /servers/{id}/action (2.100)
server migration force completeForce an ongoing live migration to complete.openstackclient/compute/v2/server_migration.py:472none2 (2)2.22, 2.59
server migration listList server migrationsopenstackclient/compute/v2/server_migration.py:30list13 (0)2.23, 2.59, 2.66, 2.80GET /os-migrations (2.80)
server migration revertRevert server migration.openstackclient/compute/v2/server.py:4591none1 (1)GET /servers/{id} (2.100); GET /servers/detail (2.100); POST /servers/{id}/action (2.100)
server migration showShow an in-progress live migration for a given server.openstackclient/compute/v2/server_migration.py:286single2 (2)2.24, 2.59, 2.80
server pausePause server(s)openstackclient/compute/v2/server.py:3514none1 (1)GET /servers/{id} (2.100); GET /servers/detail (2.100); POST /servers/{id}/action (2.100)
server rebootPerform a hard or soft server rebootopenstackclient/compute/v2/server.py:3537none4 (1)GET /servers/{id} (2.100); GET /servers/detail (2.100); POST /servers/{id}/action (2.100)
server rebuildRebuild serveropenstackclient/compute/v2/server.py:3597single19 (1)2.19, 2.54, 2.63, 2.90, 2.93, 2.96…GET /servers/{id} (2.100); GET /servers/detail (2.100)
server remove fixed ipRemove fixed IP address from serveropenstackclient/compute/v2/server.py:4104none2 (2)GET /servers/{id} (2.100); GET /servers/detail (2.100); POST /servers/{id}/action (2.100)
server remove floating ipRemove floating IP address from serveropenstackclient/compute/v2/server.py:4132none2 (2)GET /floatingips/{id}; GET /floatingips; PUT /floatingips/{id}
server remove networkRemove all ports of a network from serveropenstackclient/compute/v2/server.py:4200none2 (2)GET /servers/{id} (2.100); GET /servers/detail (2.100); GET /networks/{id}
server remove portRemove port from serveropenstackclient/compute/v2/server.py:4161none2 (2)GET /servers/{id} (2.100); GET /servers/detail (2.100); GET /ports/{id}
server remove security groupRemove security group from serveropenstackclient/compute/v2/server.py:4240none2 (2)GET /servers/{id} (2.100); GET /servers/detail (2.100); POST /servers/{id}/action (2.100)
server remove shareRemove a share from a server.openstackclient/compute/v2/server_share.py:233none2 (2)2.97GET /servers/{id} (2.100); GET /servers/detail (2.100)
server remove volumeRemove volume from server.openstackclient/compute/v2/server.py:4310none2 (2)GET /servers/{id} (2.100); GET /servers/detail (2.100); GET /volumes/{id} (3.71)
server rescuePut server in rescue mode.openstackclient/compute/v2/server.py:4354none3 (1)GET /servers/{id} (2.100); GET /servers/detail (2.100); POST /servers/{id}/action (2.100)
server resizeScale server to a new flavor.openstackclient/compute/v2/server.py:4405none5 (1)GET /servers/{id} (2.100); GET /servers/detail (2.100); GET /flavors/{id} (2.61)
server resize confirmConfirm server resize.openstackclient/compute/v2/server.py:4505none1 (1)GET /servers/{id} (2.100); GET /servers/detail (2.100); POST /servers/{id}/action (2.100)
server resize revertRevert server resize.openstackclient/compute/v2/server.py:4552none1 (1)GET /servers/{id} (2.100); GET /servers/detail (2.100); POST /servers/{id}/action (2.100)
server restoreRestore server(s)openstackclient/compute/v2/server.py:4600none1 (1)GET /servers/{id} (2.100); GET /servers/detail (2.100); POST /servers/{id}/action (2.100)
server resumeResume server(s)openstackclient/compute/v2/server.py:4623none1 (1)GET /servers/{id} (2.100); GET /servers/detail (2.100); POST /servers/{id}/action (2.100)
server setSet server propertiesopenstackclient/compute/v2/server.py:4646none12 (1)2.19, 2.26, 2.90, 2.104GET /servers/{id} (2.100); GET /servers/detail (2.100)
server share listList all the shares attached to a server.openstackclient/compute/v2/server_share.py:62list1 (1)2.97GET /servers/{id} (2.100); GET /servers/detail (2.100); GET /servers/{id}/shares (2.97)
server share showShow detail of a share attachment to a server.openstackclient/compute/v2/server_share.py:112single2 (2)2.97GET /servers/{id} (2.100); GET /servers/detail (2.100)
server shelveShelve and optionally offload server(s).openstackclient/compute/v2/server.py:4868none3 (1)GET /servers/{id} (2.100); GET /servers/detail (2.100)
server showShow server details.openstackclient/compute/v2/server.py:4977single3 (1)2.78, 2.96, 2.100GET /servers/{id} (2.100); GET /servers/detail (2.100)
server sshSSH to serveropenstackclient/compute/v2/server.py:5048none12 (1)
server startStart server(s)openstackclient/compute/v2/server.py:5209none2 (1)GET /servers/{id} (2.100); GET /servers (2.100); POST /servers/{id}/action (2.100)
server stopStop server(s)openstackclient/compute/v2/server.py:5244none2 (1)GET /servers/{id} (2.100); GET /servers (2.100); POST /servers/{id}/action (2.100)
server suspendSuspend server(s)openstackclient/compute/v2/server.py:5278none1 (1)GET /servers/{id} (2.100); GET /servers/detail (2.100); POST /servers/{id}/action (2.100)
server unlockUnlock server(s)openstackclient/compute/v2/server.py:5301none1 (1)GET /servers/{id} (2.100); GET /servers/detail (2.100); POST /servers/{id}/action (2.100)
server unpauseUnpause server(s)openstackclient/compute/v2/server.py:5324none1 (1)GET /servers/{id} (2.100); GET /servers/detail (2.100); POST /servers/{id}/action (2.100)
server unrescueRestore server from rescue modeopenstackclient/compute/v2/server.py:5347none1 (1)GET /servers/{id} (2.100); GET /servers/detail (2.100); POST /servers/{id}/action (2.100)
server unsetUnset server properties and tagsopenstackclient/compute/v2/server.py:5367none7 (1)2.19, 2.26, 2.104GET /servers/{id} (2.100); GET /servers/detail (2.100)
server unshelveUnshelve server(s)openstackclient/compute/v2/server.py:5482none5 (1)2.77, 2.91GET /servers/{id} (2.100); GET /servers/detail (2.100)
server volume listList all the volumes attached to a server.openstackclient/compute/v2/server_volume.py:29list1 (1)2.70, 2.79, 2.89GET /servers/{id} (2.100); GET /servers/detail (2.100); GET /servers/{id}/os-volume_attachments (2.89)
server volume setUpdate a volume attachment on the server.openstackclient/compute/v2/server_volume.py:87none4 (2)2.85
server volume updateDEPRECATED: Use 'server volume set' instead.openstackclient/compute/v2/server_volume.py:154none4 (2)2.85
usage listList resource usage per projectopenstackclient/compute/v2/usage.py:115list2 (0)GET /os-simple-tenant-usage (2.75)
usage showShow resource usage for a single projectopenstackclient/compute/v2/usage.py:221single4 (0)GET /os-simple-tenant-usage/p (2.75)

openstack.identity.v2 (34 commands) — not loaded with the default API versions

CommandPurposeDefined atOutputArgs (required)Min. microversions in the codeFirst requests observed
catalog listList services in the service catalogopenstackclient/identity/v2_0/catalog.py:49list0 (0)
catalog showDisplay service catalog detailsopenstackclient/identity/v2_0/catalog.py:79single1 (1)
ec2 credentials createCreate EC2 credentialsopenstackclient/identity/v2_0/ec2creds.py:34single2 (0)
ec2 credentials deleteDelete EC2 credentialsopenstackclient/identity/v2_0/ec2creds.py:91none2 (1)
ec2 credentials listList EC2 credentialsopenstackclient/identity/v2_0/ec2creds.py:144list1 (0)
ec2 credentials showDisplay EC2 credentials detailsopenstackclient/identity/v2_0/ec2creds.py:187single2 (1)
endpoint createCreate new endpointopenstackclient/identity/v2_0/endpoint.py:34single5 (2)
endpoint deleteDelete endpoint(s)openstackclient/identity/v2_0/endpoint.py:88none1 (1)
endpoint listList endpointsopenstackclient/identity/v2_0/endpoint.py:127list1 (0)
endpoint showDisplay endpoint detailsopenstackclient/identity/v2_0/endpoint.py:176single1 (1)
project createCreate new projectopenstackclient/identity/v2_0/project.py:36single6 (1)
project deleteDelete project(s). This command will remove specified existing project(s) if an active user is authorized to do this. If there are resources managed by other services (for example, Nova, Neutron, Cinder) associated with specified project(s), delete operation will proceed regardless.openstackclient/identity/v2_0/project.py:114none1 (1)
project listList projectsopenstackclient/identity/v2_0/project.py:164list2 (0)
project setSet project propertiesopenstackclient/identity/v2_0/project.py:208none6 (1)
project showDisplay project detailsopenstackclient/identity/v2_0/project.py:280single1 (1)
project unsetUnset project propertiesopenstackclient/identity/v2_0/project.py:341none2 (1)
role addAdd role to project:useropenstackclient/identity/v2_0/role.py:34single3 (3)
role assignment listList role assignmentsopenstackclient/identity/v2_0/role_assignment.py:27list5 (0)
role createCreate new roleopenstackclient/identity/v2_0/role.py:80single2 (1)
role deleteDelete role(s)openstackclient/identity/v2_0/role.py:119none1 (1)
role listList rolesopenstackclient/identity/v2_0/role.py:162list0 (0)
role removeRemove role from project : useropenstackclient/identity/v2_0/role.py:186none3 (3)
role showDisplay role detailsopenstackclient/identity/v2_0/role.py:221single1 (1)
service createCreate new serviceopenstackclient/identity/v2_0/service.py:34single3 (1)
service deleteDelete service(s)openstackclient/identity/v2_0/service.py:76none1 (1)
service listList servicesopenstackclient/identity/v2_0/service.py:116list1 (0)
service showDisplay service detailsopenstackclient/identity/v2_0/service.py:142single2 (1)
token issueIssue new tokenopenstackclient/identity/v2_0/token.py:28single0 (0)
token revokeRevoke existing tokenopenstackclient/identity/v2_0/token.py:62none1 (1)
user createCreate new useropenstackclient/identity/v2_0/user.py:61single8 (1)
user deleteDelete user(s)openstackclient/identity/v2_0/user.py:167none1 (1)
user listList usersopenstackclient/identity/v2_0/user.py:210list2 (0)
user setSet user propertiesopenstackclient/identity/v2_0/user.py:286none8 (1)
user showDisplay user detailsopenstackclient/identity/v2_0/user.py:384single1 (1)

openstack.identity.v3 (128 commands)

CommandPurposeDefined atOutputArgs (required)Min. microversions in the codeFirst requests observed
access rule deleteDelete access rule(s)openstackclient/identity/v3/access_rule.py:35none1 (1)GET /users/u/access_rules/{id}; DELETE /users/u/access_rules/{id}
access rule listList access rulesopenstackclient/identity/v3/access_rule.py:82list2 (0)GET /users/u/access_rules
access rule showDisplay access rule detailsopenstackclient/identity/v3/access_rule.py:128single1 (1)GET /users/u/access_rules/{id}
access token createCreate an access tokenopenstackclient/identity/v3/token.py:77single5 (5)
application credential createCreate new application credentialopenstackclient/identity/v3/application_credential.py:143single8 (1)POST /users/u/application_credentials
application credential deleteDelete application credentials(s)openstackclient/identity/v3/application_credential.py:285none1 (1)GET /users/u/application_credentials/{id}; GET /users/u/application_credentials; DELETE /users/u/application_credentials/{id}
application credential listList application credentialsopenstackclient/identity/v3/application_credential.py:344list2 (0)GET /users/u/application_credentials
application credential showDisplay application credential detailsopenstackclient/identity/v3/application_credential.py:386single1 (1)GET /users/u/application_credentials/{id}; GET /users/u/application_credentials
catalog listList services in the service catalogopenstackclient/identity/v3/catalog.py:43list0 (0)
catalog showDisplay service catalog detailsopenstackclient/identity/v3/catalog.py:73single1 (1)
consumer createCreate new consumeropenstackclient/identity/v3/consumer.py:33single1 (0)
consumer deleteDelete consumer(s)openstackclient/identity/v3/consumer.py:57none1 (1)
consumer listList consumersopenstackclient/identity/v3/consumer.py:98list0 (0)
consumer setSet consumer propertiesopenstackclient/identity/v3/consumer.py:119none2 (1)
consumer showDisplay consumer detailsopenstackclient/identity/v3/consumer.py:150single1 (1)
credential createCreate new credentialopenstackclient/identity/v3/credential.py:54single4 (2)GET /users/{id}; GET /users; POST /credentials
credential deleteDelete credential(s)openstackclient/identity/v3/credential.py:109none1 (1)DELETE /credentials/{id}
credential listList credentialsopenstackclient/identity/v3/credential.py:149list3 (0)GET /credentials
credential setSet credential propertiesopenstackclient/identity/v3/credential.py:206none5 (4)GET /users/{id}; GET /users; PATCH /credentials/{id}
credential showDisplay credential detailsopenstackclient/identity/v3/credential.py:268single1 (1)GET /credentials/{id}
domain createCreate new domainopenstackclient/identity/v3/domain.py:63single7 (1)POST /domains
domain deleteDelete domain(s)openstackclient/identity/v3/domain.py:130none1 (1)GET /domains/{id}; GET /domains; DELETE /domains/{id}
domain listList domainsopenstackclient/identity/v3/domain.py:171list2 (0)GET /domains
domain setSet domain propertiesopenstackclient/identity/v3/domain.py:218none7 (1)GET /domains/{id}; GET /domains
domain showDisplay domain detailsopenstackclient/identity/v3/domain.py:276single1 (1)GET /domains/{id}; GET /domains
ec2 credentials createCreate EC2 credentialsopenstackclient/identity/v3/ec2creds.py:64single4 (0)POST /users/u/credentials/OS-EC2
ec2 credentials deleteDelete EC2 credentialsopenstackclient/identity/v3/ec2creds.py:129none3 (1)DELETE /users/u/credentials/OS-EC2/{id}
ec2 credentials listList EC2 credentialsopenstackclient/identity/v3/ec2creds.py:174list2 (0)GET /users/u/credentials/OS-EC2
ec2 credentials showDisplay EC2 credentials detailsopenstackclient/identity/v3/ec2creds.py:210single3 (1)GET /users/u/credentials/OS-EC2/{id}
endpoint add projectAssociate a project to an endpointopenstackclient/identity/v3/endpoint.py:65none3 (2)GET /endpoints/{id}; GET /endpoints; GET /projects/{id}
endpoint createCreate new endpointopenstackclient/identity/v3/endpoint.py:103single6 (3)GET /services/{id}; GET /services; POST /endpoints
endpoint deleteDelete endpoint(s)openstackclient/identity/v3/endpoint.py:169none1 (1)GET /endpoints/{id}; GET /endpoints; DELETE /endpoints/{id}
endpoint group add projectAdd a project to an endpoint groupopenstackclient/identity/v3/endpoint_group.py:65none3 (2)GET /OS-EP-FILTER/endpoint_groups/{id}; GET /OS-EP-FILTER/endpoint_groups
endpoint group createCreate new endpoint groupopenstackclient/identity/v3/endpoint_group.py:99single3 (2)
endpoint group deleteDelete endpoint group(s)openstackclient/identity/v3/endpoint_group.py:142none1 (1)GET /OS-EP-FILTER/endpoint_groups/{id}; GET /OS-EP-FILTER/endpoint_groups
endpoint group listList endpoint groupsopenstackclient/identity/v3/endpoint_group.py:182list3 (0)GET /OS-EP-FILTER/endpoint_groups
endpoint group remove projectRemove project from endpoint groupopenstackclient/identity/v3/endpoint_group.py:249none3 (2)GET /OS-EP-FILTER/endpoint_groups/{id}; GET /OS-EP-FILTER/endpoint_groups
endpoint group setSet endpoint group propertiesopenstackclient/identity/v3/endpoint_group.py:283none4 (1)GET /OS-EP-FILTER/endpoint_groups/{id}; GET /OS-EP-FILTER/endpoint_groups
endpoint group showDisplay endpoint group detailsopenstackclient/identity/v3/endpoint_group.py:329single1 (1)GET /OS-EP-FILTER/endpoint_groups/{id}; GET /OS-EP-FILTER/endpoint_groups
endpoint listList endpointsopenstackclient/identity/v3/endpoint.py:212list6 (0)GET /endpoints
endpoint remove projectDissociate a project from an endpointopenstackclient/identity/v3/endpoint.py:350none3 (2)GET /endpoints/{id}; GET /endpoints; GET /projects/{id}
endpoint setSet endpoint propertiesopenstackclient/identity/v3/endpoint.py:390none7 (1)GET /endpoints/{id}; GET /endpoints
endpoint showDisplay endpoint detailsopenstackclient/identity/v3/endpoint.py:472single1 (1)GET /endpoints/{id}; GET /endpoints
federation domain listList accessible domainsopenstackclient/identity/v3/unscoped_saml.py:30list0 (0)GET /auth/domains
federation project listList accessible projectsopenstackclient/identity/v3/unscoped_saml.py:52list0 (0)GET /auth/projects
federation protocol createCreate new federation protocolopenstackclient/identity/v3/federation_protocol.py:44single3 (3)PUT /OS-FEDERATION/identity_providers/{id}/protocols/{id}
federation protocol deleteDelete federation protocol(s)openstackclient/identity/v3/federation_protocol.py:91none2 (2)DELETE /OS-FEDERATION/identity_providers/{id}/protocols/{id}
federation protocol listList federation protocolsopenstackclient/identity/v3/federation_protocol.py:146list1 (1)GET /OS-FEDERATION/identity_providers/{id}/protocols
federation protocol setSet federation protocol propertiesopenstackclient/identity/v3/federation_protocol.py:179none3 (2)
federation protocol showDisplay federation protocol detailsopenstackclient/identity/v3/federation_protocol.py:224single2 (2)GET /OS-FEDERATION/identity_providers/{id}/protocols/{id}
group add userAdd user to groupopenstackclient/identity/v3/group.py:57none4 (2)GET /groups/{id}; GET /groups; GET /users/{id}
group contains userCheck user membership in groupopenstackclient/identity/v3/group.py:119none4 (2)GET /users/{id}; GET /users; GET /groups/{id}
group createCreate new groupopenstackclient/identity/v3/group.py:178single4 (1)POST /groups
group deleteDelete group(s)openstackclient/identity/v3/group.py:244none2 (1)GET /groups/{id}; GET /groups; DELETE /groups/{id}
group listList groupsopenstackclient/identity/v3/group.py:293list4 (0)GET /groups
group remove userRemove user from groupopenstackclient/identity/v3/group.py:364none4 (2)GET /groups/{id}; GET /groups; GET /users/{id}
group setSet group propertiesopenstackclient/identity/v3/group.py:426none4 (1)GET /groups/{id}; GET /groups
group showDisplay group detailsopenstackclient/identity/v3/group.py:469single2 (1)GET /groups/{id}; GET /groups
identity provider createCreate new identity provideropenstackclient/identity/v3/identity_provider.py:62single8 (1)PUT /OS-FEDERATION/identity_providers/{id}
identity provider deleteDelete identity provider(s)openstackclient/identity/v3/identity_provider.py:175none1 (1)DELETE /OS-FEDERATION/identity_providers/{id}
identity provider listList identity providersopenstackclient/identity/v3/identity_provider.py:214list2 (0)GET /OS-FEDERATION/identity_providers
identity provider setSet identity provider propertiesopenstackclient/identity/v3/identity_provider.py:261none7 (1)
identity provider showDisplay identity provider detailsopenstackclient/identity/v3/identity_provider.py:365single1 (1)GET /OS-FEDERATION/identity_providers/{id}
implied role createCreates an association between prior and implied rolesopenstackclient/identity/v3/implied_role.py:55single2 (2)GET /roles
implied role deleteDeletes an association between prior and implied rolesopenstackclient/identity/v3/implied_role.py:90none2 (2)GET /roles
implied role listList implied rolesopenstackclient/identity/v3/implied_role.py:116list0 (0)GET /role_inferences
limit createCreate a limitopenstackclient/identity/v3/limit.py:57single7 (4)GET /projects/{id}; GET /projects; GET /services/{id}
limit deleteDelete a limitopenstackclient/identity/v3/limit.py:277none1 (1)DELETE /limits/{id}
limit listList limitsopenstackclient/identity/v3/limit.py:133list5 (0)GET /limits
limit setUpdate information about a limitopenstackclient/identity/v3/limit.py:236single3 (1)
limit showDisplay limit detailsopenstackclient/identity/v3/limit.py:214single1 (1)GET /limits/{id}
mapping createCreate new mappingopenstackclient/identity/v3/mapping.py:118single3 (2)
mapping deleteDelete mapping(s)openstackclient/identity/v3/mapping.py:154none1 (1)DELETE /OS-FEDERATION/mappings/{id}
mapping listList mappingsopenstackclient/identity/v3/mapping.py:194list0 (0)GET /OS-FEDERATION/mappings
mapping setSet mapping propertiesopenstackclient/identity/v3/mapping.py:212none3 (1)
mapping showDisplay mapping detailsopenstackclient/identity/v3/mapping.py:245single1 (1)GET /OS-FEDERATION/mappings/{id}
policy createCreate new policyopenstackclient/identity/v3/policy.py:43single2 (1)
policy deleteDelete policy(s)openstackclient/identity/v3/policy.py:79none1 (1)DELETE /policies/{id}
policy listList policiesopenstackclient/identity/v3/policy.py:119list1 (0)GET /policies
policy setSet policy propertiesopenstackclient/identity/v3/policy.py:157none3 (1)
policy showDisplay policy detailsopenstackclient/identity/v3/policy.py:195single1 (1)GET /policies/{id}
project createCreate new projectopenstackclient/identity/v3/project.py:56single11 (1)POST /projects
project deleteDelete project(s). This command will remove specified existing project(s) if an active user is authorized to do this. If there are resources managed by other services (for example, Nova, Neutron, Cinder) associated with specified project(s), delete operation will proceed regardless.openstackclient/identity/v3/project.py:186none2 (1)GET /projects/{id}; GET /projects; DELETE /projects/{id}
project listList projectsopenstackclient/identity/v3/project.py:246list15 (0)GET /projects
project setSet project propertiesopenstackclient/identity/v3/project.py:394none12 (1)GET /projects/{id}; GET /projects
project showDisplay project detailsopenstackclient/identity/v3/project.py:510single4 (1)GET /projects/{id}; GET /projects
region createCreate new regionopenstackclient/identity/v3/region.py:43single3 (1)POST /regions
region deleteDelete region(s)openstackclient/identity/v3/region.py:83none1 (1)DELETE /regions/{id}
region listList regionsopenstackclient/identity/v3/region.py:120list1 (0)GET /regions
region setSet region propertiesopenstackclient/identity/v3/region.py:160none3 (1)
region showDisplay region detailsopenstackclient/identity/v3/region.py:196single1 (1)GET /regions/{id}
registered limit createCreate a registered limitopenstackclient/identity/v3/registered_limit.py:58single5 (3)GET /services/{id}; GET /services; POST /registered_limits
registered limit deleteDelete a registered limitopenstackclient/identity/v3/registered_limit.py:125none1 (1)DELETE /registered_limits/{id}
registered limit listList registered limitsopenstackclient/identity/v3/registered_limit.py:173list3 (0)GET /registered_limits
registered limit setUpdate information about a registered limitopenstackclient/identity/v3/registered_limit.py:234single6 (1)
registered limit showDisplay registered limit detailsopenstackclient/identity/v3/registered_limit.py:321single1 (1)GET /registered_limits/{id}
request token authorizeAuthorize a request tokenopenstackclient/identity/v3/token.py:30single2 (2)GET /roles/{id}; GET /roles
request token createCreate a request tokenopenstackclient/identity/v3/token.py:129single4 (3)GET /projects/{id}; GET /projects
role addAdds a role assignment to a user or group on the system, a domain, or a projectopenstackclient/identity/v3/role.py:186none11 (1)
role assignment listList role assignmentsopenstackclient/identity/v3/role_assignment.py:62list15 (0)GET /role_assignments
role createCreate new roleopenstackclient/identity/v3/role.py:289single6 (1)POST /roles
role deleteDelete role(s)openstackclient/identity/v3/role.py:356none2 (1)GET /roles/{id}; GET /roles; DELETE /roles/{id}
role listList rolesopenstackclient/identity/v3/role.py:412list1 (0)GET /roles
role removeRemoves a role assignment from system/domain/project : user/groupopenstackclient/identity/v3/role.py:456none11 (1)
role setSet role propertiesopenstackclient/identity/v3/role.py:552none6 (1)GET /roles/{id}; GET /roles
role showDisplay role detailsopenstackclient/identity/v3/role.py:612single2 (1)GET /roles/{id}; GET /roles
service createCreate new serviceopenstackclient/identity/v3/service.py:62single5 (1)POST /services
service deleteDelete service(s)openstackclient/identity/v3/service.py:116none1 (1)GET /services/{id}; GET /services; DELETE /services/{id}
service listList servicesopenstackclient/identity/v3/service.py:157list1 (0)GET /services
service provider createCreate new service provideropenstackclient/identity/v3/service_provider.py:57single6 (3)PUT /OS-FEDERATION/service_providers/{id}
service provider deleteDelete service provider(s)openstackclient/identity/v3/service_provider.py:135none1 (1)DELETE /OS-FEDERATION/service_providers/{id}
service provider listList service providersopenstackclient/identity/v3/service_provider.py:174list0 (0)GET /OS-FEDERATION/service_providers
service provider setSet service provider propertiesopenstackclient/identity/v3/service_provider.py:207single6 (1)
service provider showDisplay service provider detailsopenstackclient/identity/v3/service_provider.py:281single1 (1)GET /OS-FEDERATION/service_providers/{id}; GET /OS-FEDERATION/service_providers
service setSet service propertiesopenstackclient/identity/v3/service.py:191none6 (1)GET /services/{id}; GET /services
service showDisplay service detailsopenstackclient/identity/v3/service.py:252single1 (1)GET /services/{id}; GET /services
token issueIssue new tokenopenstackclient/identity/v3/token.py:187single0 (0)
token revokeRevoke existing tokenopenstackclient/identity/v3/token.py:229none1 (1)DELETE /auth/tokens
trust createCreate new trustopenstackclient/identity/v3/trust.py:57single9 (4)GET /users/{id}; GET /users; GET /projects/{id}
trust deleteDelete trust(s)openstackclient/identity/v3/trust.py:213none1 (1)GET /OS-TRUST/trusts/{id}; GET /OS-TRUST/trusts; DELETE /OS-TRUST/trusts/{id}
trust listList trustsopenstackclient/identity/v3/trust.py:257list5 (0)GET /OS-TRUST/trusts
trust showDisplay trust detailsopenstackclient/identity/v3/trust.py:412single1 (1)GET /OS-TRUST/trusts/{id}; GET /OS-TRUST/trusts
user createCreate new useropenstackclient/identity/v3/user.py:197single22 (1)POST /users
user deleteDelete user(s)openstackclient/identity/v3/user.py:343none2 (1)GET /users/{id}; GET /users; DELETE /users/{id}
user listList usersopenstackclient/identity/v3/user.py:405list9 (0)GET /users
user password setChange current user passwordopenstackclient/identity/v3/user.py:715none2 (0)
user setSet user propertiesopenstackclient/identity/v3/user.py:580none22 (1)GET /users/{id}; GET /users; PATCH /users/{id}
user showDisplay user detailsopenstackclient/identity/v3/user.py:796single2 (1)GET /users/{id}; GET /users

openstack.image.v1 (6 commands) — not loaded with the default API versions

CommandPurposeDefined atOutputArgs (required)Min. microversions in the codeFirst requests observed
image createCreate/upload an imageopenstackclient/image/v1/image.py:100single20 (1)
image deleteDelete image(s)openstackclient/image/v1/image.py:360none1 (1)
image listList available imagesopenstackclient/image/v1/image.py:399list7 (0)
image saveSave an image locallyopenstackclient/image/v1/image.py:532none3 (1)
image setSet image propertiesopenstackclient/image/v1/image.py:577none21 (1)
image showDisplay image detailsopenstackclient/image/v1/image.py:823single2 (1)

openstack.image.v2 (42 commands)

CommandPurposeDefined atOutputArgs (required)Min. microversions in the codeFirst requests observed
cached image clearClear all images from cache, queue or bothopenstackclient/image/v2/cache.py:195none2 (0)DELETE /cache
cached image deleteDelete image(s) from cacheopenstackclient/image/v2/cache.py:156none1 (1)GET /images/{id}; GET /images; DELETE /cache/{id}
cached image listGet Cache Stateopenstackclient/image/v2/cache.py:73list0 (0)GET /cache
cached image queueQueue image(s) for caching.openstackclient/image/v2/cache.py:116none1 (1)GET /images/{id}; GET /images; PUT /cache/{id}
image add projectAssociate project with imageopenstackclient/image/v2/image.py:258single3 (2)GET /projects/{id}; GET /projects; GET /images/{id}
image createCreate/upload an imageopenstackclient/image/v2/image.py:304single28 (1)3.1POST /images; PUT /images//file
image deleteDelete image(s)openstackclient/image/v2/image.py:724none2 (1)GET /images/{id}; GET /images; DELETE /images/{id}
image importInitiate the image import process.openstackclient/image/v2/image.py:1713single11 (1)GET /info/import
image import infoShow available import methodsopenstackclient/image/v2/info.py:24single0 (0)GET /info/import
image listList available imagesopenstackclient/image/v2/image.py:777list19 (0)GET /images
image member getShow a particular project associated with imageopenstackclient/image/v2/image.py:1085single3 (2)GET /images/{id}; GET /images; GET /images/{id}/members/{id}
image member listList projects associated with imageopenstackclient/image/v2/image.py:1011list2 (1)GET /images/{id}; GET /images; GET /images/{id}/members
image metadef namespace createCreate a metadef namespaceopenstackclient/image/v2/metadef_namespaces.py:70single7 (1)POST /metadefs/namespaces
image metadef namespace deleteDelete metadef namespaceopenstackclient/image/v2/metadef_namespaces.py:147none1 (1)GET /metadefs/namespaces/{id}; DELETE /metadefs/namespaces/{id}
image metadef namespace listList metadef namespacesopenstackclient/image/v2/metadef_namespaces.py:187list2 (0)GET /metadefs/namespaces
image metadef namespace setSet metadef namespace propertiesopenstackclient/image/v2/metadef_namespaces.py:231none8 (1)PUT /metadefs/namespaces/{id}
image metadef namespace showShow a metadef namespaceopenstackclient/image/v2/metadef_namespaces.py:333single1 (1)GET /metadefs/namespaces/{id}
image metadef namespace unsetUnset metadef namespace tagsopenstackclient/image/v2/metadef_namespaces.py:359none3 (1)GET /metadefs/namespaces/{id}; DELETE /metadefs/namespaces/{id}/tags/{id}
image metadef object createCreate a metadef objectopenstackclient/image/v2/metadef_objects.py:53single2 (1)
image metadef object deleteDelete metadata definitions object(s)openstackclient/image/v2/metadef_objects.py:120none2 (1)DELETE /metadefs/namespaces/{id}/objects
image metadef object listList metadef objects inside a specific namespace.openstackclient/image/v2/metadef_objects.py:174list1 (1)GET /metadefs/namespaces/{id}/objects
image metadef object property showDescribe a specific metadata definitions property inside an object.openstackclient/image/v2/metadef_objects.py:244single3 (3)GET /metadefs/namespaces/{id}/objects/{id}
image metadef object showShow a particular metadef objectopenstackclient/image/v2/metadef_objects.py:88single2 (2)GET /metadefs/namespaces/{id}/objects/{id}
image metadef object updateUpdate a metadef objectopenstackclient/image/v2/metadef_objects.py:208none3 (2)GET /metadefs/namespaces/{id}/objects/{id}
image metadef property createCreate a metadef propertyopenstackclient/image/v2/metadef_properties.py:63single5 (5)
image metadef property deleteDelete metadef propert(ies)openstackclient/image/v2/metadef_properties.py:123none2 (1)DELETE /metadefs/namespaces/{id}/properties
image metadef property listList metadef propertiesopenstackclient/image/v2/metadef_properties.py:183list1 (1)GET /metadefs/namespaces/{id}/properties
image metadef property setUpdate metadef namespace propertyopenstackclient/image/v2/metadef_properties.py:213none6 (2)GET /metadefs/namespaces/{id}/properties/{id}
image metadef property showShow a particular metadef propertyopenstackclient/image/v2/metadef_properties.py:278single2 (2)GET /metadefs/namespaces/{id}/properties/k=v
image metadef resource type association createCreate metadef resource type associationopenstackclient/image/v2/metadef_resource_type_association.py:34single3 (2)POST /metadefs/namespaces/{id}/resource_types
image metadef resource type association deleteDelete metadef resource type associationopenstackclient/image/v2/metadef_resource_type_association.py:84none3 (2)GET /metadefs/namespaces/{id}; DELETE /metadefs/namespaces/{id}/resource_types/{id}
image metadef resource type association listList metadef resource type associationsopenstackclient/image/v2/metadef_resource_type_association.py:165list1 (1)GET /metadefs/namespaces/{id}/resource_types
image metadef resource type listList metadef resource typesopenstackclient/image/v2/metadef_resource_types.py:25list0 (0)GET /metadefs/resource_types
image remove projectDisassociate project with imageopenstackclient/image/v2/image.py:1049none3 (2)GET /projects/{id}; GET /projects; GET /images/{id}
image saveSave an image locallyopenstackclient/image/v2/image.py:1124none3 (1)GET /images/{id}; GET /images; GET /images/{id}/file
image setSet image propertiesopenstackclient/image/v2/image.py:1171none31 (1)GET /images/{id}; GET /images
image showDisplay image detailsopenstackclient/image/v2/image.py:1475single2 (1)GET /images/{id}; GET /images
image stageUpload data for a specific image to staging.openstackclient/image/v2/image.py:1621none4 (1)GET /images/{id}; GET /images
image stores listGet available backends (only valid with Multi-Backend support)openstackclient/image/v2/image.py:1968list1 (0)GET /info/stores
image task listList tasksopenstackclient/image/v2/task.py:91list7 (0)GET /tasks
image task showDisplay task detailsopenstackclient/image/v2/task.py:65single1 (1)GET /tasks/{id}
image unsetUnset image tags and propertiesopenstackclient/image/v2/image.py:1508none3 (1)GET /images/{id}; GET /images

openstack.network.v2 (168 commands)

CommandPurposeDefined atOutputArgs (required)Min. microversions in the codeFirst requests observed
address group createCreate a new Address Groupopenstackclient/network/v2/address_group.py:68single6 (1)POST /address-groups
address group deleteDelete address group(s)openstackclient/network/v2/address_group.py:116none1 (1)GET /address-groups/{id}; GET /address-groups; DELETE /address-groups/{id}
address group listList address groupsopenstackclient/network/v2/address_group.py:156list6 (0)GET /address-groups
address group setSet address group propertiesopenstackclient/network/v2/address_group.py:231none5 (1)GET /address-groups/{id}; GET /address-groups
address group showDisplay address group detailsopenstackclient/network/v2/address_group.py:282single1 (1)GET /address-groups/{id}; GET /address-groups
address group unsetUnset address group propertiesopenstackclient/network/v2/address_group.py:308none2 (1)GET /address-groups/{id}; GET /address-groups
address scope createCreate a new Address Scopeopenstackclient/network/v2/address_scope.py:68single7 (1)POST /address-scopes
address scope deleteDelete address scope(s)openstackclient/network/v2/address_scope.py:121none1 (1)GET /address-scopes/{id}; GET /address-scopes; DELETE /address-scopes/{id}
address scope listList address scopesopenstackclient/network/v2/address_scope.py:161list9 (0)GET /address-scopes
address scope setSet address scope propertiesopenstackclient/network/v2/address_scope.py:263none5 (1)GET /address-scopes/{id}; GET /address-scopes
address scope showDisplay address scope detailsopenstackclient/network/v2/address_scope.py:308single1 (1)GET /address-scopes/{id}; GET /address-scopes
default security group rule createAdd a new security group rule to the default security group template.openstackclient/network/v2/default_security_group_rule.py:45single14 (0)POST /default-security-group-rules
default security group rule deleteRemove security group rule(s) from the default security group template.openstackclient/network/v2/default_security_group_rule.py:241none1 (1)GET /default-security-group-rules/{id}; GET /default-security-group-rules; DELETE /default-security-group-rules/{id}
default security group rule listList security group rules used for new default security groups.openstackclient/network/v2/default_security_group_rule.py:286list4 (0)GET /default-security-group-rules
default security group rule showShow a security group rule used for new default security groups.openstackclient/network/v2/default_security_group_rule.py:405single1 (1)GET /default-security-group-rules/{id}; GET /default-security-group-rules
floating ip createCreate floating IPopenstackclient/network/v2/floating_ip.py:109single14 (1)GET /networks/{id}; GET /networks; POST /floatingips
floating ip deleteDelete floating IP(s)openstackclient/network/v2/floating_ip.py:195none1 (1)GET /floatingips/{id}; GET /floatingips; DELETE /floatingips/{id}
floating ip listList floating IP(s)openstackclient/network/v2/floating_ip.py:237list16 (0)GET /floatingips
floating ip port forwarding createCreate floating IP port forwardingopenstackclient/network/v2/floating_ip_port_forwarding.py:105single8 (6)GET /floatingips/{id}; GET /floatingips
floating ip port forwarding deleteDelete floating IP port forwardingopenstackclient/network/v2/floating_ip_port_forwarding.py:210none2 (2)GET /floatingips/{id}; GET /floatingips; DELETE /floatingips/{id}/port_forwardings/{id}
floating ip port forwarding listList floating IP port forwardingopenstackclient/network/v2/floating_ip_port_forwarding.py:263list7 (1)GET /floatingips/{id}; GET /floatingips; GET /floatingips/{id}/port_forwardings
floating ip port forwarding setSet floating IP Port Forwarding Propertiesopenstackclient/network/v2/floating_ip_port_forwarding.py:374none9 (2)GET /floatingips/{id}; GET /floatingips
floating ip port forwarding showDisplay floating IP Port Forwarding detailsopenstackclient/network/v2/floating_ip_port_forwarding.py:474single2 (2)GET /floatingips/{id}; GET /floatingips; GET /floatingips/{id}/port_forwardings/{id}
floating ip setSet floating IP Propertiesopenstackclient/network/v2/floating_ip.py:430none9 (1)GET /floatingips/{id}; GET /floatingips
floating ip showDisplay floating IP detailsopenstackclient/network/v2/floating_ip.py:512single1 (1)GET /floatingips/{id}; GET /floatingips
floating ip unsetUnset floating IP Propertiesopenstackclient/network/v2/floating_ip.py:537none6 (1)GET /floatingips/{id}; GET /floatingips
ip availability listList IP availability for networkopenstackclient/network/v2/ip_availability.py:65list6 (0)GET /network-ip-availabilities
ip availability showShow network IP availability detailsopenstackclient/network/v2/ip_availability.py:148single1 (1)GET /networks/{id}; GET /networks; GET /network-ip-availabilities/{id}
local ip association createCreate Local IP Associationopenstackclient/network/v2/local_ip_association.py:43single4 (2)GET /ports/{id}; GET /ports; GET /local_ips/{id}
local ip association deleteDelete Local IP association(s)openstackclient/network/v2/local_ip_association.py:91none2 (2)GET /local_ips/{id}; GET /local_ips; DELETE /local_ips/{id}/port_associations/{id}
local ip association listList Local IP Associationsopenstackclient/network/v2/local_ip_association.py:146list5 (1)GET /local_ips/{id}; GET /local_ips; GET /local_ips/{id}/port_associations
local ip createCreate Local IPopenstackclient/network/v2/local_ip.py:78single7 (0)POST /local_ips
local ip deleteDelete Local IP(s)openstackclient/network/v2/local_ip.py:129none1 (1)GET /local_ips/{id}; GET /local_ips; DELETE /local_ips/{id}
local ip listList Local IPsopenstackclient/network/v2/local_ip.py:202list7 (0)GET /local_ips
local ip setSet Local IP propertiesopenstackclient/network/v2/local_ip.py:170none3 (1)GET /local_ips/{id}; GET /local_ips
local ip showDisplay Local IP detailsopenstackclient/network/v2/local_ip.py:313single1 (1)GET /local_ips/{id}; GET /local_ips
network agent add networkAdd network to an agentopenstackclient/network/v2/network_agent.py:80none3 (2)GET /agents/{id}; GET /networks/{id}
network agent add routerAdd router to an agentopenstackclient/network/v2/network_agent.py:117none4 (2)GET /agents/{id}; GET /routers/{id}
network agent deleteDelete network agent(s)openstackclient/network/v2/network_agent.py:159none1 (1)DELETE /agents/{id}
network agent listList network agentsopenstackclient/network/v2/network_agent.py:197list8 (0)GET /agents
network agent remove networkRemove network from an agent.openstackclient/network/v2/network_agent.py:325none3 (2)GET /agents/{id}; GET /networks/{id}
network agent remove routerRemove router from an agentopenstackclient/network/v2/network_agent.py:361none3 (2)GET /agents/{id}; GET /routers/{id}
network agent router setSet properties of a router associated to an agentopenstackclient/network/v2/network_agent.py:392none3 (3)GET /agents/{id}; GET /routers/{id}; PUT /agents/{id}/l3-routers/{id}
network agent setSet network agent propertiesopenstackclient/network/v2/network_agent.py:431none4 (1)GET /agents/{id}
network agent showDisplay network agent detailsopenstackclient/network/v2/network_agent.py:470single1 (1)GET /agents/{id}
network auto allocated topology createCreate the auto allocated topology for projectopenstackclient/network/v2/network_auto_allocated_topology.py:71single4 (0)GET /auto-allocated-topology/p
network auto allocated topology deleteDelete auto allocated topology for projectopenstackclient/network/v2/network_auto_allocated_topology.py:136none2 (0)DELETE /auto-allocated-topology/p
network createCreate new networkopenstackclient/network/v2/network.py:203single30 (1)POST /networks
network deleteDelete network(s)openstackclient/network/v2/network.py:423none1 (1)GET /networks/{id}; GET /networks; DELETE /networks/{id}
network flavor add profileAdd a service profile to a network flavoropenstackclient/network/v2/network_flavor.py:71none2 (2)GET /flavors/{id}; GET /flavors; GET /service_profiles/{id}
network flavor createCreate new network flavoropenstackclient/network/v2/network_flavor.py:99single8 (2)POST /flavors
network flavor deleteDelete network flavorsopenstackclient/network/v2/network_flavor.py:154none1 (1)GET /flavors/{id}; GET /flavors; DELETE /flavors/{id}
network flavor listList network flavorsopenstackclient/network/v2/network_flavor.py:194list3 (0)GET /flavors
network flavor profile createCreate new network flavor profileopenstackclient/network/v2/network_flavor_profile.py:62single6 (0)
network flavor profile deleteDelete network flavor profileopenstackclient/network/v2/network_flavor_profile.py:122none1 (1)GET /service_profiles/{id}; GET /service_profiles; DELETE /service_profiles/{id}
network flavor profile listList network flavor profile(s)openstackclient/network/v2/network_flavor_profile.py:163list3 (0)GET /service_profiles
network flavor profile setSet network flavor profile propertiesopenstackclient/network/v2/network_flavor_profile.py:213none7 (1)GET /service_profiles/{id}; GET /service_profiles
network flavor profile showDisplay network flavor profile detailsopenstackclient/network/v2/network_flavor_profile.py:269single1 (1)GET /service_profiles/{id}; GET /service_profiles
network flavor remove profileRemove service profile from network flavoropenstackclient/network/v2/network_flavor.py:237none2 (2)GET /flavors/{id}; GET /flavors; GET /service_profiles/{id}
network flavor setSet network flavor propertiesopenstackclient/network/v2/network_flavor.py:265none6 (1)GET /flavors/{id}; GET /flavors
network flavor showDisplay network flavor detailsopenstackclient/network/v2/network_flavor.py:309single1 (1)GET /flavors/{id}; GET /flavors
network l3 conntrack helper createCreate a new L3 conntrack helperopenstackclient/network/v2/l3_conntrack_helper.py:54single4 (4)GET /routers/{id}; GET /routers; POST /routers/{id}/conntrack_helpers
network l3 conntrack helper deleteDelete L3 conntrack helperopenstackclient/network/v2/l3_conntrack_helper.py:101none2 (2)GET /routers/{id}; GET /routers; DELETE /routers/{id}/conntrack_helpers/{id}
network l3 conntrack helper listList L3 conntrack helpersopenstackclient/network/v2/l3_conntrack_helper.py:149list7 (1)GET /routers/{id}; GET /routers; GET /routers/{id}/conntrack_helpers
network l3 conntrack helper setSet L3 conntrack helper propertiesopenstackclient/network/v2/l3_conntrack_helper.py:229none5 (2)GET /routers/{id}; GET /routers
network l3 conntrack helper showDisplay L3 conntrack helper detailsopenstackclient/network/v2/l3_conntrack_helper.py:275single2 (2)GET /routers/{id}; GET /routers; GET /routers/{id}/conntrack_helpers/{id}
network listList networksopenstackclient/network/v2/network.py:463list24 (0)GET /networks
network meter createCreate network meteropenstackclient/network/v2/network_meter.py:71single7 (1)POST /metering/metering-labels
network meter deleteDelete network meteropenstackclient/network/v2/network_meter.py:124none1 (1)GET /metering/metering-labels/{id}; GET /metering/metering-labels; DELETE /metering/metering-labels/{id}
network meter listList network metersopenstackclient/network/v2/network_meter.py:161list3 (0)GET /metering/metering-labels
network meter rule createCreate a new meter ruleopenstackclient/network/v2/network_meter_rule.py:76single11 (1)GET /metering/metering-labels/{id}; GET /metering/metering-labels; POST /metering/metering-label-rules
network meter rule deleteDelete meter rule(s)openstackclient/network/v2/network_meter_rule.py:155none1 (1)GET /metering/metering-label-rules/{id}; GET /metering/metering-label-rules; DELETE /metering/metering-label-rules/{id}
network meter rule listList meter rulesopenstackclient/network/v2/network_meter_rule.py:193list3 (0)GET /metering/metering-label-rules
network meter rule showDisplay meter rules detailsopenstackclient/network/v2/network_meter_rule.py:244single1 (1)GET /metering/metering-label-rules/{id}; GET /metering/metering-label-rules
network meter showShow network meteropenstackclient/network/v2/network_meter.py:208single1 (1)GET /metering/metering-labels/{id}; GET /metering/metering-labels
network qos policy createCreate a QoS policyopenstackclient/network/v2/network_qos_policy.py:89single9 (1)POST /qos/policies
network qos policy deleteDelete Qos Policy(s)openstackclient/network/v2/network_qos_policy.py:152none1 (1)GET /qos/policies/{id}; GET /qos/policies; DELETE /qos/policies/{id}
network qos policy listList QoS policiesopenstackclient/network/v2/network_qos_policy.py:191list7 (0)GET /qos/policies
network qos policy setSet QoS policy propertiesopenstackclient/network/v2/network_qos_policy.py:261none8 (1)GET /qos/policies/{id}; GET /qos/policies
network qos policy showDisplay QoS policy detailsopenstackclient/network/v2/network_qos_policy.py:313single1 (1)GET /qos/policies/{id}; GET /qos/policies
network qos rule createCreate new Network QoS ruleopenstackclient/network/v2/network_qos_rule.py:252single11 (2)GET /qos/policies/{id}; GET /qos/policies
network qos rule deleteDelete Network QoS ruleopenstackclient/network/v2/network_qos_rule.py:302none2 (2)GET /qos/policies/{id}; GET /qos/policies
network qos rule listList Network QoS rulesopenstackclient/network/v2/network_qos_rule.py:339list1 (1)GET /qos/policies/{id}; GET /qos/policies
network qos rule setSet Network QoS rule propertiesopenstackclient/network/v2/network_qos_rule.py:387none11 (2)GET /qos/policies/{id}; GET /qos/policies
network qos rule showDisplay Network QoS rule detailsopenstackclient/network/v2/network_qos_rule.py:433single2 (2)GET /qos/policies/{id}; GET /qos/policies
network qos rule type listList QoS rule typesopenstackclient/network/v2/network_qos_rule_type.py:41list5 (0)GET /qos/rule-types
network qos rule type showShow details about supported QoS rule typeopenstackclient/network/v2/network_qos_rule_type.py:99single1 (1)GET /qos/rule-types/{id}
network rbac createCreate network RBAC policyopenstackclient/network/v2/network_rbac.py:103single9 (3)GET /address-groups/{id}; GET /address-groups; GET /projects/{id}
network rbac deleteDelete network RBAC policy(s)openstackclient/network/v2/network_rbac.py:191none1 (1)GET /rbac-policies/{id}; GET /rbac-policies; DELETE /rbac-policies/{id}
network rbac listList network RBAC policiesopenstackclient/network/v2/network_rbac.py:230list7 (0)GET /rbac-policies
network rbac setSet network RBAC policy propertiesopenstackclient/network/v2/network_rbac.py:336none4 (1)GET /rbac-policies/{id}; GET /rbac-policies
network rbac showDisplay network RBAC policy detailsopenstackclient/network/v2/network_rbac.py:385single1 (1)GET /rbac-policies/{id}; GET /rbac-policies
network segment createCreate new network segmentopenstackclient/network/v2/network_segment.py:42single7 (3)GET /networks/{id}; GET /networks; POST /segments
network segment deleteDelete network segment(s)openstackclient/network/v2/network_segment.py:116none1 (1)GET /segments/{id}; GET /segments; DELETE /segments/{id}
network segment listList network segmentsopenstackclient/network/v2/network_segment.py:157list5 (0)GET /segments
network segment range createCreate new network segment rangeopenstackclient/network/v2/network_segment_range.py:112single10 (4)GET /extensions/network-segment-range; GET /extensions; POST /network_segment_ranges
network segment range deleteDelete network segment range(s)openstackclient/network/v2/network_segment_range.py:269none1 (1)GET /extensions/network-segment-range; GET /extensions; GET /network_segment_ranges/{id}
network segment range listList network segment rangesopenstackclient/network/v2/network_segment_range.py:322list8 (0)GET /extensions/network-segment-range; GET /extensions; GET /network_segment_ranges
network segment range setSet network segment range propertiesopenstackclient/network/v2/network_segment_range.py:462none5 (1)GET /extensions/network-segment-range; GET /extensions; GET /network_segment_ranges/{id}
network segment range showDisplay network segment range detailsopenstackclient/network/v2/network_segment_range.py:526single1 (1)GET /extensions/network-segment-range; GET /extensions; GET /network_segment_ranges/{id}
network segment setSet network segment propertiesopenstackclient/network/v2/network_segment.py:230none4 (1)GET /segments/{id}; GET /segments
network segment showDisplay network segment detailsopenstackclient/network/v2/network_segment.py:268single1 (1)GET /segments/{id}; GET /segments
network service provider listList Service Providersopenstackclient/network/v2/network_service_provider.py:26list0 (0)GET /service-providers
network setSet network propertiesopenstackclient/network/v2/network.py:712none25 (1)GET /networks/{id}; GET /networks
network showShow network detailsopenstackclient/network/v2/network.py:857single1 (1)GET /networks/{id}; GET /networks
network subport listList all subports for a given network trunkopenstackclient/network/v2/network_trunk.py:294list1 (1)GET /trunks/{id}; GET /trunks; GET /trunks/{id}/get_subports
network trunk createCreate a network trunk for a given projectopenstackclient/network/v2/network_trunk.py:51single8 (2)GET /ports/{id}; GET /ports; POST /trunks
network trunk deleteDelete a given network trunkopenstackclient/network/v2/network_trunk.py:114none1 (1)GET /trunks/{id}; GET /trunks; DELETE /trunks/{id}
network trunk listList all network trunksopenstackclient/network/v2/network_trunk.py:155list1 (0)GET /trunks
network trunk setSet network trunk propertiesopenstackclient/network/v2/network_trunk.py:196none6 (1)GET /trunks/{id}; GET /trunks
network trunk showShow information of a given network trunkopenstackclient/network/v2/network_trunk.py:268single1 (1)GET /trunks/{id}; GET /trunks
network trunk subport addAdd a subport to a given network trunkopenstackclient/network/v2/network_trunk.py:333none4 (2)GET /trunks/{id}; GET /trunks; GET /ports/{id}
network trunk subport listList all subports for a given network trunkopenstackclient/network/v2/network_trunk.py:314list1 (1)GET /trunks/{id}; GET /trunks; GET /trunks/{id}/get_subports
network trunk subport removeRemove subport(s) from a given network trunkopenstackclient/network/v2/network_trunk.py:387none2 (2)GET /trunks/{id}; GET /trunks; GET /ports/{id}
network trunk unsetUnset subports from a given network trunkopenstackclient/network/v2/network_trunk.py:423none2 (2)GET /ports/{id}; GET /ports; GET /trunks/{id}
network unsetUnset network propertiesopenstackclient/network/v2/network.py:879none4 (1)GET /networks/{id}; GET /networks
port createCreate a new portopenstackclient/network/v2/port.py:573single40 (2)GET /networks/{id}; GET /networks; GET /extensions/tag-ports-during-bulk-creation
port deleteDelete port(s)openstackclient/network/v2/port.py:815none1 (1)GET /ports/{id}; GET /ports; DELETE /ports/{id}
port listList portsopenstackclient/network/v2/port.py:855list25 (0)GET /ports
port setSet port propertiesopenstackclient/network/v2/port.py:1098none39 (1)GET /ports/{id}; GET /ports
port showDisplay port detailsopenstackclient/network/v2/port.py:1358single1 (1)GET /ports/{id}; GET /ports
port unsetUnset port propertiesopenstackclient/network/v2/port.py:1378none16 (1)GET /ports/{id}; GET /ports
router add gatewayAdd router gatewayopenstackclient/network/v2/router.py:1349single3 (2)GET /extensions/external-gateway-multihoming; GET /extensions; GET /routers/{id}
router add portAdd a port to a routeropenstackclient/network/v2/router.py:350none2 (2)GET /ports/{id}; GET /ports; GET /routers/{id}
router add routeAdd extra static routes to a router's routing table.openstackclient/network/v2/router.py:412single2 (1)GET /routers/{id}; GET /routers; PUT /routers/{id}/add_extraroutes
router add subnetAdd a subnet to a routeropenstackclient/network/v2/router.py:374none3 (2)GET /subnets/{id}; GET /subnets; GET /routers/{id}
router createCreate a new routeropenstackclient/network/v2/router.py:516single29 (1)POST /routers
router deleteDelete router(s)openstackclient/network/v2/router.py:727none1 (1)GET /routers/{id}; GET /routers; DELETE /routers/{id}
router listList routersopenstackclient/network/v2/router.py:767list14 (0)GET /routers
router ndp proxy createCreate NDP proxyopenstackclient/network/v2/ndp_proxy.py:44single5 (2)GET /routers/{id}; GET /routers; GET /ports/{id}
router ndp proxy deleteDelete NDP proxyopenstackclient/network/v2/ndp_proxy.py:110none1 (1)GET /ndp_proxies/{id}; GET /ndp_proxies; DELETE /ndp_proxies/{id}
router ndp proxy listList NDP proxiesopenstackclient/network/v2/ndp_proxy.py:145list6 (0)GET /ndp_proxies
router ndp proxy setSet NDP proxy propertiesopenstackclient/network/v2/ndp_proxy.py:249none3 (1)GET /ndp_proxies/{id}; GET /ndp_proxies
router ndp proxy showDisplay NDP proxy detailsopenstackclient/network/v2/ndp_proxy.py:286single1 (1)GET /ndp_proxies/{id}; GET /ndp_proxies
router remove gatewayRemove router gatewayopenstackclient/network/v2/router.py:1418single3 (2)GET /extensions/external-gateway-multihoming; GET /extensions; GET /routers/{id}
router remove portRemove a port from a routeropenstackclient/network/v2/router.py:928none2 (2)GET /ports/{id}; GET /ports; GET /routers/{id}
router remove routeRemove extra static routes from a router's routing table.openstackclient/network/v2/router.py:463single2 (1)GET /routers/{id}; GET /routers; PUT /routers/{id}/remove_extraroutes
router remove subnetRemove a subnet from a routeropenstackclient/network/v2/router.py:954none2 (2)GET /subnets/{id}; GET /subnets; GET /routers/{id}
router setSet router propertiesopenstackclient/network/v2/router.py:982none26 (1)GET /routers/{id}; GET /routers
router showDisplay router detailsopenstackclient/network/v2/router.py:1216single1 (1)GET /routers/{id}; GET /routers; GET /ports
router unsetUnset router propertiesopenstackclient/network/v2/router.py:1254none7 (1)GET /routers/{id}; GET /routers
security group createCreate a new security groupopenstackclient/network/v2/security_group.py:73single9 (1)POST /security-groups
security group default statefulness createCreate a default statefulness setting for security groupsopenstackclient/network/v2/security_groups_default_statefulness.py:38single4 (0)POST /security-groups-default-statefulness
security group default statefulness deleteDelete security group default statefulness setting(s)openstackclient/network/v2/security_groups_default_statefulness.py:97none1 (1)GET /security-groups-default-statefulness/{id}; GET /security-groups-default-statefulness; DELETE /security-groups-default-statefulness/{id}
security group default statefulness listList security group default statefulness settingsopenstackclient/network/v2/security_groups_default_statefulness.py:138list2 (0)GET /security-groups-default-statefulness
security group default statefulness setUpdate a security group default statefulness settingopenstackclient/network/v2/security_groups_default_statefulness.py:184none3 (1)GET /security-groups-default-statefulness/{id}; GET /security-groups-default-statefulness; PUT /security-groups-default-statefulness/{id}
security group default statefulness showShow a security group default statefulness settingopenstackclient/network/v2/security_groups_default_statefulness.py:222single1 (1)GET /security-groups-default-statefulness/{id}; GET /security-groups-default-statefulness
security group deleteDelete security group(s)openstackclient/network/v2/security_group.py:149none1 (1)GET /security-groups/{id}; GET /security-groups; DELETE /security-groups/{id}
security group listList security groupsopenstackclient/network/v2/security_group.py:189list11 (0)GET /security-groups
security group rule createCreate a new security group ruleopenstackclient/network/v2/security_group_rule.py:45single15 (1)GET /security-groups/{id}; GET /security-groups; POST /security-group-rules
security group rule deleteDelete security group rule(s)openstackclient/network/v2/security_group_rule.py:241none1 (1)GET /security-group-rules/{id}; GET /security-group-rules; DELETE /security-group-rules/{id}
security group rule listList security group rulesopenstackclient/network/v2/security_group_rule.py:283list11 (0)GET /security-group-rules
security group rule showDisplay security group rule detailsopenstackclient/network/v2/security_group_rule.py:446single1 (1)GET /security-group-rules/{id}; GET /security-group-rules
security group setSet security group propertiesopenstackclient/network/v2/security_group.py:288none8 (1)GET /security-groups/{id}; GET /security-groups
security group showDisplay security group detailsopenstackclient/network/v2/security_group.py:348single1 (1)GET /security-groups/{id}; GET /security-groups
security group unsetUnset security group propertiesopenstackclient/network/v2/security_group.py:374none3 (1)GET /security-groups/{id}; GET /security-groups
subnet createCreate a subnetopenstackclient/network/v2/subnet.py:309single26 (2)GET /networks/{id}; GET /networks; POST /subnets
subnet deleteDelete subnet(s)openstackclient/network/v2/subnet.py:455none1 (1)GET /subnets/{id}; GET /subnets; DELETE /subnets/{id}
subnet listList subnetsopenstackclient/network/v2/subnet.py:495list19 (0)GET /subnets
subnet pool createCreate subnet poolopenstackclient/network/v2/subnet_pool.py:162single17 (2)POST /subnetpools
subnet pool deleteDelete subnet pool(s)openstackclient/network/v2/subnet_pool.py:235none1 (1)GET /subnetpools/{id}; GET /subnetpools; DELETE /subnetpools/{id}
subnet pool listList subnet poolsopenstackclient/network/v2/subnet_pool.py:274list16 (0)GET /subnetpools
subnet pool setSet subnet pool propertiesopenstackclient/network/v2/subnet_pool.py:410none15 (1)GET /subnetpools/{id}; GET /subnetpools
subnet pool showDisplay subnet pool detailsopenstackclient/network/v2/subnet_pool.py:481single1 (1)GET /subnetpools/{id}; GET /subnetpools
subnet pool unsetUnset subnet pool propertiesopenstackclient/network/v2/subnet_pool.py:505none3 (1)GET /subnetpools/{id}; GET /subnetpools
subnet setSet subnet propertiesopenstackclient/network/v2/subnet.py:677none21 (1)GET /subnets/{id}; GET /subnets
subnet showDisplay subnet detailsopenstackclient/network/v2/subnet.py:793single1 (1)GET /subnets/{id}; GET /subnets
subnet unsetUnset subnet propertiesopenstackclient/network/v2/subnet.py:816none9 (1)GET /subnets/{id}; GET /subnets

openstack.network.v2.bgpvpn (22 commands)

CommandPurposeDefined atOutputArgs (required)Min. microversions in the codeFirst requests observed
bgpvpn createCreate BGP VPN resourceopenstackclient/network/v2/bgpvpn/bgpvpn.py:273single10 (0)POST /bgpvpn/bgpvpns
bgpvpn deleteDelete BGP VPN resource(s)openstackclient/network/v2/bgpvpn/bgpvpn.py:367none1 (1)GET /bgpvpn/bgpvpns/{id}; GET /bgpvpn/bgpvpns; DELETE /bgpvpn/bgpvpns/{id}
bgpvpn listList BGP VPN resourcesopenstackclient/network/v2/bgpvpn/bgpvpn.py:403list4 (0)GET /bgpvpn/bgpvpns
bgpvpn network association createCreate a BGP VPN network associationopenstackclient/network/v2/bgpvpn/network_association.py:54single4 (2)GET /bgpvpn/bgpvpns/{id}; GET /bgpvpn/bgpvpns; GET /networks/{id}
bgpvpn network association deleteDelete a BGP VPN network association(s) for a given BGP VPNopenstackclient/network/v2/bgpvpn/network_association.py:97none2 (2)GET /bgpvpn/bgpvpns/{id}; GET /bgpvpn/bgpvpns; DELETE /bgpvpn/bgpvpns/{id}/network_associations/{id}
bgpvpn network association listList BGP VPN network associations for a given BGP VPNopenstackclient/network/v2/bgpvpn/network_association.py:146list3 (1)GET /bgpvpn/bgpvpns/{id}; GET /bgpvpn/bgpvpns; GET /bgpvpn/bgpvpns/{id}/network_associations
bgpvpn network association showShow information of a given BGP VPN network associationopenstackclient/network/v2/bgpvpn/network_association.py:197single2 (2)GET /bgpvpn/bgpvpns/{id}; GET /bgpvpn/bgpvpns; GET /bgpvpn/bgpvpns/{id}/network_associations/{id}
bgpvpn port association createCreate a BGP VPN port associationopenstackclient/network/v2/bgpvpn/port_association.py:295single8 (2)GET /bgpvpn/bgpvpns/{id}; GET /bgpvpn/bgpvpns; GET /ports/{id}
bgpvpn port association deleteDelete a BGP VPN port association(s) for a given BGP VPNopenstackclient/network/v2/bgpvpn/port_association.py:373none2 (2)GET /bgpvpn/bgpvpns/{id}; GET /bgpvpn/bgpvpns; DELETE /bgpvpn/bgpvpns/{id}/port_associations/{id}
bgpvpn port association listList BGP VPN port associations for a given BGP VPNopenstackclient/network/v2/bgpvpn/port_association.py:422list3 (1)GET /bgpvpn/bgpvpns/{id}; GET /bgpvpn/bgpvpns; GET /bgpvpn/bgpvpns/{id}/port_associations
bgpvpn port association setSet BGP VPN port association propertiesopenstackclient/network/v2/bgpvpn/port_association.py:340none8 (2)GET /bgpvpn/bgpvpns/{id}; GET /bgpvpn/bgpvpns; GET /bgpvpn/bgpvpns/{id}/port_associations/{id}
bgpvpn port association showShow information of a given BGP VPN port associationopenstackclient/network/v2/bgpvpn/port_association.py:474single2 (2)GET /bgpvpn/bgpvpns/{id}; GET /bgpvpn/bgpvpns; GET /bgpvpn/bgpvpns/{id}/port_associations/{id}
bgpvpn port association unsetUnset BGP VPN port association propertiesopenstackclient/network/v2/bgpvpn/port_association.py:368none8 (2)GET /bgpvpn/bgpvpns/{id}; GET /bgpvpn/bgpvpns; GET /bgpvpn/bgpvpns/{id}/port_associations/{id}
bgpvpn router association createCreate a BGP VPN router associationopenstackclient/network/v2/bgpvpn/router_association.py:95single6 (2)GET /bgpvpn/bgpvpns/{id}; GET /bgpvpn/bgpvpns; GET /routers/{id}
bgpvpn router association deleteDelete a BGP VPN router association(s) for a given BGP VPNopenstackclient/network/v2/bgpvpn/router_association.py:172none2 (2)GET /bgpvpn/bgpvpns/{id}; GET /bgpvpn/bgpvpns; DELETE /bgpvpn/bgpvpns/{id}/router_associations/{id}
bgpvpn router association listList BGP VPN router associations for a given BGP VPNopenstackclient/network/v2/bgpvpn/router_association.py:221list3 (1)GET /bgpvpn/bgpvpns/{id}; GET /bgpvpn/bgpvpns; GET /bgpvpn/bgpvpns/{id}/router_associations
bgpvpn router association setSet BGP VPN router association propertiesopenstackclient/network/v2/bgpvpn/router_association.py:139none4 (2)GET /bgpvpn/bgpvpns/{id}; GET /bgpvpn/bgpvpns; PUT /bgpvpn/bgpvpns/{id}/router_associations/{id}
bgpvpn router association showShow information of a given BGP VPN router associationopenstackclient/network/v2/bgpvpn/router_association.py:272single2 (2)GET /bgpvpn/bgpvpns/{id}; GET /bgpvpn/bgpvpns; GET /bgpvpn/bgpvpns/{id}/router_associations/{id}
bgpvpn router association unsetUnset BGP VPN router association propertiesopenstackclient/network/v2/bgpvpn/router_association.py:167none4 (2)GET /bgpvpn/bgpvpns/{id}; GET /bgpvpn/bgpvpns; PUT /bgpvpn/bgpvpns/{id}/router_associations/{id}
bgpvpn setSet BGP VPN propertiesopenstackclient/network/v2/bgpvpn/bgpvpn.py:327none12 (1)GET /bgpvpn/bgpvpns/{id}; GET /bgpvpn/bgpvpns
bgpvpn showShow information of a given BGP VPNopenstackclient/network/v2/bgpvpn/bgpvpn.py:455single1 (1)GET /bgpvpn/bgpvpns/{id}; GET /bgpvpn/bgpvpns
bgpvpn unsetUnset BGP VPN propertiesopenstackclient/network/v2/bgpvpn/bgpvpn.py:347none11 (1)GET /bgpvpn/bgpvpns/{id}; GET /bgpvpn/bgpvpns

openstack.network.v2.dynamic_routing (18 commands)

CommandPurposeDefined atOutputArgs (required)Min. microversions in the codeFirst requests observed
bgp dragent add speakerAdd a BGP speaker to a dynamic routing agentopenstackclient/network/v2/dynamic_routing/bgp_dragent.py:23none2 (2)GET /bgp-speakers/{id}; GET /bgp-speakers; POST /agents/{id}/bgp-drinstances
bgp dragent listList dynamic routing agentsopenstackclient/network/v2/dynamic_routing/bgp_dragent.py:75list1 (0)GET /agents
bgp dragent remove speakerRemoves a BGP speaker from a dynamic routing agentopenstackclient/network/v2/dynamic_routing/bgp_dragent.py:48none2 (2)GET /bgp-speakers/{id}; GET /bgp-speakers; DELETE /agents/{id}/bgp-drinstances/{id}
bgp peer createCreate a BGP peeropenstackclient/network/v2/dynamic_routing/bgp_peer.py:61single7 (3)POST /bgp-peers
bgp peer deleteDelete a BGP peeropenstackclient/network/v2/dynamic_routing/bgp_peer.py:130none1 (1)GET /bgp-peers/{id}; GET /bgp-peers; DELETE /bgp-peers/{id}
bgp peer listList BGP peersopenstackclient/network/v2/dynamic_routing/bgp_peer.py:150list0 (0)GET /bgp-peers
bgp peer setUpdate a BGP peeropenstackclient/network/v2/dynamic_routing/bgp_peer.py:171none3 (1)GET /bgp-peers/{id}; GET /bgp-peers; PUT /bgp-peers/{id}
bgp peer showShow information for a BGP peeropenstackclient/network/v2/dynamic_routing/bgp_peer.py:198single1 (1)GET /bgp-peers/{id}; GET /bgp-peers
bgp speaker add networkAdd a network to a BGP speakeropenstackclient/network/v2/dynamic_routing/bgp_speaker.py:80none2 (2)GET /bgp-speakers/{id}; GET /bgp-speakers; GET /networks/{id}
bgp speaker add peerAdd a peer to a BGP speakeropenstackclient/network/v2/dynamic_routing/bgp_speaker.py:108none2 (2)GET /bgp-speakers/{id}; GET /bgp-speakers; GET /bgp-peers/{id}
bgp speaker createCreate a BGP speakeropenstackclient/network/v2/dynamic_routing/bgp_speaker.py:136single9 (2)POST /bgp-speakers
bgp speaker deleteDelete a BGP speakeropenstackclient/network/v2/dynamic_routing/bgp_speaker.py:193none1 (1)GET /bgp-speakers/{id}; GET /bgp-speakers; DELETE /bgp-speakers/{id}
bgp speaker listList BGP speakersopenstackclient/network/v2/dynamic_routing/bgp_speaker.py:213list1 (0)GET /bgp-speakers
bgp speaker list advertised routesList routes advertisedopenstackclient/network/v2/dynamic_routing/bgp_speaker.py:240list1 (1)GET /bgp-speakers/{id}; GET /bgp-speakers; GET /bgp-speakers/{id}/get_advertised_routes
bgp speaker remove networkRemove a network from a BGP speakeropenstackclient/network/v2/dynamic_routing/bgp_speaker.py:271none2 (2)GET /bgp-speakers/{id}; GET /bgp-speakers; GET /networks/{id}
bgp speaker remove peerRemove a peer from a BGP speakeropenstackclient/network/v2/dynamic_routing/bgp_speaker.py:299none2 (2)GET /bgp-speakers/{id}; GET /bgp-speakers; GET /bgp-peers/{id}
bgp speaker setSet BGP speaker propertiesopenstackclient/network/v2/dynamic_routing/bgp_speaker.py:327none6 (1)GET /bgp-speakers/{id}; GET /bgp-speakers
bgp speaker showShow a BGP speakeropenstackclient/network/v2/dynamic_routing/bgp_speaker.py:350single1 (1)GET /bgp-speakers/{id}; GET /bgp-speakers

openstack.network.v2.fwaas (20 commands)

CommandPurposeDefined atOutputArgs (required)Min. microversions in the codeFirst requests observed
firewall group createCreate a new firewall groupopenstackclient/network/v2/fwaas/group.py:180single15 (0)POST /fwaas/firewall_groups
firewall group deleteDelete firewall group(s)openstackclient/network/v2/fwaas/group.py:260none1 (1)GET /fwaas/firewall_groups/{id}; GET /fwaas/firewall_groups; DELETE /fwaas/firewall_groups/{id}
firewall group listList firewall groupsopenstackclient/network/v2/fwaas/group.py:298list1 (0)GET /fwaas/firewall_groups
firewall group policy add ruleInsert a rule into a given firewall policyopenstackclient/network/v2/fwaas/policy.py:212none4 (2)GET /fwaas/firewall_policies/{id}; GET /fwaas/firewall_policies; GET /fwaas/firewall_rules/{id}
firewall group policy createCreate a new firewall policyopenstackclient/network/v2/fwaas/policy.py:127single10 (1)POST /fwaas/firewall_policies
firewall group policy deleteDelete firewall policy(s)openstackclient/network/v2/fwaas/policy.py:172none1 (1)GET /fwaas/firewall_policies/{id}; GET /fwaas/firewall_policies; DELETE /fwaas/firewall_policies/{id}
firewall group policy listList firewall policiesopenstackclient/network/v2/fwaas/policy.py:324list1 (0)GET /fwaas/firewall_policies
firewall group policy remove ruleRemove a rule from a given firewall policyopenstackclient/network/v2/fwaas/policy.py:285none2 (2)GET /fwaas/firewall_policies/{id}; GET /fwaas/firewall_policies; GET /fwaas/firewall_rules/{id}
firewall group policy setSet firewall policy propertiesopenstackclient/network/v2/fwaas/policy.py:354none9 (1)GET /fwaas/firewall_policies/{id}; GET /fwaas/firewall_policies
firewall group policy showDisplay firewall policy detailsopenstackclient/network/v2/fwaas/policy.py:399single1 (1)GET /fwaas/firewall_policies/{id}; GET /fwaas/firewall_policies
firewall group policy unsetUnset firewall policy propertiesopenstackclient/network/v2/fwaas/policy.py:440none5 (1)GET /fwaas/firewall_policies/{id}; GET /fwaas/firewall_policies
firewall group rule createCreate a new firewall ruleopenstackclient/network/v2/fwaas/rule.py:282single24 (0)POST /fwaas/firewall_rules
firewall group rule deleteDelete firewall rule(s)openstackclient/network/v2/fwaas/rule.py:346none1 (1)GET /fwaas/firewall_rules/{id}; GET /fwaas/firewall_rules; DELETE /fwaas/firewall_rules/{id}
firewall group rule listList firewall rules that belong to a given tenantopenstackclient/network/v2/fwaas/rule.py:384list1 (0)GET /fwaas/firewall_rules
firewall group rule setSet firewall rule propertiesopenstackclient/network/v2/fwaas/rule.py:440none22 (1)GET /fwaas/firewall_rules/{id}; GET /fwaas/firewall_rules
firewall group rule showDisplay firewall rule detailsopenstackclient/network/v2/fwaas/rule.py:476single1 (1)GET /fwaas/firewall_rules/{id}; GET /fwaas/firewall_rules
firewall group rule unsetUnset firewall rule propertiesopenstackclient/network/v2/fwaas/rule.py:503none9 (1)GET /fwaas/firewall_rules/{id}; GET /fwaas/firewall_rules
firewall group setSet firewall group propertiesopenstackclient/network/v2/fwaas/group.py:327none13 (1)GET /fwaas/firewall_groups/{id}; GET /fwaas/firewall_groups
firewall group showDisplay firewall group detailsopenstackclient/network/v2/fwaas/group.py:374single1 (1)GET /fwaas/firewall_groups/{id}; GET /fwaas/firewall_groups
firewall group unsetUnset firewall group propertiesopenstackclient/network/v2/fwaas/group.py:401none7 (1)GET /fwaas/firewall_groups/{id}; GET /fwaas/firewall_groups

openstack.network.v2.taas (15 commands)

CommandPurposeDefined atOutputArgs (required)Min. microversions in the codeFirst requests observed
tap flow createCreate a new tap flow.openstackclient/network/v2/taas/tap_flow.py:68single8 (3)GET /ports/{id}; GET /ports; GET /taas/tap_services/{id}
tap flow deleteDelete a tap flow.openstackclient/network/v2/taas/tap_flow.py:207none1 (1)GET /taas/tap_flows/{id}; GET /taas/tap_flows; DELETE /taas/tap_flows/{id}
tap flow listList tap flows.openstackclient/network/v2/taas/tap_flow.py:145list2 (0)GET /taas/tap_flows
tap flow showShow tap flow details.openstackclient/network/v2/taas/tap_flow.py:182single1 (1)GET /taas/tap_flows/{id}; GET /taas/tap_flows
tap flow updateUpdate a tap flow.openstackclient/network/v2/taas/tap_flow.py:242single3 (1)GET /taas/tap_flows/{id}; GET /taas/tap_flows
tap mirror createCreate a new tap mirror.openstackclient/network/v2/taas/tap_mirror.py:56single8 (4)
tap mirror deleteDelete a tap mirror.openstackclient/network/v2/taas/tap_mirror.py:188none1 (1)GET /taas/tap_mirrors/{id}; GET /taas/tap_mirrors; DELETE /taas/tap_mirrors/{id}
tap mirror listList tap mirrors.openstackclient/network/v2/taas/tap_mirror.py:131list2 (0)GET /taas/tap_mirrors
tap mirror showShow tap mirror details.openstackclient/network/v2/taas/tap_mirror.py:163single1 (1)GET /taas/tap_mirrors/{id}; GET /taas/tap_mirrors
tap mirror updateUpdate a tap mirror.openstackclient/network/v2/taas/tap_mirror.py:227single3 (1)GET /taas/tap_mirrors/{id}; GET /taas/tap_mirrors
tap service createCreate a new tap service.openstackclient/network/v2/taas/tap_service.py:61single5 (1)GET /ports/{id}; GET /ports; POST /taas/tap_services
tap service deleteDelete a tap service.openstackclient/network/v2/taas/tap_service.py:162none1 (1)GET /taas/tap_services/{id}; GET /taas/tap_services; DELETE /taas/tap_services/{id}
tap service listList tap services.openstackclient/network/v2/taas/tap_service.py:105list2 (0)GET /taas/tap_services
tap service showShow tap service details.openstackclient/network/v2/taas/tap_service.py:137single1 (1)GET /taas/tap_services/{id}; GET /taas/tap_services
tap service updateUpdate a tap service.openstackclient/network/v2/taas/tap_service.py:201single3 (1)GET /taas/tap_services/{id}; GET /taas/tap_services

openstack.network.v2.vpnaas (25 commands)

CommandPurposeDefined atOutputArgs (required)Min. microversions in the codeFirst requests observed
vpn endpoint group createCreate an endpoint groupopenstackclient/network/v2/vpnaas/endpoint_group.py:49single6 (3)GET /subnets/{id}; GET /subnets; POST /vpn/endpoint-groups
vpn endpoint group deleteDelete endpoint group(s)openstackclient/network/v2/vpnaas/endpoint_group.py:119none1 (1)GET /vpn/endpoint-groups/{id}; GET /vpn/endpoint-groups; DELETE /vpn/endpoint-groups/{id}
vpn endpoint group listList endpoint groups that belong to a given projectopenstackclient/network/v2/vpnaas/endpoint_group.py:156list1 (0)GET /vpn/endpoint-groups
vpn endpoint group setSet endpoint group propertiesopenstackclient/network/v2/vpnaas/endpoint_group.py:180none3 (1)GET /vpn/endpoint-groups/{id}; GET /vpn/endpoint-groups
vpn endpoint group showDisplay endpoint group detailsopenstackclient/network/v2/vpnaas/endpoint_group.py:221single1 (1)GET /vpn/endpoint-groups/{id}; GET /vpn/endpoint-groups
vpn ike policy createCreate an IKE policyopenstackclient/network/v2/vpnaas/ikepolicy.py:197single10 (1)POST /vpn/ikepolicies
vpn ike policy deleteDelete IKE policy (policies)openstackclient/network/v2/vpnaas/ikepolicy.py:232none1 (1)GET /vpn/ikepolicies/{id}; GET /vpn/ikepolicies; DELETE /vpn/ikepolicies/{id}
vpn ike policy listList IKE policies that belong to a given projectopenstackclient/network/v2/vpnaas/ikepolicy.py:269list1 (0)GET /vpn/ikepolicies
vpn ike policy setSet IKE policy propertiesopenstackclient/network/v2/vpnaas/ikepolicy.py:292none9 (1)GET /vpn/ikepolicies/{id}; GET /vpn/ikepolicies
vpn ike policy showDisplay IKE policy detailsopenstackclient/network/v2/vpnaas/ikepolicy.py:326single1 (1)GET /vpn/ikepolicies/{id}; GET /vpn/ikepolicies
vpn ipsec policy createCreate an IPsec policyopenstackclient/network/v2/vpnaas/ipsecpolicy.py:190single10 (1)POST /vpn/ipsecpolicies
vpn ipsec policy deleteDelete IPsec policy(policies)openstackclient/network/v2/vpnaas/ipsecpolicy.py:233none1 (1)GET /vpn/ipsecpolicies/{id}; GET /vpn/ipsecpolicies; DELETE /vpn/ipsecpolicies/{id}
vpn ipsec policy listList IPsec policies that belong to a given projectopenstackclient/network/v2/vpnaas/ipsecpolicy.py:270list1 (0)GET /vpn/ipsecpolicies
vpn ipsec policy setSet IPsec policy propertiesopenstackclient/network/v2/vpnaas/ipsecpolicy.py:294none9 (1)GET /vpn/ipsecpolicies/{id}; GET /vpn/ipsecpolicies
vpn ipsec policy showDisplay IPsec policy detailsopenstackclient/network/v2/vpnaas/ipsecpolicy.py:328single1 (1)GET /vpn/ipsecpolicies/{id}; GET /vpn/ipsecpolicies
vpn ipsec site connection createCreate an IPsec site connectionopenstackclient/network/v2/vpnaas/ipsec_site_connection.py:198single19 (7)GET /vpn/vpnservices/{id}; GET /vpn/vpnservices; GET /vpn/ikepolicies/{id}
vpn ipsec site connection deleteDelete IPsec site connection(s)openstackclient/network/v2/vpnaas/ipsec_site_connection.py:305none1 (1)GET /vpn/ipsec-site-connections/{id}; GET /vpn/ipsec-site-connections; DELETE /vpn/ipsec-site-connections/{id}
vpn ipsec site connection listList IPsec site connections that belong to a given projectopenstackclient/network/v2/vpnaas/ipsec_site_connection.py:343list1 (0)GET /vpn/ipsec-site-connections
vpn ipsec site connection setSet IPsec site connection propertiesopenstackclient/network/v2/vpnaas/ipsec_site_connection.py:375none14 (1)GET /vpn/ipsec-site-connections/{id}; GET /vpn/ipsec-site-connections
vpn ipsec site connection showShow information of a given IPsec site connectionopenstackclient/network/v2/vpnaas/ipsec_site_connection.py:425single1 (1)GET /vpn/ipsec-site-connections/{id}; GET /vpn/ipsec-site-connections
vpn service createCreate an VPN serviceopenstackclient/network/v2/vpnaas/vpnservice.py:111single9 (2)GET /routers/{id}; GET /routers; POST /vpn/vpnservices
vpn service deleteDelete VPN service(s)openstackclient/network/v2/vpnaas/vpnservice.py:157none1 (1)GET /vpn/vpnservices/{id}; GET /vpn/vpnservices; DELETE /vpn/vpnservices/{id}
vpn service listList VPN services that belong to a given projectopenstackclient/network/v2/vpnaas/vpnservice.py:191list1 (0)GET /vpn/vpnservices
vpn service setSet VPN service propertiesopenstackclient/network/v2/vpnaas/vpnservice.py:215none7 (1)GET /vpn/vpnservices/{id}; GET /vpn/vpnservices
vpn service showDisplay VPN service detailsopenstackclient/network/v2/vpnaas/vpnservice.py:249single1 (1)GET /vpn/vpnservices/{id}; GET /vpn/vpnservices

openstack.object_store.v1 (17 commands)

CommandPurposeDefined atOutputArgs (required)Min. microversions in the codeFirst requests observed
container createCreate new containeropenstackclient/object/v1/container.py:34list3 (1)PUT /{id}
container deleteDelete containeropenstackclient/object/v1/container.py:89none2 (1)DELETE /{id}
container listList containersopenstackclient/object/v1/container.py:125list6 (0)GET /
container saveSave container contents locallyopenstackclient/object/v1/container.py:191none1 (1)GET /{id}
container setSet container propertiesopenstackclient/object/v1/container.py:209none2 (2)POST /{id}
container showDisplay container detailsopenstackclient/object/v1/container.py:238single1 (1)HEAD /{id}
container unsetUnset container propertiesopenstackclient/object/v1/container.py:263none2 (2)POST /{id}
object createUpload object to containeropenstackclient/object/v1/object.py:36list3 (2)
object deleteDelete object from containeropenstackclient/object/v1/object.py:103none2 (2)DELETE /{id}/{id}
object listList objectsopenstackclient/object/v1/object.py:129list8 (1)GET /{id}
object saveSave object locallyopenstackclient/object/v1/object.py:209none3 (2)GET /{id}/{id}
object setSet object propertiesopenstackclient/object/v1/object.py:242none3 (3)POST /{id}/{id}
object showDisplay object detailsopenstackclient/object/v1/object.py:277single2 (2)HEAD /{id}/{id}
object store account setSet account propertiesopenstackclient/object/v1/account.py:27none1 (1)POST /
object store account showDisplay account detailsopenstackclient/object/v1/account.py:50single0 (0)HEAD /
object store account unsetUnset account propertiesopenstackclient/object/v1/account.py:65none1 (1)POST /
object unsetUnset object propertiesopenstackclient/object/v1/object.py:308none3 (3)POST /{id}/{id}

Share group, share.v2 (40 commands) — never loaded: ignored in favour of the python-manilaclient plugin

CommandPurposeDefined atOutputArgs (required)Min. microversions in the codeFirst requests observed
share group createCreate new share groupopenstackclient/share/v2/share_groups.py:30single8 (0)
share group deleteDelete one or more share groupsopenstackclient/share/v2/share_groups.py:163none3 (1)
share group listList share groupsopenstackclient/share/v2/share_groups.py:232list16 (0)
share group setExplicitly set share group statusopenstackclient/share/v2/share_groups.py:479none4 (1)
share group showShow details about a share groupopenstackclient/share/v2/share_groups.py:444single1 (1)
share group snapshot createCreate a share group snapshot of the given share groupopenstackclient/share/v2/share_group_snapshots.py:28single4 (1)
share group snapshot deleteDelete one or more share group snapshotopenstackclient/share/v2/share_group_snapshots.py:95none3 (1)
share group snapshot listList share group snapshotsopenstackclient/share/v2/share_group_snapshots.py:338list8 (0)
share group snapshot members listList members of share group snapshotopenstackclient/share/v2/share_group_snapshots.py:453list1 (1)
share group snapshot setSet share group snapshot propertiesopenstackclient/share/v2/share_group_snapshots.py:194none4 (1)
share group snapshot showShow details about a share group snapshotopenstackclient/share/v2/share_group_snapshots.py:163single1 (1)
share group snapshot unsetUnset a share group snapshot propertyopenstackclient/share/v2/share_group_snapshots.py:287none3 (1)
share group type access createAllow a project to access a share group type (Admin only).openstackclient/share/v2/share_group_type_access.py:29none3 (2)
share group type access deleteDeny a project to access a share group type (Admin only).openstackclient/share/v2/share_group_type_access.py:129none3 (2)
share group type access listGet access list for share group type (Admin only).openstackclient/share/v2/share_group_type_access.py:93list1 (1)
share group type createCreate new share group typeopenstackclient/share/v2/share_group_types.py:39single4 (2)
share group type deleteDelete a share group typeopenstackclient/share/v2/share_group_types.py:134none1 (1)
share group type listList share typesopenstackclient/share/v2/share_group_types.py:180list2 (0)
share group type setSet share group type propertiesopenstackclient/share/v2/share_group_types.py:283none2 (1)
share group type showShow share group typesopenstackclient/share/v2/share_group_types.py:242single1 (1)
share group type unsetUnset share group type extra specsopenstackclient/share/v2/share_group_types.py:340none2 (2)
share group unsetUnset a share group propertyopenstackclient/share/v2/share_groups.py:550none3 (1)
share lock createLock a resource action from occurring on a resourceopenstackclient/share/v2/resource_locks.py:81single4 (2)
share lock deleteRemove one or more resource locksopenstackclient/share/v2/resource_locks.py:138none1 (1)
share lock listLists all resource locksopenstackclient/share/v2/resource_locks.py:176list15 (0)
share lock setUpdate resource lock propertiesopenstackclient/share/v2/resource_locks.py:419none3 (1)
share lock showShow details about a resource lockopenstackclient/share/v2/resource_locks.py:390single1 (1)
share lock unsetRemove resource lock propertiesopenstackclient/share/v2/resource_locks.py:458none2 (1)
share message deleteRemove one or more messagesopenstackclient/share/v2/messages.py:42none1 (1)
share message listLists all messagesopenstackclient/share/v2/messages.py:80list9 (0)
share message showShow details about a messageopenstackclient/share/v2/messages.py:202single1 (1)
share security service createCreate security service used by project.openstackclient/share/v2/security_services.py:29single10 (1)
share security service deleteDelete one or more security services.openstackclient/share/v2/security_services.py:161none1 (1)
share security service listList security services.openstackclient/share/v2/security_services.py:484list14 (0)
share security service setSet security service.openstackclient/share/v2/security_services.py:234none10 (1)
share security service showShow security service.openstackclient/share/v2/security_services.py:203single1 (1)
share security service unsetUnset security service.openstackclient/share/v2/security_services.py:360none10 (1)
share service ensure sharesRun ensure shares in a back end (Admin only).openstackclient/share/v2/services.py:185none1 (1)
share service listList share services (Admin only).openstackclient/share/v2/services.py:108list5 (0)
share service setEnable/Disable share service (Admin only).openstackclient/share/v2/services.py:25none5 (2)

openstack.volume.v2 (57 commands) — not loaded with the default API versions

CommandPurposeDefined atOutputArgs (required)Min. microversions in the codeFirst requests observed
consistency group add volumeAdd volume(s) to consistency groupopenstackclient/volume/v2/consistency_group.py:72none2 (2)
consistency group createCreate new consistency group.openstackclient/volume/v2/consistency_group.py:116single8 (0)
consistency group deleteDelete consistency group(s).openstackclient/volume/v2/consistency_group.py:222none2 (1)
consistency group listList consistency groups.openstackclient/volume/v2/consistency_group.py:273list2 (0)
consistency group remove volumeRemove volume(s) from consistency groupopenstackclient/volume/v2/consistency_group.py:338none2 (2)
consistency group setSet consistency group propertiesopenstackclient/volume/v2/consistency_group.py:382none3 (1)
consistency group showDisplay consistency group details.openstackclient/volume/v2/consistency_group.py:420single1 (1)
consistency group snapshot createCreate new consistency group snapshot.openstackclient/volume/v2/consistency_group_snapshot.py:52single3 (0)
consistency group snapshot deleteDelete consistency group snapshot(s).openstackclient/volume/v2/consistency_group_snapshot.py:103none1 (1)
consistency group snapshot listList consistency group snapshots.openstackclient/volume/v2/consistency_group_snapshot.py:151list4 (0)
consistency group snapshot showDisplay consistency group snapshot detailsopenstackclient/volume/v2/consistency_group_snapshot.py:241single1 (1)
volume backend capability showShow capability commandopenstackclient/volume/v2/volume_backend.py:29list1 (1)
volume backend pool listList pool commandopenstackclient/volume/v2/volume_backend.py:80list1 (0)
volume backup createCreate new volume backupopenstackclient/volume/v2/volume_backup.py:64single8 (1)
volume backup deleteDelete volume backup(s)openstackclient/volume/v2/volume_backup.py:149none2 (1)
volume backup listList volume backupsopenstackclient/volume/v2/volume_backup.py:203list8 (0)
volume backup record exportExport volume backup details.openstackclient/volume/v2/backup_record.py:31single1 (1)
volume backup record importImport volume backup details.openstackclient/volume/v2/backup_record.py:69single2 (2)
volume backup restoreRestore volume backupopenstackclient/volume/v2/volume_backup.py:341single3 (1)
volume backup setSet volume backup propertiesopenstackclient/volume/v2/volume_backup.py:417none2 (1)
volume backup showDisplay volume backup detailsopenstackclient/volume/v2/volume_backup.py:465single1 (1)
volume createCreate new volumeopenstackclient/volume/v2/volume.py:145single16 (0)
volume deleteDelete volume(s)openstackclient/volume/v2/volume.py:386none4 (1)
volume host failoverFailover volume host to different backendopenstackclient/volume/v2/volume_host.py:26none2 (2)
volume host setSet volume host propertiesopenstackclient/volume/v2/volume_host.py:55none3 (1)
volume listList volumesopenstackclient/volume/v2/volume.py:457list10 (0)
volume migrateMigrate volume to a new hostopenstackclient/volume/v2/volume.py:594none4 (2)
volume qos associateAssociate a QoS specification to a volume typeopenstackclient/volume/v2/qos_specs.py:36none2 (2)
volume qos createCreate new QoS specificationopenstackclient/volume/v2/qos_specs.py:66single3 (1)
volume qos deleteDelete QoS specificationopenstackclient/volume/v2/qos_specs.py:124none2 (1)
volume qos disassociateDisassociate a QoS specification from a volume typeopenstackclient/volume/v2/qos_specs.py:173none3 (1)
volume qos listList QoS specificationsopenstackclient/volume/v2/qos_specs.py:215list0 (0)
volume qos setSet QoS specification propertiesopenstackclient/volume/v2/qos_specs.py:251none3 (1)
volume qos showDisplay QoS specification detailsopenstackclient/volume/v2/qos_specs.py:315single1 (1)
volume qos unsetUnset QoS specification propertiesopenstackclient/volume/v2/qos_specs.py:364none2 (1)
volume service listList service commandopenstackclient/volume/v2/service.py:29list3 (0)
volume service setSet volume service propertiesopenstackclient/volume/v2/service.py:95none5 (2)
volume setSet volume propertiesopenstackclient/volume/v2/volume.py:647none17 (1)
volume showDisplay volume detailsopenstackclient/volume/v2/volume.py:969single1 (1)
volume snapshot createCreate new volume snapshotopenstackclient/volume/v2/volume_snapshot.py:105single6 (1)
volume snapshot deleteDelete volume snapshot(s)openstackclient/volume/v2/volume_snapshot.py:202none2 (1)
volume snapshot listList volume snapshotsopenstackclient/volume/v2/volume_snapshot.py:257list10 (0)
volume snapshot setSet volume snapshot propertiesopenstackclient/volume/v2/volume_snapshot.py:403none6 (1)
volume snapshot showDisplay volume snapshot detailsopenstackclient/volume/v2/volume_snapshot.py:520single1 (1)
volume snapshot unsetUnset volume snapshot propertiesopenstackclient/volume/v2/volume_snapshot.py:548none2 (1)
volume transfer request acceptAccept volume transfer request.openstackclient/volume/v2/volume_transfer_request.py:34single2 (2)
volume transfer request createCreate volume transfer request.openstackclient/volume/v2/volume_transfer_request.py:75single2 (1)
volume transfer request deleteDelete volume transfer request(s).openstackclient/volume/v2/volume_transfer_request.py:116none1 (1)
volume transfer request listLists all volume transfer requests.openstackclient/volume/v2/volume_transfer_request.py:157list1 (0)
volume transfer request showShow volume transfer request details.openstackclient/volume/v2/volume_transfer_request.py:190single1 (1)
volume type createCreate new volume typeopenstackclient/volume/v2/volume_type.py:156single15 (1)
volume type deleteDelete volume type(s)openstackclient/volume/v2/volume_type.py:379none1 (1)
volume type listList volume typesopenstackclient/volume/v2/volume_type.py:422list5 (0)
volume type setSet volume type propertiesopenstackclient/volume/v2/volume_type.py:535none16 (1)
volume type showDisplay volume type detailsopenstackclient/volume/v2/volume_type.py:770single2 (1)
volume type unsetUnset volume type propertiesopenstackclient/volume/v2/volume_type.py:842none5 (1)
volume unsetUnset volume propertiesopenstackclient/volume/v2/volume.py:997none3 (1)

openstack.volume.v3 (94 commands)

CommandPurposeDefined atOutputArgs (required)Min. microversions in the codeFirst requests observed
block storage cleanupDo block storage cleanup.openstackclient/volume/v3/block_storage_cleanup.py:58list10 (0)3.24
block storage cluster listList block storage clusters.openstackclient/volume/v3/block_storage_cluster.py:77list9 (0)3.7GET /clusters (3.26)
block storage cluster setSet block storage cluster properties.openstackclient/volume/v3/block_storage_cluster.py:188none5 (1)3.7PUT /clusters/enable
block storage cluster showShow detailed information for a block storage cluster.openstackclient/volume/v3/block_storage_cluster.py:269single2 (1)3.7GET /clusters/{id} (3.26)
block storage log level listList log levels of block storage service.openstackclient/volume/v3/block_storage_log_level.py:27list3 (0)3.32PUT /os-services/get-log (3.32)
block storage log level setSet log level of block storage serviceopenstackclient/volume/v3/block_storage_log_level.py:102none4 (1)3.32PUT /os-services/set-log (3.32)
block storage resource filter listList block storage resource filtersopenstackclient/volume/v3/block_storage_resource_filter.py:28list0 (0)3.33GET /resource_filters (3.33)
block storage resource filter showShow filters for a block storage resource typeopenstackclient/volume/v3/block_storage_resource_filter.py:66single1 (1)3.33GET /resource_filters (3.33)
block storage snapshot manageable listList manageable snapshots.openstackclient/volume/v3/block_storage_manage.py:205list8 (0)3.8, 3.17
block storage volume manageable listList manageable volumes.openstackclient/volume/v3/block_storage_manage.py:31list8 (0)3.8, 3.17
consistency group add volumeAdd volume(s) to consistency groupopenstackclient/volume/v3/consistency_group.py:71none2 (2)GET /volumes/{id} (3.71); GET /volumes/detail (3.71); GET /consistencygroups/{id}
consistency group createCreate new consistency group.openstackclient/volume/v3/consistency_group.py:115single8 (0)GET /types/{id}; GET /types; POST /consistencygroups
consistency group deleteDelete consistency group(s).openstackclient/volume/v3/consistency_group.py:221none2 (1)GET /consistencygroups/{id}; GET /consistencygroups/detail; POST /consistencygroups/{id}/delete
consistency group listList consistency groups.openstackclient/volume/v3/consistency_group.py:272list2 (0)GET /consistencygroups/detail
consistency group remove volumeRemove volume(s) from consistency groupopenstackclient/volume/v3/consistency_group.py:337none2 (2)GET /volumes/{id} (3.71); GET /volumes/detail (3.71); GET /consistencygroups/{id}
consistency group setSet consistency group propertiesopenstackclient/volume/v3/consistency_group.py:381none3 (1)
consistency group showDisplay consistency group details.openstackclient/volume/v3/consistency_group.py:419single1 (1)GET /consistencygroups/{id}; GET /consistencygroups/detail
consistency group snapshot createCreate new consistency group snapshot.openstackclient/volume/v3/consistency_group_snapshot.py:51single3 (0)
consistency group snapshot deleteDelete consistency group snapshot(s).openstackclient/volume/v3/consistency_group_snapshot.py:102none1 (1)GET /cgsnapshots/{id}; GET /cgsnapshots/detail; DELETE /cgsnapshots/{id}
consistency group snapshot listList consistency group snapshots.openstackclient/volume/v3/consistency_group_snapshot.py:150list4 (0)GET /cgsnapshots/detail
consistency group snapshot showDisplay consistency group snapshot detailsopenstackclient/volume/v3/consistency_group_snapshot.py:240single1 (1)GET /cgsnapshots/{id}; GET /cgsnapshots/detail
volume attachment completeComplete an attachment for a volume.openstackclient/volume/v3/volume_attachment.py:378none1 (1)3.44POST /attachments/{id}/action (3.71)
volume attachment createCreate an attachment for a volume.openstackclient/volume/v3/volume_attachment.py:85single13 (2)3.27, 3.54GET /volumes/{id} (3.71); GET /volumes/detail (3.71); GET /servers/{id} (2.100)
volume attachment deleteDelete an attachment for a volume.openstackclient/volume/v3/volume_attachment.py:249none1 (1)3.27DELETE /attachments/{id} (3.71)
volume attachment listLists all volume attachments.openstackclient/volume/v3/volume_attachment.py:405list8 (0)3.27GET /attachments (3.71)
volume attachment setUpdate an attachment for a volume.openstackclient/volume/v3/volume_attachment.py:285single9 (1)3.27PUT /attachments/{id} (3.71)
volume attachment showShow detailed information for a volume attachment.openstackclient/volume/v3/volume_attachment.py:514single1 (1)3.27GET /attachments/{id} (3.71)
volume backend capability showShow capability commandopenstackclient/volume/v3/volume_backend.py:29list1 (1)GET /capabilities/{id}
volume backend pool listList pool commandopenstackclient/volume/v3/volume_backend.py:80list1 (0)GET /scheduler-stats/get_pools
volume backup createCreate new volume backupopenstackclient/volume/v3/volume_backup.py:66single10 (1)3.43, 3.51GET /volumes/{id} (3.71); GET /volumes/detail (3.71); POST /backups (3.64)
volume backup deleteDelete volume backup(s)openstackclient/volume/v3/volume_backup.py:191none2 (1)GET /backups/{id} (3.64); GET /backups/detail (3.64); DELETE /backups/{id} (3.64)
volume backup listList volume backupsopenstackclient/volume/v3/volume_backup.py:245list9 (0)GET /volumes/detail (3.71); GET /backups/detail (3.64)
volume backup record exportExport volume backup details.openstackclient/volume/v3/backup_record.py:29single1 (1)GET /backups/{id} (3.64); GET /backups/detail (3.64); GET /backups/{id}/export_record
volume backup record importImport volume backup details.openstackclient/volume/v3/backup_record.py:67single2 (2)POST /backups/export_record (3.64)
volume backup restoreRestore volume backupopenstackclient/volume/v3/volume_backup.py:414single3 (1)GET /backups/{id} (3.64); GET /backups/detail (3.64)
volume backup setSet volume backup propertiesopenstackclient/volume/v3/volume_backup.py:488none6 (1)3.9, 3.43GET /backups/{id} (3.64); GET /backups/detail (3.64)
volume backup showDisplay volume backup detailsopenstackclient/volume/v3/volume_backup.py:684single1 (1)GET /backups/{id} (3.64); GET /backups/detail (3.64)
volume backup unsetUnset volume backup properties.openstackclient/volume/v3/volume_backup.py:627none2 (1)3.43GET /backups/{id} (3.64); GET /backups/detail (3.64)
volume createCreate new volumeopenstackclient/volume/v3/volume.py:150single20 (0)3.16, 3.47
volume deleteDelete volume(s)openstackclient/volume/v3/volume.py:511none5 (1)GET /volumes/{id} (3.71); GET /volumes/detail (3.71); DELETE /volumes/{id} (3.71)
volume group createCreate a volume group.openstackclient/volume/v3/volume_group.py:66single9 (0)3.13, 3.14
volume group deleteDelete a volume group.openstackclient/volume/v3/volume_group.py:276none2 (1)3.13GET /groups/{id} (3.38); GET /groups/detail (3.38); POST /groups/{id}/action (3.38)
volume group failoverFailover replication for a volume group.openstackclient/volume/v3/volume_group.py:576none4 (1)3.38GET /groups/{id} (3.38); GET /groups/detail (3.38); POST /groups/{id}/action (3.38)
volume group listLists all volume groups.openstackclient/volume/v3/volume_group.py:412list1 (0)3.13GET /groups/detail (3.38)
volume group setUpdate a volume group.openstackclient/volume/v3/volume_group.py:320single5 (1)3.13, 3.38GET /groups/{id} (3.38); GET /groups/detail (3.38)
volume group showShow detailed information for a volume group.openstackclient/volume/v3/volume_group.py:478single5 (1)3.13, 3.25, 3.38GET /groups/{id} (3.38); GET /groups/detail (3.38)
volume group snapshot createCreate a volume group snapshot.openstackclient/volume/v3/volume_group_snapshot.py:56single3 (1)3.14GET /groups/{id} (3.38); GET /groups (3.38); POST /group_snapshots (3.29)
volume group snapshot deleteDelete a volume group snapshot.openstackclient/volume/v3/volume_group_snapshot.py:110none1 (1)3.14GET /group_snapshots/{id} (3.29); GET /group_snapshots (3.29); DELETE /group_snapshots/{id} (3.29)
volume group snapshot listLists all volume group snapshot.openstackclient/volume/v3/volume_group_snapshot.py:146list1 (0)3.14GET /group_snapshots/detail (3.29)
volume group snapshot showShow detailed information for a volume group snapshot.openstackclient/volume/v3/volume_group_snapshot.py:212single1 (1)3.14GET /group_snapshots/{id} (3.29); GET /group_snapshots/detail (3.29)
volume group type createCreate a volume group type.openstackclient/volume/v3/volume_group_type.py:59single4 (1)3.11POST /group_types (3.11)
volume group type deleteDelete a volume group type.openstackclient/volume/v3/volume_group_type.py:118none1 (1)3.11GET /group_types/{id} (3.11); GET /group_types (3.11); DELETE /group_types/{id} (3.11)
volume group type listLists all volume group types.openstackclient/volume/v3/volume_group_type.py:335list1 (0)3.11GET /group_types (3.11)
volume group type setUpdate a volume group type.openstackclient/volume/v3/volume_group_type.py:153single7 (1)3.11GET /group_types/{id} (3.11); GET /group_types (3.11)
volume group type showShow detailed information for a volume group type.openstackclient/volume/v3/volume_group_type.py:411single1 (1)3.11GET /group_types/{id} (3.11); GET /group_types (3.11)
volume host failoverFailover volume host to different backendopenstackclient/volume/v3/volume_host.py:25none2 (2)PUT /os-services/failover
volume host setSet volume host propertiesopenstackclient/volume/v3/volume_host.py:54none3 (1)
volume listList volumesopenstackclient/volume/v3/volume.py:597list11 (0)GET /volumes/detail (3.71)
volume message deleteDelete a volume failure messageopenstackclient/volume/v3/volume_message.py:63none1 (1)3.3DELETE /messages/{id}
volume message listList volume failure messagesopenstackclient/volume/v3/volume_message.py:106list4 (0)3.3GET /messages
volume message showShow a volume failure messageopenstackclient/volume/v3/volume_message.py:184single1 (1)3.3GET /messages/{id}
volume migrateMigrate volume to a new hostopenstackclient/volume/v3/volume.py:749none5 (1)3.16GET /volumes/{id} (3.71); GET /volumes/detail (3.71); POST /volumes/{id}/action (3.71)
volume qos associateAssociate a QoS specification to a volume typeopenstackclient/volume/v3/qos_specs.py:35none2 (2)GET /qos-specs/{id}; GET /qos-specs; GET /types/{id}
volume qos createCreate new QoS specificationopenstackclient/volume/v3/qos_specs.py:65single3 (1)POST /qos-specs
volume qos deleteDelete QoS specificationopenstackclient/volume/v3/qos_specs.py:123none2 (1)GET /qos-specs/{id}; GET /qos-specs; DELETE /qos-specs/{id}
volume qos disassociateDisassociate a QoS specification from a volume typeopenstackclient/volume/v3/qos_specs.py:172none3 (1)GET /qos-specs/{id}; GET /qos-specs
volume qos listList QoS specificationsopenstackclient/volume/v3/qos_specs.py:214list0 (0)GET /qos-specs
volume qos setSet QoS specification propertiesopenstackclient/volume/v3/qos_specs.py:250none3 (1)GET /qos-specs/{id}; GET /qos-specs
volume qos showDisplay QoS specification detailsopenstackclient/volume/v3/qos_specs.py:314single1 (1)GET /qos-specs/{id}; GET /qos-specs; GET /qos-specs/{id}/associations
volume qos unsetUnset QoS specification propertiesopenstackclient/volume/v3/qos_specs.py:363none2 (1)GET /qos-specs/{id}; GET /qos-specs
volume revertRevert a volume to a snapshot.openstackclient/volume/v3/volume.py:1298none1 (1)3.40GET /snapshots/{id} (3.65); GET /snapshots/detail (3.65)
volume service listList service commandopenstackclient/volume/v3/service.py:29list3 (0)3.7, 3.49GET /os-services (3.32)
volume service setSet volume service propertiesopenstackclient/volume/v3/service.py:101none5 (2)GET /os-services (3.32)
volume setSet volume propertiesopenstackclient/volume/v3/volume.py:820none17 (1)3.42GET /volumes/{id} (3.71); GET /volumes/detail (3.71)
volume showDisplay volume detailsopenstackclient/volume/v3/volume.py:1152single1 (1)GET /volumes/{id} (3.71); GET /volumes/detail (3.71)
volume snapshot createCreate new volume snapshotopenstackclient/volume/v3/volume_snapshot.py:104single6 (1)3.66GET /volumes/{id} (3.71); GET /volumes/detail (3.71); POST /snapshots (3.65)
volume snapshot deleteDelete volume snapshot(s)openstackclient/volume/v3/volume_snapshot.py:213none3 (1)GET /snapshots/{id} (3.65); GET /snapshots/detail (3.65); DELETE /snapshots/{id} (3.65)
volume snapshot listList volume snapshotsopenstackclient/volume/v3/volume_snapshot.py:286list10 (0)GET /volumes/detail (3.71); GET /snapshots/detail (3.65)
volume snapshot setSet volume snapshot propertiesopenstackclient/volume/v3/volume_snapshot.py:433none6 (1)GET /snapshots/{id} (3.65); GET /snapshots/detail (3.65)
volume snapshot showDisplay volume snapshot detailsopenstackclient/volume/v3/volume_snapshot.py:550single1 (1)GET /snapshots/{id} (3.65); GET /snapshots/detail (3.65)
volume snapshot unsetUnset volume snapshot propertiesopenstackclient/volume/v3/volume_snapshot.py:578none2 (1)GET /snapshots/{id} (3.65); GET /snapshots/detail (3.65)
volume summaryShow a summary of all volumes in this deployment.openstackclient/volume/v3/volume.py:1244single1 (0)3.12, 3.36GET /volumes/summary (3.36)
volume transfer request acceptAccept volume transfer request.openstackclient/volume/v3/volume_transfer_request.py:34single2 (2)GET /volume-transfers/{id} (3.55); GET /volume-transfers (3.55); POST /volume-transfers/{id}/accept (3.55)
volume transfer request createCreate volume transfer request.openstackclient/volume/v3/volume_transfer_request.py:75single4 (1)3.55GET /volumes/{id} (3.71); GET /volumes/detail (3.71); POST /volume-transfers (3.55)
volume transfer request deleteDelete volume transfer request(s).openstackclient/volume/v3/volume_transfer_request.py:150none1 (1)DELETE /volume-transfers/{id} (3.55)
volume transfer request listLists all volume transfer requests.openstackclient/volume/v3/volume_transfer_request.py:191list1 (0)GET /volume-transfers/detail (3.55)
volume transfer request showShow volume transfer request details.openstackclient/volume/v3/volume_transfer_request.py:224single1 (1)GET /volume-transfers/{id} (3.55); GET /volume-transfers (3.55)
volume type createCreate new volume typeopenstackclient/volume/v3/volume_type.py:167single15 (1)POST /types
volume type deleteDelete volume type(s)openstackclient/volume/v3/volume_type.py:391none1 (1)GET /types/{id}; GET /types; DELETE /types/{id}
volume type listList volume typesopenstackclient/volume/v3/volume_type.py:434list10 (0)3.52GET /types
volume type setSet volume type propertiesopenstackclient/volume/v3/volume_type.py:629none16 (1)GET /types/{id}; GET /types
volume type showDisplay volume type detailsopenstackclient/volume/v3/volume_type.py:865single2 (1)GET /types/{id}; GET /types
volume type unsetUnset volume type propertiesopenstackclient/volume/v3/volume_type.py:936none5 (1)GET /types/{id}; GET /types
volume unsetUnset volume propertiesopenstackclient/volume/v3/volume.py:1179none3 (1)GET /volumes/{id} (3.71); GET /volumes/detail (3.71)

Source: reverse-spec-python-openstackclient/01-cli-commands_stable-2026.2.md. The _rewrite/ and _inventory/ files are not published on the site.