golden hour
/opt/saltstack/salt/lib/python3.10/site-packages/salt/cloud/clouds/__pycache__
⬆️ Go Up
Upload
File/Folder
Size
Actions
__init__.cpython-310.pyc
171 B
Del
OK
aliyun.cpython-310.pyc
19.81 KB
Del
OK
azurearm.cpython-310.pyc
39.67 KB
Del
OK
clc.cpython-310.pyc
8.91 KB
Del
OK
cloudstack.cpython-310.pyc
10.87 KB
Del
OK
digitalocean.cpython-310.pyc
27.39 KB
Del
OK
dimensiondata.cpython-310.pyc
12.62 KB
Del
OK
ec2.cpython-310.pyc
92.28 KB
Del
OK
gce.cpython-310.pyc
48.78 KB
Del
OK
gogrid.cpython-310.pyc
11.07 KB
Del
OK
hetzner.cpython-310.pyc
11.82 KB
Del
OK
joyent.cpython-310.pyc
22.78 KB
Del
OK
libvirt.cpython-310.pyc
16.69 KB
Del
OK
linode.cpython-310.pyc
59.17 KB
Del
OK
lxc.cpython-310.pyc
10.9 KB
Del
OK
msazure.cpython-310.pyc
71.44 KB
Del
OK
oneandone.cpython-310.pyc
18.39 KB
Del
OK
opennebula.cpython-310.pyc
90.2 KB
Del
OK
openstack.cpython-310.pyc
23.53 KB
Del
OK
packet.cpython-310.pyc
12.06 KB
Del
OK
parallels.cpython-310.pyc
11.89 KB
Del
OK
profitbricks.cpython-310.pyc
25.34 KB
Del
OK
proxmox.cpython-310.pyc
27.25 KB
Del
OK
pyrax.cpython-310.pyc
2.59 KB
Del
OK
qingcloud.cpython-310.pyc
16.64 KB
Del
OK
saltify.cpython-310.pyc
11.91 KB
Del
OK
scaleway.cpython-310.pyc
9.36 KB
Del
OK
softlayer.cpython-310.pyc
13.26 KB
Del
OK
softlayer_hw.cpython-310.pyc
13.5 KB
Del
OK
tencentcloud.cpython-310.pyc
20.55 KB
Del
OK
vagrant.cpython-310.pyc
8.32 KB
Del
OK
virtualbox.cpython-310.pyc
9.57 KB
Del
OK
vmware.cpython-310.pyc
94.14 KB
Del
OK
vultrpy.cpython-310.pyc
12.8 KB
Del
OK
xen.cpython-310.pyc
25.66 KB
Del
OK
Edit: opennebula.cpython-310.pyc
o �xe�� � @ s� d Z ddlZddlZddlZddlZddlmZ ddlZddl Zddl m Z m Z m Z mZmZ zddlZddlmZ dZW n eyG dZY nw e�e�ZdZdd � Zd d � Zd d � Z dd� Z d�dd�Z d�dd�Z d�dd�Z d�dd�Z!d�dd�Z"d�dd�Z#d�d d �Z$d�d d �Z%d�d d!�Z&d�d"d#�Z'd�d$d%�Z(d�d&d'�Z)d�d(d)�Z*d�d*d+�Z+d�d,d-�Z,d�d.d/�Z-d�d0d1�Z.d�d2d3�Z/d�d4d5�Z0d6d7� Z1d�d8d9�Z2d:d;� Z3d�d<d=�Z4d�d>d?�Z5d�d@dA�Z6dBdC� Z7d�dDdE�Z8d�dFdG�Z9d�dHdI�Z:dJdK� Z;d�dLdM�Z<d�dNdO�Z=d�dPdQ�Z>d�dRdS�Z?d�dTdU�Z@d�dVdW�ZAd�dXdY�ZBd�dZd[�ZCd�d\d]�ZDd�d^d_�ZEd�d`da�ZFd�dbdc�ZGd�ddde�ZHd�dfdg�ZId�dhdi�ZJd�djdk�ZKd�dldm�ZLd�dndo�ZMd�dpdq�ZNd�drds�ZOd�dtdu�ZPd�dvdw�ZQd�dxdy�ZRd�dzd{�ZSd�d|d}�ZTd�d~d�ZUd�d�d��ZVd�d�d��ZWd�d�d��ZXd�d�d��ZYd�d�d��ZZd�d�d��Z[d�d�d��Z\d�d�d��Z]d�d�d��Z^d�d�d��Z_d�d�d��Z`d�d�d��Zad�d�d��Zbd�d�d��Zcd�d�d��Zdd�d�d��Zed�d�d��Zfd�d�d��Zgd�d�d��Zhd�d�d��Zid�d�d��Zjd�d�d��Zkd�d�� Zld�d�� Zmd�d�� Znd�d�d��Zod�d�� ZpdS )�ab OpenNebula Cloud Module ======================= The OpenNebula cloud module is used to control access to an OpenNebula cloud. .. versionadded:: 2014.7.0 :depends: lxml :depends: OpenNebula installation running version ``4.14`` or later. Use of this module requires the ``xml_rpc``, ``user``, and ``password`` parameters to be set. Set up the cloud configuration at ``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/opennebula.conf``: .. code-block:: yaml my-opennebula-config: xml_rpc: http://localhost:2633/RPC2 user: oneadmin password: JHGhgsayu32jsa driver: opennebula This driver supports accessing new VM instances via DNS entry instead of IP address. To enable this feature, in the provider or profile file add `fqdn_base` with a value matching the base of your fully-qualified domain name. Example: .. code-block:: yaml my-opennebula-config: [...] fqdn_base: <my.basedomain.com> [...] The driver will prepend the hostname to the fqdn_base and do a DNS lookup to find the IP of the new VM. .. note: Whenever ``data`` is provided as a kwarg to a function and the attribute=value syntax is used, the entire ``data`` value must be wrapped in single or double quotes. If the value given in the attribute=value data string contains multiple words, double quotes *must* be used for the value while the entire data string should be encapsulated in single quotes. Failing to do so will result in an error. Example: .. code-block:: bash salt-cloud -f image_allocate opennebula datastore_name=default \ data='NAME="My New Image" DESCRIPTION="Description of the image." \ PATH=/home/one_user/images/image_name.img' salt-cloud -f secgroup_allocate opennebula \ data="Name = test RULE = [PROTOCOL = TCP, RULE_TYPE = inbound, \ RANGE = 1000:2000]" � N)�SaltCloudConfigError�SaltCloudExecutionFailure�SaltCloudExecutionTimeout�SaltCloudNotFound�SaltCloudSystemExit)�etreeTF� opennebulac C s t � du rdS t� du rdS tS )z' Check for OpenNebula configs. F)�get_configured_provider�get_dependencies�__virtualname__� r r �P/opt/saltstack/salt/lib/python3.10/site-packages/salt/cloud/clouds/opennebula.py� __virtual__^ s r c C s" zt �� W S ty t Y S w �N)Z__active_provider_name__�value�AttributeErrorr r r r �_get_active_provider_namek s �r c C s t �tt� ptd�S )z/ Return the first configured instance. )�xml_rpc�user�password)�configZis_provider_configured�__opts__r r r r r r r r s �r c C s t �tdti�S )z* Warn if dependencies aren't met. Zlmxl)r Zcheck_driver_dependenciesr � HAS_XML_LIBSr r r r r } s r c C �l | dkrt d��t� \}}}d�||g�}|jj�|ddd�d }i }t|�D ] }t|�||�d�j < q'|S )z� Return available OpenNebula images. CLI Example: .. code-block:: bash salt-cloud --list-images opennebula salt-cloud --function avail_images opennebula salt-cloud -f avail_images opennebula �actionz`The avail_images function must be called with -f or --function, or with the --list-images option�:������� �NAME) r � _get_xml_rpc�join�oneZ imagepool�info�_get_xml� _xml_to_dict�find�text)�call�serverr r �authZ image_pool�images�imager r r � avail_images� s � r- c C �f | dkrt d��t� \}}}d�||g�}|jj�|�d }i }t|�D ] }t|�||�d�j < q$|S )z� Return available OpenNebula locations. CLI Example: .. code-block:: bash salt-cloud --list-locations opennebula salt-cloud --function avail_locations opennebula salt-cloud -f avail_locations opennebula r zgThe avail_locations function must be called with -f or --function, or with the --list-locations option.r r r ) r r r! r" Zhostpoolr# r$ r% r& r' )r( r) r r r* Z host_pool� locations�hostr r r �avail_locations� s � r1 c C s | dkrt d��t�d� i S )zl Because sizes are built into templates with OpenNebula, there will be no sizes to return here. r z_The avail_sizes function must be called with -f or --function, or with the --list-sizes option.zUBecause sizes are built into templates with OpenNebula, there are no sizes to return.)r �log�warning�r( r r r � avail_sizes� s ��r5 c C r. )z� Returns a list of clusters in OpenNebula. .. versionadded:: 2016.3.0 CLI Example: .. code-block:: bash salt-cloud -f list_clusters opennebula r z@The list_clusters function must be called with -f or --function.r r r ) r r r! r" Z clusterpoolr# r$ r% r& r' )r( r) r r r* Z cluster_poolZclustersZclusterr r r � list_clusters� � � r6 c C r. )z� Returns a list of data stores on OpenNebula. .. versionadded:: 2016.3.0 CLI Example: .. code-block:: bash salt-cloud -f list_datastores opennebula r zBThe list_datastores function must be called with -f or --function.r r r ) r r r! r" Z datastorepoolr# r$ r% r& r' )r( r) r r r* Zdatastore_poolZ datastoresZ datastorer r r �list_datastores� r7 r8 c C s | dkrt d��t� S )z� Returns a list of hosts on OpenNebula. .. versionadded:: 2016.3.0 CLI Example: .. code-block:: bash salt-cloud -f list_hosts opennebula r z=The list_hosts function must be called with -f or --function.)r r1 r4 r r r � list_hosts s �r9 c C � | dkrt d��tdd�S )z� Return a list of VMs on OpenNebula. CLI Example: .. code-block:: bash salt-cloud -Q salt-cloud --query salt-cloud --function list_nodes opennebula salt-cloud -f list_nodes opennebula r z=The list_nodes function must be called with -f or --function.F��full�r � _list_nodesr4 r r r � list_nodes � � r? c C r: )z� Return a list of the VMs on OpenNebula. CLI Example: .. code-block:: bash salt-cloud -F salt-cloud --full-query salt-cloud --function list_nodes_full opennebula salt-cloud -f list_nodes_full opennebula r �BThe list_nodes_full function must be called with -f or --function.Tr; r= r4 r r r �list_nodes_full6 r@ rB c C s( | dkrt d��td td�td | �S )zP Return a list of the VMs that are on the provider, with select fields. r rA zcloud.list_nodes_select�functionzquery.selection)r � __utils__rB r r4 r r r �list_nodes_selectL s ��rE c C r )z� Lists all security groups available to the user and the user's groups. .. versionadded:: 2016.3.0 CLI Example: .. code-block:: bash salt-cloud -f list_security_groups opennebula r zGThe list_security_groups function must be called with -f or --function.r r r r r ) r r r! r" Z secgrouppoolr# r$ r% r& r' )r( r) r r r* Z secgroup_pool�groups�groupr r r �list_security_groups\ � � rH c C r )z� Lists all templates available to the user and the user's groups. .. versionadded:: 2016.3.0 CLI Example: .. code-block:: bash salt-cloud -f list_templates opennebula r zAThe list_templates function must be called with -f or --function.r r r r r ) r r r! r" Z templatepoolr# r$ r% r& r' )r( r) r r r* Z template_poolZ templates�templater r r �list_templatesx rI rK c C r )z� Lists all virtual networks available to the user and the user's groups. .. versionadded:: 2016.3.0 CLI Example: .. code-block:: bash salt-cloud -f list_vns opennebula r z;The list_vns function must be called with -f or --function.r r r r r ) r r r! r" Zvnpoolr# r$ r% r& r' )r( r) r r r* Zvn_poolZvnsZ v_networkr r r �list_vns� rI rL c C �. |dkrt d��t�d| � t| ddi|d�S )z� Reboot a VM. .. versionadded:: 2016.3.0 name The name of the VM to reboot. CLI Example: .. code-block:: bash salt-cloud -a reboot my-vm r �4The start action must be called with -a or --action.zRebooting node %s�reboot��kwargsr( �r r2 r# � vm_action��namer( r r r rO � � � rO c C rM )z� Start a VM. .. versionadded:: 2016.3.0 name The name of the VM to start. CLI Example: .. code-block:: bash salt-cloud -a start my-vm r rN zStarting node %sZresumerP rR rT r r r �start� rV rW c C rM )z� Stop a VM. .. versionadded:: 2016.3.0 name The name of the VM to stop. CLI Example: .. code-block:: bash salt-cloud -a stop my-vm r rN zStopping node %s�stoprP rR rT r r r rX � rV rX c C sH |dkrt d��| du ri } t� \}}}d�||g�}|jj�|�d S )z� Returns the OpenNebula version. .. versionadded:: 2016.3.5 CLI Example: .. code-block:: bash salt-cloud -f get_one_version one_provider_name r �AThe get_cluster_id function must be called with -f or --function.Nr r )r r r! r" �system�version)rQ r( r) r r r* r r r �get_one_version� s � r\ c C �j |dkrt d��| du ri } | �dd�}|du r t d��z t� | d }W |S ty4 t d�|���w )z� Returns a cluster's ID from the given cluster name. .. versionadded:: 2016.3.0 CLI Example: .. code-block:: bash salt-cloud -f get_cluster_id opennebula name=my-cluster-name r rY NrU z,The get_cluster_id function requires a name.�idz#The cluster '{}' could not be found)r �getr6 �KeyError�format�rQ r( rU �retr r r �get_cluster_id � � ��rd c C r] )z� Returns a data store's ID from the given data store name. .. versionadded:: 2016.3.0 CLI Example: .. code-block:: bash salt-cloud -f get_datastore_id opennebula name=my-datastore-name r zCThe get_datastore_id function must be called with -f or --function.NrU z.The get_datastore_id function requires a name.r^ z&The datastore '{}' could not be found.)r r_ r8 r` ra rb r r r �get_datastore_id6 re rf c C r] )z� Returns a host's ID from the given host name. .. versionadded:: 2016.3.0 CLI Example: .. code-block:: bash salt-cloud -f get_host_id opennebula name=my-host-name r z>The get_host_id function must be called with -f or --function.NrU z)The get_host_id function requires a name.r^ z The host '{}' could not be found)r r_ r1 r` ra rb r r r � get_host_idV re rg c C s` t � }ttjd| tdd��}|D ]}||| d || d fv r(|| d S qtd�|���)zk Return the image object to use. vm\_ The VM dictionary for which to obtain an image. r, F�� search_globalrU r^ z.The specified image, '{}', could not be found.)r- �strr �get_cloud_config_valuer r ra )�vm_r+ Zvm_imager, r r r � get_imagev s � ��rm c C r] )z� Returns an image's ID from the given image name. .. versionadded:: 2016.3.0 CLI Example: .. code-block:: bash salt-cloud -f get_image_id opennebula name=my-image-name r z?The get_image_id function must be called with -f or --function.NrU z*The get_image_id function requires a name.r^ z!The image '{}' could not be found)r r_ r- r` ra rb r r r � get_image_id� re rn c C sl t � }ttjd| tdd��}|dkrdS |D ]}||| d || d fv r.|| d S qtd�|���) zg Return the VM's location. vm\_ The VM dictionary for which to obtain a location. �locationFrh �NoneNrU r^ z1The specified location, '{}', could not be found.)r1 rj r rk r r ra )rl r/ Z vm_locationro r r r � get_location� s � ��rq c C r] )z� Returns a security group's ID from the given security group name. .. versionadded:: 2016.3.0 CLI Example: .. code-block:: bash salt-cloud -f get_secgroup_id opennebula name=my-secgroup-name r zBThe get_secgroup_id function must be called with -f or --function.NrU z/The get_secgroup_id function requires a 'name'.r^ z+The security group '{}' could not be found.)r r_ rH r` ra rb r r r �get_secgroup_id� s" � ���rr c C sr |dkrt d��| du ri } | �dd�}|du r t d��zt� | d d d }W |S ty8 t d �|���w ) z� Returns a template's image from the given template name. .. versionadded:: 2018.3.0 .. code-block:: bash salt-cloud -f get_template_image opennebula name=my-template-name r zEThe get_template_image function must be called with -f or --function.NrU z2The get_template_image function requires a 'name'.rJ �diskr, z/The image for template '{}' could not be found.�r r_ rK r` ra rb r r r �get_template_image� s" � ���ru c C r] )z� Returns a template's ID from the given template name. .. versionadded:: 2016.3.0 CLI Example: .. code-block:: bash salt-cloud -f get_template_id opennebula name=my-template-name r zBThe get_template_id function must be called with -f or --function.NrU z/The get_template_id function requires a 'name'.r^ z%The template '{}' could not be found.rt rb r r r �get_template_id re rv c C sD t tjd| tdd��}zt� | d W S ty! td�|���w )z� Return the template id for a VM. .. versionadded:: 2016.11.0 vm\_ The VM dictionary for which to obtain a template. rJ Frh r^ z1The specified template, '{}', could not be found.)rj r rk r rK r` r ra )rl Z vm_templater r r � get_template" s � ��rw c C r] )z� Returns a virtual machine's ID from the given virtual machine's name. .. versionadded:: 2016.3.0 CLI Example: .. code-block:: bash salt-cloud -f get_vm_id opennebula name=my-vm r z<The get_vm_id function must be called with -f or --function.NrU z'The get_vm_id function requires a name.r^ z The VM '{}' could not be found.)r r_ r? r` ra rb r r r � get_vm_id7 re rx c C r] )z� Returns a virtual network's ID from the given virtual network's name. .. versionadded:: 2016.3.0 CLI Example: .. code-block:: bash salt-cloud -f get_vn_id opennebula name=my-vn-name r z<The get_vn_id function must be called with -f or --function.NrU z'The get_vn_id function requires a name.r^ z The VN '{}' could not be found.)r r_ rL r` ra rb r r r � get_vn_idW re ry c s� � �fdd�}|dd� �d }�d }|dkr8d�v r!�d }nt d|id�}td|id�}d �|||�}|S |d kr_|d � �d } d �| |�}| d kr]|d� �d } d�| || �}|S dS )zf Returns the template format to create a disk in open nebula .. versionadded:: 2018.3.0 c s& | D ]}|�vrt d�� |���qd S )Nz"The disk {} requires a {} argument)r ra )�args�arg�rs � disk_infor r �_require_disk_opts s ���z0_get_device_template.<locals>._require_disk_opts� disk_type�size�cloner, rU �rQ z0DISK=[IMAGE={}, IMAGE_ID={}, CLONE=YES, SIZE={}]Zvolatile�typezDISK=[TYPE={}, SIZE={}]Zfsra z"DISK=[TYPE={}, SIZE={}, FORMAT={}]N)ru rn ra ) rs r} rJ r~ r� r Z clone_imageZclone_image_idZtempZv_typera r r| r �_get_device_templatew s. � �r� c C s z| d rt �tt� p d| d �du rW dS W n ty Y nw td ddd�| d �td d | g d ��td td d� t�d| d � | d t | �t | �d�}d| v r`t d| d i�|d< t j d| tddd�}|rndnd|d< td ddd�| d �dtd d|t |��itd d � g }|�d �r�|�d �|�d ��� | �d �r�|�d �| �d ��� | �d!�r�|�d"�| �d!��� | �d#�r�|�d$�| �d#��� | �d%�r�| �d%�}| d& }|D ]}|�t||| |d'�� q�d(t|�vr�td)��d*�|�}z6t� \}} } d+�| | g�} |jj�| t|d, �|d d|�} | d- �s3tjd.| d | d/ tjd0� W dS W n t �yT } ztjd1| d | tjd0� W Y d} ~ dS d} ~ ww | �d2�}|du�rgd3�| d |�}d4d5� }z td6 || d ft j d7| td8d9�t j d:| td;d9�d<�}W n7 t t f�y� } z(z!zt | d � W n t�y� Y nw W tt| ���W tt| ���tt| ���d} ~ ww t j d=| tddd�}|du�r�t j!�"|��s�t#d>�|���|�r�|| d?< d@}n4z|dA d- }W n+ t$�y z |d dB dC }W n t$�y |d dB dD }Y nw || d?< Y nw t j dE| tdFd9�}|| dG< || dH< tdI | t�}|dJ |dJ< | d& |d&< | d |d< |d d |dK< |dL |dL< ||dA< g |dM< t�dN| d � t�%dO| d t&�'|�� td ddPdQ�| d �td dR| g d ��td d � |S )Sa# Create a single VM from a data dict. vm\_ The dictionary use to create a VM. Optional vm\_ dict options for overwriting template: region_id Optional - OpenNebula Zone ID memory Optional - In MB cpu Optional - Percent of host CPU to allocate vcpu Optional - Amount of vCPUs to allocate CLI Example: .. code-block:: bash salt-cloud -p my-opennebula-profile vm_name salt-cloud -p my-opennebula-profile vm_name memory=16384 cpu=2.5 vcpu=16 �profiler F�cloud.fire_event�eventzstarting createzsalt/cloud/{}/creatingrU zcloud.filter_eventZcreating)rU r� ZproviderZdriver�sock_dir� transport)rz r� r� zCreating Cloud VM %s)rU � template_id� region_idrJ �image_id�private_networkingN)ri �default�true�falsezrequesting instancezsalt/cloud/{}/requestingrQ Z requesting�rz r� r� zSCHED_REQUIREMENTS="ID={}"�memoryz MEMORY={}�cpuzCPU={}ZvcpuzVCPU={}rs r, )rJ ZCLONEz^Missing an image disk to clone. Must define a clone disk alongside all other disk definitions.� r r� r zmError creating %s on OpenNebula The following error was returned when trying to instantiate the template: %sr )Zexc_info_on_loglevelzqError creating %s on OpenNebula The following exception was thrown when trying to run the initial deployment: %sZ fqdn_basez{}.{}c S s8 t | dd�}|s dS |d dkrdS |d dkr|S d S )Nr r4 F�state�7Z lcm_state�3)� show_instance)�vm_nameZ node_datar r r �__query_node_data- s �z!create.<locals>.__query_node_datazcloud.wait_for_ipZwait_for_ip_timeoutiX )r� Zwait_for_ip_interval� )� update_args�timeout�intervalZ private_keyz,The defined key_filename '{}' does not existZssh_hostz0.0.0.0� private_ips�nic�ipZ ip6_global� ssh_username�root�username� key_filenamezcloud.bootstrapr^ r� r� � public_ipszCreated Cloud VM '%s'z '%s' VM creation details: %szcreated instancezsalt/cloud/{}/created�created)(r Zis_profile_configuredr r r rD ra r2 r# rw rq rv rk �listr_ �appendr� rj r r! r r" rJ � instantiate�int�error�logging�DEBUG� Exceptionr r �destroy�os�path�isfiler r` �debug�pprintZpformat)rl rQ r� rJ Z get_disks� template_namers Z template_argsr) r r r* Zcret�excZfqdnr� �datar� Z private_ipr� rc r r r �create� sD ���� � �� � � ��� � � � � � � �� �� � �� ��� ��� � � �� r� c C s� |dkrt d��td ddd�| �d| itd d � t� \}}}d �||g�}t| d d �}|jj� |d t |d ��}td ddd�| �d| itd d � t� dd�du rbtd | t � � d �d t� d|d |d |d d�}|S )aI Destroy a node. Will check termination protection and warn if enabled. name The name of the vm to be destroyed. CLI Example: .. code-block:: bash salt-cloud --destroy vm_name salt-cloud -d vm_name salt-cloud --action destroy vm_name salt-cloud -a destroy vm_name rC zEThe destroy action must be called with -d, --destroy, -a or --action.r� r� zdestroying instancezsalt/cloud/{}/destroyingrU r� r� r r r4 �deleter^ zdestroyed instancezsalt/cloud/{}/destroyedZupdate_cachedirFTz cloud.delete_minion_cachedirr z vm.deleter r� )r �deletedZnode_id� error_code)r rD ra r r r! r� r" �vmr r� r_ r �split)rU r( r) r r r* r� �noder r r r� � s@ �� ���r� c C s& | dkrt d��|du ri }|�dd�}|�dd�}|�dd�}|�dd�}|r0|r/t�d� n|r:td |id �}nt d ��|rH|rGt�d � n$|rhtjjj|d d�� }|� � }W d � n1 sbw Y nt d��t � \}}} d� || g�} |j j �| |t|��} d| d | d | d d�} | S )a) Allocates a new image in OpenNebula. .. versionadded:: 2016.3.0 path The path to a file containing the template of the image to allocate. Syntax within the file can be the usual attribute=value or XML. Can be used instead of ``data``. data The data containing the template of the image to allocate. Syntax can be the usual attribute=value or XML. Can be used instead of ``path``. datastore_id The ID of the data-store to be used for the new image. Can be used instead of ``datastore_name``. datastore_name The name of the data-store to be used for the new image. Can be used instead of ``datastore_id``. CLI Example: .. code-block:: bash salt-cloud -f image_allocate opennebula path=/path/to/image_file.txt datastore_id=1 salt-cloud -f image_allocate opennebula datastore_name=default \ data='NAME="Ubuntu 14.04" PATH="/home/one_user/images/ubuntu_desktop.img" \ DESCRIPTION="Ubuntu 14.04 for development."' rC �AThe image_allocate function must be called with -f or --function.Nr� r� � datastore_id�datastore_namez`Both a 'datastore_id' and a 'datastore_name' were provided. 'datastore_id' will take precedence.rU r� zbThe image_allocate function requires either a 'datastore_id' or a 'datastore_name' to be provided.�PBoth the 'data' and 'path' arguments were provided. 'data' will take precedence.�r��modezSThe image_allocate function requires either a file 'path' or 'data' to be provided.r zimage.allocater r r� )r � allocatedr� r� )r r_ r2 r3 rf �salt�utils�files�fopen�readr r! r" r, �allocater� ) r( rQ r� r� r� r� �rfhr) r r r* �responserc r r r �image_allocate� sX � ����� ��� �r� c C �� | dkrt d��|du ri }|�dd�}|�dd�}|�dd�}|du r(t d��|r2|r1t�d� n|r<td|id �}nt d ��t� \}}}d �||g�}|jj� |t |�|�} d | d | d || d d�} | S )a Clones an existing image. .. versionadded:: 2016.3.0 name The name of the new image. image_id The ID of the image to be cloned. Can be used instead of ``image_name``. image_name The name of the image to be cloned. Can be used instead of ``image_id``. CLI Example: .. code-block:: bash salt-cloud -f image_clone opennebula name=my-new-image image_id=10 salt-cloud -f image_clone opennebula name=my-new-image image_name=my-image-to-clone rC z>The image_clone function must be called with -f or --function.NrU r� � image_namez:The image_clone function requires a 'name' to be provided.�^Both the 'image_id' and 'image_name' arguments were provided. 'image_id' will take precedence.r� zYThe image_clone function requires either an 'image_id' or an 'image_name' to be provided.r z image.cloner r r� )r �clonedZcloned_image_idZcloned_image_namer� ) r r_ r2 r3 rn r r! r" r, r� r� ) r( rQ rU r� r� r) r r r* r� r� r r r � image_clone sD � ���� �r� c C � | dkrt d��|du ri }|�dd�}|�dd�}|r$|r#t�d� n|r.td|id�}nt d��t� \}}}d �||g�}|jj� |t |��}d |d |d |d d�} | S )a� Deletes the given image from OpenNebula. Either a name or an image_id must be supplied. .. versionadded:: 2016.3.0 name The name of the image to delete. Can be used instead of ``image_id``. image_id The ID of the image to delete. Can be used instead of ``name``. CLI Example: .. code-block:: bash salt-cloud -f image_delete opennebula name=my-image salt-cloud --function image_delete opennebula image_id=100 rC z?The image_delete function must be called with -f or --function.NrU r� �XBoth the 'image_id' and 'name' arguments were provided. 'image_id' will take precedence.r� zSThe image_delete function requires either an 'image_id' or a 'name' to be provided.r z image.deleter r r� )r r� r� r� ) r r_ r2 r3 rn r r! r" r, r� r� ) r( rQ rU r� r) r r r* r� r� r r r � image_delete[ �8 � ��� �r� c C � | dkrt d��|du ri }|�dd�}|�dd�}|r$|r#t�d� n|r.td|id�}nt d��t� \}}}d �||g�}i }|jj� |t |��d } t | �} t | �|| � d �j< |S ) a Retrieves information for a given image. Either a name or an image_id must be supplied. .. versionadded:: 2016.3.0 name The name of the image for which to gather information. Can be used instead of ``image_id``. image_id The ID of the image for which to gather information. Can be used instead of ``name``. CLI Example: .. code-block:: bash salt-cloud -f image_info opennebula name=my-image salt-cloud --function image_info opennebula image_id=5 rC z=The image_info function must be called with -f or --function.NrU r� r� r� zPThe image_info function requires either a 'name or an 'image_id' to be provided.r r r )r r_ r2 r3 rn r r! r" r, r# r� r$ r% r& r' ) r( rQ rU r� r) r r r* r# r� �treer r r � image_info� �4 � ��� r� c C s� | dkrt d��|du ri }|�dd�}|�dd�}|�dd�}|du r(t d��|r2|r1t�d� n|r<td|id �}nt d ��t� \}}}d �||g�}|jj� |t |�t j j �|��} d | d | d | d d�} | S )aX Sets the Image as persistent or not persistent. .. versionadded:: 2016.3.0 name The name of the image to set. Can be used instead of ``image_id``. image_id The ID of the image to set. Can be used instead of ``name``. persist A boolean value to set the image as persistent or not. Set to true for persistent, false for non-persistent. CLI Example: .. code-block:: bash salt-cloud -f image_persistent opennebula name=my-image persist=True salt-cloud --function image_persistent opennebula image_id=5 persist=False rC zCThe image_persistent function must be called with -f or --function.NrU �persistr� zPThe image_persistent function requires 'persist' to be set to 'True' or 'False'.r� r� zWThe image_persistent function requires either a 'name' or an 'image_id' to be provided.r zimage.persistentr r r� )r r� r� r� )r r_ r2 r3 rn r r! r" r, Z persistentr� r� r� r� �is_true) r( rQ rU r� r� r) r r r* r� r� r r r �image_persistent� sF � ���� ��r� c C �� | dkrt d��|du ri }|�dd�}|�dd�}|�dd�}|du r(t d��|r2|r1t�d� n|r<td |id �}nt d ��t� \}}}d �||g�}|jj� |t |�t |��} d | d | d | d d�} | S )a= Deletes a snapshot from the image. .. versionadded:: 2016.3.0 image_id The ID of the image from which to delete the snapshot. Can be used instead of ``image_name``. image_name The name of the image from which to delete the snapshot. Can be used instead of ``image_id``. snapshot_id The ID of the snapshot to delete. CLI Example: .. code-block:: bash salt-cloud -f image_snapshot_delete vm_id=106 snapshot_id=45 salt-cloud -f image_snapshot_delete vm_name=my-vm snapshot_id=111 rC zHThe image_snapshot_delete function must be called with -f or --function.Nr� r� � snapshot_idzKThe image_snapshot_delete function requires a 'snapshot_id' to be provided.r� rU r� zbThe image_snapshot_delete function requires either an 'image_id' or a 'image_name' to be provided.r zimage.snapshotdeleter r r� �r r� r� r� ) r r_ r2 r3 rn r r! r" r, �snapshotdeleter� � r( rQ r� r� r� r) r r r* r� r� r r r �image_snapshot_delete sB � ���� �r� c C r� )a# Reverts an image state to a previous snapshot. .. versionadded:: 2016.3.0 image_id The ID of the image to revert. Can be used instead of ``image_name``. image_name The name of the image to revert. Can be used instead of ``image_id``. snapshot_id The ID of the snapshot to which the image will be reverted. CLI Example: .. code-block:: bash salt-cloud -f image_snapshot_revert vm_id=106 snapshot_id=45 salt-cloud -f image_snapshot_revert vm_name=my-vm snapshot_id=120 rC zHThe image_snapshot_revert function must be called with -f or --function.Nr� r� r� zKThe image_snapshot_revert function requires a 'snapshot_id' to be provided.r� rU r� zcThe image_snapshot_revert function requires either an 'image_id' or an 'image_name' to be provided.r zimage.snapshotrevertr r r� )r Zrevertedr� r� ) r r_ r2 r3 rn r r! r" r, �snapshotrevertr� r� r r r �image_snapshot_revert] �B � ���� �r� c C r� )a� Flattens the snapshot of an image and discards others. .. versionadded:: 2016.3.0 image_id The ID of the image. Can be used instead of ``image_name``. image_name The name of the image. Can be used instead of ``image_id``. snapshot_id The ID of the snapshot to flatten. CLI Example: .. code-block:: bash salt-cloud -f image_snapshot_flatten vm_id=106 snapshot_id=45 salt-cloud -f image_snapshot_flatten vm_name=my-vm snapshot_id=45 rC zIThe image_snapshot_flatten function must be called with -f or --function.Nr� r� r� zMThe image_stanpshot_flatten function requires a 'snapshot_id' to be provided.r� rU r� zdThe image_snapshot_flatten function requires either an 'image_id' or an 'image_name' to be provided.r zimage.snapshotflattenr r r� )r Z flattenedr� r� ) r r_ r2 r3 rn r r! r" r, Zsnapshotflattenr� r� r r r �image_snapshot_flatten� r� r� c C � | dkrt d��|du ri }|�dd�}|�dd�}|�dd�}|�dd�}|�dd�}d d g}|du r8t d ��||d krAd }n||d krJd }n t d�|d |d ���|r`|r_t�d� n|rjtd|id�}nt d��|rx|rwt�d� n$|r�tjjj |dd�� } | � � }W d � n1 s�w Y nt d��t � \} } } d� | | g�} | j j�| t|�|t|��}d|d |d |d d�}|S )as Replaces the image template contents. .. versionadded:: 2016.3.0 image_id The ID of the image to update. Can be used instead of ``image_name``. image_name The name of the image to update. Can be used instead of ``image_id``. path The path to a file containing the template of the image. Syntax within the file can be the usual attribute=value or XML. Can be used instead of ``data``. data Contains the template of the image. Syntax can be the usual attribute=value or XML. Can be used instead of ``path``. update_type There are two ways to update an image: ``replace`` the whole template or ``merge`` the new template with the existing one. CLI Example: .. code-block:: bash salt-cloud -f image_update opennebula image_id=0 file=/path/to/image_update_file.txt update_type=replace salt-cloud -f image_update opennebula image_name="Ubuntu 14.04" update_type=merge \ data='NAME="Ubuntu Dev" PATH="/home/one_user/images/ubuntu_desktop.img" \ DESCRIPTION = "Ubuntu 14.04 for development."' rC r� Nr� r� r� r� � update_type�replace�mergezCThe image_update function requires an 'update_type' to be provided.r r �1The update_type argument must be either {} or {}.r� rU r� zZThe image_update function requires either an 'image_id' or an 'image_name' to be provided.r� r� r� zQThe image_update function requires either 'data' or a file 'path' to be provided.r z image.updater� )r �updatedr� r� )r r_ ra r2 r3 rn r� r� r� r� r� r r! r" r, �updater� )r( rQ r� r� r� r� r� r� � update_numberr� r) r r r* r� rc r r r � image_update� sv !� � ������� ��� �r� c C s. |dkrt d��t| �}td |t� t� |S )a_ Show the details from OpenNebula concerning a named VM. name The name of the VM for which to display details. call Type of call to use with this function such as ``function``. CLI Example: .. code-block:: bash salt-cloud --action show_instance vm_name salt-cloud -a show_instance vm_name r z<The show_instance action must be called with -a or --action.zcloud.cache_node)r � _get_noderD r r )rU r( r� r r r r� P s �r� c C �� | dkrt d��|du ri }|�dd�}|�dd�}|r$|r#t�d� n$|rDtjjj|dd�� }|�� }W d � n1 s>w Y nt d ��t � \}}}d � ||g�}|j j � ||�} d | d | d | d d�} | S )a� Allocates a new security group in OpenNebula. .. versionadded:: 2016.3.0 path The path to a file containing the template of the security group. Syntax within the file can be the usual attribute=value or XML. Can be used instead of ``data``. data The template data of the security group. Syntax can be the usual attribute=value or XML. Can be used instead of ``path``. CLI Example: .. code-block:: bash salt-cloud -f secgroup_allocate opennebula path=/path/to/secgroup_file.txt salt-cloud -f secgroup_allocate opennebula \ data="NAME = test RULE = [PROTOCOL = TCP, RULE_TYPE = inbound, \ RANGE = 1000:2000]" rC �DThe secgroup_allocate function must be called with -f or --function.Nr� r� r� r� r� zVThe secgroup_allocate function requires either 'data' or a file 'path' to be provided.r zsecgroup.allocater r r� )r r� � secgroup_idr� )r r_ r2 r3 r� r� r� r� r� r r! r" �secgroupr� � r( rQ r� r� r� r) r r r* r� rc r r r �secgroup_allocatem s> � �� ��� �r� c C r� )aO Clones an existing security group. .. versionadded:: 2016.3.0 name The name of the new template. secgroup_id The ID of the security group to be cloned. Can be used instead of ``secgroup_name``. secgroup_name The name of the security group to be cloned. Can be used instead of ``secgroup_id``. CLI Example: .. code-block:: bash salt-cloud -f secgroup_clone opennebula name=my-cloned-secgroup secgroup_id=0 salt-cloud -f secgroup_clone opennebula name=my-cloned-secgroup secgroup_name=my-secgroup rC zAThe secgroup_clone function must be called with -f or --function.NrU r� � secgroup_namez=The secgroup_clone function requires a 'name' to be provided.�gBoth the 'secgroup_id' and 'secgroup_name' arguments were provided. 'secgroup_id' will take precedence.r� z`The secgroup_clone function requires either a 'secgroup_id' or a 'secgroup_name' to be provided.r zsecgroup.cloner r r� )r r� Zcloned_secgroup_idZcloned_secgroup_namer� ) r r_ r2 r3 rr r r! r" r� r� r� ) r( rQ rU r� r� r) r r r* r� r� r r r �secgroup_clone� sD � ���� �r� c C r� )a Deletes the given security group from OpenNebula. Either a name or a secgroup_id must be supplied. .. versionadded:: 2016.3.0 name The name of the security group to delete. Can be used instead of ``secgroup_id``. secgroup_id The ID of the security group to delete. Can be used instead of ``name``. CLI Example: .. code-block:: bash salt-cloud -f secgroup_delete opennebula name=my-secgroup salt-cloud --function secgroup_delete opennebula secgroup_id=100 rC zBThe secgroup_delete function must be called with -f or --function.NrU r� �^Both the 'secgroup_id' and 'name' arguments were provided. 'secgroup_id' will take precedence.r� zXThe secgroup_delete function requires either a 'name' or a 'secgroup_id' to be provided.r zsecgroup.deleter r r� )r r� r� r� ) r r_ r2 r3 rr r r! r" r� r� r� ) r( rQ rU r� r) r r r* r� r� r r r �secgroup_delete� s8 � ��� �r� c C r� ) aF Retrieves information for the given security group. Either a name or a secgroup_id must be supplied. .. versionadded:: 2016.3.0 name The name of the security group for which to gather information. Can be used instead of ``secgroup_id``. secgroup_id The ID of the security group for which to gather information. Can be used instead of ``name``. CLI Example: .. code-block:: bash salt-cloud -f secgroup_info opennebula name=my-secgroup salt-cloud --function secgroup_info opennebula secgroup_id=5 rC z@The secgroup_info function must be called with -f or --function.NrU r� r� r� zRThe secgroup_info function requires either a name or a secgroup_id to be provided.r r r )r r_ r2 r3 rr r r! r" r� r# r� r$ r% r& r' ) r( rQ rU r� r) r r r* r# r� r� r r r � secgroup_info/ r� r c C r� )a� Replaces the security group template contents. .. versionadded:: 2016.3.0 secgroup_id The ID of the security group to update. Can be used instead of ``secgroup_name``. secgroup_name The name of the security group to update. Can be used instead of ``secgroup_id``. path The path to a file containing the template of the security group. Syntax within the file can be the usual attribute=value or XML. Can be used instead of ``data``. data The template data of the security group. Syntax can be the usual attribute=value or XML. Can be used instead of ``path``. update_type There are two ways to update a security group: ``replace`` the whole template or ``merge`` the new template with the existing one. CLI Example: .. code-block:: bash salt-cloud --function secgroup_update opennebula secgroup_id=100 \ path=/path/to/secgroup_update_file.txt \ update_type=replace salt-cloud -f secgroup_update opennebula secgroup_name=my-secgroup update_type=merge \ data="Name = test RULE = [PROTOCOL = TCP, RULE_TYPE = inbound, RANGE = 1000:2000]" rC r� Nr� r� r� r� r� r� r� zFThe secgroup_update function requires an 'update_type' to be provided.r r r� r� rU r� zaThe secgroup_update function requires either a 'secgroup_id' or a 'secgroup_name' to be provided.r� r� r� zTThe secgroup_update function requires either 'data' or a file 'path' to be provided.r zsecgroup.updater� )r r� r� r� )r r_ ra r2 r3 rr r� r� r� r� r� r r! r" r� r� r� )r( rQ r� r� r� r� r� r� r� r� r) r r r* r� rc r r r �secgroup_updatei �z %� � ������� ��� ��r c C r� )a� Allocates a new template in OpenNebula. .. versionadded:: 2016.3.0 path The path to a file containing the elements of the template to be allocated. Syntax within the file can be the usual attribute=value or XML. Can be used instead of ``data``. data Contains the elements of the template to be allocated. Syntax can be the usual attribute=value or XML. Can be used instead of ``path``. CLI Example: .. code-block:: bash salt-cloud -f template_allocate opennebula path=/path/to/template_file.txt salt-cloud -f template_allocate opennebula \ data='CPU="1.0" DISK=[IMAGE="Ubuntu-14.04"] GRAPHICS=[LISTEN="0.0.0.0",TYPE="vnc"] \ MEMORY="1024" NETWORK="yes" NIC=[NETWORK="192net",NETWORK_UNAME="oneadmin"] \ OS=[ARCH="x86_64"] SUNSTONE_CAPACITY_SELECT="YES" SUNSTONE_NETWORK_SELECT="YES" \ VCPU="1"' rC zDThe template_allocate function must be called with -f or --function.Nr� r� r� r� r� zVThe template_allocate function requires either 'data' or a file 'path' to be provided.r ztemplate.allocater r r� )r r� r� r� )r r_ r2 r3 r� r� r� r� r� r r! r" rJ r� r� r r r �template_allocate� s> � �� ��� �r c C s� | dkrt d��|du ri }|�dd�}|�dd�}|�dd�}|�dd�}|du r.t d ��|r8|r7t�d � n|rBtd|id �}nt d ��t� \}}}d �||g�} |jj� | t |�||�} d| d | d || d d�} | S )a� Clones an existing virtual machine template. .. versionadded:: 2016.3.0 name The name of the new template. template_id The ID of the template to be cloned. Can be used instead of ``template_name``. template_name The name of the template to be cloned. Can be used instead of ``template_id``. clone_images Optional, defaults to False. Indicates if the images attached to the template should be cloned as well. CLI Example: .. code-block:: bash salt-cloud -f template_clone opennebula name=my-new-template template_id=0 salt-cloud -f template_clone opennebula name=my-new-template template_name=my-template rC zAThe template_clone function must be called with -f or --function.NrU r� r� � clone_imagesFz;The template_clone function requires a name to be provided.�gBoth the 'template_id' and 'template_name' arguments were provided. 'template_id' will take precedence.r� z`The template_clone function requires either a 'template_id' or a 'template_name' to be provided.r ztemplate.cloner r r� )r r� Zcloned_template_idZcloned_template_namer� ) r r_ r2 r3 rv r r! r" rJ r� r� ) r( rQ rU r� r� r r) r r r* r� r� r r r �template_clone sF � ���� �r c C r� )a� Deletes the given template from OpenNebula. Either a name or a template_id must be supplied. .. versionadded:: 2016.3.0 name The name of the template to delete. Can be used instead of ``template_id``. template_id The ID of the template to delete. Can be used instead of ``name``. CLI Example: .. code-block:: bash salt-cloud -f template_delete opennebula name=my-template salt-cloud --function template_delete opennebula template_id=5 rC zBThe template_delete function must be called with -f or --function.NrU r� z^Both the 'template_id' and 'name' arguments were provided. 'template_id' will take precedence.r� zXThe template_delete function requires either a 'name' or a 'template_id' to be provided.r ztemplate.deleter r r� )r r� r� r� ) r r_ r2 r3 rv r r! r" rJ r� r� ) r( rQ rU r� r) r r r* r� r� r r r �template_deletee r� r c C s� | dkrt d��|du ri }|�dd�}|�dd�}|�dd�}|du r(t d��|r2|r1t�d� n|r<td |id �}nt d ��t� \}}}d �||g�}|jj� |t |�|�} d | d | d || d d�} | S )a Instantiates a new virtual machine from a template. .. versionadded:: 2016.3.0 .. note:: ``template_instantiate`` creates a VM on OpenNebula from a template, but it does not install Salt on the new VM. Use the ``create`` function for that functionality: ``salt-cloud -p opennebula-profile vm-name``. vm_name Name for the new VM instance. template_id The ID of the template from which the VM will be created. Can be used instead of ``template_name``. template_name The name of the template from which the VM will be created. Can be used instead of ``template_id``. CLI Example: .. code-block:: bash salt-cloud -f template_instantiate opennebula vm_name=my-new-vm template_id=0 rC zGThe template_instantiate function must be called with -f or --function.Nr� r� r� zFThe template_instantiate function requires a 'vm_name' to be provided.r rU r� zfThe template_instantiate function requires either a 'template_id' or a 'template_name' to be provided.r ztemplate.instantiater r r� )r Z instantiatedZinstantiated_vm_idr� r� ) r r_ r2 r3 rv r r! r" rJ r� r� ) r( rQ r� r� r� r) r r r* r� r� r r r �template_instantiate� sD � ���� �r c C r� )ak Replaces the template contents. .. versionadded:: 2016.3.0 template_id The ID of the template to update. Can be used instead of ``template_name``. template_name The name of the template to update. Can be used instead of ``template_id``. path The path to a file containing the elements of the template to be updated. Syntax within the file can be the usual attribute=value or XML. Can be used instead of ``data``. data Contains the elements of the template to be updated. Syntax can be the usual attribute=value or XML. Can be used instead of ``path``. update_type There are two ways to update a template: ``replace`` the whole template or ``merge`` the new template with the existing one. CLI Example: .. code-block:: bash salt-cloud --function template_update opennebula template_id=1 update_type=replace \ path=/path/to/template_update_file.txt salt-cloud -f template_update opennebula template_name=my-template update_type=merge \ data='CPU="1.0" DISK=[IMAGE="Ubuntu-14.04"] GRAPHICS=[LISTEN="0.0.0.0",TYPE="vnc"] \ MEMORY="1024" NETWORK="yes" NIC=[NETWORK="192net",NETWORK_UNAME="oneadmin"] \ OS=[ARCH="x86_64"] SUNSTONE_CAPACITY_SELECT="YES" SUNSTONE_NETWORK_SELECT="YES" \ VCPU="1"' rC zBThe template_update function must be called with -f or --function.Nr� r� r� r� r� r� r� zFThe template_update function requires an 'update_type' to be provided.r r r� r rU r� zaThe template_update function requires either a 'template_id' or a 'template_name' to be provided.r� r� r� zTThe template_update function requires either 'data' or a file 'path' to be provided.r ztemplate.updater� )r r� r� r� )r r_ ra r2 r3 rv r� r� r� r� r� r r! r" rJ r� r� )r( rQ r� r� r� r� r� r� r� r� r) r r r* r� rc r r r �template_update� r r c C s� |dkrt d��|du ri }|�dd�}|du r t d��t� \}}}d�||g�}ttd| id��}|jj�|||�} dt |� | d | d | d d �} | S ) a� Submits an action to be performed on a given virtual machine. .. versionadded:: 2016.3.0 name The name of the VM to action. action The action to be performed on the VM. Available options include: - boot - delete - delete-recreate - hold - poweroff - poweroff-hard - reboot - reboot-hard - release - resched - resume - shutdown - shutdown-hard - stop - suspend - undeploy - undeploy-hard - unresched CLI Example: .. code-block:: bash salt-cloud -a vm_action my-vm action='release' r z:The vm_action function must be called with -a or --action.Nz6The vm_action function must have an 'action' provided.r rU r� z vm.action.r r r� )r Zactioned�vm_idr� ) r r_ r r! r� rx r" r� r rj ) rU rQ r( r r) r r r* r r� r� r r r rS \ s* $� � �rS c C s� | dkrt d��|du ri }|�dd�}|�dd�}|�dd�}|r*|r)t�d� n$|rJtjjj|d d �� }|�� }W d � n1 sDw Y nt d ��t � \}}}d � ||g�} |j j � | |tjj�|��} d | d | d | d d�} | S )aB Allocates a new virtual machine in OpenNebula. .. versionadded:: 2016.3.0 path The path to a file defining the template of the VM to allocate. Syntax within the file can be the usual attribute=value or XML. Can be used instead of ``data``. data Contains the template definitions of the VM to allocate. Syntax can be the usual attribute=value or XML. Can be used instead of ``path``. hold If this parameter is set to ``True``, the VM will be created in the ``HOLD`` state. If not set, the VM is created in the ``PENDING`` state. Default is ``False``. CLI Example: .. code-block:: bash salt-cloud -f vm_allocate path=/path/to/vm_template.txt salt-cloud --function vm_allocate path=/path/to/vm_template.txt hold=True rC z>The vm_allocate function must be called with -f or --function.Nr� r� �holdFr� r� r� zPThe vm_allocate function requires either 'data' or a file 'path' to be provided.r z vm.allocater r r� )r r� r r� )r r_ r2 r3 r� r� r� r� r� r r! r" r� r� r� r� ) r( rQ r� r� r r� r) r r r* r� rc r r r � vm_allocate� s@ � �� ��� �r c C �� |dkrt d��|du ri }|�dd�}|�dd�}|r$|r#t�d� n$|rDtjjj|dd�� }|�� }W d � n1 s>w Y nt d ��t � \}}}d � ||g�} t t d | id ��} |j j�| | |�} d | d | d | d d�} | S )a� Attaches a new disk to the given virtual machine. .. versionadded:: 2016.3.0 name The name of the VM for which to attach the new disk. path The path to a file containing a single disk vector attribute. Syntax within the file can be the usual attribute=value or XML. Can be used instead of ``data``. data Contains the data needed to attach a single disk vector attribute. Syntax can be the usual attribute=value or XML. Can be used instead of ``path``. CLI Example: .. code-block:: bash salt-cloud -a vm_attach my-vm path=/path/to/disk_file.txt salt-cloud -a vm_attach my-vm data="DISK=[DISK_ID=1]" r z8The vm_attach action must be called with -a or --action.Nr� r� r� r� r� zNThe vm_attach function requires either 'data' or a file 'path' to be provided.r rU r� z vm.attachr r r� )r Zattachedr r� )r r_ r2 r3 r� r� r� r� r� r r! r� rx r" r� �attach� rU rQ r( r� r� r� r) r r r* r r� rc r r r � vm_attach� �@ � �� ��� �r c C r )a� Attaches a new network interface to the given virtual machine. .. versionadded:: 2016.3.0 name The name of the VM for which to attach the new network interface. path The path to a file containing a single NIC vector attribute. Syntax within the file can be the usual attribute=value or XML. Can be used instead of ``data``. data Contains the single NIC vector attribute to attach to the VM. Syntax can be the usual attribute=value or XML. Can be used instead of ``path``. CLI Example: .. code-block:: bash salt-cloud -a vm_attach_nic my-vm path=/path/to/nic_file.txt salt-cloud -a vm_attach_nic my-vm data="NIC=[NETWORK_ID=1]" r z<The vm_attach_nic action must be called with -a or --action.Nr� r� r� r� r� zRThe vm_attach_nic function requires either 'data' or a file 'path' to be provided.r rU r� z vm.attachnicr r r� )r Z nic_attachedr r� )r r_ r2 r3 r� r� r� r� r� r r! r� rx r" r� Z attachnicr r r r � vm_attach_nic$ r r c C s& |dkrt d��|du ri }|�dd�}|�dd�}|�dd�}|�dd�}|�d d�}|r6|r5t�d � n|r@td |id �}nt d ��|rN|rMt�d� n |rXtd |id �}nd}t� \}} } d�| | g�} td | id �} |j j � | t | �t |�t jj�|�t |��} d| d | d | d d�}|S )a� Initiates the instance of the given VM on the target host. .. versionadded:: 2016.3.0 name The name of the VM to deploy. host_id The ID of the target host where the VM will be deployed. Can be used instead of ``host_name``. host_name The name of the target host where the VM will be deployed. Can be used instead of ``host_id``. capacity_maintained True to enforce the Host capacity is not over-committed. This parameter is only acknowledged for users in the ``oneadmin`` group. Host capacity will be always enforced for regular users. datastore_id The ID of the target system data-store where the VM will be deployed. Optional and can be used instead of ``datastore_name``. If neither ``datastore_id`` nor ``datastore_name`` are set, OpenNebula will choose the data-store. datastore_name The name of the target system data-store where the VM will be deployed. Optional, and can be used instead of ``datastore_id``. If neither ``datastore_id`` nor ``datastore_name`` are set, OpenNebula will choose the data-store. CLI Example: .. code-block:: bash salt-cloud -a vm_deploy my-vm host_id=0 salt-cloud -a vm_deploy my-vm host_id=1 capacity_maintained=False salt-cloud -a vm_deploy my-vm host_name=host01 datastore_id=1 salt-cloud -a vm_deploy my-vm host_name=host01 datastore_name=default r z8The vm_deploy action must be called with -a or --action.N�host_id� host_name�capacity_maintainedTr� r� �[Both the 'host_id' and 'host_name' arguments were provided. 'host_id' will take precedence.rU r� zLThe vm_deploy function requires a 'host_id' or a 'host_name' to be provided.�jBoth the 'datastore_id' and 'datastore_name' arguments were provided. 'datastore_id' will take precedence.�-1r z vm.deployr r r� )r Zdeployedr r� )r r_ r2 r3 rg rf r r! rx r" r� Zdeployr� r� r� r� r� )rU rQ r( r r r r� r� r) r r r* r r� r� r r r � vm_deployg s^ )� ����� � �r c C � |dkrt d��|du ri }|�dd�}|du r t d��t� \}}}d�||g�}ttd| id��}|jj�||t|��} d | d | d | d d �} | S )a% Detaches a disk from a virtual machine. .. versionadded:: 2016.3.0 name The name of the VM from which to detach the disk. disk_id The ID of the disk to detach. CLI Example: .. code-block:: bash salt-cloud -a vm_detach my-vm disk_id=1 r z8The vm_detach action must be called with -a or --action.N�disk_idz;The vm_detach function requires a 'disk_id' to be provided.r rU r� z vm.detachr r r� )r Zdetachedr r� ) r r_ r r! r� rx r" r� �detach) rU rQ r( r r) r r r* r r� r� r r r � vm_detach� �* � � �r c C r )a3 Detaches a disk from a virtual machine. .. versionadded:: 2016.3.0 name The name of the VM from which to detach the network interface. nic_id The ID of the nic to detach. CLI Example: .. code-block:: bash salt-cloud -a vm_detach_nic my-vm nic_id=1 r z<The vm_detach_nic action must be called with -a or --action.N�nic_idz>The vm_detach_nic function requires a 'nic_id' to be provided.r rU r� z vm.detachnicr r r� )r Z nic_detachedr r� ) r r_ r r! r� rx r" r� Z detachnic) rU rQ r( r r) r r r* r r� r� r r r � vm_detach_nic� r r c C s� |dkrt d��|du ri }|�dd�}|�dd�}|�dd�}t|�dd ��}|du s0|du r4t d ��t� \}}} d �|| g�} ttd | id ��} |jj�| | t|�|||�} d| d | d | d d�} | S )aI Sets the disk to be saved in the given image. .. versionadded:: 2016.3.0 name The name of the VM containing the disk to save. disk_id The ID of the disk to save. image_name The name of the new image where the disk will be saved. image_type The type for the new image. If not set, then the default ``ONED`` Configuration will be used. Other valid types include: OS, CDROM, DATABLOCK, KERNEL, RAMDISK, and CONTEXT. snapshot_id The ID of the snapshot to export. If not set, the current image state will be used. CLI Example: .. code-block:: bash salt-cloud -a vm_disk_save my-vm disk_id=1 image_name=my-new-image salt-cloud -a vm_disk_save my-vm disk_id=1 image_name=my-new-image image_type=CONTEXT snapshot_id=10 r z;The vm_disk_save action must be called with -a or --action.Nr r� � image_type� r� r zRThe vm_disk_save function requires a 'disk_id' and an 'image_name' to be provided.r rU r� z vm.disksaver r r� )r Zsavedr� r� ) r r_ r� r r! rx r" r� Zdisksave)rU rQ r( r r� r! r� r) r r r* r r� r� r r r � vm_disk_save* s4 � � ��r# c C s� |dkrt d��|du ri }|�dd�}|�dd�}|du s"|du r&t d��t� \}}}d�||g�}ttd| id ��} |jj�|| t|�|�} d | d | d | d d�} | S )a� Takes a new snapshot of the disk image. .. versionadded:: 2016.3.0 name The name of the VM of which to take the snapshot. disk_id The ID of the disk to save. description The description for the snapshot. CLI Example: .. code-block:: bash salt-cloud -a vm_disk_snapshot_create my-vm disk_id=0 description="My Snapshot Description" r zFThe vm_disk_snapshot_create action must be called with -a or --action.Nr � descriptionz]The vm_disk_snapshot_create function requires a 'disk_id' and a 'description' to be provided.r rU r� zvm.disksnapshotcreater r r� )r r� r� r� ) r r_ r r! r� rx r" r� Zdisksnapshotcreate) rU rQ r( r r$ r) r r r* r r� r� r r r �vm_disk_snapshot_createm s, � � �r% c C � |dkrt d��|du ri }|�dd�}|�dd�}|du s"|du r&t d��t� \}}}d�||g�}ttd| id ��} |jj�|| t|�t|��} d | d | d | d d�} | S )a� Deletes a disk snapshot based on the given VM and the disk_id. .. versionadded:: 2016.3.0 name The name of the VM containing the snapshot to delete. disk_id The ID of the disk to save. snapshot_id The ID of the snapshot to be deleted. CLI Example: .. code-block:: bash salt-cloud -a vm_disk_snapshot_delete my-vm disk_id=0 snapshot_id=6 r zFThe vm_disk_snapshot_delete action must be called with -a or --action.Nr r� z]The vm_disk_snapshot_create function requires a 'disk_id' and a 'snapshot_id' to be provided.r rU r� zvm.disksnapshotdeleter r r� r� ) r r_ r r! r� rx r" r� Zdisksnapshotdelete� rU rQ r( r r� r) r r r* r r� r� r r r �vm_disk_snapshot_delete� �0 � � ��r( c C r& )a� Reverts a disk state to a previously taken snapshot. .. versionadded:: 2016.3.0 name The name of the VM containing the snapshot. disk_id The ID of the disk to revert its state. snapshot_id The ID of the snapshot to which the snapshot should be reverted. CLI Example: .. code-block:: bash salt-cloud -a vm_disk_snapshot_revert my-vm disk_id=0 snapshot_id=6 r zFThe vm_disk_snapshot_revert action must be called with -a or --action.Nr r� z]The vm_disk_snapshot_revert function requires a 'disk_id' and a 'snapshot_id' to be provided.r rU r� zvm.disksnapshotrevertr r r� r� ) r r_ r r! r� rx r" r� Zdisksnapshotrevertr' r r r �vm_disk_snapshot_revert� r) r* c C s� |dkrt d��t� \}}}d�||g�}ttd| id��}|jj�||�}|d du r0|d S i }t|d �} t | �|| � d �j < |S ) a Retrieves information for a given virtual machine. A VM name must be supplied. .. versionadded:: 2016.3.0 name The name of the VM for which to gather information. CLI Example: .. code-block:: bash salt-cloud -a vm_info my-vm r z6The vm_info action must be called with -a or --action.r rU r� r Fr r ) r r r! r� rx r" r� r# r$ r% r& r' ) rU r( r) r r r* r r� r# r� r r r �vm_info s � r+ c C sB |dkrt d��|du ri }|�dd�}|�dd�}|�dd�}|�dd �}|�d d�}|�d d�}|r<|r;t�d � n|rFtd |id�}nt d��|rT|rSt�d� n|r^td |id�}nt d��t� \} } } d�| | g�} tt d | id��} | j j � | | t|�t jj�|�t jj�|�t|��}d|d |d |d d�}|S )a Migrates the specified virtual machine to the specified target host. .. versionadded:: 2016.3.0 name The name of the VM to migrate. host_id The ID of the host to which the VM will be migrated. Can be used instead of ``host_name``. host_name The name of the host to which the VM will be migrated. Can be used instead of ``host_id``. live_migration If set to ``True``, a live-migration will be performed. Default is ``False``. capacity_maintained True to enforce the Host capacity is not over-committed. This parameter is only acknowledged for users in the ``oneadmin`` group. Host capacity will be always enforced for regular users. datastore_id The target system data-store ID where the VM will be migrated. Can be used instead of ``datastore_name``. datastore_name The name of the data-store target system where the VM will be migrated. Can be used instead of ``datastore_id``. CLI Example: .. code-block:: bash salt-cloud -a vm_migrate my-vm host_id=0 datastore_id=1 salt-cloud -a vm_migrate my-vm host_id=0 datastore_id=1 live_migration=True salt-cloud -a vm_migrate my-vm host_name=host01 datastore_name=default r z9The vm_migrate action must be called with -a or --action.Nr r �live_migrationFr Tr� r� r rU r� z^The vm_migrate function requires either a 'datastore_id' or a 'datastore_name' to be provided.r zTThe vm_migrate function requires either a 'host_id' or a 'host_name' to be provided.r z vm.migrater r r� )r Zmigratedr r� )r r_ r2 r3 rf rg r r! r� rx r" r� Zmigrater� r� r� r� )rU rQ r( r r r, r r� r� r) r r r* r r� r� r r r � vm_migrate2 sf )� ������ � �r- c C s� |dkrt d��t� \}}}d�||g�}ttd| id��}|jj�||�}|d du r3t� d� i S i }t |d �D ] } t | �|| � d �j < q;|S ) a� Returns the monitoring records for a given virtual machine. A VM name must be supplied. The monitoring information returned is a list of VM elements. Each VM element contains the complete dictionary of the VM with the updated information returned by the poll action. .. versionadded:: 2016.3.0 name The name of the VM for which to gather monitoring records. CLI Example: .. code-block:: bash salt-cloud -a vm_monitoring my-vm r z<The vm_monitoring action must be called with -a or --action.r rU r� r FzHThere was an error retrieving the specified VM's monitoring information.r �ID)r r r! r� rx r" r� Z monitoringr2 r� r$ r% r& r' ) rU r( r) r r r* r r� r# rl r r r � vm_monitoring� s" � �r/ c C s |dkrt d��|du ri }|�dd�}|�dd�}|�dd�}|r*|r)t�d� n$|rJtjjj|d d �� }|�� }W d � n1 sDw Y nt d ��t � \}}} d � || g�} t t d | id��} |j j�| | |tjj�|��} d| d | d | d d�} | S )a� Changes the capacity of the virtual machine. .. versionadded:: 2016.3.0 name The name of the VM to resize. path The path to a file containing new capacity elements CPU, VCPU, MEMORY. If one of them is not present, or its value is 0, the VM will not be re-sized. Syntax within the file can be the usual attribute=value or XML. Can be used instead of ``data``. data Contains the new capacity elements CPU, VCPU, and MEMORY. If one of them is not present, or its value is 0, the VM will not be re-sized. Can be used instead of ``path``. capacity_maintained True to enforce the Host capacity is not over-committed. This parameter is only acknowledged for users in the ``oneadmin`` group. Host capacity will be always enforced for regular users. CLI Example: .. code-block:: bash salt-cloud -a vm_resize my-vm path=/path/to/capacity_template.txt salt-cloud -a vm_resize my-vm path=/path/to/capacity_template.txt capacity_maintained=False salt-cloud -a vm_resize my-vm data="CPU=1 VCPU=1 MEMORY=1024" r z8The vm_resize action must be called with -a or --action.Nr� r� r Tr� r� r� zNThe vm_resize function requires either 'data' or a file 'path' to be provided.r rU r� z vm.resizer r r� )r Zresizedr r� )r r_ r2 r3 r� r� r� r� r� r r! r� rx r" r� �resizer� r� )rU rQ r( r� r� r r� r) r r r* r r� rc r r r � vm_resize� sF !� �� ��� ��r1 c C s� |dkrt d��|du ri }|�dd�}|du r t d��t� \}}}d�||g�}ttd| id��}|jj�|||�} d | d | d | d d �} | S )an Creates a new virtual machine snapshot from the provided VM. .. versionadded:: 2016.3.0 vm_name The name of the VM from which to create the snapshot. snapshot_name The name of the snapshot to be created. CLI Example: .. code-block:: bash salt-cloud -a vm_snapshot_create my-vm snapshot_name=my-new-snapshot r zAThe vm_snapshot_create action must be called with -a or --action.N� snapshot_namezJThe vm_snapshot_create function requires a 'snapshot_name' to be provided.r rU r� zvm.snapshotcreater r r� )r Zsnapshot_createdr� r� ) r r_ r r! r� rx r" r� Zsnapshotcreate) r� rQ r( r2 r) r r r* r r� r� r r r �vm_snapshot_create s* � � �r3 c C r )aV Deletes a virtual machine snapshot from the provided VM. .. versionadded:: 2016.3.0 vm_name The name of the VM from which to delete the snapshot. snapshot_id The ID of the snapshot to be deleted. CLI Example: .. code-block:: bash salt-cloud -a vm_snapshot_delete my-vm snapshot_id=8 r zAThe vm_snapshot_delete action must be called with -a or --action.Nr� zHThe vm_snapshot_delete function requires a 'snapshot_id' to be provided.r rU r� zvm.snapshotdeleter r r� )r Zsnapshot_deletedr r� ) r r_ r r! r� rx r" r� r� � r� rQ r( r� r) r r r* r r� r� r r r �vm_snapshot_deleteB r r5 c C r )a Reverts a virtual machine to a snapshot .. versionadded:: 2016.3.0 vm_name The name of the VM to revert. snapshot_id The snapshot ID. CLI Example: .. code-block:: bash salt-cloud -a vm_snapshot_revert my-vm snapshot_id=42 r zAThe vm_snapshot_revert action must be called with -a or --action.Nr� zHThe vm_snapshot_revert function requires a 'snapshot_id' to be provided.r rU r� zvm.snapshotrevertr r r� )r Zsnapshot_revertedr r� ) r r_ r r! r� rx r" r� r� r4 r r r �vm_snapshot_revertq r r6 c C sR |dkrt d��|du ri }|�dd�}|�dd�}|�dd�}ddg}|du r,t d ��||d kr5d }n||d kr>d }n t d �|d |d ���|rT|rSt�d � n$|rttjjj|dd�� }|� � }W d � n1 snw Y nt d��t � \} } } d� | | g�} t t d| id��} | jj�| | |t |��}d|d |d |d d�}|S )a� Replaces the user template contents. .. versionadded:: 2016.3.0 name The name of the VM to update. path The path to a file containing new user template contents. Syntax within the file can be the usual attribute=value or XML. Can be used instead of ``data``. data Contains the new user template contents. Syntax can be the usual attribute=value or XML. Can be used instead of ``path``. update_type There are two ways to update a VM: ``replace`` the whole template or ``merge`` the new template with the existing one. CLI Example: .. code-block:: bash salt-cloud -a vm_update my-vm path=/path/to/user_template_file.txt update_type='replace' r z8The vm_update action must be called with -a or --action.Nr� r� r� r� r� z@The vm_update function requires an 'update_type' to be provided.r r r� r� r� r� zNThe vm_update function requires either 'data' or a file 'path' to be provided.r rU r� z vm.updater� )r r� � resource_idr� )r r_ ra r2 r3 r� r� r� r� r� r r! r� rx r" r� r� )rU rQ r( r� r� r� r� r� r� r) r r r* r r� rc r r r � vm_update� s^ � � ���� ��� �r8 c C �& | dkrt d��|du ri }|�dd�}|�dd�}|�dd�}|�dd�}|r0|r/t�d� n|r:td |id �}nt d ��|rH|rGt�d � n$|rhtjjj|d d�� }|� � }W d � n1 sbw Y nt d��t � \}}} d� || g�} |j j �| t|�|�} d| d | d | d d�} | S )a� Adds address ranges to a given virtual network. .. versionadded:: 2016.3.0 vn_id The ID of the virtual network to add the address range. Can be used instead of ``vn_name``. vn_name The name of the virtual network to add the address range. Can be used instead of ``vn_id``. path The path to a file containing the template of the address range to add. Syntax within the file can be the usual attribute=value or XML. Can be used instead of ``data``. data Contains the template of the address range to add. Syntax can be the usual attribute=value or XML. Can be used instead of ``path``. CLI Example: .. code-block:: bash salt-cloud -f vn_add_ar opennebula vn_id=3 path=/path/to/address_range.txt salt-cloud -f vn_add_ar opennebula vn_name=my-vn \ data="AR=[TYPE=IP4, IP=192.168.0.5, SIZE=10]" rC z<The vn_add_ar function must be called with -f or --function.N�vn_id�vn_namer� r� �UBoth the 'vn_id' and 'vn_name' arguments were provided. 'vn_id' will take precedence.rU r� zIThe vn_add_ar function requires a 'vn_id' and a 'vn_name' to be provided.r� r� r� zNThe vn_add_ar function requires either 'data' or a file 'path' to be provided.r z vn.add_arr r r� )r Zaddress_range_addedr7 r� )r r_ r2 r3 ry r� r� r� r� r� r r! r" �vnZadd_arr� � r( rQ r: r; r� r� r� r) r r r* r� rc r r r � vn_add_ar� sX � ����� ��� �r? c C s" | dkrt d��|du ri }|�dd�}|�dd�}|�dd�}|�dd�}|r0|r/t�d� n$|rPtjjj|d d �� }|�� }W d � n1 sJw Y nt d ��|r^|r]t�d � n |rht d |id�}nd}t � \}}} d� || g�} |j j �| |t|��} d| d | d | d d�} | S )uI Allocates a new virtual network in OpenNebula. .. versionadded:: 2016.3.0 path The path to a file containing the template of the virtual network to allocate. Syntax within the file can be the usual attribute=value or XML. Can be used instead of ``data``. data Contains the template of the virtual network to allocate. Syntax can be the usual attribute=value or XML. Can be used instead of ``path``. cluster_id The ID of the cluster for which to add the new virtual network. Can be used instead of ``cluster_name``. If neither ``cluster_id`` nor ``cluster_name`` are provided, the virtual network won’t be added to any cluster. cluster_name The name of the cluster for which to add the new virtual network. Can be used instead of ``cluster_id``. If neither ``cluster_name`` nor ``cluster_id`` are provided, the virtual network won't be added to any cluster. CLI Example: .. code-block:: bash salt-cloud -f vn_allocate opennebula path=/path/to/vn_file.txt rC z>The vn_allocate function must be called with -f or --function.N� cluster_id� cluster_namer� r� r� r� r� zPThe vn_allocate function requires either 'data' or a file 'path' to be provided.zdBoth the 'cluster_id' and 'cluster_name' arguments were provided. 'cluster_id' will take precedence.rU r� r r z vn.allocater r r� )r r� r: r� )r r_ r2 r3 r� r� r� r� r� rd r r! r" r= r� r� ) r( rQ r@ rA r� r� r� r) r r r* r� rc r r r � vn_allocateL sT � �� ����� �rB c C r� )a� Deletes the given virtual network from OpenNebula. Either a name or a vn_id must be supplied. .. versionadded:: 2016.3.0 name The name of the virtual network to delete. Can be used instead of ``vn_id``. vn_id The ID of the virtual network to delete. Can be used instead of ``name``. CLI Example: .. code-block:: bash salt-cloud -f vn_delete opennebula name=my-virtual-network salt-cloud --function vn_delete opennebula vn_id=3 rC z<The vn_delete function must be called with -f or --function.NrU r: �RBoth the 'vn_id' and 'name' arguments were provided. 'vn_id' will take precedence.r� zEThe vn_delete function requires a 'name' or a 'vn_id' to be provided.r z vn.deleter r r� )r r� r: r� ) r r_ r2 r3 ry r r! r" r= r� r� ) r( rQ rU r: r) r r r* r� r� r r r � vn_delete� s8 � ��� �rD c C r� )aI Frees a reserved address range from a virtual network. .. versionadded:: 2016.3.0 vn_id The ID of the virtual network from which to free an address range. Can be used instead of ``vn_name``. vn_name The name of the virtual network from which to free an address range. Can be used instead of ``vn_id``. ar_id The ID of the address range to free. CLI Example: .. code-block:: bash salt-cloud -f vn_free_ar opennebula vn_id=3 ar_id=1 salt-cloud -f vn_free_ar opennebula vn_name=my-vn ar_id=1 rC z=The vn_free_ar function must be called with -f or --function.Nr: r; �ar_idz;The vn_free_ar function requires an 'rn_id' to be provided.r< rU r� zIThe vn_free_ar function requires a 'vn_id' or a 'vn_name' to be provided.r z vn.free_arr r r� )r Zar_freedr7 r� ) r r_ r2 r3 ry r r! r" r= Zfree_arr� ) r( rQ r: r; rE r) r r r* r� r� r r r � vn_free_ar� sB � ���� �rF c C r9 )at Holds a virtual network lease as used. .. versionadded:: 2016.3.0 vn_id The ID of the virtual network from which to hold the lease. Can be used instead of ``vn_name``. vn_name The name of the virtual network from which to hold the lease. Can be used instead of ``vn_id``. path The path to a file defining the template of the lease to hold. Syntax within the file can be the usual attribute=value or XML. Can be used instead of ``data``. data Contains the template of the lease to hold. Syntax can be the usual attribute=value or XML. Can be used instead of ``path``. CLI Example: .. code-block:: bash salt-cloud -f vn_hold opennebula vn_id=3 path=/path/to/vn_hold_file.txt salt-cloud -f vn_hold opennebula vn_name=my-vn data="LEASES=[IP=192.168.0.5]" rC z:The vn_hold function must be called with -f or --function.Nr: r; r� r� r< rU r� zFThe vn_hold function requires a 'vn_id' or a 'vn_name' to be provided.r� r� r� zGThe vn_hold function requires either 'data' or a 'path' to be provided.r zvn.holdr r r� )r Zheldr7 r� )r r_ r2 r3 ry r� r� r� r� r� r r! r" r= r r� r> r r r �vn_hold �X � ����� ��� �rG c C s� | dkrt d��|du ri }|�dd�}|�dd�}|r$|r#t�d� n|r.td|id�}nt d��t� \}}}d �||g�}|jj� |t |��}|d d u rS|d S i } t |d �} t | �| | � d �j< | S )a� Retrieves information for the virtual network. .. versionadded:: 2016.3.0 name The name of the virtual network for which to gather information. Can be used instead of ``vn_id``. vn_id The ID of the virtual network for which to gather information. Can be used instead of ``name``. CLI Example: .. code-block:: bash salt-cloud -f vn_info opennebula vn_id=3 salt-cloud --function vn_info opennebula name=public rC z:The vn_info function must be called with -f or --function.NrU r: rC r� zJThe vn_info function requires either a 'name' or a 'vn_id' to be provided.r r Fr r )r r_ r2 r3 ry r r! r" r= r# r� r$ r% r& r' ) r( rQ rU r: r) r r r* r� r# r� r r r �vn_infor s8 � ��� rI c C r9 )a� Releases a virtual network lease that was previously on hold. .. versionadded:: 2016.3.0 vn_id The ID of the virtual network from which to release the lease. Can be used instead of ``vn_name``. vn_name The name of the virtual network from which to release the lease. Can be used instead of ``vn_id``. path The path to a file defining the template of the lease to release. Syntax within the file can be the usual attribute=value or XML. Can be used instead of ``data``. data Contains the template defining the lease to release. Syntax can be the usual attribute=value or XML. Can be used instead of ``path``. CLI Example: .. code-block:: bash salt-cloud -f vn_release opennebula vn_id=3 path=/path/to/vn_release_file.txt salt-cloud =f vn_release opennebula vn_name=my-vn data="LEASES=[IP=192.168.0.5]" rC �=The vn_reserve function must be called with -f or --function.Nr: r; r� r� r< rU r� zIThe vn_release function requires a 'vn_id' or a 'vn_name' to be provided.r� r� r� zJThe vn_release function requires either 'data' or a 'path' to be provided.r z vn.releaser r r� )r Zreleasedr7 r� )r r_ r2 r3 ry r� r� r� r� r� r r! r" r= �releaser� r> r r r � vn_release� rH rL c C r9 )a� Reserve network addresses. .. versionadded:: 2016.3.0 vn_id The ID of the virtual network from which to reserve addresses. Can be used instead of vn_name. vn_name The name of the virtual network from which to reserve addresses. Can be used instead of vn_id. path The path to a file defining the template of the address reservation. Syntax within the file can be the usual attribute=value or XML. Can be used instead of ``data``. data Contains the template defining the address reservation. Syntax can be the usual attribute=value or XML. Data provided must be wrapped in double quotes. Can be used instead of ``path``. CLI Example: .. code-block:: bash salt-cloud -f vn_reserve opennebula vn_id=3 path=/path/to/vn_reserve_file.txt salt-cloud -f vn_reserve opennebula vn_name=my-vn data="SIZE=10 AR_ID=8 NETWORK_ID=1" rC rJ Nr: r; r� r� r< rU r� zIThe vn_reserve function requires a 'vn_id' or a 'vn_name' to be provided.r� r� r� z9The vn_reserve function requires a 'path' to be provided.r z vn.reserver r r� )r Zreservedr7 r� )r r_ r2 r3 ry r� r� r� r� r� r r! r" r= Zreserver� r> r r r � vn_reserve sX � ����� ��� �rM c C sX d}|dkr*zt � | W S ty% |d8 }t�d| |� t�d� Y nw |dksi S )z� Helper function that returns all information about a named node. name The name of the node for which to get information. � r r z<Failed to get the data for node '%s'. Remaining attempts: %sg �?)rB r` r2 r� �time�sleep)rU Zattemptsr r r r� X s ���r� c C s: zt �| �}W |S t jy } ztd�| ���d}~ww )zN Intrepret the data coming from opennebula and raise if it's not XML. zopennebula returned: {}N)r ZXMLZXMLSyntaxErrorr ra )Zxml_strZxml_data�errr r r r$ r s ���r$ c C sR t � } tjd| tdd�}tjd| tdd�}tjd| tdd�}tj�|�}|||fS )z� Uses the OpenNebula cloud provider configurations to connect to the OpenNebula API. Returns the server connection created as well as the user and password values from the cloud provider config file used to make the connection. r Frh r r )r r rk r �xmlrpc�clientZ ServerProxy)rl r r r r) r r r r � s �� r c C sb t � \}}}d�||g�}|jj�|dddd�d }i }t|�D ]�}|�d�j}i ||< |�d��d�j} |�d��d�j} g } |�d��d �D ]} z | � | �d �j� W qH t y^ Y qHw |�d �j|| d < d |�d�v r}|�d��d �j|| d< ||| d< | | d�|| d< |�d�j|| d< | || d< g || d< | r�t |�||�d�j< q |S )z� Helper function for the list_* query functions - Constructs the appropriate dictionaries to return from the API query. full If performing a full query, such as in list_nodes_full, change this parameter to ``True``. r r r r r �TEMPLATEZCPUZMEMORYZNICZIPr. r^ Z TEMPLATE_IDr, rU )r� r� r� ZSTATEr� r� r� ) r r! r" Zvmpoolr# r$ r& r' �findallr� r� r% ) r< r) r r r* Zvm_poolZvmsr� rU Zcpu_sizeZ memory_sizer� r� r r r r> � s8 � �r> c C sf i }| D ],}|j �� }d}||v r |t|�7 }|d7 }||v s|jdu r+t|�||< q|j||< q|S )zi Helper function to covert xml into a data dictionary. xml The xml data to convert. r N)�tag�lowerrj r' r% )ZxmlZdicts�item�key�idxr r r r% � s � r% r )NN)F)q�__doc__r� r� r� rO Z salt.configr Zsalt.utils.datar� Zsalt.utils.filesZsalt.exceptionsr r r r r Z xmlrpc.clientrR Zlxmlr r � ImportErrorZ getLogger�__name__r2 r r r r r r- r1 r5 r6 r8 r9 r? rB rE rH rK rL rO rW rX r\ rd rf rg rm rn rq rr ru rv rw rx ry r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r r r r r r r rS r r r r r r r# r% r( r* r+ r- r/ r1 r3 r5 r6 r8 r? rB rD rF rG rI rL rM r� r$ r r> r% r r r r �<module> s� = � " - a ; X D ; : G F D D k @ F < : q B I ; K q A D C C e / / C 5 7 7 " j * M / / / V V T : D T : TX ,
Save