# vagrant-cloud-resource

**Repository Path**: mirrors_vmware-archive/vagrant-cloud-resource

## Basic Information

- **Project Name**: vagrant-cloud-resource
- **Description**: manages boxes in vagrant cloud, by provider
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-03-25
- **Last Updated**: 2025-09-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Vagrant Cloud Resource

Automates creation of box versions in [Vagrant Cloud](https://vagrantcloud.com).


## Source Configuration

* `access_token`: *Required.* The access token.

* `username`: *Required.* The user that owns the box.

* `box`: *Required.* The name of the box.

* `provider`: *Required.* The provider of the box.


### Example

``` yaml
- name: virtualbox-box
  type: vagrant-cloud
  source:
    access_token: 1234567890abcdef
    username: your-name
    box: a-great-box
    provider: virtualbox
```

``` yaml
- get: virtualbox-box
  params:
    download: true
```

``` yaml
- put: virtualbox-box
  params:
    version: path/to/version/file
    url: path/to/url/file
```


## Behavior

### `check`: Check for new versions of the box's provider.

Queries the Vagrant Cloud API for new versions of the box. If no version is
given, the current version is returned. Otherwise, the version specified and the
current version are returned.


### `in`: Fetches the box.

Downloads the .box file for the box's provider and version. If no version,
the current version is fetched.

Returns the box version as the resource's version.

Places the following files in the destination:

* `version`: The version number of the box.

* `url`: The URL of the .box. (Be sure to follow redirects.)

* `box`: The downloaded .box file, if `download` is enabled.

#### Parameters

* `download`: *Optional.* Download the .box file.


### `out`: Publish a version of the box.

Creates a version of the box's provider. At least one of `url` or `release`
must be provided.

#### Parameters

* `version`: *Required.* Path to a file containing the version number.

* `description`: *Optional.* Path to a file containing the description of the
  version.

* `url`: *Optional.* Path to a file containing the URL to the .box.

* `release`: *Optional. Default `false`.* Release the version.