---
title: vCenter folder
slug: homologacao-atmosphere/vcenter-folder
description: Learn how to use the vCenter module to efficiently manage folders in a specific datacenter. This document covers the creation, deletion, movement, and renaming of folders, along with essential parameters like datacenter name, folder type, hostname, and mo
docTags: 
createdAt: 2022-01-19T12:39:20.000Z
---

## Resumo

- Este módulo pode ser usado para criar, excluir, mover e renomear a pasta no datacenter determinado.
- Este módulo é compatível apenas com o vCenter.

## Parâmetros

| **Parâmetro**           | **Tipo** | **Escolhas \| Valor Padrão**                                      | **Comentários**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| ----------------------- | -------- | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| datacenter - required   |          |                                                                   | Nome do datacenter.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| folder\_name - required |          |                                                                   | Nome da pasta a ser gerenciada.<br /><br />Este é um parâmetro sensível a maiúsculas e minúsculas.<br /><br />O nome da pasta deve ter menos de 80 caracteres. Esta é uma restrição VMware.                                                                                                                                                                                                                                                                                                                                                                                                    |
| folder\_type            |          | Escolhas:<br />- datastore<br />- host<br />- network<br />- vm ← | Este é o tipo de pasta.<br /><br />Se definido como `vm`, então 'VM and Template Folder' será criado no datacenter.<br /><br />Se definido como `host`, então 'Host and Cluster Folder' é criado no datacenter.<br /><br />Se definido como `datastore`, a 'Pasta de Armazenamento' será criada no datacenter.<br /><br />Se definido como `network`, a 'Pasta de Rede' será criada no datacenter.<br /><br />Este parâmetro é obrigatório se `state` estiver definido como `presente` a parent\_folder estiver absent.<br /><br />Esta opção é ignorada, se `parent_folder` estiver definida. |
| hostname                |          |                                                                   | O nome do host ou endereço IP do servidor vSphere vCenter ou ESXi.<br /><br />Se o valor não for especificado na tarefa, o valor da variável de ambiente `VMWARE_HOST` será usado.                                                                                                                                                                                                                                                                                                                                                                                                             |
| parent\_folder          |          |                                                                   | Nome da pasta pai na qual a nova pasta precisa ser criada.<br /><br />Este é um parâmetro sensível a maiúsculas e minúsculas.<br /><br />Se o usuário quiser criar uma pasta em '/DC0/vm/vm\_folder', esse valor será 'vm\_folder'.<br /><br />Se o usuário quiser criar uma pasta em '/DC0/vm/folder1/folder2', esse valor será 'folder1/folder2'.                                                                                                                                                                                                                                            |
| password                |          |                                                                   | A senha do servidor vSphere vCenter ou ESXi.<br /><br />Se o valor não for especificado na tarefa, o valor da variável de ambiente VMWARE\_PASSWORD será usado.                                                                                                                                                                                                                                                                                                                                                                                                                                |
| port                    |          | Default:<br />443                                                 | O número da porta do servidor vSphere vCenter ou ESXi.<br /><br />Se o valor não for especificado na tarefa, o valor da variável de ambiente `VMWARE_PORT` será usado.                                                                                                                                                                                                                                                                                                                                                                                                                         |
| proxy\_host             |          |                                                                   | Endereço de um proxy que receberá todas as solicitações HTTPS e as retransmitirá.<br /><br />O formato é um nome de host ou um IP.Se o valor não for especificado na tarefa, o valor da variável de ambiente `VMWARE_PROXY_HOST` será usado.                                                                                                                                                                                                                                                                                                                                                   |
| proxy\_port             |          |                                                                   | Porta do proxy HTTP que receberá todas as solicitações HTTPS e as retransmitirá.<br /><br />Se o valor não for especificado na tarefa, o valor da variável de ambiente `VMWARE_PROXY_PORT` será usado.                                                                                                                                                                                                                                                                                                                                                                                         |
| state                   |          | Escolhas:<br />- present ←<br />- absent                          | Estado da pasta.<br /><br />Se definido como `present` sem o parâmetro de pasta pai, a pasta com `folder_type` será criada.<br /><br />Se definido como `present` com o parâmetro da pasta pai, a pasta será criada na pasta pai. folder\_type é ignorado.<br /><br />Se definido como `absent`, a pasta não será registrada e será destruída.                                                                                                                                                                                                                                                 |
| username                |          |                                                                   | O nome de usuário do servidor vSphere vCenter ou ESXi.<br /><br />Se o valor não for especificado na tarefa, o valor da variável de ambiente `VMWARE_USER` será usado.                                                                                                                                                                                                                                                                                                                                                                                                                         |
| validate\_certs         |          | Escolhas:<br />- true ←<br />- false                              | Permite a conexão quando os certificados SSL não são válidos. Definido para `false` quando os certificados não são confiáveis.<br /><br />Se o valor não for especificado na tarefa, o valor da variável de ambiente `VMWARE_VALIDATE_CERTS` será usado.                                                                                                                                                                                                                                                                                                                                       |




## Notas

- Testado no vSphere 7.0.2
- Todos os módulos requerem acesso de gravação à API e, portanto, não são compatíveis com uma licença ESXi gratuita.

## Exemplos

```yaml
- name: Create a VM folder on given datacenter
  community.vmware.vcenter_folder:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: datacenter_name
    folder_name: sample_vm_folder
    folder_type: vm
    state: present
  register: vm_folder_creation_result
  delegate_to: localhost

- name: Create a datastore folder on given datacenter
  community.vmware.vcenter_folder:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: datacenter_name
    folder_name: sample_datastore_folder
    folder_type: datastore
    state: present
  register: datastore_folder_creation_result
  delegate_to: localhost

- name: Create a sub folder under VM folder on given datacenter
  community.vmware.vcenter_folder:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: datacenter_name
    folder_name: sample_sub_folder
    parent_folder: vm_folder
    state: present
  register: sub_folder_creation_result
  delegate_to: localhost

- name: Delete a VM folder on given datacenter
  community.vmware.vcenter_folder:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: datacenter_name
    folder_name: sample_vm_folder
    folder_type: vm
    state: absent
  register: vm_folder_deletion_result
  delegate_to: localhost

```

## Valores de retorno

| **Chave** | **Tipo** | **Retornado quando** | **Descrição**                      |
| --------- | -------- | -------------------- | ---------------------------------- |
| result    | complex  | sucesso              | O detalhe sobre a nova pasta<br /> |

## Subcampos da chave de retorno result

| **Chave** | **Tipo** | **Retornado quando** | **Descrição**                       |
| --------- | -------- | -------------------- | ----------------------------------- |
| msg       | string   | sucesso              | String informando sobre o resultado |
| path      | string   | sucesso              | O caminho completo da nova pasta    |




