vca-cli

VMware vCloud CLI

These details have not been verified by PyPI

Project links

Homepage

Project description

vca-cli
=======

[![Download Status](https://img.shields.io/pypi/dm/vca-cli.svg)](https://pypi.python.org/pypi/vca-cli) [![Stable Version](https://img.shields.io/pypi/v/vca-cli.svg)](https://pypi.python.org/pypi/vca-cli) [![Build Status](https://img.shields.io/travis/vmware/vca-cli.svg?style=flat)](https://travis-ci.org/vmware/vca-cli/)

NOTE: due to changes in the service, use the --host argument to login on OnDemand:

v c a l o g i n u s e r @ c o m p a n y . c o m - - h o s t v c a . v m w a r e . c o m - - p a s s w o r d

PASS --save-password

Command Line Interface for VMware vCloud Air. It supports vCloud Air On Demand and Subscription. It also supports standalone vCloud Director.

> Release early, release often.

This project is under development, the commands and parameters might change over time. This README usually reflects the syntax of the latest version. See the [documentation](http://vca-cli.readthedocs.org) for a detailed description of each command. More information about commands and usage can be found in the [vca-cli wiki](https://github.com/vmware/vca-cli/wiki). The [networking section](https://github.com/vmware/vca-cli/wiki/Networking) documents all the operations related to networks, edge gateway and network services. See the [release notes](https://github.com/vmware/vca-cli/wiki/ReleaseNotes) for what's new.

`vca-cli` uses [pyvcloud](https://github.com/vmware/pyvcloud "Title"), Python SDK for VMware vCloud.

Installation:
=============

In general, `vca-cli` can be installed with:

p i p i n s t a l l v c a - c l i ‘ v c a - c l i ‘ r e q u i r e s a P y t h o n e n v i r o n m e n t a l r e a d y i n s t a l l e d, i f t h e p r e v i o u s c o m m a n d f a i l s, f o l l o w t h e i n s t r u c t i o n s b e l o w . U b u n t u : - - - - - - - T h e f o l l o w i n g i n s t r u c t i o n s h a v e b e e n t e s t e d w i t h U b u n t u 12.04 :

sudo apt-get update

s u d o a p t - g e t i n s t a l l - y b u i l d - e s s e n t i a l l i b f f i - d e v l i b s s l - d e v l i b x m l 2 - d e v l i b x s l t - d e v p y t h o n - d e v

wget https://bootstrap.pypa.io/get-pip.py

s u d o p y t h o n g e t - p i p . p y

sudo pip install vca-cli

Mac OS X:
---------

On Mac OS X (10.10.3), open a Terminal and enter the commands listed below (skip those that refer to a component already installed on your mac):

Install `Xcode Command Line Tools`:

x c o d e - s e l e c t - - i n s t a l l P r e s s ‘ I n s t a l l ‘ a n d a c c e p t t h e l i c e n s e t e r m s . I n s t a l l ‘ p i p ‘ :

sudo easy_install pip

Install `vca-cli`

s u d o p i p i n s t a l l v c a - c l i V e r i f y I n s t a l l a t i o n : - - - - - - - - - - - - - - - - - - - - D i s p l a y t h e v e r s i o n i n s t a l l e d :

vca --version

vca-cli version 12 (pyvcloud: 13)

Installation with virtualenv:
-----------------------------

It is also possible to install vca-cli in a [virtualenv](http://docs.python-guide.org/en/latest/dev/virtualenvs/).

Upgrade:
--------

To upgrade an existing `vca-cli` install, just run:

p i p i n s t a l l v c a - c l i - - u p g r a d e Y o u m i g h t n e e d t o r u n t h e p r e v i o u s c o m m a n d w i t h ‘ s u d o ‘ (o n U b u n t u, C e n t O S a n d M a c O S) i f n o t u s i n g ‘ v i r t u a l e n v ‘ . P r e - r e l e a s e s : - - - - - - - - - - - - - T h e c o m m a n d s d e s c r i b e d a b o v e i n s t a l l t h e c u r r e n t s t a b l e v e r s i o n o f ‘ v c a - c l i ‘ . T o i n s t a l l a p r e - r e l e a s e v e r s i o n, e n t e r :

pip install vca-cli --pre

And to upgrade a pre-release:

You can't use 'macro parameter character #' in math mode

vca login user@domain.com --password ******** --save-password

# same as:

You can't use 'macro parameter character #' in math mode

vca login user@domain.com --password ******** --save-password \
--host vchs.vmware.com --type subscription --version 5.6

# vCloud Director Standalone

You can't use 'macro parameter character #' in math mode

vca login user@domain.com --password ******** --save-password \
--host vcdhost.domain.com --org myorg --type standalone --version 5.6 \
--insecure

vCloud Air On Demand, login to a specific instance and get the details of the instance (organization):

v c a l o g i n u s e r @ d o m a i n . c o m - - p a s s w o r d * * * * * * * * L o g i n s u c c e s s f u l f o r p r o f i l e^{'} d e f a u l t^{'}

vca instance
Available instances for user 'email@company.com' in 'default' profile:
| Instance Id | Region | Plan Id |
|--------------------------------------+-----------------------------------+--------------------------------------|
| fbf278f0-065d-4028-96d4-6ece56789751 | us-virginia-1-4.vchs.vmware.com | feda2919-32cb-4efd-a4e5-c5953733df33 |
| c40ba6b4-c158-49fb-b164-5c66f90344fa | us-california-1-3.vchs.vmware.com | 41400e74-4445-49ef-90a4-98da4ccfb16c |
| 7d275413-bc0b-4bbf-8c7b-b9522777beec | uk-slough-1-6.vchs.vmware.com | 62155213-e5fc-448d-a46a-770c57c5dd31 |

v c a l o g i n u s e r @ d o m a i n . c o m - - p a s s w o r d * * * * * * * * - - i n s t a n c e c 40 b a 6 b 4 - c 158 - 49 f b - b 164 - 5 c 66 f 90344 f a L o g i n s u c c e s s f u l f o r p r o f i l e^{'} d e f a u l t^{'}

vca org info
Details for org 'a6545fcb-d68a-489f-afff-2ea055104cc1':
| Type | Name |
|------------+------------------------|
| catalog | Public Catalog |
| catalog | default-catalog |
| orgNetwork | default-routed-network |
| orgNetwork | default-routed-network |
| vdc | VDC1 |
| vdc | VDC2 |

Connection status:

v c a s t a t u s S t a t u s : | P r o p e r t y | V a l u e | | - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | | g a t e w a y | | | h o s t | h t t p s : / / i a m . v c h s . v m w a r e . c o m | | h o s t_{s} c o r e | h t t p s : / / s c o r e . v c a . i o | | i n s t a n c e | d 7 a 623 d e - 1183 - 46 a 9 - 9 b 02 - 9043 c a 68 f 441 | | o r g | | | o r g_{u} r l | h t t p s : / / u s - v i r g i n i a - 1 - 4. v c h s . v m w a r e . c o m / a p i / c o m p u t . . | | p a s s w o r d | < e n c r y p t e d > | | p y v c l o u d_{v} e r s i o n | 13 r c 14 | | s e r v i c e | 85 - 719 | | s e r v i c e_{t} y p e | o n d e m a n d | | s e r v i c e_{v} e r s i o n | 5.7 | | s e s s i o n | a c t i v e | | s e s s i o n_{t} o k e n | 523823 d 5754 f 43 a d 85 c b b 72333 e 8343 b | | s e s s i o n_{u} r i | h t t p s : / / u s - v i r g i n i a - 1 - 4. v c h s . v m w a r e . c o m / a p i / c o m p u t . . | | t o k e n | e y J h b G c i O i J S U z I 1 N i J 9. e y J q d G k i O i I 2 M z V l Z G Q 4 N i 1 i M T N h L . . | | u s e r | v c a_{s} a s_{o} d a @ v m w a r e . c o m | | v c a_{c} l i_{v} e r s i o n | 12 r c 9 | | v d c | v d c - t m p | | v e r i f y | T r u e | L o g o u t :

vca logout
Logout successful for profile 'default'

Examples and Help:
------------------

`vca-cli` provides a list of examples with the `example` command:

Misplaced &

T M P D I R / p y v c l o u d . l o g | v c a - - d e b u g v m | | 82 | s h o w v e r s i o n | v c a - - v e r s i o n | | 83 | s h o w h e l p | v c a - - h e l p | | 84 | s h o w c o m m a n d h e l p | v c a < c o m m a n d > - - h e l p | S y n t a x, c o m m a n d s a n d a r g u m e n t s :

vca --help
Usage: vca [OPTIONS] COMMAND [ARGS]...

VMware vCloud Air Command Line Interface.

Options:
-p, --profile <profile> Profile id
-v, --version Show version
-d, --debug Enable debug
-j, --json Results as JSON object
-x, --xml Results as XML document
-i, --insecure Perform insecure SSL connections
-h, --help Show this message and exit.

Commands:
bp Operations with Blueprints
catalog Operations with Catalogs
dep Operations with Deployments
dhcp Operations with Edge Gateway DHCP Service
example vCloud Air CLI Examples
firewall Operations with Edge Gateway Firewall Rules
gateway Operations with Edge Gateway
instance Operations with Instances
login Login to a vCloud service
logout Logout from a vCloud service
nat Operations with Edge Gateway NAT Rules
network Operations with Networks
org Operations with Organizations
plan Operations with Instances
status Show current status
vapp Operations with vApps
vdc Operations with Virtual Data Centers (vdc)
vm Operations with Virtual Machines (VMs)
vpn Operations with Edge Gateway VPN

Detailed syntax for a specific command:

$ vca vapp --help
Usage: vca vapp [OPTIONS] [list | info | create | delete | power.on |
power.off | deploy | undeploy | customize |
insert | eject]

Operations with vApps

Options:
-v, --vdc <vdc> Virtual Data Center Id
-a, --vapp <vapp> vApp name
-c, --catalog <catalog> catalog name
-t, --template <template> template name
-n, --network <network> Network name
-m, --mode [POOL, DHCP] Network connection mode
-V, --vm <vm> VM name
-f, --file <customization_file>
Guest OS Customization script file
-e, --media <media> virtual media name (ISO)
-h, --help Show this message and exit.

Algorithm	Hash digest
SHA256	`9c5f384f6f6102a8682a083bc3096eef8ccd968cf987c838d3c1da89f2f317b6`
MD5	`3818f742144973f3f07ffcc3e27247e3`
BLAKE2b-256	`139c982b60c53cbfcd289936d79b14a1634d76744080b2f217e7411a61e7e91c`

vca-cli 14

Navigation

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Project description

Project details

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Release history Release notifications | RSS feed

Download files

Source Distribution

File details

File metadata

File hashes