Data Types

目次

• Data Types

  • AWS Gateway

  • AWS Interface

  • AWS Service

  • Azure Gateway

  • Azure Interface

  • Azure Service

  • Colocation Logical Link

  • Colocation Physical Link

  • Colocation Space

  • Common Function

  • Common Function Gateway

  • Common Function Pool

  • FIC Gateway

  • FIC Interface

  • FIC Service

  • Firewall

  • Firewall Interface

  • Firewall Plan

  • GCP Gateway

  • GCP Interface

  • GCP Service

  • Gateway Interface

  • Inter DC Gateway

  • Inter DC Interface

  • Inter DC Service

  • Internet Gateway

  • Internet Service

  • Load Balancer

  • Load Balancer Interface

  • Load Balancer Plan

  • Load Balancer Syslog Server

  • Network

  • Physical Port

  • Port

  • Port (managed_by_service==True)

  • Public IPs

  • QoS Options

  • Quotas

  • Reserved addresses

  • Security Group

  • Security Group Rule

  • Static Route

  • Subnet

  • Tenant Connection

  • VPN Gateway

  • VPN Interface

  • VPN Service

AWS Gateway

AWS Gateway

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
aws_service_id	string	hyph-uuid-or-empty	-	AWS Service instantiated by this Gateway	R
description	string	-	-	Description of the AWS Gateway resource	R
id	string	-	-	Unique ID of the AWS Gateway resource	R
name	string	-	-	Name of the AWS Gateway resource	R
qos_option_id	string	hyph-uuid-or-empty	-	Quality of Service options selected for this Gateway	R
status	string	-	-	The AWS Gateway status.	R
tenant_id	string	non-hyph-uuid	-	Tenant ID of the owner (UUID)	R

example

