Skip to content

Commit

Permalink
Update gen API ref
Browse files Browse the repository at this point in the history
  • Loading branch information
Frostman committed Aug 28, 2024
1 parent 42bc89f commit 0e85a46
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/reference/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -646,6 +646,9 @@ _Appears in:_
| `vrf` _string_ | VRF name to identify specific VPC (will be added to DHCP packets by DHCP relay in suboption 151), such as "VrfVvpc-1" as it's named on switch | | |
| `circuitID` _string_ | VLAN ID to identify specific subnet withing the VPC, such as "Vlan1000" as it's named on switch | | |
| `pxeURL` _string_ | PXEURL (optional) to identify the pxe server to use to boot hosts connected to this segment such as http://10.10.10.99/bootfilename or tftp://10.10.10.99/bootfilename, http query strings are not supported | | |
| `dnsServers` _string array_ | DNSservers (optional) to configure Domain Name Servers for this particular segment such as: 10.10.10.1, 10.10.10.2 | | |
| `timeServers` _string array_ | TimeServers (optional) NTP server addresses to configure for time servers for this particular segment such as: 10.10.10.1, 10.10.10.2 | | |
| `interfaceMTU` _integer_ | InterfaceMTU (optional) is the MTU setting that the dhcp server will send to the clients. It is dependent on the client to honor this option. | | |


#### DHCPSubnetStatus
Expand Down Expand Up @@ -1070,7 +1073,26 @@ _Appears in:_
| `relay` _string_ | Relay is the DHCP relay IP address, if specified, DHCP server will be disabled | | |
| `enable` _boolean_ | Enable enables DHCP server for the subnet | | |
| `range` _[VPCDHCPRange](#vpcdhcprange)_ | Range (optional) is the DHCP range for the subnet if DHCP server is enabled | | |
| `options` _[VPCDHCPOptions](#vpcdhcpoptions)_ | Options (optional) is the DHCP options for the subnet if DHCP server is enabled | | |


#### VPCDHCPOptions



VPCDHCPOptions defines the DHCP options for the subnet if DHCP server is enabled



_Appears in:_
- [VPCDHCP](#vpcdhcp)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `pxeURL` _string_ | PXEURL (optional) to identify the pxe server to use to boot hosts connected to this segment such as http://10.10.10.99/bootfilename or tftp://10.10.10.99/bootfilename, http query strings are not supported | | |
| `dnsServers` _string array_ | DNSservers (optional) to configure Domain Name Servers for this particular segment such as: 10.10.10.1, 10.10.10.2 | | Optional: {} <br /> |
| `timeServers` _string array_ | TimeServers (optional) NTP server addresses to configure for time servers for this particular segment such as: 10.10.10.1, 10.10.10.2 | | Optional: {} <br /> |
| `interfaceMTU` _integer_ | InterfaceMTU (optional) is the MTU setting that the dhcp server will send to the clients. It is dependent on the client to honor this option. | | |


#### VPCDHCPRange
Expand Down

0 comments on commit 0e85a46

Please sign in to comment.