network methods

class ecl.network.v2._proxy.Proxy(session)

Bases: ecl.proxy2.BaseProxy

aws_gateways(**params)

Return a list of aws_gateways :param params: The parameters as query string

to get aws_gateways by specified condition.

Returns:A list of aws_gateways objects Return type:list of AWSGateway

aws_interfaces(**params)

Return a list of aws_interfaces

Parameters:params – The parameters as query string to get aws_interfaces by specified condition. Returns:A list of aws_interfaces objects Return type:list of AWSInterface

aws_services(**params)

Return a list of aws_services

Parameters:params – The parameters as query string to get aws_services by specified condition. Returns:A list of aws_services objects Return type:list of AWSService

colocation_logical_links(**query)

Return a list of colocation_logical_links

Parameters:query – Query parameters to select results. Returns:A list of colocation_logical_links objects Return type:list of ColocationLogicalLink

colocation_physical_links(**query)

Return a list of colocation_physical_links

Parameters:query – Query parameters to select results. Returns:A list of colocation_physical_links objects Return type:list of ColocationPhysicalLink

colocation_spaces(**query)

Return a list of colocation_spaces

Parameters:query – Query parameters to select results. Returns:A list of colocation_spaces objects Return type:list of ColocationSpace

common_function_gateways(**query)

Return a list of common_function_gateways

Parameters:query – Query parameters to select results. Returns:A list of common_function_gateways objects Return type:list of CommonFunctionGateway

common_function_pools(**query)

Return a list of common_function_pools

Returns:A list of common_function_pool objects Return type:list of CommonFunctionPool

common_functions(**query)

Return a list of common_functions

Parameters:query – Query parameters to select results. Returns:A list of common_functions objects Return type:list of CommonFunction

create_colocation_logical_link(colocation_physical_link_id, network_id, vlan_id, description=None, name=None, tags=None)

Create a new colocation_logical_link from attributes

Parameters:

• colocation_physical_link_id (string) – Colocation Physical Link ID.
• network_id (string) – Network connected to this link.
• vlan_id (string) – Logical port vlan id.
• description (string) – Colocation Logical Link description.
• name (string) – Colocation Logical Link name.
• tags (dict) – Colocation Logical Link tags.

Returns:

The results of colocation_logical_link creation

Return type:

ColocationLogicalLink

create_common_function_gateway(common_function_pool_id, description=None, name=None)

Create a new common_function_gateway from attributes

Parameters:

• common_function_pool_id (string) – Common Function Pool instantiated by this Gateway.
• description (string) – Description of the Common Function Pool Gateway resource.
• name (string) – Name of the Common Function Pool Gateway resource.

Returns:

The results of common_function_gateway creation

Return type:

CommonFunctionGateway

create_firewall(firewall_plan_id, availability_zone=None, default_gateway=None, description=None, name=None)

Create firewall.

Parameters:

• firewall_plan_id – Firewall Plan ID.
• availability_zone – Get from ~ecl.compute.v2.availability_zone.AvailabilityZone
• default_gateway – IP address of default gateway.
• description – Description of the Firewall.
• name – Name of the Firewall.

Returns:

Firewall

create_gateway_interface(service_type, network_id, netmask, primary_ipv4, secondary_ipv4, gw_vipv4, vrid, name=None, description=None, primary_ipv6=None, secondary_ipv6=None, gw_vipv6=None, interdc_gw_id=None, internet_gw_id=None, vpn_gw_id=None, aws_gw_id=None, tenant_id=None)

Create a Gateway Interface from parameters

Parameters:

• service_type (string) – service type of gateway interface to create
• network_id (string) – network ID of gateway interface to create
• netmask (int) – netmask of gateway interface to create
• primary_ipv4 (IPv4) – primary IPv4 of gateway interface to create
• secondary_ipv4 (IPv4) – secondary IPv4 of gateway interface to create
• gw_vipv4 (IPv4) – gateway virtual IPv4 interface to create
• vrid (int) – ID of VRRP of gateway interface to create
• name (string) – name of gateway interface to create
• description (string) – description of gateway interface to create
• primary_ipv6 (IPv6) – primary IPv6 of gateway interface to create
• secondary_ipv6 (IPv6) – secondary IPv6 of gateway interface to create
• gw_vipv6 (IPv6) – gateway virtual IPv6 of gateway interface to create
• interdc_gw_id (string) – InterDC Gateway ID of gateway interface to create
• internet_gw_id (string) – Internet Gateway ID of gateway interface to create
• vpn_gw_id (string) – VPN Gateway ID of gateway interface to create
• tenant_id (string) – tenant ID of gateway interface to create

Returns:

The results of GatewayInterface creation

Return type:

One GatewayInterface

create_interdc_interface(interdc_gw_id, netmask, primary_ipv4, secondary_ipv4, gw_vipv4, vrid, name=None, description=None, primary_ipv6=None, secondary_ipv6=None, gw_vipv6=None, tenant_id=None)

Create an InterDC Interface from parameters

Parameters:

• interdc_gw_id (string) – ID of InterDC interface to create
• netmask (int) – netmask of InterDC interface to create
• primary_ipv4 (IPv4) – primary IPv4 of InterDC interface to create
• secondary_ipv4 (IPv4) – secondary IPv4 of InterDC interface to create
• gw_vipv4 (IPv4) – InterDC virtual IPv4 interface to create
• vrid (int) – ID of VRRP of InterDC interface to create
• name (string) – name of InterDC interface to create
• description (string) – description of InterDC interface to create
• primary_ipv6 (IPv6) – primary IPv6 of InterDC interface to create
• secondary_ipv6 (IPv6) – secondary IPv6 of InterDC interface to create
• gw_vipv6 (IPv6) – InterDC virtual IPv6 of InterDC interface to create
• tenant_id (string) – tenant ID of InterDC interface to create

Returns:

The results of InterDCInterface creation

Return type:

One InterDCInterface

create_internet_gateway(internet_service_id, qos_option_id, name=None, description=None, tenant_id=None)

Create a new Internet Gateway from parameters.

Parameters:

• internet_service_id (string) – ID of Internet Service of gateway to create
• qos_option_id (string) – ID of QoS Option of gateway to create
• name (string) – name of gateway to create
• description (string) – description of gateway to create
• tenant_id (string) – ID of Tenant of gateway to create

Returns:

One InternetGateway

create_load_balancer(load_balancer_plan_id, availability_zone=None, description=None, name=None)

Create a load_balancer.

Parameters:

• load_balancer_plan_id – Load Balancer Plan.
• availability_zone – Availability Zone.
• description – Description of the Load Balancer.
• name – Name of the Load Balancer.

Returns:

LoadBalancer

create_load_balancer_syslog_server(ip_address, load_balancer_id, name, acl_logging=None, appflow_logging=None, date_format=None, description=None, log_facility=None, log_level=None, port_number=None, priority=None, tcp_logging=None, tenant_id=None, time_zone=None, transport_type=None, user_configurable_log_messages=None)

Create a Load Balancer Syslog Server from properties

Parameters:

• ip_address (string) – IP address of the syslog server
• load_balancer_id (uuid) – ID of load balancer this syslog server belongs to
• name (string) – Name for syslog
• acl_logging (enumerate) – [“ENABLED”, “DISABLED”]
• appflow_logging (enumerate) – [“ENABLED”, “DISABLED”]
• date_format (enumerate) – [“DDMMYYYY”, “MMDDYYYY”, “YYYYMMDD”]
• description (string) – Description for syslog
• log_facility (enumerate) – [“LOCAL0”, “LOCAL1”, “LOCAL2”, “LOCAL3”, “LOCAL4”, “LOCAL5”, “LOCAL6”, “LOCAL7”]
• log_level (string) – “ALL”, “NONE”, or one or more (join with “|”) of [“ALERT”, “CRITICAL”, “NOTICE”, “DEBUG”, “ERROR”, “WARNING”, “EMERGENCY”, “INFORMATIONAL”]
• port_number (int) – 1-65536
• priority (int) – 0-255
• tcp_logging (enumerate) – [“NONE”, “ALL”]
• tenant_id (uuid) – Tenant ID of the owner
• time_zone (enumerate) – [“GMT_TIME”, “LOCAL_TIME”]
• transport_type (enumerate) – [“UDP”]
• user_configurable_log_messages (enumerate) – [“YES”, “NO”]

Returns:

LoadBalancerSyslogServer

create_network(admin_state_up=None, description=None, name=None, plane=None, tenant_id=None, tags=None)

Create a new network from attributes

Parameters:

• admin_state_up (bool) – administrative state, default true
• description (string) – description of network
• name (string) – name of network
• plane (string) – Type of the traffic will be used. value should be “data” or “storage”
• tenant_id (string) – tenant id to create network
• tags (dict) – tags of network

Returns:

The results of network creation

Return type:

Network

create_port(admin_state_up=None, allowed_address_pairs=None, mac_address=None, description=None, device_id=None, device_owner=None, fixed_ips=None, name=None, network_id=None, segmentation_id=None, segmentation_type=None, tags=None)

Create a new port from attributes

Parameters:

• admin_state_up (string) – The admin state of port to create
• allowed_address_pairs (array) – allowed address pairs e.g. [{“mac_address”: <mac>, “ip_address”: <ipv4/cidr>}]
• mac_address (string) – The mac address of port to create
• description (string) – The description of port to create
• device_id (string) – The device id of port to create
• device_owner (string) – The device owner of port to create
• fixed_ips (array) – The fixed ips of port to create e.g. [{“ip_address”:<ipv4> , “subnet_id”: <uuid> }, ]
• name (string) – The name of port to create
• network_id (string) – The network id of port to create
• segmentation_id (int) – The segmentation id of port to create
• segmentation_type (string) – The segmentation type of port to create
• tags (dict) – tags of port

