PortConnectionEntities

PortConnectionEntities
PortConnectionEntities

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

JSON Example
{
    "containers": {
        "logical_ports": [
            {
                "_self": {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                },
                "_links": [
                    {
                        "action": "string",
                        "href": "string",
                        "rel": "string"
                    }
                ],
                "_schema": "string",
                "_revision": 0,
                "_system_owned": false,
                "display_name": "string",
                "description": "string",
                "tags": [
                    {
                        "scope": "string",
                        "tag": "string"
                    }
                ],
                "_create_user": "string",
                "_protection": "string",
                "_create_time": 0,
                "_last_modified_time": 0,
                "_last_modified_user": "string",
                "id": "string",
                "resource_type": "string",
                "logical_switch_id": "string",
                "init_state": "string",
                "switching_profile_ids": [
                    {
                        "value": "string",
                        "key": "string"
                    }
                ],
                "attachment": {
                    "attachment_type": "string",
                    "context": {
                        "allocate_addresses": "string",
                        "resource_type": "string"
                    },
                    "id": "string"
                },
                "admin_state": "string",
                "extra_configs": [
                    {
                        "config_pair": {
                            "value": "string",
                            "key": "string"
                        }
                    }
                ],
                "address_bindings": [
                    {
                        "vlan": 0,
                        "ip_address": "string",
                        "mac_address": "string"
                    }
                ]
            }
        ]
    },
    "hypervisors": [
        {
            "resource": {
                "_system_owned": false,
                "display_name": "string",
                "description": "string",
                "tags": [
                    {
                        "scope": "string",
                        "tag": "string"
                    }
                ],
                "_create_user": "string",
                "_protection": "string",
                "_create_time": 0,
                "_last_modified_time": 0,
                "_last_modified_user": "string",
                "id": "string",
                "resource_type": "string"
            },
            "id": "string",
            "pnics": [
                {
                    "uplink_name": "string",
                    "device_name": "string"
                }
            ],
            "pnics_list": [
                {
                    "source": "string",
                    "admin_status": "string",
                    "link_status": "string",
                    "interface_alias": [
                        {
                            "ip_configuration": "string",
                            "netmask": "string",
                            "ip_address": "string",
                            "physical_address": "string",
                            "broadcast_address": "string"
                        }
                    ],
                    "ens_enabled": false,
                    "interface_type": "string",
                    "interface_id": "string",
                    "connected_switch": "string",
                    "ens_capable": false,
                    "mtu": 0
                }
            ],
            "neighbors_list": [
                {
                    "_self": {
                        "action": "string",
                        "href": "string",
                        "rel": "string"
                    },
                    "_links": [
                        {
                            "action": "string",
                            "href": "string",
                            "rel": "string"
                        }
                    ],
                    "_schema": "string",
                    "_revision": 0,
                    "_system_owned": false,
                    "display_name": "string",
                    "description": "string",
                    "tags": [
                        {
                            "scope": "string",
                            "tag": "string"
                        }
                    ],
                    "_create_user": "string",
                    "_protection": "string",
                    "_create_time": 0,
                    "_last_modified_time": 0,
                    "_last_modified_user": "string",
                    "id": "string",
                    "resource_type": "string",
                    "ifindex": 0,
                    "neighbors": [
                        {
                            "system_name": "string",
                            "system_desc": "string",
                            "system_port_number": 0,
                            "name": "string",
                            "oid": "string",
                            "mgmt_addr": "string",
                            "capabilities": "string",
                            "link_aggregation_status": false,
                            "ifindex": 0,
                            "mac": "string",
                            "link_aggregation_capable": false,
                            "port_desc": "string",
                            "enabled_capabilities": "string",
                            "link_aggregation_port_id": "string"
                        }
                    ],
                    "mac": "string",
                    "name": "string"
                }
            ],
            "profiles": [
                {
                    "_self": {
                        "action": "string",
                        "href": "string",
                        "rel": "string"
                    },
                    "_links": [
                        {
                            "action": "string",
                            "href": "string",
                            "rel": "string"
                        }
                    ],
                    "_schema": "string",
                    "_revision": 0,
                    "_system_owned": false,
                    "display_name": "string",
                    "description": "string",
                    "tags": [
                        {
                            "scope": "string",
                            "tag": "string"
                        }
                    ],
                    "_create_user": "string",
                    "_protection": "string",
                    "_create_time": 0,
                    "_last_modified_time": 0,
                    "_last_modified_user": "string",
                    "id": "string",
                    "resource_type": "string",
                    "required_capabilities": [
                        "string"
                    ]
                }
            ]
        }
    ],
    "errors": [
        {
            "error_summary": "string",
            "entity_type": "string"
        }
    ],
    "logical_switches": [
        {
            "resource": {
                "_system_owned": false,
                "display_name": "string",
                "description": "string",
                "tags": [
                    {
                        "scope": "string",
                        "tag": "string"
                    }
                ],
                "_create_user": "string",
                "_protection": "string",
                "_create_time": 0,
                "_last_modified_time": 0,
                "_last_modified_user": "string",
                "id": "string",
                "resource_type": "string"
            },
            "id": "string",
            "vm_ports_states": [
                {
                    "transport_node_ids": [
                        "string"
                    ],
                    "discovered_bindings": [
                        {
                            "source": "string",
                            "binding": {
                                "vlan": 0,
                                "ip_address": "string",
                                "mac_address": "string"
                            },
                            "binding_timestamp": 0
                        }
                    ],
                    "id": "string",
                    "realized_bindings": [
                        {
                            "source": "string",
                            "binding": {
                                "vlan": 0,
                                "ip_address": "string",
                                "mac_address": "string"
                            },
                            "binding_timestamp": 0
                        }
                    ]
                }
            ],
            "vm_ports": [
                {
                    "_self": {
                        "action": "string",
                        "href": "string",
                        "rel": "string"
                    },
                    "_links": [
                        {
                            "action": "string",
                            "href": "string",
                            "rel": "string"
                        }
                    ],
                    "_schema": "string",
                    "_revision": 0,
                    "_system_owned": false,
                    "display_name": "string",
                    "description": "string",
                    "tags": [
                        {
                            "scope": "string",
                            "tag": "string"
                        }
                    ],
                    "_create_user": "string",
                    "_protection": "string",
                    "_create_time": 0,
                    "_last_modified_time": 0,
                    "_last_modified_user": "string",
                    "id": "string",
                    "resource_type": "string",
                    "logical_switch_id": "string",
                    "init_state": "string",
                    "switching_profile_ids": [
                        {
                            "value": "string",
                            "key": "string"
                        }
                    ],
                    "attachment": {
                        "attachment_type": "string",
                        "context": {
                            "allocate_addresses": "string",
                            "resource_type": "string"
                        },
                        "id": "string"
                    },
                    "admin_state": "string",
                    "extra_configs": [
                        {
                            "config_pair": {
                                "value": "string",
                                "key": "string"
                            }
                        }
                    ],
                    "address_bindings": [
                        {
                            "vlan": 0,
                            "ip_address": "string",
                            "mac_address": "string"
                        }
                    ]
                }
            ],
            "vm_vnics": [
                {
                    "_self": {
                        "action": "string",
                        "href": "string",
                        "rel": "string"
                    },
                    "_links": [
                        {
                            "action": "string",
                            "href": "string",
                            "rel": "string"
                        }
                    ],
                    "_schema": "string",
                    "_last_sync_time": 0,
                    "display_name": "string",
                    "description": "string",
                    "resource_type": "string",
                    "tags": [
                        {
                            "scope": "string",
                            "tag": "string"
                        }
                    ],
                    "mac_address": "string",
                    "device_key": "string",
                    "host_id": "string",
                    "owner_vm_id": "string",
                    "vm_local_id_on_host": "string",
                    "external_id": "string",
                    "lport_attachment_id": "string",
                    "ip_address_info": [
                        {
                            "source": "string",
                            "ip_addresses": [
                                "string"
                            ]
                        }
                    ],
                    "device_name": "string"
                }
            ],
            "router_ports": [
                {
                    "_self": {
                        "action": "string",
                        "href": "string",
                        "rel": "string"
                    },
                    "_links": [
                        {
                            "action": "string",
                            "href": "string",
                            "rel": "string"
                        }
                    ],
                    "_schema": "string",
                    "_revision": 0,
                    "_system_owned": false,
                    "display_name": "string",
                    "description": "string",
                    "tags": [
                        {
                            "scope": "string",
                            "tag": "string"
                        }
                    ],
                    "_create_user": "string",
                    "_protection": "string",
                    "_create_time": 0,
                    "_last_modified_time": 0,
                    "_last_modified_user": "string",
                    "id": "string",
                    "resource_type": "string",
                    "logical_switch_id": "string",
                    "init_state": "string",
                    "switching_profile_ids": [
                        {
                            "value": "string",
                            "key": "string"
                        }
                    ],
                    "attachment": {
                        "attachment_type": "string",
                        "context": {
                            "allocate_addresses": "string",
                            "resource_type": "string"
                        },
                        "id": "string"
                    },
                    "admin_state": "string",
                    "extra_configs": [
                        {
                            "config_pair": {
                                "value": "string",
                                "key": "string"
                            }
                        }
                    ],
                    "address_bindings": [
                        {
                            "vlan": 0,
                            "ip_address": "string",
                            "mac_address": "string"
                        }
                    ]
                }
            ]
        }
    ],
    "edge_node_groups": [
        {
            "resource": {
                "_system_owned": false,
                "display_name": "string",
                "description": "string",
                "tags": [
                    {
                        "scope": "string",
                        "tag": "string"
                    }
                ],
                "_create_user": "string",
                "_protection": "string",
                "_create_time": 0,
                "_last_modified_time": 0,
                "_last_modified_user": "string",
                "id": "string",
                "resource_type": "string"
            },
            "id": "string",
            "edge_nodes": [
                {
                    "_self": {
                        "action": "string",
                        "href": "string",
                        "rel": "string"
                    },
                    "_links": [
                        {
                            "action": "string",
                            "href": "string",
                            "rel": "string"
                        }
                    ],
                    "_schema": "string",
                    "_revision": 0,
                    "_system_owned": false,
                    "display_name": "string",
                    "description": "string",
                    "tags": [
                        {
                            "scope": "string",
                            "tag": "string"
                        }
                    ],
                    "_create_user": "string",
                    "_protection": "string",
                    "_create_time": 0,
                    "_last_modified_time": 0,
                    "_last_modified_user": "string",
                    "id": "string",
                    "resource_type": "string",
                    "host_switches": [
                        {
                            "pnics": [
                                {
                                    "uplink_name": "string",
                                    "device_name": "string"
                                }
                            ],
                            "host_switch_name": "string",
                            "static_ip_pool_id": "string",
                            "host_switch_profile_ids": [
                                {
                                    "value": "string",
                                    "key": "string"
                                }
                            ]
                        }
                    ],
                    "host_switch_spec": {
                        "resource_type": "string"
                    },
                    "node_id": "string",
                    "maintenance_mode": "string",
                    "transport_zone_endpoints": [
                        {
                            "transport_zone_id": "string",
                            "transport_zone_profile_ids": [
                                {
                                    "profile_id": "string",
                                    "resource_type": "string"
                                }
                            ]
                        }
                    ]
                }
            ],
            "logical_router_id": "string"
        }
    ],
    "routers": [
        {
            "resource": {
                "_system_owned": false,
                "display_name": "string",
                "description": "string",
                "tags": [
                    {
                        "scope": "string",
                        "tag": "string"
                    }
                ],
                "_create_user": "string",
                "_protection": "string",
                "_create_time": 0,
                "_last_modified_time": 0,
                "_last_modified_user": "string",
                "id": "string",
                "resource_type": "string"
            },
            "id": "string",
            "uplink_ports": [
                {
                    "_self": {
                        "action": "string",
                        "href": "string",
                        "rel": "string"
                    },
                    "_links": [
                        {
                            "action": "string",
                            "href": "string",
                            "rel": "string"
                        }
                    ],
                    "_schema": "string",
                    "_revision": 0,
                    "_system_owned": false,
                    "display_name": "string",
                    "description": "string",
                    "tags": [
                        {
                            "scope": "string",
                            "tag": "string"
                        }
                    ],
                    "_create_user": "string",
                    "_protection": "string",
                    "_create_time": 0,
                    "_last_modified_time": 0,
                    "_last_modified_user": "string",
                    "id": "string",
                    "resource_type": "string",
                    "logical_router_id": "string",
                    "service_bindings": [
                        {
                            "service_id": {
                                "target_display_name": "string",
                                "is_valid": false,
                                "target_id": "string",
                                "target_type": "string"
                            }
                        }
                    ]
                }
            ],
            "downlink_ports": [
                {
                    "_self": {
                        "action": "string",
                        "href": "string",
                        "rel": "string"
                    },
                    "_links": [
                        {
                            "action": "string",
                            "href": "string",
                            "rel": "string"
                        }
                    ],
                    "_schema": "string",
                    "_revision": 0,
                    "_system_owned": false,
                    "display_name": "string",
                    "description": "string",
                    "tags": [
                        {
                            "scope": "string",
                            "tag": "string"
                        }
                    ],
                    "_create_user": "string",
                    "_protection": "string",
                    "_create_time": 0,
                    "_last_modified_time": 0,
                    "_last_modified_user": "string",
                    "id": "string",
                    "resource_type": "string",
                    "logical_router_id": "string",
                    "service_bindings": [
                        {
                            "service_id": {
                                "target_display_name": "string",
                                "is_valid": false,
                                "target_id": "string",
                                "target_type": "string"
                            }
                        }
                    ]
                }
            ]
        }
    ],
    "vms": [
        {
            "_self": {
                "action": "string",
                "href": "string",
                "rel": "string"
            },
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_last_sync_time": 0,
            "display_name": "string",
            "description": "string",
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "source": {
                "target_display_name": "string",
                "is_valid": false,
                "target_id": "string",
                "target_type": "string"
            },
            "local_id_on_host": "string",
            "type": "string",
            "power_state": "string",
            "compute_ids": [
                "string"
            ],
            "host_id": "string",
            "external_id": "string"
        }
    ],
    "tunnels": [
        {
            "src_node_id": "string",
            "tunnel_properties": {
                "status": "string",
                "egress_interface": "string",
                "remote_node_display_name": "string",
                "remote_node_id": "string",
                "encap": "string",
                "bfd": {
                    "active": false,
                    "state": "string",
                    "remote_state": "string",
                    "remote_diagnostic": "string",
                    "forwarding": false,
                    "diagnostic": "string"
                },
                "name": "string",
                "local_ip": "string",
                "last_updated_time": 0,
                "remote_ip": "string"
            }
        }
    ]
}
containers
Required

containers

hypervisors
Required

hypervisors

errors
Required

errors

logical_switches
Required

logical_switches

edge_node_groups
Optional

edge_node_groups

routers
Optional

routers

vms
Required

vms

tunnels
Required

tunnels