# novaclient.v2.shell module

class novaclient.v2.shell.Console(console_dict)

  Bases: `object`

class novaclient.v2.shell.EvacuateHostResponse(manager, info, loaded=False, resp=None)

  Bases: `Resource`

  Populate and bind to a manager.

  Parameters:

    - manager – BaseManager object

    - info – dictionary representing resource attributes

    - loaded – prevent lazy-loading if set to True

    - resp – Response or list of Response objects

class novaclient.v2.shell.HostServersMigrateResponse(manager, info, loaded=False, resp=None)

  Bases: `Resource`

  Populate and bind to a manager.

  Parameters:

    - manager – BaseManager object

    - info – dictionary representing resource attributes

    - loaded – prevent lazy-loading if set to True

    - resp – Response or list of Response objects

novaclient.v2.shell.console_dict_accessor(cs, data)

novaclient.v2.shell.do_add_secgroup(cs, args)

  Add a Security Group to a server.

novaclient.v2.shell.do_agent_create(cs, args)

  DEPRECATED Create new agent build.

novaclient.v2.shell.do_agent_delete(cs, args)

  DEPRECATED Delete existing agent build.

novaclient.v2.shell.do_agent_list(cs, args)

  DEPRECATED List all builds.

novaclient.v2.shell.do_agent_modify(cs, args)

  DEPRECATED Modify existing agent build.

novaclient.v2.shell.do_aggregate_add_host(cs, args)

  Add the host to the specified aggregate.

novaclient.v2.shell.do_aggregate_cache_images(cs, args)

  Request images be cached.

novaclient.v2.shell.do_aggregate_create(cs, args)

  Create a new aggregate with the specified details.

novaclient.v2.shell.do_aggregate_delete(cs, args)

  Delete the aggregate.

novaclient.v2.shell.do_aggregate_list(cs, args)

  Print a list of all aggregates.

novaclient.v2.shell.do_aggregate_remove_host(cs, args)

  Remove the specified host from the specified aggregate.

novaclient.v2.shell.do_aggregate_set_metadata(cs, args)

  Update the metadata associated with the aggregate.

novaclient.v2.shell.do_aggregate_show(cs, args)

  Show details of the specified aggregate.

novaclient.v2.shell.do_aggregate_update(cs, args)

  Update the aggregate’s name and optionally availability zone.

novaclient.v2.shell.do_availability_zone_list(cs, _args)

  List all the availability zones.

novaclient.v2.shell.do_backup(cs, args)

  Backup a server by creating a ‘backup’ type snapshot.

novaclient.v2.shell.do_boot(cs, args)

  Boot a new server.

novaclient.v2.shell.do_clear_password(cs, args)

  Clear the admin password for a server from the metadata server. This action does not actually change the instance server password.

novaclient.v2.shell.do_console_log(cs, args)

  Get console log output of a server.

novaclient.v2.shell.do_delete(cs, args)

  Immediately shut down and delete specified server(s).

novaclient.v2.shell.do_diagnostics(cs, args)

  Retrieve server diagnostics.

novaclient.v2.shell.do_evacuate(cs, args)

  Evacuate server from failed host.

novaclient.v2.shell.do_flavor_access_add(cs, args)

  Add flavor access for the given tenant.

novaclient.v2.shell.do_flavor_access_list(cs, args)

  Print access information about the given flavor.

novaclient.v2.shell.do_flavor_access_remove(cs, args)

  Remove flavor access for the given tenant.

novaclient.v2.shell.do_flavor_create(cs, args)

  Create a new flavor.

novaclient.v2.shell.do_flavor_delete(cs, args)

  Delete a specific flavor

novaclient.v2.shell.do_flavor_key(cs, args)

  Set or unset extra_spec for a flavor.

novaclient.v2.shell.do_flavor_list(cs, args)

  Print a list of available ‘flavors’ (sizes of servers).

novaclient.v2.shell.do_flavor_show(cs, args)

  Show details about the given flavor.

novaclient.v2.shell.do_flavor_update(cs, args)

  Update the description of an existing flavor.

novaclient.v2.shell.do_force_delete(cs, args)

  Force delete a server.

novaclient.v2.shell.do_get_mks_console(cs, args)

  Get an MKS console to a server.

novaclient.v2.shell.do_get_password(cs, args)

  Get the admin password for a server. This operation calls the metadata service to query metadata information and does not read password information from the server itself.

novaclient.v2.shell.do_get_rdp_console(cs, args)

  Get a rdp console to a server.

novaclient.v2.shell.do_get_serial_console(cs, args)

  Get a serial console to a server.