Returns:

The results of port creation

Return type:

Port

create_public_ip(internet_gw_id, submask_length, description=None, name=None, tenant_id=None)

Create a Public IP from parameters

Parameters:

• internet_gw_id (string) – ID of Internet Gateway to create public ip
• submask_length (int) – submask length to create public ip pool with
• description (string) – description of public ip to create
• name (string) – name of public ip to create
• tenant_id (string) – tenant ID of public ip

Returns:

One PublicIP

create_static_route(service_type, destination, nexthop, name=None, description=None, interdc_gw_id=None, internet_gw_id=None, vpn_gw_id=None, aws_gw_id=None, tenant_id=None)

Create a Static Route

Parameters:

• service_type – service type of static route to create
• destination – destination of static route to create
• nexthop – next hop of static route to create
• name – name of static route to create
• description – description of static route to create
• interdc_gw_id – InterDC Gateway ID of static route to create
• internet_gw_id – Internet Gateway ID of static route to create
• vpn_gw_id – VPN Gateway ID of static route to create
• tenant_id – tenant ID of static route to create

Returns:

The results of StaticRoute creation

Return type:

One StaticRoute

create_subnet(network_id, cidr, allocation_pools=None, description=None, dns_nameservers=None, enable_dhcp=None, gateway_ip=None, host_routes=None, ip_version=4, name=None, ntp_servers=None, tags=None)

Create a new subnet from attributes

Parameters:

• network_id (string) – ID of network that subnet belongs to.
• cidr (CIDR) – cidr of subnet to create
• allocation_pools (array) – allocation pools of subnet to create
• description (string) – description of subnet to create
• dns_nameservers (array) – dns nameservers of subnet to create
• enable_dhcp (bool) – bool value indicating if dhcp is enabled
• gateway_ip (IPv4) – Gateway IP of subnet to create
• host_routes (array) – host routes of subnet to create
• ip_version (Integer) – support v4 only
• name (string) – name of subnet to create
• ntp_servers (array) – ntp servers of subnet to create
• tags (dict) – tags of subnet to create

Returns:

The results of subnet creation

Return type:

Subnet

create_tenant_connection(connected_network_id, connected_network_tenant_id, connected_interface_id, connected_interface_ip_address, interface_type, name=None, description=None, tenant_id=None, connected_interface_virtual_ip_address=None, connected_interface_virtual_ip_vrid=None)

Create a TenantConnection from attributes

Parameters:

• connected_network_id (uuid) – ID of the connected network
• connected_network_tenant_id (uuid) – Tenant ID of the Connected Network
• connected_interface_id (uuid) – Resource id of the Interface which Connects the Tenant
• connected_interface_ip_address (IPv4) – IP Address of the Interface which Connects the Tenant
• connected_interface_virtual_ip_address (IPv4) – Virtual IP Address of the Interface which Connects the Tenant
• connected_interface_virtual_ip_vrid (integer) – VRID of the Interface which Connects the Tenant
• interface_type (string) – Interface Type of the Tenant Connection
• name (string) – Name of the Tenant Connection
• description (string) – Description of the Tenant Connection
• tenant_id (uuid) – Tenant ID of the owner

Returns:

results of TenantConnection creation

Return type:

TenantConnection

delete_colocation_logical_link(colocation_logical_link, ignore_missing=True)

Delete a colocation_logical_link

Parameters:

• colocation_logical_link – The value can be either the ID of a colocation_logical_link Interface or a ColocationLogicalLink instance.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the colocation_logical_link Interface does not exist. When set to True, no exception will be set when attempting to delete a nonexistent colocation_logical_link Interface.

Returns:

One ColocationLogicalLink

delete_common_function_gateway(common_function_gateway, ignore_missing=True)

Delete a common_function_gateway

Parameters:

• common_function_gateway – The value can be either the ID of a common_function_gateway Interface or a CommonFunctionGateway instance.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the common_function_gateway Interface does not exist. When set to True, no exception will be set when attempting to delete a nonexistent common_function_gateway Interface.

Returns:

One CommonFunctionGateway

delete_firewall(firewall_id)

Delete a sepcified firewall.

Parameters:firewall_id – ID of specified firewall. Returns:None

delete_gateway_interface(gwif, ignore_missing=True)

Delete a Gateway Interface

Parameters:

• gwif – The value can be either the ID of a Gateway Interface or a GatewayInterface instance.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the Gateway Interface does not exist. When set to True, no exception will be set when attempting to delete a nonexistent Gateway Interface.

Returns:

One GatewayInterface

delete_interdc_interface(interdc_interface, ignore_missing=True)

Delete an InterDC Interface

Parameters:

• gwif – The value can be either the ID of an InterDC Interface or a InterDCInterface instance.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the InterDC Interface does not exist. When set to True, no exception will be set when attempting to delete a nonexistent InterDC Interface.

Returns:

One InterDCInterface

delete_internet_gateway(inet_gw, ignore_missing=True)

Delete an Internet Gateway

Parameters:

• inet_gw – The value can be either the ID of an Internet Gateway or a InternetGateway instance.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the Internet Gateway does not exist. When set to True, no exception will be set when attempting to delete a nonexistent Internet Gateway.

Returns:

None

delete_load_balancer(load_balancer_id)

Delete load_balancer.

Parameters:load_balancer_id – ID of load balancer. Returns:LoadBalancer

delete_load_balancer_syslog_server(load_balancer_syslog_server, ignore_missing=True)

Delete a load balancer syslog server

Parameters:

• load_balancer_syslog_server –

  The value can be either the ID of an Load Balancer Syslog Server or a

  LoadBalancerSyslogServer instance.

• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the Load Balancer Syslog Server does not exist. When set to True, no exception will be set when attempting to delete a nonexistent Load Balancer Syslog Server.

Returns:

None

delete_network(network, ignore_missing=True)

Delete a network

Parameters:

• network – The value can be either the ID of a network or a Network instance.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the network does not exist. When set to True, no exception will be set when attempting to delete a nonexistent network.

Returns:

None

delete_port(port, ignore_missing=True)

Delete a port

Parameters:

• port – The value can be either the ID of a port or a Port instance.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the port does not exist. When set to True, no exception will be set when attempting to delete a nonexistent port.

Returns:

None

delete_public_ip(publicip, ignore_missing=True)

Delete a Public Ip

Parameters:

• publicip – The value can be either the ID of a Public IP or a PublicIP instance.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the Public IP does not exist. When set to True, no exception will be set when attempting to delete a nonexistent Public IP.

Returns:

One PublicIP

delete_static_route(static_route, ignore_missing=True)

Delete a Static Route

Parameters:

• static_route – The value can be either the ID of a Static Route or a StaticRoute instance.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the Static Route does not exist. When set to True, no exception will be set when attempting to delete a nonexistent Static Route.

Returns:

One StaticRoute

delete_subnet(subnet, ignore_missing=True)

Delete a subnet

Parameters:

• subnet – The value can be either the ID of a subnet or a Subnet instance.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the subnet does not exist. When set to True, no exception will be set when attempting to delete a nonexistent subnet.

Returns:

None

delete_tenant_connection(tenant_connection)

Delete a Tenant Connection

Parameters:tenant_connection – The value can be the ID of a tenant_connection or a TenantConeection instance. Returns:

execute_tenant_connection(tenant_connection)

extensions()

Return a list of extensions

Returns:A list of extension objects Return type:Extension

find_aws_gateway(name_or_id, ignore_missing=True)

Find a single aws_gateway

Parameters:

• name_or_id – The name or ID of a aws_gateway.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.

Returns:

One AWSGateway or None

find_aws_interface(name_or_id, ignore_missing=True)

Find a single aws_interface

Parameters:

• name_or_id – The name or ID of a aws_interface.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.

Returns:

One AWSInterface or None

find_aws_service(name_or_id, ignore_missing=True)

Find a single aws_service

Parameters:

• name_or_id – The name or ID of a aws_service.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.

Returns:

One AWSService or None

find_common_function(name_or_id, ignore_missing=True)

Find a single common_function

Parameters:

• name_or_id – The name or ID of a common_function_gatway.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.

Returns:

One CommonFunction or None

find_common_function_gateway(name_or_id, ignore_missing=True)

Find a single common_function_gateway

Parameters:

• name_or_id – The name or ID of a common_function_gatway.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.

Returns:

One CommonFunctionGateway or None

find_common_function_pool(name_or_id, ignore_missing=True)

Find a single common_function_pool

Parameters:

• name_or_id – The name or ID of a common_function_pool.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.

Returns:

One CommonFunctionPool or None

find_extension(name_or_id, ignore_missing=True)

Find a single extension

Parameters:

• name_or_id – The name or ID of a extension.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.

Returns:

One Extension or None

find_firewall(name_or_id, ignore_missing=True)

Find a single firewall

Parameters:

• name_or_id – The name or ID of a firewall.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.

Returns:

One Firewall or None

find_firewall_plan(name_or_id, ignore_missing=True)

Find a firewall plan

Parameters:

• id_or_name – The name or ID of a firewall plan.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.

Returns:

One FirewallPlan or None

find_gateway_interface(name_or_id, ignore_missing=True)

Find a single gateway_interface

Parameters:

• name_or_id – The name or ID of a common_function_gatway.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.

