Skip to content

Openstack Networks

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openstack-networks/ List networks
GET /api/openstack-networks/{uuid}/ Get network details
POST /api/openstack-networks/{uuid}/create_subnet/ Create subnet
POST /api/openstack-networks/{uuid}/pull/ Synchronize resource state
POST /api/openstack-networks/{uuid}/unlink/ Unlink resource
PUT /api/openstack-networks/{uuid}/ Update network
PATCH /api/openstack-networks/{uuid}/ Partially update network
DELETE /api/openstack-networks/{uuid}/ Delete network
Other Actions
POST /api/openstack-networks/{uuid}/rbac_policy_create/ Create RBAC policy
POST /api/openstack-networks/{uuid}/set_erred/ Mark resource as ERRED
POST /api/openstack-networks/{uuid}/set_mtu/ Set network MTU
POST /api/openstack-networks/{uuid}/set_ok/ Mark resource as OK
DELETE /api/openstack-networks/{uuid}/rbac_policy_delete/{rbac_policy_uuid}/ Delete RBAC policy

Core CRUD

List networks

Get a list of networks.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-networks/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.models.open_stack_network_field_enum import OpenStackNetworkFieldEnum # (2)
from waldur_api_client.api.openstack_networks import openstack_networks_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_networks_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CoreStates
  2. Model Source: OpenStackNetworkFieldEnum
  3. API Source: openstack_networks_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackNetworksList } from 'waldur-js-client';

try {
  const response = await openstackNetworksList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
direct_only boolean Direct only
external_ip string External IP
field array
is_external boolean
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
rbac_only boolean RBAC only
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
tenant string (uri) Tenant URL
tenant_uuid string (uuid) Tenant UUID
type string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url any
tenant string (uri) OpenStack tenant this network belongs to
tenant_name string
tenant_uuid string (uuid)
is_external boolean Defines whether this network is external (public) or internal (private)
type string Network type, such as local, flat, vlan, vxlan, or gre
segmentation_id integer VLAN ID for VLAN networks or tunnel ID for VXLAN/GRE networks
subnets array of objects
subnets.uuid string (uuid)
subnets.name string
subnets.description string
subnets.cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
subnets.gateway_ip any IP address of the gateway for this subnet
subnets.allocation_pools array of objects
subnets.allocation_pools.start any An IPv4 or IPv6 address.
subnets.allocation_pools.end any An IPv4 or IPv6 address.
subnets.ip_version integer IP protocol version (4 or 6)
subnets.enable_dhcp boolean If True, DHCP service will be enabled on this subnet
subnets.port_security_enabled boolean
mtu integer The maximum transmission unit (MTU) value to address fragmentation.
rbac_policies array of objects
rbac_policies.url string (uri)
rbac_policies.uuid string (uuid)
rbac_policies.network string (uri)
rbac_policies.network_name string
rbac_policies.source_tenant_uuid string (uuid)
rbac_policies.source_tenant_name string
rbac_policies.target_tenant string (uri)
rbac_policies.target_tenant_name string
rbac_policies.target_label string
rbac_policies.direction any
rbac_policies.backend_id string
rbac_policies.policy_type any Type of access granted - either shared access or external network access
rbac_policies.created string (date-time)
port_security_enabled boolean Default port_security_enabled for ports on this network. When False, ports created on this network inherit disabled port security unless explicitly overridden.
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_type string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Get network details

Retrieve details of a specific network.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-networks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_network_field_enum import OpenStackNetworkFieldEnum # (1)
from waldur_api_client.api.openstack_networks import openstack_networks_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_networks_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: OpenStackNetworkFieldEnum
  2. API Source: openstack_networks_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackNetworksRetrieve } from 'waldur-js-client';

try {
  const response = await openstackNetworksRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url any
tenant string (uri) OpenStack tenant this network belongs to
tenant_name string
tenant_uuid string (uuid)
is_external boolean Defines whether this network is external (public) or internal (private)
type string Network type, such as local, flat, vlan, vxlan, or gre
segmentation_id integer VLAN ID for VLAN networks or tunnel ID for VXLAN/GRE networks
subnets array of objects
subnets.uuid string (uuid)
subnets.name string
subnets.description string
subnets.cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
subnets.gateway_ip any IP address of the gateway for this subnet
subnets.allocation_pools array of objects
subnets.allocation_pools.start any An IPv4 or IPv6 address.
subnets.allocation_pools.end any An IPv4 or IPv6 address.
subnets.ip_version integer IP protocol version (4 or 6)
subnets.enable_dhcp boolean If True, DHCP service will be enabled on this subnet
subnets.port_security_enabled boolean
mtu integer The maximum transmission unit (MTU) value to address fragmentation.
rbac_policies array of objects
rbac_policies.url string (uri)
rbac_policies.uuid string (uuid)
rbac_policies.network string (uri)
rbac_policies.network_name string
rbac_policies.source_tenant_uuid string (uuid)
rbac_policies.source_tenant_name string
rbac_policies.target_tenant string (uri)
rbac_policies.target_tenant_name string
rbac_policies.target_label string
rbac_policies.direction any
rbac_policies.backend_id string
rbac_policies.policy_type any Type of access granted - either shared access or external network access
rbac_policies.created string (date-time)
port_security_enabled boolean Default port_security_enabled for ports on this network. When False, ports created on this network inherit disabled port security unless explicitly overridden.
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_type string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create subnet

Create a new subnet within the network.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openstack-networks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/create_subnet/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openstack-network"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_sub_net_request import OpenStackSubNetRequest # (1)
from waldur_api_client.api.openstack_networks import openstack_networks_create_subnet # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackSubNetRequest(
    name="my-awesome-openstack-network"
)
response = openstack_networks_create_subnet.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackSubNetRequest
  2. API Source: openstack_networks_create_subnet
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackNetworksCreateSubnet } from 'waldur-js-client';

