# Update IDEA configuration (idea-admin.sh config) {% hint style="info" %} Use the **Config** command if you want to make a configuration change (e.g: enable SES, point DCV driver to a new version, change default security group ...). Refer to [Update IDEA configuration (idea-admin.sh config)](/idea/first-time-users/cluster-operations/update-idea-cluster/update-idea-configuration-idea-admin.sh-config.md) for other types of updates. {% endhint %} `idea-admin.sh config` utility is a powerful tool that allow you to control the vast majority of your cluster configuration/parameters without having to manually access the configuration files. In this example, we will demonstrate how you can easily update the integration of IDEA with AWS Backup. ## Workflow
* Admins run the `idea-admin.sh config` utility to retrieve/update the current configuration * Configuration change is updated on the Amazon DynamoDB table associated to the IDEA cluster * DynamoDB Stream updates the relevant IDEA module automatically after a configuration parameter has been changed {% hint style="info" %} Configuration keys are prefixed with the module information. See some examples below: * scheduler.security\_group\_id is linked to the [HPC WorkLoads](https://docs.ide-on-aws.com/hpc-simulations/) module * vdc.dcv\_host\_security\_group\_id is linked to the [Virtual Desktop Interface (VDI)](https://docs.ide-on-aws.com/virtual-desktop-interface/) module * directoryservice.root\_username\_secret\_arn is linked to the DirectoryService module {% endhint %} ## ./idea-admin.sh config show You can retrieve the current configuration of your IDEA cluster by running `./idea-admin.sh config show` utility. This utility also supports regular expressions as part of the `--query/-q` argument. For example, run the command below to list all configuration related to the integration of AWS Backup: ``` ./idea-admin.sh config show \ --cluster-name \ --aws-region \ --query "(.*)backup(.*)" +-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+---------+ | Key | Value | Version | +-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+---------+ | cluster.backups.backup_plan.arn | arn:aws:backup:us-east-2:REDACTED:backup-plan:c80992c6-8d7c-4708-9182-0bf81f20b3d2 | 2 | | cluster.backups.backup_plan.rules.default.completion_window_minutes | 480 | 1 | | cluster.backups.backup_plan.rules.default.delete_after_days | 7 | 1 | | cluster.backups.backup_plan.rules.default.move_to_cold_storage_after_days | - | 1 | | cluster.backups.backup_plan.rules.default.schedule_expression | cron(0 5 * * ? *) | 1 | | cluster.backups.backup_plan.rules.default.start_window_minutes | 60 | 1 | | cluster.backups.backup_plan.selection.tags | - Key=idea:ClusterName,Value= | 1 | | | - Key=idea:BackupPlan,Value=cluster | | | | | | | cluster.backups.backup_vault.arn | arn:aws:backup:us-east-2:REDACTED:backup-vault:-cluster-backup-vault | 2 | | cluster.backups.backup_vault.kms_key_id | - | 1 | | cluster.backups.backup_vault.removal_policy | DESTROY | 1 | | cluster.backups.enable_restore | True | 1 | | cluster.backups.enabled | True | 1 | | cluster.backups.role_arn | arn:aws:iam::REDACTED:role/-cluster-backup-role-us-east-2 | 2 | | cluster.logging.handlers.file.backupCount | 15 | 1 | | vdc.vdi_host_backup.backup_plan.arn | arn:aws:backup:us-east-2:REDACTED:backup-plan:d65c14d0-a970-4d3c-933e-4b658e1a6f3d | 1 | | vdc.vdi_host_backup.backup_plan.rules.default.completion_window_minutes | 480 | 1 | | vdc.vdi_host_backup.backup_plan.rules.default.delete_after_days | 7 | 1 | | vdc.vdi_host_backup.backup_plan.rules.default.move_to_cold_storage_after_days | - | 1 | | vdc.vdi_host_backup.backup_plan.rules.default.schedule_expression | cron(0 5 * * ? *) | 1 | | vdc.vdi_host_backup.backup_plan.rules.default.start_window_minutes | 60 | 1 | | vdc.vdi_host_backup.backup_plan.selection.tags | - Key=idea:ClusterName,Value= | 1 | | | - Key=idea:BackupPlan,Value=vdc | | | | | | | vdc.vdi_host_backup.enabled | True | 1 | +-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+---------+ ``` {% hint style="info" %} You can display the output in multiple formats (yaml/table/raw) {% endhint %} To continue our example, let's pretend we want to disable the AWS Backup integration. First, query your IDEA configuration to verify if the integration is active by checking the "cluster.backups.enabled" parameter. ``` ./idea-admin.sh config show \ --cluster-name \ --aws-region --query "cluster.backups.enabled" +-----------------------------+-------+---------+ | Key | Value | Version | +-----------------------------+-------+---------+ | cluster.backups.enabled. | True | 1 | +-----------------------------+-------+---------+ ``` Alternatively, you can validate this setting via the web interface under "**Cluster Settings**": ![](/files/HnhR0OBKMMaC2Zwla5Yr) ## ./idea-admin.sh config set To update this configuration parameter, run the `./idea-admin.sh config set` command and pass the `Key` argument via Key=\,Type=\,Value=\ ``` ./idea-admin.sh config set \ Key=cluster.backups.enabled,Type=bool,Value=False \ --cluster-name \ --aws-region +-----------------------------+-------+ | Key | Value | +-----------------------------+-------+ | cluster.backups.enabled. | False | +-----------------------------+-------+ ? Are you sure you want to update above config entries? Yes updating config: cluster.backups.enabled = False ``` {% hint style="info" %} Entry must be of below format: Key=KEY\_NAME,Type=\[str|int|float|bool|list|list|list|list],Value=\[VALUE|\[VALUE1,VALUE2,...]] Config key names cannot contain: comma(,), colon(:) Examples: 1. To set a **string** config type: ./idea-admin.sh config set Key=global-settings.string\_val,Type=string,Value=stringcontent --cluster-name \ --aws-region \ 2. To set an **integer** config type: ./idea-admin.sh config set Key=global-settings.int\_val,Type=int,Value=12 --cluster-name \ --aws-region \ 3. To set a config **with list of strings**: ./idea-admin.sh config set "Key=my\_config.string\_list,Type=list\,Value=value1,value2" --cluster-name \ --aws-region \ 4. To set a config **with list of integers**: ./idea-admin.sh config set "Key=my\_config.string\_list,Type=list\,Value=value1,value2" --cluster-name \ --aws-region \ 5. To set a config **with list of decimal/float**: ./idea-admin.sh config set "Key=my\_config.string\_list,Type=list\,Value=value1,value2" --cluster-name \ --aws-region \ 6. To set a config **with list of bool**: ./idea-admin.sh config set "Key=my\_config.string\_list,Type=list\,Value=value1,value2" --cluster-name \ --aws-region \ 7. Update multiple config entries: ./idea-admin.sh config set Key=global-settings.string\_val,Type=string,Value=stringcontent\ "Key=global-settings.integer\_list,Type=list,Value=1,2"\ "Key=global-settings.string\_list,Type=list,Value=str1,str2"\ \--cluster-name \\ \--aws-region \ {% endhint %} You can now re-run the `./idea-admin.sh config show` command to validate the configuration in the IDEA database has been updated correctly: ``` ./idea-admin.sh config show \ --cluster-name \ --aws-region --query "cluster.backups.enabled" +-----------------------------+-------+---------+ | Key | Value | Version | +-----------------------------+-------+---------+ | cluster.backups.enabled | False | 2 | +-----------------------------+-------+---------+ ``` Alternatively, you can validate this setting via the web interface under "**Cluster Settings**" and config the integration with AWS Backup is now disabled. ![](/files/y8rmKjv93eZWUCX5Wp0E) --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.ide-on-aws.com/idea/first-time-users/cluster-operations/update-idea-cluster/update-idea-configuration-idea-admin.sh-config.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.