Returns:

One GatewayInterface or None

find_interdc_gateway(name_or_id, ignore_missing=True)

Find a single interdc_gateway

Parameters:

• name_or_id – The name or ID of an interdc_gateway.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.

Returns:

One InternetDC or None

find_internet_gateway(name_or_id, ignore_missing=True)

Find a single internet_gateway

Parameters:

• name_or_id – The name or ID of an internet_gateway.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.

Returns:

One InternetGateway or None

find_internet_service(name_or_id, ignore_missing=True)

Find a single internet_service

Parameters:

• name_or_id – The name or ID of an internet_service.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.

Returns:

One InternetService or None

find_load_balancer(name_or_id, ignore_missing=True)

Find a single load_balancer

Parameters:

• name_or_id – The name or ID of a load_balancer.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.

Returns:

One LoadBalancer or None

find_load_balancer_plan(name_or_id, ignore_missing=True)

Find a load_balancer plan

Parameters:

• id_or_name – The name or ID of a load balancer plan.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.

Returns:

One LoadBalancerPlan or None

find_network(name_or_id, ignore_missing=True)

Find a single network

Parameters:

• name_or_id – The name or ID of a network.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.

Returns:

One Network or None

find_port(name_or_id, ignore_missing=True)

Find a single port

Parameters:

• name_or_id – The name or ID of a port.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.

Returns:

One Port or None

find_qos_option(name_or_id, ignore_missing=True)

Find a single qos_option

Parameters:

• name_or_id – The name or ID of a qos_option.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.

Returns:

One QosOption or None

find_subnet(name_or_id, ignore_missing=True)

Find a single subnet

Parameters:

• name_or_id – The name or ID of a subnet.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.

Returns:

One Subnet or None

find_vpn_gateway(name_or_id, ignore_missing=True)

Find a single vpn_gateway

Parameters:

• name_or_id – The name or ID of a vpn_gateway.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.

Returns:

One VPNGateway or None

firewall_interfaces(**query)

List all visible firewall_interfaces.

Parameters:query – Query parameters to select results Returns:A generator of FirewallInterface instances. Return type:FirewallInterface

firewall_plans(**query)

List all visible firewall_plans.

Parameters:query – Query parameters to select results Returns:A generator of FirewallPlan instances. Return type:FirewallPlan

firewalls(**query)

List all visible firewalls.

Parameters:query – Query parameters to select results Returns:A generator of firewall instances. Return type:Firewall

gateway_interfaces(**query)

Return a list of Gateway Interfaces

Returns:A list of Gateway Interface objects

get_aws_gateway(aws_gateway)

Get a single aws_gateway

Parameters:aws_gateway – The value can be the ID of a aws_gateway or a AWSGateway instance. Returns:One AWSGateway Raises:ResourceNotFound when no resource can be found.

get_aws_interface(aws_interface)

Get a single aws_interface

Parameters:aws_interface – The value can be the ID of a aws_interface or a AWSInterface instance. Returns:One AWSInterface Raises:ResourceNotFound when no resource can be found.

get_aws_service(aws_service)

Get a single aws_service

Parameters:aws_service – The value can be the ID of a aws_service or a AWSService instance. Returns:One AWSService Raises:ResourceNotFound when no resource can be found.

get_colocation_logical_link(colocation_logical_link)

Get a single colocation_logical_link

Parameters:colocation_logical_link – The value can be the ID of a colocation_logical_link or a ColocationLogicalLink instance. Returns:One ColocationLogicalLink Raises:ResourceNotFound when no resource can be found.

get_colocation_physical_link(colocation_physical_link)

Get a single colocation_physical_link

Parameters:colocation_physical_link – The value can be the ID of a colocation_physical_link or a ColocationPhysicalLink instance. Returns:One ColocationPhysicalLink Raises:ResourceNotFound when no resource can be found.

get_colocation_space(colocation_space)

Get a single colocation_space

Parameters:colocation_space – The value can be the ID of a colocation_space or a ColocationSpace instance. Returns:One ColocationSpace Raises:ResourceNotFound when no resource can be found.

get_common_function(common_function)

Get a single common_function

Parameters:common_function – The value can be the ID of a common_function or a CommonFunction instance. Returns:One CommonFunction Raises:ResourceNotFound when no resource can be found.

get_common_function_gateway(common_function_gateway)

Get a single common_function_gateway

Parameters:common_function_gateway – The value can be the ID of a common_function_gateway or a CommonFunctionGateway instance. Returns:One CommonFunctionGateway Raises:ResourceNotFound when no resource can be found.

get_common_function_pool(common_function_pool)

Get a single common_function_pool

Parameters:common_function_pool – The value can be the ID of a common_function_pool or a CommonFunctionPool instance. Returns:One CommonFunctionPool Raises:ResourceNotFound when no resource can be found.

get_extension(extension)

Get a single extension

Parameters:extension – The value can be the ID of a extension or a Extension instance. Returns:One Extension Raises:ResourceNotFound when no resource can be found.

get_firewall(firewall_id)

Get details for firewall.

Parameters:firewall_id – ID of specified firewall. Returns:Firewall

get_firewall_interface(firewall_interface_id)

Get details for firewall_interface.

Parameters:firewall_interface_id – ID of specified firewall_interface. Returns:FirewallInterface

get_firewall_plan(firewall_plan_id)

Get details for firewall_plan.

Parameters:firewall_plan_id – Specified firewall plan id. Returns:FirewallPlan

get_gateway_interface(gw_interface)

Get a single Gateway Interface

Parameters:gw_interface – The value can be the ID of a Gateway Interface or a GatewayInterface instance. Returns:One GatewayInterface Raises:ResourceNotFound when no resource can be found.

get_interdc_gateway(interdc_gateway)

Get a single InterDC Gateway

Parameters:interdc_gateway – The value can be the ID of an InterDC Gateway or a InterDCGateway instance. Returns:One InterDCGateway Raises:ResourceNotFound when no resource can be found.

get_interdc_interface(interdc_interface)

Get a single InterDC Gateway

Parameters:interdc_interface – The value can be the ID of an InterDC Interface or a InterDCInterface instance. Returns:One InterDCInterface Raises:ResourceNotFound when no resource can be found.

get_interdc_service(interdc_service)

Get a single InterDC Service

Parameters:interdc_service – The value can be the ID of an InterDC Service or a InterDCService instance. Returns:One InterDCService Raises:ResourceNotFound when no resource can be found.

get_internet_gateway(internet_gateway)

Get a single Internet Gateway

Parameters:internet_gateway – The value can be the ID of an Internet Gateway or a InternetGateway instance. Returns:One InternetGateway Raises:ResourceNotFound when no resource can be found.

get_internet_service(internet_service)

Get a single Internet Service

Parameters:internet_service – The value can be the ID of an Internet Service or a InternetService instance. Returns:One InternetService Raises:ResourceNotFound when no resource can be found.

get_load_balancer(load_balancer_id)

Get details for load_balancer.

Parameters:load_balancer_id – ID of load balancer. Returns:LoadBalancer

get_load_balancer_interface(load_balancer_interface_id)

Get details for load_balancer_interface.

Parameters:load_balancer_interface_id – ID for specified load_balancer_interface. Returns:LoadBalancerInterface

get_load_balancer_plan(load_balancer_interface_id)

Get details for load_balancer_plan.

Parameters:load_balancer_interface_id – ID of specified load balancer plan. Returns:LoadBalancerPlan

get_load_balancer_syslog_server(load_balancer_syslog_server)

Get a single Load Balancer Syslog Server

Parameters:load_balancer_syslog_server – The value can be the ID of an Load Balancer Syslog Server or a LoadBalancerSyslogServer instance. Returns:One LoadBalancerSyslogServer Raises:ResourceNotFound when no resource can be found.

get_network(network)

Get a single network

Parameters:network – The value can be the ID of a network or a Network instance. Returns:One Network Raises:ResourceNotFound when no resource can be found.

get_physical_port(physical_port)

Get a single physical_port

Parameters:physical_port – The value can be the ID of a physical_port or a PhysicalPort instance. Returns:One Port Raises:ResourceNotFound when no resource can be found.

get_port(port)

Get a single port

Parameters:port – The value can be the ID of a port or a Port instance. Returns:One Port Raises:ResourceNotFound when no resource can be found.

get_public_ip(publicip)

Get a single Public IP

Parameters:publicip – The value can be the ID of a Public IP or a PublicIP instance. Returns:One PublicIP Raises:ResourceNotFound when no resource can be found.

get_qos_option(qos_option)

Get a single QoS Option

Parameters:qos_option – The value can be the ID of a QoS Option or a QoSOption instance. Returns:One QoSOption Raises:ResourceNotFound when no resource can be found.

get_quota(quota)

Get a quota

Parameters:quota – The value can be the ID of a quota or a Quota instance. The ID of a quota is the same as the tenant ID for the quota. Returns:One Quota Raises:ResourceNotFound when no resource can be found.

get_reserved_address(reserved_address)

Get a reserved address

Parameters:reserved_address – The value can be the ID of a reserved address or a ReservedAddress instance. Returns:One ReservedAddress Raises:ResourceNotFound when no resource can be found.

get_static_route(static_route)

Get a single Static Route

Parameters:static_route – The value can be the ID of a Static Route or a StaticRoute instance. Returns:One StaticRoute Raises:ResourceNotFound when no resource can be found.

get_subnet(subnet)

Get a single subnet

Parameters:subnet – The value can be the ID of a subnet or a Subnet instance. Returns:One Subnet Raises:ResourceNotFound when no resource can be found.

get_tenant_connection(tenant_connection)

Get a single tenant_connection

Parameters:tenant_connection – The value can be the ID of a TenantConnection or a TenantConnection instance. Returns:One TenantConnection Raises:ResourceNotFound when no resource can be found.

get_vpn_gateway(vpn_gateway)

Get a single VPN Gateway

Parameters:vpn_gateway – The value can be the ID of a VPN Gateway or a VPNGateway instance. Returns:One VPNGateway Raises:ResourceNotFound when no resource can be found.

get_vpn_interface(vpn_interface)

Get a single VPN Gateway

Parameters:vpn_interface – The value can be the ID of a VPN Interface or a VPNInterface instance. Returns:One VPNInterface Raises:ResourceNotFound when no resource can be found.

get_vpn_service(vpn_service)

Get a single VPN Service

Parameters:vpn_service – The value can be the ID of a VPN Service or a VPNService instance. Returns:One VPNService Raises:ResourceNotFound when no resource can be found.

interdc_gateways(**query)

Return a list of InterDC Gateways

Parameters:query – Query parameters to select results Returns:A list of InterDC Gateway objects

interdc_interfaces(**query)

Return a list of InterDC Interface

Returns:A list of InterDC Interface objects

interdc_services(**query)

Return a list of InterDC Service

Returns:A list of InterDC Service objects

internet_gateways(**query)

Return a list of Internet Gateways

Parameters:query – Query parameters to select results Returns:A list of Internet Gateway objects

internet_services(**query)

Return a list of Internet Services

Returns:A list of Internet Service objects

load_balancer_interfaces(**query)

List all visible load_balancer_interfaces.

Parameters:query – Query parameters to select results Returns:A generator of LoadBalancerInterface instances. Return type:LoadBalancerInterface

load_balancer_plans(**query)

List all visible load_balancer_plans.

Parameters:query – Query parameters to select results. Returns:A generator of LoadBalancerPlan instances. Return type:LoadBalancerPlan

load_balancer_syslog_servers(**query)

Return a list of Load Balancer Syslog Server

Returns:A list of Load Balancer Syslog Server objects

load_balancers(**query)

List all visible load_balancers.

Parameters:query – Query parameters to select results. Returns:A generator of LoadBalancer instances. Return type:LoadBalancer

networks(**params)

Return a list of networks :param params: The parameters as query string

to get networks by specified condition.

Returns:A list of network objects Return type:list of Network

physical_ports(**query)

List all visible physical_ports.

Parameters:query – Query parameters to select results Returns:A generator of physical_ports. Return type:PhysicalPort

ports(**query)

Return a list of ports

Parameters:query – Query parameters to select results Returns:A list of port objects Return type:Port

public_ips(**query)

Return a list of Public IPs

Parameters:query – Query parameters to select results Returns:A list of Public IP objects

qos_options(**query)

Return a list of QoS Options

Returns:A list of QoS Option objects

reboot_firewall(firewall_id, type)

Reboot Firewall.

Parameters:

• firewall_id – ID of specified firewall.
• type – Type to reboot firewall.

Returns:

None

reboot_load_balancer(load_balancer_id, type)

Reboot Firewall.

Parameters:

• load_balancer_id – ID of specified load_balancer.
• type – Type to reboot firewall.

Returns:

None

reserved_addresses(**query)

Return a list of reserved addresses

Returns:A list of reserved addresses objects Return type:list of ReservedAddress

reset_password_firewall(firewall_id, username)

Reset password of firewall instance.

Parameters:

• firewall_id – ID of specified firewall.
• username – Username to change the password.

Returns:

FirewallAction

reset_password_load_balancer(load_balancer_id, username)

Reset password of load balancer instance.

Parameters:

• load_balancer_id – ID of specified load balancer.
• username – Username to change the password.

Returns:

LoadBalancerAction

static_routes(**query)

Return a list of Static Routes

Returns:A list of Static Route objects

subnets(**query)

Return a list of subnets

Parameters:query – Query parameters to select results Returns:A list of subnet objects Return type:Subnet

tenant_connections(**query)

Return a list of tenant_connections

Parameters:query – Query parameters to select results. Returns:A list of tenant_connection objects Return type:list of TenantConnection

update_colocation_logical_link(colocation_logical_link, **params)

Update a colocation_logical_link

Parameters:

• colocation_logical_link – The value can be the ID of a colocation_logical_link or a ColocationLogicalLink instance.
• **params (kwargs) –

  Parameters for Colocation Logical Link update.

  • string description: Colocation Logical Link description.
  • string name: Colocation Logical Link name.
  • dict tags: Colocation Logical Link tags.

Returns:

The result of update colocation_logical_link.

Return type:

ColocationLogicalLink

update_common_function_gateway(common_function_gateway, **params)

Update a common_function_gateway

Parameters:

• common_function_gateway – The value can be the ID of a common_function_gateway or a CommonFunctionGateway instance.
• **params (kwargs) –

  Parameter for Common Function Gateway update. * description: Description of the Common Function Pool Gateway

  resource.

  • name: Name of the Common Function Pool Gateway resource.

Returns:

The result of update common_function_gateway.

Return type:

CommonFunctionGateway

update_firewall(firewall_id, **params)

Update a specified firewall.

Parameters:

• firewall_id – ID of specified firewall.
• **params –

  Parameters for firewall update.

  • default_gateway: IP address of default gateway.
  • description: Description of the Firewall.
  • firewall_plan_id: Firewall Plan ID.
  • name: Name of the Firewall.

Returns:

Firewall

update_firewall_interface(firewall_id, firewall_interface_id, **params)

Update firewall_interface.

Parameters:

• firewall_id – ID of parent firewall ID of firewall_interface.
• firewall_interface_id – ID of specified firewall_interface.
• params – Parameters for update.

Returns:

FirewallInterface

update_gateway_interface(gw_interface, **body)

Update a Gateway Interface

Parameters:

• gw_interface – The value can be the ID of a Gateway Interface or a GatewayInterface instance.
• name – name of gateway interface to update
• description – description of gateway interface to update

Returns:

The result of update Gateway Interface

Return type:

GatewayInterface

update_interdc_interface(interdc_interface, **body)

Update an InterDC Interface from parameters

Parameters:

• interdc_interface – ID of InterDC interface to update
• name – name of InterDC interface to update
• description – description of InterDC interface to update

Returns:

The results of InterDCInterface update

Return type:

One InterDCInterface

update_internet_gateway(inet_gw, **body)

Update a new Internet Gateway from parameters.

Parameters:

• inet_gw – The value can be the ID of an Internet Gateway or a InternetGateway instance.
• name (string) – name of gateway to update
• description (string) – description of gateway to update
• qos_option_id (string) – ID of QoS Option of gateway to update

Returns:

result of update Internet Gateway

:rtype InternetGateway

update_load_balancer(load_balancer_id, **params)

Update a specified firewall.

Parameters:

• load_balancer_id – ID of specified load balancer.
• **params –

  Parameters for firewall update.

  • load_balancer_interface_id: ID for specified load_balancer_interface.
  • description: Description the Load Balancer Interface.
  • ip_address: IP Address.
  • name: Name the Load Balancer Interface.
  • network_id: Network ID.
  • virtual_ip_address: Virtual IP Address.

  • virtual_ip_properties: Properties used for virtual IP address.

    Available parameters include:

    • protocol: Redundancy Protocol. Enumeration is [‘vrrp’].

      This parameter is optional.

    • vrid: VRRP group identifier. This parameter is optional.

Returns:

LoadBalancer

update_load_balancer_interface(load_balancer_id, load_balancer_interface_id, **params)

Update load_balancer_interface.

Parameters:

• load_balancer_id – ID for parent load balancer of specified load_balancer_interface.
• load_balancer_interface_id – ID for specified load_balancer_interface.
• params – Parameters for update.

Returns:

update_load_balancer_syslog_server(load_balancer_syslog_server, acl_logging=None, appflow_logging=None, date_format=None, description=None, log_facility=None, log_level=None, priority=None, tcp_logging=None, time_zone=None, user_configurable_log_messages=None)

Update a Load Balancer Syslog Server from properties

Parameters:

• load_balancer_syslog_server –

  The value can be either the ID of an Load Balancer Syslog Server or a

  LoadBalancerSyslogServer instance.

• acl_logging (enumerate) – [“ENABLED”, “DISABLED”]
• appflow_logging (enumerate) – [“ENABLED”, “DISABLED”]
• date_format (enumerate) – [“DDMMYYYY”, “MMDDYYYY”, “YYYYMMDD”]
• description (string) – Description for syslog
• log_facility (enumerate) – [“LOCAL0”, “LOCAL1”, “LOCAL2”, “LOCAL3”, “LOCAL4”, “LOCAL5”, “LOCAL6”, “LOCAL7”]
• log_level (string) – “ALL”, “NONE”, or one or more (join with “|”) of [“ALERT”, “CRITICAL”, “NOTICE”, “DEBUG”, “ERROR”, “WARNING”, “EMERGENCY”, “INFORMATIONAL”]
• priority (int) – 0-255
• tcp_logging (enumerate) – [“NONE”, “ALL”]
• time_zone (enumerate) – [“GMT_TIME”, “LOCAL_TIME”]
• user_configurable_log_messages (enumerate) – [“YES”, “NO”]

Returns:

LoadBalancerSyslogServer

update_network(network, **params)

Update a network

Parameters:

network – Either the id of a network or a Network instance.

Attrs **params:

