# Cmdlets

```{toctree}
:glob:
:hidden:

commandlets/*
```

## Connection

Cmdlets related to the Vault connection.

| Name                                                                       | Description                 |
| -------------------------------------------------------------------------- | --------------------------- |
| [Open-VaultConnection](</code_reference/commandlets/open-vaultconnection>) | Connects to a Vault server. |


## Debug

Cmdlets to help identifying issues in scripts.

| Name                                             | Description                                                                                |
| ------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| [](</code_reference/commandlets/show-inspector>) | Opens a dialog in which all available PowerShell variables and their values are displayed. |


-----

:::{note} 
The following cmdlets require an existing Vault connection in the application being used to work with them.
:::

## Files

Cmdlets for adding, updating and retrieving Vault File(s) and their associations.

| Name                                                                                 | Description                                                  |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------ |
| [Get-VaultFile](</code_reference/commandlets/get-vaultfile>)                         | Retrieves a File from Vault.                                 |
| [Get-VaultFiles](</code_reference/commandlets/get-vaultfiles>)                       | Retrieves multiples File from Vault.                         |
| [Get-VaultFileAssociations](</code_reference/commandlets/get-vaultfileassociations>) | Retrieves the associations of a File in Vault.               |
| [Get-VaultFileBom](</code_reference/commandlets/get-vaultfilebom>)                   | Retrieves the Bill of Material data of a of a File in Vault. |
| [Add-VaultFile](</code_reference/commandlets/add-vaultfile>)                         | Adds a new File to the Vault.                                |
| [Update-VaultFile](</code_reference/commandlets/update-vaultfile>)                   | Updates an existing File in Vault.                           |
| [Save-VaultFile](</code_reference/commandlets/save-vaultfile>)                       | Download a File from Vault to a local directory.             |

## Folders

Cmdlets for retrieving Vault Folder(s).

| Name                                                               | Description                    |
| ------------------------------------------------------------------ | ------------------------------ |
| [Get-VaultFolder](</code_reference/commandlets/get-vaultfolder>)   | Retrieves a Folder from Vault. |
| [Get-VaultFolders](</code_reference/commandlets/get-vaultfolders>) | Retrieves Folders from Vault.  |


## Items

Cmdlets for updating and retrieving Vault Item(s) and their associations.

| Name                                                                                | Description                                                   |
| ----------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| [Get-VaultItem](</code_reference/commandlets/get-vaultitem>)                        | Retrieves an Item from Vault.                                 |
| [Get-VaultItemAssociations](</code_reference/commandlets/get-vaultitemassociation>) | Retrieves the associations of an Item in Vault.               |
| [Get-VaultItemBom](</code_reference/commandlets/get-vaultitembom>)                  | Retrieves the Bill of Material data of a of an Item in Vault. |
| [Update-VaultItem](</code_reference/commandlets/update-vaultitem>)                  | Updates an existing Item in Vault.                            |


## Change Orders

Cmdlets for adding, updating and retrieving Change Order(s) and their associations.

| Name                                                                                               | Description                                              |
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| [Get-VaultChangeOrder](</code_reference/commandlets/get-vaultchangeorder>)                         | Retrieves a Change Order from Vault.                     |
| [Get-VaultChangeOrderAssociations](</code_reference/commandlets/get-vaultchangeorderassociations>) | Retrieves the associations of a Change Order from Vault. |
| [Add-VaultChangeOrder](</code_reference/commandlets/add-vaultchangeorder>)                         | Creates a Change Order in Vault.                         |
| [Update-VaultChangeOrder](</code_reference/commandlets/update-vaultchangeorder>)                   | Updates an existing Change Order in Vault.               |


## Jobs

Cmdlets related to Jobs and the Vault JobQueue.

| Name                                                       | Description                           |
| ---------------------------------------------------------- | ------------------------------------- |
| [Add-VaultJob](</code_reference/commandlets/add-vaultjob>) | Adds a new Job to the Vault JobQueue. |