az netappfiles snapshot policy
Gerencie os recursos de política de instantâneo do Azure NetApp Files (ANF).
Comandos
| Name | Description | Tipo | Status |
|---|---|---|---|
| az netappfiles snapshot policy create |
Crie uma política de instantâneo. |
Core | disponibilidade geral |
| az netappfiles snapshot policy delete |
Excluir política de instantâneo. |
Core | disponibilidade geral |
| az netappfiles snapshot policy list |
Política de instantâneo de lista. |
Core | disponibilidade geral |
| az netappfiles snapshot policy show |
Obtenha uma Política de snapshot. |
Core | disponibilidade geral |
| az netappfiles snapshot policy update |
Atualize uma política de instantâneo. |
Core | disponibilidade geral |
| az netappfiles snapshot policy volumes |
Listar volumes associados à política de snapshot. |
Core | disponibilidade geral |
| az netappfiles snapshot policy wait |
Coloque a CLI em um estado de espera até que uma condição seja atendida. |
Core | disponibilidade geral |
az netappfiles snapshot policy create
Crie uma política de instantâneo.
az netappfiles snapshot policy create --account-name
--name --snapshot-policy-name
--resource-group
[--daily-hour]
[--daily-minute]
[--daily-snapshots --snapshots-to-keep]
[--days-of-month --monthly-days]
[--enabled {0, 1, f, false, n, no, t, true, y, yes}]
[--hour --monthly-hour]
[--hourly-minute --minute]
[--hourly-snapshots]
[--location]
[--monthly-minute]
[--monthly-snapshots]
[--tags]
[--weekly-day]
[--weekly-hour]
[--weekly-minute]
[--weekly-snapshots]
Exemplos
Criar uma política de instantâneo ANF
az netappfiles snapshot policy create -g mygroup --account-name myaccountname --snapshot-policy-name mysnapshotpolicyname -l westus2 --hourly-snapshots 1 --hourly-minute 5 --enabled true
Parâmetros Obrigatórios
O nome da conta NetApp.
O nome da política de instantâneo.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
Indica qual hora no fuso horário UTC um instantâneo deve ser tirado.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | DailySchedule Arguments |
Indica qual minuto instantâneo deve ser tirado.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | DailySchedule Arguments |
Contagem diária de instantâneos a manter.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | DailySchedule Arguments |
Indica quais dias do mês o instantâneo deve ser tirado. Uma cadeia de caracteres delimitada por vírgula.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | MonthlySchedule Arguments |
A propriedade para decidir a política está habilitada ou não.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Properties Arguments |
| Default value: | True |
| Valores aceites: | 0, 1, f, false, n, no, t, true, y, yes |
Indica qual hora no fuso horário UTC um instantâneo deve ser tirado.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | MonthlySchedule Arguments |
Indica qual minuto instantâneo deve ser tirado.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | HourlySchedule Arguments |
Contagem de instantâneos por hora a ser mantida.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | HourlySchedule Arguments |
A localização geográfica onde o recurso reside Quando não especificada, a localização do grupo de recursos será usada.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Body Arguments |
Indica qual minuto instantâneo deve ser tirado.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | MonthlySchedule Arguments |
Contagem mensal de instantâneos a manter.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | MonthlySchedule Arguments |
Tags de recursos. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Body Arguments |
Indica qual instantâneo de dias da semana deve ser tirado, aceita uma lista separada por vírgulas de nomes de dias da semana em inglês.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | WeeklySchedule Arguments |
Indica qual hora no fuso horário UTC um instantâneo deve ser tirado.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | WeeklySchedule Arguments |
Indica qual minuto instantâneo deve ser tirado.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | WeeklySchedule Arguments |
Contagem semanal de instantâneos a manter.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | WeeklySchedule Arguments |
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az netappfiles snapshot policy delete
Excluir política de instantâneo.
az netappfiles snapshot policy delete [--account-name]
[--ids]
[--name --snapshot-policy-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
Exemplos
Excluir uma política de instantâneo ANF
az netappfiles snapshot policy delete -g mygroup --account-name myaccname --snapshot-policy-name mysnapshotpolicyname
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
O nome da conta NetApp.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
O nome da política de instantâneo.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Não espere que a operação de longa duração termine.
| Propriedade | Valor |
|---|---|
| Valores aceites: | 0, 1, f, false, n, no, t, true, y, yes |
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Não solicite confirmação.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az netappfiles snapshot policy list
Política de instantâneo de lista.
az netappfiles snapshot policy list --account-name
--resource-group
Exemplos
Listar as políticas de snapshot para a conta ANF
az netappfiles snapshot policy list -g mygroup --account-name myname
Parâmetros Obrigatórios
O nome da conta NetApp.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az netappfiles snapshot policy show
Obtenha uma Política de snapshot.
az netappfiles snapshot policy show [--account-name]
[--ids]
[--name --snapshot-policy-name]
[--resource-group]
[--subscription]
Exemplos
Obter uma política de snapshot ANF
az netappfiles snapshot policy show -g mygroup --account-name myaccname --snapshot-policy-name mysnapshotpolicyname
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
O nome da conta NetApp.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
O nome da política de instantâneo.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az netappfiles snapshot policy update
Atualize uma política de instantâneo.
az netappfiles snapshot policy update [--account-name]
[--add]
[--daily-hour]
[--daily-minute]
[--daily-snapshots --snapshots-to-keep]
[--days-of-month --monthly-days]
[--enabled {0, 1, f, false, n, no, t, true, y, yes}]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--hour --monthly-hour]
[--hourly-minute --minute]
[--hourly-snapshots]
[--ids]
[--monthly-minute]
[--monthly-snapshots]
[--name --snapshot-policy-name]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--tags]
[--weekly-day]
[--weekly-hour]
[--weekly-minute]
[--weekly-snapshots]
Exemplos
Atualizar valores específicos para uma política de instantâneo ANF
az netappfiles snapshot policy update -g mygroup --account-name myaccountname --snapshot-policy-name mysnapshotpolicyname --daily-snapshots 1 --enabled false
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
O nome da conta NetApp.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Adicione um objeto a uma lista de objetos especificando um caminho e pares de valor de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Generic Update Arguments |
Indica qual hora no fuso horário UTC um instantâneo deve ser tirado.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | DailySchedule Arguments |
Indica qual minuto instantâneo deve ser tirado.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | DailySchedule Arguments |
Contagem diária de instantâneos a manter.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | DailySchedule Arguments |
Indica quais dias do mês o instantâneo deve ser tirado. Uma cadeia de caracteres delimitada por vírgula.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | MonthlySchedule Arguments |
A propriedade para decidir a política está habilitada ou não.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Properties Arguments |
| Valores aceites: | 0, 1, f, false, n, no, t, true, y, yes |
Ao usar 'set' ou 'add', preserve literais de string em vez de tentar converter para JSON.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Generic Update Arguments |
| Valores aceites: | 0, 1, f, false, n, no, t, true, y, yes |
Indica qual hora no fuso horário UTC um instantâneo deve ser tirado.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | MonthlySchedule Arguments |
Indica qual minuto instantâneo deve ser tirado.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | HourlySchedule Arguments |
Contagem de instantâneos por hora a ser mantida.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | HourlySchedule Arguments |
Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Indica qual minuto instantâneo deve ser tirado.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | MonthlySchedule Arguments |
Contagem mensal de instantâneos a manter.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | MonthlySchedule Arguments |
O nome da política de instantâneo.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OU --remove propertyToRemove.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Generic Update Arguments |
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Generic Update Arguments |
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Tags de recursos. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Body Arguments |
Indica qual instantâneo de dias da semana deve ser tirado, aceita uma lista separada por vírgulas de nomes de dias da semana em inglês.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | WeeklySchedule Arguments |
Indica qual hora no fuso horário UTC um instantâneo deve ser tirado.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | WeeklySchedule Arguments |
Indica qual minuto instantâneo deve ser tirado.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | WeeklySchedule Arguments |
Contagem semanal de instantâneos a manter.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | WeeklySchedule Arguments |
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az netappfiles snapshot policy volumes
Listar volumes associados à política de snapshot.
Obtenha todos os volumes ANF associados à política de snapshot.
az netappfiles snapshot policy volumes [--account-name]
[--ids]
[--resource-group]
[--snapshot-policy-name]
[--subscription]
Exemplos
Obter volumes ANF associados à política de snapshot especificada
az netappfiles snapshot policy volumes -g mygroup --account-name myaccname --snapshot-policy-name mysnapshotpolicyname
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
O nome da conta NetApp.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
O nome da política de instantâneo.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az netappfiles snapshot policy wait
Coloque a CLI em um estado de espera até que uma condição seja atendida.
az netappfiles snapshot policy wait [--account-name]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name --snapshot-policy-name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
O nome da conta NetApp.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Aguarde até ser criado com 'provisioningState' em 'Succeeded'.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Default value: | False |
Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
Aguarde até ser excluído.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Default value: | False |
Aguarde até que o recurso exista.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Default value: | False |
Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Intervalo de sondagem em segundos.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Default value: | 30 |
O nome da política de instantâneo.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Espera máxima em segundos.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Default value: | 3600 |
Aguarde até ser atualizado com provisioningState em 'Succeeded'.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Default value: | False |
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |