get_tier1_gateway
Retrieve detailed configuration and status information for a specific Tier-1 gateway in VMware NSX networking environments.
Instructions
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.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tier1_id | Yes | ||
| target | No |
Implementation Reference
- vmware_nsx/ops/inventory.py:138-148 (handler)The actual implementation of retrieving a Tier-1 gateway.
def get_tier1_gateway(client: NsxClient, tier1_id: str) -> dict: """Get Tier-1 gateway details.""" t = client.get(f"/policy/api/v1/infra/tier-1s/{tier1_id}") return { "id": _sanitize(t.get("id", "")), "display_name": _sanitize(t.get("display_name", "")), "tier0_path": _sanitize(t.get("tier0_path", "")), "failover_mode": t.get("failover_mode", ""), "route_advertisement_types": t.get("route_advertisement_types", []), "type": t.get("type", ""), } - mcp_server/server.py:156-166 (registration)Tool registration for get_tier1_gateway in the MCP server.
def get_tier1_gateway(tier1_id: str, target: str | None = None) -> dict: """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. """ from vmware_nsx.ops.inventory import get_tier1_gateway as _get_tier1 client = _get_connection(target) return _get_tier1(client, tier1_id)