|
| 1 | +--- |
| 2 | +title: azdata bdc hdfs settings reference |
| 3 | +titleSuffix: SQL Server big data clusters |
| 4 | +description: Reference article for azdata bdc hdfs settings commands. |
| 5 | +ms.prod: sql |
| 6 | +ms.technology: big-data-cluster |
| 7 | +--- |
| 8 | + |
| 9 | +# azdata bdc hdfs settings |
| 10 | + |
| 11 | +Applies to [!INCLUDE [azure-data-cli-azdata](../../includes/azure-data-cli-azdata.md)] |
| 12 | + |
| 13 | +The following article provides reference for the **hdfs settings** commands in the **azdata** tool. For more information about other **azdata** commands, see [azdata reference](reference-azdata.md) |
| 14 | + |
| 15 | +## Commands |
| 16 | +|Command|Description| |
| 17 | +| --- | --- | |
| 18 | +[azdata bdc hdfs settings set](#azdata-bdc-hdfs-settings-set) | Set hdfs service-scope settings. |
| 19 | +[azdata bdc hdfs settings show](#azdata-bdc-hdfs-settings-show) | Show hdfs service-scope settings and optionally hdfs settings for specified resources. |
| 20 | + |
| 21 | +## azdata bdc hdfs settings set |
| 22 | +Provides the ability to set a service-scoped or resource-scoped setting. Specify the full name of the setting and the value. Does not apply the setting to the running BDC. Run upgrade to do so. |
| 23 | +```bash |
| 24 | +azdata bdc hdfs settings set --settings -s |
| 25 | + |
| 26 | +``` |
| 27 | +### Examples |
| 28 | +Disable volume readthrough for the HDFS service |
| 29 | +```bash |
| 30 | +azdata bdc hdfs settings set --settings hdfs-site dfs.datanode.provided.volume.readthrough=false |
| 31 | +``` |
| 32 | +Set the replication factor for the Storage Pool resource |
| 33 | +```bash |
| 34 | +azdata bdc hdfs settings set --settings hdfs-site.dfs.replication=3 –resources storage-0 |
| 35 | +``` |
| 36 | + |
| 37 | +### Required Parameters |
| 38 | +#### `--settings -s` |
| 39 | +Sets the configured value for the provided settings. Multiple settings can be set using a comma separated list. |
| 40 | +### Optional Parameters |
| 41 | +#### `--resources` |
| 42 | +Sets the given setting(s) for the provided resource(s). Resources can be listed as a comma separated list. |
| 43 | + |
| 44 | +### Global Arguments |
| 45 | +#### `--debug` |
| 46 | +Increase logging verbosity to show all debug logs. |
| 47 | +#### `--help -h` |
| 48 | +Show this help message and exit. |
| 49 | +#### `--output -o` |
| 50 | +Output format. Allowed values: json, jsonc, table, tsv. Default: json. |
| 51 | +#### `--query -q` |
| 52 | +JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples. |
| 53 | +#### `--verbose` |
| 54 | +Increase logging verbosity. Use --debug for full debug logs. |
| 55 | + |
| 56 | +## azdata bdc hdfs settings show |
| 57 | +Shows the BDC's `hdfs` service-scope (optionally resource-scope) settings. By default, this command shows user-configured service-scope settings. Filters are available to show all settings (system-managed & configurable), configurable settings, or pending settings. To see a specific service-scope or resource-scope setting, you can provide the setting name. Use “recursive” to show settings for all resources as part of the service. |
| 58 | +```bash |
| 59 | + |
| 60 | +azdata bdc hdfs settings show |
| 61 | +[--settings -s] |
| 62 | +[--filter-option -f] |
| 63 | +[--recursive -rec] |
| 64 | +[--include-details -i] |
| 65 | +[--description -d] |
| 66 | +``` |
| 67 | +### Examples |
| 68 | +Show the user configured HDFS service-scope settings |
| 69 | +```bash |
| 70 | +azdata bdc hdfs settings show |
| 71 | +``` |
| 72 | +Show the replication factor for HDFS in the Storage Pool. |
| 73 | +```bash |
| 74 | +azdata bdc hdfs settings show --settings hdfs-site.dfs.replication --resources storage-0 |
| 75 | +``` |
| 76 | +Show the pending settings changes for the HDFS service-scope and resource-scope settings |
| 77 | +```bash |
| 78 | +azdata bdc hdfs settings show --filter-options=pending --recursive --include-details |
| 79 | +``` |
| 80 | +### Optional Parameters |
| 81 | +#### `--filter-options | -f` |
| 82 | +Options to filter which service-level or resource-scope settings are shown, rather than only user configured settings. Filters are available to show all settings (system-managed & user-configurable), all configurable settings, or pending settings. Options: `userConfigured`, `all`, `pending`, `configurable`. |
| 83 | +#### `--settings | -s` |
| 84 | +Shows information for the specified setting name(s) |
| 85 | +#### `--include-details | -i` |
| 86 | +Includes additional details for the settings chosen to be shown |
| 87 | +#### `--description | -d` |
| 88 | +Include the description of the setting. Must be used with --include-details |
| 89 | +#### `--resources | -r` |
| 90 | +Shows the setting(s) information for the given resource(s). Resources can be listed as a comma separated list. |
| 91 | +#### `--recursive | -rec` |
| 92 | +Shows the setting information for the given scope (service or service-resource) as well as all lower-scoped components (resources). |
| 93 | + |
| 94 | +### Global Arguments |
| 95 | +#### `--debug` |
| 96 | +Increase logging verbosity to show all debug logs. |
| 97 | +#### `--help -h` |
| 98 | +Show this help message and exit. |
| 99 | +#### `--output -o` |
| 100 | +Output format. Allowed values: json, jsonc, table, tsv. Default: json. |
| 101 | +#### `--query -q` |
| 102 | +JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples. |
| 103 | +#### `--verbose` |
| 104 | +Increase logging verbosity. Use --debug for full debug logs. |
| 105 | + |
| 106 | +## Next steps |
| 107 | + |
| 108 | +For more information about other **azdata** commands, see [azdata reference](reference-azdata.md). |
| 109 | + |
| 110 | +For more information about how to install the **azdata** tool, see [Install azdata to manage SQL Server 2019 big data clusters](../install/deploy-install-azdata.md). |
0 commit comments