Parameters for network update.

• bool admin_state_up: admin state of network to update
• string name: name of network to update
• string description: description of network to update
• dict tags: tags of network to update

Returns:

The updated network

Return type:

Network

update_port(port, **params)

Update a port

Parameters:

• port – Either the id of a port or a Port instance.
• **params (kwargs) –

  Parameters for Port update.

  • string admin_state_up: The admin state of port to update

  • array allowed_address_pairs: allowed address pairs

    e.g. [{“mac_address”: <mac>, “ip_address”: <ipv4/cidr>}]

  • string mac_address: The mac address of port to update
  • string description: The description of port to update
  • string device_id: The device id of port to update
  • string device_owner: The device owner of port to update

  • array fixed_ips: The fixed ips of port to update

    e.g. [{“ip_address”:<ipv4> , “subnet_id”: <uuid> }, ]

  • string name: The name of port to update
  • int segmentation_id: The segmentation id of port to update
  • string segmentation_type: The segmentation type of port to update
  • dict tags: tags of port

Returns:

The updated port

Return type:

Port

update_public_ip(public_ip, **body)

Update a Public IP

Parameters:

• public_ip – The value can be the ID of a Public IP or a PublicIP instance.
• description – description of public ip to update

Returns:

The result of update Public IP

Return type:

PublicIP

update_static_route(static_route, **body)

Update a Static Route

Parameters:

• static_route – The value can be the ID of a Static Route or a StaticRoute instance.
• name – name of static route to update
• description – description of static route to update

Returns:

The result of update Static Route

Return type:

StaticRoute

update_subnet(subnet, **params)

Update a subnet

Parameters:

• subnet – Either the id of a subnet or a Subnet instance.
• **params –

  Parameters for subnet update.

  • string description: description of subnet to create
  • array dns_nameservers: dns nameservers of subnet to create
  • bool enable_dhcp: bool value indicating if dhcp is enabled
  • IPv4 gateway_ip: Gateway IP of subnet to create
  • array host_routes: host routes of subnet to create
  • string name: name of subnet to create
  • array ntp_servers: ntp servers of subnet to create
  • dict tags: tags of subnet to create

Returns:

The updated subnet

Return type:

Subnet

update_tenant_connection(tenant_connection, name=None, description=None)

Update a Tenant Connection from attributes

Parameters:

• tenant_connection – The value can be the ID of a tenant_connection or a TenantConeection instance.
• name (string) – Name of TenantConnection to update
• description (string) – Description of TenantConnection to update

Returns:

results of TenantConnection update

Return type:

TenantConnection

vpn_gateways(**query)

Return a list of VPN Gateways

Parameters:query – Query parameters to select results Returns:A list of VPN Gateway objects

vpn_interfaces(**query)

Return a list of VPN Interface

Returns:A list of VPN Interface objects

vpn_services(**query)

Return a list of VPN Service

Returns:A list of VPN Service objects

aws

class ecl.network.v2.aws.AWSGateway(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

allow_get = True

allow_list = True

aws_service_id = None

base_path = '/v2.0/aws_gateways'

description = None

id = None

name = None

qos_option_id = None

resource_key = 'aws_gateway'

resources_key = 'aws_gateways'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

status = None

tenant_id = None

class ecl.network.v2.aws.AWSInterface(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

allow_get = True

allow_list = True

aws_gw_id = None

base_path = '/v2.0/aws_interfaces'

description = None

id = None

name = None

primary = None

resource_key = 'aws_interface'

resources_key = 'aws_interfaces'

secondary = None

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

status = None

tenant_id = None

class ecl.network.v2.aws.AWSService(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

allow_get = True

allow_list = True

base_path = '/v2.0/aws_services'

description = None

id = None

name = None

resource_key = 'aws_service'

resources_key = 'aws_services'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

zone = None

base

class ecl.network.v2.base.NetworkBaseResource(synchronized=False, **attrs)

Bases: ecl.resource2.Resource

name_or_id

set_id_as_name_if_empty(length=8)

tenant_id = None

The ID of the project this resource is associated with.

colocation_logical_link

class ecl.network.v2.colocation_logical_link.ColocationLogicalLink(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

allow_create = True

allow_delete = True

allow_get = True

allow_list = True

allow_update = True

base_path = '/v2.0/colocation_logical_links'

colocation_physical_link_id = None

Colocation Physical Link ID.

description = None

Colocation Logical Link description.

id = None

Colocation Logical Link unique id.

name = None

Colocation Logical Link name.

network_id = None

Network connected to this link.

resource_key = 'colocation_logical_link'

resources_key = 'colocation_logical_links'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

status = None

The Colocation Logical Link status.

tags = None

Colocation Logical Link tags.

tenant_id = None

The owner name of Colocation Logical Link.

type_a_port_id = None

Type A Port ID.

type_b_port_id = None

Type B Port ID.

vlan_id = None

Logical port vlan id.

colocation_physical_link

class ecl.network.v2.colocation_physical_link.ColocationPhysicalLink(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

allow_get = True

allow_list = True

bandwidth = None

The bandwidth of Colocation Physical Link.

base_path = '/v2.0/colocation_physical_links'

colocation_space_id = None

Colocation Space ID.

description = None

Colocation Physical Link description.

id = None

Colocation Physical Link unique id.

name = None

Colocation Physical Link name.

resource_key = 'colocation_physical_link'

resources_key = 'colocation_physical_links'

segmentation_ranges = None

Ranges of allowed VLAN tags.

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

status = None

The Colocation Physical Link status.

tags = None

Colocation Physical Link tags.

tenant_id = None

The owner name of Colocation Physical Link.

type_a_physical_port_id = None

Type A Physical Port ID.

type_a_rack_id = None

Type A Rack ID.

type_b_physical_port_id = None

Type B Physical Port ID.

type_b_rack_id = None

Type B Rack ID.

colocation_space

class ecl.network.v2.colocation_space.ColocationSpace(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

allow_get = True

allow_list = True

base_path = '/v2.0/colocation_spaces'

description = None

Colocation Space description.

id = None

Colocation Space unique id.

name = None

Colocation Space name.

resource_key = 'colocation_space'

resources_key = 'colocation_spaces'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

common_function

class ecl.network.v2.common_function.CommonFunction(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

allow_get = True

allow_list = True

base_path = '/v2.0/common_functions'

description = None

Description of the Common Function resource.

classmethod find(session, name_or_id, ignore_missing=True, **params)

Find a resource by its name or id.

Parameters:

• session (Session) – The session to use for making this request.
• name_or_id – This resource’s identifier, if needed by the request. The default is None.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.
• params (dict) – Any additional parameters to be passed into underlying methods, such as to existing() in order to pass on URI parameters.

Returns:

The Resource object matching the given name or id or None if nothing matches.

Raises:

ecl.exceptions.DuplicateResource if more than one resource is found for this request.

Raises:

ecl.exceptions.ResourceNotFound if nothing is found and ignore_missing is False.

id = None

Unique ID of the Common Function resource.

link_local_ip_address = None

Link-local IP address of Common Function (after NAT).

name = None

Name of the Common Function resource.

resource_key = 'common_function'

resources_key = 'common_functions'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

status = None

Hidden Common Function status.

common_function_gateway

class ecl.network.v2.common_function_gateway.CommonFunctionGateway(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

allow_create = True

allow_delete = True

allow_get = True

allow_list = True

allow_update = True

base_path = '/v2.0/common_function_gateways'

common_function_pool_id = None

Common Function Pool instantiated by this Gateway.

description = None

Description of the Common Function Pool Gateway resource.

classmethod find(session, name_or_id, ignore_missing=True, **params)

Find a resource by its name or id.

Parameters:

• session (Session) – The session to use for making this request.
• name_or_id – This resource’s identifier, if needed by the request. The default is None.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.
• params (dict) – Any additional parameters to be passed into underlying methods, such as to existing() in order to pass on URI parameters.

Returns:

The Resource object matching the given name or id or None if nothing matches.

Raises:

ecl.exceptions.DuplicateResource if more than one resource is found for this request.

Raises:

ecl.exceptions.ResourceNotFound if nothing is found and ignore_missing is False.

id = None

Unique ID of the Common Function Pool Gateway resource.

name = None

Name of the Common Function Pool Gateway resource.

network_id = None

Id of automatically created network connected to this Common Function Pool Gateway.

resource_key = 'common_function_gateway'

resources_key = 'common_function_gateways'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

status = None

The Common Function Gateway status.

subnet_id = None

Id of automatically created subnet connected to this Common Function Pool Gateway (using link-local addresation).

tenant_id = None

Tenant ID of the owner (UUID).

common_function_pool

class ecl.network.v2.common_function_pool.CommonFunctionPool(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

allow_get = True

allow_list = True

base_path = '/v2.0/common_function_pools'

description = None

Description of the Common Function Pool resource.

classmethod find(session, name_or_id, ignore_missing=True, **params)

Find a resource by its name or id.

Parameters:

• session (Session) – The session to use for making this request.
• name_or_id – This resource’s identifier, if needed by the request. The default is None.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.
• params (dict) – Any additional parameters to be passed into underlying methods, such as to existing() in order to pass on URI parameters.

Returns:

The Resource object matching the given name or id or None if nothing matches.

Raises:

ecl.exceptions.DuplicateResource if more than one resource is found for this request.

Raises:

ecl.exceptions.ResourceNotFound if nothing is found and ignore_missing is False.

id = None

Unique ID of the Common Function Pool resource.

name = None

Name of the Common Function Pool resource.

resource_key = 'common_function_pool'

resources_key = 'common_function_pools'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

extension

class ecl.network.v2.extension.Extension(synchronized=False, **attrs)

Bases: ecl.resource2.Resource

alias = None

An alias the extension is known under.

allow_get = True

allow_list = True

base_path = '/v2.0/extensions'

description = None

Text describing what the extension does.

classmethod find(session, name_or_id, ignore_missing=True, **params)

Find a resource by its name or id.

Parameters:

• session (Session) – The session to use for making this request.
• name_or_id – This resource’s identifier, if needed by the request. The default is None.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.
• params (dict) – Any additional parameters to be passed into underlying methods, such as to existing() in order to pass on URI parameters.

Returns:

The Resource object matching the given name or id or None if nothing matches.

Raises:

ecl.exceptions.DuplicateResource if more than one resource is found for this request.

Raises:

ecl.exceptions.ResourceNotFound if nothing is found and ignore_missing is False.

id = None

The id of this extension.

links = None

Description links

name = None

The name of this extension.

namespace = None

A URL pointing to the namespace for this extension.

resource_key = 'extension'

resources_key = 'extensions'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

updated_at = None

Timestamp when the extension was last updated.

firewall

class ecl.network.v2.firewall.Firewall(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

admin_password = None

User password with admin access to VM instance.

admin_username = None

Username with admin access to VM instance.

allow_create = True

allow_delete = True

allow_get = True

allow_list = True

allow_update = True

availability_zone = None

Availability Zone.

base_path = '/v2.0/firewalls'

default_gateway = None

IP address of default gateway.

description = None

Description of the Firewall.

classmethod find(session, name_or_id, ignore_missing=True, **params)

Find a resource by its name or id.

Parameters:

• session (Session) – The session to use for making this request.
• name_or_id – This resource’s identifier, if needed by the request. The default is None.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.
• params (dict) – Any additional parameters to be passed into underlying methods, such as to existing() in order to pass on URI parameters.

Returns:

The Resource object matching the given name or id or None if nothing matches.

Raises:

ecl.exceptions.DuplicateResource if more than one resource is found for this request.

Raises:

ecl.exceptions.ResourceNotFound if nothing is found and ignore_missing is False.

firewall_plan_id = None

Firewall Plan.

id = None

Unique ID of the Firewall.

interfaces = None

Attached interfaces: interfaces.id: Unique ID of the Firewall Interface. interfaces.ip_address: IP Address. interfaces.name: Name the Firewall Interface. interfaces.network_id: Network. interfaces.slot_number: Slot Number. interfaces.virtual_ip_address: Virtual IP Address. interfaces.virtual_ip_properties: Properties used for virtual IP address. interfaces.virtual_ip_properties.protocol: Redundancy Protocol. interfaces.virtual_ip_properties.vrid: VRRP group identifier.

name = None

Name of the Firewall.

resource_key = 'firewall'

resources_key = 'firewalls'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

status = None

The Firewall status.

tenant_id = None

Tenant ID of the owner (UUID).

update(session, firewall_id, **attrs)

Update a firewall.

user_password = None

User password with normal access to VM instance.

user_username = None

Username with normal user access to VM instance.

firewall_action

class ecl.network.v2.firewall_action.FirewallAction(synchronized=False, **attrs)

Bases: ecl.resource2.Resource

allow_create = True

allow_get = True

base_path = '/v2.0/firewalls/%(firewall_id)s/%(action)s'

new_password = None

New password reset

reboot(session, firewall_id, type)

Reboot firewall.

reset_password(session, firewall_id, username)

Reset password of firewall instance.

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

username = None

Username of the firewall

firewall_interface

class ecl.network.v2.firewall_interface.FirewallInterface(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

allow_get = True

allow_list = True

allow_update = True

base_path = '/v2.0/firewall_interfaces'

description = None

Description the Firewall Interface.

firewall_id = None

The ID of firewall this firewall_interface belongs to.

id = None

Unique ID of the Firewall Interface.

ip_address = None

IP Address.

name = None

Name the Firewall Interface.

network_id = None

Network ID.

resource_key = 'firewall_interface'

resources_key = 'firewall_interfaces'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

slot_number = None

Slot Number.

status = None

Firewall interface status.

tenant_id = None

Tenant ID of the owner (UUID).

update(session, firewall_id, firewall_interface_id, **attrs)

Update a firewall interface.

virtual_ip_address = None

Virtual IP Address.

virtual_ip_properties = None

Properties used for virtual IP address.

vrid

firewall_plan

class ecl.network.v2.firewall_plan.FirewallPlan(synchronized=False, **attrs)

Bases: ecl.resource2.Resource

allow_get = True

allow_list = True

base_path = '/v2.0/firewall_plans'

description = None

Description of the Firewall Plan

enabled = None

classmethod find(session, name_or_id, ignore_missing=True, **params)

Find a resource by its name or id.

Parameters:

• session (Session) – The session to use for making this request.
• name_or_id – This resource’s identifier, if needed by the request. The default is None.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.
• params (dict) – Any additional parameters to be passed into underlying methods, such as to existing() in order to pass on URI parameters.

Returns:

The Resource object matching the given name or id or None if nothing matches.

Raises:

ecl.exceptions.DuplicateResource if more than one resource is found for this request.

Raises:

ecl.exceptions.ResourceNotFound if nothing is found and ignore_missing is False.

id = None

Unique ID of the Firewall Plan

name = None

Name of the Firewall Plan

resource_key = 'firewall_plan'

resources_key = 'firewall_plans'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

vendor = None

Firewall Type

version = None

Firewall Type

gw_interface

class ecl.network.v2.gw_interface.GatewayInterface(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

allow_create = True

allow_delete = True

allow_get = True

allow_list = True

allow_update = True

aws_gw_id = None

base_path = '/v2.0/gw_interfaces'

description = None

classmethod find(session, name_or_id, ignore_missing=True, **params)

Find a resource by its name or id.

Parameters:

• session (Session) – The session to use for making this request.
• name_or_id – This resource’s identifier, if needed by the request. The default is None.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.
• params (dict) – Any additional parameters to be passed into underlying methods, such as to existing() in order to pass on URI parameters.

Returns:

The Resource object matching the given name or id or None if nothing matches.

Raises:

ecl.exceptions.DuplicateResource if more than one resource is found for this request.

Raises:

ecl.exceptions.ResourceNotFound if nothing is found and ignore_missing is False.

gw_vipv4 = None

gw_vipv6 = None

id = None

interdc_gw_id = None

internet_gw_id = None

name = None

netmask = None

network_id = None

primary_ipv4 = None

primary_ipv6 = None

resource_key = 'gw_interface'

resources_key = 'gw_interfaces'

secondary_ipv4 = None

secondary_ipv6 = None

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

service_type = None

status = None

tenant_id = None

vpn_gw_id = None

vrid = None

wait_for_create(session, status='ACTIVE', failures=['ERROR'], interval=2, wait=120)

interdc

class ecl.network.v2.interdc.InterDCGateway(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

allow_create = True

allow_delete = True

allow_get = True

allow_list = True

allow_update = True

base_path = '/v2.0/interdc_gateways'

description = None

classmethod find(session, name_or_id, ignore_missing=True, **params)

Find a resource by its name or id.

Parameters:

• session (Session) – The session to use for making this request.
• name_or_id – This resource’s identifier, if needed by the request. The default is None.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.
• params (dict) – Any additional parameters to be passed into underlying methods, such as to existing() in order to pass on URI parameters.

Returns:

The Resource object matching the given name or id or None if nothing matches.

Raises:

ecl.exceptions.DuplicateResource if more than one resource is found for this request.

Raises:

ecl.exceptions.ResourceNotFound if nothing is found and ignore_missing is False.

id = None

interdc_service_id = None

name = None

resource_key = 'interdc_gateway'

resources_key = 'interdc_gateways'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': None, 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

status = None

tenant_id = None

class ecl.network.v2.interdc.InterDCInterface(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

allow_create = True

allow_delete = True

allow_get = True

allow_list = True

allow_update = True

base_path = '/v2.0/interdc_interfaces'

description = None

classmethod find(session, name_or_id, ignore_missing=True, **params)

Find a resource by its name or id.

Parameters:

• session (Session) – The session to use for making this request.
• name_or_id – This resource’s identifier, if needed by the request. The default is None.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.
• params (dict) – Any additional parameters to be passed into underlying methods, such as to existing() in order to pass on URI parameters.

Returns:

The Resource object matching the given name or id or None if nothing matches.

Raises:

ecl.exceptions.DuplicateResource if more than one resource is found for this request.

Raises:

ecl.exceptions.ResourceNotFound if nothing is found and ignore_missing is False.

gw_vipv4 = None

gw_vipv6 = None

id = None

interdc_gw_id = None

name = None

netmask = None

primary_ipv4 = None

primary_ipv6 = None

resource_key = 'interdc_interface'

resources_key = 'interdc_interfaces'

secondary_ipv4 = None

secondary_ipv6 = None

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': None, 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

status = None

tenant_id = None

vrid = None

wait_for_interface(session, status='ACTIVE', failures=['ERROR'], interval=2, wait=120)

class ecl.network.v2.interdc.InterDCService(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

allow_get = True

allow_list = True

base_path = '/v2.0/interdc_services'

description = None

id = None

name = None

resource_key = 'interdc_service'

resources_key = 'interdc_services'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

zone = None

internet

class ecl.network.v2.internet.InternetGateway(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

allow_create = True

allow_delete = True

allow_get = True

allow_list = True

allow_update = True

base_path = '/v2.0/internet_gateways'

description = None

classmethod find(session, name_or_id, ignore_missing=True, **params)

Find a resource by its name or id.

Parameters:

• session (Session) – The session to use for making this request.
• name_or_id – This resource’s identifier, if needed by the request. The default is None.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.
• params (dict) – Any additional parameters to be passed into underlying methods, such as to existing() in order to pass on URI parameters.

Returns:

The Resource object matching the given name or id or None if nothing matches.

Raises:

ecl.exceptions.DuplicateResource if more than one resource is found for this request.

Raises:

ecl.exceptions.ResourceNotFound if nothing is found and ignore_missing is False.

id = None

internet_service_id = None

name = None

qos_option_id = None

resource_key = 'internet_gateway'

resources_key = 'internet_gateways'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': None, 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

status = None

tenant_id = None

wait_for_gateway(session, status='ACTIVE', failures=['ERROR'], interval=2, wait=120)

class ecl.network.v2.internet.InternetService(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

allow_get = True

allow_list = True

base_path = '/v2.0/internet_services'

description = None

classmethod find(session, name_or_id, ignore_missing=True, **params)

Find a resource by its name or id.

Parameters:

• session (Session) – The session to use for making this request.
• name_or_id – This resource’s identifier, if needed by the request. The default is None.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.
• params (dict) – Any additional parameters to be passed into underlying methods, such as to existing() in order to pass on URI parameters.

Returns:

The Resource object matching the given name or id or None if nothing matches.

Raises:

ecl.exceptions.DuplicateResource if more than one resource is found for this request.

Raises:

ecl.exceptions.ResourceNotFound if nothing is found and ignore_missing is False.

id = None

minimal_submask_length = None

name = None

resource_key = 'internet_service'

resources_key = 'internet_services'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

zone = None

load_balancer

class ecl.network.v2.load_balancer.LoadBalancer(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

admin_password = None

Admin’s password placeholder.

admin_username = None

Username with admin access to VM instance.

allow_create = True

allow_delete = True

allow_get = True

allow_list = True

allow_update = True

availability_zone = None

Availability Zone.

base_path = '/v2.0/load_balancers'

default_gateway = None

IP address of default gateway.

description = None

Description of the Load Balancer.

classmethod find(session, name_or_id, ignore_missing=True, **params)

Find a resource by its name or id.

Parameters:

• session (Session) – The session to use for making this request.
• name_or_id – This resource’s identifier, if needed by the request. The default is None.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.
• params (dict) – Any additional parameters to be passed into underlying methods, such as to existing() in order to pass on URI parameters.

Returns:

The Resource object matching the given name or id or None if nothing matches.

Raises:

ecl.exceptions.DuplicateResource if more than one resource is found for this request.

Raises:

ecl.exceptions.ResourceNotFound if nothing is found and ignore_missing is False.

id = None

Unique ID of the Load Balancer.

interfaces = None

Attached interfaces: interfaces.id: Unique ID of the Load Balancer Interface interfaces.ip_address: IP Address interfaces.name: Name the Load Balancer Interface interfaces.network_id: Network interfaces.slot_number: Slot Number interfaces.status: Load Balancer Interface status interfaces.type: Load Balancer Interface Type interfaces.virtual_ip_address: Virtual IP Address interfaces.virtual_ip_properties: Properties used for virtual IP address.

load_balancer_plan_id = None

Load Balancer Plan

name = None

Name of the Load Balancer

resource_key = 'load_balancer'

resources_key = 'load_balancers'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

status = None

The load_balancer status.

tenant_id = None

Tenant ID of the owner (UUID)

update(session, load_balancer_id, **attrs)

Update a load balancer.

user_password = None

User’s password placeholder

user_username = None

Username with user access to VM instance

load_balancer_action

class ecl.network.v2.load_balancer_action.LoadBalancerAction(synchronized=False, **attrs)

Bases: ecl.resource2.Resource

allow_create = True

allow_get = True

base_path = '/v2.0/load_balancers/%(load_balancer_id)s/%(action)s'

new_password = None

New password reset.

reboot(session, load_balancer_id, type)

Reboot load balancer.

reset_password(session, load_balancer_id, username)

Reset password of load balancer instance.

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

username = None

Username of the load balancer.

load_balancer_interface

class ecl.network.v2.load_balancer_interface.LoadBalancerInterface(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

allow_get = True

allow_list = True

allow_update = True

base_path = '/v2.0/load_balancer_interfaces'

description = None

Description of the Load Balancer Interface.

id = None

Unique ID of the Load Balancer Interface.

ip_address = None

IP Address

load_balancer_id = None

The ID of load_balancer this load_balancer_interface belongs to.

name = None

Name of the Load Balancer

network_id = None

Network

resource_key = 'load_balancer_interface'

resources_key = 'load_balancer_interfaces'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

slot_number = None

Slot Number

status = None

The load_balancer status.

tenant_id = None

Tenant ID of the owner (UUID)

update(session, load_balancer_id, load_balancer_interface_id, **attrs)

Update a load balancer interface.

virtual_ip_address = None

Virtual IP Address

virtual_ip_properties = None

Properties used for virtual IP address. virtual_ip_properties.protocol: Redundancy Protocol. virtual_ip_properties.vrid: VRRP group identifier.

load_balancer_plan

class ecl.network.v2.load_balancer_plan.LoadBalancerPlan(synchronized=False, **attrs)

Bases: ecl.resource2.Resource

allow_get = True

allow_list = True

base_path = '/v2.0/load_balancer_plans'

description = None

Description of the Load Balancer Plan.

enabled = None

classmethod find(session, name_or_id, ignore_missing=True, **params)

Find a resource by its name or id.

Parameters:

• session (Session) – The session to use for making this request.
• name_or_id – This resource’s identifier, if needed by the request. The default is None.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.
• params (dict) – Any additional parameters to be passed into underlying methods, such as to existing() in order to pass on URI parameters.

Returns:

The Resource object matching the given name or id or None if nothing matches.

Raises:

ecl.exceptions.DuplicateResource if more than one resource is found for this request.

Raises:

ecl.exceptions.ResourceNotFound if nothing is found and ignore_missing is False.

id = None

Unique ID of the Load Balancer Plan.

model = None

Model of load balancer. Model.edition of load balancer. Model.size of load balancer.

name = None

Name of load balancer.

resource_key = 'load_balancer_plan'

resources_key = 'load_balancer_plans'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

vendor = None

Vendor of load balancer.

version = None

Version of load balancer.

load_balancer_syslog_server

class ecl.network.v2.load_balancer_syslog_server.LoadBalancerSyslogServer(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

acl_logging = None

allow_create = True

allow_delete = True

allow_get = True

allow_list = True

allow_update = True

appflow_logging = None

base_path = '/v2.0/load_balancer_syslog_servers'

date_format = None

description = None

Description of the Load Balancer Syslog Server.

id = None

Unique ID of the Load Balancer Syslog Server.

ip_address = None

IP Address

load_balancer_id = None

The ID of load_balancer this load_balancer_interface belongs to.

log_facility = None

log_level = None

name = None

Name of the Load Balancer

port_number = None

Port Number

priority = None

Priority

resource_key = 'load_balancer_syslog_server'

resources_key = 'load_balancer_syslog_servers'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

status = None

The load_balancer Syslog Server status.

tcp_logging = None

tenant_id = None

Tenant ID of the owner (UUID)

time_zone = None

Timezone

transport_type = None

user_configurable_log_messages = None

network

class ecl.network.v2.network.Network(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

admin_state

admin_state_up = None

admin_state_up status of network

allow_create = True

allow_delete = True

allow_get = True

allow_list = True

allow_update = True

base_path = '/v2.0/networks'

description = None

The network description.

classmethod find(session, name_or_id, ignore_missing=True, **params)

Find a resource by its name or id.

Parameters:

• session (Session) – The session to use for making this request.
• name_or_id – This resource’s identifier, if needed by the request. The default is None.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.
• params (dict) – Any additional parameters to be passed into underlying methods, such as to existing() in order to pass on URI parameters.

Returns:

The Resource object matching the given name or id or None if nothing matches.

Raises:

ecl.exceptions.DuplicateResource if more than one resource is found for this request.

Raises:

ecl.exceptions.ResourceNotFound if nothing is found and ignore_missing is False.

id = None

The network id.

name = None

The network name.

plane = None

The plane of network

project_id = None

The ID of the project this network is associated with.

resource_key = 'network'

resources_key = 'networks'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

shared = None

The boolean shared status of network.

status = None

The network status.

subnets = None

The associated subnet IDs. Type: list of strs of the subnet IDs

tags = None

tags of the network.

physical_port

class ecl.network.v2.physical_port.PhysicalPort(synchronized=False, **attrs)

Bases: ecl.resource2.Resource

allow_get = True

allow_list = True

base_path = '/v2.0/physical_ports'

description = None

Physical port description.

id = None

Physical port unique id.

name = None

Physical port name.

plane = None

The type of traffic that port will be used.

resource_key = 'physical_port'

resources_key = 'physical_ports'

segmentation_ranges = None

Ranges of allowed VLAN tags.

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

service_id = None

The ID of service that owns the physical port.

service_owner = None

The type of physical port service owner.

status = None

The Physical Port status.

tags = None

Port tags.

tenant_id = None

The owner name of physical port.

port

class ecl.network.v2.port.Port(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

admin_state

admin_state displayed by ‘UP’ or ‘DOWN’

admin_state_up = None

admin state of port

allow_create = True

allow_delete = True

allow_get = True

allow_list = True

allow_update = True

allowed_address_pairs = None

allowed address pairs

base_path = '/v2.0/ports'

description = None

The port description.

device_id = None

Device ID of this port.

device_owner = None

Device owner of this port (e.g. network:dhcp).

classmethod find(session, name_or_id, ignore_missing=True, **params)

Find a resource by its name or id.

Parameters:

• session (Session) – The session to use for making this request.
• name_or_id – This resource’s identifier, if needed by the request. The default is None.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.
• params (dict) – Any additional parameters to be passed into underlying methods, such as to existing() in order to pass on URI parameters.

Returns:

The Resource object matching the given name or id or None if nothing matches.

Raises:

ecl.exceptions.DuplicateResource if more than one resource is found for this request.

Raises:

ecl.exceptions.ResourceNotFound if nothing is found and ignore_missing is False.

fixed_ips = None

fixed ips of the port.

id = None

ID of the port.

mac_address = None

The MAC address of the port.

managed_by_service = None

If the port is managed by service

name = None

The port name.

network_id = None

The ID of the attached network.

project_id = None

The ID of the project who owns the network. Only administrative users can specify a project ID other than their own.

resource_key = 'port'

resources_key = 'ports'

segmentation_id = None

The segmentation ID of ports.

segmentation_type = None

The segmentation type of ports.

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

status = None

The port status. Value is ACTIVE or DOWN.

tags = None

tags of the port.

publicip

class ecl.network.v2.publicip.PublicIP(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

allow_create = True

allow_delete = True

allow_get = True

allow_list = True

allow_update = True

base_path = '/v2.0/public_ips'

cidr = None

description = None

id = None

internet_gw_id = None

name = None

resource_key = 'public_ip'

resources_key = 'public_ips'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

status = None

submask_length = None

tenant_id = None

wait_for_publicip(session, status='ACTIVE', failures=['ERROR'], interval=2, wait=120)

qos_option

class ecl.network.v2.qos_option.QosOption(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

allow_get = True

allow_list = True

bandwidth = None

base_path = '/v2.0/qos_options'

description = None

classmethod find(session, name_or_id, ignore_missing=True, **params)

Find a resource by its name or id.

Parameters:

• session (Session) – The session to use for making this request.
• name_or_id – This resource’s identifier, if needed by the request. The default is None.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.
• params (dict) – Any additional parameters to be passed into underlying methods, such as to existing() in order to pass on URI parameters.

Returns:

The Resource object matching the given name or id or None if nothing matches.

Raises:

ecl.exceptions.DuplicateResource if more than one resource is found for this request.

Raises:

ecl.exceptions.ResourceNotFound if nothing is found and ignore_missing is False.

id = None

interdc_service_id = None

internet_service_id = None

name = None

qos_type = None

resource_key = 'qos_option'

resources_key = 'qos_options'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

service_type = None

status = None

vpn_service_id = None

quota

class ecl.network.v2.quota.Quota(synchronized=False, **attrs)

Bases: ecl.resource2.Resource

allow_delete = True

allow_get = True

allow_list = True

allow_update = True

base_path = '/v2.0/quotas'

colocation_logical_link = None

The maximum amount of colocation logical link you can have. Type: int

common_function_gateway = None

The maximum amount of common function gateway you can create. Type: int

firewall = None

The maximum amount of firewall you can create. Type: int

id = None

ID of quota

interdc_gateway = None

The maximum amount of interdc gateway you can create. Type: int

internet_gateway = None

The maximum amount of internet gateway you can create. Type: int

load_balancer = None

The maximum amount of load balancer you can create. Type: int

network = None

The maximum amount of networks you can create. Type: int

port = None

The maximum amount of ports you can create. Type: int

project_id = None

The ID of the project these quota values are for.

public_ip = None

The maximum amount of public ip you can create. Type: int

resource_key = 'quota'

resources_key = 'quotas'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

subnet = None

The maximum amount of subnets you can create. Type: int

vpn_gateway = None

The maximum amount of vpn gateway you can create. Type: int

class ecl.network.v2.quota.QuotaDefault(synchronized=False, **attrs)

Bases: ecl.network.v2.quota.Quota

allow_delete = False

allow_list = False

allow_retrieve = True

allow_update = False

base_path = '/quotas/%(project)s/default'

reserved_address

class ecl.network.v2.reserved_address.ReservedAddress(synchronized=False, **attrs)

Bases: ecl.resource2.Resource

allow_create = False

allow_delete = False

allow_get = True

allow_list = True

allow_update = False

base_path = '/v2.0/reserve_addresses'

id = None

id of the reserved address

resource_key = 'reserve_address'

resources_key = 'reserve_addresses'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

subnets = None

subnets cidr of the reserved address

tenant_id = None

tenant id that reserved address belong to

static_route

class ecl.network.v2.static_route.StaticRoute(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

allow_create = True

allow_delete = True

allow_get = True

allow_list = True

allow_update = True

aws_gw_id = None

base_path = '/v2.0/static_routes'

description = None

destination = None

id = None

interdc_gw_id = None

internet_gw_id = None

name = None

nexthop = None

resource_key = 'static_route'

resources_key = 'static_routes'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

service_type = None

status = None

tenant_id = None

vpn_gw_id = None

wait_for_create(session, status='ACTIVE', failures=['ERROR'], interval=2, wait=120)

subnet

class ecl.network.v2.subnet.Subnet(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

allocation_pools = None

The start and end addresses for the allocation pools.

allow_create = True

allow_delete = True

allow_get = True

allow_list = True

allow_update = True

base_path = '/v2.0/subnets'

cidr = None

The CIDR.

description = None

The subnet description.

dns_nameservers = None

A list of DNS nameservers.

enable_dhcp = None

Set to True if DHCP is enabled and False if DHCP is disabled. Type: bool

classmethod find(session, name_or_id, ignore_missing=True, **params)

Find a resource by its name or id.

Parameters:

• session (Session) – The session to use for making this request.
• name_or_id – This resource’s identifier, if needed by the request. The default is None.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.
• params (dict) – Any additional parameters to be passed into underlying methods, such as to existing() in order to pass on URI parameters.

Returns:

The Resource object matching the given name or id or None if nothing matches.

Raises:

ecl.exceptions.DuplicateResource if more than one resource is found for this request.

Raises:

ecl.exceptions.ResourceNotFound if nothing is found and ignore_missing is False.

gateway_ip = None

The gateway IP address.

host_routes = None

A list of host routes.

id = None

Subnet unique id.

ip_version = None

The IP version, which is 4 or 6.

ipv6_address_mode = None

The IPv6 address modes which are ‘dhcpv6-stateful’, ‘dhcpv6-stateless’, or ‘SLAAC’

ipv6_ra_mode = None

The IPv6 router advertisements modes

name = None

The subnet name.

network_id = None

The ID of the attached network.

ntp_servers = None

A list of ntp servers.

project_id = None

The ID of the project this subnet is associated with.

resource_key = 'subnet'

resources_key = 'subnets'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

status = None

The status of the subnet

tags = None

tags of the subnet

tenant_connection

class ecl.network.v2.tenant_connection.TenantConnection(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

allow_create = True

allow_delete = True

allow_get = True

allow_list = True

allow_update = True

approval_request_id = None

base_path = '/v2.0/tenant_connections'

connected_interface = None

connected_network = None

description = None

execute(session)

Preform tenant connection execute.

id = None

interface_type = None

name = None

progress = None

resource_key = 'tenant_connection'

resources_key = 'tenant_connections'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

tenant_id = None

vpn

class ecl.network.v2.vpn.VPNGateway(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

allow_create = True

allow_delete = True

allow_get = True

allow_list = True

allow_update = True

base_path = '/v2.0/vpn_gateways'

description = None

classmethod find(session, name_or_id, ignore_missing=True, **params)

Find a resource by its name or id.

Parameters:

• session (Session) – The session to use for making this request.
• name_or_id – This resource’s identifier, if needed by the request. The default is None.
• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.
• params (dict) – Any additional parameters to be passed into underlying methods, such as to existing() in order to pass on URI parameters.

Returns:

The Resource object matching the given name or id or None if nothing matches.

Raises:

ecl.exceptions.DuplicateResource if more than one resource is found for this request.

Raises:

ecl.exceptions.ResourceNotFound if nothing is found and ignore_missing is False.

id = None

name = None

qos_option_id = None

resource_key = 'vpn_gateway'

resources_key = 'vpn_gateways'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': None, 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

status = None

tenant_id = None

vpn_service_id = None

class ecl.network.v2.vpn.VPNInterface(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

allow_create = True

allow_delete = True

allow_get = True

allow_list = True

allow_update = True

base_path = '/v2.0/vpn_interfaces'

description = None

id = None

name = None

primary = None

resource_key = 'vpn_interface'

resources_key = 'vpn_interfaces'

secondary = None

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': None, 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

status = None

tenant_id = None

vpn_gw_id = None

wait_for_interface(session, status='ACTIVE', failures=['ERROR'], interval=2, wait=120)

class ecl.network.v2.vpn.VPNService(synchronized=False, **attrs)

Bases: ecl.network.v2.base.NetworkBaseResource

allow_get = True

allow_list = True

base_path = '/v2.0/vpn_services'

description = None

id = None

name = None

resource_key = 'vpn_service'

resources_key = 'vpn_services'

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': 'v2.0', 'service_type': 'network', 'requires_project_id': False, 'api_version': None}

zone = None