InlineProposedSegmentationObject1

InlineProposedSegmentationObject1

JSON Example

{
    "publish_action": "NONE",
    "_create_user": "admin",
    "_create_time": 1782155258592,
    "_last_modified_user": "admin",
    "_last_modified_time": 1782155258592,
    "_revision": 0,
    "id": "-6286331157426286654",
    "display_name": "USA_Portland_Shared",
    "site_ids": [],
    "segmentation_object_type": "ENVIRONMENT",
    "hierarchy_tags": [
        {
            "scope": "region",
            "tag": "USA"
        },
        {
            "scope": "zone",
            "tag": "Portland"
        },
        {
            "scope": "environment",
            "tag": "Shared"
        }
    ],
    "proposed_groups": [
        {
            "_create_user": "admin",
            "_create_time": 1782155258592,
            "_last_modified_user": "admin",
            "_last_modified_time": 1782155258592,
            "_revision": 0,
            "id": "674239690117385218",
            "display_name": "USA_Portland_Shared",
            "site_ids": [
                "123a456b-123c-456d-89ab-cdef12345678"
            ],
            "group_path": "/infra/domains/default/groups/c348192d-d1f0-37eb-9262-e9feac4a0547",
            "object_count_per_type": [
                {
                    "type": "VIRTUAL_MACHINE",
                    "count": 1
                }
            ],
            "group_action": "CREATE",
            "publish_status_info": {
                "publish_status": "READY_TO_PUBLISH"
            },
            "current_effective_vm_count": 0,
            "projected_effective_vm_count": 1
        }
    ],
    "publish_status": "READY_TO_PUBLISH",
    "parent_id": "-5834291957839695920"
}

SegmentationObjectType

segmentation_object_type

Read-Only  

Type of segmentation object

Enumeration: APPLICATION, ENVIRONMENT, TIER, INFRASTRUCTURE_ASSET, OTHER

array of Tag

hierarchy_tags

Read-Only  

Tags representing the hierarchical position of this object across all sites (e.g., region, zone, environment, application scopes). All groups within this object share these same hierarchy tags.

array of ProposedSegmentationGroup

proposed_groups

Read-Only  

List of site-specific proposed groups for this object. Each group represents the NSX group that will be created/updated on a specific site.

PublishStatus

publish_status

Read-Only  

Status of segmentation object publication. For status of the segmentation object's internal groups, check the groups themselves.

Enumeration: READY_TO_PUBLISH, IN_PROGRESS, PUBLISH_SUCCESS, PUBLISH_FAILED, PUBLISH_CANCELED

PublishAction

publish_action

Required  

Constraints: default: NONE

Action to perform on this segmentation object. This is the ONLY writable field. Set to PUBLISH to initiate publication across all sites, or CANCEL_PUBLISH to cancel an ongoing operation.

Enumeration: NONE, PUBLISH, FORCE_PUBLISH, CANCEL_PUBLISH

string

parent_id

Read-Only  

Optional reference to a parent segmentation object for hierarchical relationships. For example, tiers reference their parent application.

Used By

ProposedSegmentationObject