9.5.3 ahf configuration

Use the ahf configuration command to change AHF configuration.

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:
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:
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]
Actions Description

set

Sets configuration property and value.

get

Gets configuration property and value.

unset

Unsets configuration property and value.

check

Checks configuration.

ahf configuration set

ahf configuration set --type CONFIGURATION_TYPE [OPTIONS]
Parameter Description

-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

--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.

--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

--url URL: Specify the full fleet insights registration URL.

--user-name USER_NAME: Specify the user name which the command requires.

--type repository

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

--size SIZE: Specify the maximum size of repository (MB).

--type 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 GoldenGate Service Manager port.

--type upload

--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 which the command requires.

--password: Specify to prompt for 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 configure a cell or 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 choose to enter different password for each cell node.
  • The password supplied while running the ahf configuration set command will override already stored password.

--type 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

--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 update.

--type upgrade

--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 upgrade.

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

–temporary-location TEMPORARY_LOCATION: Temporary location directory for AHF to extract the install archive to (must exist) (Default: /tmp)

--remove-installer REMOVE_INSTALLER: Flag to remove AHF installer zip from stage location after auto upgrade, Valid values: yes|no. By default, AHF does not remove the AHF installer zip.

–frequency FREQUENCY: Specify the autograde 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

--tool {tfa}: Currently, you can only specify tfa. Default: tfa

--cpu CPU: Specify a float number (rounded to 2 decimals) indicating the number of CPU that can be used.

CPU range of values: 0.5 <= value <= max_value
  • value is the float number you specify
  • max_value is the minimum of (4, total number of CPUs * 0.75)

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

Kmem range of values: 1600 <= value <= max_value
  • value is the integer you specify
  • max_value is the minimum of (20480, total system memory * 0.75)

--swmem SWMEM: Specify an integer number (in MB) indicating the memory+swap that can be used.

SWMEM range of values: 1600 <= value <= max_value
  • value is the integer you specify
  • max_value is the minimum of (20480, total system memory * 0.75)

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]
Parameter Description

--type TYPE

Specify the type of configuration to get.

Valid values:

  • GoldenGate microservice: goldengate
  • Upload configuration: upload

--name CONFIG_NAME

Specify unique configuration name for --type goldengate or --type upload.

--property PROPERTY_NAME

 Specify the name of the property.

--type upload

--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 which the command requires.

--password: Specify to prompt for 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: Spefiy 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 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

--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

--all: Specify to get all update configuration parameter details.

--type upgrade

--all: Specify to get all upgrade configuration parameter details.

Syntax: ahf configuration check

ahf configuration check [OPTIONS]
Parameter Description

--type TYPE

Specify the type of configuration to check.

--to-json

Specify to display the output in JSON format.

--name CONFIG_NAME

Specify configuration name to check if --type goldengate or --type upload.

--type cell

Specify the node name to validate the configuration of a cell or 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 flag to get status of cells configuration in JSON format.

--type smtp

--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.

Syntax: ahf configuration unset

ahf configuration unset [OPTIONS]
Parameter Description

--type TYPE

Specify the type of configuration to unset.

--type fleet-insights

--user-name USER_NAME: API registration user.

--url URL: Full fleet insights registration URL.

--type goldengate

--name CONFIG_NAME: Configuration name.

--type upload

--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 which the command requires.

--password: Specify to prompt for 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: Spefiy 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 a cell or the --all-nodes option to delete the configuration all cells.

For example:
  • ahf configuration unset --type cell --node <nodename>
  • ahf configuration unset --type cell --all-nodes

--type smtp

--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

--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 update.

--type upgrade

--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 upgrade.

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

–temporary-location TEMPORARY_LOCATION: Temporary location directory for AHF to extract the install archive to (must exist) (Default: /tmp)

--remove-installer REMOVE_INSTALLER: Flag to remove AHF installer zip from stage location after auto upgrade, Valid values: yes|no. By default, AHF does not remove the AHF installer zip.

–frequency FREQUENCY: Specify the autograde 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.

Syntax: AHF Balance

ahf configuration set --type CONFIGURATION_TYPE [OPTIONS]

Parameters

Table 9-128 ahf configuration set Command Parameters

Parameter Description

-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 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.

Parent topic: Running Unified AHF CLI Administration Commands

9.5.3.1 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.

Parent topic: ahf configuration