1. Oracle Autonomous Health Framework User's Guide
  2. ahf configuration

ahf configuration

Use the ahf configuration command to change AHF configuration.

AHF 26.3

Store Switch Configuration Using AHF CLI

AHF 26.3 introduces the ability to manage switch configurations directly through the AHF CLI.

Switch configurations can be set, retrieved, checked, or unset using intuitive commands. All configurations are securely stored in the AHF wallet to ensure enhanced security and centralized management. Administrators can configure individual switches, multiple specific nodes, or all switches as needed.

  • Set Switch Configuration

    • Set configuration for a single switch:

      ahf configuration set --type switch --node

    • Set configuration for all switches:

      ahf configuration set --type switch --all-nodes

    • Set configuration for specific switches using --nodes:

      ahf configuration set --type switch --nodes node1,node2
# OR
ahf configuration set --type switch --nodes node1 node2

  • Unset Switch Configuration

    • Unset configuration for a single switch:

      ahf configuration unset --type switch --node

    • Unset configuration for all switches:

      ahf configuration unset --type switch --all-nodes

    • Unset configuration for specific switches using --nodes:

      ahf configuration unset --type switch --nodes node1,node2
# OR
ahf configuration unset --type switch --nodes node1 node2

  • Get Switch Configuration Status

    • Get configuration for a single switch:

      ahf configuration get --type switch --node

    • Get configuration for all switches:

      ahf configuration get --type switch --all-nodes

    • Get configuration for specific switches using --nodes:

      ahf configuration get --type switch --nodes node1,node2
# OR
ahf configuration get --type switch --nodes node1 node2

  • Check Switch Configuration

    • Check configuration for a single switch:

      ahf configuration check --type switch --node

    • Check configuration for all switches:

      ahf configuration check --type switch --all-nodes

AHF 25.8

Automating Excluded Compliance Checks

AHF 25.8 introduces a new mechanism to automate the management of excluded compliance checks.

Previously, to skip certain checks in compliance reports, the excluded_check_ids.txt file had to be manually created on each node.

With this release, the process is automated, and updates are automatically propagated to all nodes.

  • No need to manually create or distribute excluded_check_ids.txt across nodes.
  • Excluded check IDs can now be added, listed, replaced, or removed using the ahf configuration commands.
  • Changes are automatically propagated to all nodes.

Use case scenarios:

  • When excluded_check_ids.txt exists with valid checks

    To print the excluded check IDs:

    ahf configuration get --property ahf.compliance.excluded-check-ids

    Example output:

    Excluded checks:  
ahf.compliance.excluded-check-ids: ['CHECKID1', 'CHECKID2', 'CHECKID3']
  • When excluded_check_ids.txt does not exist

    To exclude a check ID:

    ahf configuration set --property ahf.compliance.excluded-check-ids --value CHECKID2

    Example output:

    Successfully updated.

    This creates or updates the excluded_check_ids.txt file.

  • Overwriting the list of excluded checks

    If the file already exists with valid checks, you can replace the list:

    ahf configuration set --property ahf.compliance.excluded-check-ids --value CHECKID3 --replace

    Example output:

    Excluded checks:  
Successfully updated.

    This replaces the existing list with the new check ID(s).

  • Unsetting excluded checks

    To remove specific excluded checks:

    ahf configuration unset --type compliance --excluded-check-ids LIST_OF_EXCLUDED_CHECKS

    To unset all excluded checks:

    ahf configuration reset --property ahf.compliance.excluded-check-ids

AHF 25.5

Upgrade Configuration Management

The AHF commands for managing upgrade configurations have been replaced with new SDK CLI commands. You are encouraged to transition to the new SDK CLI commands, as the existing ahfctl commands will be deprecated and be removed in a future release.

The legacy ahfctl command line, which is also slated for deprecation, currently provides the following commands for managing AHF upgrades:

  • ahfctl getupgrade
  • ahfctl setupgrade
  • ahfctl unsetupgrade

