NSX-T Data Center REST API

VpcSubnetDhcpConfig (type)

{
  "description": "VPC Subnet DHCP config",
  "id": "VpcSubnetDhcpConfig",
  "module_id": "PolicyVpcSubnet",
  "properties": {
    "dhcp_relay_config_path": {
      "deprecated": true,
      "deprecation_advice": "Configure dhcp_relay_config is a recommended option to configure DHCP relay on subnet.\ndhcp_relay_config_path is not allowed for VPC subnet when VPC has DHCP configured under VPC Service Profile.\n",
      "description": "If configured then subnet will be configured with the DHCP Relay. Configure dhcp_relay_config is a recommended option to configure DHCP relay on subnet.",
      "required": false,
      "title": "DHCP relay config path",
      "type": "string",
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "VpcSubnet"
          ],
          "relationshipType": "VPC_SUBNET_DHCP_RELAY_PROFILE_RELATIONSHIP",
          "rightType": [
            "DhcpRelayConfig"
          ]
        }
      ]
    },
    "dns_client_config": {
      "$ref": "DnsClientConfig",
      "description": "Specifies the Network Time Protocol servers that clients will use to synchronize their system clock. The NTP servers must be configured within this property rather than using DHCP option code 42 directly. This approach ensures consistency and centralized management if NTP settings.",
      "required": false,
      "title": "Dns client configuration"
    },
    "enable_dhcp": {
      "description": "This is used to enable or disable DHCP at VPC Subnet. True: to override DHCP config at VPC/VPC Service Profile. False: to disable DHCP, other DHCP configurations are not allowed to be configured.",
      "required": false,
      "title": "Activate or Deactivate DHCP",
      "type": "boolean"
    },
    "lease_time": {
      "default": 86400,
      "description": "DHCP lease time in seconds. When specified, this property overwrites lease time configured DHCP server config. The default lease time is 86,400 seconds. In DHCP_RELAY mode, any specified lease time will be ignored.",
      "maximum": 4294967295,
      "minimum": 60,
      "nsx_feature": "VpcSimplification",
      "required": false,
      "title": "DHCP lease time for subnet",
      "type": "integer"
    },
    "static_pool_config": {
      "$ref": "StaticPoolConfig",
      "description": "Static IP pool configuration.",
      "required": false,
      "title": "Static IP pool configuration"
    }
  },
  "title": "VPC Subnet DHCP configuration",
  "type": "object"
}