v2 Package

agent Module

Agent action implementations

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

Bases: cliff.show.ShowOne

Create compute agent command

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

Bases: cliff.command.Command

Delete compute agent command

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

Bases: cliff.lister.Lister

List compute agent command

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

Bases: cliff.show.ShowOne

Set compute agent command

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

aggregate Module

Compute v2 Aggregate action implementations

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

Bases: cliff.show.ShowOne

Add host to aggregate

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

Bases: cliff.show.ShowOne

Create a new aggregate

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

Bases: cliff.command.Command

Delete an existing aggregate

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

Bases: cliff.lister.Lister

List all aggregates

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

Bases: cliff.show.ShowOne

Remove host from aggregate

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

Bases: cliff.show.ShowOne

Set aggregate properties

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

Bases: cliff.show.ShowOne

Display aggregate details

get_parser(prog_name)
log = <logging.Logger object at 0x511de90>
take_action(*args, **kwargs)

availability_zone Module

Compute v2 Availability Zone action implementations

class openstackclient.compute.v2.availability_zone.ListAvailabilityZone(app, app_args, cmd_name=None)

Bases: cliff.lister.Lister

List availability zones and their status

get_parser(prog_name)
log = <logging.Logger object at 0x5481290>
take_action(*args, **kwargs)

console Module

Compute v2 Console action implementations

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

Bases: cliff.command.Command

Show server’s console output

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

Bases: cliff.show.ShowOne

Show server’s remote console URL

get_parser(prog_name)
log = <logging.Logger object at 0x54f1d10>
take_action(*args, **kwargs)

fixedip Module

Fixed IP action implementations

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

Bases: cliff.command.Command

Add fixed-ip command

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

Bases: cliff.command.Command

Remove fixed-ip command

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

flavor Module

Flavor action implementations

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

Bases: cliff.show.ShowOne

Create new flavor

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

Bases: cliff.command.Command

Delete flavor

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

Bases: cliff.lister.Lister

List flavors

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

Bases: cliff.show.ShowOne

Set flavor properties

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

Bases: cliff.show.ShowOne

Display flavor details

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

Bases: cliff.show.ShowOne

Unset flavor properties

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

floatingip Module

Floating IP action implementations

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

Bases: cliff.command.Command

Add floating-ip to server

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

Bases: cliff.show.ShowOne

Create new floating-ip

get_parser(prog_name)
log = <logging.Logger object at 0x5500bd0>
take_action(*args, **kwargs)
class openstackclient.compute.v2.floatingip.DeleteFloatingIP(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Delete a floating-ip

get_parser(prog_name)
log = <logging.Logger object at 0x5500710>
take_action(*args, **kwargs)
class openstackclient.compute.v2.floatingip.ListFloatingIP(app, app_args, cmd_name=None)

Bases: cliff.lister.Lister

List floating-ips

log = <logging.Logger object at 0x54f1650>
take_action(*args, **kwargs)
class openstackclient.compute.v2.floatingip.RemoveFloatingIP(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Remove floating-ip from server

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

floatingippool Module

Floating IP Pool action implementations

class openstackclient.compute.v2.floatingippool.ListFloatingIPPool(app, app_args, cmd_name=None)

Bases: cliff.lister.Lister

List floating-ip-pools

log = <logging.Logger object at 0x4973910>
take_action(*args, **kwargs)

host Module

Host action implementations

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

Bases: cliff.lister.Lister

List host command

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

Bases: cliff.lister.Lister

Show host command

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

hypervisor Module

Hypervisor action implementations

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

Bases: cliff.lister.Lister

List hypervisors

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

Bases: cliff.show.ShowOne

Display hypervisor details

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

hypervisor_stats Module

Hypervisor Stats action implementations

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

Bases: cliff.show.ShowOne

Display hypervisor stats details

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

keypair Module

Keypair action implementations

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

Bases: cliff.show.ShowOne

Create new public key

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

Bases: cliff.command.Command

Delete public key

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

Bases: cliff.lister.Lister

List public key fingerprints

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

Bases: cliff.show.ShowOne

Display public key details

get_parser(prog_name)
log = <logging.Logger object at 0x3ec0690>
take_action(*args, **kwargs)

security_group Module

Compute v2 Security Group action implementations

class openstackclient.compute.v2.security_group.CreateSecurityGroup(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Create a new security group

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

Bases: cliff.show.ShowOne

Create a new security group rule

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

Bases: cliff.command.Command

Delete a security group

get_parser(prog_name)
log = <logging.Logger object at 0x59925d0>
take_action(*args, **kwargs)
class openstackclient.compute.v2.security_group.DeleteSecurityGroupRule(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Delete a security group rule

get_parser(prog_name)
log = <logging.Logger object at 0x5992ad0>
take_action(*args, **kwargs)
class openstackclient.compute.v2.security_group.ListSecurityGroup(app, app_args, cmd_name=None)

Bases: cliff.lister.Lister

List all security groups

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

Bases: cliff.lister.Lister

List all security group rules

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

Bases: cliff.show.ShowOne

Set security group properties

get_parser(prog_name)
log = <logging.Logger object at 0x59927d0>
take_action(*args, **kwargs)
class openstackclient.compute.v2.security_group.ShowSecurityGroup(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Show a specific security group

get_parser(prog_name)
log = <logging.Logger object at 0x59928d0>
take_action(*args, **kwargs)

server Module

Compute v2 Server action implementations

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

Bases: cliff.command.Command

Add security group to server

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

Bases: cliff.command.Command

Add volume to server

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

Bases: cliff.show.ShowOne

Create a new server

get_parser(prog_name)
log = <logging.Logger object at 0x5ad2b50>
take_action(*args, **kwargs)
class openstackclient.compute.v2.server.CreateServerImage(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Create a new disk image from a running server

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

Bases: cliff.command.Command

Delete server(s)

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

Bases: cliff.lister.Lister

List servers

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

Bases: cliff.command.Command

Lock a server. A non-admin user will not be able to execute actions

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

Bases: cliff.command.Command

Migrate server to different host

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

Bases: cliff.command.Command

Pause server

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

Bases: cliff.command.Command

Perform a hard or soft server reboot

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

Bases: cliff.show.ShowOne

Rebuild server

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

Bases: cliff.command.Command

Remove security group from server

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

Bases: cliff.command.Command

Remove volume from server

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

Bases: cliff.show.ShowOne

Put server in rescue mode

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

Bases: cliff.command.Command

Scale server to a new flavor

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

Bases: cliff.command.Command

Resume server

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

Bases: cliff.command.Command

Set server properties

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

Bases: cliff.show.ShowOne

Show server details

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

Bases: cliff.command.Command

Ssh to server

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

Bases: cliff.command.Command

Suspend server

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

Bases: cliff.command.Command

Unlock server

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

Bases: cliff.command.Command

Unpause server

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

Bases: cliff.command.Command

Restore server from rescue mode

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

Bases: cliff.command.Command

Unset server properties

get_parser(prog_name)
log = <logging.Logger object at 0x5b04a10>
take_action(*args, **kwargs)

service Module

Service action implementations

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

Bases: cliff.lister.Lister

List service command

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

Bases: cliff.lister.Lister

Set service command

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

usage Module

Usage action implementations

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

Bases: openstackclient.compute.v2.usage.ListUsage

List resource usage per project

deprecated = True
log = <logging.Logger object at 0x63cf3d0>
take_action(parsed_args)
class openstackclient.compute.v2.usage.ListUsage(app, app_args, cmd_name=None)

Bases: cliff.lister.Lister

List resource usage per project

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

Bases: cliff.show.ShowOne

Show resource usage for a single project

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