Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| VMWARE_NSX_CONFIG | Yes | Path to the NSX configuration YAML file. | ~/.vmware-nsx/config.yaml |
| VMWARE_NSX_PROD_PASSWORD | No | The password for the VMware NSX Manager. Note: The environment variable name depends on the target name defined in your config (VMWARE_<TARGET_UPPER>_PASSWORD). |
Capabilities
Features and capabilities supported by this server
| Capability | Details |
|---|---|
| tools | {
"listChanged": false
} |
| prompts | {
"listChanged": false
} |
| resources | {
"subscribe": false,
"listChanged": false
} |
| experimental | {} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| list_segments | List all NSX network segments with type, subnet, admin state, and port count. Args: target: Optional NSX Manager target name from config. Uses default if omitted. |
| get_segment | Get detailed info for a specific network segment. Args: segment_id: The segment ID (policy path name). target: Optional NSX Manager target name from config. Uses default if omitted. |
| list_tier0_gateways | List all Tier-0 gateways with HA mode and transit subnets. Args: target: Optional NSX Manager target name from config. Uses default if omitted. |
| get_tier0_gateway | Get detailed info for a specific Tier-0 gateway. Args: tier0_id: The Tier-0 gateway ID. target: Optional NSX Manager target name from config. Uses default if omitted. |
| list_tier1_gateways | List all Tier-1 gateways with linked Tier-0 path and route advertisement. Args: target: Optional NSX Manager target name from config. Uses default if omitted. |
| get_tier1_gateway | Get detailed info for a specific Tier-1 gateway. Args: tier1_id: The Tier-1 gateway ID. target: Optional NSX Manager target name from config. Uses default if omitted. |
| list_transport_zones | List all transport zones with type and host switch name. Args: target: Optional NSX Manager target name from config. Uses default if omitted. |
| list_transport_nodes | List all transport nodes with type and status. Args: target: Optional NSX Manager target name from config. Uses default if omitted. |
| list_edge_clusters | List all edge clusters with member count and deployment type. Args: target: Optional NSX Manager target name from config. Uses default if omitted. |
| list_nat_rules | List NAT rules on a Tier-1 gateway. Args: tier1_id: The Tier-1 gateway ID. target: Optional NSX Manager target name from config. Uses default if omitted. |
| get_bgp_neighbors | Get BGP neighbors for a Tier-0 gateway with connection state and ASN. Args: tier0_id: The Tier-0 gateway ID. target: Optional NSX Manager target name from config. Uses default if omitted. |
| list_static_routes | List static routes on a Tier-1 gateway. Args: tier1_id: The Tier-1 gateway ID. target: Optional NSX Manager target name from config. Uses default if omitted. |
| list_ip_pools | List all IP address pools with subnets and usage summary. Args: target: Optional NSX Manager target name from config. Uses default if omitted. |
| get_ip_pool_usage | Get IP pool allocation usage details (total, allocated, free). Args: pool_id: The IP pool ID. target: Optional NSX Manager target name from config. Uses default if omitted. |
| list_nsx_alarms | Get all active NSX alarms with severity, feature, description, and entity. Args: target: Optional NSX Manager target name from config. Uses default if omitted. |
| get_transport_node_status | Check status of a specific transport node (connectivity, tunnel status). Args: node_id: The transport node ID. target: Optional NSX Manager target name from config. Uses default if omitted. |
| get_edge_cluster_status | Check status of an edge cluster (member health, overall status). Args: cluster_id: The edge cluster ID. target: Optional NSX Manager target name from config. Uses default if omitted. |
| get_nsx_manager_status | Get NSX Manager cluster status (node health, cluster status, version). Args: target: Optional NSX Manager target name from config. Uses default if omitted. |
| get_logical_port_status | Check logical port operational status (admin state, link state, attachment). Args: port_id: The logical port ID. target: Optional NSX Manager target name from config. Uses default if omitted. |
| get_segment_port_for_vm | Find which segment a VM is attached to via its VIF attachment. Args: vm_id: The VM external ID (BIOS UUID or instance UUID from vCenter). target: Optional NSX Manager target name from config. Uses default if omitted. |
| create_segment | Create a new network segment. Args: segment_id: Unique ID for the segment (used in policy path). display_name: Human-readable name for the segment. transport_zone_path: Full policy path to the transport zone. vlan_ids: VLAN ID(s) for VLAN-backed segments (e.g. "100" or "100-200"). subnet: Gateway CIDR for the segment (e.g. "192.168.1.1/24"). target: Optional NSX Manager target name from config. Uses default if omitted. |
| update_segment | Update an existing network segment (partial update via PATCH). Args: segment_id: The segment ID to update. display_name: New display name (optional). subnet: New gateway CIDR (optional). target: Optional NSX Manager target name from config. Uses default if omitted. |
| delete_segment | Delete a network segment. WARNING: This will disconnect all attached VMs. Args: segment_id: The segment ID to delete. target: Optional NSX Manager target name from config. Uses default if omitted. |
| create_tier1_gateway | Create a new Tier-1 gateway. Args: tier1_id: Unique ID for the Tier-1 gateway. display_name: Human-readable name. tier0_path: Policy path to link to a Tier-0 gateway (optional). edge_cluster_path: Policy path to an edge cluster for services (optional). route_advertisement: Comma-separated route advertisement types (optional). target: Optional NSX Manager target name from config. Uses default if omitted. |
| update_tier1_gateway | Update an existing Tier-1 gateway (partial update via PATCH). Args: tier1_id: The Tier-1 gateway ID to update. display_name: New display name (optional). tier0_path: New Tier-0 path to link (optional). route_advertisement: New route advertisement types (optional). target: Optional NSX Manager target name from config. Uses default if omitted. |
| delete_tier1_gateway | Delete a Tier-1 gateway. WARNING: This removes all attached segments and NAT rules. Args: tier1_id: The Tier-1 gateway ID to delete. target: Optional NSX Manager target name from config. Uses default if omitted. |
| configure_tier0_bgp | Configure BGP on a Tier-0 gateway (add/update a BGP neighbor). Args: tier0_id: The Tier-0 gateway ID. local_as: Local AS number. neighbor_address: BGP neighbor IP address. remote_as: Remote AS number. hold_time: Hold down time in seconds (default 180). keep_alive: Keep alive time in seconds (default 60). target: Optional NSX Manager target name from config. Uses default if omitted. |
| create_nat_rule | Create a NAT rule on a Tier-1 gateway. Args: tier1_id: The Tier-1 gateway ID. rule_id: Unique ID for the NAT rule. action: NAT action: "SNAT", "DNAT", or "REFLEXIVE" (default "DNAT"). source_network: Source network CIDR (required for SNAT). destination_network: Destination network CIDR (required for DNAT). translated_network: Translated network/IP address. target: Optional NSX Manager target name from config. Uses default if omitted. |
| delete_nat_rule | Delete a NAT rule from a Tier-1 gateway. Args: tier1_id: The Tier-1 gateway ID. rule_id: The NAT rule ID to delete. target: Optional NSX Manager target name from config. Uses default if omitted. |
| create_static_route | Create a static route on a Tier-1 gateway. Args: tier1_id: The Tier-1 gateway ID. route_id: Unique ID for the static route. network: Destination CIDR (e.g. "10.0.0.0/8"). next_hop: Next hop IP address. target: Optional NSX Manager target name from config. Uses default if omitted. |
| delete_static_route | Delete a static route from a Tier-1 gateway. Args: tier1_id: The Tier-1 gateway ID. route_id: The static route ID to delete. target: Optional NSX Manager target name from config. Uses default if omitted. |
| create_ip_pool | Create a new IP address pool with a static subnet allocation range. Args: pool_id: Unique ID for the IP pool. display_name: Human-readable name. start_ip: Start IP address of the allocation range. end_ip: End IP address of the allocation range. cidr: Subnet CIDR (e.g. "192.168.1.0/24"). gateway_ip: Gateway IP for the subnet (optional). target: Optional NSX Manager target name from config. Uses default if omitted. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |