Deleting a mailbox fails with TypeError: delete() takes exactly 4 arguments (3 given):

$ gandi mail delete --help
Usage: gandi mail [OPTIONS] [email protected]

  Delete a mailbox.

Options:
  -f, --force  This is a dangerous option that will cause CLI to continue
               without prompting. (default=False).
  --help       Show this message and exit.

$ gandi mail delete [email protected]
Traceback (most recent call last):
  File "/usr/local/bin/gandi", line 9, in <module>
    load_entry_point('gandi.cli==0.11', 'console_scripts', 'gandi')()
  File "/usr/local/Cellar/python/2.7.8/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/gandi/cli/__main__.py", line 8, in main
    cli(obj={})
  File "/usr/local/lib/python2.7/site-packages/click/core.py", line 610, in __call__
    return self.main(*args, **kwargs)
  File "/usr/local/lib/python2.7/site-packages/click/core.py", line 590, in main
    rv = self.invoke(ctx)
  File "/usr/local/Cellar/python/2.7.8/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/gandi/cli/core/cli.py", line 168, in invoke
    click.Group.invoke(self, ctx)
  File "/usr/local/lib/python2.7/site-packages/click/core.py", line 936, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/usr/local/lib/python2.7/site-packages/click/core.py", line 782, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/usr/local/lib/python2.7/site-packages/click/core.py", line 416, in invoke
    return callback(*args, **kwargs)
  File "/usr/local/lib/python2.7/site-packages/click/decorators.py", line 64, in new_func
    return ctx.invoke(f, obj, *args[1:], **kwargs)
  File "/usr/local/lib/python2.7/site-packages/click/core.py", line 416, in invoke
    return callback(*args, **kwargs)
TypeError: delete() takes exactly 4 arguments (3 given)

Maybe a parsing issue in def delete?

The Debian package builds cleanly on a Debian 7 but depends on 2 non-existing Debian packages:

• python-click
• python-yaml

Theses dependencies do not exist on my Debian 7 installation.

Regards

When executing the following:

gandi webacc delete --backend 2001:4b98:dc2:43:216:3eff:fe2c:xxxx --port 80

I encountered the following error:

Traceback (most recent call last):
  File "/home/julien/Projects/gandi/15-ans/venv/bin/gandi", line 9, in <module>
    load_entry_point('gandi.cli==0.12', 'console_scripts', 'gandi')()
  File "/home/julien/Projects/gandi/15-ans/venv/local/lib/python2.7/site-packages/gandi.cli-0.12-py2.7.egg/gandi/cli/__main__.py", line 8, in main
    cli(obj={})
  File "/home/julien/Projects/gandi/15-ans/venv/local/lib/python2.7/site-packages/click-3.3-py2.7.egg/click/core.py", line 610, in __call__
    return self.main(*args, **kwargs)
  File "/home/julien/Projects/gandi/15-ans/venv/local/lib/python2.7/site-packages/click-3.3-py2.7.egg/click/core.py", line 590, in main
    rv = self.invoke(ctx)
  File "/home/julien/Projects/gandi/15-ans/venv/local/lib/python2.7/site-packages/gandi.cli-0.12-py2.7.egg/gandi/cli/core/cli.py", line 168, in invoke
    click.Group.invoke(self, ctx)
  File "/home/julien/Projects/gandi/15-ans/venv/local/lib/python2.7/site-packages/click-3.3-py2.7.egg/click/core.py", line 936, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/home/julien/Projects/gandi/15-ans/venv/local/lib/python2.7/site-packages/click-3.3-py2.7.egg/click/core.py", line 782, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/home/julien/Projects/gandi/15-ans/venv/local/lib/python2.7/site-packages/click-3.3-py2.7.egg/click/core.py", line 416, in invoke
    return callback(*args, **kwargs)
  File "/home/julien/Projects/gandi/15-ans/venv/local/lib/python2.7/site-packages/click-3.3-py2.7.egg/click/decorators.py", line 64, in new_func
    return ctx.invoke(f, obj, *args[1:], **kwargs)
  File "/home/julien/Projects/gandi/15-ans/venv/local/lib/python2.7/site-packages/click-3.3-py2.7.egg/click/core.py", line 416, in invoke
    return callback(*args, **kwargs)
  File "/home/julien/Projects/gandi/15-ans/venv/local/lib/python2.7/site-packages/gandi.cli-0.12-py2.7.egg/gandi/cli/commands/webacc.py", line 183, in delete
    result = gandi.webacc.backend_remove(backend)
  File "/home/julien/Projects/gandi/15-ans/venv/local/lib/python2.7/site-packages/gandi.cli-0.12-py2.7.egg/gandi/cli/modules/webacc.py", line 131, in backend_remove
    (backend['ip'], backend['port']))
