salt.cloud.clouds.digital_ocean_v2¶

DigitalOcean Cloud Module v2¶

The DigitalOcean cloud module is used to control access to the DigitalOcean VPS system.

Use of this module only requires the personal_access_token parameter to be set. Set up the cloud configuration at /etc/salt/cloud.providers or /etc/salt/cloud.providers.d/digital_ocean.conf:

my-digital-ocean-config:
  personal_access_token: xxx
  provider: digital_ocean

salt.cloud.clouds.digital_ocean_v2.avail_images(call=None)¶

Return a list of the images that are on the provider

salt.cloud.clouds.digital_ocean_v2.avail_locations(call=None)¶

Return a dict of all available VM locations on the cloud provider with relevant data

salt.cloud.clouds.digital_ocean_v2.avail_sizes(call=None)¶

Return a list of the image sizes that are on the provider

salt.cloud.clouds.digital_ocean_v2.create(vm_)¶

Create a single VM from a data dict

salt.cloud.clouds.digital_ocean_v2.create_dns_record(hostname, ip_address)¶

Creates a DNS record for the given hostname if the domain is managed with DO.

salt.cloud.clouds.digital_ocean_v2.create_node(args)¶

Create a node

salt.cloud.clouds.digital_ocean_v2.delete_dns_record(hostname)¶

Deletes a DNS for the given hostname if the domain is managed with DO.

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

Destroy a node. Will check termination protection and warn if enabled.

CLI Example:

salt-cloud --destroy mymachine

salt.cloud.clouds.digital_ocean_v2.get_configured_provider()¶

Return the first configured instance.

salt.cloud.clouds.digital_ocean_v2.get_image(vm_)¶

Return the image object to use

salt.cloud.clouds.digital_ocean_v2.get_keyid(keyname)¶

Return the ID of the keyname

salt.cloud.clouds.digital_ocean_v2.get_location(vm_)¶

Return the VM's location

salt.cloud.clouds.digital_ocean_v2.get_size(vm_)¶

Return the VM's size. Used by create_node().

salt.cloud.clouds.digital_ocean_v2.list_keypairs(call=None)¶

Return a dict of all available VM locations on the cloud provider with relevant data

salt.cloud.clouds.digital_ocean_v2.list_nodes(call=None)¶

Return a list of the VMs that are on the provider

salt.cloud.clouds.digital_ocean_v2.list_nodes_full(call=None, forOutput=True)¶

Return a list of the VMs that are on the provider

salt.cloud.clouds.digital_ocean_v2.list_nodes_select(call=None)¶

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

salt.cloud.clouds.digital_ocean_v2.query(method='droplets', droplet_id=None, command=None, args=None, http_method='get')¶

Make a web call to DigitalOcean

salt.cloud.clouds.digital_ocean_v2.script(vm_)¶

Return the script deployment object

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

Show the details from DigitalOcean concerning a droplet

salt.cloud.clouds.digital_ocean_v2.show_keypair(kwargs=None, call=None)¶

Show the details of an SSH keypair