# Usar os documentos de comando do Systems Manager para criar snapshots baseados no VSS
<a name="create-vss-snapshots-ssm"></a>

Você pode usar documentos de comando do AWS Systems Manager para criar snapshots baseados no VSS. O conteúdo a seguir apresenta os documentos de comando disponíveis e os parâmetros de runtime que os documentos usam para criar seus snapshots.

Antes de usar qualquer um dos documentos de comando do Systems Manager, verifique se você atendeu a todos os [Pré-requisitos para criar snapshots do EBS baseados no VSS do Windows](application-consistent-snapshots-prereqs.md).

**Topics**
+ [Parâmetros para documentos de snapshot de VSS do Systems Manager](#create-vss-snapshots-ssm-params)
+ [Execução de documentos de comando de snapshot de VSS do Systems Manager](#create-vss-snapshots-ssm-methods)

## Parâmetros para documentos de snapshot de VSS do Systems Manager
<a name="create-vss-snapshots-ssm-params"></a>

Todos os documentos do Systems Manager que criam snapshots de VSS usam os seguintes parâmetros, exceto onde indicado:

**AmiName** (string, opcional)  
Se a opção **CreateAmi** for definida como `True`, especifique o nome da AMI que o backup criará.

**description** (string, opcional)  
Especifique uma descrição para os snapshots ou para a imagem que esse processo vai criar.

**CollectDiagnosticLogs** (string, opcional)  
Para coletar mais informações durante as etapas de criação de snapshots e AMIs, defina esse parâmetro como "`True`". O valor padrão desse parâmetro é "`False`". Os logs de diagnóstico consolidados são salvos como um arquivo no formato `.zip` no seguinte local em sua instância:  
`C:\ProgramData\Amazon\AwsVss\Logs\{{timestamp}}.zip`

**CopyOnly** (string, opcional)  
Se você estiver usando o backup nativo do SQL Server além do AWS VSS, fazer um backup somente cópia evitará que o AWS VSS rompa a cadeia nativa de backup diferencial. Para realizar uma operação de backup somente cópia, defina esse parâmetro como `True`.  
O valor padrão desse parâmetro é `False`, que faz com que o AWS VSS faça uma operação de backup total.

**CreateAmi** (string, opcional)  
Para criar uma imagem de máquina da Amazon (AMI) baseada no VSS para fazer backup da instância, defina esse parâmetro como `True`. O valor padrão desse parâmetro é `False`, que faz backup da instância com um snapshot do EBS.  
Para obter mais informações sobre como criar uma AMI de uma instância, consulte [Criação de uma AMI baseada no Amazon EBS](creating-an-ami-ebs.md).

**executionTimeout** (string, opcional)  
Especifique o tempo máximo em segundos para executar o processo de criação de snapshots na instância ou para criar uma AMI da instância. Aumentar esse tempo limite permite que o comando aguarde mais tempo até o VSS iniciar seu congelamento e concluir a marcação dos recursos criados. Esse tempo limite só se aplica às etapas de criação de snapshot ou AMI. A etapa inicial para instalar ou atualizar o pacote `AwsVssComponents` não está incluída no tempo limite.

**ExcludeBootVolume** (string, opcional)  
Se você criar snapshots, essa configuração excluirá os volumes de inicialização do processo de backups. **Para excluir os volumes de inicialização dos snapshots, defina **ExcludeBootVolume** como `True` e CreateAmi** como `False`.  
Se você criar uma AMI para o backup, esse parâmetro deverá ser definido como `False`. O valor padrão desse parâmetro é `False`.

**NoWriters** (string, opcional)  
Para excluir os gravadores do VSS do processo de snapshots, defina esse parâmetro como `True`. Excluir gravadores do VSS pode ajudar você a resolver conflitos com componentes de backup de VSS de terceiros. O valor padrão desse parâmetro é `False`.  
Se `SaveVssMetadata` for `True`, esse parâmetro precisará ser definido como `False`.

**SaveVSSMetadata** (string, opcional)  
Para salvar arquivos de metadados do VSS durante cada snapshot, defina esse parâmetro como `True`. O valor padrão é `False`. Os arquivos ajudam a fornecer insights sobre quais componentes ou gravadores foram incluídos em uma operação de backup, bem como os arquivos e volumes associados com cada snapshot. Os arquivos de metadados são usados ao restaurar um banco de dados SQL usando a solução de restauração VSS. Para obter mais informações sobre como restaurar um banco de dados SQL a partir de snapshots do VSS, consulte [Usar um runbook de automação para restaurar seu banco de dados a partir de snapshots da solução AWS VSS](https://docs.aws.amazon.com/sql-server-ec2/latest/userguide/ms-ssdb-ec2-restore-vss.html).  
Os arquivos de metadados têm o ID do conjunto de snapshots associado em seus nomes. Você os encontrará no seguinte local na instância:  

```
C:\ProgramData\Amazon\AwsVss\VssMetadata\
```
+ Salvar arquivos de metadados do VSS requer a versão 2.4.0 ou superior do pacote de `AwsVssComponents`. Se a instância tiver uma versão anterior instalada, definir `SaveVssMetadata` como `True` fará com que a criação do snapshot falhe.
+ Os parâmetros `NoWriters` e `SaveVssMetadata` são mutuamente exclusivos. Se ambos estiverem definidos como `True`, a criação do snapshot falhará.

**tags** (string, opcional)  
Recomendamos marcar seus snapshots e imagens com tags para facilitar a localização e o gerenciamento dos seus recursos, por exemplo, para restaurar volumes de uma lista de snapshots. O sistema adiciona a chave `Name` com um valor em branco em que você pode especificar o nome que deseja aplicar aos snapshots ou imagens de saída.  
Se desejar especificar tags adicionais, separe-as com ponto e vírgulas. Por exemplo, `Key=Environment,Value=Test;Key=User,Value=TestUser1`.  
As chaves e os valores das etiquetas devem conter apenas caracteres alfanuméricos e os seguintes caracteres especiais: `() ./\-"'@_+:={}`.
Por padrão, o sistema adiciona as tags reservadas a seguir para imagens e snapshots baseados no VSS.  
+ **Dispositivo**: para snapshots baseados no VSS, esse é o nome do dispositivo do volume do EBS que o snapshot captura.
+ **AppConsistent**: essa tag indica a criação com êxito de uma AMI ou um snapshot baseado no VSS.
+ **AwsVSSConfig**: identifica snapshots e AMIs criados com o VSS habilitado. A tag inclui informações meta, como a versão de `AwsVssComponents` e o ID do conjunto de snapshots.
Especificar qualquer uma dessas tags reservadas na sua lista de parâmetros causará um erro.

**VssVersion** (string, opcional)  
Somente para o documento `AWSEC2-VssInstallAndSnapshot`, você pode especificar o parâmetro `VssVersion` para instalar uma versão específica do pacote `AwsVssComponents` na instância. Deixe esse parâmetro em branco para instalar a versão padrão recomendada.  
Se a versão especificada do pacote `AwsVssComponents` já estiver instalada, o script pulará a etapa de instalação e passará para a etapa de backup. Para obter uma lista das versões do pacote `AwsVssComponents` e suporte operacional, consulte [Histórico de versões da solução AWS VSS](vss-comps-history.md).

## Execução de documentos de comando de snapshot de VSS do Systems Manager
<a name="create-vss-snapshots-ssm-methods"></a>

Você pode criar snapshots do EBS baseados no VSS com documentos de comando do AWS Systems Manager conforme a seguir.

### Execução do documento de comando AWSEC2-VssInstallAndSnapshot (recomendado)
<a name="create-with-AWSEC2-VssInstallAndSnapshot"></a>

Quando você usa o AWS Systems Manager para executar o documento `AWSEC2-VssInstallAndSnapshot`, o script executa as etapas a seguir.

1. O script primeiro instala ou atualiza o pacote `AwsVssComponents` na instância, dependendo de ele já estar ou não instalado.

1. O script cria os snapshots consistentes com a aplicação após a conclusão da primeira etapa.

Para executar o documento `AWSEC2-VssInstallAndSnapshot`, siga as etapas para o ambiente de sua preferência.

------
#### [ Console ]

**Criar snapshots do EBS baseados no VSS no console**

1. Abra o console AWS Systems Manager em [https://console.aws.amazon.com/systems-manager/](https://console.aws.amazon.com/systems-manager/).

1. Selecione **Run Command** no painel de navegação. Isso mostra uma lista dos comandos que estão sendo executados atualmente na conta, se aplicável.

1. Selecione **Run command**. Isso abre uma lista dos documentos de comando a que você tem acesso.

1. Selecione `AWSEC2-VssInstallAndSnapshot` na lista de documentos de comando. Para otimizar os resultados, você pode inserir todo ou parte do nome do documento. Você também pode filtrar pelo proprietário, por tipos de plataforma ou por tags.

   Quando você seleciona um documento de comando, os detalhes são preenchidos abaixo da lista.

1. Selecione `Default version at runtime` na lista **Versão do documento**.

1. Configure os **parâmetros de comando** para definir como `AWSEC2-VssInstallAndSnapshot` instalará o pacote `AwsVssComponents` e fará backup com snapshots ou com uma AMI do VSS. Para obter detalhes dos parâmetros, consulte [Parâmetros para documentos de snapshot de VSS do Systems Manager](#create-vss-snapshots-ssm-params).

1. Em **Seleção de alvos**, especifique as tags ou selecione manualmente as instâncias em que a operação deve ser executada.
**nota**  
Se selecionar manualmente as instâncias e uma instância que você espera ver não estiver incluída na lista, consulte [Onde estão minhas instâncias?](https://docs.aws.amazon.com/systems-manager/latest/userguide/troubleshooting-remote-commands.html#where-are-instances) para obter dicas de solução de problemas.

1. Para obter parâmetros adicionais para definir o comportamento do Run Command do Systems Manager, como, **Controle da taxa**, insira os valores como descrito em [Executar comandos no console](https://docs.aws.amazon.com/systems-manager/latest/userguide/running-commands-console.html).

1. Escolha **Run**.

   Se bem-sucedido, o comando preenche a lista de snapshots do EBS com os novos snapshots. É possível localizar esses snapshots na lista de snapshots do EBS procurando as tags que especificou ou então `AppConsistent`. Se a execução do comando falhou, exiba a saída do comando do Systems Manager para obter detalhes do motivo da falha. Se o comando for concluído com êxito, mas houver falha no backup de um volume específico, será possível solucionar essa falha na lista de volumes do EBS.

------
#### [ AWS CLI ]

Você pode executar os comandos a seguir na AWS CLI para criar snapshots do EBS baseados no VSS e obter o status da criação do snapshot.

**Criar snapshots do EBS baseados no VSS**  
Execute o comando a seguir para criar snapshots do EBS baseados no VSS. Para criar os snapshots, você deve identificar as instâncias com o parâmetro `--instance-ids`. Para obter mais informações sobre outros parâmetros que você pode usar, consulte [Parâmetros para documentos de snapshot de VSS do Systems Manager](#create-vss-snapshots-ssm-params).

```
aws ssm send-command \
	--document-name "AWSEC2-VssInstallAndSnapshot" \
	--instance-ids "{{i-01234567890abcdef}}" \
	--parameters '{"ExcludeBootVolume":["False"],"description":["Description"],"tags":["Key={{key_name}},Value={{tag_value}}"],"VssVersion":[""]}'
```

Se bem-sucedido, o documento de comando preenche a lista de snapshots do EBS com os novos snapshots. É possível localizar esses snapshots na lista de snapshots do EBS procurando as tags que especificou ou então `AppConsistent`. Se a execução do comando falhou, exiba a saída do comando para obter detalhes do motivo da falha.

**Obter status do comando**  
Para obter o status atual dos snapshots, execute o comando a seguir usando o ID de comando retornado de **send-command**.

```
aws ssm get-command-invocation
	--instance-ids "{{i-01234567890abcdef}}" \
	--command-id "{{a1b2c3d4-5678-90ab-cdef-EXAMPLE11111}}" \
	--plugin-name "CreateVssSnapshot"
```

------
#### [ PowerShell ]

Execute os comandos a seguir com o AWS Tools for Windows PowerShell para criar snapshots do EBS baseados no VSS e obter o status atual do runtime da criação da saída. Especifique os parâmetros descritos na lista anterior para modificar o comportamento do processo de snapshots.

**Criar snapshots do EBS baseados no VSS com o Tools for Windows PowerShell**  
Execute o comando a seguir para criar AMIs ou snapshots do EBS baseados no VSS.

```
Send-SSMCommand -DocumentName "AWSEC2-VssInstallAndSnapshot" -InstanceId "{{i-01234567890abcdef}}" -Parameter @{'ExcludeBootVolume'='False';'description'='{{a_description}}'
	;'tags'='Key={{key_name}},Value={{tag_value}}';'VssVersion'=''}
```

**Obter status do comando**  
Para obter o status atual dos snapshots, execute o comando a seguir usando o ID de comando retornado de **Send-SSMCommand**.

```
Get-SSMCommandInvocationDetail -InstanceId "{{i-01234567890abcdef}}" -CommandId "{{a1b2c3d4-5678-90ab-cdef-EXAMPLE11111}}" -PluginName "CreateVssSnapshot"
```

Se bem-sucedido, o comando preenche a lista de snapshots do EBS com os novos snapshots. É possível localizar esses snapshots na lista de snapshots do EBS procurando as tags que especificou ou então `AppConsistent`. Se a execução do comando falhou, exiba a saída do comando para obter detalhes do motivo da falha.

------

### Execução do documento de comandos AWSEC2-CreateVssSnapshot
<a name="create-with-AWSEC2-CreateVssSnapshot"></a>

Para executar o documento `AWSEC2-CreateVssSnapshot`, siga as etapas para o ambiente de sua preferência.

------
#### [ Console ]

**Criar snapshots do EBS baseados no VSS no console**

1. Abra o console AWS Systems Manager em [https://console.aws.amazon.com/systems-manager/](https://console.aws.amazon.com/systems-manager/).

1. Selecione **Run Command** no painel de navegação. Isso mostra uma lista dos comandos que estão sendo executados atualmente na conta, se aplicável.

1. Selecione **Run command**. Isso abre uma lista dos documentos de comando a que você tem acesso.

1. Selecione `AWSEC2-CreateVssSnapshot` na lista de documentos de comando. Para otimizar os resultados, você pode inserir todo ou parte do nome do documento. Você também pode filtrar pelo proprietário, por tipos de plataforma ou por tags.

   Quando você seleciona um documento de comando, os detalhes são preenchidos abaixo da lista.

1. Selecione `Default version at runtime` na lista **Versão do documento**.

1. Configure os **Parâmetros de comando** para definir como `AWSEC2-CreateVssSnapshot` fará backup com snapshots ou com uma AMI do VSS. Para obter detalhes dos parâmetros, consulte [Parâmetros para documentos de snapshot de VSS do Systems Manager](#create-vss-snapshots-ssm-params).

1. Em **Seleção de alvos**, especifique as tags ou selecione manualmente as instâncias em que a operação deve ser executada.
**nota**  
Se selecionar manualmente as instâncias e uma instância que você espera ver não estiver incluída na lista, consulte [Onde estão minhas instâncias?](https://docs.aws.amazon.com/systems-manager/latest/userguide/troubleshooting-remote-commands.html#where-are-instances) para obter dicas de solução de problemas.

1. Para obter parâmetros adicionais para definir o comportamento do Run Command do Systems Manager, como, **Controle da taxa**, insira os valores como descrito em [Executar comandos no console](https://docs.aws.amazon.com/systems-manager/latest/userguide/running-commands-console.html).

1. Escolha **Run**.

   Se bem-sucedido, o comando preenche a lista de snapshots do EBS com os novos snapshots. É possível localizar esses snapshots na lista de snapshots do EBS procurando as tags que especificou ou então `AppConsistent`. Se a execução do comando falhou, exiba a saída do comando do Systems Manager para obter detalhes do motivo da falha. Se o comando for concluído com êxito, mas houver falha no backup de um volume específico, será possível solucionar essa falha na lista de volumes do EBS.

------
#### [ AWS CLI ]

Você pode executar o comando a seguir na AWS CLI para criar snapshots do EBS baseados no VSS.

**Criar snapshots do EBS baseados no VSS**  
Execute o comando a seguir para criar snapshots do EBS baseados no VSS. Para criar os snapshots, você deve identificar as instâncias com o parâmetro `--instance-ids`. Para obter mais informações sobre outros parâmetros que você pode usar, consulte [Parâmetros para documentos de snapshot de VSS do Systems Manager](#create-vss-snapshots-ssm-params).

```
aws ssm send-command \
	--document-name "AWSEC2-CreateVssSnapshot" \
	--instance-ids "{{i-01234567890abcdef}}" \
	--parameters '{"ExcludeBootVolume":["False"],"description":["Description"],"tags":["Key={{key_name}},Value={{tag_value}}"]}'
```

Se bem-sucedido, o documento de comando preenche a lista de snapshots do EBS com os novos snapshots. É possível localizar esses snapshots na lista de snapshots do EBS procurando as tags que especificou ou então `AppConsistent`. Se a execução do comando falhou, exiba a saída do comando para obter detalhes do motivo da falha.

------
#### [ PowerShell ]

Execute o comando a seguir com o AWS Tools for Windows PowerShell para criar snapshots do EBS baseados no VSS.

**Criar snapshots do EBS baseados no VSS com o Tools for Windows PowerShell**  
Execute o comando a seguir para criar snapshots do EBS baseados no VSS. Para criar os snapshots, você deve identificar as instâncias com o parâmetro `InstanceId`. Você pode especificar mais de uma instância para a qual criar snapshots. Para obter mais informações sobre outros parâmetros que você pode usar, consulte [Parâmetros para documentos de snapshot de VSS do Systems Manager](#create-vss-snapshots-ssm-params).

```
Send-SSMCommand -DocumentName AWSEC2-CreateVssSnapshot -InstanceId "{{i-01234567890abcdef}}" -Parameter @{'ExcludeBootVolume'='False';'description'='{{a_description}}'
	;'tags'='Key={{key_name}},Value={{tag_value}}'}
```

Se bem-sucedido, o comando preenche a lista de snapshots do EBS com os novos snapshots. É possível localizar esses snapshots na lista de snapshots do EBS procurando as tags que especificou ou então `AppConsistent`. Se a execução de comando for malsucedida, exiba a saída de comando do para obter detalhes sobre o motivo da falha na execução. Se o comando for concluído com êxito, mas houver falha no backup de um volume específico, será possível solucionar essa falha na lista de snapshots do EBS.

------

### Execução de documentos de comando para um cluster de failover do Windows com armazenamento compartilhado do EBS
<a name="create-vss-win-failover-cluster"></a>

Você pode usar qualquer um dos procedimentos da linha de comandos descritos na seção anterior para criar um snapshot baseado no VSS. O documento de comando (`AWSEC2-VssInstallAndSnapshot` ou `AWSEC2-CreateVssSnapshot`) deve ser executado no nó primário do cluster. O documento falhará nos nós secundários, pois eles não têm acesso aos discos compartilhados. Se o primário e o secundário mudarem dinamicamente, você poderá executar o documento AWS Systems Manager Executar comando em vários nós com a expectativa de que o comando seja bem-sucedido no nó primário e falhe nos nós secundários.

**nota**  
Para automatizar os backups, você pode criar uma tarefa da janela de manutenção do AWS Systems Manager que use o documento `AWSEC2-VssInstallAndSnapshot`. Para obter mais informações, consulte [Trabalhar com janelas de manutenção (console)](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-working.html) no *Manual do usuário do AWS Systems Manager*.