KeyError: 'port'

I have been testing this project. When I create a custom VM, I can´t select a custom image for my new server. Could be possible include this option?

I get an error after running:

$ apt-get install python-pip
$ pip install virtualenv
$ git clone https://github.com/Gandi/gandi.cli.git
$ virtualenv gandi.cli
$ pip install gandi.cli

The error is:

    x86_64-linux-gnu-gcc -pthread -fno-strict-aliasing -DNDEBUG -g -fwrapv -O2 -Wall -Wstrict-prototypes -fPIC -I/usr/include/python2.7 -c ext/_yaml.c -o build/temp.linux-x86_64-2.7/ext/_yaml.o
    ext/_yaml.c:8:22: fatal error: pyconfig.h: No such file or directory
     #include "pyconfig.h"
                        ^
    compilation terminated.

This needs an API first since the network interfaces creation API don't seem to have the reverse parameter.

Being able to set it at VM creation would be great!

The values in ~/.config/gandi/config.yaml get overwritten (without warning) every time a command such as gandi create vm is run.
It should be possible to specify a custom config file when running such commands, to prevent unexpected changes to config.yaml and to allow easier context switching.

A better way might be, for example:

• gandi create vm --config docker should look for ~/.config/gandi/docker.yaml, or
• gandi create vm --config ~/path/to/test.yaml.

Homebrew is the most popular method for cli installations on OS X. Presumably a large chunk of your customers use OS X. A formula would be an awesome addition to gandi-cli. ⛄ \

https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Formula-Cookbook.md#formula-cookbook

It would be useful to have a method in the ip namespace to set the reverse of a public IPv6 or IPv4.
Something like:

gandi ip update --reverse ns.chausette.org 1.2.3.4

As reverse name is the only element to modify in the ip object, the update method should have only one options (aside the mandatory --help).

$gandi vm ssh <resource> currently uses the root user by default.

It would be nice to have an option to choose what user to login with, such as -u <username> or similar.

WDYT?

The list method for ip allow user to get the reverse name with the option --reverse, but the info method does not provide the information. I think the info output should have the the reverse name:

$ gandi ip info 1.2.3.4
ip         : 1.2.3.4
reverse    : ns.chaussette.org <---
state      : created
type       : public
vm         : server01
datacenter : LU

I tried to attach a disk to a VM and as the VM was in a bad state, the operation failed with the step error.

