• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Neutron
  5. Network
  6. Introduction

Introduction

Object

This interface is used to manage and perform operations on network resources, including querying a network list, creating a network, querying a specified network, deleting a network, and updating networks.

Object Model

Table 1 network object

Attribute

Type

CRUD

Default Value

Restriction

Description

status

String

R

ACTIVE

N/A

Specifies a network status, which can be ACTIVEBUILDDOWN, or ERROR.

subnets

List(Uuid-str)

R

N/A

N/A

Specifies a list for the IDs of the subnets associated with a network.

One network supports the association of only one subnet.

name

String(255)

CRU

N/A

N/A

Specifies the network name.

The name cannot be the same as the admin_external_net value.

router:external

Bool

CRU

false

true or false

Specifies whether the network is an external network.

This attribute is for administrators only. Tenants cannot configure or update this attribute and can only query it.

admin_state_up

Bool

CRU

true

true or false

Specifies the administrative status.

The value can only be true.

tenant_id

String(255)

CR

N/A

N/A

Specifies the tenant ID. Only the administrator can specify tenant_id of other tenants.

shared

Bool

CRU

false

true or false

Specifies whether the network can be shared across tenants.

This attribute is for administrators only. Tenants cannot configure or update this attribute and can only query it.

id

Uuid-str

R

Automatically generated

N/A

Specifies the network ID.

provider:physical_network

String(64)

CR

N/A

N/A

Specifies the physical network used by this network.

This parameter is available only to administrators.

provider:network_type

String(32)

CR

N/A

Vlan, vxlan, flat, local, gre, or geneve

Specifies the network type. Only VXLAN and GENEVE networks are supported.

This attribute is available only to administrators. Only GENEVE tenants can perform operations on this attribute.

provider:segmentation_id

Int

CR

N/A

VLAN: 1–4094

VXLAN: 1 to 16 million

Specifies a network segment ID. The value is a VLAN ID for a VLAN network and is a VNI for a VXLAN network.

This parameter is available only to administrators.

segments

List(segment)

CR

N/A

N/A

Specifies the provider list.

This parameter is incompatible with the preceding three provider parameters.

This parameter is available only to administrators.

availability_zone_hints

List<String>

R

N/A

N/A

Specifies the availability zones available to this network. The current version does not support cross-availability-zone network scheduling.

An empty list is returned.

availability_zones

List<String>

R

N/A

N/A

Specifies the AZ on the network.

An empty list is returned.

port_security_enabled

Bool

CRU

true

N/A

Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect.