Data Sync Server Documentation Index
Configuration Reference Home

Generate Server Profile Recurring Task

Generate Server Profile Recurring Tasks can be used to generate updated server profiles on a regular basis.

Parent Component
Properties
dsconfig Usage

Parent Component

The Generate Server Profile Recurring Task component inherits from the Recurring Task

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ cancel-on-task-dependency-failure
↓ email-on-start
↓ email-on-success
↓ email-on-failure
↓ alert-on-start
↓ alert-on-success
↓ alert-on-failure
↓ profile-directory
↓ include-path
↓ retain-previous-profile-count
↓ retain-previous-profile-age

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

profile-directory

Description
The directory in which the generated server profiles will be placed. The files will be named with the pattern "server-profile-{timestamp}.zip", where "{timestamp}" represents the time that the profile was generated.
Default Value
None
Allowed Values
A filesystem path
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

include-path

Description
An optional set of additional paths to files within the instance root that should be included in the generated server profile. All paths must be within the instance root, and relative paths will be relative to the instance root.
Default Value
None
Allowed Values
A filesystem path
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

retain-previous-profile-count

Description
The minimum number of previous server profile zip files that should be preserved after a new profile is generated. At least one of the retain-previous-profile-count and retain-previous-profile-age properties must be set. If both properties are set, then only profiles that are outside the criteria for both properties will be considered for removal. If only one of these properties has a value, then only the criteria associated with that property will be used to determine which previous profiles will be retained.
Default Value
Only the retain-previous-profile-age property will be used to determine which previous profiles to retain, and any profiles 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-profile-age

Description
The minimum age of previous server profile zip files that should be preserved after a new profile is generated. At least one of the retain-previous-profile-count and retain-previous-profile-age properties must be set. If both properties are set, then only profiles that are outside the criteria for both properties will be considered for removal. If only one of these properties has a value, then only the criteria associated with that property will be used to determine which previous profiles will be retained.
Default Value
Only the retain-previous-profile-age property will be used to determine which previous profiles to retain, and if there are more previous profiles than that, then the oldest profiles may 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 Generate Server Profile Recurring Task:

dsconfig create-recurring-task
     --task-name {name}
     --type generate-server-profile
     --set profile-directory:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Recurring Task:

dsconfig delete-recurring-task
     --task-name {name}