{
  "aws_gateway": {
    "aws_service_id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9",
    "description": "aws_gateway_inet_test, 10M-BE, member role",
    "id": "07f97269-e616-4dff-a73f-ca80bc5682dc",
    "name": "test-member-user-aws-gateway",
    "qos_option_id": "e41f6a2f-e197-41c8-9f71-ef19cfd2a85a",
    "status": "ACTIVE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

AWS Interface

AWS Uplink Interface

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
aws_gw_id	string	hyph-uuid-or-empty	-	AWS Gateway to which this interface is connected	R
description	string	-	-	Description of the AWS Interface resource	R
id	string	-	-	Unique ID of the AWS Interface resource	R
name	string	-	-	Name of the AWS Interface resource	R
primary	object	-	-	Primary router uplink ip configuration	R
bgp_peer_ip	string	ipv4	-	Address of the eBGP peer	R
bgp_router_id	string	ipv4	-	Router id used in virtual-router config (defaults to ip_address)	R
ip_address	string	cidr	-	Address of the uplink interface	R
secondary	object	-	-	Secondary router uplink ip configuration	R
bgp_peer_ip	string	ipv4	-	Address of the eBGP peer	R
bgp_router_id	string	ipv4	-	Router id used in virtual-router config (defaults to ip_address)	R
ip_address	string	cidr	-	Address of the uplink interface	R
status	string	-	-	The AWS Interface status.	R
tenant_id	string	non-hyph-uuid	-	Tenant ID of the owner (UUID)	R

example

{
  "aws_interface": {
    "aws_gw_id": "b6d96194-f74a-4beb-97cd-727f02b0e070",
    "description": "aws-interface-1-tenantA",
    "id": "278dfbe4-f8cc-4ce4-aa17-561401c01661",
    "name": "aws-interface-1",
    "primary": {
      "bgp_peer_ip": "10.2.121.1",
      "bgp_router_id": "10.2.121.10",
      "ip_address": "10.2.121.10/25"
    },
    "secondary": {
      "bgp_peer_ip": "10.2.121.129",
      "bgp_router_id": "10.2.121.130",
      "ip_address": "10.2.121.130/25"
    },
    "status": "ACTIVE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

AWS Service

AWS Service

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
description	string	-	-	Description of the AWS Service resource	R
id	string	hyph-uuid	-	Unique ID of the AWS Service resource	R
name	string	-	-	Name of the AWS Service resource	R
zone	string	-	-	Name of zone	R

example

{
  "aws_service": {
    "description": "AWS connectivity provider",
    "id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9",
    "name": "AWS-Service-Provider-01",
    "zone": "Lab3"
  }
}

Azure Gateway

Azure Gateway

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
azure_service_id	string	hyph-uuid-or-empty	-	Azure Service instantiated by this Gateway	R
description	string	-	-	Description of the Azure Gateway resource	R
id	string	-	-	Unique ID of the Azure Gateway resource	R
name	string	-	-	Name of the Azure Gateway resource	R
qos_option_id	string	hyph-uuid-or-empty	-	Quality of Service options selected for this Gateway	R
status	string	-	-	The Azure Gateway status.	R
tenant_id	string	non-hyph-uuid	-	Tenant ID of the owner (UUID)	R

example

{
  "azure_gateway": {
    "azure_service_id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9",
    "description": "azure_gateway_inet_test, 10M-BE, member role",
    "id": "07f97269-e616-4dff-a73f-ca80bc5682dc",
    "name": "test-member-user-azure-gateway",
    "qos_option_id": "e41f6a2f-e197-41c8-9f71-ef19cfd2a85a",
    "status": "ACTIVE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Azure Interface

Azure Uplink Interface

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
azure_gw_id	string	hyph-uuid-or-empty	-	Azure Gateway to which this interface is connected	R
description	string	-	-	Description of the Azure Interface resource	R
id	string	-	-	Unique ID of the Azure Interface resource	R
name	string	-	-	Name of the Azure Interface resource	R
primary	object	-	-	Primary router uplink ip configuration	R
bgp_peer_ip	string	ipv4	-	Address of the eBGP peer	R
bgp_router_id	string	ipv4	-	Router id used in virtual-router config (defaults to ip_address)	R
ip_address	string	cidr	-	Address of the uplink interface	R
secondary	object	-	-	Secondary router uplink ip configuration	R
bgp_peer_ip	string	ipv4	-	Address of the eBGP peer	R
bgp_router_id	string	ipv4	-	Router id used in virtual-router config (defaults to ip_address)	R
ip_address	string	cidr	-	Address of the uplink interface	R
status	string	-	-	The Azure Interface status.	R
tenant_id	string	non-hyph-uuid	-	Tenant ID of the owner (UUID)	R

example

{
  "azure_interface": {
    "azure_gw_id": "b6d96194-f74a-4beb-97cd-727f02b0e070",
    "description": "azure-interface-1-tenantA",
    "id": "278dfbe4-f8cc-4ce4-aa17-561401c01661",
    "name": "azure-interface-1",
    "primary": {
      "bgp_peer_ip": "10.2.121.1",
      "bgp_router_id": "10.2.121.10",
      "ip_address": "10.2.121.10/25"
    },
    "secondary": {
      "bgp_peer_ip": "10.2.121.129",
      "bgp_router_id": "10.2.121.130",
      "ip_address": "10.2.121.130/25"
    },
    "status": "ACTIVE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Azure Service

Azure Service

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
description	string	-	-	Description of the Azure Service resource	R
id	string	hyph-uuid	-	Unique ID of the Azure Service resource	R
name	string	-	-	Name of the Azure Service resource	R
zone	string	-	-	Name of zone	R

example

{
  "azure_service": {
    "description": "Azure connectivity provider",
    "id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9",
    "name": "Azure-Service-Provider-01",
    "zone": "Lab3"
  }
}

Colocation Logical Link

Colocation Logical Link

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
colocation_physical_link_id	string	hyph-uuid	-	Colocation Physical Link ID	CR
description	string	-	-	Colocation Logical Link description	CRU
id	string	hyph-uuid	-	Colocation Logical Link unique id	R
name	string	-	-	Colocation Logical Link name	CRU
network_id	string	hyph-uuid	-	Colocation ID	CR
status	string	-	-	The Colocation Logical Link status	R
tags	object	-	-	Port tags	CRU
tenant_id	string	non-hyph-uuid	-	The owner name of Colocation Logical Link	CR
type_a_port_id	string	hyph-uuid	-	Type A Port ID	R
type_b_port_id	string	hyph-uuid	-	Type B Port ID	R
vlan_id	integer	-	-	Logical port vlan id	CR

example

{
  "colocation_logical_link": {
    "colocation_physical_link_id": "4b703f08-ed57-4455-8438-296ffcdff4c7",
    "description": "Lab1 TEST",
    "id": "9ba631dc-cb35-4294-b407-3837683060a2",
    "name": "Lab1 clocation logical link for 10G TEST",
    "network_id": "3f605a7f-9766-4e0a-91df-a3bc0b7a7c9a",
    "status": "ACTIVE",
    "tags": {
      "keyword1": "value1",
      "keyword2": "value2"
    },
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "type_a_port_id": "9b795865-e73c-4f09-aac8-cb81e41d9fac",
    "type_b_port_id": "9b795865-e73c-4f09-aac8-cb81e41d9fac",
    "vlan_id": 123
  }
}

Colocation Physical Link

Colocation Physical Link

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
bandwidth	string	-	['1g', '10g']	The bandwidth of Colocation Physical Link physical link	R
colocation_space_id	string	hyph-uuid	-	Colocation Space ID	R
description	string	-	-	Colocation Physical Link description	R
id	string	hyph-uuid	-	Colocation Physical Link unique id	R
name	string	-	-	Colocation Physical Link name	R
plane	string	-	['data']	Connection type (only data)	R
segmentation_ranges	array<object>	-	-	Ranges of allowed VLAN tags	R
end	integer	-	-	-	R
start	integer	-	-	-	R
status	string	-	-	The Colocation Physical Link status	R
tags	object	-	-	Port tags	R
tenant_id	string	non-hyph-uuid	-	The owner name of Colocation Physical Link	R
type_a_physical_port_id	string	hyph-uuid	-	Type A Physical Port ID	R
type_a_rack_id	string	-	-	Type A Rack ID	R
type_b_physical_port_id	string	hyph-uuid	-	Type B Physical Port ID	R
type_b_rack_id	string	-	-	Type B Rack ID	R

example

{
  "colocation_physical_link": {
    "bandwidth": "10g",
    "colocation_space_id": "b33afaf9-f371-4f34-909c-b8822e3b87e1",
    "description": "Lab1 TEST",
    "id": "4b703f08-ed57-4455-8438-296ffcdff4c7",
    "name": "Lab1 colocation physical link for 10G TEST",
    "plane": "data",
    "segmentation_ranges": [
      {
        "end": 2048,
        "start": 3
      },
      {
        "end": 4093,
        "start": 2050
      }
    ],
    "status": "ACTIVE",
    "tags": {
      "keyword1": "value1",
      "keyword2": "value2"
    },
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "type_a_physical_port_id": "42c9e882-14fc-404b-a0fe-a72b8d7fee0e",
    "type_a_rack_id": "string formant",
    "type_b_physical_port_id": "42c9e882-14fc-404b-a0fe-a72b8d7fee0e",
    "type_b_rack_id": "string formant"
  }
}

Colocation Space

Colocation Space

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
description	string	-	-	Colocation Space description	R
id	string	hyph-uuid	-	Colocation Space unique id	R
name	string	-	-	Colocation Space name	R
plane	string	-	['data']	Connection type (only data)	R

example

{
  "colocation_space": {
    "description": "Lab1 10G colo TEST",
    "id": "b33afaf9-f371-4f34-909c-b8822e3b87e1",
    "name": "Tokyo No.1 Data Center",
    "plane": "data"
  }
}

Common Function

Common Function

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
description	string	-	-	Description of the Common Function resource	R
id	string	hyph-uuid	-	Unique ID of the Common Function resource	R
link_local_ip_address	string	ipv4	-	Link-local IP address of Common Function (after NAT)	R
name	string	-	-	Name of the Common Function resource	R
status	string	-	-	Common Function status.	R

example

{
  "common_function": {
    "description": "",
    "id": "29c616f9-f92e-47f9-a97f-17cd3fb62467",
    "link_local_ip_address": "169.254.127.2",
    "name": "reserved-01",
    "status": "ACTIVE"
  }
}

Common Function Gateway

Common Function Gateway

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
common_function_pool_id	string	hyph-uuid	-	Common Function Pool instantiated by this Gateway	CR
description	string	-	-	Description of the Common Function Gateway resource	CRU
id	string	hyph-uuid	-	Unique ID of the Common Function Gateway resource	R
name	string	-	-	Name of the Common Function Gateway resource	CRU
network_id	string	hyph-uuid-or-empty	-	Id of automatically created network connected to this Common Function Gateway	R
status	string	-	-	The Common Function Gateway status.	R
subnet_id	string	hyph-uuid-or-empty	-	Id of automatically created subnet connected to this Common Function Gateway (using link-local addresation)	R
tenant_id	string	non-hyph-uuid	-	Tenant ID of the owner (UUID)	CR

example

{
  "common_function_gateway": {
    "common_function_pool_id": "c57066cc-9553-43a6-90de-c847231bc70b",
    "description": "test",
    "id": "00efeb33-b050-4d2c-912f-d3a21bd744df",
    "name": "test",
    "network_id": "4dbc584d-4e63-40c7-be72-134a5e996efd",
    "status": "ACTIVE",
    "subnet_id": "ec43e4fb-ebdd-49c9-8927-a3dd9d0d9d01",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Common Function Pool

Common Function Pool

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
description	string	-	-	Description of the Common Function Pool resource	R
id	string	hyph-uuid	-	Unique ID of the Common Function Pool resource	R
name	string	-	-	Name of the Common Function Pool resource	R

example

{
  "common_function_pool": {
    "description": "lab3_common_function_pools-01",
    "id": "c57066cc-9553-43a6-90de-c847231bc70b",
    "name": "lab3_common_function_pools-01"
  }
}

FIC Gateway

FIC Gateway

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
description	string	-	-	Description of the FIC Gateway resource	R
fic_service_id	string	hyph-uuid-or-empty	-	FIC Service instantiated by this Gateway	R
id	string	-	-	Unique ID of the FIC Gateway resource	R
name	string	-	-	Name of the FIC Gateway resource	R
qos_option_id	string	hyph-uuid-or-empty	-	Quality of Service options selected for this Gateway	R
status	string	-	-	The FIC Gateway status.	R
tenant_id	string	non-hyph-uuid	-	Tenant ID of the owner (UUID)	R

example

{
  "fic_gateway": {
    "description": "fic_gateway_inet_test, 10M-BE, member role",
    "fic_service_id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9",
    "id": "07f97269-e616-4dff-a73f-ca80bc5682dc",
    "name": "lab3-test-member-user-fic-gateway",
    "qos_option_id": "e41f6a2f-e197-41c8-9f71-ef19cfd2a85a",
    "status": "ACTIVE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

FIC Interface

FIC Uplink Interface

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
description	string	-	-	Description of the FIC Interface resource	R
fic_gw_id	string	hyph-uuid-or-empty	-	FIC Gateway to which this interface is connected	R
id	string	-	-	Unique ID of the FIC Interface resource	R
name	string	-	-	Name of the FIC Interface resource	R
primary	object	-	-	Primary router uplink ip configuration	R
bgp_peer_ip	string	ipv4	-	Address of the eBGP peer	R
bgp_router_id	string	ipv4	-	Router id used in virtual-router config (defaults to ip_address)	R
ip_address	string	cidr	-	Address of the uplink interface	R
secondary	object	-	-	Secondary router uplink ip configuration	R
bgp_peer_ip	string	ipv4	-	Address of the eBGP peer	R
bgp_router_id	string	ipv4	-	Router id used in virtual-router config (defaults to ip_address)	R
ip_address	string	cidr	-	Address of the uplink interface	R
status	string	-	-	The FIC Interface status.	R
tenant_id	string	non-hyph-uuid	-	Tenant ID of the owner (UUID)	R

example

{
  "fic_interface": {
    "description": "lab3-fic-interface_for_tenant-sdpgui01",
    "fic_gw_id": "b6d96194-f74a-4beb-97cd-727f02b0e070",
    "id": "278dfbe4-f8cc-4ce4-aa17-561401c01661",
    "name": "fic_interface_for_tenant-sdpgui01",
    "primary": {
      "bgp_peer_ip": "10.2.121.1",
      "bgp_router_id": "10.2.121.10",
      "ip_address": "10.2.121.10/25"
    },
    "secondary": {
      "bgp_peer_ip": "10.2.121.129",
      "bgp_router_id": "10.2.121.130",
      "ip_address": "10.2.121.130/25"
    },
    "status": "ACTIVE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

FIC Service

FIC Service

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
description	string	-	-	Description of the FIC Service resource	R
id	string	hyph-uuid	-	Unique ID of the FIC Service resource	R
name	string	-	-	Name of the FIC Service resource	R
zone	string	-	-	Name of zone	R

example

{
  "fic_service": {
    "description": "lab3 fic connectivity provider",
    "id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9",
    "name": "Lab3-FIC-Service-Provider-01",
    "zone": "Lab3"
  }
}

Firewall

Firewall

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
admin_username	string	-	-	Username with admin access to VM instance	R
availability_zone	string	-	-	Availability Zone, this can be referred to using Virtual Server (Nova)'s list availability zones	CR
default_gateway	string	ipv4	-	IP address of default gateway	CRUD
description	string	-	-	Description of the Firewall	CRU
firewall_plan_id	string	hyph-uuid	-	Firewall Plan	CRU
id	string	hyph-uuid	-	Unique ID of the Firewall	R
interfaces	array<object>	-	-	Attached interfaces	R
id	string	-	-	-	R
ip_address	string	-	-	-	R
name	string	-	-	-	R
network_id	string	-	-	-	R
slot_number	integer	-	-	-	R
status	string	-	-	-	R
name	string	-	-	Name of the Firewall	CRU
status	string	-	-	The Firewall status.	R
tenant_id	string	non-hyph-uuid	-	Tenant ID of the owner (UUID)	CR
user_username	string	-	-	Username with user access to VM instance	R

example

{
  "firewall": {
    "admin_username": "user-admin",
    "availability_zone": "zone1-groupa",
    "default_gateway": null,
    "description": "abcdefghijklmnopqrstuvwxyz",
    "firewall_plan_id": "bd12784a-c66e-4f13-9f72-5143d64762b6",
    "id": "5f3cae7c-58a5-4124-b622-9ca3cfbf2525",
    "interfaces": [
      {
        "id": "d41e624a-60a7-42ce-8c24-0b7d16d4cbc6",
        "ip_address": "100.127.253.173",
        "name": "dp0s4",
        "network_id": "c7f88fab-573e-47aa-b0b4-257db28dae23",
        "slot_number": 1,
        "status": "ACTIVE",
        "virtual_ip_address": null,
        "virtual_ip_properties": null
      },
      {
        "id": "d2c9b6a1-4b75-4d89-bebf-bf182f78425f",
        "ip_address": "192.168.110.1",
        "name": "dp0s5",
        "network_id": "1839d290-721c-49ba-99f1-3d7aa37811b0",
        "slot_number": 2,
        "status": "ACTIVE",
        "virtual_ip_address": null,
        "virtual_ip_properties": null
      },
      {
        "id": "43c95cd1-2694-4eca-b446-0d8db9e54c4c",
        "ip_address": null,
        "name": "dp0s6",
        "network_id": null,
        "slot_number": 3,
        "status": "ACTIVE",
        "virtual_ip_address": null,
        "virtual_ip_properties": null
      },
      {
        "id": "366499fd-b03b-40a4-a4ad-f83ef788a938",
        "ip_address": null,
        "name": "dp0s7",
        "network_id": null,
        "slot_number": 4,
        "status": "ACTIVE",
        "virtual_ip_address": null,
        "virtual_ip_properties": null
      }
    ],
    "name": "abcdefghijklmnopqrstuvwxyz",
    "status": "ACTIVE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "user_username": "user-read"
  }
}

Firewall Interface

Firewall Interface

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
description	string	-	-	Description the Firewall Interface	RU
firewall_id	string	hyph-uuid	-	The ID of firewall this firewall_interface belongs to.	R
id	string	uuid	-	Unique ID of the Firewall Interface	R
ip_address	string	ipv4	-	IP Address	RUD
name	string	-	-	Name the Firewall Interface	RU
network_id	string	hyph-uuid	-	Network	RUD
slot_number	integer	-	-	Slot Number	R
status	string	-	-	Firewall interface status	R
tenant_id	string	uuid	-	Tenant ID of the owner (UUID)	R
virtual_ip_address	string	ipv4	-	Virtual IP Address	RUD
virtual_ip_properties	object	-	-	Properties used for virtual IP address	RUD
protocol	string	-	['vrrp']	Redundancy Protocol	RUD
vrid	integer	-	-	VRRP group identifier	RUD

example

{
  "firewall_interface": {
    "description": "test",
    "firewall_id": "9f872504-36ab-46af-83ce-a4991c669edd",
    "id": "2897f333-3554-4099-a638-64d7022bf9ae",
    "ip_address": "100.64.64.99",
    "name": "dp0s5",
    "network_id": "e6106a35-d79b-44a3-bda0-6009b2f8775a",
    "slot_number": 2,
    "status": "ACTIVE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "virtual_ip_address": "100.64.64.100",
    "virtual_ip_properties": {
      "protocol": "vrrp",
      "vrid": 10
    }
  }
}

Firewall Plan

Firewall Plan

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
description	string	-	-	Description of the Firewall Plan	R
enabled	boolean	-	-	Is user allowed to create new firewalls with this plan.	R
id	string	hyph-uuid	-	Unique ID of the Firewall Plan	R
name	string	-	-	Name of the Firewall Plan	R
vendor	string	-	['vyatta']	Firewall Type	R
version	string	-	-	Firewall Type	R

example

{
  "firewall_plan": {
    "description": "",
    "enabled": true,
    "id": "2b757ea7-f346-4297-a598-4d054bc0ae58",
    "name": "firewall-2core-4interface",
    "vendor": "vyatta",
    "version": "3.5R6"
  }
}

GCP Gateway

GCP Gateway

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
description	string	-	-	Description of the GCP Gateway resource	R
gcp_service_id	string	hyph-uuid-or-empty	-	GCP Service instantiated by this Gateway	R
id	string	-	-	Unique ID of the GCP Gateway resource	R
name	string	-	-	Name of the GCP Gateway resource	R
qos_option_id	string	hyph-uuid-or-empty	-	Quality of Service options selected for this Gateway	R
status	string	-	-	The GCP Gateway status.	R
tenant_id	string	non-hyph-uuid	-	Tenant ID of the owner (UUID)	R

example

{
  "gcp_gateway": {
    "description": "gcp_gateway_inet_test, 10M-BE, member role",
    "gcp_service_id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9",
    "id": "07f97269-e616-4dff-a73f-ca80bc5682dc",
    "name": "test-member-user-gcp-gateway",
    "qos_option_id": "e41f6a2f-e197-41c8-9f71-ef19cfd2a85a",
    "status": "ACTIVE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

GCP Interface

GCP Uplink Interface

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
description	string	-	-	Description of the GCP Interface resource	R
gcp_gw_id	string	hyph-uuid-or-empty	-	GCP Gateway to which this interface is connected	R
id	string	-	-	Unique ID of the GCP Interface resource	R
name	string	-	-	Name of the GCP Interface resource	R
primary	object	-	-	Primary router uplink ip configuration	R
bgp_peer_ip	string	ipv4	-	Address of the eBGP peer	R
bgp_router_id	string	ipv4	-	Router id used in virtual-router config (defaults to ip_address)	R
ip_address	string	cidr	-	Address of the uplink interface	R
secondary	object	-	-	Secondary router uplink ip configuration	R
bgp_peer_ip	string	ipv4	-	Address of the eBGP peer	R
bgp_router_id	string	ipv4	-	Router id used in virtual-router config (defaults to ip_address)	R
ip_address	string	cidr	-	Address of the uplink interface	R
status	string	-	-	The GCP Interface status.	R
tenant_id	string	non-hyph-uuid	-	Tenant ID of the owner (UUID)	R

example

{
  "gcp_interface": {
    "description": "gcp-interface-1-tenantA",
    "gcp_gw_id": "b6d96194-f74a-4beb-97cd-727f02b0e070",
    "id": "278dfbe4-f8cc-4ce4-aa17-561401c01661",
    "name": "gcp-interface-1",
    "primary": {
      "bgp_peer_ip": "10.2.121.1",
      "bgp_router_id": "10.2.121.10",
      "ip_address": "10.2.121.10/25"
    },
    "secondary": {
      "bgp_peer_ip": "10.2.121.129",
      "bgp_router_id": "10.2.121.130",
      "ip_address": "10.2.121.130/25"
    },
    "status": "ACTIVE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

GCP Service

GCP Service

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
description	string	-	-	Description of the GCP Service resource	R
id	string	hyph-uuid	-	Unique ID of the GCP Service resource	R
name	string	-	-	Name of the GCP Service resource	R
zone	string	-	-	Name of zone	R

example

{
  "gcp_service": {
    "description": "GCP connectivity provider",
    "id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9",
    "name": "GCP-Service-Provider-01",
    "zone": "Lab3"
  }
}

Gateway Interface

Gateway Interface

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
aws_gw_id	string	hyph-uuid-or-empty	-	AWS Gateway to which this port is connected	R
azure_gw_id	string	hyph-uuid-or-empty	-	Azure Gateway to which this port is connected	R
description	string	-	-	Description of the Gateway Interface resource	CRU
fic_gw_id	string	hyph-uuid-or-empty	-	FIC Gateway to which this port is connected	R
gcp_gw_id	string	hyph-uuid-or-empty	-	GCP Gateway to which this port is connected	R
gw_vipv4	string	ipv4	-	IP version 4 address to be assigned virtual router on VRRP	CR
gw_vipv6	string	ipv6	-	IP version 6 address to be assigned virtual router on VRRP	R
id	string	hyph-uuid	-	Unique ID of the Gateway Interface resource	R
interdc_gw_id	string	hyph-uuid-or-empty	-	Inter DC Gateway to which this port is connected	R
internet_gw_id	string	hyph-uuid-or-empty	-	Internet GW to which this port is connected	CR
name	string	-	-	Name of the Gateway Interface resource	CRU
netmask	integer	-	-	Netmask for IPv4 addresses	CR
network_id	string	hyph-uuid-or-empty	-	Network connected to this interface	CR
primary_ipv4	string	ipv4	-	IP version 4 address to be assigned to primary device on VRRP	CR
primary_ipv6	string	ipv6	-	IP version 6 address to be assigned to primary device on VRRP	R
secondary_ipv4	string	ipv4	-	IP version 4 address to be assigned to secondary device on VRRP	CR
secondary_ipv6	string	ipv6	-	IP version 6 address to be assigned to secondary device on VRRP	R
service_type	string	-	['aws', 'azure', 'fic', 'gcp', 'vpn', 'internet', 'interdc']	Service type for this interface	CR
status	string	-	-	The Gateway Interface status.	R
tenant_id	string	non-hyph-uuid-or-empty	-	Tenant ID of the owner (UUID)	CR
vpn_gw_id	string	hyph-uuid-or-empty	-	VPN Gateway to which this port is connected	R
vrid	integer	-	-	VRRP Group ID for this GW Interface	CR

example

{
  "gw_interface": {
    "aws_gw_id": null,
    "azure_gw_id": null,
    "description": "",
    "fic_gw_id": null,
    "gcp_gw_id": null,
    "gw_vipv4": "100.127.254.49",
    "gw_vipv6": null,
    "id": "09771fbb-6496-4ae1-9b53-226b6edcc1be",
    "interdc_gw_id": null,
    "internet_gw_id": "e72ef35a-c96f-45f8-aeee-e7547c5b94b3",
    "name": "5_Gateway",
    "netmask": 29,
    "network_id": "0200a550-82cf-4d6d-b564-a87eb63e2b75",
    "primary_ipv4": "100.127.254.53",
    "primary_ipv6": null,
    "secondary_ipv4": "100.127.254.54",
    "secondary_ipv6": null,
    "service_type": "internet",
    "status": "ACTIVE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "vpn_gw_id": null,
    "vrid": 1
  }
}

Inter DC Gateway

Inter Data-Center Gateway

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
description	string	-	-	Description of the Inter DC Gateway resource	R
id	string	-	-	Unique ID of the Inter DC Gateway resource	R
interdc_service_id	string	hyph-uuid-or-empty	-	Inter DC Service instantiated by this Gateway	R
name	string	-	-	Name of the Inter DC Gateway resource	R
status	string	-	-	The VPN Gateway status.	R
tenant_id	string	non-hyph-uuid	-	Tenant ID of the owner (UUID)	R

example

{
  "interdc_gateway": {
    "description": "interdc_gateway_inet_test, 10M-BE, member role",
    "id": "07f97269-e616-4dff-a73f-ca80bc5682dc",
    "interdc_service_id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9",
    "name": "lab3-test-member-user-interdc-gateway",
    "status": "ACTIVE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Inter DC Interface

Inter Data-Center Gateway uplink Interface

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
description	string	-	-	Description of the Inter DC Interface resource	CRU
gw_vipv4	string	ipv4	-	IP version 4 address to be assigned virtual router on VRRP	CR
gw_vipv6	string	ipv6	-	IP version 6 address to be assigned virtual router on VRRP	CR
id	string	-	-	Unique ID of the Inter DC Interface resource	R
interdc_gw_id	string	hyph-uuid-or-empty	-	Inter DC Gateway to which this port is connected	CR
name	string	-	-	Name of the Inter DC Interface resource	CRU
netmask	integer	-	-	Netmask for IPv4 addresses	CR
primary_ipv4	string	ipv4	-	IP version 4 address to be assigned to primary device on VRRP	CR
primary_ipv6	string	ipv6	-	IP version 6 address to be assigned to primary device on VRRP	CR
secondary_ipv4	string	ipv4	-	IP version 4 address to be assigned to secondary device on VRRP	CR
secondary_ipv6	string	ipv6	-	IP version 6 address to be assigned to secondary device on VRRP	CR
status	string	-	-	The Inter DC Gateway Interface status.	R
tenant_id	string	non-hyph-uuid	-	Tenant ID of the owner (UUID)	CR
vrid	integer	-	-	VRRP Group ID for this Inter DC Interface	CR

example

{
  "interdc_interface": {
    "description": "lab3-interdc-interface_for_tenant-sdpgui01",
    "gw_vipv4": "10.26.25.1",
    "gw_vipv6": null,
    "id": "278dfbe4-f8cc-4ce4-aa17-561401c01661",
    "interdc_gw_id": "b6d96194-f74a-4beb-97cd-727f02b0e070",
    "name": "interdc_interface_for_tenant-sdpgui01",
    "netmask": 24,
    "primary_ipv4": "10.26.25.101",
    "primary_ipv6": null,
    "secondary_ipv4": "10.26.25.102",
    "secondary_ipv6": null,
    "status": "ACTIVE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "vrid": 7
  }
}

Inter DC Service

Inter Data-Center Service

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
description	string	-	-	Description of the Inter DC Service resource	R
id	string	hyph-uuid	-	Unique ID of the Inter DC Service resource	R
name	string	-	-	Name of the Inter DC Service resource	R
zone	string	-	-	Name of zone	R

example

{
  "interdc_service": {
    "description": "test InterDC service",
    "id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9",
    "name": "test InterDC service 1",
    "zone": "Lab3"
  }
}

Internet Gateway

Internet Gateway

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
description	string	-	-	Description of the Internet Gateway resource	CRU
id	string	hyph-uuid	-	Unique ID of the Internet Gateway resource	R
internet_service_id	string	hyph-uuid-or-empty	-	Internet Service instantiated by this Gateway	CR
name	string	-	-	Name of the Internet Gateway resource	CRU
qos_option_id	string	hyph-uuid-or-empty	-	Quality of Service options selected for this Gateway	CRU
status	string	-	-	The Internet Gateway status.	R
tenant_id	string	non-hyph-uuid	-	Tenant ID of the owner (UUID)	CR

example

{
  "internet_gateway": {
    "description": "",
    "id": "03a07645-980a-42a4-9e2e-ebfb04391841",
    "internet_service_id": "5536154d-9a00-4b11-81fb-b185c9111d90",
    "name": "Lab3-Internet-Service-Provider-01",
    "qos_option_id": "e497bbc3-1127-4490-a51d-93582c40ab40",
    "status": "ACTIVE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Internet Service

Internet Service

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
description	string	-	-	Description of the Internet Service	R
id	string	hyph-uuid	-	Unique ID of the Internet Service	R
minimal_submask_length	integer	-	-	Don't allow allocating public IP blocks with shorter mask (i.e. larger subnets)	R
name	string	-	-	Name of the Internet Service	R
zone	string	-	-	Name of zone	R

example

{
  "internet_service": {
    "description": "lab3 internet connectivity provider",
    "id": "a7791c79-19b0-4eb6-9a8f-ea739b44e8d5",
    "minimal_submask_length": 26,
    "name": "Lab3-Internet-Service-Provider-01",
    "zone": "Lab3"
  }
}

Load Balancer

Load Balancer

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
admin_username	string	-	-	Username with admin access to VM instance	R
availability_zone	string	-	-	Availability Zone, this can be referred to using Virtual Server (Nova)'s list availability zones	CR
default_gateway	string	ipv4	-	IP address of default gateway	RUD
description	string	-	-	Description of the Load Balancer	CRU
id	string	hyph-uuid	-	Unique ID of the Load Balancer	R
interfaces	array<object>	-	-	Attached interfaces	R
id	string	-	-	-	R
ip_address	string	-	-	-	R
name	string	-	-	-	R
network_id	string	-	-	-	R
slot_number	integer	-	-	-	R
status	string	-	-	-	R
type	integer	-	-	-	R
load_balancer_plan_id	string	hyph-uuid	-	Load Balancer Plan	CRU
name	string	-	-	Name of the Load Balancer	CRU
status	string	-	-	The Load Balancer status.	R
syslog_servers	array<object>	-	-	Connected syslog servers	R
id	string	-	-	-	R
ip_address	string	-	-	-	R
log_facility	integer	-	-	-	R
log_level	string	-	-	-	R
name	string	-	-	-	R
port_number	integer	-	-	-	R
status	string	-	-	-	R
tenant_id	string	non-hyph-uuid	-	Tenant ID of the owner (UUID)	CR
user_username	string	-	-	Username with user access to VM instance	R

example

{
  "load_balancer": {
    "admin_username": "user-admin",
    "availability_zone": "zone1-groupa",
    "default_gateway": null,
    "description": "abcdefghijklmnopqrstuvwxyz",
    "id": "5f3cae7c-58a5-4124-b622-9ca3cfbf2525",
    "interfaces": [
      {
        "id": "ee335c69-b50f-4a32-9d0f-f44cef84a456",
        "ip_address": "100.127.253.173",
        "name": "Interface 1/1",
        "network_id": "c7f88fab-573e-47aa-b0b4-257db28dae23",
        "slot_number": 1,
        "status": "ACTIVE",
        "type": "user",
        "virtual_ip_address": null,
        "virtual_ip_properties": null
      },
      {
        "id": "b39b61e4-00b1-4698-aed0-1928beb90abe",
        "ip_address": "192.168.110.1",
        "name": "Interface 1/2",
        "network_id": "1839d290-721c-49ba-99f1-3d7aa37811b0",
        "slot_number": 2,
        "status": "ACTIVE",
        "type": "user",
        "virtual_ip_address": null,
        "virtual_ip_properties": null
      },
      {
        "id": "e1bede1c-68df-4adb-92ff-bc79cb5ff4c9",
        "ip_address": "192.168.3.4",
        "name": "Interface 1/3",
        "network_id": "bc4fe0f3-655c-49f8-b7e5-f3dccb2b920f",
        "slot_number": 3,
        "status": "ACTIVE",
        "type": "user",
        "virtual_ip_address": null,
        "virtual_ip_properties": null
      },
      {
        "id": "1de97307-3a90-407b-be5a-1d104c664bcb",
        "ip_address": null,
        "name": "Interface 1/4",
        "network_id": null,
        "slot_number": 4,
        "status": "ACTIVE",
        "type": "user",
        "virtual_ip_address": null,
        "virtual_ip_properties": null
      }
    ],
    "load_balancer_plan_id": "bd12784a-c66e-4f13-9f72-5143d64762b6",
    "name": "abcdefghijklmnopqrstuvwxyz",
    "status": "ACTIVE",
    "syslog_servers": [
      {
        "id": "11001101-2edf-1844-1ff7-12ba5b7e566a",
        "ip_address": "177.77.07.215",
        "log_facility": "LOCAL0",
        "log_level": "ALERT|INFO|ERROR",
        "name": "syslog_server_main",
        "port_number": 514,
        "status": "ACTIVE"
      },
      {
        "id": "22002202-2edf-1844-1ff7-12ba5b7e566a",
        "ip_address": "177.77.07.211",
        "log_facility": "LOCAL1",
        "log_level": "ERROR",
        "name": "syslog_server_backup_fst",
        "port_number": 514,
        "status": "ACTIVE"
      }
    ],
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "user_username": "user-read"
  }
}

Load Balancer Interface

Load Balancer Interface

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
description	string	-	-	Description the Load Balancer Interface	RU
id	string	uuid	-	Unique ID of the Load Balancer Interface	R
ip_address	string	ipv4	-	IP Address	RUD
load_balancer_id	string	hyph-uuid	-	The ID of load_balancer this load_balancer_interface belongs to.	R
name	string	-	-	Name of the Load Balancer Interface	RU
network_id	string	hyph-uuid	-	Network	RUD
slot_number	integer	-	-	Slot Number	R
status	string	-	-	Load Balancer Interface status	R
tenant_id	string	uuid	-	Tenant ID of the owner (UUID)	R
virtual_ip_address	string	ipv4	-	Virtual IP Address	RUD
virtual_ip_properties	object	-	-	Properties used for virtual IP address	RUD
protocol	string	-	['vrrp']	Redundancy Protocol	RUD
vrid	integer	-	-	VRRP group identifier	RUD

example

{
  "load_balancer_interface": {
    "description": "test",
    "id": "2897f333-3554-4099-a638-64d7022bf9ae",
    "ip_address": "100.64.64.34",
    "load_balancer_id": "9f872504-36ab-46af-83ce-a4991c669edd",
    "name": "Interface 1/2",
    "network_id": "e6106a35-d79b-44a3-bda0-6009b2f8775a",
    "slot_number": 2,
    "status": "ACTIVE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "virtual_ip_address": "100.64.64.101",
    "virtual_ip_properties": {
      "protocol": "vrrp",
      "vrid": 10
    }
  }
}

Load Balancer Plan

Load Balancer Plan

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
description	string	-	-	Description of the Load Balancer Plan	R
enabled	boolean	-	-	Is user allowed to create new load balancers with this plan.	R
update_enabled	boolean	-	-	Is user allowed to update load balancers with this plan.	R
id	string	hyph-uuid	-	Unique ID of the Load Balancer Plan	R
maximum_syslog_servers	integer	-	-	maximum number of syslog servers	R
model	object	-	-	Model of load balancer	R
edition	string	-	['Standard', 'Enterprise', 'Platinum']	-	R
size	string	-	['10', '50', '200', '1000', '3000']	-	R
name	string	-	-	Name of the Load Balancer Plan	R
vendor	string	-	['citrix']	Load Balancer Type	R
version	string	-	-	Version name	R

example

{
  "load_balancer_plan": {
    "description": "",
    "enabled": true,
    "id": "120c8eb8-0762-4855-9130-634b2ab8a201",
    "maximum_syslog_servers": 10,
    "model": {
      "edition": "Standard",
      "size": "50"
    },
    "name": "LB_Plan1",
    "update_enabled": true,
    "vendor": "citrix",
    "version": "10.5-57.7"
  }
}

Load Balancer Syslog Server

Syslog server configuration for LB

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
acl_logging	string	-	['ENABLED', 'DISABLED']	should syslog record acl info	CRU
appflow_logging	string	-	['ENABLED', 'DISABLED']	should syslog record appflow info	CRU
date_format	string	-	['DDMMYYYY', 'MMDDYYYY', 'YYYYMMDD']	date format utilized by syslog	CRU
description	string	-	-	Description for syslog	CRU
id	string	uuid	-	Unique ID of the syslog resource	R
ip_address	string	ipv4	-	Ip address of syslog server	CR
load_balancer_id	string	hyph-uuid	-	The ID of load_balancer this load_balancer_syslog_server belongs to.	CR
log_facility	string	-	['LOCAL0', 'LOCAL1', 'LOCAL2', 'LOCAL3', 'LOCAL4', 'LOCAL5', 'LOCAL6', 'LOCAL7']	Log facility for syslog	CRU
log_level	string	-	-	Valid elements for log_level are "ALERT","CRITICAL","EMERGENCY", "INFORMATIONAL","NOTICE", "ALL", "DEBUG", "ERROR","NONE", "WARNING". log_level value can be assigned combining multiple elements as "ALERT"|"CRITICAL"|"EMERGENCY". Caution: Can not combine "ALL" or "NONE" with the others.	CRU
name	string	-	-	Name of the syslog resource	CR
port_number	integer	-	-	Port number of syslog server	CR
priority	integer	-	-	priority (0-255)	CRU
status	string	-	-	Load balancer syslog server status	R
tcp_logging	string	-	['NONE', 'ALL']	should syslog record tcp protocol info	CRU
tenant_id	string	uuid	-	Tenant ID of the owner (UUID)	CR
time_zone	string	-	['GMT_TIME', 'LOCAL_TIME']	time zone utilized by syslog	CRU
transport_type	string	-	['UDP']	protocol for syslog transport	CR
user_configurable_log_messages	string	-	['YES', 'NO']	can user configure log messages	CRU

example

{
  "load_balancer_syslog_server": {
    "acl_logging": "DISABLED",
    "appflow_logging": "DISABLED",
    "date_format": "MMDDYYYY",
    "description": "test",
    "id": "2897f333-3554-4099-a638-64d7022bf9ae",
    "ip_address": "120.120.120.30",
    "load_balancer_id": "9f872504-36ab-46af-83ce-a4991c669edd",
    "log_facility": "LOCAL3",
    "log_level": "DEBUG",
    "name": "first_syslog_server",
    "port_number": 514,
    "priority": 20,
    "status": "ACTIVE",
    "tcp_logging": "ALL",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "time_zone": "LOCAL_TIME",
    "transport_type": "UDP",
    "user_configurable_log_messages": "NO"
  }
}

Network

Networks

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
admin_state_up	boolean	-	-	The administrative state of the network	CRU
description	string	-	-	Network description.	CRU
id	string	hyph-uuid	-	Network unique id.	R
name	string	-	-	Network name.	CRU
plane	string	-	['storage', 'data']	Type of the traffic for which network will be used.	CR
shared	boolean	-	-	Indicates whether this network is shared across all tenants (not supported)	R
status	string	-	-	The network status.	R
subnets	array<string>	hyph-uuid	-	The associated subnets.	R
tags	object	-	-	Network tags.	CRU
tenant_id	string	non-hyph-uuid	-	The name of the network owner.	CR

example

{
  "network": {
    "admin_state_up": true,
    "description": "Example network 1 description.",
    "id": "6a9a64f6-45e7-46b2-b0e8-0a850896ff55",
    "name": "Example network 1",
    "plane": "data",
    "shared": false,
    "status": "ACTIVE",
    "subnets": [],
    "tags": {
      "keyword1": "value1",
      "keyword2": "value2"
    },
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Physical Port

Physical port

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
description	string	-	-	Physical port description.	R
id	string	hyph-uuid	-	Physical port unique id.	R
name	string	-	-	Physical port name.	R
plane	string	-	['storage', 'data']	The type of traffic that port will be used.	R
segmentation_ranges	array<object>	-	-	Ranges of allowed VLAN tags	R
end	integer	-	-	-	R
start	integer	-	-	-	R
service_id	string	-	-	The ID of service that owns the physical port.	R
service_owner	string	-	['server', 'storage', 'l2_gateway', 'colo_device', None]	The type of physical port service owner.	R
status	string	-	-	The Physical Port status.	R
tags	object	-	-	Port tags.	R
tenant_id	string	non-hyph-uuid	-	The owner name of physical port.	R

example

{
  "physical_port": {
    "description": "Example physical_port 1 description.",
    "id": "1ce557a3-142b-413a-83dc-76680b0ca7b3",
    "name": "Example physical_port 1",
    "plane": "data",
    "segmentation_ranges": [
      {
        "end": 2048,
        "start": 3
      },
      {
        "end": 4093,
        "start": 2050
      }
    ],
    "service_id": "570bc4a1-2e49-4993-a476-2d503055b86c",
    "service_owner": "server",
    "status": "ACTIVE",
    "tags": {
      "keyword1": "value1",
      "keyword2": "value2"
    },
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Port

Port

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
admin_state_up	boolean	-	-	Administrative state of Port (supported when device_owner starts with "compute:")	CRU
allowed_address_pairs	array<object>	-	-	Allowed address pairs	CRU
ip_address	string	cidr-or-ipv4	-	-	CRU
mac_address	string	-	-	-	CRU
description	string	-	-	Port description.	CRU
device_id	string	hyph-uuid-or-empty	-	The Id of device (i.e physical port id for baremetal).	CRUD
device_owner	string	-	-	The name of the port owner	CRUD
fixed_ips	array<object>	-	-	List of fixes IP addresses assign to port.	CRU
ip_address	string	-	-	The IP address assign to port within subnet.	CRU
subnet_id	string	hyph-uuid	-	The ID of subnet from which IP address is allocated.	CRU
id	string	hyph-uuid	-	Port unique id.	R
mac_address	string	-	-	The MAC address of the port.	CR
managed_by_service	boolean	-	-	Set to true if only admin can modify it. Normal user has only read access.	R
name	string	-	-	Port name.	CRU
network_id	string	hyph-uuid	-	The ID of network this port belongs to.	CR
security_groups	array<string>	hyph-uuid	-	The IDs of security groups applied to the port.	CRU
segmentation_id	integer	-	-	The segmentation ID used for this port (i.e. for vlan type it is vlan tag)	CRUD
segmentation_type	string	-	['flat', 'vlan']	The segmentation type used for this port (i.e. vlan)	CRUD
status	string	-	-	The port status.	R
tags	object	-	-	Port tags.	CRU
tenant_id	string	non-hyph-uuid-or-empty	-	The owner name of port.	CR

example

{
  "port": {
    "admin_state_up": true,
    "allowed_address_pairs": [],
    "description": "Example port 1 description.",
    "device_id": "b269b8c0-1a42-4464-9314-4396e51e5107",
    "device_owner": "compute:Tokyo-DC1",
    "fixed_ips": [
      {
        "ip_address": "10.161.54.13",
        "subnet_id": "93bb920c-19be-4026-8cc7-564bfcd41456"
      }
    ],
    "id": "81c3b7d4-eae2-4858-ab76-fa56117b8ab4",
    "mac_address": "26:8d:42:f6:c2:c4",
    "managed_by_service": true,
    "name": "Example port 1",
    "network_id": "ba199c9e-ff09-4d7d-a164-ff61c66cf01f",
    "security_groups": [
      "5a79909b-2bf3-4e26-8a9c-0bf6bb175457"
    ],
    "segmentation_id": 0,
    "segmentation_type": "flat",
    "status": "ACTIVE",
    "tags": {
      "keyword1": "value1",
      "keyword2": "value2"
    },
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Port (managed_by_service==True)

Port

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
admin_state_up	boolean	-	-	Administrative state of Port (supported when device_owner starts with "compute:")	R
allowed_address_pairs	array<object>	-	-	Allowed address pairs	R
ip_address	string	cidr-or-ipv4	-	-	R
mac_address	string	-	-	-	R
description	string	-	-	Port description.	R
device_id	string	hyph-uuid-or-empty	-	The Id of device (i.e physical port id for baremetal).	R
device_owner	string	-	-	The name of the port owner	R
fixed_ips	array<object>	-	-	List of fixes IP addresses assign to port.	R
ip_address	string	-	-	The IP address assign to port within subnet.	R
subnet_id	string	hyph-uuid	-	The ID of subnet from which IP address is allocated.	R
id	string	hyph-uuid	-	Port unique id.	R
mac_address	string	-	-	The MAC address of the port.	R
managed_by_service	boolean	-	-	Set to true if only admin can modify it. Normal user has only read access.	R
name	string	-	-	Port name.	R
network_id	string	hyph-uuid	-	The ID of network this port belongs to.	R
security_groups	array<string>	hyph-uuid	-	The IDs of security groups applied to the port.	R
status	string	-	-	The port status.	R
tags	object	-	-	Port tags.	R
tenant_id	string	non-hyph-uuid-or-empty	-	The owner name of port.	R

example

{
  "port": {
    "admin_state_up": true,
    "allowed_address_pairs": [],
    "description": "Example port 1 description.",
    "device_id": "b269b8c0-1a42-4464-9314-4396e51e5107",
    "device_owner": "compute:Tokyo-DC1",
    "fixed_ips": [
      {
        "ip_address": "10.161.54.13",
        "subnet_id": "93bb920c-19be-4026-8cc7-564bfcd41456"
      }
    ],
    "id": "81c3b7d4-eae2-4858-ab76-fa56117b8ab4",
    "mac_address": "26:8d:42:f6:c2:c4",
    "managed_by_service": true,
    "name": "Example port 1",
    "network_id": "ba199c9e-ff09-4d7d-a164-ff61c66cf01f",
    "security_groups": [
      "5a79909b-2bf3-4e26-8a9c-0bf6bb175457"
    ],
    "status": "ACTIVE",
    "tags": {
      "keyword1": "value1",
      "keyword2": "value2"
    },
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Public IPs

Public IP Block assigned to user

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
cidr	string	-	-	The IP address of the block (assigned automatically)	R
description	string	-	-	Description of the Public IPs	CRU
id	string	hyph-uuid	-	Unique ID of the Public IPs	R
internet_gw_id	string	hyph-uuid-or-empty	-	Internet Gateway the block will be assigned to	CR
name	string	-	-	Name of the Public IPs	CRU
status	string	-	-	Public IP status.	R
submask_length	integer	-	-	Specifies the size of the block by the length of its subnetwork mask length	CR
tenant_id	string	non-hyph-uuid	-	Tenant ID of the owner (UUID)	CR

example

{
  "public_ip": {
    "cidr": "100.127.255.80",
    "description": "",
    "id": "0718a31b-67be-4349-946b-61a0fc38e4cd",
    "internet_gw_id": "2a75cfa6-89af-425b-bce5-2a85197ef04f",
    "name": "seinou-test-public",
    "status": "ACTIVE",
    "submask_length": 28,
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

QoS Options

QoS Option

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
aws_service_id	string	hyph-uuid-or-empty	-	AWS Service for which this QoS option is available	R
azure_service_id	string	hyph-uuid-or-empty	-	Azure Service for which this QoS option is available	R
bandwidth	string	-	-	Bandwidth assigned with this QoS Option	R
description	string	-	-	Description of the QoS Policy	R
fic_service_id	string	hyph-uuid-or-empty	-	FIC Service for which this QoS option is available	R
gcp_service_id	string	hyph-uuid-or-empty	-	GCP Service for which this QoS option is available	R
id	string	hyph-uuid	-	Unique ID of the QoS Policy	R
interdc_service_id	string	hyph-uuid-or-empty	-	Inter DC Service for which this QoS option is available	R
internet_service_id	string	hyph-uuid-or-empty	-	Internet Service this policy is available from	R
name	string	-	-	Name of the QoS Policy	R
qos_type	string	-	['besteffort', 'guarantee']	Type of QoS Option	R
service_type	string	-	['aws', 'azure', 'fic', 'gcp', 'vpn', 'internet', 'interdc']	Service type for this option	R
status	string	-	-	QoS Option status.	R
vpn_service_id	string	hyph-uuid-or-empty	-	VPN Service for which this QoS option is available	R

example

{
  "qos_option": {
    "aws_service_id": null,
    "azure_service_id": null,
    "bandwidth": "100",
    "description": "lab3-100M-besteffort-menu",
    "fic_service_id": null,
    "gcp_service_id": null,
    "id": "284a7ca9-f26e-4242-8baa-938f48360c2c",
    "interdc_service_id": null,
    "internet_service_id": "5536154d-9a00-4b11-81fb-b185c9111d90",
    "name": "Lab3-100M-BE",
    "qos_type": "besteffort",
    "service_type": "internet",
    "status": "ACTIVE",
    "vpn_service_id": null
  }
}

Quotas

Quotas

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
aws_gateway	integer	-	-	AWS gateway quota.	R
azure_gateway	integer	-	-	Azure gateway quota.	R
colocation_logical_link	integer	-	-	Colocation Logical Link quota.	R
common_function_gateway	integer	-	-	Common Function gateway quota.	R
fic_gateway	integer	-	-	FIC gateway quota.	R
firewall	integer	-	-	Firewall quota.	R
gcp_gateway	integer	-	-	GCP gateway quota.	R
id	string	-	-	Quota Id which should be equal to tenant_id.	R
interdc_gateway	integer	-	-	Inter DC gateway quota.	R
internet_gateway	integer	-	-	Internet gateway quota.	R
load_balancer	integer	-	-	Load Balancer quota.	R
network	integer	-	-	Network quota	R
port	integer	-	-	Port quota.	R
public_ip	integer	-	-	Public IP quota.	R
security_group	integer	-	-	Security group quota.	R
subnet	integer	-	-	Subnet quota.	R
tenant_id	string	-	-	The owner of quota.	R
vpn_gateway	integer	-	-	VPN gateway quota.	R

example

{
  "quota": {
    "aws_gateway": 1,
    "azure_gateway": 1,
    "colocation_logical_link": 2,
    "common_function_gateway": 1,
    "fic_gateway": 1,
    "firewall": 2,
    "gcp_gateway": 1,
    "id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "interdc_gateway": 1,
    "internet_gateway": 1,
    "load_balancer": 2,
    "network": 2,
    "port": 30,
    "public_ip": 1,
    "subnet": 5,
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "vpn_gateway": 1
  }
}

Reserved addresses

Reserve addresses

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
id	string	hyph-uuid	-	Id which should be equal to tenant_id.	R
subnets	array<string>	-	-	Reserved CIDR of a subnet.	R
tenant_id	string	-	-	The owner of reserve_addresses.	R

example

{
  "reserve_address": {
    "id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "subnets": [
      "169.254.0.0/16"
    ],
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Security Group

Security group

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
description	string	-	-	Security group description.	CRU
id	string	hyph-uuid	-	Security group unique id.	R
name	string	-	-	Security group name.	CRU
security_group_rules	array<object>	-	-	Security group rules	R
description	string	-	-	Security group rule description.	R
direction	string	-	['ingress', 'egress']	Direction in which the security group rule is applied.	R
ethertype	string	-	['IPv4', 'IPv6', None]	It should be IPv4 or IPv6. If specified, addresses represented in CIDR must match this value.	R
id	string	hyph-uuid	-	Security group rule unique id.	R
port_range_max	integer	-	-	The maximum port number in the range that is matched by the security group rule.	R
port_range_min	integer	-	-	The minimum port number in the range that is matched by the security group rule.	R
protocol	string	-	-	Protocol name or number in string format. e.g. "ICMP" or "1"	R
remote_group_id	string	hyph-uuid	-	The remote group UUID to associate with this security group rule. Only either one of remote_group_id and remote_ip_prefix have to be specified.	R
remote_ip_prefix	string	-	-	The remote IP prefix that is matched by this security group rule. Only either one of remote_group_id and remote_ip_prefix have to be specified.	R
security_group_id	string	hyph-uuid	-	Security group id.	R
tenant_id	string	non-hyph-uuid-or-empty	-	The owner name of security group rule.	R
status	string	-	-	Security group status.	R
tags	object	-	-	Security Group tags.	CRU
tenant_id	string	non-hyph-uuid-or-empty	-	The owner name of security group.	CR

example

{
  "security_group": {
    "description": "Example security group 1 description.",
    "id": "5a79909b-2bf3-4e26-8a9c-0bf6bb175457",
    "name": "Example security group 1",
    "security_group_rules": [
      {
        "description": "Example security group rule 1 description.",
        "direction": "ingress",
        "ethertype": "IPv4",
        "id": "830b1b3a-d159-4e4b-b43b-4ba62bf46bb8",
        "port_range_max": 65535,
        "port_range_min": 0,
        "protocol": "ip",
        "remote_group_id": null,
        "remote_ip_prefix": "192.168.100.0/24",
        "security_group_id": "5a79909b-2bf3-4e26-8a9c-0bf6bb175457",
        "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
      }
    ],
    "status": "ACTIVE",
    "tags": {},
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Security Group Rule

Security group rule

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
description	string	-	-	Security group rule description.	CR
direction	string	-	['ingress', 'egress']	Direction in which the security group rule is applied.	CR
ethertype	string	-	['IPv4', 'IPv6', None]	It should be IPv4 or IPv6. If specified, addresses represented in CIDR must match this value.	CR
id	string	hyph-uuid	-	Security group rule unique id.	R
port_range_max	integer	-	-	The maximum port number in the range that is matched by the security group rule.	CR
port_range_min	integer	-	-	The minimum port number in the range that is matched by the security group rule.	CR
protocol	string	-	-	Protocol name or number in string format. e.g. "ICMP" or "1"	CR
remote_group_id	string	hyph-uuid	-	The remote group UUID to associate with this security group rule. Only either one of remote_group_id and remote_ip_prefix have to be specified.	CR
remote_ip_prefix	string	-	-	The remote IP prefix that is matched by this security group rule. Only either one of remote_group_id and remote_ip_prefix have to be specified.	CR
security_group_id	string	hyph-uuid	-	Security group id.	CR
tenant_id	string	non-hyph-uuid-or-empty	-	The owner name of security group rule.	CR

example

{
  "security_group_rule": {
    "description": "Example security group rule 1 description.",
    "direction": "ingress",
    "ethertype": "IPv4",
    "id": "830b1b3a-d159-4e4b-b43b-4ba62bf46bb8",
    "port_range_max": 65535,
    "port_range_min": 0,
    "protocol": "ip",
    "remote_group_id": null,
    "remote_ip_prefix": "192.168.100.0/24",
    "security_group_id": "5a79909b-2bf3-4e26-8a9c-0bf6bb175457",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Static Route

Static Route for GW Services

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
aws_gw_id	string	hyph-uuid-or-empty	-	AWS Gateway on which this static route will be set	R
azure_gw_id	string	hyph-uuid-or-empty	-	Azure Gateway on which this static route will be set	R
description	string	-	-	Description of the Static Route resource	CRU
destination	string	cidr-or-ipv4	-	CIDR this static route points to	CR
fic_gw_id	string	hyph-uuid-or-empty	-	FIC Gateway on which this static route will be set	R
gcp_gw_id	string	hyph-uuid-or-empty	-	GCP Gateway on which this static route will be set	R
id	string	hyph-uuid	-	Unique ID of the Static Route resource	R
interdc_gw_id	string	hyph-uuid-or-empty	-	Inter DC Gateway on which this static route will be set	R
internet_gw_id	string	hyph-uuid-or-empty	-	Internet Gateway on which this static route will be set	CR
name	string	-	-	Name of the Static Route resource	CRU
nexthop	string	ipv4	-	Next Hop address for specified CIDR	CR
service_type	string	-	['aws', 'azure', 'fic', 'gcp', 'vpn', 'internet', 'interdc']	Service type for this route	CR
status	string	-	-	Static Route status.	R
tenant_id	string	non-hyph-uuid	-	Tenant ID of the owner (UUID)	CR
vpn_gw_id	string	hyph-uuid-or-empty	-	VPN Gateway on which this static route will be set	R

example

{
  "static_route": {
    "aws_gw_id": null,
    "azure_gw_id": null,
    "description": "",
    "destination": "100.127.254.152/29",
    "fic_gw_id": null,
    "gcp_gw_id": null,
    "id": "93aaec0f-1546-4062-88c5-93c397b93c03",
    "interdc_gw_id": null,
    "internet_gw_id": "3c5703b7-e783-42fe-ba23-5b0fe872cccb",
    "name": "TEST-01",
    "nexthop": "100.127.254.153",
    "service_type": "internet",
    "status": "ACTIVE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "vpn_gw_id": null
  }
}

Subnet

Subnets

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
allocation_pools	array<object>	-	-	List of subnet allocation pools	CR
end	string	ipv4	-	-	CR
start	string	ipv4	-	-	CR
cidr	string	cidr	-	Subnet CIDR.	CR
description	string	-	-	Subnet description.	CRU
dns_nameservers	array<string>	-	-	List of subnet dns name servers.	CRU
enable_dhcp	boolean	-	-	Set to true if DHCP is enabled and false if DHCP is disabled.	CRU
gateway_ip	string	ipv4	-	Subnet default gateway ip.	CRUD
host_routes	array<object>	-	-	A list of host route dictionaries for the subnet.	CRU
destination	string	cidr	-	-	CRU
nexthop	string	ipv4	-	-	CRU
id	string	hyph-uuid	-	Subnet unique id.	R
ip_version	integer	-	[4]	The IP version used. (supports only 4)	CR
ipv6_address_mode	string	-	['dhcpv6-stateful', 'dhcpv6-stateless', 'static']	Address mode for IPv6 (not supported)	R
ipv6_ra_mode	string	-	['dhcpv6-stateful', 'dhcpv6-stateless', 'static']	IPv6 router advertisement mode (not supported)	R
name	string	-	-	Subnet name.	CRU
network_id	string	hyph-uuid	-	The ID of network this subnet belongs to.	CR
ntp_servers	array<string>	-	-	List of ntp servers.	CRU
status	string	-	-	Subnet status.	R
tags	object	-	-	Subnet tags.	CRU
tenant_id	string	non-hyph-uuid	-	The owner name of subnet.	CR

example

{
  "subnet": {
    "allocation_pools": [
      {
        "end": "10.161.54.99",
        "start": "10.161.54.13"
      },
      {
        "end": "10.161.54.220",
        "start": "10.161.54.200"
      }
    ],
    "cidr": "10.161.54.0/24",
    "description": "Example subnet 1 description.",
    "dns_nameservers": [
      "8.8.8.8",
      "10.161.54.11"
    ],
    "enable_dhcp": true,
    "gateway_ip": "10.161.54.1",
    "host_routes": [
      {
        "destination": "10.2.0.0/24",
        "nexthop": "10.1.0.10"
      }
    ],
    "id": "93bb920c-19be-4026-8cc7-564bfcd41456",
    "ip_version": 4,
    "ipv6_address_mode": null,
    "ipv6_ra_mode": null,
    "name": "Example subnet 1",
    "network_id": "6a9a64f6-45e7-46b2-b0e8-0a850896ff55",
    "ntp_servers": [
      "10.161.54.12"
    ],
    "status": "ACTIVE",
    "tags": {
      "keyword1": "value1",
      "keyword2": "value2"
    },
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Tenant Connection

Tenant Connection

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
approval_request_id	string	hyph-uuid	-	Approval Request ID	R
connected_interface	object	-	-	Properties used for Connected Interface properties	CR
id	string	hyph-uuid	-	Resource id of the Interface which Connects the Tenant	CR
ip_address	string	ipv4	-	IP Address	CR
virtual_ip_address	string	ipv4	-	Virtual IP Address	CR
virtual_ip_properties	object	-	-	Properties used for virtual IP address	CR
protocol	string	-	['vrrp']	Redundancy Protocol	CR
vrid	integer	-	-	VRRP group identifier	CR
connected_network	object	-	-	Properties used for Connected Network	CR
id	string	hyph-uuid	-	Network ID	CR
subnet_cidr	string	cidr	-	Subnet CIDR.	CR
tenant_id	string	non-hyph-uuid	-	Tenant ID of the Connected Network (UUID)	CR
description	string	-	-	Description of the Tenant Connection	CRU
id	string	hyph-uuid	-	Unique ID of the Tenant Connection	R
interface_type	string	-	['firewall_interface']	Interface Type of the Tenant Connection	CR
name	string	-	-	Name of the Tenant Connection	CRU
progress	string	-	['REQUESTING', 'REQUEST_FAILED', 'REQUESTED', 'EXECUTED', 'DELETING', 'DELETE_FAILED']	Progress of the Tenant Connection. 'REQUESTED' assures only having succeeded in registering approval request, which means this doesn't deal with other sss status ('cancelled', 'approved', 'denied' 'expired', 'approval_expired').	R
tenant_id	string	non-hyph-uuid	-	Tenant ID of the owner (UUID)	CR

example

{
  "tenant_connection": {
    "approval_request_id": "1d5e9218-34e2-4ae2-872a-30726d46ac49",
    "connected_interface": {
      "id": "af64dfc4-3451-44e0-b2ce-f1972d89c6dc",
      "ip_address": "192.168.100.4",
      "virtual_ip_address": "192.168.100.3",
      "virtual_ip_properties": {
        "protocol": "vrrp",
        "vrid": 120
      }
    },
    "connected_network": {
      "id": "39dafb75-aa70-4079-9f69-eb6ffed00d7d",
      "subnet_cidr": "192.168.100.0/24",
      "tenant_id": "18a0e390d1534fd48f25f259add006c5"
    },
    "description": "",
    "id": "2b757ea7-f346-4297-a598-4d054bc0ae58",
    "interface_type": "firewall_interface",
    "name": "example A",
    "progress": "REQUESTED",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

VPN Gateway

VPN Gateway

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
description	string	-	-	Description of the VPN Gateway resource	R
id	string	-	-	Unique ID of the VPN Gateway resource	R
name	string	-	-	Name of the VPN Gateway resource	R
qos_option_id	string	hyph-uuid-or-empty	-	Quality of Service options selected for this Gateway	R
status	string	-	-	The VPN Gateway status.	R
tenant_id	string	non-hyph-uuid	-	Tenant ID of the owner (UUID)	R
vpn_service_id	string	hyph-uuid-or-empty	-	VPN Service instantiated by this Gateway	R

example

{
  "vpn_gateway": {
    "description": "vpn_gateway_inet_test, 10M-BE, member role",
    "id": "07f97269-e616-4dff-a73f-ca80bc5682dc",
    "name": "lab3-test-member-user-vpn-gateway",
    "qos_option_id": "e41f6a2f-e197-41c8-9f71-ef19cfd2a85a",
    "status": "ACTIVE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "vpn_service_id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9"
  }
}

VPN Interface

VPN Uplink Interface

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
description	string	-	-	Description of the VPN Interface resource	R
id	string	-	-	Unique ID of the VPN Interface resource	R
name	string	-	-	Name of the VPN Interface resource	R
primary	object	-	-	Primary router uplink ip configuration	R
bgp_peer_ip	string	ipv4	-	Address of the eBGP peer	R
bgp_router_id	string	ipv4	-	Router id used in virtual-router config (defaults to ip_address)	R
ip_address	string	cidr	-	Address of the uplink interface	R
secondary	object	-	-	Secondary router uplink ip configuration	R
bgp_peer_ip	string	ipv4	-	Address of the eBGP peer	R
bgp_router_id	string	ipv4	-	Router id used in virtual-router config (defaults to ip_address)	R
ip_address	string	cidr	-	Address of the uplink interface	R
status	string	-	-	The VPN Interface status.	R
tenant_id	string	non-hyph-uuid	-	Tenant ID of the owner (UUID)	R
vpn_gw_id	string	hyph-uuid-or-empty	-	VPN Gateway to which this interface is connected	R

example

{
  "vpn_interface": {
    "description": "lab3-vpn-interface_for_tenant-sdpgui01",
    "id": "278dfbe4-f8cc-4ce4-aa17-561401c01661",
    "name": "vpn_interface_for_tenant-sdpgui01",
    "primary": {
      "bgp_peer_ip": "10.2.121.1",
      "bgp_router_id": "10.2.121.10",
      "ip_address": "10.2.121.10/25"
    },
    "secondary": {
      "bgp_peer_ip": "10.2.121.129",
      "bgp_router_id": "10.2.121.130",
      "ip_address": "10.2.121.130/25"
    },
    "status": "ACTIVE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "vpn_gw_id": "b6d96194-f74a-4beb-97cd-727f02b0e070"
  }
}

VPN Service

VPN Service

members of this type

Parameter	Type	Format	Enumeration	Description	Permission (_member_)
description	string	-	-	Description of the VPN Service resource	R
id	string	hyph-uuid	-	Unique ID of the VPN Service resource	R
name	string	-	-	Name of the VPN Service resource	R
zone	string	-	-	Name of zone	R

example

{
  "vpn_service": {
    "description": "lab3 vpn connectivity provider",
    "id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9",
    "name": "Lab3-VPN-Service-Provider-01",
    "zone": "Lab3"
  }
}

目次

• L2 Network Service
  • Network
  • Subnet
  • Port
  • Port (managed_by_service==True)
  • Physical Port
  • Security Group
  • Security Group Rule
  • Reserved addresses
  • Quotas
• Data Types
  • AWS Gateway
  • AWS Interface
  • AWS Service
  • Azure Gateway
  • Azure Interface
  • Azure Service
  • Colocation Logical Link
  • Colocation Physical Link
  • Colocation Space
  • Common Function
  • Common Function Gateway
  • Common Function Pool
  • FIC Gateway
  • FIC Interface
  • FIC Service
  • Firewall
  • Firewall Interface
  • Firewall Plan
  • GCP Gateway
  • GCP Interface
  • GCP Service
  • Gateway Interface
  • Inter DC Gateway
  • Inter DC Interface
  • Inter DC Service
  • Internet Gateway
  • Internet Service
  • Load Balancer
  • Load Balancer Interface
  • Load Balancer Plan
  • Load Balancer Syslog Server
  • Network
  • Physical Port
  • Port
  • Port (managed_by_service==True)
  • Public IPs
  • QoS Options
  • Quotas
  • Reserved addresses
  • Security Group
  • Security Group Rule
  • Static Route
  • Subnet
  • Tenant Connection
  • VPN Gateway
  • VPN Interface
  • VPN Service

• Revision History

---

Quotas

Revision History