InlineRecommendationResult1

InlineRecommendationResult1
InlineRecommendationResult1
JSON Example
{
    "_create_user": "system",
    "_create_time": 1779144952584,
    "_last_modified_user": "system",
    "_last_modified_time": 1779144952584,
    "_revision": 0,
    "_system_owned": false,
    "id": "9e0865d0-9d89-44c7-8cc0-9f96a9b35721",
    "display_name": "REC 260518 03:46:50",
    "description": "Recommendation created on 5/18/26, 3:46 PM",
    "site_ids": [],
    "infra": {
        "resource_type": "Infra",
        "id": "infra",
        "children": [
            {
                "resource_type": "ChildResourceReference",
                "target_type": "Domain",
                "id": "default",
                "children": [
                    {
                        "resource_type": "ChildSecurityPolicy",
                        "SecurityPolicy": {
                            "resource_type": "SecurityPolicy",
                            "id": "Policy-d81c4105-3da3-4cb5-8a08-51f082c175ae-fd0b23f9-7bc6-4f95-9308-ec1d620b9605",
                            "display_name": "Policy-1 (REC 260518 03:46:50)",
                            "connectivity_preference": "NONE",
                            "category": "Application",
                            "scope": [
                                "/infra/domains/default/groups/05604720-dbe9-3b27-a953-3a1de60b8e28"
                            ],
                            "stateful": true,
                            "children": [
                                {
                                    "resource_type": "ChildRule",
                                    "Rule": {
                                        "resource_type": "Rule",
                                        "id": "Rule-d81c4105-3da3-4cb5-8a08-51f082c175ae-7e17cb1b-3099-4111-83dc-b0db36be1923",
                                        "display_name": "Rule-1 (REC 260518 03:46:50)",
                                        "action": "ALLOW",
                                        "direction": "IN_OUT",
                                        "source_groups": [
                                            "/infra/domains/default/groups/05604720-dbe9-3b27-a953-3a1de60b8e28"
                                        ],
                                        "destination_groups": [
                                            "/infra/domains/default/groups/fd2186ce-4129-3567-9a47-e1ec6c3b498a"
                                        ],
                                        "services": [
                                            "/infra/services/SSH"
                                        ],
                                        "sequence_number": 1
                                    }
                                }
                            ]
                        }
                    }
                ]
            }
        ]
    },
    "status": {
        "id": "9e0865d0-9d89-44c7-8cc0-9f96a9b35721",
        "site_id": "9e0865d0-9d89-44c7-8cc0-9f96a9b35721",
        "status": "READY_TO_PUBLISH"
    },
    "site_id": "9e0865d0-9d89-44c7-8cc0-9f96a9b35721",
    "job_run_time": 66,
    "infra_generated": true,
    "diff_document_generated": false,
    "checkpoints": [],
    "context_effective_vms": [
        {
            "id": "c29fe908-00d5-48b7-95fb-2fca418a105f",
            "display_name": "Web-VM-1",
            "site_ids": [
                "9e0865d0-9d89-44c7-8cc0-9f96a9b35721"
            ]
        }
    ],
    "context_effective_physical_servers": []
}
infra
Optional

Infra space related policy.

recommendation_session_info
Read-Only  

The original recommendation session configuration that was used to generate this recommendation result. Contains all the input parameters, context, and settings that were provided when the recommendation was initiated.

publish_action
Optional
Constraints: default: NONE

Action to perform on a publishable entity (recommendations, segmentation objects, etc.).

  • NONE: No action (default state)
  • PUBLISH: Run NSX capacity precheck then queue publication to NSX Policy Manager
  • FORCE_PUBLISH: Skip NSX capacity precheck and queue publication anyway (use only after acknowledging capacity risk). Note: FORCE_PUBLISH bypasses the NSX capacity limit check but does NOT bypass the SSP platform hard limit on groups. If the projected group count exceeds the SSP hard limit, the publish will be rejected regardless of this flag.
Enumeration: NONE, PUBLISH, FORCE_PUBLISH
status
Read-Only  

Status information for a recommendation result at a specific site. Contains the current status, status message.

string
site_id
Read-Only  

The site identifier (local manager ID) where this recommendation result was generated. This corresponds to one of the site_ids specified in the recommendation session.

job_run_time
Read-Only  

Time in seconds that it took to analyze the flows and generate the recommendations

boolean
infra_generated
Read-Only  

Boolean flag to reflect if recommendation has already generated Infra. Infra object is the payload that is used to publish the recommended policies and rules to NSX Policy Manage. Default value is false.

boolean
diff_document_generated
Read-Only  

Boolean flag to reflect if recommendation has already generated Diff document. Diff document is a object recommended, uses for updates to existing section to segment unsegmented flows for this application. Default value is false.

checkpoints
Read-Only  

The list of checkpoints the recommendations job has passed/failed when rec status is NOTHING_TO_PUBLISH

group_related_infos
Read-Only  

group_related_infos

string
protection_rule_id
Read-Only  

Primary identifier of the protection rule. This field is only valid for environment context.

array of Resource
context_effective_vms
Read-Only  

The effective vm's that were used to generate the recommendation. This is a function of user provided context_groups and/or context_vms. System will set this during first time recommendation generation and a rerun of the recommendation will replace this value based on the latest group membership status and existence of vms in the system. Any deleted vms will be removed when this value is set. This value is indeterminate until the recommendation is in READY_TO_PUBLISH state and should not be interpreted by the user when the recommendation is in WAITING state.

array of Resource
context_effective_physical_servers
Read-Only  

[Deprecated] The effective physical servers that were used to generate the recommendation. This is a function of the physical servers that resolve from user provided context_groups and/or context_physical_servers. System will set this during first time recommendation generation and a rerun of the recommendation will replace this value based on the latest group membership status and existence of physical servers in the system. Any deleted servers will be removed when this value is set. This value is indeterminate until the recommendation is in READY_TO_PUBLISH state and should not be interpreted by the user when the recommendation is in WAITING state.