$ gandi disk attach sys_1425568864 myvm
Are you sure to attach disk 'sys_1425568864' to vm 'myvm' [y/N]: y
Attaching your disk(s).
Progress: [##############################################-----------------------] 66.67%  
00:00:19  Usage: gandi disk [OPTIONS] DISK VM

Error: step ERROR unknown, exiting

We should avoid printing a usage message in case of an operation in error.

More information:

$ cat /etc/debian_version 
8.0

$ gandi --version
Gandi CLI 0.12

$ dpkg -l gandicli
||/ Name                   Version          Architecture     Description
ii  gandicli               0.12             all              commandline client for Gandi.net

We're currently unable to change a VM maximum memory limit

Meaning that creating a VM with the default 256Mib, we're unable to change it's memory past 2048Mib

We need:

• an option to change the vm_max_memory
• probably a interactive warning stating that this will reboot the VM (are you sure?)
• probably an automatic option to upgrade it when updating memory beyond the current vm_max_memory

While automatically connecting to the vm may seem useful for some use cases, one may want to execute some more commands before connecting (eg. creating and attaching some disks, adding zone entries…).

The connection should be optional or a parameter exposed to disable the automatic connection.

$ gandi paas create --name squirrels --type phpmysql --vhosts squirrels.gandi.xyz
Password:
Repeat for confirmation:
Creating your PaaS instance.
Progress: [############################################################################] 100.00%  00:01:38
Your PaaS instance squirrels has been created.
Cloning into 'squirrels.gandi.xyz'...
fatal: repository not found
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.
An error has occured during git clone of instance.

gandi paas --help says --vhosts is supposed to be followed by a "List* of virtual hosts to be linked to the instance" so I don't know what a git error is doing there.

• it wants a list, but the help text says --vhosts TEXT so it's not clear if the expected input is www.example.com or "www.example.com or ["www.example.com"] or "[www.example.com]" or what. I tried each of those formats and got the same error each time (the instance is still created, however).

I think this CLI is a great way to increase your popularity among developers and tech-savvy people.

• Add documentation on support for certificates (I didn't think it existed at first).
• For extra usefulness, add a friendly, optional wrapper around the openssl command. So that a single command could generate the key (or use existing), create csr and order a certificate. All with a sane interface.

Updated to reflect support for certificates, at first I didn't know support existed (thanks soulshake).

We don't currently acknowledge contributors to the Gandi CLI. We should.
We could do this automatically, see node-contributors or generate-authors.sh, for example.

My fault. While moving to click, did not realize we need to call the docker client this way:
gandi docker -- run -i -t debian bash

To avoid click option parsing errors.
Still unclear to me if we have a clean way to support this with click while still understanding --vm, but if not I should at least update the documentation.

TL;DR: add a param position in gandi disk attach which could be used in the hosting.vm.disk_attach API method.

The public API documentation for the option of the hosting.vm.disk_attach optional dict:
http://doc.rpc.gandi.net/hosting/reference_vm.html#VMDiskAttachOptions

Use case:
As a IaaS user, I am using a virtual machine and need to use another system disk (aka virtual disk with an associated kernel). I need to detach the current system disk and then attach the new disk to the VM. The new disk need to be attached in position 0 or I will need to rewrite the kernel boot param.

On my computer, the current help is:

$ gandi disk attach --help
Usage: gandi disk [OPTIONS] DISK VM

  Attach disk to vm.

  disk can be a disk name, or ID vm can be a vm name, or ID

Options:
  --bg, --background  Run command in background mode (default=False).
  -f, --force         This is a dangerous option that will cause CLI to
                      continue without prompting. (default=False).
  --help              Show this message and exit.

We could add a -p --position value : On which position do you want to attach the disk to the VM.

Bonus point if we could have the access method as a parameter of gandi disk attach also. Something like : -a --access ro|rw : Access method to the disk, ro is for read-only, rw is for read and write.

Context:

$ gandi --version
Gandi CLI 0.12

$ cat /etc/debian_version 
8.0

$ dpkg -l gandicli
||/ Name                   Version          Architecture
ii  gandicli               0.12             all

gandi vm create allows to pass a script with --script.

Being also able to also pass parameters to that script would be very handy for automatic provisioning with pre-existing bootstrap scripts requiring parameters (amongst other use cases).

My use case: https://github.com/saltstack/salt-bootstrap

I just fell in love with your great API but when i wanted to add my newly created VM to my vlan... i didn't find a way :(

Problems with gandi domain create:

• Warning: Invoked legacy parameter callback message should not appear
• Should exit cleanly if domain is not available

$ gandi domain create
Domain: squirrel.li
/usr/local/lib/python2.7/site-packages/click/core.py:767: Warning: Invoked legacy parameter callback "<function check_domain_available at 0x102282b18>".  The new signature for such callbacks starting with click 2.0 is (ctx, param, value).
  value, args = param.handle_parse_result(ctx, opts, args)
squirrel.li is not available
Duration [1]:
Usage: gandi domain [OPTIONS]

Error: Gandi API has returned an error: <Fault 150000: 'Error on object : OBJECT_APPLICATION (CAUSE_UNKNOWN) [Internal Server Error]'>

Hi,

I installed gandi.cli with pip and virtualenv on Mac OS X Yosemite (Beta 4). Then, i run through setup configuring, ote and production API Key.

Unfortunately, i got a "No configuration found" when i try to execute a cli command (i.e. gandi vm create)

Could you please help?
Thanks
Jérôme.

I have created a new vhost on a paas instance and choose --alter-zone to overide and activate my zone file. I want to start working on my website but I don't found the host to indicate in /etc/hosts with paas info and vhost info as it's the case for 'console' or 'git_server'.

It seems that the Gandi API don't give this information in api.paas.info, 'api.paas.list,api.paas.vhost.listorapi.paas.vhost.info`.

I suggest that config.yaml (which contains the API key) should be created without read access for the world, whatever the user umask is. Yes, the directory is protected but I prefer to have belts and suspenders.

I really like the short form of vm create - especially for my quick-vm-needs.
however, I believe we should refine the default value overriding/saving methods.

My default datacenter is set to US for latency reasons. If I need a temporary LU vm, I'll use the --datacenter switch. I'll probably forget to switch it back to US the next time.

I'd suggest:

• continue saving a default value for some parameters when they do not have one
• stop overriding default values, if the customer uses a --switch it is probably an exception
• maybe adding a --save switch, or providing a more friendly gandi config command (especially to output current default values)

Hi,

Just a question - do you plan to add SSL certificate management to the toolkit? Would be quite helpful!

summary

I would like a new parameter to gandi vm list command to get only the subset of VM running in a specific datacenter. Same thing for the gandi disk list.

current command

$ gandi vm list --help
Usage: gandi vm [OPTIONS]

  List virtual machines.

Options:
  --state TEXT     Filter results by state.
  --id             Display ids.
  --limit INTEGER  Limit number of results.  [default: 100]
  --help           Show this message and exit.

possible solution

$ gandi vm list --help
Usage: gandi vm [OPTIONS]

  List virtual machines.

Options:
  --state TEXT     Filter results by state.
  --id             Display ids.
  --limit INTEGER  Limit number of results.  [default: 100]
  --datacenter [FR|US|LU]  Filter by datacenter.
  --help           Show this message and exit.

more information

$ cat /etc/debian_version 
8.0

$ gandi --version
Gandi CLI 0.12

$ dpkg -l gandicli
||/ Name                   Version          Architecture     Description
ii  gandicli               0.12             all              commandline client for Gandi.net

https://github.com/Gandi/gandi.cli/search?utf8=%E2%9C%93&q=have+been+created

In all the above search results, the correct syntax would be has been created.

In the 'disk' namespace, the info method does not show the potential kernel which could be associated with the virtual disk. Could we add it ?

$ gandi disk update --kernel "3.10-x86_64" sys_chaussette
Updating your disk.
Progress: [#############################] 100.00% 00:00:16

$ gandi disk info sys_chaussette
name : sys_chaussette
state : created
size : 3072
type : data
id : 1988888999999999
datacenter: FR
vm : chaussette

When creating VMs with --script option, the script is only copied to its expected location on the VM (/var/tmp/gscript) if the --background option is not present.

When $ gandi vm create is ran without a password, we get this message:

/!\ Please be aware that you did not provide a password, some services like console will not be able to work.

It might be nicer instead to display the VM's config and other details such as:

• root and admin users will be created
• SSH key authorization will be used
• No password was supplied (Warning: emergency console access from the web interface is disabled)

WDYT?

System

OS OSX 10.10 (14A343f)
Python 2.7.6 system
Easy Install 3.6
Virtualenv 1.11.6
pip pip 1.5.6 from /Users/thibault/gandi/gandi.cli/lib/python2.7/site-packages (python 2.7)

Error

when I try to run the command pip install gandi.cli I got this output

Command /Users/thibault/gandi/gandi.cli/bin/python -c "import setuptools, tokenize;__file__='/Users/thibault/gandi/gandi.cli/build/pyyaml/setup.py';exec(compile(getattr(tokenize, 'open', open)(__file__).read().replace('\r\n', '\n'), __file__, 'exec'))" install --record /var/folders/w4/xvgx5h5523j0sbjf17pfm4h00000gn/T/pip-jo4QW4-record/install-record.txt --single-version-externally-managed --compile --install-headers /Users/thibault/gandi/gandi.cli/include/site/python2.7 failed with error code 1 in /Users/thibault/gandi/gandi.cli/build/pyyaml
Storing debug log for failure in /Users/thibault/.pip/pip.log

Log file

complete terminal outpout
pip.log

This applies to all namespaces with some info command (gandi vm info, gandi paas info, etc).

It would be very useful if users could 1) request only specific elements, and/or 2) get output in a structured format.

1) request only specific elements

Currently, I can only do this:

gandi paas info shine
name      : shine
type      : pythonmysql
size      : s
console   : [email protected]
ftp_server: sftp.dc1.gpaas.net
git_server: git.dc1.gpaas.net
vhost     : f75eccb375.test-url.ws
vhost     : shine.soulshake.net
datacenter: US

and I would like to be able to do something like this:

$ gandi paas info shine --vhost
vhost     : f75eccb375.test-url.ws
vhost     : shine.soulshake.net

2) get output in a structured format:

Currently, the output of a gandi vm info command, for example:

$ gandi vm info irc
hostname      : irc
state         : running
cores         : 1
memory        : 256
console       : 1
datacenter    : US
bandwidth     : 102400.0
ip4           : 173.246.105.94
ip6           : 2604:3400:dc1:43:216:3eff:febb:3cc0

label         : Ubuntu 14.04 64 bits
kernel_version: 3.10-x86_64
name          : sys_irc
size          : 3072

If I want to use the CLI in my scripts, I currently need to do some grep/cut/sed acrobatics, e.g.:
$ gandi vm info $vm_hostname | grep ^ip4 | cut -d: -f2 | sed "s/^ //"

It would be great if users could easily get this output into a Python dict (something like gandi vm info irc --json?), for example.

My dream is to be able to easily do things like this:

print(irc_info['ip4'])
173.246.105.94

This will require checking issue #22 for a coherent interface
There's a little work to do for a clean interaction between commands/(vm,disk), modules, and dependencies.

Running gandi deploy invokes a git clone of the vhost you're trying to deploy (if it's not initialized, at least).

Hi

Currently, we can only add a new DNS record. Being able to remove and update them would permit to easily and dynamically manage an entry, like for a laptop. Is it planned ?

gandi record delete domain.tld results in a blank zone file. Not really what I wanted to do.

A confirmation would have been nice !

Playing with the certificate command, I just spent €10 to buy a certificate for pouet.com

While it's not very disturbing for a temporary VM (a few cents if you delete it immediately) I believe we should add confirmation messages for higher cost operations. Pricing information would be a must but might be a little more difficult to implement right now.

In some OS images, the SSH server is setup to only allow root connection with SSH public key. When a user create a VM (gandi vm create ...) without SSH public key but with a login, the root account is setup with this password, but the user cannot connect to the VM using SSH. Moreover the gandi vm create ... command cannot automatically SSH to the VM.

If the user use the --login and no --sshkey params in the CLI command, we could try to auto-SSH the VM after the creation of the VM with the login as parameter instead of using 'root' in all cases.

I'm packaging gandi.cli for Arch Linux (https://aur.archlinux.org/packages/gandi.cli/).

Why does it depend on click <=3.1?
It seems to work fine with 3.3.
One less dependency to maintain for me if the compatibility with 3.3 could be asserted ;)

At present, names are automatically generated for VMs and instances in the following format:

temp1415214477

Would any functionality be lost if we were to use a more creative naming scheme?
e.g. gandi vm delete temp\* ?

For inspiration, see names-generator.go.

I would like to leverage the default values, configuration files, existing benefits of our CLI and use it or parts of it as a python module.

My main frustration here is that most convenient functions (default values and configuration especially) are tightly coupled to the command/ module and its setup by the cores.

I don't have any idea right now. How can we achieve something usable there ?

It would be nice if the domain information method will show the associated date : creation, renew, changed. Something like:

gandi domain info choucroute.net
owner       : AA1-GANDI
admin       : BB2-GANDI
bill        : CC3-GANDI
tech        : DD4-GANDI
fqdn        : choucroute.net
nameservers : ['a.dns.gandi.net', 'b.dns.gandi.net', 'c.dns.gandi.net']
services    : ['gandidns']
zone_id     : 424242
tags        : aliment
expires    : 2016-04-30 21:59:59
created    : 2006-04-07 14:57:34
changed   : 2015-03-30 22:07:01

Context:

$ gandi --version
Gandi CLI 0.12

$ cat /etc/debian_version 
8.0

Add a 'default_path' in the config.yaml to clone repository into the directory indicated. When I used gandi vhost create if you forgot to change directory, the folder is created in the current directory. I would like have a default path which all repository are clone to use this command and change directory automaticaly after that :

[12-01-15 - 6:25:24] [alex@badam] :/home/alex 
$ gandi vhost create --vhost courgette.bhz.im --paas test
Creating a new vhost.
Your vhost courgette.bhz.im has been created.
Your have set /home/alex/dev/paas/ as the default git directory, would you like to clone this vhost in this repo ? [y/N] y
Clonage dans '/home/alex/dev/paas/courgette.bhz.im'...
warning: Vous semblez avoir cloné un dépôt vide.
Vérification de la connectivité... fait.
[12-01-15 - 6:26:16] [alex@badam] :/home/alex/dev/paas.courgette.bhz.im/
$ 

gandi vm ssh tmp^I^I

Can we get a return code from script execution?
See this issue for details.

$ gandi --help
Traceback (most recent call last):
  File "/usr/local/bin/gandi", line 5, in <module>
from pkg_resources import load_entry_point
  File "/System/Library/Frameworks/Python.framework/Versions/2.7/Extras/lib/python/pkg_resources.py", line 2603, in <module>
working_set.require(__requires__)
  File "/System/Library/Frameworks/Python.framework/Versions/2.7/Extras/lib/python/pkg_resources.py", line 666, in require
needed = self.resolve(parse_requirements(requirements))
  File "/System/Library/Frameworks/Python.framework/Versions/2.7/Extras/lib/python/pkg_resources.py", line 565, in resolve
raise DistributionNotFound(req)  # XXX put more info here
pkg_resources.DistributionNotFound: click<=3.1

Here is some PIP information:

$ pip freeze | grep click
click==3.1

I tried to delete a bunch of private IP addresses by running

gandi ip delete --force $(gandi ip list --detached | awk '/ip/ {print $3}')

and encounter the following error:

Error: Got unexpected extra arguments (192.168.1.4 192.168.1.5 )

It would be great to be able to delete IP addresses by batch, don't you think ?

To bypass this limitation, I temporary use a bash for loop:

for i in $(gandi ip list --detached | awk '/ip/ {print $3}') ; do gandi ip delete --force $i ; done

Here is my current configuration

$ uname -a
Linux XXXXX 3.14-2-amd64 #1 SMP Debian 3.14.15-2 (2014-08-09) x86_64 GNU/Linux

$ gandi --version
Gandi CLI 0.12

Copyright: © 2014-2015 Gandi S.A.S.
License: GPL-3