novaclient.v2.shell.do_get_spice_console(cs, args)

  Get a spice console to a server.

novaclient.v2.shell.do_get_vnc_console(cs, args)

  Get a vnc console to a server.

novaclient.v2.shell.do_host_evacuate(cs, args)

  Evacuate all instances from failed host.

novaclient.v2.shell.do_host_evacuate_live(cs, args)

  Live migrate all instances off the specified host to other available hosts.

novaclient.v2.shell.do_host_meta(cs, args)

  Set or Delete metadata on all instances of a host.

novaclient.v2.shell.do_host_servers_migrate(cs, args)

  Cold migrate all instances off the specified host to other available hosts.

novaclient.v2.shell.do_hypervisor_list(cs, args)

  List hypervisors.

novaclient.v2.shell.do_hypervisor_servers(cs, args)

  List servers belonging to specific hypervisors.

novaclient.v2.shell.do_hypervisor_show(cs, args)

  Display the details of the specified hypervisor.

novaclient.v2.shell.do_hypervisor_stats(cs, args)

novaclient.v2.shell.do_hypervisor_uptime(cs, args)

  Display the uptime of the specified hypervisor.

novaclient.v2.shell.do_image_create(cs, args)

  Create a new image by taking a snapshot of a running server.

novaclient.v2.shell.do_instance_action(cs, args)

  Show an action.

novaclient.v2.shell.do_instance_action_list(cs, args)

  List actions on a server.

novaclient.v2.shell.do_instance_usage_audit_log(cs, args)

  List/Get server usage audits.

novaclient.v2.shell.do_interface_attach(cs, args)

  Attach a network interface to a server.

novaclient.v2.shell.do_interface_detach(cs, args)

  Detach a network interface from a server.

novaclient.v2.shell.do_interface_list(cs, args)

  List interfaces attached to a server.

novaclient.v2.shell.do_keypair_add(cs, args)

  Create a new key pair for use with servers.

novaclient.v2.shell.do_keypair_delete(cs, args)

  Delete keypair given by its name.

novaclient.v2.shell.do_keypair_list(cs, args)

  Print a list of keypairs for a user

novaclient.v2.shell.do_keypair_show(cs, args)

  Show details about the given keypair.

novaclient.v2.shell.do_limits(cs, args)

  Print rate and absolute limits.

novaclient.v2.shell.do_list(cs, args)

  List servers.

novaclient.v2.shell.do_list_secgroup(cs, args)

  List Security Group(s) of a server.

novaclient.v2.shell.do_live_migration(cs, args)

  Migrate running server to a new machine.

novaclient.v2.shell.do_live_migration_abort(cs, args)

  Abort an on-going live migration.

novaclient.v2.shell.do_live_migration_force_complete(cs, args)

  Force on-going live migration to complete.

novaclient.v2.shell.do_lock(cs, args)

  Lock a server. A normal (non-admin) user will not be able to execute actions on a locked server.

novaclient.v2.shell.do_meta(cs, args)

  Set or delete metadata on a server.

novaclient.v2.shell.do_migrate(cs, args)

  Migrate a server.

novaclient.v2.shell.do_migration_list(cs, args)

  Print a list of migrations.

novaclient.v2.shell.do_pause(cs, args)

  Pause a server.

novaclient.v2.shell.do_quota_class_show(cs, args)

  List the quotas for a quota class.

novaclient.v2.shell.do_quota_class_update(cs, args)

  Update the quotas for a quota class.

novaclient.v2.shell.do_quota_defaults(cs, args)

  List the default quotas for a tenant.

novaclient.v2.shell.do_quota_delete(cs, args)

  Delete quota for a tenant/user so their quota will Revert back to default.

novaclient.v2.shell.do_quota_show(cs, args)

  List the quotas for a tenant/user.

novaclient.v2.shell.do_quota_update(cs, args)

  Update the quotas for a tenant/user.

novaclient.v2.shell.do_reboot(cs, args)

  Reboot a server.

novaclient.v2.shell.do_rebuild(cs, args)

  Shutdown, re-image, and re-boot a server.

novaclient.v2.shell.do_refresh_network(cs, args)

  Refresh server network information.

novaclient.v2.shell.do_remove_secgroup(cs, args)

  Remove a Security Group from a server.

novaclient.v2.shell.do_rescue(cs, args)

  Reboots a server into rescue mode, which starts the machine from either the initial image or a specified image, attaching the current boot disk as secondary.

novaclient.v2.shell.do_reset_network(cs, args)

  Reset network of a server.