The following new commands are implemented within the ahf configuration command category, offering a simplified way to manage AHF upgrade configurations. However, to ensure compatibility with future releases and to benefit from enhanced functionality, you must adopt the new SDK CLI commands for upgrade management.

  • To set AHF upgrade configuration parameters, run:

    ahf configuration set --type upgrade [--software-stage SOFTWARE_STAGE] [--auto-upgrade AUTO_UPGRADE] [--upgrade-time UPGRADE_TIME][--file-system-type FILE_SYSTEM_TYPE] [-temporary-location TEMPORARY_LOCATION] [--remove-installer REMOVE_INSTALLER] [-frequency FREQUENCY] [--service-name SERVICE_NAME] [--auto-update AUTO_UPDATE]

  • To get AHF upgrade configuration parameter details, run:

    ahf configuration get --type upgrade [--to-json]

  • To unset AHF upgrade configuration parameters, run:

    ahf configuration unset --type upgrade [--software-stage SOFTWARE_STAGE] [--auto-upgrade AUTO_UPGRADE] [--upgrade-time UPGRADE_TIME][--file-system-type FILE_SYSTEM_TYPE] [-temporary-location TEMPORARY_LOCATION] [--remove-installer REMOVE_INSTALLER] [-frequency FREQUENCY] [--service-name SERVICE_NAME] [--auto-update AUTO_UPDATE]

AHF 25.1

Update Configuration Management

The AHF commands for managing update configurations have been replaced with new SDK CLI commands. You are encouraged to transition to the new SDK CLI commands, as the existing ahfctl commands will be deprecated and be removed in a future release.

The legacy ahfctl command line, which is also slated for deprecation, currently provides the following commands for managing AHF updates:

  • ahfctl setupdate
  • ahfctl getupdate
  • ahfctl unsetupdate

The following new commands are implemented within the ahf configuration command category, offering a simplified way to manage AHF update configurations. However, to ensure compatibility with future releases and to benefit from enhanced functionality, you must adopt the new SDK CLI commands for update management.

  • To set AHF update configuration parameters, run:

    ahf configuration set --type update [--all] [--software-stage SOFTWARE_STAGE] [--auto-update AUTO_UPDATE] [--file-system-type FILE_SYSTEM_TYPE] [-frequency FREQUENCY] [--service-name SERVICE_NAME] [--update-time UPDATE_TIME]

  • To get AHF update configuration parameter details, run:

    ahf configuration get --type update --all

  • To unset AHF update configuration parameters, run:

    ahf configuration unset [--all] [--software-stage SOFTWARE_STAGE] [--auto-update AUTO_UPDATE] [--file-system-type FILE_SYSTEM_TYPE] [-frequency FREQUENCY] [--service-name SERVICE_NAME] [--update-time UPDATE_TIME]

Syntax: ahf configuration

ahf configuration action [options]
  • set
    Sets the configuration property and value.
  • get
    Gets the configuration property and value.
  • unset
    Unsets the configuration property and value.
  • check
    Checks the configuration.

ahf configuration set

