Update A VLAN
PUT {{baseUrl}}/networks/:networkId/appliance/vlans/:vlanId
Update a VLAN
#### Body Parameters
Parameter|Type|Description
:-------------: |:-------------: |:-------------:
name| string| The name of the VLAN
subnet| string| The subnet of the VLAN
applianceIp| string| The local IP of the appliance on the VLAN
groupPolicyId| string| The id of the desired group policy to apply to the VLAN
vpnNatSubnet| string| The translated VPN subnet if VPN and VPN subnet translation are enabled on the VLAN
dhcpHandling| string| The appliance's handling of DHCP requests on this VLAN. One of: 'Run a DHCP server', 'Relay DHCP to another server' or 'Do not respond to DHCP requests'
dhcpRelayServerIps| array| The IPs of the DHCP servers that DHCP requests should be relayed to
dhcpLeaseTime| string| The term of DHCP leases if the appliance is running a DHCP server on this VLAN. One of: '30 minutes', '1 hour', '4 hours', '12 hours', '1 day' or '1 week'
dhcpBootOptionsEnabled| boolean| Use DHCP boot options specified in other properties
dhcpBootNextServer| string| DHCP boot option to direct boot clients to the server to load the boot file from
dhcpBootFilename| string| DHCP boot option for boot filename
fixedIpAssignments| object| The DHCP fixed IP assignments on the VLAN. This should be an object that contains mappings from MAC addresses to objects that themselves each contain ip
and name
string fields. See the sample request/response for more details.
reservedIpRanges| array| The DHCP reserved IP ranges on the VLAN
dnsNameservers| string| The DNS nameservers used for DHCP responses, either upstream_dns
, google_dns
, opendns
, or a newline seperated string of IP addresses or domain names
dhcpOptions| array| The list of DHCP options that will be included in DHCP responses. Each object in the list should have code
, type
, and value
properties.
Supports Action Batches
Resource | Operation |
---|---|
/networks/{networkId}/appliance/vlans/{vlanId} | update |
Request Body
{"name"=>"<string>", "subnet"=>"<string>", "applianceIp"=>"<string>", "groupPolicyId"=>"<string>", "vpnNatSubnet"=>"<string>", "dhcpHandling"=>"<string>", "dhcpRelayServerIps"=>["<string>", "<string>"], "dhcpLeaseTime"=>"<string>", "dhcpBootOptionsEnabled"=>"<boolean>", "dhcpBootNextServer"=>"<string>", "dhcpBootFilename"=>"<string>", "fixedIpAssignments"=>{}, "reservedIpRanges"=>[{"start"=>"<string>", "end"=>"<string>", "comment"=>"<string>"}, {"start"=>"<string>", "end"=>"<string>", "comment"=>"<string>"}], "dnsNameservers"=>"<string>", "dhcpOptions"=>[{"code"=>"<string>", "type"=>"<string>", "value"=>"<string>"}, {"code"=>"<string>", "type"=>"<string>", "value"=>"<string>"}]}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-Cisco-Meraki-API-Key | null | ||
Content-Type | string |
RESPONSES
status: OK
{"id":"1234","networkId":"N_24329156","name":"My VLAN","applianceIp":"192.168.1.2","subnet":"192.168.1.0/24","groupPolicyId":"101","fixedIpAssignments":{"22:33:44:55:66:77":{"ip":"1.2.3.4","name":"Some client name"}},"reservedIpRanges":[{"start":"192.168.1.0","end":"192.168.1.1","comment":"A reserved IP range"}],"dnsNameservers":"google_dns","dhcpHandling":"Run a DHCP server","dhcpLeaseTime":"1 day","dhcpBootOptionsEnabled":false,"dhcpBootNextServer":null,"dhcpBootFilename":null,"dhcpOptions":[{"code":5,"type":"text","value":"five"}]}