salt.cloud.clouds.vagrant
Vagrant Cloud Driver
The Vagrant cloud is designed to "vagrant up" a virtual machine as a Salt minion.
Use of this module requires some configuration in cloud profile and provider files as described in the Getting Started with Vagrant documentation.
New in version 2018.3.0.
-
This function returns a list of images available for this cloud provider. vagrant will return a list of profiles. salt-cloud --list-images my-cloud-provider
salt.cloud.clouds.vagrant.avail_images(call=None)
-
This function returns a list of locations available.
CLI Example:
salt-cloud --list-locations my-cloud-provider # \[ vagrant will always returns an empty dictionary \]
salt.cloud.clouds.vagrant.avail_locations(call=None)
-
This function returns a list of sizes available for this cloud provider.
CLI Example:
salt-cloud --list-sizes my-cloud-provider # \[ vagrant always returns an empty dictionary \]
salt.cloud.clouds.vagrant.avail_sizes(call=None)
-
Provision a single machine
CLI Example:
salt-cloud -p my_profile new_node_1
salt.cloud.clouds.vagrant.create(vm_)
-
Destroy a node.
CLI Example:
salt-cloud --destroy mymachine
salt.cloud.clouds.vagrant.destroy(name, call=None)
-
Return the first configured instance.
salt.cloud.clouds.vagrant.get_configured_provider()
-
List the nodes which have salt-cloud:driver:vagrant grains.
CLI Example:
salt-cloud -Q
salt.cloud.clouds.vagrant.list_nodes(call=None)
-
List the nodes, ask all 'vagrant' minions, return dict of grains (enhanced).
CLI Example:
salt-call -F
salt.cloud.clouds.vagrant.list_nodes_full(call=None)
-
Return a list of the minions that have salt-cloud grains, with select fields.
salt.cloud.clouds.vagrant.list_nodes_select(call=None)
-
Reboot a vagrant minion.
- name
-
The name of the VM to reboot.
CLI Example:
salt-cloud -a reboot vm_name
salt.cloud.clouds.vagrant.reboot(name, call=None)
-
List the a single node, return dict of grains.
salt.cloud.clouds.vagrant.show_instance(name, call=None)
© 2021 SaltStack.
Licensed under the Apache License, Version 2.0.
https://docs.saltproject.io/en/latest/ref/clouds/all/salt.cloud.clouds.vagrant.html