ahf configuration set --type CONFIGURATION_TYPE [OPTIONS]
  • -h, --help
    Show this help and exit.
  • --to-json
    Specify to display the output in JSON format.
  • --type TYPE
    Specify the type of configuration to access.
  • --name NAME
    Specify the name of the component or configuration.
  • --property NAME
    Specify the name of the property to set.
  • --value VALUE
    Specify the value of the property.
  • --type impact
    Configure AHF Balance impact analysis.

    --user-name USER_NAME: Specify the Oracle Enterprise Manager Repository user name.

    Note:

    Running this command prompts you to enter the password for the Oracle Enterprise Manager Repository user. The Oracle Enterprise Manager Repository user can be any Enterprise Manager (EM) user with the Target Privilege: View any Target. AHF Balance connects to an EM repository instance as the specified user.

    --connect-string CONNECT_STRING: Specify the connect string for the Oracle Enterprise Manager Repository.

    For example: @[//]my EM host[:port][/my AHF EM service_name]

    Ensure that Transparent Application Failover (TAF) is not enabled for this service.

  • --type fleet-insights
    Configure Fleet Insights.

    --url URL: Specify the full Fleet Insights registration URL.

    --user-name USER_NAME: Specify the user name required by the command.

  • --type repository
    Configure the AHF repository.

    --location LOCATION: Specify a new location for the repository.

    --size SIZE: Specify the maximum size of the repository in MB.

  • --type goldengate
    Configure Oracle GoldenGate.

    --all: Specify to set all parameters interactively.

    --host-name HOST_NAME: Specify the fully qualified host name with domain name.

    --db-name DB_NAME: Specify the database name.

    --port PORT: Specify the GoldenGate Service Manager port.

  • --type upload
    Configure an upload endpoint.

    --endpoint-type {https,bugdb,sqlnet,sftp}: Specify the upload endpoint type.

    --all: Specify to set all parameters interactively.

    --host-name HOST_NAME: Specify the fully qualified host name with domain name.

    --user-name USER_NAME: Specify the user name required by the command.

    --password: Specify to prompt for a password.

    --url URL: Specify the full registration or upload URL.

    --port PORT: Specify the service port number.

    --store-type STORE_TYPE: Specify the store type.

    --proxy PROXY: Specify the proxy URL.

    --connect-string CONNECT_STRING: Specify the connect string for the Oracle Enterprise Manager Repository.

    --upload-table UPLOAD_TABLE: Specify the upload table name.

    --no-authentication: Specify if no authentication is required.

    --https-token HTTPS_TOKEN: Specify the HTTPS token to log in.

    --https-header HTTPS_HEADER: Specify the HTTPS header string.

    --request-type REQUEST_TYPE: Specify the HTTPS request type.

  • --type cell
    Specify a node to configure a cell, or use the --all-nodes option to configure all cells.

    For example:

    ahf configuration set --type cell --node <nodename> --password

    ahf configuration set --type cell --all-nodes

    Note:

    Configurations set through the AHF CLI are securely stored in the AHF wallet.

    You can specify a different password for each cell node. The password supplied when you run the ahf configuration set command overrides an already stored password.

  • --type smtp
    Configure SMTP.

    --all: Specify to set all smtp configuration parameters interactively.

    --host-name HOST_NAME: Specify the name of the SMTP server, for example, smtphostname.

    --user-name USER_NAME: Specify the name of the SMTP user required by the command or API registration, for example, smtpuser.

    --password: Specify the password of the SMTP user.

    --from FROM_EMAIL: Specify the email address of the sender.

    --to TO: Specify the email address of the recipient.

    --port PORT: Specify the port of the SMTP server, for example, 44.

    --cc CC: Specify the CC email address.

    --bcc BCC: Specify the BCC email address.

    --ssl: Specify true to enable SSL and false to disable SSL. Default: false.

    --no-authentication: Specify true to enable SMTP authentication and false to disable SMTP authentication. Default: false.

  • --type update
    Configure AHF automatic updates.

    --all: Specify to set all update configuration parameters in interactive mode.

    --software-stage SOFTWARE_STAGE: Specify the software stage location.

    --auto-update AUTO_UPDATE: Specify to enable or disable autoupdate. Default: on. Valid values: on|off.

    --file-system-type FILE_SYSTEM_TYPE: Specify the stage location file system type.

    --frequency FREQUENCY: Specify the autoupdate frequency in days in the range (1,30), for example, 15.

    --service-name SERVICE_NAME: Specify the name of the REST download service. Default: ahf_update_loc.

    --update-time UPDATE_TIME: Specify the time for the update.

  • --type upgrade
    Configure AHF automatic upgrades.

    --all: Specify to set all upgrade configuration parameters in interactive mode.

    --software-stage SOFTWARE_STAGE: Specify the software stage location.

    --auto-upgrade AUTO_UPGRADE: Specify to enable or disable autoupgrade. Default: on. Valid values: on|off.

    --upgrade-time UPGRADE_TIME: Specify the time for the upgrade.

    --file-system-type FILE_SYSTEM_TYPE: Specify the stage location file system type.

    --temporary-location TEMPORARY_LOCATION: Specify the temporary directory where AHF extracts the installation archive. The directory must exist. Default: /tmp.

    --remove-installer REMOVE_INSTALLER: Specify whether to remove the AHF installer ZIP from the stage location after an automatic upgrade. Valid values: yes|no. By default, AHF does not remove the AHF installer ZIP.

    --frequency FREQUENCY: Specify the autoupgrade frequency in days in the range (1,30), for example, 15.

    --service-name SERVICE_NAME: Specify the name of the REST download service. Default: ahf_upgrade_loc.

    --auto-update AUTO_UPDATE: Specify to enable or disable autoupdate. Default: on. Valid values: on|off.

  • --type resource-limit
    Configure AHF resource limits.

    --tool {tfa}: Specify the tool. Currently, only tfa is supported. Default: tfa.

    --cpu CPU: Specify a floating-point number, rounded to two decimal places, indicating the number of CPUs that can be used.

    CPU range: 0.5 <= value <= max_value

    Where:

    • value is the floating-point number you specify.
    • max_value is the minimum of 4 and total number of CPUs * 0.75.

    --kmem KMEM: Specify an integer in MB indicating the kernel memory that can be used.

    Kmem range: 1600 <= value <= max_value

    Where:

    • value is the integer you specify.
    • max_value is the minimum of 20480 and total system memory * 0.75.

    --swmem SWMEM: Specify an integer in MB indicating the memory plus swap that can be used.

    SWMEM range: 1600 <= value <= max_value

    Where:

    • value is the integer you specify.
    • max_value is the minimum of 20480 and total system memory * 0.75.
  • --type switch
    Configure switches.

    --node <nodename>: Sets configuration for a single switch.

    --all-nodes: Sets configuration for all switches.

Note:

  • --user-name is the Oracle Enterprise Manager Repository user name if --type impact
  • --user-name is the API registration user if --type fleet-insights
  • --user-name is the upload configuration user if --type upload
  • --user-name is the GoldenGate service manager user if --type goldengate
  • --name is the component name if --type repository
  • --name is the configuration name if --type goldengate

Values supported for --property :

  • Repository properties:

  • reposizeMB

    • repositorydir
  • Global properties:

    gather_ahf_feature_usage

  • User properties:
  • ahf.insights.max-collection-interval
  • ahf.collectors.enhanced_os_metrics
  • Resource limit properties:
  • ahf.tfa.resource-cpu
  • ahf.tfa.resource-kmem
  • ahf.tfa.resource-swmem
  • Excluded check IDs:

    ahf.compliance.excluded-check-ids

Syntax: ahf configuration get

ahf configuration get [OPTIONS]

  • --type TYPE
    Specify the type of configuration to get.

    Valid values:

    • goldengate: GoldenGate microservice configuration.
    • upload: Upload configuration.
  • --name CONFIG_NAME
    Specify the unique configuration name for --type goldengate or --type upload.
  • --property PROPERTY_NAME
    Specify the name of the property.
  • --type upload
    Get upload configuration parameters.

    --endpoint-type {https,bugdb,sqlnet,sftp}: Specify the upload endpoint type.

    --all: Specify to get all parameters.

    --host-name HOST_NAME: Specify the fully qualified host name with domain name.

    --user-name USER_NAME: Specify the user name required by the command.

    --password: Specify to prompt for a password.

    --url URL: Specify the full registration or upload URL.

    --port PORT: Specify the service port number.

    --store-type STORE_TYPE: Specify the store type.

    --proxy PROXY: Specify the proxy URL.

    --connect-string CONNECT_STRING: Specify the connect string for the Oracle Enterprise Manager Repository.

    --upload-table UPLOAD_TABLE: Specify the upload table name.

    --no-authentication: Specify if no authentication is required.

    --https-token HTTPS_TOKEN: Specify the HTTPS token to log in.

    --https-header HTTPS_HEADER: Specify the HTTPS header string.

    --request-type REQUEST_TYPE: Specify the HTTPS request type.

  • --type cell
    Specify the node name to get the configuration status of a cell, or use the --all-nodes option to get the configuration status of all cells.

    For example:

    • ahf configuration get --type cell --node <nodename>
    • ahf configuration get --type cell --all-nodes
  • --type smtp
    Get SMTP configuration parameters.

    --all: Specify to get all smtp configuration parameters.

    --host-name HOST_NAME: Specify the name of the SMTP server, for example, smtphostname.

    --user-name USER_NAME: Specify the name of the SMTP user required by the command or API registration, for example, smtpuser.

    --password: Specify the password of the SMTP user.

    --from FROM_EMAIL: Specify the email address of the sender.

    --to TO: Specify the email address of the recipient.

    --port PORT: Specify the port of the SMTP server, for example, 44.

    --cc CC: Specify the CC email address.

    --bcc BCC: Specify the BCC email address.

    --ssl: Specify true to enable SSL and false to disable SSL. Default: false.

    --no-authentication: Specify true to enable SMTP authentication and false to disable SMTP authentication. Default: false.

  • --type update
    Get AHF update configuration parameters.

    --all: Specify to get details of all update configuration parameters.

  • --type upgrade
    Get AHF upgrade configuration parameters.

    --all: Specify to get details of all upgrade configuration parameters.

  • --type switch
    Get switch configuration.

    --node <nodename>: Gets configuration for a single switch.

    --all-nodes: Gets configuration for all switches.

Syntax: ahf configuration check

ahf configuration check [OPTIONS]
  • --type TYPE
    Specify the type of configuration to check.
  • --to-json
    Specify to display the output in JSON format.
  • --name CONFIG_NAME
    Specify the configuration name to check when using --type goldengate or --type upload.

  • --type cell
    Specify the node name to validate the configuration of a cell, or use the --all-nodes option to validate the configuration of all cells.

    For example:

    • ahf configuration check --type cell --node <nodename>
    • ahf configuration check --type cell --all-nodes

    Note:

    Use the --to-json option to display the cell configuration status in JSON format.

  • --type smtp
    Check SMTP configuration parameters.

    --all: Specify to check all smtp configuration parameters.

    --host-name HOST_NAME: Specify the name of the SMTP server, for example, smtphostname.

    --user-name USER_NAME: Specify the name of the SMTP user required by the command or API registration, for example, smtpuser.

    --password: Specify the password of the SMTP user.

    --from FROM_EMAIL: Specify the email address of the sender.

    --to TO: Specify the email address of the recipient.

    --port PORT: Specify the port of the SMTP server, for example, 44.

    --cc CC: Specify the CC email address.

    --bcc BCC: Specify the BCC email address.

    --ssl: Specify true to enable SSL and false to disable SSL. Default: false.

    --no-authentication: Specify true to enable SMTP authentication and false to disable SMTP authentication. Default: false.

  • --type switch
    Check switch configuration.

    --node <nodename>: Checks configuration for a single switch.

    --all-nodes: Checks configuration for all switches.

Syntax: ahf configuration unset

ahf configuration unset [OPTIONS]
  • --type TYPE
    Specify the type of configuration to unset.
  • --type fleet-insights
    Unset Fleet Insights configuration.

    --user-name USER_NAME: Specify the API registration user.

    --url URL: Specify the full Fleet Insights registration URL.

  • --type goldengate
    Unset Oracle GoldenGate configuration.

    --name CONFIG_NAME: Specify the configuration name.

  • --type upload
    Unset upload configuration.

    --endpoint-type {https,bugdb,sqlnet,sftp}: Specify the upload endpoint type.

    --all: Specify to unset all parameters.

    --host-name HOST_NAME: Specify the fully qualified host name with domain name.

    --user-name USER_NAME: Specify the user name required by the command.

    --password: Specify to prompt for a password.

    --url URL: Specify the full registration or upload URL.

    --port PORT: Specify the service port number.

    --store-type STORE_TYPE: Specify the store type.

    --proxy PROXY: Specify the proxy URL.

    --connect-string CONNECT_STRING: Specify the connect string for the Oracle Enterprise Manager Repository.

    --upload-table UPLOAD_TABLE: Specify the upload table name.

    --no-authentication: Specify if no authentication is required.

    --https-token HTTPS_TOKEN: Specify the HTTPS token to log in.

    --https-header HTTPS_HEADER: Specify the HTTPS header string.

    --request-type REQUEST_TYPE: Specify the HTTPS request type.

  • --type cell
    Specify the node name to delete the configuration for a cell, or use the --all-nodes option to delete the configuration for all cells.

    For example:

    • ahf configuration unset --type cell --node <nodename>
    • ahf configuration unset --type cell --all-nodes
  • --type smtp
    Unset SMTP configuration parameters.

    --all: Specify to unset all smtp configuration parameters.

    --host-name HOST_NAME: Specify the name of the SMTP server, for example, smtphostname.

    --user-name USER_NAME: Specify the name of the SMTP user required by the command or API registration, for example, smtpuser.

    --password: Specify the password of the SMTP user.

    --from FROM_EMAIL: Specify the email address of the sender.

    --to TO: Specify the email address of the recipient.

    --port PORT: Specify the port of the SMTP server, for example, 44.

    --cc CC: Specify the CC email address.

    --bcc BCC: Specify the BCC email address.

    --ssl: Specify true to enable SSL and false to disable SSL. Default: false.

    --no-authentication: Specify true to enable SMTP authentication and false to disable SMTP authentication. Default: false.

  • --type update
    Unset AHF update configuration parameters.

    --all: Specify to unset all update configuration parameters.

    --software-stage SOFTWARE_STAGE: Specify the software stage location.

    --auto-update AUTO_UPDATE: Specify to enable or disable autoupdate. Default: on. Valid values: on|off.

    --file-system-type FILE_SYSTEM_TYPE: Specify the stage location file system type.

    --frequency FREQUENCY: Specify the autoupdate frequency in days in the range (1,30), for example, 15.

    --service-name SERVICE_NAME: Specify the name of the REST download service. Default: ahf_update_loc.

    --update-time UPDATE_TIME: Specify the time for the update.

  • --type upgrade
    Unset AHF upgrade configuration parameters.

    --all: Specify to unset all upgrade configuration parameters.

    --software-stage SOFTWARE_STAGE: Specify the software stage location.

    --auto-upgrade AUTO_UPGRADE: Specify to enable or disable autoupgrade. Default: on. Valid values: on|off.

    --upgrade-time UPGRADE_TIME: Specify the time for the upgrade.

    --file-system-type FILE_SYSTEM_TYPE: Specify the stage location file system type.

    --temporary-location TEMPORARY_LOCATION: Specify the temporary directory where AHF extracts the installation archive. The directory must exist. Default: /tmp.

    --remove-installer REMOVE_INSTALLER: Specify whether to remove the AHF installer ZIP from the stage location after an automatic upgrade. Valid values: yes|no. By default, AHF does not remove the AHF installer ZIP.

    --frequency FREQUENCY: Specify the autoupgrade frequency in days in the range (1,30), for example, 15.

    --service-name SERVICE_NAME: Specify the name of the REST download service. Default: ahf_upgrade_loc.

    --auto-update AUTO_UPDATE: Specify to enable or disable autoupdate. Default: on. Valid values: on|off.

  • --type switch
    Unset switch configuration.

    --node <nodename>: Unsets configuration for a single switch.

    --all-nodes: Unsets configuration for all switches.

Syntax: AHF Balance

ahf configuration set --type CONFIGURATION_TYPE [OPTIONS]

Parameters

ahf configuration set Command Parameters

  • -h, --help
    Show this help and exit.
  • --type CONFIGURATION_TYPE
    Specify the type of configuration (impact) to access.
  • --connect-string CONNECT_STRING
    Specify the connect string for the Oracle Enterprise Manager repository.
  • --user-name USER_NAME
    Specify the Oracle Enterprise Manager repository user name.

Note:

Running this command will prompt you to enter the password for the Oracle Enterprise Manager repository user. The Oracle Enterprise Manager repository user can be any Enterprise Manager (EM) user with Target Privilege: View any Target. AHF Balance connects to an EM repository instance as the specified user.

Store Exadata Infrastructure Details for Best Practice Checking

The ahf CLI stores the details of Exadata Dom0s, storage servers, and switches. These stored details are subsequently used for Best Practice checks.

AHF may not discover all Exadata infrastructure when run on Dom0. As a result, Best Practice checks might miss peer Dom0s, storage servers, and switches.

The ahf CLI provides the ability to save the details of Exadata Dom0s, storage servers, and switches, using the command:ahf configuration set --type cell --node {nodename} --password. The Best Practice checks will then use this saved configuration for full infrastructure analysis.

AHF discovers peer DomUs from the Oracle Cluster Registry. By merging Oracle Exachk reports from DomU and Dom0, it provides a comprehensive report for the entire Exadata rack.

To merge Oracle Exachk reports, run `exachk -merge *report_1*,*report_2*`.