This Page

Psst... hey. You're reading the latest content, but it might be out of sync with code. You can read Nova 2011.2 docs or all OpenStack docs too.

The nova.api.ec2.admin Module

Admin API controller, exposed through http via the api worker.

class nova.api.ec2.admin.AdminController

Bases: object

API Controller for users, hosts, nodes, and workers.

block_external_addresses(context, cidr)

Add provider-level firewall rules to block incoming traffic.

deregister_project(context, name)

Permanently deletes a project.

deregister_user(context, name, **_kwargs)

Deletes a single user (NOT undoable.) Should throw an exception if the user has instances, volumes, or buckets remaining.

describe_external_address_blocks(context)
describe_hosts(context, **_kwargs)

Returns status info for all nodes. Includes: * Hostname * Compute (up, down, None) * Instance count * Volume (up, down, None) * Volume Count

describe_instance_types(context, **_kwargs)

Returns all active instance types data (vcpus, memory, etc.)

describe_project(context, name, **kwargs)

Returns project data, including member ids.

describe_project_members(context, name, **kwargs)
describe_projects(context, user=None, **kwargs)

Returns all projects - should be changed to deal with a list.

describe_roles(context, project_roles=True, **kwargs)

Returns a list of allowed roles.

describe_user(_context, name, **_kwargs)

Returns user data, including access and secret keys.

describe_user_roles(context, user, project=None, **kwargs)

Returns a list of roles for the given user. Omitting project will return any global roles that the user has. Specifying project will return only project specific roles.

describe_users(_context, **_kwargs)

Returns all users - should be changed to deal with a list.

describe_vpns(context)
generate_x509_for_user(context, name, project=None, **kwargs)

Generates and returns an x509 certificate for a single user. Is usually called from a client that will wrap this with access and secret key info, and return a zip file.

modify_project(context, name, manager_user, description=None, **kwargs)

Modifies a project

modify_project_member(context, user, project, operation, **kwargs)

Add or remove a user from a project.

modify_user_role(context, user, role, project=None, operation='add', **kwargs)

Add or remove a role for a user and project.

register_project(context, name, manager_user, description=None, member_users=None, **kwargs)

Creates a new project

register_user(context, name, **_kwargs)

Creates a new user, and returns generated credentials.

remove_external_address_block(context, cidr)
start_vpn(context, project)
nova.api.ec2.admin.host_dict(host, compute_service, instances, volume_service, volumes, now)

Convert a host model object to a result dict

nova.api.ec2.admin.instance_dict(inst)
nova.api.ec2.admin.project_dict(project)

Convert the project object to a result dict

nova.api.ec2.admin.user_dict(user, base64_file=None)

Convert the user object to a result dict

nova.api.ec2.admin.vpn_dict(project, vpn_instance)