Updating the agent configuration files
model9-stdenv.sh
The following parameters are optional unless indicated otherwise:
Parameter | Description | Default |
|---|---|---|
JAVA_HOME | (Required) 64-bit Java home path | None |
TIME_ZONE | (Required) Java time zone, for example, America/New_York | None |
TCPIP_NAME | TCP/IP stack used by the agent1 | TCPIP |
AGENT_MEMORY | Allocated Java heap space for the agent. 1 GB is the minimum value. | 1 GB |
LIFE_CYCLE_MEMORY | Allocated Java heap space for life cycle management. 256 MB is the minimum value. | 256 MB |
SAPI_MEMORY | Allocated Java heap space for the server API (M9SAPI). 56 MB is the minimum value. | 56 MB |
SAPI_NETWORK_DEBUG | Enable network level debug for server API (M9SAPI). Valid values are true and false. | false |
SAPI_KEYRING_NAME | The SAF keyring name to be used as a truststore during server API certificate validation. If specified, the keyring is searched at &SYSUID/keyRingName | None |
SEC_FILE | A security file path to disable weak ciphers The security.properties file is provided in the BMC AMI Cloud download package. For more information about customizing the security file, see Disabling weak ciphers. | $PWD/properties/security.properties |
1 If your environment has multiple TCP/IP stacks, use the DISPLAY TCPIP operator command to display the TCP/IP stack name, as shown in the following example:
EZAOP50I TCPIP STATUS REPORT 264
COUNT TCPIP NAME VERSION STATUS
----- ---------- -------- --------------------------------
1 TCPIP CS V2R5 ACTIVE
*** END TCPIP STATUS REPORT ***
EZAOP41I 'DISPLAY TCPIP' COMMAND COMPLETED SUCCESSFULLY
agent.yml
The following parameters are optional unless indicated otherwise:
Parameter | Description | Default |
|---|---|---|
port | Agent’s listening port for server HTTPS communication | 9999 |
keystore | Agent keystore in JKS format, which contains only one key entry to be used by the agent for incoming HTTPS requests. For more information, see Securing the server to agent communication. | agent.jks |
keystore_password | Provided keystore password | agent |
truststore | Agent truststore in JKS format, which the agent will use to trust incoming HTTPS requests. For more information, Securing the server to agent communication. | keystore value |
truststore_password | Provided truststore password | keystore_password value |
Configure the object storage settings by providing the following parameters:
The following parameters are optional unless indicated otherwise:
Parameter | Description | Value |
|---|---|---|
objstore.endpoint.url | (Required) URL of the object storage The URL should start with http:// or https:// | Default: none |
objstore.endpoint.userid | (Required) Access key to object storage | Default: none |
objstore.endpoint.password | (Required) Secret key to object storage | Default: none |
objstore.endpoint.password_encrypted | Determines whether the object storage password is obfuscated | Default: false |
objstore.resources.container.name | (Required) Container or bucket name | Default: model9-data |
objstore.endpoint.api.id | Object storage API name | Default: s3 Amazon AWS: aws-s3 Microsoft Azure: azureblob |
objstore.endpoint.api.s3.v4signatures | When using object storage that uses V4 signatures, set this parameter to true, in addition to api.id: s3 | Default: false Cohesity: true HCP-CS: true |
objstore.endpoint.no.verify.ssl | When using the HTTPS protocol, set to true to avoid SSL certificate verifications1 | Default: true |
objstore.endpoint.tier | Object storage tier to use for created blobs (only when using AWS S3 or Azure Blob) | Valid values are as follows:
|
objstore.endpoint.api.s3.calculatemd5 | Enables MD5 checksum calculation to be included in putObject requests. This parameter is required for Object Lock enabled buckets. | Valid values: true|false Default: false |
| objstore.jclouds-config.jclouds.s3.virtual-host-buckets | Defines whether to use virtual hosting url When you specify true, the url used by AMI Cloud is prefixed by the bucket name. | Valid values: true|false Default: false |
objstore.resources.complex.id | Defines the resources that the agent can process | group- &SYSPLEX |
1 To enable trust validation on the object storage certificate, use the objstore.endpoint.no.verify.ssl parameter and set it to false. For more information, see Enabling-trust-between-the-agent-and-the-object-storage.
The agent.yml file might contain the additional parameters:
Parameter Name | Description | Default value |
|---|---|---|
objstore.endpoint.shared.archive.volume | Archived volume serial name | M9ARCH |
objstore.functionality.backup.threadpool.size | Number of parallel threads for backup and archive runs. Increasing this parameter requires verifying that sufficient Java heap space is defined for the agent | 20 |
load.balancing.group.name | Group of agents that can share the work of a single policy Group name must not exceed eight characters. | &SYSPLEX |
restore.progress.interval.percentage | Progress interval by percentage | 10 |
restore.progress.minimum.size.mb | Minimum size (in MB) of a backup or archive action at which point the agent starts reporting recall and restore progress | 1048576 |
lifecycle.deleteExpired.gdg.minimumDays | Minimum number of days that a data set is kept after being archived After the number of minimum days has passed, the data is checked to determine whether it is eligible for deletion. | 7 |
lifecycle.deleteExpired.gdg.intervalDays | Interval (in days) at which the data set is checked to determine whether it is eligible for deletion | 4 |
lifecycle.deleteExpired.cds.catalogExpiration.minimumDays | Minimum number of days for which a catalog-controlled cloud data set is kept in storage | 7 |
cli.functionality.backup.compression | Compression type used for CLI backup execution | gzip |
cli.functionality.archive.compression | Compression type used for CLI archive execution | gzip |
import.allocate_use_expdt_98000 | Determines whether to add the EXPDT(98000) to the tape allocations For CA-1 import support, change to true. | false |
import.allocate_label_type | Determines which label type the tape allocation should use For CA-1 import support, change to blp. | sl |
dcollect.output.unit | DCOLLECT UNIT | VIO |
dfdss.input_primary_cyl | DFDSS SYSIN primary size | 1 |
dfdss.input_secondary_cyl | DFDSS SYSIN secondary size | 10 |
dfdss.input_lrecl | DFDSS SYSIN LRECL | 80 |
dfdss.input_block_size | DFDSS SYSIN block size | 80 |
dfdss.input_bufno | DFDSS SYSIN BUFNO | 1 |
dfdss.input_unit | DFDSS SYSIN UNIT | VIO |
dfdss.output_primary_cyl | DFDSS SYSPRINT primary size | 1 |
dfdss.output_secondary_cyl | DFDSS SYSPRINT secondary size | 10 |
dfdss.output_lrecl | DFDSS SYSPRINT LRECL | 134 |
dfdss.output_block_size | DFDSS SYSPRINT block size | 1340 |
dfdss.output_bufno | DFDSS SYSPRINT BUFNO | 1 |
dfdss.output_unit | DFDSS SYSPRINT UNIT | VIO |
dfdss.optimize | Sets the DFDSS OPTIMIZE value for data set backup and archive | 3 |
discovery.missing_property.message.level | The message level used for resource level discovery failures while fetching properties. Valid values are as follows:
| WARNING |
idcams.temp.unit | IDCAMS temporary unit | VIO |
xcf.functionality.enabled | Controls the agent's XCF listener, which enables the auto-recall and CDS functionality | true |
volumeBackup_dfdss_warn_to_ok_msg_codes | Controls which DFDSS warning messages will not affect the return code of the DFDSS operation | ADR411W ADR333W |
model9.dfdss.statements.backup.forcecp.enabled | Enables the use of FORCECP for data set level backup (CLI & Policy). Valid values are as follows:
| true |
model9.dfdss.statements.backup.forcecp.days | FORCECP parameter days value. Valid values: 0-255 | 0 |
dfdss.restore_full_bypass_adrlock_exclusive_enqueue | Overrides the DFDSS ADRLOCK NONSPEC enqueue | false |
Resource complex and load balancing parameters
Agents sharing the same resource complex can all interact with the same resources. Actions such as backup, archive, recall, restore, and list are all dependent on the resource complex parameter. Agents not sharing the same resource complex will not be able to list, restore, or recall backups or archives created on a different resource complex. By default, all agents in the same sysplex share the same resource complex.
To update the default value of the resource complex, add the parameter to your agent.yml configuration file with a new value. Within a resource complex, you can define one or more load-balancing groups. For more information, see Restore-recall-and-export-behavior-when-using-an-agent-group-policy.