get_tier0_gateway
Retrieve detailed configuration and status information for a specific Tier-0 gateway in VMware NSX by providing its gateway ID.
Instructions
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.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tier0_id | Yes | ||
| target | No |
Implementation Reference
- vmware_nsx/ops/inventory.py:103-114 (handler)The core function that performs the API call to NSX to retrieve Tier-0 gateway details.
def get_tier0_gateway(client: NsxClient, tier0_id: str) -> dict: """Get Tier-0 gateway details.""" t = client.get(f"/policy/api/v1/infra/tier-0s/{tier0_id}") return { "id": _sanitize(t.get("id", "")), "display_name": _sanitize(t.get("display_name", "")), "ha_mode": t.get("ha_mode", ""), "failover_mode": t.get("failover_mode", ""), "transit_subnets": t.get("transit_subnets", []), "internal_transit_subnets": t.get("internal_transit_subnets", []), "rd_admin_field": t.get("rd_admin_field", ""), } - mcp_server/server.py:129-139 (handler)The MCP tool handler function in mcp_server/server.py that prepares the client and calls the inventory module.
def get_tier0_gateway(tier0_id: str, target: str | None = None) -> dict: """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. """ from vmware_nsx.ops.inventory import get_tier0_gateway as _get_tier0 client = _get_connection(target) return _get_tier0(client, tier0_id)