Module Expr Str ImportFrom alias Import alias Import alias identifier Assign NameStore Call AttributeLoad NameLoad attr NameLoad Assign NameStore Dict Str Str Assign NameStore Str FunctionDef arguments args defaults body Expr Str If Call AttributeLoad NameLoad attr body Return NameLoad Return TupleLoad NameLoad Str decorator_list Assign NameStore Dict FunctionDef arguments args NameParam defaults NameLoad body Expr Str If NameLoad body Assign NameStore Call SubscriptLoad NameLoad Index Str NameLoad Assign NameStore SubscriptLoad NameLoad Index Str Assign NameStore SubscriptLoad NameLoad Index Str Assign NameStore SubscriptLoad NameLoad Index Str Assign NameStore SubscriptLoad NameLoad Index Str Assign NameStore Call AttributeLoad NameLoad attr Str NameLoad Assign NameStore Call AttributeLoad NameLoad attr Str NameLoad Assign NameStore Call AttributeLoad NameLoad attr Str NameLoad orelse Assign NameStore Call SubscriptLoad NameLoad Index Str Str Assign NameStore Call SubscriptLoad NameLoad Index Str Str Assign NameStore Call SubscriptLoad NameLoad Index Str Str Assign NameStore Call SubscriptLoad NameLoad Index Str Str Assign NameStore Call SubscriptLoad NameLoad Index Str Str Assign NameStore Call SubscriptLoad NameLoad Index Str Str Assign NameStore Call SubscriptLoad NameLoad Index Str Str Assign NameStore Dict Str Str Str Str Str Str Str NameLoad NameLoad NameLoad NameLoad NameLoad NameLoad NameLoad Return Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam defaults Num Num NameLoad Num body Expr Str Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr NameLoad NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad NameLoad body Expr Str Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr keyword NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad body Expr Str Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam defaults Num NameLoad NameLoad NameLoad body Expr Str Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr NameLoad NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad body Expr Str Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad Num body Expr Str Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam defaults Str NameLoad Num body Expr Str Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr NameLoad NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad body Expr Str Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad body Expr Str Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad body Expr Str Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad body Expr Str Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults NameLoad body Expr Str Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam defaults Num Num Num Num NameLoad body Expr Str Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr NameLoad NameLoad NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad body Expr Str Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults NameLoad body Expr Str Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad NameLoad NameLoad body Expr Str Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad body Expr Str Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad NameLoad body Expr Str Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad NameLoad NameLoad kwarg body Expr Str Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad NameLoad NameLoad NameLoad body Expr Str Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults NameLoad body Expr Str Return Call NameLoad keyword NameLoad decorator_list FunctionDef arguments args NameParam defaults NameLoad body Expr Str Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad body Expr Str Return Call NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults NameLoad body Expr Str Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad body Expr Str Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad body Expr Str Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad body Expr Str Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults NameLoad body Expr Str Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad body Expr Str Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr NameLoad decorator_list
N/A N/A 
Module for handling OpenStack Nova calls

