{ "info": { "author": "Ryan Gard", "author_email": "ryan.gard@puppetlabs.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: End Users/Desktop", "License :: OSI Approved :: Apache Software License", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Topic :: Utilities" ], "description": "vmpooler\\_client.py\n===================\n\n| The \u201cvmpooler\\_client.py\u201d script provides the ability to manage\n vmpooler\n| resources in the vcloud. Currently the script supports grabbing\n| a new VM for testing and handing a VM back to the pooler to be\n| destroyed.\n\nTo get help on the command-line for the script use the command:\n\n::\n\n vmpooler_client_app.py -h\n\nQuickstart\n~~~~~~~~~~\n\n::\n\n # Create a token (only on first run)\n $ ./vmpooler_client_app.py token create\n Please provide LDAP credentials for the VM pooler\n\n Username: bob.smith\n Password:\n\n Token: \n\n # List available templates\n $ ./vmpooler_client_app.py vm list redhat\n redhat-4-x86_64\n redhat-5-i386\n redhat-5-x86_64\n redhat-6-i386\n redhat-6-x86_64\n redhat-7-x86_64\n\n # Grab a VM\n $ ./vmpooler_client_app.py vm get redhat-6-x86_64\n Hostname: h2qbe7c29ix2w1r\n\n # Login and do work\n $ ssh root@h2qbe7c29ix2w1r\n\n # Logout\n\n # Give vm back to the pool\n $ ./vmpooler_client_app.py vm destroy h2qbe7c29ix2w1r\n\nExamples\n~~~~~~~~\n\n``vmpooler_client_app.py`` is separated into a few subcommands:\n\n::\n\n vmpooler_client_app.py\n * vm\n * list\n * get\n * destroy\n * destroy_all\n * info\n * running\n * lifetime\n * get\n * extend\n * set\n * token\n * create\n * validate\n * revoke\n * config\n * get\n * set\n * list\n * unset\n\nHelp is available for each subcommand by appending ``-h`` to the\ncommand:\n\n::\n\n vmpooler_client_app.py lifetime set -h\n\nList vmpooler templates\n^^^^^^^^^^^^^^^^^^^^^^^\n\nThis will list all the available templates.\n\n**Usage**\n\n::\n\n vmpooler_client_app.py vm list\n\nFilter the list vmpooler templates\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nFilter available templates via a fuzzy matching pattern.\n\n**Usage**\n\n::\n\n vmpooler_client_app.py vm list PATTERN\n\n**Example**\n\n::\n\n vmpooler_client_app.py vm list win\n\nGet a VM from the vmpooler\n^^^^^^^^^^^^^^^^^^^^^^^^^^\n\n| It is required that you know what the template names are for the\n| vmpooler.\n\n**Usage**\n\n::\n\n vmpooler_client_app.py vm get TEMPLATE_NAME\n\n**Example**\n\n::\n\n vmpooler_client_app.py vm get ubuntu-1404-x86_64\n\nList all of your running VMs\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis gives you a concise list of what VMs you have running\n\n**Usage**\n\n::\n\n vmpooler_client_app.py vm running\n\n**Example Output**\n\n::\n\n l2l7jdlpt6xlptq | Running: 4.27 hours | centos-6-i386\n etcgjzxks2vtw9t | Running: 0.15 hours | centos-5-i386\n\nHand a VM back to the vmpooler for destruction\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\n| It is required that you know what the hostname is for the VM you want\n to\n| destroy.\n\n**Usage**\n\n::\n\n vmpooler_client_app.py vm destroy VM_NAME\n\n**Example**\n\n::\n\n vmpooler_client_app.py vm destroy skj3k4hahdk\n\nHand all active VMs back to the vmpooler for destruction\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nBe careful, this will destroy every active VM associate with your token\n\n**Usage**\n\n::\n\n vmpooler_client_app.py vm destroy_all\n\n**Example Output**\n\n::\n\n Destroying etcgjzxks2vtw9t\n Destroying l2l7jdlpt6xlptq\n\nGet the time to live for a VM in the vmpooler\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\n**Usage**\n\n::\n\n vmpooler_client_app.py lifetime get VM_NAME\n\n**Example**\n\n::\n\n vmpooler_client_app.py lifetime get skj3k4hahdk\n\nExtend the time to live for a VM in the vmpooler\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis command will add a certain number of hours to the lifetime of a VM\n**Usage**\n\n::\n\n vmpooler_client_app.py lifetime extend VM_NAME LIFETIME\n\n**Example**\n\n::\n\n vmpooler_client_app.py lifetime extend skj3k4hahdk 2\n > Lifetime extended to 10 hours\n\nSet the total time to live for a VM in the vmpooler to a certain number of hours\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis command will overwrite the time to live for a VM\n\n**Usage**\n\n::\n\n vmpooler_client_app.py lifetime set VM_NAME LIFETIME\n\n**Example**\n\n::\n\n vmpooler_client_app.py lifetime set skj3k4hahdk 24\n\nGet information on a VM in the vmpooler\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis will work on running and destroyed VMs in the vmpooler.\n\n**Usage**\n\n::\n\n vmpooler_client_app.py vm info VM_NAME\n\n**Example**\n\n::\n\n vmpooler_client_app.py vm info skj3k4hahdk\n\nCreate an authorization token for use with the vmpooler\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nWARNING! Know what you\u2019re doing before using this function!\n\n**Usage**\n\n::\n\n vmpooler_client_app.py token create\n\nRevoke an authorization token\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nWARNING! Know what you\u2019re doing before using this function!\n\n**Usage**\n\n::\n\n vmpooler_client_app.py token revoke TOKEN\n\n**Example**\n\n::\n\n vmpooler_client_app.py token revoke sfn3h65earxah6ar9aal3oac2pfx9817\n\nVerify that an authorization token is valid\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nWARNING! Know what you\u2019re doing before using this function!\n\n**Usage**\n\n::\n\n vmpooler_client_app.py token validate TOKEN\n\n**Example**\n\n::\n\n vmpooler_client_app.py token validate sfn3h65earxah6ar9aal3oac2pfx9817\n\nRead a config setting\n^^^^^^^^^^^^^^^^^^^^^\n\n**Usage**\n\n::\n\n vmpooler_client_app.py config get SETTING_NAME\n\n**Example**\n\n::\n\n vmpooler_client_app.py config get username\n\nModify/create a config setting\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nModify an existing setting or create add a new setting if it doesn\u2019t\nexist yet.\n\n**Usage**\n\n::\n\n vmpooler_client_app.py config set SETTING_NAME VALUE\n\n**Examples**\n\n::\n\n vmpooler_client_app.py config set username bob.smith\n vmpooler_client_app.py config set a_new_setting some_value\n\nRemove a config setting\n^^^^^^^^^^^^^^^^^^^^^^^\n\n**Usage**\n\n::\n\n vmpooler_client_app.py config unset SETTING_NAME\n\n**Example**\n\n::\n\n vmpooler_client_app.py config unset auth_token\n\nList all config settings\n^^^^^^^^^^^^^^^^^^^^^^^^\n\n| Print all the settings in the config file\n| **Usage**\n\n::\n\n vmpooler_client_app.py config list", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/puppetlabs/vmpooler-client", "keywords": null, "license": "UNKNOWN", "maintainer": null, "maintainer_email": null, "name": "vmpooler-client", "package_url": "https://pypi.org/project/vmpooler-client/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/vmpooler-client/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/puppetlabs/vmpooler-client" }, "release_url": "https://pypi.org/project/vmpooler-client/3.1.0/", "requires_dist": null, "requires_python": null, "summary": "Manage resources in the vmpooler service from the command-line.", "version": "3.1.0" }, "last_serial": 1963581, "releases": { "3.1.0": [ { "comment_text": "", "digests": { "md5": "c9443c512633349f3f10301deb0d07f4", "sha256": "9da161f316f5447d075b13a5c38946419527b11c2e574858233fc68ce5875890" }, "downloads": -1, "filename": "vmpooler_client-3.1.0-py2-none-any.whl", "has_sig": false, "md5_digest": "c9443c512633349f3f10301deb0d07f4", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 21175, "upload_time": "2016-02-18T17:41:07", "url": "https://files.pythonhosted.org/packages/33/d4/5f70916c841a69dfcf1c4af14a4c29cfe13044278a223bf99cb02b2219e9/vmpooler_client-3.1.0-py2-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "c9443c512633349f3f10301deb0d07f4", "sha256": "9da161f316f5447d075b13a5c38946419527b11c2e574858233fc68ce5875890" }, "downloads": -1, "filename": "vmpooler_client-3.1.0-py2-none-any.whl", "has_sig": false, "md5_digest": "c9443c512633349f3f10301deb0d07f4", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 21175, "upload_time": "2016-02-18T17:41:07", "url": "https://files.pythonhosted.org/packages/33/d4/5f70916c841a69dfcf1c4af14a4c29cfe13044278a223bf99cb02b2219e9/vmpooler_client-3.1.0-py2-none-any.whl" } ] }