VMware NSX

[READ] Get NSX Manager cluster status (node health, control/management plane). Start any NSX health check here: if the manager cluster is degraded, every other reading is suspect. Returns one dict (not the list envelope): cluster_id, overall_status, control_cluster_status, mgmt_cluster_status, online_node_count and nodes. Only online nodes are listed, so a node missing from `nodes` is down rather than absent. Then list_nsx_alarms for what is actually firing. Args: target: NSX Manager target from config (default if omitted).

[READ] Get full details for one network segment, including its attached ports. Use after list_segments to inspect one segment. Returns one dict (not the list envelope): id, display_name, type, admin_state, subnets, transport_zone_path, connectivity_path (linked gateway), vlan_ids, port_count, and the first 50 ports only. A segment with attached ports cannot be deleted — check port_count before calling delete_segment. For per-port realized state use get_logical_port_status; to change the segment use update_segment. Args: segment_id: Segment ID — final component of /infra/segments/<id>, as…

[READ] Find which segment(s) a VM is attached to via its VIF attachments. Start here for "why can this VM not reach the network?" — it is the only tool mapping a VM name onto NSX topology. Looks the VM up in the fabric inventory, fetches its VIFs, and matches segment ports by lport_attachment_id. Returns one dict (not the list envelope): VM info (external_id, host, power state) and matched_ports (segment id/name, port id/name). Matching is on exact display name, and empty matched_ports means no VIF is attached, not that the VM is missing. Then get_logical_port_status on the segment it names.…

[READ] Get configuration details for one Tier-0 gateway (north-south edge router). Use after list_tier0_gateways to inspect HA configuration, or to build the tier0_path ("/infra/tier-0s/<id>") that create_tier1_gateway needs. For BGP peering state use get_bgp_neighbors instead. Returns one dict (not the list envelope): id, display_name, ha_mode, failover_mode, transit_subnets, internal_transit_subnets, rd_admin_field. Static config only — it does not say whether the gateway is currently forwarding. Args: tier0_id: Tier-0 gateway ID, as returned by list_tier0_gateways. target: NSX Man…

[READ] Get detailed info for one Tier-1 gateway. Use after list_tier1_gateways, and always before update_tier1_gateway — update is a PATCH, so you need the current values to know what you are changing. Returns a single detail dict (not the list envelope): id, display_name, tier0_path, failover_mode, route_advertisement_types, type. Attached segments are not listed here — use list_segments for those. Args: tier1_id: Tier-1 gateway ID, as returned by list_tier1_gateways. target: NSX Manager target from config (default if omitted).

[READ] Get realized runtime status of one transport node (ESXi host or Edge node). Use after list_transport_nodes when a node looks degraded or overlay tunnels are suspect; for cluster-wide edge health use get_edge_cluster_status instead. Returns one dict (not the list envelope): node_id, status (UP, DEGRADED, DOWN, UNKNOWN), control_connection_status, mgmt_connection_status, tunnel_status (up/down/degraded counts, BFD counters) and pnic_status. Point-in-time only — no history. If tunnels are down on one segment only, follow up with get_logical_port_status rather than blaming the node. Args…

[READ] List all edge clusters with member count and deployment type. Returns the result envelope; check `truncated` before calling it complete. Page it: `limit` is the page size (1-1000, default 50; 0 or negative is rejected), `offset` is how many rows to skip, and the response carries `next_offset` — pass that back as `offset` and stop when it is null. Do not loop on `truncated`: that says this page is not the whole collection, so it stays true on the last page of a walk. Use this first to resolve a cluster_id, then get_edge_cluster_status for member health. The id is also what create_tier1…

[READ] List all IP address pools with subnets and usage summary. Returns the result envelope; check `truncated` before calling it complete. Page it: `limit` is the page size (1-1000, default 50; 0 or negative is rejected), `offset` is how many rows to skip, and the response carries `next_offset` — pass that back as `offset` and stop when it is null. Do not loop on `truncated`: that says this page is not the whole collection, so it stays true on the last page of a walk. Use this first to resolve a pool_id, then get_ip_pool_usage for the actual allocations — the summary here does not tell you …

[READ] List NAT rules on a Tier-1 gateway (USER section). Returns the result envelope; check `truncated` before calling it complete. Page it: `limit` is the page size (1-1000, default 50; 0 or negative is rejected), `offset` is how many rows to skip, and the response carries `next_offset` — pass that back as `offset` and stop when it is null. Do not loop on `truncated`: that says this page is not the whole collection, so it stays true on the last page of a walk. Get tier1_id from list_tier1_gateways first. Use this before create_nat_rule to avoid an id clash, and before delete_nat_rule to co…

