PortConnectionEntities

PortConnectionEntities
PortConnectionEntities

Port Connection Entities (to help draw a visual picture of entities between two ports)

JSON Example
{
    "containers": {
        "logical_ports": [
            {
                "_links": [
                    {
                        "action": "string",
                        "href": "string",
                        "rel": "string"
                    }
                ],
                "_schema": "string",
                "_self": {},
                "_revision": 0,
                "_create_time": 0,
                "_create_user": "string",
                "_last_modified_time": 0,
                "_last_modified_user": "string",
                "_protection": "string",
                "_system_owned": false,
                "description": "string",
                "display_name": "string",
                "id": "string",
                "resource_type": "string",
                "tags": [
                    {
                        "scope": "string",
                        "tag": "string"
                    }
                ],
                "address_bindings": [
                    {
                        "ip_address": "string",
                        "mac_address": "string",
                        "vlan": 0
                    }
                ],
                "admin_state": "string",
                "attachment": {
                    "attachment_type": "string",
                    "context": {
                        "allocate_addresses": "string",
                        "resource_type": "string"
                    },
                    "id": "string"
                },
                "extra_configs": [
                    {
                        "config_pair": {
                            "key": "string",
                            "value": "string"
                        }
                    }
                ],
                "ignore_address_bindings": [
                    {
                        "ip_address": "string",
                        "mac_address": "string",
                        "vlan": 0
                    }
                ],
                "init_state": "string",
                "internal_id": "string",
                "logical_switch_id": "string",
                "origin_id": "string",
                "switching_profile_ids": [
                    {
                        "key": "string",
                        "value": "string"
                    }
                ]
            }
        ]
    },
    "edge_node_groups": [
        {
            "id": "string",
            "resource": {
                "_create_time": 0,
                "_create_user": "string",
                "_last_modified_time": 0,
                "_last_modified_user": "string",
                "_protection": "string",
                "_system_owned": false,
                "description": "string",
                "display_name": "string",
                "id": "string",
                "resource_type": "string",
                "tags": [
                    {
                        "scope": "string",
                        "tag": "string"
                    }
                ]
            },
            "edge_nodes": [
                {
                    "_links": [
                        {
                            "action": "string",
                            "href": "string",
                            "rel": "string"
                        }
                    ],
                    "_schema": "string",
                    "_self": {},
                    "_revision": 0,
                    "_create_time": 0,
                    "_create_user": "string",
                    "_last_modified_time": 0,
                    "_last_modified_user": "string",
                    "_protection": "string",
                    "_system_owned": false,
                    "description": "string",
                    "display_name": "string",
                    "id": "string",
                    "resource_type": "string",
                    "tags": [
                        {
                            "scope": "string",
                            "tag": "string"
                        }
                    ],
                    "failure_domain_id": "string",
                    "host_switch_spec": {
                        "resource_type": "string"
                    },
                    "is_overridden": false,
                    "maintenance_mode": "string",
                    "node_deployment_info": {
                        "description": "string",
                        "discovered_ip_addresses": [
                            "string"
                        ],
                        "display_name": "string",
                        "external_id": "string",
                        "fqdn": "string",
                        "id": "string",
                        "ip_addresses": [
                            "string"
                        ],
                        "resource_type": "string",
                        "tags": [
                            {
                                "scope": "string",
                                "tag": "string"
                            }
                        ]
                    },
                    "node_id": "string",
                    "remote_tunnel_endpoint": {
                        "host_switch_name": "string",
                        "ip_assignment_spec": {
                            "resource_type": "string"
                        },
                        "named_teaming_policy": "string",
                        "rtep_vlan": 0
                    }
                }
            ],
            "logical_router_id": "string"
        }
    ],
    "errors": [
        {
            "entity_type": "string",
            "error_details": {},
            "error_summary": "string"
        }
    ],
    "hypervisors": [
        {
            "id": "string",
            "resource": {
                "_create_time": 0,
                "_create_user": "string",
                "_last_modified_time": 0,
                "_last_modified_user": "string",
                "_protection": "string",
                "_system_owned": false,
                "description": "string",
                "display_name": "string",
                "id": "string",
                "resource_type": "string",
                "tags": [
                    {
                        "scope": "string",
                        "tag": "string"
                    }
                ]
            },
            "neighbors_list": [
                {
                    "_links": [
                        {
                            "action": "string",
                            "href": "string",
                            "rel": "string"
                        }
                    ],
                    "_schema": "string",
                    "_self": {},
                    "_revision": 0,
                    "_create_time": 0,
                    "_create_user": "string",
                    "_last_modified_time": 0,
                    "_last_modified_user": "string",
                    "_protection": "string",
                    "_system_owned": false,
                    "description": "string",
                    "display_name": "string",
                    "id": "string",
                    "resource_type": "string",
                    "tags": [
                        {
                            "scope": "string",
                            "tag": "string"
                        }
                    ],
                    "ifindex": 0,
                    "mac": "string",
                    "name": "string",
                    "neighbors": [
                        {
                            "capabilities": "string",
                            "enabled_capabilities": "string",
                            "ifindex": 0,
                            "link_aggregation_capable": false,
                            "link_aggregation_port_id": "string",
                            "link_aggregation_status": false,
                            "mac": "string",
                            "mgmt_addr": "string",
                            "name": "string",
                            "oid": "string",
                            "port_desc": "string",
                            "system_desc": "string",
                            "system_name": "string",
                            "system_port_number": 0
                        }
                    ]
                }
            ],
            "pnics": [
                {
                    "device_name": "string",
                    "uplink_name": "string"
                }
            ],
            "pnics_list": [
                {
                    "admin_status": "string",
                    "backing_nsx_managed": false,
                    "connected_switch": "string",
                    "connected_switch_type": "string",
                    "device": "string",
                    "dpu_alias": "string",
                    "dpu_backed": false,
                    "dpu_id": "string",
                    "driver": "string",
                    "ens_capable": false,
                    "ens_enabled": false,
                    "ens_interrupt_capable": false,
                    "ens_interrupt_enabled": false,
                    "host_managed": false,
                    "interface_alias": [
                        {
                            "broadcast_address": "string",
                            "ip6_address": [
                                "string"
                            ],
                            "ip_address": "string",
                            "ip_configuration": "string",
                            "netmask": "string",
                            "physical_address": "string"
                        }
                    ],
                    "interface_id": "string",
                    "interface_type": "string",
                    "interface_uuid": "string",
                    "key": "string",
                    "link_status": "string",
                    "lport_attachment_id": "string",
                    "mtu": 0,
                    "pci": "string",
                    "source": "string",
                    "speed": "number",
                    "state": "string"
                }
            ],
            "profiles": [
                {
                    "_links": [
                        {
                            "action": "string",
                            "href": "string",
                            "rel": "string"
                        }
                    ],
                    "_schema": "string",
                    "_self": {},
                    "_revision": 0,
                    "_create_time": 0,
                    "_create_user": "string",
                    "_last_modified_time": 0,
                    "_last_modified_user": "string",
                    "_protection": "string",
                    "_system_owned": false,
                    "description": "string",
                    "display_name": "string",
                    "id": "string",
                    "resource_type": "string",
                    "tags": [
                        {
                            "scope": "string",
                            "tag": "string"
                        }
                    ],
                    "required_capabilities": [
                        "string"
                    ]
                }
            ]
        }
    ],
    "logical_switches": [
        {
            "id": "string",
            "resource": {
                "_create_time": 0,
                "_create_user": "string",
                "_last_modified_time": 0,
                "_last_modified_user": "string",
                "_protection": "string",
                "_system_owned": false,
                "description": "string",
                "display_name": "string",
                "id": "string",
                "resource_type": "string",
                "tags": [
                    {
                        "scope": "string",
                        "tag": "string"
                    }
                ]
            },
            "router_ports": [
                {
                    "_links": [
                        {
                            "action": "string",
                            "href": "string",
                            "rel": "string"
                        }
                    ],
                    "_schema": "string",
                    "_self": {},
                    "_revision": 0,
                    "_create_time": 0,
                    "_create_user": "string",
                    "_last_modified_time": 0,
                    "_last_modified_user": "string",
                    "_protection": "string",
                    "_system_owned": false,
                    "description": "string",
                    "display_name": "string",
                    "id": "string",
                    "resource_type": "string",
                    "tags": [
                        {
                            "scope": "string",
                            "tag": "string"
                        }
                    ],
                    "address_bindings": [
                        {
                            "ip_address": "string",
                            "mac_address": "string",
                            "vlan": 0
                        }
                    ],
                    "admin_state": "string",
                    "attachment": {
                        "attachment_type": "string",
                        "context": {
                            "allocate_addresses": "string",
                            "resource_type": "string"
                        },
                        "id": "string"
                    },
                    "extra_configs": [
                        {
                            "config_pair": {
                                "key": "string",
                                "value": "string"
                            }
                        }
                    ],
                    "ignore_address_bindings": [
                        {
                            "ip_address": "string",
                            "mac_address": "string",
                            "vlan": 0
                        }
                    ],
                    "init_state": "string",
                    "internal_id": "string",
                    "logical_switch_id": "string",
                    "origin_id": "string",
                    "switching_profile_ids": [
                        {
                            "key": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "vm_ports": [
                {
                    "_links": [
                        {
                            "action": "string",
                            "href": "string",
                            "rel": "string"
                        }
                    ],
                    "_schema": "string",
                    "_self": {},
                    "_revision": 0,
                    "_create_time": 0,
                    "_create_user": "string",
                    "_last_modified_time": 0,
                    "_last_modified_user": "string",
                    "_protection": "string",
                    "_system_owned": false,
                    "description": "string",
                    "display_name": "string",
                    "id": "string",
                    "resource_type": "string",
                    "tags": [
                        {
                            "scope": "string",
                            "tag": "string"
                        }
                    ],
                    "address_bindings": [
                        {
                            "ip_address": "string",
                            "mac_address": "string",
                            "vlan": 0
                        }
                    ],
                    "admin_state": "string",
                    "attachment": {
                        "attachment_type": "string",
                        "context": {
                            "allocate_addresses": "string",
                            "resource_type": "string"
                        },
                        "id": "string"
                    },
                    "extra_configs": [
                        {
                            "config_pair": {
                                "key": "string",
                                "value": "string"
                            }
                        }
                    ],
                    "ignore_address_bindings": [
                        {
                            "ip_address": "string",
                            "mac_address": "string",
                            "vlan": 0
                        }
                    ],
                    "init_state": "string",
                    "internal_id": "string",
                    "logical_switch_id": "string",
                    "origin_id": "string",
                    "switching_profile_ids": [
                        {
                            "key": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "vm_ports_states": [
                {
                    "attachment": {
                        "attachers": [
                            {
                                "entity": "string",
                                "host": "string"
                            }
                        ],
                        "id": "string",
                        "state": "string"
                    },
                    "discovered_bindings": [
                        {
                            "binding": {
                                "ip_address": "string",
                                "mac_address": "string",
                                "vlan": 0
                            },
                            "binding_timestamp": 0,
                            "source": "string"
                        }
                    ],
                    "duplicate_bindings": [
                        {
                            "binding": {
                                "ip_address": "string",
                                "mac_address": "string",
                                "vlan": 0
                            },
                            "binding_timestamp": 0,
                            "source": "string",
                            "conflicting_port": "string"
                        }
                    ],
                    "id": "string",
                    "realized_bindings": [
                        {
                            "binding": {
                                "ip_address": "string",
                                "mac_address": "string",
                                "vlan": 0
                            },
                            "binding_timestamp": 0,
                            "source": "string"
                        }
                    ],
                    "transport_node_ids": [
                        "string"
                    ]
                }
            ],
            "vm_vnics": [
                {
                    "_links": [
                        {
                            "action": "string",
                            "href": "string",
                            "rel": "string"
                        }
                    ],
                    "_schema": "string",
                    "_self": {},
                    "_last_sync_time": 0,
                    "description": "string",
                    "display_name": "string",
                    "resource_type": "string",
                    "scope": [
                        {
                            "scope_id": "string",
                            "scope_type": "string"
                        }
                    ],
                    "tags": [
                        {
                            "scope": "string",
                            "tag": "string"
                        }
                    ],
                    "device_key": "string",
                    "device_name": "string",
                    "external_id": "string",
                    "host_id": "string",
                    "ip_address_info": [
                        {
                            "ip_addresses": [
                                "string"
                            ],
                            "source": "string"
                        }
                    ],
                    "lport_attachment_id": "string",
                    "mac_address": "string",
                    "owner_vm_id": "string",
                    "owner_vm_type": "string",
                    "uptv2_enabled": false,
                    "vm_local_id_on_host": "string"
                }
            ]
        }
    ],
    "physical_hosts": {
        "dst_port": {
            "address_bindings": [
                {
                    "ip_address": "string",
                    "mac_address": "string",
                    "vlan": 0
                }
            ],
            "admin_state": "string",
            "attachment": {
                "attachment_type": "string",
                "context": {
                    "allocate_addresses": "string",
                    "resource_type": "string"
                },
                "id": "string"
            },
            "extra_configs": [
                {
                    "config_pair": {
                        "key": "string",
                        "value": "string"
                    }
                }
            ],
            "ignore_address_bindings": [
                {
                    "ip_address": "string",
                    "mac_address": "string",
                    "vlan": 0
                }
            ],
            "init_state": "string",
            "internal_id": "string",
            "logical_switch_id": "string",
            "origin_id": "string",
            "switching_profile_ids": [
                {
                    "key": "string",
                    "value": "string"
                }
            ]
        },
        "src_port": {
            "address_bindings": [
                {
                    "ip_address": "string",
                    "mac_address": "string",
                    "vlan": 0
                }
            ],
            "admin_state": "string",
            "attachment": {
                "attachment_type": "string",
                "context": {
                    "allocate_addresses": "string",
                    "resource_type": "string"
                },
                "id": "string"
            },
            "extra_configs": [
                {
                    "config_pair": {
                        "key": "string",
                        "value": "string"
                    }
                }
            ],
            "ignore_address_bindings": [
                {
                    "ip_address": "string",
                    "mac_address": "string",
                    "vlan": 0
                }
            ],
            "init_state": "string",
            "internal_id": "string",
            "logical_switch_id": "string",
            "origin_id": "string",
            "switching_profile_ids": [
                {
                    "key": "string",
                    "value": "string"
                }
            ]
        }
    },
    "routers": [
        {
            "id": "string",
            "resource": {
                "_create_time": 0,
                "_create_user": "string",
                "_last_modified_time": 0,
                "_last_modified_user": "string",
                "_protection": "string",
                "_system_owned": false,
                "description": "string",
                "display_name": "string",
                "id": "string",
                "resource_type": "string",
                "tags": [
                    {
                        "scope": "string",
                        "tag": "string"
                    }
                ]
            },
            "downlink_ports": [
                {
                    "_links": [
                        {
                            "action": "string",
                            "href": "string",
                            "rel": "string"
                        }
                    ],
                    "_schema": "string",
                    "_self": {},
                    "_revision": 0,
                    "_create_time": 0,
                    "_create_user": "string",
                    "_last_modified_time": 0,
                    "_last_modified_user": "string",
                    "_protection": "string",
                    "_system_owned": false,
                    "description": "string",
                    "display_name": "string",
                    "id": "string",
                    "resource_type": "string",
                    "tags": [
                        {
                            "scope": "string",
                            "tag": "string"
                        }
                    ],
                    "logical_router_id": "string",
                    "service_bindings": [
                        {
                            "service_id": {
                                "is_valid": false,
                                "target_display_name": "string",
                                "target_id": "string",
                                "target_type": "string"
                            }
                        }
                    ]
                }
            ],
            "uplink_ports": [
                {
                    "_links": [
                        {
                            "action": "string",
                            "href": "string",
                            "rel": "string"
                        }
                    ],
                    "_schema": "string",
                    "_self": {},
                    "_revision": 0,
                    "_create_time": 0,
                    "_create_user": "string",
                    "_last_modified_time": 0,
                    "_last_modified_user": "string",
                    "_protection": "string",
                    "_system_owned": false,
                    "description": "string",
                    "display_name": "string",
                    "id": "string",
                    "resource_type": "string",
                    "tags": [
                        {
                            "scope": "string",
                            "tag": "string"
                        }
                    ],
                    "logical_router_id": "string",
                    "service_bindings": [
                        {
                            "service_id": {
                                "is_valid": false,
                                "target_display_name": "string",
                                "target_id": "string",
                                "target_type": "string"
                            }
                        }
                    ]
                }
            ]
        }
    ],
    "tunnels": [
        {
            "src_node_id": "string",
            "tunnel_properties": {
                "bfd": {
                    "active": false,
                    "bfd_encap": "string",
                    "diagnostic": "string",
                    "forwarding": false,
                    "remote_diagnostic": "string",
                    "remote_state": "string",
                    "state": "string"
                },
                "egress_interface": "string",
                "encap": "string",
                "last_updated_time": 0,
                "latency_type": "string",
                "latency_value": 0,
                "local_ip": "string",
                "name": "string",
                "remote_ip": "string",
                "remote_node_display_name": "string",
                "remote_node_id": "string",
                "status": "string"
            }
        }
    ],
    "vms": [
        {
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_self": {},
            "_last_sync_time": 0,
            "description": "string",
            "display_name": "string",
            "resource_type": "string",
            "scope": [
                {
                    "scope_id": "string",
                    "scope_type": "string"
                }
            ],
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "compute_ids": [
                "string"
            ],
            "external_id": "string",
            "guest_info": {
                "computer_name": "string",
                "os_name": "string"
            },
            "host_id": "string",
            "local_id_on_host": "string",
            "power_state": "string",
            "runtime_info": {
                "vif_runtime_info": [
                    {
                        "external_id": "string",
                        "uptv2_active": "string"
                    }
                ]
            },
            "source": {
                "is_valid": false,
                "target_display_name": "string",
                "target_id": "string",
                "target_type": "string"
            },
            "type": "string",
            "uptv2_enabled": false
        }
    ]
}
containers
Required

Port Connection Containers Entities

edge_node_groups
Optional

edge_node_groups

errors
Required

errors

hypervisors
Required

hypervisors

logical_switches
Required

logical_switches

physical_hosts
Optional

Port Connection Bare Metal Entities

routers
Optional

routers

tunnels
Required

tunnels

vms
Required

vms