openstackclient.compute.v2 package

Submodules

openstackclient.compute.v2.agent module

Agent action implementations

class openstackclient.compute.v2.agent.CreateAgent(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.ShowOne

Create compute agent

get_parser(prog_name)
log = <logging.Logger object at 0xffffb3d886d0>
take_action(parsed_args)
class openstackclient.compute.v2.agent.DeleteAgent(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Delete compute agent(s)

get_parser(prog_name)
log = <logging.Logger object at 0xffffb3d880d0>
take_action(parsed_args)
class openstackclient.compute.v2.agent.ListAgent(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Lister

List compute agents

get_parser(prog_name)
log = <logging.Logger object at 0xffffb3d88490>
take_action(parsed_args)
class openstackclient.compute.v2.agent.SetAgent(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Set compute agent properties

get_parser(prog_name)
log = <logging.Logger object at 0xffffb3d64050>
take_action(parsed_args)

openstackclient.compute.v2.aggregate module

Compute v2 Aggregate action implementations

class openstackclient.compute.v2.aggregate.AddAggregateHost(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.ShowOne

Add host to aggregate

get_parser(prog_name)
log = <logging.Logger object at 0xffffb3d64b90>
take_action(parsed_args)
class openstackclient.compute.v2.aggregate.CreateAggregate(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.ShowOne

Create a new aggregate

get_parser(prog_name)
log = <logging.Logger object at 0xffffb3d64d10>
take_action(parsed_args)
class openstackclient.compute.v2.aggregate.DeleteAggregate(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Delete existing aggregate(s)

get_parser(prog_name)
log = <logging.Logger object at 0xffffb3d64dd0>
take_action(parsed_args)
class openstackclient.compute.v2.aggregate.ListAggregate(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Lister

List all aggregates

get_parser(prog_name)
log = <logging.Logger object at 0xffffb3d64850>
take_action(parsed_args)
class openstackclient.compute.v2.aggregate.RemoveAggregateHost(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.ShowOne

Remove host from aggregate

get_parser(prog_name)
log = <logging.Logger object at 0xffffb3d64810>
take_action(parsed_args)
class openstackclient.compute.v2.aggregate.SetAggregate(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Set aggregate properties

get_parser(prog_name)
log = <logging.Logger object at 0xffffb3daaf50>
take_action(parsed_args)
class openstackclient.compute.v2.aggregate.ShowAggregate(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.ShowOne

Display aggregate details

get_parser(prog_name)
log = <logging.Logger object at 0xffffb3daaa90>
take_action(parsed_args)
class openstackclient.compute.v2.aggregate.UnsetAggregate(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Unset aggregate properties

get_parser(prog_name)
log = <logging.Logger object at 0xffffb3daa910>
take_action(parsed_args)

openstackclient.compute.v2.console module

Compute v2 Console action implementations

class openstackclient.compute.v2.console.ShowConsoleLog(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Show server’s console output

get_parser(prog_name)
log = <logging.Logger object at 0xffffb319e8d0>
take_action(parsed_args)
class openstackclient.compute.v2.console.ShowConsoleURL(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.ShowOne

Show server’s remote console URL

get_parser(prog_name)
log = <logging.Logger object at 0xffffb319ea50>
take_action(parsed_args)

openstackclient.compute.v2.fixedip module

Fixed IP action implementations

class openstackclient.compute.v2.fixedip.AddFixedIP(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Add fixed IP address to server

deprecated = True
get_parser(prog_name)
log = <logging.Logger object at 0xffffb3130c10>
take_action(parsed_args)
class openstackclient.compute.v2.fixedip.RemoveFixedIP(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Remove fixed IP address from server

deprecated = True
get_parser(prog_name)
log = <logging.Logger object at 0xffffb3130c10>
take_action(parsed_args)

openstackclient.compute.v2.flavor module

Flavor action implementations

class openstackclient.compute.v2.flavor.CreateFlavor(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.ShowOne

Create new flavor

get_parser(prog_name)
log = <logging.Logger object at 0xffffb3173590>
take_action(parsed_args)
class openstackclient.compute.v2.flavor.DeleteFlavor(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Delete flavor(s)

get_parser(prog_name)
log = <logging.Logger object at 0xffffb3173650>
take_action(parsed_args)
class openstackclient.compute.v2.flavor.ListFlavor(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Lister

List flavors

get_parser(prog_name)
log = <logging.Logger object at 0xffffb3173850>
take_action(parsed_args)
class openstackclient.compute.v2.flavor.SetFlavor(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Set flavor properties

get_parser(prog_name)
log = <logging.Logger object at 0xffffb3173a10>
take_action(parsed_args)
class openstackclient.compute.v2.flavor.ShowFlavor(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.ShowOne

Display flavor details

get_parser(prog_name)
log = <logging.Logger object at 0xffffb3173c10>
take_action(parsed_args)
class openstackclient.compute.v2.flavor.UnsetFlavor(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Unset flavor properties

get_parser(prog_name)
log = <logging.Logger object at 0xffffb3173e10>
take_action(parsed_args)

openstackclient.compute.v2.floatingip module

Floating IP action implementations

class openstackclient.compute.v2.floatingip.AddFloatingIP(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Add floating IP address to server

deprecated = True
get_parser(prog_name)
log = <logging.Logger object at 0xffffb3130c10>
take_action(parsed_args)
class openstackclient.compute.v2.floatingip.RemoveFloatingIP(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Remove floating IP address from server

deprecated = True
get_parser(prog_name)
log = <logging.Logger object at 0xffffb3130c10>
take_action(parsed_args)

openstackclient.compute.v2.host module

Host action implementations

class openstackclient.compute.v2.host.ListHost(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Lister

List hosts

get_parser(prog_name)
log = <logging.Logger object at 0xffffb373b3d0>
take_action(parsed_args)
class openstackclient.compute.v2.host.SetHost(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Set host properties

get_parser(prog_name)
log = <logging.Logger object at 0xffffb373b8d0>
take_action(parsed_args)
class openstackclient.compute.v2.host.ShowHost(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Lister

Display host details

get_parser(prog_name)
log = <logging.Logger object at 0xffffb3a2c890>
take_action(parsed_args)

openstackclient.compute.v2.hypervisor module

Hypervisor action implementations

class openstackclient.compute.v2.hypervisor.ListHypervisor(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Lister

List hypervisors

get_parser(prog_name)
log = <logging.Logger object at 0xffffb354fd90>
take_action(parsed_args)
class openstackclient.compute.v2.hypervisor.ShowHypervisor(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.ShowOne

Display hypervisor details

get_parser(prog_name)
log = <logging.Logger object at 0xffffb354f810>
take_action(parsed_args)

openstackclient.compute.v2.hypervisor_stats module

Hypervisor Stats action implementations

class openstackclient.compute.v2.hypervisor_stats.ShowHypervisorStats(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.ShowOne

Display hypervisor stats details

log = <logging.Logger object at 0xffffb39b9f90>
take_action(parsed_args)

openstackclient.compute.v2.keypair module

Keypair action implementations

class openstackclient.compute.v2.keypair.CreateKeypair(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.ShowOne

Create new public key

get_parser(prog_name)
log = <logging.Logger object at 0xffffb34c6110>
take_action(parsed_args)
class openstackclient.compute.v2.keypair.DeleteKeypair(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Delete public key(s)

get_parser(prog_name)
log = <logging.Logger object at 0xffffb34c6210>
take_action(parsed_args)
class openstackclient.compute.v2.keypair.ListKeypair(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Lister

List public key fingerprints

log = <logging.Logger object at 0xffffb34c6350>
take_action(parsed_args)
class openstackclient.compute.v2.keypair.ShowKeypair(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.ShowOne

Display public key details

get_parser(prog_name)
log = <logging.Logger object at 0xffffb34c6fd0>
take_action(parsed_args)

openstackclient.compute.v2.server module

Compute v2 Server action implementations

class openstackclient.compute.v2.server.AddFixedIP(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Add fixed IP address to server

get_parser(prog_name)
log = <logging.Logger object at 0xffffb319ef50>
take_action(parsed_args)
class openstackclient.compute.v2.server.AddFloatingIP(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Add floating IP address to server

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f49590>
take_action(parsed_args)
class openstackclient.compute.v2.server.AddServerSecurityGroup(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Add security group to server

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f49690>
take_action(parsed_args)
class openstackclient.compute.v2.server.AddServerVolume(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Add volume to server

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f49790>
take_action(parsed_args)
class openstackclient.compute.v2.server.CreateServer(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.ShowOne

Create a new server

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f49890>
take_action(parsed_args)
class openstackclient.compute.v2.server.CreateServerDump(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Create a dump file in server(s)

Trigger crash dump in server(s) with features like kdump in Linux. It will create a dump file in the server(s) dumping the server(s)’ memory, and also crash the server(s). OSC sees the dump file (server dump) as a kind of resource.

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f49990>
take_action(parsed_args)
class openstackclient.compute.v2.server.DeleteServer(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Delete server(s)

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f49a90>
take_action(parsed_args)
class openstackclient.compute.v2.server.ListServer(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Lister

List servers

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f49b90>
take_action(parsed_args)
class openstackclient.compute.v2.server.LockServer(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Lock server(s). A non-admin user will not be able to execute actions

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f49c90>
take_action(parsed_args)
class openstackclient.compute.v2.server.MigrateServer(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Migrate server to different host

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f49d90>
take_action(parsed_args)
class openstackclient.compute.v2.server.PauseServer(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Pause server(s)

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f49f50>
take_action(parsed_args)
class openstackclient.compute.v2.server.RebootServer(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Perform a hard or soft server reboot

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f2b190>
take_action(parsed_args)
class openstackclient.compute.v2.server.RebuildServer(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.ShowOne

Rebuild server

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f2b390>
take_action(parsed_args)
class openstackclient.compute.v2.server.RemoveFixedIP(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Remove fixed IP address from server

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f2b590>
take_action(parsed_args)
class openstackclient.compute.v2.server.RemoveFloatingIP(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Remove floating IP address from server

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f2b790>
take_action(parsed_args)
class openstackclient.compute.v2.server.RemoveServerSecurityGroup(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Remove security group from server

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f2b990>
take_action(parsed_args)
class openstackclient.compute.v2.server.RemoveServerVolume(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Remove volume from server

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f2bb90>
take_action(parsed_args)
class openstackclient.compute.v2.server.RescueServer(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.ShowOne

Put server in rescue mode

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f2bd90>
take_action(parsed_args)
class openstackclient.compute.v2.server.ResizeServer(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Scale server to a new flavor

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f2bf90>
take_action(parsed_args)
class openstackclient.compute.v2.server.RestoreServer(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Restore server(s)

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f2f1d0>
take_action(parsed_args)
class openstackclient.compute.v2.server.ResumeServer(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Resume server(s)

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f2f3d0>
take_action(parsed_args)
class openstackclient.compute.v2.server.SetServer(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Set server properties

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f2f5d0>
take_action(parsed_args)
class openstackclient.compute.v2.server.ShelveServer(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Shelve server(s)

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f2f7d0>
take_action(parsed_args)
class openstackclient.compute.v2.server.ShowServer(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.ShowOne

Show server details

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f2f9d0>
take_action(parsed_args)
class openstackclient.compute.v2.server.SshServer(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

SSH to server

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f2fbd0>
take_action(parsed_args)
class openstackclient.compute.v2.server.StartServer(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Start server(s).

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f2fdd0>
take_action(parsed_args)
class openstackclient.compute.v2.server.StopServer(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Stop server(s).

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f2ffd0>
take_action(parsed_args)
class openstackclient.compute.v2.server.SuspendServer(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Suspend server(s)

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f17210>
take_action(parsed_args)
class openstackclient.compute.v2.server.UnlockServer(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Unlock server(s)

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f17410>
take_action(parsed_args)
class openstackclient.compute.v2.server.UnpauseServer(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Unpause server(s)

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f17610>
take_action(parsed_args)
class openstackclient.compute.v2.server.UnrescueServer(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Restore server from rescue mode

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f17810>
take_action(parsed_args)
class openstackclient.compute.v2.server.UnsetServer(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Unset server properties

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f17a10>
take_action(parsed_args)
class openstackclient.compute.v2.server.UnshelveServer(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Unshelve server(s)

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2f17c10>
take_action(parsed_args)

openstackclient.compute.v2.server_backup module

Compute v2 Server action implementations

class openstackclient.compute.v2.server_backup.CreateServerBackup(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.ShowOne

Create a server backup image

IMAGE_API_VERSIONS = {'1': 'openstackclient.image.v1.image', '2': 'openstackclient.image.v2.image'}
get_parser(prog_name)
log = <logging.Logger object at 0xffffb2551a10>
take_action(parsed_args)

openstackclient.compute.v2.server_group module

Compute v2 Server Group action implementations

class openstackclient.compute.v2.server_group.CreateServerGroup(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.ShowOne

Create a new server group.

get_parser(prog_name)
log = <logging.Logger object at 0xffffb264d4d0>
take_action(parsed_args)
class openstackclient.compute.v2.server_group.DeleteServerGroup(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Delete existing server group(s).

get_parser(prog_name)
log = <logging.Logger object at 0xffffb252be50>
take_action(parsed_args)
class openstackclient.compute.v2.server_group.ListServerGroup(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Lister

List all server groups.

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2551190>
take_action(parsed_args)
class openstackclient.compute.v2.server_group.ShowServerGroup(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.ShowOne

Display server group details.

get_parser(prog_name)
log = <logging.Logger object at 0xffffb254eb90>
take_action(parsed_args)

openstackclient.compute.v2.server_image module

Compute v2 Server action implementations

class openstackclient.compute.v2.server_image.CreateServerImage(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.ShowOne

Create a new server disk image from an existing server

IMAGE_API_VERSIONS = {'1': 'openstackclient.image.v1.image', '2': 'openstackclient.image.v2.image'}
get_parser(prog_name)
log = <logging.Logger object at 0xffffb24a3bd0>
take_action(parsed_args)

openstackclient.compute.v2.service module

Service action implementations

class openstackclient.compute.v2.service.DeleteService(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Delete compute service(s)

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2440f50>
take_action(parsed_args)
class openstackclient.compute.v2.service.ListService(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Lister

List compute services

get_parser(prog_name)
log = <logging.Logger object at 0xffffb2440210>
take_action(parsed_args)
class openstackclient.compute.v2.service.SetService(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Set compute service properties

get_parser(prog_name)
log = <logging.Logger object at 0xffffb24404d0>
take_action(parsed_args)

openstackclient.compute.v2.usage module

Usage action implementations

class openstackclient.compute.v2.usage.ListUsage(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Lister

List resource usage per project

get_parser(prog_name)
log = <logging.Logger object at 0xffffb23cf1d0>
take_action(parsed_args)
class openstackclient.compute.v2.usage.ShowUsage(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.ShowOne

Show resource usage for a single project

get_parser(prog_name)
log = <logging.Logger object at 0xffffb23cf650>
take_action(parsed_args)

Module contents