az networkcloud cluster
Note
This reference is part of the networkcloud extension for the Azure CLI (version 2.67.0 or higher). A extensão será instalada automaticamente na primeira vez que você executar um comando az networkcloud cluster . Learn more about extensions.
Manage cluster.
Comandos
Name | Description | Tipo | Status |
---|---|---|---|
az networkcloud cluster baremetalmachinekeyset |
Gerencie o conjunto de chaves de máquina bare metal do cluster. |
Extension | disponibilidade geral |
az networkcloud cluster baremetalmachinekeyset create |
Crie um novo conjunto de chaves de máquina bare metal ou atualize o existente para o cluster fornecido. |
Extension | disponibilidade geral |
az networkcloud cluster baremetalmachinekeyset delete |
Exclua o conjunto de chaves da máquina bare metal do cluster fornecido. |
Extension | disponibilidade geral |
az networkcloud cluster baremetalmachinekeyset list |
Liste os conjuntos de chaves da máquina bare metal do cluster. |
Extension | disponibilidade geral |
az networkcloud cluster baremetalmachinekeyset show |
Obtenha o conjunto de chaves da máquina bare metal do cluster fornecido. |
Extension | disponibilidade geral |
az networkcloud cluster baremetalmachinekeyset update |
Atualize as propriedades do conjunto de chaves de máquina bare metal para o cluster fornecido ou atualize as tags associadas a ele. As atualizações de propriedades e tags podem ser feitas de forma independente. |
Extension | disponibilidade geral |
az networkcloud cluster baremetalmachinekeyset wait |
Coloque a CLI em um estado de espera até que uma condição seja atendida. |
Extension | disponibilidade geral |
az networkcloud cluster bmckeyset |
Gerencie o conjunto de chaves do controlador de gerenciamento da placa base do cluster. |
Extension | disponibilidade geral |
az networkcloud cluster bmckeyset create |
Crie um novo conjunto de chaves do controlador de gerenciamento da placa base ou atualize o existente para o cluster fornecido. |
Extension | disponibilidade geral |
az networkcloud cluster bmckeyset delete |
Exclua o conjunto de chaves do controlador de gerenciamento da placa base do cluster fornecido. |
Extension | disponibilidade geral |
az networkcloud cluster bmckeyset list |
Liste os conjuntos de chaves do controlador de gerenciamento da placa base do cluster. |
Extension | disponibilidade geral |
az networkcloud cluster bmckeyset show |
Obtenha o conjunto de chaves do controlador de gerenciamento da placa base do cluster fornecido. |
Extension | disponibilidade geral |
az networkcloud cluster bmckeyset update |
Atualize as propriedades do conjunto de chaves do controlador de gerenciamento da placa base para o cluster fornecido ou atualize as tags associadas a ele. As atualizações de propriedades e tags podem ser feitas de forma independente. |
Extension | disponibilidade geral |
az networkcloud cluster bmckeyset wait |
Coloque a CLI em um estado de espera até que uma condição seja atendida. |
Extension | disponibilidade geral |
az networkcloud cluster continue-update-version |
Acionar a continuação de uma atualização para um cluster com uma estratégia de atualização correspondente que tenha sido pausada após a conclusão de um segmento da atualização. |
Extension | disponibilidade geral |
az networkcloud cluster create |
Crie um novo cluster ou atualize as propriedades do cluster, se ele existir. |
Extension | disponibilidade geral |
az networkcloud cluster delete |
Exclua o cluster fornecido. |
Extension | disponibilidade geral |
az networkcloud cluster deploy |
Implante o cluster. |
Extension | disponibilidade geral |
az networkcloud cluster list |
Liste clusters no grupo de recursos ou assinatura fornecidos. |
Extension | disponibilidade geral |
az networkcloud cluster metricsconfiguration |
Gerencie a configuração de métricas do cluster. |
Extension | disponibilidade geral |
az networkcloud cluster metricsconfiguration create |
Crie a configuração de métricas do cluster fornecido. |
Extension | disponibilidade geral |
az networkcloud cluster metricsconfiguration delete |
Exclua a configuração de métricas do cluster fornecido. |
Extension | disponibilidade geral |
az networkcloud cluster metricsconfiguration list |
Listar configurações de métricas do cluster. |
Extension | disponibilidade geral |
az networkcloud cluster metricsconfiguration show |
Obtenha a configuração de métricas do cluster fornecido. |
Extension | disponibilidade geral |
az networkcloud cluster metricsconfiguration update |
Atualize as propriedades da configuração de métricas para o cluster fornecido ou atualize as tags associadas a ele. As atualizações de propriedades e tags podem ser feitas de forma independente. |
Extension | disponibilidade geral |
az networkcloud cluster metricsconfiguration wait |
Coloque a CLI em um estado de espera até que uma condição seja atendida. |
Extension | disponibilidade geral |
az networkcloud cluster scan-runtime |
Acione a execução de uma verificação de proteção de tempo de execução para detetar e corrigir problemas detetados, de acordo com a configuração do cluster. |
Extension | disponibilidade geral |
az networkcloud cluster show |
Obtenha as propriedades do cluster fornecido. |
Extension | disponibilidade geral |
az networkcloud cluster update |
Atualize as propriedades do cluster fornecido ou atualize as tags associadas ao cluster. As atualizações de propriedades e tags podem ser feitas de forma independente. |
Extension | disponibilidade geral |
az networkcloud cluster update-version |
Atualize a versão do cluster fornecido para uma das versões suportadas disponíveis. |
Extension | disponibilidade geral |
az networkcloud cluster wait |
Coloque a CLI em um estado de espera até que uma condição seja atendida. |
Extension | disponibilidade geral |
az networkcloud cluster continue-update-version
Acionar a continuação de uma atualização para um cluster com uma estratégia de atualização correspondente que tenha sido pausada após a conclusão de um segmento da atualização.
az networkcloud cluster continue-update-version [--cluster-name --name]
[--ids]
[--machine-group-targeting-mode --mode {AlphaByRack}]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
Exemplos
Continuar uma atualização pausada para a versão do cluster
az networkcloud cluster continue-update-version --name "clusterName" --resource-group "resourceGroupName" --machine-group-targeting-mode "AlphaByRack"
Parâmetros Opcionais
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
O nome do cluster.
Propriedade | Valor |
---|---|
Parameter group: | 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 |
---|---|
Parameter group: | Resource Id Arguments |
O modo pelo qual o cluster direcionará o próximo agrupamento de servidores para continuar a atualização.
Propriedade | Valor |
---|---|
Parameter group: | ClusterContinueUpdateVersionParameters Arguments |
Default value: | AlphaByRack |
Valores aceites: | AlphaByRack |
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 |
---|---|
Parameter group: | 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 |
---|---|
Parameter group: | 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 |
Output format.
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 networkcloud cluster create
Crie um novo cluster ou atualize as propriedades do cluster, se ele existir.
az networkcloud cluster create --aggregator-or-single-rack-definition
--cluster-name --name
--cluster-type {MultiRack, SingleRack}
--cluster-version
--extended-location
--network-fabric-id
--resource-group
[--analytics-output-settings --ao-settings]
[--cluster-location]
[--cluster-service-principal]
[--co-settings --command-output-settings]
[--compute-deployment-threshold]
[--compute-rack-definitions]
[--if-match]
[--if-none-match]
[--location]
[--managed-resource-group-configuration --mrg]
[--mi-system-assigned {0, 1, f, false, n, no, t, true, y, yes}]
[--mi-user-assigned]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--runtime-protection]
[--sa-settings --secret-archive-settings]
[--tags]
[--update-strategy]
[--vs-settings --vulnerability-scanning-settings]
Exemplos
Criar ou atualizar cluster de rack único
az networkcloud cluster create --name "clusterName" -g "resourceGroupName" --extended-location name="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" type="CustomLocation" --location "eastus" --cluster-location "Foo Street, 3rd Floor, row 9" --cluster-service-principal application-id="12345678-1234-1234-1234-123456789012" password="password" principal-id="00000008-0004-0004-0004-000000000012" tenant-id="80000000-4000-4000-4000-120000000000" --cluster-type "SingleRack" --cluster-version "3.0.0" --compute-deployment-threshold type="PercentSuccess" grouping="PerCluster" value=90 --network-fabric-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default" --aggregator-or-single-rack-definition network-rack-id="/subscriptions/subscriptionId/resourceGroups/rgName/providers/Microsoft.Network/virtualNetworks/cmName/subnets/ClusterManagerSubnet" rack-sku-id="/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/VLab_Single_DellR750_8C2M_x70r3_9" rack-serial-number=b99m99r1 rack-location='b99m99r1' availability-zone=1 storage-appliance-configuration-data="[{rackSlot:1,adminCredentials:{username:'adminuser',password:'password'},storageApplianceName:name,serialNumber:serial}]" bare-metal-machine-configuration-data="[{bmcCredentials:{password:'bmcPassword',username:'root'},bmcMacAddress:'AA:BB:CC:DD:E7:08',bootMacAddress:'AA:BB:CC:F8:71:2E',machineName:lab00r750wkr1,rackSlot:2,serialNumber:5HS7PK3},{bmcCredentials:{password:'bmcPassword',username:'root'},bmcMacAddress:'AA:BB:CC:FD:DC:76',bootMacAddress:'AA:BB:CC:F8:50:CA',machineName:lab00r750wkr8,rackSlot:11,serialNumber:9M56PK3}]" --tags key1="myvalue1" key2="myvalue2" --mi-user-assigned "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myUAI" --command-output-settings identity-type="UserAssignedIdentity" identity-resource-id="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myUAI" container-url="https://myaccount.blob.core.windows.net/mycontainer?restype=container"
Criar ou atualizar cluster de rack único usando a entrada de arquivo json
az networkcloud cluster create --name "clusterName" -g "resourceGroupName" --extended-location name="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" type="CustomLocation" --location "eastus" --cluster-location "Foo Street, 3rd Floor, row 9" --cluster-service-principal application-id="12345678-1234-1234-1234-123456789012" password="password" principal-id="00000008-0004-0004-0004-000000000012" tenant-id="80000000-4000-4000-4000-120000000000" --cluster-type "SingleRack" --cluster-version "3.0.0" --compute-deployment-threshold type="PercentSuccess" grouping="PerCluster" value=90 --network-fabric-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default" --aggregator-or-single-rack-definition ./aggregator-or-single-rack-definition.json --tags key1="myvalue1" key2="myvalue2
Criar ou atualizar cluster de rack único com identidade atribuída ao usuário, configurações de saída de comando e configurações de saída de análise
az networkcloud cluster create --name "clusterName" -g "resourceGroupName" --extended-location name="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" type="CustomLocation" --location "eastus" --cluster-location "Foo Street, 2nd Floor, row 9" --cluster-service-principal application-id="0000-000-0000-0000-0000-00000000" password="password" principal-id="00000000-0000-0000-0000-000000000000" tenant-id="00000000-0000-0000-0000-000000000000" --cluster-type "SingleRack" --cluster-version "3.0.0" --compute-deployment-threshold type="PercentSuccess" grouping="PerCluster" value=90 --network-fabric-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default" --aggregator-or-single-rack-definition ./aggregator-or-single-rack-definition.json --tags key1="myvalue1" key2="myvalue2" --mi-user-assigned "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myUAI" --command-output-settings identity-type="UserAssignedIdentity" identity-resource-id="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myUAI" container-url="https://myaccount.blob.core.windows.net/mycontainer?restype=container" --analytics-output-settings analytics-workspace-id="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName" identity-type="UserAssignedIdentity" identity-resource-id="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myUAI"
Parâmetros Obrigatórios
A definição de rack que se destina a refletir apenas um único rack em um único cluster de rack ou um rack agregador em um cluster de vários racks. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
Propriedade | Valor |
---|---|
Parameter group: | Properties Arguments |
O nome do cluster.
O tipo de configuração de rack para o cluster.
Propriedade | Valor |
---|---|
Parameter group: | Properties Arguments |
Valores aceites: | MultiRack, SingleRack |
A versão atual do tempo de execução do cluster.
Propriedade | Valor |
---|---|
Parameter group: | Properties Arguments |
O local estendido do gerenciador de cluster associado ao cluster. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
Propriedade | Valor |
---|---|
Parameter group: | ClusterParameters Arguments |
A ID do recurso da malha de rede associada ao cluster.
Propriedade | Valor |
---|---|
Parameter group: | Properties Arguments |
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Parâmetros Opcionais
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
As configurações do espaço de trabalho de análise de log usado para a saída de logs desse cluster. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
Propriedade | Valor |
---|---|
Parameter group: | Properties Arguments |
As informações de localização fornecidas pelo cliente para identificar onde o cluster reside.
Propriedade | Valor |
---|---|
Parameter group: | Properties Arguments |
A entidade de serviço a ser usada pelo cluster durante a instalação do Arc Appliance. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
Propriedade | Valor |
---|---|
Parameter group: | Properties Arguments |
As configurações para comandos são executados nesse cluster, como comandos somente leitura de máquina bare metal e extrações de dados. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
Propriedade | Valor |
---|---|
Parameter group: | Properties Arguments |
O limite de validação que indica as falhas permitidas de máquinas de computação durante a validação e implantação do ambiente. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
Propriedade | Valor |
---|---|
Parameter group: | Properties Arguments |
A lista de definições de rack para os racks de computação em um cluster de vários racks ou uma lista vazia em um cluster de rack único. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
Propriedade | Valor |
---|---|
Parameter group: | Properties Arguments |
O ETag da transformação. Omita esse valor para sempre substituir o recurso atual. Especifique o valor ETag visto pela última vez para evitar a substituição acidental de alterações simultâneas.
Defina como '*' para permitir que um novo conjunto de registros seja criado, mas para impedir a atualização de um recurso existente. Outros valores resultarão em erro do servidor, pois não são suportados.
A localização geográfica onde o recurso reside Quando não especificada, a localização do grupo de recursos será usada.
Propriedade | Valor |
---|---|
Parameter group: | ClusterParameters Arguments |
A configuração do grupo de recursos gerenciados associado ao recurso. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
Propriedade | Valor |
---|---|
Parameter group: | Properties Arguments |
Habilite a identidade atribuída ao sistema.
Propriedade | Valor |
---|---|
Parameter group: | Managed Identity Arguments |
Valores aceites: | 0, 1, f, false, n, no, t, true, y, yes |
IDs de recursos separados por espaço para adicionar identidades atribuídas pelo usuário. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
Propriedade | Valor |
---|---|
Parameter group: | Managed Identity 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 |
As configurações para proteção de tempo de execução do cluster. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
Propriedade | Valor |
---|---|
Parameter group: | Properties Arguments |
As configurações para o arquivo secreto usado para armazenar credenciais para o cluster. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
Propriedade | Valor |
---|---|
Parameter group: | Properties Arguments |
Resource tags. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
Propriedade | Valor |
---|---|
Parameter group: | ClusterParameters Arguments |
A estratégia para atualizar o cluster. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
Propriedade | Valor |
---|---|
Parameter group: | Properties Arguments |
As configurações de como a verificação de vulnerabilidades de segurança é aplicada ao cluster. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
Propriedade | Valor |
---|---|
Parameter group: | Properties 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 |
Output format.
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 networkcloud cluster delete
Exclua o cluster fornecido.
az networkcloud cluster delete [--cluster-name --name]
[--ids]
[--if-match]
[--if-none-match]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
Exemplos
Delete cluster
az networkcloud cluster delete --name "clusterName" --resource-group "resourceGroupName"
Parâmetros Opcionais
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
O nome do cluster.
Propriedade | Valor |
---|---|
Parameter group: | 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 |
---|---|
Parameter group: | Resource Id Arguments |
O ETag da transformação. Omita esse valor para sempre substituir o recurso atual. Especifique o valor ETag visto pela última vez para evitar a substituição acidental de alterações simultâneas.
Defina como '*' para permitir que um novo conjunto de registros seja criado, mas para impedir a atualização de um recurso existente. Outros valores resultarão em erro do servidor, pois não são suportados.
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 |
---|---|
Parameter group: | 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 |
---|---|
Parameter group: | 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 |
Output format.
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 networkcloud cluster deploy
Implante o cluster.
az networkcloud cluster deploy [--cluster-name --name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--skip-validations-for-machines]
[--subscription]
Exemplos
Deploy cluster
az networkcloud cluster deploy --name "clusterName" --resource-group "resourceGroupName"
Implantar validação de pulo de cluster
az networkcloud cluster deploy --name "clusterName" --resource-group "resourceGroupName" --skip-validations-for-machines "bmmName1"
Parâmetros Opcionais
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
O nome do cluster.
Propriedade | Valor |
---|---|
Parameter group: | 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 |
---|---|
Parameter group: | 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 |
---|---|
Parameter group: | Resource Id Arguments |
Os nomes das máquinas bare metal no cluster que devem ser ignorados durante a validação do ambiente. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
Propriedade | Valor |
---|---|
Parameter group: | ClusterDeployParameters Arguments |
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Propriedade | Valor |
---|---|
Parameter group: | 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 |
Output format.
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 networkcloud cluster list
Liste clusters no grupo de recursos ou assinatura fornecidos.
az networkcloud cluster list [--max-items]
[--next-token]
[--resource-group]
Exemplos
Listar clusters para grupo de recursos
az networkcloud cluster list --resource-group "resourceGroupName"
Listar clusters para assinatura
az networkcloud cluster list
Parâmetros Opcionais
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Número total de itens a serem retornados na saída do comando. Se o número total de itens disponíveis for maior do que o valor especificado, um token será fornecido na saída do comando. Para retomar a paginação, forneça o valor do token em --next-token
argumento de um comando subsequente.
Propriedade | Valor |
---|---|
Parameter group: | Pagination Arguments |
Token para especificar por onde começar a paginar. Este é o valor de token de uma resposta truncada anteriormente.
Propriedade | Valor |
---|---|
Parameter group: | Pagination Arguments |
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 |
Output format.
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 networkcloud cluster scan-runtime
Acione a execução de uma verificação de proteção de tempo de execução para detetar e corrigir problemas detetados, de acordo com a configuração do cluster.
az networkcloud cluster scan-runtime [--cluster-name --name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--scan-activity {Scan, Skip}]
[--subscription]
Exemplos
Executar uma verificação de proteção de tempo de execução no cluster
az networkcloud cluster scan-runtime -n "clusterName" -g "resourceGroupName" --scan-activity "Scan"
Parâmetros Opcionais
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
O nome do cluster.
Propriedade | Valor |
---|---|
Parameter group: | 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 |
---|---|
Parameter group: | 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 |
---|---|
Parameter group: | Resource Id Arguments |
A escolha de se a operação de verificação deve executar a verificação.
Propriedade | Valor |
---|---|
Parameter group: | ClusterScanRuntimeParameters Arguments |
Default value: | Scan |
Valores aceites: | Scan, Skip |
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Propriedade | Valor |
---|---|
Parameter group: | 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 |
Output format.
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 networkcloud cluster show
Obtenha as propriedades do cluster fornecido.
az networkcloud cluster show [--cluster-name --name]
[--ids]
[--resource-group]
[--subscription]
Exemplos
Get cluster
az networkcloud cluster show --name "clusterName" --resource-group "resourceGroupName"
Parâmetros Opcionais
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
O nome do cluster.
Propriedade | Valor |
---|---|
Parameter group: | 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 |
---|---|
Parameter group: | Resource Id Arguments |
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Propriedade | Valor |
---|---|
Parameter group: | 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 |
---|---|
Parameter group: | 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 |
Output format.
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 networkcloud cluster update
Atualize as propriedades do cluster fornecido ou atualize as tags associadas ao cluster. As atualizações de propriedades e tags podem ser feitas de forma independente.
az networkcloud cluster update [--aggregator-or-single-rack-definition]
[--analytics-output-settings --ao-settings]
[--cluster-location]
[--cluster-name --name]
[--cluster-service-principal]
[--co-settings --command-output-settings]
[--compute-deployment-threshold]
[--compute-rack-definitions]
[--ids]
[--if-match]
[--if-none-match]
[--mi-system-assigned {0, 1, f, false, n, no, t, true, y, yes}]
[--mi-user-assigned]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--runtime-protection]
[--sa-settings --secret-archive-settings]
[--subscription]
[--tags]
[--update-strategy]
[--vs-settings --vulnerability-scanning-settings]
Exemplos
Localização do cluster de patches
az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName" --cluster-location "Foo Street, 3rd Floor, row 9" --tags key1="myvalue1" key2="myvalue2"
Agregador de cluster de patchOrSingleRackDefinition
az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName --aggregator-or-single-rack-definition "{networkRackId:'/subscriptions/subscriptionId/resourceGroups/rgName/providers/Microsoft.Network/virtualNetworks/cmName/subnets/ClusterManagerSubnet',rackSkuId:'/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/VLab_Single_DellR750_8C2M_x70r3_9',rackSerialNumber:b99m99r1,rackLocation:b99m99r1,availabilityZone:1,storageApplianceConfigurationData:[{rackSlot:1,adminCredentials:{username:'adminuser',password:'password'},storageApplianceName:name,serialNumber:serial}],bareMetalMachineConfigurationData:[{bmcCredentials:{password:'bmcPassword',username:'root'},bmcMacAddress:'AA:BB:CC:DD:E7:08',bootMacAddress:'AA:BB:CC:F8:71:2E',machineName:lab00r750wkr1,rackSlot:2,serialNumber:5HS7PK3},{bmcCredentials:{password:'bmcPassword',username:'root'},bmcMacAddress:'AA:BB:CC:FD:DC:76',bootMacAddress:'AA:BB:CC:F8:50:CA',machineName:lab00r750wkr8,rackSlot:11,serialNumber:9M56PK3}]}" --compute-deployment-threshold type="PercentSuccess" grouping="PerCluster" value=90 --tags key1="myvalue1" key2="myvalue2"
Agregador de cluster de patchOrSingleRackDefinition usando a entrada de arquivo json
az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName" --aggregator-or-single-rack-definition ./aggregator-or-single-rack-definition.json --compute-deployment-threshold type="PercentSuccess" grouping="PerCluster" value=90 --tags key1="myvalue1" key2="myvalue2"
Configuração de proteção de tempo de execução do cluster de patch
az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName" --runtime-protection enforcement-level="OnDemand"
Configurações de vulnerabilidade do patch
az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName" --vulnerability-scanning-settings container-scan="Enabled"
Estratégia de atualização do patch
az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName" --update-strategy strategy-type="Rack" threshold-type="CountSuccess" threshold-value=4 max-unavailable=4 wait-time-minutes=10
Definir identidade atribuída ao usuário (remove o sistema atribuído se tiver sido adicionado anteriormente)
az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName" --mi-user-assigned "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myUAI"
Definir identidade atribuída ao sistema (remove o usuário atribuído se tiver sido adicionado anteriormente)
az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName" --mi-system-assigned
Definir identidades atribuídas pelo sistema e pelo usuário ao cluster
az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName" --mi-system-assigned --mi-user-assigned "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myUAI"
Configurações de arquivo secreto de patch (a identidade do cluster é definida antes)
az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName" --secret-archive-settings identity-type="UserAssignedIdentity" identity-resource-id="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myUAI" vault_uri="https://keyvaultname.vault.azure.net/"
Configurações de saída do comando de patch (a identidade do cluster é definida antes)
az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName" --command-output-settings identity-type="UserAssignedIdentity" identity-resource-id="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myUAI" container-url="https://myaccount.blob.core.windows.net/mycontainer?restype=container"
Configurações de saída da análise de log de patch (a identidade do cluster é definida antes)
az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName" --analytics-output-settings analytics-workspace-id="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName" identity-type="UserAssignedIdentity" identity-resource-id="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity"
Parâmetros Opcionais
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
A definição de rack que se destina a refletir apenas um único rack em um único cluster de rack ou um rack agregador em um cluster de vários racks. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
Propriedade | Valor |
---|---|
Parameter group: | Properties Arguments |
As configurações do espaço de trabalho de análise de log usado para a saída de logs desse cluster. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
Propriedade | Valor |
---|---|
Parameter group: | Properties Arguments |
As informações de localização fornecidas pelo cliente para identificar onde o cluster reside.
Propriedade | Valor |
---|---|
Parameter group: | Properties Arguments |
O nome do cluster.
Propriedade | Valor |
---|---|
Parameter group: | Resource Id Arguments |
A entidade de serviço a ser usada pelo cluster durante a instalação do Arc Appliance. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
Propriedade | Valor |
---|---|
Parameter group: | Properties Arguments |
As configurações para comandos são executados nesse cluster, como comandos somente leitura de máquina bare metal e extrações de dados. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
Propriedade | Valor |
---|---|
Parameter group: | Properties Arguments |
O limite de validação que indica as falhas permitidas de máquinas de computação durante a validação e implantação do ambiente. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
Propriedade | Valor |
---|---|
Parameter group: | Properties Arguments |
A lista de definições de rack para os racks de computação em um cluster de vários racks ou uma lista vazia em um cluster de rack único. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
Propriedade | Valor |
---|---|
Parameter group: | Properties 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 |
---|---|
Parameter group: | Resource Id Arguments |
O ETag da transformação. Omita esse valor para sempre substituir o recurso atual. Especifique o valor ETag visto pela última vez para evitar a substituição acidental de alterações simultâneas.
Defina como '*' para permitir que um novo conjunto de registros seja criado, mas para impedir a atualização de um recurso existente. Outros valores resultarão em erro do servidor, pois não são suportados.
Habilite a identidade atribuída ao sistema.
Propriedade | Valor |
---|---|
Parameter group: | Managed Identity Arguments |
Valores aceites: | 0, 1, f, false, n, no, t, true, y, yes |
IDs de recursos separados por espaço para adicionar identidades atribuídas pelo usuário. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
Propriedade | Valor |
---|---|
Parameter group: | Managed Identity 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 |
---|---|
Parameter group: | Resource Id Arguments |
As configurações para proteção de tempo de execução do cluster. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
Propriedade | Valor |
---|---|
Parameter group: | Properties Arguments |
As configurações para o arquivo secreto usado para armazenar credenciais para o cluster. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
Propriedade | Valor |
---|---|
Parameter group: | Properties Arguments |
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Propriedade | Valor |
---|---|
Parameter group: | Resource Id Arguments |
As marcas de recursos do Azure que substituirão as existentes. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
Propriedade | Valor |
---|---|
Parameter group: | ClusterUpdateParameters Arguments |
A estratégia para atualizar o cluster. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
Propriedade | Valor |
---|---|
Parameter group: | Properties Arguments |
As configurações de como a verificação de vulnerabilidades de segurança é aplicada ao cluster. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
Propriedade | Valor |
---|---|
Parameter group: | Properties 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 |
Output format.
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 networkcloud cluster update-version
Atualize a versão do cluster fornecido para uma das versões suportadas disponíveis.
az networkcloud cluster update-version --target-cluster-version
[--cluster-name --name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
Exemplos
Atualizar a versão do cluster
az networkcloud cluster update-version --cluster-name "clusterName" --target-cluster-version "2.0" --resource-group "resourceGroupName"
Parâmetros Obrigatórios
A versão a ser aplicada ao cluster durante a atualização.
Propriedade | Valor |
---|---|
Parameter group: | ClusterUpdateVersionParameters Arguments |
Parâmetros Opcionais
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
O nome do cluster.
Propriedade | Valor |
---|---|
Parameter group: | 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 |
---|---|
Parameter group: | 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 |
---|---|
Parameter group: | 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 |
---|---|
Parameter group: | 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 |
Output format.
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 networkcloud cluster wait
Coloque a CLI em um estado de espera até que uma condição seja atendida.
az networkcloud cluster wait [--cluster-name --name]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Parâmetros Opcionais
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
O nome do cluster.
Propriedade | Valor |
---|---|
Parameter group: | Resource Id Arguments |
Aguarde até ser criado com 'provisioningState' em 'Succeeded'.
Propriedade | Valor |
---|---|
Parameter group: | 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 |
---|---|
Parameter group: | Wait Condition Arguments |
Aguarde até ser excluído.
Propriedade | Valor |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Aguarde até que o recurso exista.
Propriedade | Valor |
---|---|
Parameter group: | 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 |
---|---|
Parameter group: | Resource Id Arguments |
Intervalo de sondagem em segundos.
Propriedade | Valor |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | 30 |
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Propriedade | Valor |
---|---|
Parameter group: | 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 |
---|---|
Parameter group: | Resource Id Arguments |
Espera máxima em segundos.
Propriedade | Valor |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | 3600 |
Aguarde até ser atualizado com provisioningState em 'Succeeded'.
Propriedade | Valor |
---|---|
Parameter group: | 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 |
Output format.
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 |