models.vlan module

class models.vlan.Vlan(add_to_cluster_partition=None, all_tenant_access=None, app_ip_vec_in_use=None, appsips=None, description=None, dns_delegation_zones=None, ecmp_enabled=None, gateway=None, gateway_v6=None, hostname=None, id=None, iface_group_name=None, interface_group_id=None, interface_name=None, ip_family=None, ip_pool_map=None, ip_range=None, ip_ranges=None, ips=None, mtu=None, subnet=None, subnet_v6=None, tenant_id=None, vlan_name=None)

Bases: object

Implementation of the ‘Vlan’ model.

Specifies the settings of a VLAN. Its used by both Request and Response structures.

Attributes:

add_to_cluster_partition (bool): Specifies whether to add the VLAN IPs

to the cluster partition that already has one or more IPs from this VLAN.

all_tenant_access (bool): Specifies if this VLAN can be used by all

tenants without explicit assignment to them. This option can only be set true for VLANs that are not assigned to any tenant.

app_ip_vec_in_use (bool): Set to true when ips are in use by Athena

Apps. Note: If it is true then vlan interface can’t be deleted.

appsips (list of string): Array of Athena Apps IPs. Specifies a list

of Athena IPs in the VLAN.

description (string): Specifies a description of the VLAN. dns_delegation_zones (list of DnsDelegationZone): Specifies list of

dns delegation zones.

ecmp_enabled (bool): EcmpEnabled. Specifies if ECMP is enabled in the

VLAN.

gateway (string): Specifies the Gateway of the VLAN. gateway_v6 (string): Specifies the Gateway of the VLAN. hostname (string): Specifies the hostname of the VLAN. id (int): Specifies the id of the VLAN. iface_group_name (string): Specifies the interface group name of the

VLAN. It is in the format of <base_interface_group_name>.<vlan_id>.

interface_group_id (int): Specifies the id of the Loopback Interface

group. Used only in get, for display.

interface_name (string): Specifies the interface name ip_family (int|long): Specifies IP family. Based on this,

subnet/gateway field contains V4 or V6 values. Used in Request.

ip_pool_map (dict<object, list of string>): IpPoolMap. Pool IPs to

program VIP followers.

ip_range (IpRange): IP Range for vip addition ip_ranges (list of IpRange): Array of range of ips. If specified in

PUT request, Ips field will be ignored. Specifies ips in compressed way using list of [start, end] vips.

ips (list of string): Array of IPs. Specifies a list of IPs in the

VLAN.

mtu (int): TODO: type description here. subnet (Subnet): Specifies the subnet of the VLAN. The netmask can be

specified by setting netmaskBits or netmaskIp4. The netmask can only be set using netmaskIp4 if the IP address is an IPv4 address.

subnet_v6 (Subnet): Specifies the subnet of the VLAN.

The netmask can be specified by setting netmaskBits or netmaskIp4. The netmask can only be set using netmaskIp4 if the IP address is an IPv4 address.

tenant_id (string): Optional tenant id that this vlan belongs to. vlan_name (string): Specifies the VLAN name of the vlanId.

classmethod from_dictionary(dictionary)

Creates an instance of this model from a dictionary

Args:

dictionary (dictionary): A dictionary representation of the object as obtained from the deserialization of the server’s response. The keys MUST match property names in the API description.

Returns:

object: An instance of this structure class.