Managing Analyses

The following methods manage AFA device, group, and matrix analyses.

Creating and Updating a Scheduler Job

The set_scheduler_job method creates a new, or updates a pre-existing scheduler job.

Request Type: SetSchedulerJobRequest

Element

Type

Description
SessionIDMandatory

String

SessionID obtained from the connect method.
JobNameMandatory

AfaNonEmptyString

Name of the job to create or update.

EntityTypeMandatory

AfaNonEmptyString

Entity the job is scheduled for. One of the following:

    device
    group
    matrix
EntityIDMandatory

AfaNonEmptyString

Tree name of the group/device/matrix.

BaseAnalysisOnExistingReportsOptional

AfaBoolean

If True, aggregates all existing reports for the device/group/matrix.

[Default] If False, generates new reports for each device/group/matrix. 

RecurrenceMandatory

String

Specifies how often the job is run. Options are:

    daily
  • weekly: Specify the day(s) to run the job in the Weekday parameter.
  • upon_policy_inst: Runs the job when the policy is installed. The entity type must be a single device.
WeekdayOptional

List of AfaNonEmptyString

List of weekdays to schedule:

    Monday
    Tuesday
    Wednesday
    Thursday
    Friday
    Saturday
    Sunday
HourOptional

Integer

Specifies the hour of day the job is run. Valid values are from 0 to 23.
MinuteOptional

Integer

Specifies the minute the job is run. Valid values are from 0 to 59.

Response Type: SetSchedulerJobResponse

Element

Type

Description
SetSchedulerJobResponse

AfaBoolean

On success, returns 1.

On failure, throws a SOAP fault, such as 0 - WS_ERR_OPERATION_FAILED.

Deleting a Scheduler Job

The delete_scheduler_job method deletes a Scheduler Job.

Request Type: DeleteSchedulerJobRequest

Element

Type

Description
SessionIDMandatory

String

SessionID obtained from the connect method.
JobNameMandatory

AfaNonEmptyString

Name of the job to delete.

Response Type: DeleteSchedulerJobResponse

Element

Type

Description
DeleteSchedulerJobResponse

AfaBoolean

On success, returns 1.

On failure, throws a SOAP fault, such as 0 - WS_ERR_OPERATION_FAILED.

Starting an Analysis

The start_analysis method begins a new analysis of a device, group, or matrix.

In order to run the start_analysis method, your must log in with permissions to start analysis.

Request Type: StartAnalysisRequest

Element

Type

Description
SessionIDMandatory

String

SessionID obtained from the Connect method.
EntityTypeMandatory

AfaNonEmptyString

Entity the job is scheduled for. One of the following:

    device
    group
    matrix
EntityIDMandatory

AfaNonEmptyString

Tree name of the group/device/matrix.

RiskProfileOptional

AfaNonEmptyString

Risk Profile name. When empty, the standard Risk Profile is used.

Note: Although optional, we recommend you select a Risk Profile each time you perform an analysis.
AvoidEmailNotificationOptional

AfaBoolean

If True, avoids sending out notifications and updates via email.

[Default] If False, sends notifications and updates via email.
BaseAnalysisOnExistingReportsOptional

AfaBoolean

If True, aggregates all existing reports for the device/group/matrix.

[Default] If False, generates a new report for the device/group/matrix.

Analysis for a specific log date range or a What-if analysis is not available through the Web Service. To specify log dates or a What-if analysis, use the AFA Web Interface.

Response Type: StartAnalysisResponse

Element

Type

Description
StartAnalysisResponse

AfaBoolean

On success, returns 1.

On failure, throws a SOAP fault, such as 0 - WS_ERR_OPERATION_FAILED.