Openstack Networks
Operations Summary
Core CRUD
List Openstack Networks
HTTPie Python TypeScript Query Parameters Responses
http \
GET \
https://api.example.com/api/openstack-networks/ \
Authorization:"Token YOUR_API_TOKEN"
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_networks import openstack_networks_list # (1)
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 )
API Source: openstack_networks_list
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
can_manage
boolean
Can manage
customer
string (uuid)
customer_abbreviation
string
customer_name
string
customer_native_name
string
customer_uuid
string (uuid)
description
string
direct_only
boolean
Direct only
external_ip
string
field
array
is_external
boolean
name
string
name_exact
string
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
project
string (uuid)
project_name
string
project_uuid
string (uuid)
rbac_only
boolean
RBAC only
service_settings_name
string
service_settings_uuid
string (uuid)
state
array
tenant
string
Tenant URL
tenant_uuid
string (uuid)
Tenant UUID
type
string
uuid
string (uuid)
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
string
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
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.target_tenant
string (uri)
rbac_policies.target_tenant_name
string
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)
marketplace_offering_uuid
string
marketplace_offering_name
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
Retrieve
HTTPie Python TypeScript Path Parameters Query Parameters Responses
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 from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_networks import openstack_networks_retrieve # (1)
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 )
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)
✓
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
string
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
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.target_tenant
string (uri)
rbac_policies.target_tenant_name
string
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)
marketplace_offering_uuid
string
marketplace_offering_name
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
HTTPie Python TypeScript Path Parameters Request Body (required) Responses
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 )
Model Source: OpenStackSubNetRequest
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.
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
string
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.
marketplace_offering_uuid
string
marketplace_offering_name
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.
Unlink resource
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.
Update
HTTPie Python TypeScript Path Parameters Request Body (required) Responses
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 )
Model Source: OpenStackNetworkRequest
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
string
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
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.target_tenant
string (uri)
rbac_policies.target_tenant_name
string
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)
marketplace_offering_uuid
string
marketplace_offering_name
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
Partial Update
HTTPie Python TypeScript Path Parameters Request Body Responses
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 )
Model Source: PatchedOpenStackNetworkRequest
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
string
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
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.target_tenant
string (uri)
rbac_policies.target_tenant_name
string
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)
marketplace_offering_uuid
string
marketplace_offering_name
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
Other Actions
Create RBAC policy for the network
Create RBAC policy for the network
Set mtu
Delete RBAC policy for the network
Delete RBAC policy for the network