Collect Support Data Recurring Task
The Collect Support Data Recurring Task can be used to invoke the collect support data tool on a regular basis.
Parent Component
The Collect Support Data Recurring Task component inherits from the Recurring Task
Properties
The properties supported by this managed object are as follows:
Basic Properties
description
Description
| A description for this Recurring Task
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
cancel-on-task-dependency-failure
Description
| Indicates whether an instance of this Recurring Task should be canceled if the task immediately before it in the recurring task chain fails to complete successfully (including if it is canceled by an administrator before it starts or while it is running). If this is true, then the instance of this Recurring Task will also be considered a failure (with a state of "canceled before starting"), and if that instance is itself a dependency for any other Recurring Task instance, then that dependent task's cancel-on-task-dependency-failure property will be used to determine whether it should be canceled or preserved.
|
Default Value
| false
|
Allowed Values
| true
false
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
email-on-start
Description
| The email addresses to which a message should be sent whenever an instance of this Recurring Task starts running. If this option is used, then at least one smtp-server must be configured in the global configuration.
|
Default Value
| No email message will be sent when instances of this Recurring Task start running.
|
Allowed Values
| A string
|
Multi-Valued
| Yes
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
email-on-success
Description
| The email addresses to which a message should be sent whenever an instance of this Recurring Task completes successfully. If this option is used, then at least one smtp-server must be configured in the global configuration.
|
Default Value
| No email message will be sent when instances of this Recurring Task finish running.
|
Allowed Values
| A string
|
Multi-Valued
| Yes
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
email-on-failure
Description
| The email addresses to which a message should be sent if an instance of this Recurring Task fails to complete successfully. If this option is used, then at least one smtp-server must be configured in the global configuration.
|
Default Value
| No email message will be sent when instances of this Recurring Task fail to complete successfully.
|
Allowed Values
| A string
|
Multi-Valued
| Yes
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
alert-on-start
Description
| Indicates whether the server should generate an administrative alert whenever an instance of this Recurring Task starts running.
|
Default Value
| false
|
Allowed Values
| true
false
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
alert-on-success
Description
| Indicates whether the server should generate an administrative alert whenever an instance of this Recurring Task completes successfully.
|
Default Value
| false
|
Allowed Values
| true
false
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
alert-on-failure
Description
| Indicates whether the server should generate an administrative alert whenever an instance of this Recurring Task fails to complete successfully.
|
Default Value
| true
|
Allowed Values
| true
false
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
output-directory
Description
| The directory in which the support data archive files will be placed. The path must be a directory, and that directory must already exist. Relative paths will be interpreted as relative to the server root. The support data archive files will be given names using the pattern support-data-{product}-{instanceName}-{timestamp}-zip[-encrypted], where {product} represents the server product type, {instanceName} represents the server instance name, and {timestamp} indicates the time that the support data archive was generated. If an encryption passphrase file was specified, then "-encrypted" will be appended to archive name.
|
Default Value
| None
|
Allowed Values
| A filesystem path
|
Multi-Valued
| No
|
Required
| Yes
|
Admin Action Required
| None. Modification requires no further action
|
encryption-passphrase-file
Description
| The path to a file that contains the passphrase to encrypt the contents of the support data archive. If an encryption passphrase file is specified, then the file must exist, and it must contain a single line that comprises the passphrase to use to encrypt the file. If no encryption passphrase file is specified, the support data archive will not be encrypted.
|
Default Value
| None
|
Allowed Values
| A filesystem path
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
include-expensive-data
Description
| Indicates whether the support data archive should include information that may be expensive to obtain, and that may temporarily affect the server's performance or responsiveness.
|
Default Value
| false
|
Allowed Values
| true
false
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
include-replication-state-dump
Description
| Indicates whether the support data archive should include a replication state dump, which may be several megabytes in size.
|
Default Value
| false
|
Allowed Values
| true
false
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
include-binary-files
Description
| Indicates whether the support data archive should include binary files that may not have otherwise been included. Note that it may not be possible to obscure or redact sensitive information in binary files.
|
Default Value
| false
|
Allowed Values
| true
false
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
include-extension-source
Description
| Indicates whether the support data archive should include the source code (if available) for any third-party extensions that may be installed in the server.
|
Default Value
| false
|
Allowed Values
| true
false
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
use-sequential-mode
Description
| Indicates whether to capture support data information sequentially rather than in parallel. Capturing data in sequential mode may reduce the amount of memory that the tool requires to operate, at the cost of taking longer to run.
|
Default Value
| true
|
Allowed Values
| true
false
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
security-level
Description
| The security level to use when deciding which information to include in or exclude from the support data archive, and which included data should be obscured or redacted.
|
Default Value
| obscure-secrets
|
Allowed Values
| none - Do not attempt to exclude or obscure any information in the support data archive.
obscure-secrets - Obscure secret information (e.g., the values of sensitive configuration properties, like credentials needed to authenticate to external systems) and exclude logs that may include user data (like the data recovery log).
maximum - In addition to th e protections added by the obscure-secrets level, take even more drastic measures to avoid capturing any personally identifiable information, including excluding access logs from the archive and obscuring values in entry DNs and search filters.
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
jstack-count
Description
| The number of times to invoke the jstack utility to obtain a stack trace of all threads running in the JVM. A value of zero indicates that the jstack utility should not be invoked.
|
Default Value
| 10
|
Allowed Values
| An integer value. Lower limit is 0.
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
report-count
Description
| The number of intervals of data to collect from tools that use sample-based reporting, like vmstat, iostat, and mpstat. A value of zero indicates that these kinds of tools should not be used to collect any information.
|
Default Value
| 10
|
Allowed Values
| An integer value. Lower limit is 0.
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
report-interval-seconds
Description
| The duration (in seconds) between each interval of data to collect from tools that use sample-based reporting, like vmstat, iostat, and mpstat.
|
Default Value
| 1
|
Allowed Values
| An integer value. Lower limit is 1.
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-duration
Description
| The maximum age (leading up to the time the collect-support-data tool was invoked) for log content to include in the support data archive. This property cannot be used in conjunction with either the log-file-head-collection-size or log-file-tail-collection-size properties. If none of these properties are specified, then the server will capture a default amount of content from each log file (based on size rather than duration).
|
Default Value
| The server will capture a default amount of content from each log file.
|
Allowed Values
| A duration. Lower limit is 0 milliseconds.
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-file-head-collection-size
Description
| The amount of data to collect from the beginning of each log file included in the support data archive. This property cannot be used in conjunction with the log-duration property, but it can be used with the log-file-tail-collection-size. If none of these properties are specified, then the server will capture a default amount of content from each log file (based on size rather than duration).
|
Default Value
| The server will capture a default amount of content from each log file.
|
Allowed Values
| A positive integer representing a size.
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-file-tail-collection-size
Description
| The amount of data to collect from the end of each log file included in the support data archive. This property cannot be used in conjunction with the log-duration property, but it can be used with the log-file-head-collection-size. If none of these properties are specified, then the server will capture a default amount of content from each log file (based on size rather than duration).
|
Default Value
| The server will capture a default amount of content from each log file.
|
Allowed Values
| A positive integer representing a size.
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
comment
Description
| An optional comment to include in a README file within the support data archive.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
retain-previous-support-data-archive-count
Description
| The minimum number of previous support data archives that should be preserved after a new archive is generated. If both the retain-previous-support-data-archive-count and the retain-previous-support-data-archive-age properties have a value, then only archives that are outside the criteria for both properties will be candidates for removal. If only one of those properties has a value, then only the criteria associated with that property will be used to determine which previous archives may be removed. At least one of these properties must have a value.
|
Default Value
| If a retain-previous-support-data-archive-age value is configured, then only that property will be used to determine which archives to retain, and any archives older than that may be removed.
|
Allowed Values
| An integer value. Lower limit is 0.
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
retain-previous-support-data-archive-age
Description
| The minimum age of previous support data archives that should be preserved after a new archive is generated. Values for this property should use the duration syntax, which consists of an integer value followed by a time unit (for example, "1w" for one week, "5d" for five days, or "12h" for twelve hours).
If both the retain-previous-support-data-archive-count and the retain-previous-support-data-archive-age properties have a value, then only archives that are outside the criteria for both properties will be candidates for removal. If only one of those properties has a value, then only the criteria associated with that property will be used to determine which previous archives may be removed. At least one of these properties must have a value.
|
Default Value
| If a retain-previous-support-data-archive-count value is configured, then only that number of the most recent archives will be retained, and any additional older archives will be removed.
|
Allowed Values
| A duration. Lower limit is 0 milliseconds.
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
dsconfig Usage
To list the configured Recurring Tasks:
dsconfig list-recurring-tasks
[--property {propertyName}] ...
To view the configuration for an existing Recurring Task:
dsconfig get-recurring-task-prop
--task-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Recurring Task:
dsconfig set-recurring-task-prop
--task-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Collect Support Data Recurring Task:
dsconfig create-recurring-task
--task-name {name}
--type collect-support-data
--set output-directory:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Recurring Task:
dsconfig delete-recurring-task
--task-name {name}