Table of Contents

Class OrganizationsApplianceVlan

Namespace
Meraki.Api.Data
Assembly
Meraki.Api.dll

Organizations Appliance Vlan

[DataContract]
public class OrganizationsApplianceVlan
Inheritance
OrganizationsApplianceVlan
Inherited Members

Constructors

OrganizationsApplianceVlan() 

public OrganizationsApplianceVlan()

Properties

ApplianceIp

The local IP of the appliance on the VLAN

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "applianceIp")]
public string ApplianceIp { get; set; }

Property Value

string

Cidr

CIDR of the pool of subnets. Applicable only for template network. Each network bound to the template will automatically pick a subnet from this pool to build its own VLAN.

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "cidr")]
public string Cidr { get; set; }

Property Value

string

DhcpBootFilename

DHCP boot option to direct boot clients to the server to load the boot file from

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "dhcpBootFilename")]
public string DhcpBootFilename { get; set; }

Property Value

string

DhcpBootNextServer

DHCP boot option to direct boot clients to the server to load the boot file from

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "dhcpBootNextServer")]
public string DhcpBootNextServer { get; set; }

Property Value

string

DhcpBootOptionsEnabled

Use DHCP boot options specified in other properties

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "dhcpBootOptionsEnabled")]
public bool DhcpBootOptionsEnabled { get; set; }

Property Value

bool

DhcpHandling

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'

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "dhcpLeaseTime")]
public string DhcpHandling { get; set; }

Property Value

string

DhcpLeaseTime

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'

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "dhcpLeaseTime")]
public string DhcpLeaseTime { get; set; }

Property Value

string

DhcpOptions

The list of DHCP options that will be included in DHCP responses. Each object in the list should have "code", "type", and "value" properties.

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "dhcpOptions")]
public List<OrganizationsApplianceVlanDhcpOption> DhcpOptions { get; set; }

Property Value

List<OrganizationsApplianceVlanDhcpOption>

DhcpRelayServerIps

The IPs of the DHCP servers that DHCP requests should be relayed to

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "dhcpRelayServerIps")]
public List<string> DhcpRelayServerIps { get; set; }

Property Value

List<string>

DnsNameservers

The DNS nameservers used for DHCP responses, either "upstream_dns", "google_dns", "opendns", or a newline seperated string of IP addresses or domain names

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "dnsNameservers")]
public string DnsNameservers { get; set; }

Property Value

string

FixedIpAssignments

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.

[ApiAccess(ApiAccess.ReadWrite)]
[DataMember(Name = "fixedIpAssignments")]
public OrganizationsApplianceVlanFixedIpAssignments FixedIpAssignments { get; set; }

Property Value

OrganizationsApplianceVlanFixedIpAssignments

GroupPolicyId

The id of the desired group policy to apply to the VLAN

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "groupPolicyId")]
public string GroupPolicyId { get; set; }

Property Value

string

Id

The VLAN ID of the VLAN

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "id")]
public string Id { get; set; }

Property Value

string

InterfaceId

The interface ID of the VLAN

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "interfaceId")]
public string InterfaceId { get; set; }

Property Value

string

Ipv6

IPv6 configuration on the VLAN

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "ipv6")]
public OrganizationsApplianceVlanIpv6 Ipv6 { get; set; }

Property Value

OrganizationsApplianceVlanIpv6

MandatoryDhcp

Mandatory DHCP will enforce that clients connecting to this VLAN must use the IP address assigned by the DHCP server. Clients who use a static IP address won't be able to associate. Only available on firmware versions 17.0 and above

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "mandatoryDhcp")]
public OrganizationsApplianceVlanMandatoryDhcp MandatoryDhcp { get; set; }

Property Value

OrganizationsApplianceVlanMandatoryDhcp

Mask

Mask used for the subnet of all bound to the template networks. Applicable only for template network.

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "mask")]
public int Mask { get; set; }

Property Value

int

Name

The name of the VLAN

[ApiAccess(ApiAccess.ReadWrite)]
[DataMember(Name = "name")]
public string Name { get; set; }

Property Value

string

ReservedIpRanges

The DHCP reserved IP ranges on the VLAN

[ApiAccess(ApiAccess.ReadWrite)]
[DataMember(Name = "reservedIpRanges")]
public List<OrganizationsApplianceVlanReservedIpRange> ReservedIpRanges { get; set; }

Property Value

List<OrganizationsApplianceVlanReservedIpRange>

Subnet

The subnet of the VLAN

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "subnet")]
public string Subnet { get; set; }

Property Value

string

TemplateVlanType

Type of subnetting of the VLAN. Applicable only for template network.

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "templateVlanType")]
public VlanType TemplateVlanType { get; set; }

Property Value

VlanType

VpnNatSubnet

The translated VPN subnet if VPN and VPN subnet translation are enabled on the VLAN

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "vpnNatSubnet")]
public string VpnNatSubnet { get; set; }

Property Value

string
Edit this page