try {
  const response = await openstackNetworksCreateSubnet({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openstack-network"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
cidr string
gateway_ip any IP address of the gateway for this subnet
disable_gateway boolean If True, no gateway IP address will be allocated
allocation_pools array of objects
allocation_pools.start any ✓ An IPv4 or IPv6 address.
allocation_pools.end any ✓ An IPv4 or IPv6 address.
dns_nameservers array of anys
host_routes array of objects
host_routes.destination string ✓
host_routes.nexthop any ✓ An IPv4 or IPv6 address.

201 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url any
tenant string (uri)
tenant_name string
network string (uri) Network to which this subnet belongs
network_name string
cidr string
gateway_ip any IP address of the gateway for this subnet
disable_gateway boolean If True, no gateway IP address will be allocated
allocation_pools array of objects
allocation_pools.start any An IPv4 or IPv6 address.
allocation_pools.end any An IPv4 or IPv6 address.
ip_version integer IP protocol version (4 or 6)
enable_dhcp boolean If True, DHCP service will be enabled on this subnet
dns_nameservers array of anys
host_routes array of objects
host_routes.destination string
host_routes.nexthop any An IPv4 or IPv6 address.
is_connected boolean Is subnet connected to the default tenant router.
port_security_enabled boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_type string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-networks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_networks import openstack_networks_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_networks_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_networks_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackNetworksPull } from 'waldur-js-client';

try {
  const response = await openstackNetworksPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-networks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_networks import openstack_networks_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_networks_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_networks_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackNetworksUnlink } from 'waldur-js-client';

try {
  const response = await openstackNetworksUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update network

Update an existing network.

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/openstack-networks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openstack-network"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_network_request import OpenStackNetworkRequest # (1)
from waldur_api_client.api.openstack_networks import openstack_networks_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackNetworkRequest(
    name="my-awesome-openstack-network"
)
response = openstack_networks_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackNetworkRequest
  2. API Source: openstack_networks_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackNetworksUpdate } from 'waldur-js-client';

try {
  const response = await openstackNetworksUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openstack-network"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
description string

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url any
tenant string (uri) OpenStack tenant this network belongs to
tenant_name string
tenant_uuid string (uuid)
is_external boolean Defines whether this network is external (public) or internal (private)
type string Network type, such as local, flat, vlan, vxlan, or gre
segmentation_id integer VLAN ID for VLAN networks or tunnel ID for VXLAN/GRE networks
subnets array of objects
subnets.uuid string (uuid)
subnets.name string
subnets.description string
subnets.cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
subnets.gateway_ip any IP address of the gateway for this subnet
subnets.allocation_pools array of objects
subnets.allocation_pools.start any An IPv4 or IPv6 address.
subnets.allocation_pools.end any An IPv4 or IPv6 address.
subnets.ip_version integer IP protocol version (4 or 6)
subnets.enable_dhcp boolean If True, DHCP service will be enabled on this subnet
subnets.port_security_enabled boolean
mtu integer The maximum transmission unit (MTU) value to address fragmentation.
rbac_policies array of objects
rbac_policies.url string (uri)
rbac_policies.uuid string (uuid)
rbac_policies.network string (uri)
rbac_policies.network_name string
rbac_policies.source_tenant_uuid string (uuid)
rbac_policies.source_tenant_name string
rbac_policies.target_tenant string (uri)
rbac_policies.target_tenant_name string
rbac_policies.target_label string
rbac_policies.direction any
rbac_policies.backend_id string
rbac_policies.policy_type any Type of access granted - either shared access or external network access
rbac_policies.created string (date-time)
port_security_enabled boolean Default port_security_enabled for ports on this network. When False, ports created on this network inherit disabled port security unless explicitly overridden.
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_type string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Partially update network

Update specific fields of a network.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/openstack-networks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_open_stack_network_request import PatchedOpenStackNetworkRequest # (1)
from waldur_api_client.api.openstack_networks import openstack_networks_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedOpenStackNetworkRequest()
response = openstack_networks_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedOpenStackNetworkRequest
  2. API Source: openstack_networks_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackNetworksPartialUpdate } from 'waldur-js-client';

try {
  const response = await openstackNetworksPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string
description string

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url any
tenant string (uri) OpenStack tenant this network belongs to
tenant_name string
tenant_uuid string (uuid)
is_external boolean Defines whether this network is external (public) or internal (private)
type string Network type, such as local, flat, vlan, vxlan, or gre
segmentation_id integer VLAN ID for VLAN networks or tunnel ID for VXLAN/GRE networks
subnets array of objects
subnets.uuid string (uuid)
subnets.name string
subnets.description string
subnets.cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
subnets.gateway_ip any IP address of the gateway for this subnet
subnets.allocation_pools array of objects
subnets.allocation_pools.start any An IPv4 or IPv6 address.
subnets.allocation_pools.end any An IPv4 or IPv6 address.
subnets.ip_version integer IP protocol version (4 or 6)
subnets.enable_dhcp boolean If True, DHCP service will be enabled on this subnet
subnets.port_security_enabled boolean
mtu integer The maximum transmission unit (MTU) value to address fragmentation.
rbac_policies array of objects
rbac_policies.url string (uri)
rbac_policies.uuid string (uuid)
rbac_policies.network string (uri)
rbac_policies.network_name string
rbac_policies.source_tenant_uuid string (uuid)
rbac_policies.source_tenant_name string
rbac_policies.target_tenant string (uri)
rbac_policies.target_tenant_name string
rbac_policies.target_label string
rbac_policies.direction any
rbac_policies.backend_id string
rbac_policies.policy_type any Type of access granted - either shared access or external network access
rbac_policies.created string (date-time)
port_security_enabled boolean Default port_security_enabled for ports on this network. When False, ports created on this network inherit disabled port security unless explicitly overridden.
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_type string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Delete network

Delete a network.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/openstack-networks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_networks import openstack_networks_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_networks_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_networks_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackNetworksDestroy } from 'waldur-js-client';

try {
  const response = await openstackNetworksDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Create RBAC policy

Create RBAC policy for the network. DEPRECATED: please use the dedicated /api/openstack-network-rbac-policies/ endpoint.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openstack-networks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/rbac_policy_create/ \
  Authorization:"Token YOUR_API_TOKEN" \
  target_tenant="https://api.example.com/api/target-tenant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.deprecated_network_rbac_policy_request import DeprecatedNetworkRBACPolicyRequest # (1)
from waldur_api_client.api.openstack_networks import openstack_networks_rbac_policy_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = DeprecatedNetworkRBACPolicyRequest(
    target_tenant="https://api.example.com/api/target-tenant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openstack_networks_rbac_policy_create.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: DeprecatedNetworkRBACPolicyRequest
  2. API Source: openstack_networks_rbac_policy_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackNetworksRbacPolicyCreate } from 'waldur-js-client';

try {
  const response = await openstackNetworksRbacPolicyCreate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "target_tenant": "https://api.example.com/api/target-tenant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
target_tenant string (uri) ✓
policy_type any Type of access granted - either shared access or external network access
Constraints: default: access_as_shared

200 -

Field Type Description
url string (uri)
uuid string (uuid)
network string (uri)
network_name string
source_tenant_uuid string (uuid)
source_tenant_name string
target_tenant string (uri)
target_tenant_name string
target_label string
direction any
backend_id string
policy_type any Type of access granted - either shared access or external network access
created string (date-time)

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-networks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.openstack_networks import openstack_networks_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = openstack_networks_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: openstack_networks_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackNetworksSetErred } from 'waldur-js-client';

try {
  const response = await openstackNetworksSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Set network MTU

Update the Maximum Transmission Unit (MTU) for the network.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openstack-networks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_mtu/ \
  Authorization:"Token YOUR_API_TOKEN" \
  mtu=123

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_mtu_request import SetMtuRequest # (1)
from waldur_api_client.api.openstack_networks import openstack_networks_set_mtu # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetMtuRequest(
    mtu=123
)
response = openstack_networks_set_mtu.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetMtuRequest
  2. API Source: openstack_networks_set_mtu
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackNetworksSetMtu } from 'waldur-js-client';

try {
  const response = await openstackNetworksSetMtu({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "mtu": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
mtu integer ✓

202 -

Field Type
mtu integer

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-networks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_networks import openstack_networks_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_networks_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_networks_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackNetworksSetOk } from 'waldur-js-client';

try {
  const response = await openstackNetworksSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Delete RBAC policy

Delete RBAC policy for the network. DEPRECATED: please use the dedicated /api/openstack-network-rbac-policies/ endpoint.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/openstack-networks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/rbac_policy_delete/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_networks import openstack_networks_rbac_policy_delete_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_networks_rbac_policy_delete_destroy.sync(
    rbac_policy_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_networks_rbac_policy_delete_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { openstackNetworksRbacPolicyDeleteDestroy } from 'waldur-js-client';

try {
  const response = await openstackNetworksRbacPolicyDeleteDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "rbac_policy_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
rbac_policy_uuid string (uuid) ✓ UUID of the RBAC policy to delete
uuid string (uuid) ✓

204 - No response body