[READ] Get active NSX alarms at one severity, with feature, description, and entity. Returns the result envelope; check `truncated` before calling it complete. Note: the NSX severity filter is an EXACT match — "MEDIUM" returns only MEDIUM alarms, not MEDIUM-and-above, so call it once per severity to build a full picture. Page it: `limit` is the page size (1-1000, 0 or negative is rejected), `offset` is how many rows to skip, and the response carries `next_offset` — pass that back as `offset` and stop when it is null. Do not loop on `truncated`: that says this page is not the whole set, so it…

[READ] List all NSX network segments with type, subnet, admin state, and port count. Returns the result envelope: rows under `items`, plus `returned`, `limit`, `total` (the collection's result_count, null when the API omits it), `truncated` and `hint`. Check `truncated` before calling this the complete set — when true, more rows exist. Every list tool here returns that shape. Page it: `limit` is the page size (1-1000, default 50; 0 or negative is rejected), `offset` is how many rows to skip, and the response carries `next_offset` — pass that back as `offset` and stop when it is null. Do not …

[READ] List static routes on a Tier-0 or Tier-1 gateway. Returns the result envelope; check `truncated` before calling it complete. Page it: `limit` is the page size (1-1000, default 50; 0 or negative is rejected), `offset` is how many rows to skip, and the response carries `next_offset` — pass that back as `offset` and stop when it is null. Do not loop on `truncated`: that says this page is not the whole collection, so it stays true on the last page of a walk. Use this before create_static_route to avoid an id clash, and before delete_static_route to confirm the destination and next hops. g…

[READ] List all Tier-0 gateways with HA mode and transit subnets. Returns the result envelope; check `truncated` before calling it complete. Page it: `limit` is the page size (1-1000, default 50; 0 or negative is rejected), `offset` is how many rows to skip, and the response carries `next_offset` — pass that back as `offset` and stop when it is null. Do not loop on `truncated`: that says this page is not the whole collection, so it stays true on the last page of a walk. Use this first to resolve a tier0_id, then get_tier0_gateway for HA detail and the tier0_path that create_tier1_gateway nee…

[READ] List all Tier-1 gateways with linked Tier-0 path and route advertisement. Returns the result envelope; check `truncated` before calling it complete. Page it: `limit` is the page size (1-1000, default 50; 0 or negative is rejected), `offset` is how many rows to skip, and the response carries `next_offset` — pass that back as `offset` and stop when it is null. Do not loop on `truncated`: that says this page is not the whole collection, so it stays true on the last page of a walk. Use this first to resolve a tier1_id — create_nat_rule, create_static_route, list_nat_rules and update_tier1…

[READ] List all transport nodes (ESXi hosts and Edge nodes) with type and status. Returns the result envelope; check `truncated` before calling it complete. Page it: `limit` is the page size (1-1000, default 50; 0 or negative is rejected), `offset` is how many rows to skip, and the response carries `next_offset` — pass that back as `offset` and stop when it is null. Do not loop on `truncated`: that says this page is not the whole collection, so it stays true on the last page of a walk. Use this first to resolve a node_id, then get_transport_node_status for that node's tunnels, controller con…

[READ] List all NSX transport zones — the overlay/VLAN boundaries segments attach to. Page it: `limit` is the page size (1-1000, default 50; 0 or negative is rejected), `offset` is how many rows to skip, and the response carries `next_offset` — pass that back as `offset` and stop when it is null. Do not loop on `truncated`: that says this page is not the whole collection, so it stays true on the last page of a walk. Use this first when building a segment: create_segment requires a transport_zone_path of "/infra/sites/default/enforcement-points/default/transport-zones/<id>" built from the id …

[WRITE] Update an existing network segment (partial update via PATCH). Only the fields you pass change. Use get_segment first, and prefer this over create_segment for an existing segment: create is a PUT and overwrites everything. Changing subnet re-addresses the gateway and can drop traffic for attached VMs, so check port_count first. Returns the updated segment dict, else {"error", "hint"}. Args: segment_id: Segment ID to update, as returned by list_segments. display_name: New display name. Optional. subnet: New gateway CIDR, e.g. "192.168.1.1/24". Optional. target: NSX Man…

[WRITE] Partially update an existing Tier-1 gateway via PATCH. Only the fields you pass change. Use get_tier1_gateway first — route_advertisement is sent as a whole list, so include every type you want kept. Prefer this over create_tier1_gateway for an existing gateway: create is a PUT and overwrites everything. Re-applying identical values is harmless. Returns the updated gateway dict, else {"error", "hint"}. Args: tier1_id: Gateway ID to update, as returned by list_tier1_gateways. display_name: New display name. Optional. tier0_path: New parent Tier-0 path, e.g. "/infra/tier-0s…