novaclient.v2.shell.do_reset_state(cs, args)

  Reset the state of a server.

novaclient.v2.shell.do_resize(cs, args)

  Resize a server.

novaclient.v2.shell.do_resize_confirm(cs, args)

  Confirm a previous resize.

novaclient.v2.shell.do_resize_revert(cs, args)

  Revert a previous resize (and return to the previous VM).

novaclient.v2.shell.do_restore(cs, args)

  Restore a soft-deleted server.

novaclient.v2.shell.do_resume(cs, args)

  Resume a server.

novaclient.v2.shell.do_server_group_create(cs, args)

  Create a new server group with the specified details.

novaclient.v2.shell.do_server_group_delete(cs, args)

  Delete specific server group(s).

novaclient.v2.shell.do_server_group_get(cs, args)

  Get a specific server group.

novaclient.v2.shell.do_server_group_list(cs, args)

  Print a list of all server groups.

novaclient.v2.shell.do_server_migration_list(cs, args)

  Get the migrations list of specified server.

novaclient.v2.shell.do_server_migration_show(cs, args)

  Get the migration of specified server.

novaclient.v2.shell.do_server_tag_add(cs, args)

  Add one or more tags to a server.

novaclient.v2.shell.do_server_tag_delete(cs, args)

  Delete one or more tags from a server.

novaclient.v2.shell.do_server_tag_delete_all(cs, args)

  Delete all tags from a server.

novaclient.v2.shell.do_server_tag_list(cs, args)

  Get list of tags from a server.

novaclient.v2.shell.do_server_tag_set(cs, args)

  Set list of tags to a server.

novaclient.v2.shell.do_server_topology(cs, args)

  Retrieve server topology.

novaclient.v2.shell.do_service_delete(cs, args)

  Delete the service by UUID ID.

  If deleting a nova-compute service, be sure to stop the actual nova-compute process on the physical host before deleting the service with this command. Failing to do so can lead to the running service re-creating orphaned compute_nodes table records in the database.

novaclient.v2.shell.do_service_disable(cs, args)

  Disable the service.

novaclient.v2.shell.do_service_enable(cs, args)

  Enable the service.

novaclient.v2.shell.do_service_force_down(cs, args)

  Force service to down.

novaclient.v2.shell.do_service_list(cs, args)

  Show a list of all running services. Filter by host & binary.

novaclient.v2.shell.do_set_password(cs, args)

  Change the admin password for a server.

novaclient.v2.shell.do_shelve(cs, args)

  Shelve a server.

novaclient.v2.shell.do_shelve_offload(cs, args)

  Remove a shelved server from the compute node.

novaclient.v2.shell.do_show(cs, args)

  Show details about the given server.

novaclient.v2.shell.do_ssh(cs, args)

  SSH into a server.

novaclient.v2.shell.do_start(cs, args)

  Start the server(s).

novaclient.v2.shell.do_stop(cs, args)

  Stop the server(s).

novaclient.v2.shell.do_suspend(cs, args)

  Suspend a server.

novaclient.v2.shell.do_trigger_crash_dump(cs, args)

  Trigger crash dump in an instance.

novaclient.v2.shell.do_unlock(cs, args)

  Unlock a server.

novaclient.v2.shell.do_unpause(cs, args)

  Unpause a server.

novaclient.v2.shell.do_unrescue(cs, args)

  Restart the server from normal boot disk again.

novaclient.v2.shell.do_unshelve(cs, args)

  Unshelve a server.

novaclient.v2.shell.do_update(cs, args)

  Update the name or the description for a server.

novaclient.v2.shell.do_usage(cs, args)

  Show usage data for a single tenant.

novaclient.v2.shell.do_usage_list(cs, args)

  List usage data for all tenants.

novaclient.v2.shell.do_version_list(cs, args)

  List all API versions.

novaclient.v2.shell.do_volume_attach(cs, args)

  Attach a volume to a server.

novaclient.v2.shell.do_volume_attachments(cs, args)

  List all the volumes attached to a server.

novaclient.v2.shell.do_volume_detach(cs, args)

  Detach a volume from a server.

novaclient.v2.shell.do_volume_update(cs, args)

  Update the attachment on the server.

  If dest_volume is the same as the src_volume then the command migrates the data from the attached volume to the specified available volume and swaps out the active attachment to the new volume. Otherwise it only updates the parameters of the existing attachment.

novaclient.v2.shell.emit_duplicated_image_with_warning(img, image_with)

novaclient.v2.shell.print_console(cs, data)

this page last updated: 2026-07-15 14:18:20

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug