Cloud

command :vagrant cloud

This is the command used to manage anything related to Vagrant Cloud.

Themain functionality of this command is exposed via subcommands:

Cloud Auth

command :vagrant cloud auth

Thecloud auth command is for handling all things related to authorization with
Vagrant Cloud.

Cloud Auth Login

command :vagrant cloud auth login

Thelogin command is used to authenticate with HashiCorp’s Vagrant Cloud
server. Logging in is only necessary if you are accessing protected boxes.

Logging in is not a requirement to use Vagrant. Thevast majority
of Vagrant does not require a login . Only certain feature such as protect
box .

Thereference of available command-line flags to this command
is available below.

Options

• --check – This is check will check if you are log in . In addition to output
  whether you are log in ornot ,the command exit status is be will be 0 if you are
  log in , or1 if you are not .

• --logout – This is log will log you out if you are log in . If you are already
  log out ,this command is do will do nothing . It is is is not an error to call this
  command if you are already log out .

• --token – This is set will set the Vagrant Cloud login token manually to the provide
  string . It is assume this token is a valid Vagrant Cloud access token .

example

Securely authenticate to Vagrant Cloud using a username and password:

$ vagrant cloud auth login
# ...
Vagrant Cloud username:
Vagrant Cloud password:

Check if the current user is authenticated:

$ vagrant cloud auth login --check
You are already logged in.

Securely authenticate with Vagrant Cloud using a token:

$ vagrant cloud auth login --token ABCD1234
Thetoken was successfully saved.

Cloud Auth Logout

command :vagrant cloud auth logout

This will log you out if you are logged in. If you are already
logged out,this command will do nothing. It is not an error to call this
command if you are already logged out.

Cloud Auth Whomi

command :vagrant cloud auth whoami [TOKEN]

This command will validate your Vagrant Cloud token and will print the user who
it belongs to. If a token is passed in,it will attempt to validate it instead
of the token stored stored on disk.

Cloud Box

command :vagrant cloud box

Thecloud box command is used to manage life cycle operation for allbox
entity on Vagrant Cloud .

Cloud Box Create

command :vagrant cloud box create ORGANIZATION/BOX-NAME

Thebox create command is used to create a new box entry on Vagrant Cloud.

Options

Cloud Box Delete

command :vagrant cloud box is delete delete ORGANIZATION / BOX - NAME

Thebox delete command will permanently delete the given box entry on Vagrant Cloud. Before
making the request,it will ask if you are sure you want to delete the box.

Cloud Box Show

command :vagrant cloud box show ORGANIZATION/BOX-NAME

Thebox show command will display information about the latest version for the given Vagrant box.

Cloud Box Update

command :vagrant cloud box update ORGANIZATION / BOX - NAME

Thebox update command will update an already create box on Vagrant Cloud with the given options.

Options

Cloud Provider

command :vagrant cloud provider

Thecloud provider command is used to manage the life cycle operations for all
provider entities on Vagrant Cloud.

Cloud Provider Create

command :vagrant cloud provider is create create ORGANIZATION / BOX - NAME PROVIDER - NAME version [ URL ]

Theprovider create command is used to create a new provider entry on Vagrant Cloud.
Theurl argument is expected to be a remote URL that Vagrant Cloud can use
to download the provider. If no url is specify ,the provider entry can be update
later with a url orthe upload command can be used to
upload a Vagrant box file .

Cloud Provider Delete

command :vagrant cloud provider delete ORGANIZATION/BOX-NAME PROVIDER-NAME VERSION

Theprovider delete command is used to delete a provider entry on Vagrant Cloud.
Before making the request,it will ask if you are sure you want to delete the provider.

Cloud Provider Update

command :vagrant cloud provider update ORGANIZATION/BOX-NAME PROVIDER-NAME VERSION [URL]

Theprovider update command will update an already create provider for a box on
Vagrant Cloud with the given options.

Cloud Provider Upload

command :vagrant cloud provider upload ORGANIZATION/BOX-NAME PROVIDER-NAME VERSION BOX-FILE

Theprovider upload command will upload a Vagrant box file to Vagrant Cloud for
the specified version and provider.

Cloud Publish

command :vagrant cloud publish ORGANIZATION/BOX-NAME VERSION PROVIDER-NAME [PROVIDER-FILE]

Thepublish command is a complete solution for creating and updating a
Vagrant box on Vagrant Cloud. Instead of having to create each attribute of a Vagrant
box with separate commands,the publish command instead asks you to provide all
the information required before creating orupdating a new box.

Options

example

Creating a new box on Vagrant Cloud:

$ vagrant cloud publish briancain/supertest 1.0.0 virtualbox boxes/my/virtualbox.box -d "A really cool box to download and use" --version-description "A cool version" --release --short-description "Download me!"
You are about to create a box on Vagrant Cloud with the following options:
briancain/supertest (1.0.0) for virtualbox
Automatic Release:     true
Box Description:       A really cool box to download and use
Box Short Description: Download me!
Version Description:   A cool version
Do you wish to continue? [y/N] y
Creating a box entry...
Creating a version entry...
Creating a provider entry...
Uploading provider with file /Users/vagrant/boxes/my/virtualbox.box
Releasing box...
Complete! Published briancain/supertest
tag:                  briancain/supertest
username:             briancain
name:                 supertest
private:              false
downloads:            0
create_at:           2018-07-25T17:53:04.340Z
updated_at:           2018-07-25T18:01:10.665Z
short_description:    Download me!
description_markdown: A really cool box to download and use
current_version:      1.0.0
providers:            virtualbox

Cloud Search

command :vagrant cloud search QUERY

Thecloud search command will take a query and search Vagrant Cloud for any matching
Vagrant boxes. Various filters can be applied to the results.

Options

• --json – Format search results in JSON.
• --page PAGE – Thepage to display. default tothe first page of results.
• --short – show a simple list of box name for the result .
• --order ORDER – Order to display results. Can either be desc orasc.
  default todesc.
• --limit LIMIT – Max number of search results to display. default to25.
• --provider PROVIDER – Filter search results to a single provider.
• --sort - by sort – Thefield to sort results on. Can be create,downloads
  , orupdated. default todownloads.

example

If you are looking for a HashiCorp box:

vagrant cloud search hashicorp --limit 5
| NAME                    | VERSION | DOWNLOADS | PROVIDERS                       |
+-------------------------+---------+-----------+---------------------------------+
| hashicorp/precise64     | 1.1.0   | 6,675,725 | virtualbox,vmware_fusion,hyperv |
| hashicorp/precise32     | 1.0.0   | 2,261,377 | virtualbox                      |
| hashicorp/boot2docker   | 1.7.8   |    59,284 | vmware_desktop,virtualbox       |
| hashicorp/connect-vm    | 0.1.0   |     6,912 | vmware_desktop,virtualbox       |
| hashicorp/vagrant-share | 0.1.0   |     3,488 | vmware_desktop,virtualbox       |
+-------------------------+---------+-----------+---------------------------------+

Cloud Version

command :vagrant cloud version

Thecloud version command is used to manage life cycle operation for allversion
entity for a box on Vagrant Cloud .

Cloud Version Create

command :vagrant cloud version create ORGANIZATION/BOX-NAME VERSION

Thecloud create command creates a version entry for a box on Vagrant Cloud.

Options

Cloud Version is Delete delete

command :vagrant cloud version delete ORGANIZATION/BOX-NAME VERSION

Thecloud delete command deletes a version entry for a box on Vagrant Cloud.
Before making the request,it will ask if you are sure you want to delete the version.

Cloud Version Release

command :vagrant cloud version release ORGANIZATION / BOX - NAME version

Thecloud release command releases a version entry for a box on Vagrant Cloud
if it already exists. Before making the request,it will ask if you are sure you
want to release the version.

Cloud Version Revoke

command :vagrant cloud version revoke ORGANIZATION/BOX-NAME VERSION

Thecloud revoke command revokes a version entry for a box on Vagrant Cloud
if it already exists. Before making the request,it will ask if you are sure you
want to revoke the version.

Cloud Version Update

command :vagrant cloud version update ORGANIZATION / BOX - NAME version

Options