1SALT-CLOUD(1) Salt SALT-CLOUD(1)
2
6 salt-cloud - Salt Cloud Command
7 Provision virtual machines in the cloud with Salt
9
11 salt-cloud -m /etc/salt/cloud.map
12 salt-cloud -m /etc/salt/cloud.map NAME
14 salt-cloud -m /etc/salt/cloud.map NAME1 NAME2
16 salt-cloud -p PROFILE NAME
18 salt-cloud -p PROFILE NAME1 NAME2 NAME3 NAME4 NAME5 NAME6
20
22 Salt Cloud is the system used to provision virtual machines on various
23 public clouds via a cleanly controlled profile and mapping system.
24
26 --version
27 Print the version of Salt that is running.
28 --versions-report
30 Show program's dependencies and version number, and then exit
31 -h, --help
33 Show the help message and exit
34 -c CONFIG_DIR, --config-dir=CONFIG_dir
36 The location of the Salt configuration directory. This directory
37 contains the configuration files for Salt master and minions.
38 The default location on most systems is /etc/salt.
39 Execution Options
41 -L LOCATION, --location=LOCATION
42 Specify which region to connect to.
43 -a ACTION, --action=ACTION
45 Perform an action that may be specific to this cloud provider.
46 This argument requires one or more instance names to be speci‐
47 fied.
48 -f <FUNC-NAME> <PROVIDER>, --function=<FUNC-NAME> <PROVIDER>
50 Perform an function that may be specific to this cloud provider,
51 that does not apply to an instance. This argument requires a
52 provider to be specified (i.e.: nova).
53 -p PROFILE, --profile=PROFILE
55 Select a single profile to build the named cloud VMs from. The
56 profile must be defined in the specified profiles file.
57 -m MAP, --map=MAP
59 Specify a map file to use. If used without any other options,
60 this option will ensure that all of the mapped VMs are created.
61 If the named VM already exists then it will be skipped.
62 -H, --hard
64 When specifying a map file, the default behavior is to ensure
65 that all of the VMs specified in the map file are created. If
66 the --hard option is set, then any VMs that exist on configured
67 cloud providers that are not specified in the map file will be
68 destroyed. Be advised that this can be a destructive operation
69 and should be used with care.
70 -d, --destroy
72 Pass in the name(s) of VMs to destroy, salt-cloud will search
73 the configured cloud providers for the specified names and de‐
74 stroy the VMs. Be advised that this is a destructive operation
75 and should be used with care. Can be used in conjunction with
76 the -m option to specify a map of VMs to be deleted.
77 -P, --parallel
79 Normally when building many cloud VMs they are executed seri‐
80 ally. The -P option will run each cloud vm build in a separate
81 process allowing for large groups of VMs to be build at once.
82 Be advised that some cloud provider's systems don't seem to be
84 well suited for this influx of vm creation. When creating large
85 groups of VMs watch the cloud provider carefully.
86 -u, --update-bootstrap
88 Update salt-bootstrap to the latest stable bootstrap release.
89 -y, --assume-yes
91 Default yes in answer to all confirmation questions.
92 -k, --keep-tmp
94 Do not remove files from /tmp/ after deploy.sh finishes.
95 --show-deploy-args
97 Include the options used to deploy the minion in the data re‐
98 turned.
99 --script-args=SCRIPT_ARGS
101 Script arguments to be fed to the bootstrap script when deploy‐
102 ing the VM.
103 Query Options
105 -Q, --query
106 Execute a query and return some information about the nodes run‐
107 ning on configured cloud providers
108 -F, --full-query
110 Execute a query and print out all available information about
111 all cloud VMs. Can be used in conjunction with -m to display
112 only information about the specified map.
113 -S, --select-query
115 Execute a query and print out selected information about all
116 cloud VMs. Can be used in conjunction with -m to display only
117 information about the specified map.
118 --list-providers
120 Display a list of configured providers.
121 --list-profiles
123 New in version 2014.7.0.
124 Display a list of configured profiles. Pass in a cloud provider
127 to view the provider's associated profiles, such as digitalo‐
128 cean, or pass in all to list all the configured profiles.
129 Cloud Providers Listings
131 --list-locations=LIST_LOCATIONS
132 Display a list of locations available in configured cloud
133 providers. Pass the cloud provider that available locations are
134 desired on, such as "linode", or pass "all" to list locations
135 for all configured cloud providers
136 --list-images=LIST_IMAGES
138 Display a list of images available in configured cloud
139 providers. Pass the cloud provider that available images are de‐
140 sired on, such as "linode", or pass "all" to list images for all
141 configured cloud providers
142 --list-sizes=LIST_SIZES
144 Display a list of sizes available in configured cloud providers.
145 Pass the cloud provider that available sizes are desired on,
146 such as "AWS", or pass "all" to list sizes for all configured
147 cloud providers
148 Cloud Credentials
150 --set-password=<USERNAME> <PROVIDER>
151 Configure password for a cloud provider and save it to the
152 keyring. PROVIDER can be specified with or without a driver,
153 for example: "--set-password bob rackspace" or more specific
154 "--set-password bob rackspace:openstack" DEPRECATED!
155 Output Options
157 --out Pass in an alternative outputter to display the return of data.
158 This outputter can be any of the available outputters:
159 highstate, json, key, overstatestage, pprint, raw, txt, yaml,
160 and many others.
161 Some outputters are formatted only for data returned from spe‐
163 cific functions. If an outputter is used that does not support
164 the data passed into it, then Salt will fall back on the pprint
165 outputter and display the return data using the Python pprint
166 standard library module.
167 --out-indent OUTPUT_INDENT, --output-indent OUTPUT_INDENT
169 Print the output indented by the provided value in spaces. Nega‐
170 tive values disable indentation. Only applicable in outputters
171 that support indentation.
172 --out-file=OUTPUT_FILE, --output-file=OUTPUT_FILE
174 Write the output to the specified file.
175 --out-file-append, --output-file-append
177 Append the output to the specified file.
178 --no-color
180 Disable all colored output
181 --force-color
183 Force colored output
184 NOTE:
186 When using colored output the color codes are as follows:
187 green denotes success, red denotes failure, blue denotes
189 changes and success and yellow denotes a expected future
190 change in configuration.
191 --state-output=STATE_OUTPUT, --state_output=STATE_OUTPUT
193 Override the configured state_output value for minion output.
194 One of 'full', 'terse', 'mixed', 'changes' or 'filter'. Default:
195 'none'.
196 --state-verbose=STATE_VERBOSE, --state_verbose=STATE_VERBOSE
198 Override the configured state_verbose value for minion output.
199 Set to True or False. Default: none.
200
202 To create 4 VMs named web1, web2, db1, and db2 from specified profiles:
203 salt-cloud -p fedora_rackspace web1 web2 db1 db2
205 To read in a map file and create all VMs specified therein:
207 salt-cloud -m /path/to/cloud.map
209 To read in a map file and create all VMs specified therein in parallel:
211 salt-cloud -m /path/to/cloud.map -P
213 To delete any VMs specified in the map file:
215 salt-cloud -m /path/to/cloud.map -d
217 To delete any VMs NOT specified in the map file:
219 salt-cloud -m /path/to/cloud.map -H
221 To display the status of all VMs specified in the map file:
223 salt-cloud -m /path/to/cloud.map -Q
225
227 salt-cloud(7) salt(7) salt-master(1) salt-minion(1)
228
230 Thomas S. Hatch <thatch45@gmail.com> and many others, please see the
231 Authors file
2323003 Feb 23, 2021 SALT-CLOUD(1)