# salt.cloud.clouds.gogrid

## GoGrid Cloud Module

The GoGrid cloud module. This module interfaces with the gogrid public cloud service. To use Salt Cloud with GoGrid log into the GoGrid web interface and create an api key. Do this by clicking on "My Account" and then going to the API Keys tab.

Set up the cloud configuration at `/etc/salt/cloud.providers` or `/etc/salt/cloud.providers.d/gogrid.conf`:

    my-gogrid-config:
      # The generated api key to use
      apikey: asdff7896asdh789
      # The apikey's shared secret
      sharedsecret: saltybacon
      driver: gogrid

Note

A Note about using Map files with GoGrid:

Due to limitations in the GoGrid API, instances cannot be provisioned in parallel with the GoGrid driver. Map files will work with GoGrid, but the `-P` argument should not be used on maps referencing GoGrid instances.

Note

A Note about using Map files with GoGrid:

Due to limitations in the GoGrid API, instances cannot be provisioned in parallel with the GoGrid driver. Map files will work with GoGrid, but the `-P` argument should not be used on maps referencing GoGrid instances.

salt.cloud.clouds.gogrid.avail_images()

  Available images

salt.cloud.clouds.gogrid.avail_locations()

  Available locations

salt.cloud.clouds.gogrid.avail_sizes()

  Available sizes

salt.cloud.clouds.gogrid.create(vm_)

  Create a single VM from a data dict

salt.cloud.clouds.gogrid.destroy(name, call=None)

  Destroy a machine by name

  CLI Example:

      salt-cloud -d vm_name

salt.cloud.clouds.gogrid.get_configured_provider()

  Return the first configured instance.

salt.cloud.clouds.gogrid.list_common_lookups(kwargs=None, call=None)

  List common lookups for a particular type of item

  Added in version 2015.8.0.

salt.cloud.clouds.gogrid.list_nodes(full=False, call=None)

  List of nodes, keeping only a brief listing

  CLI Example:

      salt-cloud -Q

salt.cloud.clouds.gogrid.list_nodes_full(call=None)

  List nodes, with all available information

  CLI Example:

      salt-cloud -F

salt.cloud.clouds.gogrid.list_nodes_select(call=None)

  Return a list of the VMs that are on the provider, with select fields

  CLI Example:

      salt-cloud -S

salt.cloud.clouds.gogrid.list_passwords(kwargs=None, call=None)

  List all password on the account

  Added in version 2015.8.0.

salt.cloud.clouds.gogrid.list_public_ips(kwargs=None, call=None)

  List all available public IPs.

  CLI Example:

      salt-cloud -f list_public_ips <provider>

  To list unavailable (assigned) IPs, use:

  CLI Example:

      salt-cloud -f list_public_ips <provider> state=assigned

  Added in version 2015.8.0.

salt.cloud.clouds.gogrid.reboot(name, call=None)

  Reboot a machine by name

  CLI Example:

      salt-cloud -a reboot vm_name

  Added in version 2015.8.0.

salt.cloud.clouds.gogrid.show_instance(name, call=None)

  Start a machine by name

  CLI Example:

      salt-cloud -a show_instance vm_name

  Added in version 2015.8.0.

salt.cloud.clouds.gogrid.start(name, call=None)

  Start a machine by name

  CLI Example:

      salt-cloud -a start vm_name

  Added in version 2015.8.0.

salt.cloud.clouds.gogrid.stop(name, call=None)

  Stop a machine by name

  CLI Example:

      salt-cloud -a stop vm_name

  Added in version 2015.8.0.