InlineRecommendationSession1

InlineRecommendationSession1

JSON Example

{
    "recommendation_type": "string",
    "site_ids": [
        "string"
    ],
    "start_time": 0,
    "time_interval": {
        "start_time": 0,
        "end_time": 0
    },
    "monitoring_enabled": false,
    "action": "string",
    "status": {
        "recommendation_overall_status": "READY_TO_PUBLISH",
        "recommendation_analysis_states": [
            {
                "site_id": "9e0865d0-9d89-44c7-8cc0-9f96a9b35721",
                "status_message": "",
                "status": "SUCCESS"
            }
        ],
        "recommendation_result_states": [
            {
                "id": "9e0865d0-9d89-44c7-8cc0-9f96a9b35721",
                "site_id": "9e0865d0-9d89-44c7-8cc0-9f96a9b35721",
                "status": "READY_TO_PUBLISH"
            }
        ],
        "rerun_recommended": false,
        "alerts": [],
        "groups_with_alert": []
    }
}

RecommendationType

recommendation_type

Required  

we support three recommendation types:

1. CLASSIC recommendations will take the DFW VMs and groups as input, and will reuse or create security policy, rules and groups. The result of DFW recommendation can be published and exported to CSV files.
2. APPLICATION recommendations will take the SSP application as input, and will reuse or create security policy, rules and groups. The result of SSP recommendation can be published and exported to CSV files.
3. ENVIRONMENT recommendations will take the SSP environment pair as input, and will reuse or create security policy, rules and groups. The result of SSP recommendation can be published and exported to CSV files.

Enumeration: CLASSIC, APPLICATION, ENVIRONMENT

array of string

site_ids

Required  

List of site identifiers (local manager IDs) where the recommendation analysis should be performed. The recommendation will analyze flows and generate policies for the specified sites.

EpochMsTimestamp

start_time

Required  

Defines the start of the time window used for flow analysis. The recommendation examines traffic flows in the interval (start_time, now). To start a traffic-based recommendation, provide a valid epoch time in milliseconds. To start a non-traffic-based recommendation, omit this field or set it to null. If it is not specified, the default value is null.

TimeInterval

time_interval

Read-Only  

The time interval for the recommendation analysis. This is a read-only field that represents the actual time range analyzed, calculated from start_time to the current time.

boolean

monitoring_enabled

Optional

Constraints: default: true

Whether the recommendation has to be periodically monitored for new effective context compute boundary changes. When set, this recommendation is monitored to check if the recommendation is to be rerun. Any such changes result in the rerun_recommended flag to be set. The monitoring interval is determined by system configuration.

RecommendationSessionAction

action

Optional

Actions that can be performed on a recommendation session.

Action	Description
CANCEL	Stops the analysis if it's in progress.
ANALYZE	Triggers or re-triggers the recommendation analysis.

Enumeration: CANCEL, ANALYZE

RecommendationSessionState

status

Read-Only  

Status information for a recommendation session, including overall status, analysis status, status messages, alerts, and rerun recommendations. Provides visibility into the current state and progress of the recommendation generation process.

Used By

RecommendationSession