:depends:   - novaclient Python module
:configuration: This module is not usable until the user, password, tenant, and
    auth URL are specified either in a pillar or in the minion's config file.
    For example::

        keystone.user: admin
        keystone.password: verybadpass
        keystone.tenant: admin
        keystone.auth_url: 'http://127.0.0.1:5000/v2.0/'
        # Optional
        keystone.region_name: 'RegionOne'

    If configuration for multiple OpenStack accounts is required, they can be
    set up as different configuration profiles:
    For example::

        openstack1:
          keystone.user: admin
          keystone.password: verybadpass
          keystone.tenant: admin
          keystone.auth_url: 'http://127.0.0.1:5000/v2.0/'

        openstack2:
          keystone.user: admin
          keystone.password: verybadpass
          keystone.tenant: admin
          keystone.auth_url: 'http://127.0.0.2:5000/v2.0/'

    With this configuration in place, any of the nova functions can make use of
    a configuration profile by declaring it explicitly.
    For example::

        salt '*' nova.flavor_list profile=openstack1
 __future__ absolute_import N/A logging N/A salt.utils.openstack.nova suon N/A log N/A N/A logging getLogger __name__ N/A __func_alias__ N/A list_ list N/A __virtualname__ nova __virtual__ N/A N/A N/A N/A N/A 
    Only load this module if nova
    is installed on this minion.
     N/A N/A N/A suon check_nova N/A N/A __virtualname__ N/A N/A False The nova execution module failed to load: only available if nova is installed. N/A N/A __opts__ N/A _auth N/A N/A profile N/A None N/A N/A 
    Set up nova credentials
     N/A profile N/A N/A credentials N/A N/A __salt__ N/A config.option profile N/A user N/A credentials N/A keystone.user N/A password N/A credentials N/A keystone.password N/A tenant N/A credentials N/A keystone.tenant N/A auth_url N/A credentials N/A keystone.auth_url N/A region_name N/A N/A credentials get keystone.region_name None N/A api_key N/A N/A credentials get keystone.api_key None N/A os_auth_system N/A N/A credentials get keystone.os_auth_system None N/A N/A user N/A N/A __salt__ N/A config.option keystone.user N/A password N/A N/A __salt__ N/A config.option keystone.password N/A tenant N/A N/A __salt__ N/A config.option keystone.tenant N/A auth_url N/A N/A __salt__ N/A config.option keystone.auth_url N/A region_name N/A N/A __salt__ N/A config.option keystone.region_name N/A api_key N/A N/A __salt__ N/A config.option keystone.api_key N/A os_auth_system N/A N/A __salt__ N/A config.option keystone.os_auth_system N/A kwargs N/A username password api_key project_id auth_url region_name os_auth_plugin user password api_key tenant auth_url region_name os_auth_system N/A N/A N/A suon SaltNova kwargs N/A boot N/A N/A name flavor_id image_id profile timeout N/A 0 0 None 300 N/A N/A 
    Boot (create) a new instance

    name
        Name of the new instance (must be first)

    flavor_id
        Unique integer ID for the flavor

    image_id
        Unique integer ID for the image

    timeout
        How long to wait, after creating the instance, for the provider to
        return information about it (default 300 seconds).

        .. versionadded:: 2014.1.0

    CLI Example:

    .. code-block:: bash

        salt '*' nova.boot myinstance flavor_id=4596 image_id=2

    The flavor_id and image_id are obtained from nova.flavor_list and
    nova.image_list

    .. code-block:: bash

        salt '*' nova.flavor_list
        salt '*' nova.image_list
     N/A conn N/A _auth profile N/A N/A N/A conn boot name flavor_id image_id timeout N/A volume_list N/A N/A search_opts profile N/A None None N/A N/A 
    List storage volumes

    search_opts
        Dictionary of search options

    profile
        Profile to use

    CLI Example:

    .. code-block:: bash

        salt '*' nova.volume_list                 search_opts='{"display_name": "myblock"}'                 profile=openstack

     N/A conn N/A _auth profile N/A N/A N/A conn volume_list search_opts search_opts N/A volume_show N/A N/A name profile N/A None N/A N/A 
    Create a block storage volume

    name
        Name of the volume

    profile
        Profile to use

    CLI Example:

    .. code-block:: bash

        salt '*' nova.volume_show myblock profile=openstack

     N/A conn N/A _auth profile N/A N/A N/A conn volume_show name N/A volume_create N/A N/A name size snapshot voltype profile N/A 100 None None None N/A N/A 
    Create a block storage volume

    name
        Name of the new volume (must be first)

    size
        Volume size

    snapshot
        Block storage snapshot id

    voltype
        Type of storage

    profile
        Profile to build on

    CLI Example:

    .. code-block:: bash

        salt '*' nova.volume_create myblock size=300 profile=openstack

     N/A conn N/A _auth profile N/A N/A N/A conn volume_create name size snapshot voltype N/A volume_delete N/A N/A name profile N/A None N/A N/A 
    Destroy the volume

    name
        Name of the volume

    profile
        Profile to build on

    CLI Example:

    .. code-block:: bash

        salt '*' nova.volume_delete myblock profile=openstack

     N/A conn N/A _auth profile N/A N/A N/A conn volume_delete name N/A volume_detach N/A N/A name profile timeout N/A None 300 N/A N/A 
    Attach a block storage volume

    name
        Name of the new volume to attach

    server_name
        Name of the server to detach from

    profile
        Profile to build on

    CLI Example:

    .. code-block:: bash

        salt '*' nova.volume_detach myblock profile=openstack

     N/A conn N/A _auth profile N/A N/A N/A conn volume_detach name timeout N/A volume_attach N/A N/A name server_name device profile timeout N/A /dev/xvdb None 300 N/A N/A 
    Attach a block storage volume

    name
        Name of the new volume to attach

    server_name
        Name of the server to attach to

    device
        Name of the device on the server

    profile
        Profile to build on

    CLI Example:

    .. code-block:: bash

        salt '*' nova.volume_attach myblock slice.example.com profile=openstack
        salt '*' nova.volume_attach myblock server.example.com                 device='/dev/xvdb' profile=openstack

     N/A conn N/A _auth profile N/A N/A N/A conn volume_attach name server_name device timeout N/A suspend N/A N/A instance_id profile N/A None N/A N/A 
    Suspend an instance

    instance_id
        ID of the instance to be suspended

    CLI Example:

    .. code-block:: bash

        salt '*' nova.suspend 1138

     N/A conn N/A _auth profile N/A N/A N/A conn suspend instance_id N/A resume N/A N/A instance_id profile N/A None N/A N/A 
    Resume an instance

    instance_id
        ID of the instance to be resumed

    CLI Example:

    .. code-block:: bash

        salt '*' nova.resume 1138

     N/A conn N/A _auth profile N/A N/A N/A conn resume instance_id N/A lock N/A N/A instance_id profile N/A None N/A N/A 
    Lock an instance

    instance_id
        ID of the instance to be locked

    CLI Example:

    .. code-block:: bash

        salt '*' nova.lock 1138

     N/A conn N/A _auth profile N/A N/A N/A conn lock instance_id N/A delete N/A N/A instance_id profile N/A None N/A N/A 
    Delete an instance

    instance_id
        ID of the instance to be deleted

    CLI Example:

    .. code-block:: bash

        salt '*' nova.delete 1138

     N/A conn N/A _auth profile N/A N/A N/A conn delete instance_id N/A flavor_list N/A N/A profile N/A None N/A N/A 
    Return a list of available flavors (nova flavor-list)

    CLI Example:

    .. code-block:: bash

        salt '*' nova.flavor_list
     N/A conn N/A _auth profile N/A N/A N/A conn flavor_list N/A flavor_create N/A N/A name flavor_id ram disk vcpus profile N/A 0 0 0 1 None N/A N/A 
    Add a flavor to nova (nova flavor-create). The following parameters are
    required:

    name
        Name of the new flavor (must be first)
    flavor_id
        Unique integer ID for the new flavor
    ram
        Memory size in MB
    disk
        Disk size in GB
    vcpus
        Number of vcpus

    CLI Example:

    .. code-block:: bash

        salt '*' nova.flavor_create myflavor flavor_id=6                 ram=4096 disk=10 vcpus=1
     N/A conn N/A _auth profile N/A N/A N/A conn flavor_create name flavor_id ram disk vcpus N/A flavor_delete N/A N/A flavor_id profile N/A None N/A N/A 
    Delete a flavor from nova by id (nova flavor-delete)

    CLI Example:

    .. code-block:: bash

        salt '*' nova.flavor_delete 7
     N/A conn N/A _auth profile N/A N/A N/A conn flavor_delete flavor_id N/A keypair_list N/A N/A profile N/A None N/A N/A 
    Return a list of available keypairs (nova keypair-list)

    CLI Example:

    .. code-block:: bash

        salt '*' nova.keypair_list
     N/A conn N/A _auth profile N/A N/A N/A conn keypair_list N/A keypair_add N/A N/A name pubfile pubkey profile N/A None None None N/A N/A 
    Add a keypair to nova (nova keypair-add)

    CLI Examples:

    .. code-block:: bash

        salt '*' nova.keypair_add mykey pubfile='/home/myuser/.ssh/id_rsa.pub'
        salt '*' nova.keypair_add mykey pubkey='ssh-rsa <key> myuser@mybox'
     N/A conn N/A _auth profile N/A N/A N/A conn keypair_add name pubfile pubkey N/A keypair_delete N/A N/A name profile N/A None N/A N/A 
    Add a keypair to nova (nova keypair-delete)

    CLI Example:

    .. code-block:: bash

        salt '*' nova.keypair_delete mykey'
     N/A conn N/A _auth profile N/A N/A N/A conn keypair_delete name N/A image_list N/A N/A name profile N/A None None N/A N/A 
    Return a list of available images (nova images-list + nova image-show)
    If a name is provided, only that image will be displayed.

    CLI Examples:

    .. code-block:: bash

        salt '*' nova.image_list
        salt '*' nova.image_list myimage
     N/A conn N/A _auth profile N/A N/A N/A conn image_list name N/A image_meta_set N/A N/A image_id name profile N/A None None None kwargs N/A N/A 
    Sets a key=value pair in the metadata for an image (nova image-meta set)

    CLI Examples:

    .. code-block:: bash

        salt '*' nova.image_meta_set 6f52b2ff-0b31-4d84-8fd1-af45b84824f6                 cheese=gruyere
        salt '*' nova.image_meta_set name=myimage salad=pasta beans=baked
     N/A conn N/A _auth profile N/A N/A N/A conn image_meta_set image_id name kwargs N/A image_meta_delete N/A N/A image_id name keys profile N/A None None None None N/A N/A 
    Delete a key=value pair from the metadata for an image
    (nova image-meta set)

    CLI Examples:

    .. code-block:: bash

        salt '*' nova.image_meta_delete                 6f52b2ff-0b31-4d84-8fd1-af45b84824f6 keys=cheese
        salt '*' nova.image_meta_delete name=myimage keys=salad,beans
     N/A conn N/A _auth profile N/A N/A N/A conn image_meta_delete image_id name keys N/A list_ N/A N/A profile N/A None N/A N/A 
    To maintain the feel of the nova command line, this function simply calls
    the server_list function.
     N/A N/A server_list profile profile N/A server_list N/A N/A profile N/A None N/A N/A 
    Return list of active servers

    CLI Example:

    .. code-block:: bash

        salt '*' nova.server_list
     N/A conn N/A _auth profile N/A N/A N/A conn server_list N/A show N/A N/A server_id profile N/A None N/A N/A 
    To maintain the feel of the nova command line, this function simply calls
    the server_show function.

    CLI Example:

    .. code-block:: bash

        salt '*' nova.show
     N/A N/A server_show server_id profile N/A server_list_detailed N/A N/A profile N/A None N/A N/A 
    Return detailed list of active servers

    CLI Example:

    .. code-block:: bash

        salt '*' nova.server_list_detailed
     N/A conn N/A _auth profile N/A N/A N/A conn server_list_detailed N/A server_show N/A N/A server_id profile N/A None N/A N/A 
    Return detailed information for an active server

    CLI Example:

    .. code-block:: bash

        salt '*' nova.server_show <server_id>
     N/A conn N/A _auth profile N/A N/A N/A conn server_show server_id N/A secgroup_create N/A N/A name description profile N/A None N/A N/A 
    Add a secgroup to nova (nova secgroup-create)

    CLI Example:

    .. code-block:: bash

        salt '*' nova.secgroup_create mygroup 'This is my security group'
     N/A conn N/A _auth profile N/A N/A N/A conn secgroup_create name description N/A secgroup_delete N/A N/A name profile N/A None N/A N/A 
    Delete a secgroup to nova (nova secgroup-delete)

    CLI Example:

    .. code-block:: bash

        salt '*' nova.secgroup_delete mygroup
     N/A conn N/A _auth profile N/A N/A N/A conn secgroup_delete name N/A secgroup_list N/A N/A profile N/A None N/A N/A 
    Return a list of available security groups (nova items-list)

    CLI Example:

    .. code-block:: bash

        salt '*' nova.secgroup_list
     N/A conn N/A _auth profile N/A N/A N/A conn secgroup_list N/A server_by_name N/A N/A name profile N/A None N/A N/A 
    Return information about a server

    name
        Server Name

    CLI Example:

    .. code-block:: bash

        salt '*' nova.server_by_name myserver profile=openstack
     N/A conn N/A _auth profile N/A N/A N/A conn server_by_name name N/A