Skip to content

Openstack Ports

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openstack-ports/ List Openstack Ports
GET /api/openstack-ports/{uuid}/ Retrieve
POST /api/openstack-ports/ Create
POST /api/openstack-ports/{uuid}/pull/ Synchronize resource state
POST /api/openstack-ports/{uuid}/unlink/ Unlink resource
POST /api/openstack-ports/{uuid}/update_port_ip/ Update port IP address
POST /api/openstack-ports/{uuid}/update_security_groups/ Update security groups of the port
PUT /api/openstack-ports/{uuid}/ Update
PATCH /api/openstack-ports/{uuid}/ Partial Update
DELETE /api/openstack-ports/{uuid}/ Delete
Other Actions
POST /api/openstack-ports/{uuid}/disable_port/ Disable port
POST /api/openstack-ports/{uuid}/disable_port_security/ Disable port security for the port
POST /api/openstack-ports/{uuid}/enable_port/ Enable port
POST /api/openstack-ports/{uuid}/enable_port_security/ Enable port security for the port

Core CRUD

List Openstack Ports

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_ports import openstack_ports_list # (1)

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

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

try {
  const response = await openstackPortsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
admin_state_up boolean
backend_id string
device_id string
device_owner string
exclude_subnet_uuids string Exclude Subnet UUIDs (comma-separated)
field array
fixed_ips string Search by fixed IP
has_device_owner boolean Has device owner
mac_address string
name string
name_exact string
network_name string Search by network name
network_uuid string (uuid) Search by network UUID
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
query string Search by name, MAC address or backend ID
status string
tenant string
tenant_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 Port ID in OpenStack
access_url string
fixed_ips array of objects
fixed_ips.ip_address any IP address to assign to the port
fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
mac_address string MAC address of the port
allowed_address_pairs array of objects
allowed_address_pairs.mac_address string
tenant string (uri) OpenStack tenant this port belongs to
tenant_name string
tenant_uuid string (uuid)
network string (uri) Network to which this port belongs
network_name string
network_uuid string (uuid)
floating_ips array of string (uri)s
device_id string ID of device (instance, router etc) to which this port is connected
device_owner string Entity that uses this port (e.g. network:router_interface)
port_security_enabled boolean If True, security groups and rules will be applied to this port
security_groups array of objects
security_groups.uuid string (uuid)
security_groups.name string
security_groups.url string (uri)
admin_state_up boolean Administrative state of the port. If down, port does not forward packets
status string Port status in OpenStack (e.g. ACTIVE, DOWN)
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

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-ports/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_ports import openstack_ports_retrieve # (1)

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

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

try {
  const response = await openstackPortsRetrieve({
  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 Port ID in OpenStack
access_url string
fixed_ips array of objects
fixed_ips.ip_address any IP address to assign to the port
fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
mac_address string MAC address of the port
allowed_address_pairs array of objects
allowed_address_pairs.mac_address string
tenant string (uri) OpenStack tenant this port belongs to
tenant_name string
tenant_uuid string (uuid)
network string (uri) Network to which this port belongs
network_name string
network_uuid string (uuid)
floating_ips array of string (uri)s
device_id string ID of device (instance, router etc) to which this port is connected
device_owner string Entity that uses this port (e.g. network:router_interface)
port_security_enabled boolean If True, security groups and rules will be applied to this port
security_groups array of objects
security_groups.uuid string (uuid)
security_groups.name string
security_groups.url string (uri)
admin_state_up boolean Administrative state of the port. If down, port does not forward packets
status string Port status in OpenStack (e.g. ACTIVE, DOWN)
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

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openstack-ports/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openstack-port"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_port_request import OpenStackPortRequest # (1)
from waldur_api_client.api.openstack_ports import openstack_ports_create # (2)

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

body_data = OpenStackPortRequest(
    name="my-awesome-openstack-port"
)
response = openstack_ports_create.sync(
    client=client,
    body=body_data
)

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

try {
  const response = await openstackPortsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-openstack-port"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
description string
fixed_ips array of objects
fixed_ips.ip_address any ✓ IP address to assign to the port
fixed_ips.subnet_id string ✓ ID of the subnet in which to assign the IP address
mac_address string MAC address of the port
allowed_address_pairs array of objects
allowed_address_pairs.ip_address string
Constraints: write-only, default: 192.168.42.0/24
allowed_address_pairs.mac_address string
target_tenant string (uri) Target tenant for shared network port creation. If not specified, defaults to network's tenant.
Constraints: write-only
network string (uri) Network to which this port belongs
port_security_enabled boolean If True, security groups and rules will be applied to this port
security_groups array of objects
security_groups.name string ✓

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 Port ID in OpenStack
access_url string
fixed_ips array of objects
fixed_ips.ip_address any IP address to assign to the port
fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
mac_address string MAC address of the port
allowed_address_pairs array of objects
allowed_address_pairs.mac_address string
tenant string (uri) OpenStack tenant this port belongs to
tenant_name string
tenant_uuid string (uuid)
network string (uri) Network to which this port belongs
network_name string
network_uuid string (uuid)
floating_ips array of string (uri)s
device_id string ID of device (instance, router etc) to which this port is connected
device_owner string Entity that uses this port (e.g. network:router_interface)
port_security_enabled boolean If True, security groups and rules will be applied to this port
security_groups array of objects
security_groups.uuid string (uuid)
security_groups.name string
security_groups.url string (uri)
admin_state_up boolean Administrative state of the port. If down, port does not forward packets
status string Port status in OpenStack (e.g. ACTIVE, DOWN)
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.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-ports/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_ports import openstack_ports_pull # (1)

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

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

try {
  const response = await openstackPortsPull({
  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 - No response body

409 - No response body

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-ports/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_ports import openstack_ports_unlink # (1)

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

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

try {
  const response = await openstackPortsUnlink({
  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 port IP address

Update port IP address.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/openstack-ports/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_port_ip/ \
  Authorization:"Token YOUR_API_TOKEN" \
  subnet="https://api.example.com/api/subnet/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  ip_address="192.168.42.50"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_port_ip_update_request import OpenStackPortIPUpdateRequest # (1)
from waldur_api_client.api.openstack_ports import openstack_ports_update_port_ip # (2)

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

body_data = OpenStackPortIPUpdateRequest(
    subnet="https://api.example.com/api/subnet/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    ip_address="192.168.42.50"
)
response = openstack_ports_update_port_ip.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await openstackPortsUpdatePortIp({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "subnet": "https://api.example.com/api/subnet/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "ip_address": "192.168.42.50"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
subnet string (uri) ✓ The subnet where the new IP address will be allocated
Constraints: write-only
ip_address any ✓ The IP address to assign within the subnet

200 - No response body

Update security groups of the port

Update security groups of the port

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openstack-ports/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_security_groups/ \
  Authorization:"Token YOUR_API_TOKEN" \
  security_groups:='["web-server-sg"]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_instance_security_groups_update_request import OpenStackInstanceSecurityGroupsUpdateRequest # (1)
from waldur_api_client.api.openstack_ports import openstack_ports_update_security_groups # (2)

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

body_data = OpenStackInstanceSecurityGroupsUpdateRequest(
    security_groups=[
            "web-server-sg"
        ]
)
response = openstack_ports_update_security_groups.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await openstackPortsUpdateSecurityGroups({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "security_groups": [
      "web-server-sg"
    ]
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
security_groups array of string (uri)s ✓ List of security groups to be assigned to the instance.

200 - No response body

Update

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

 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_port_request import OpenStackPortRequest # (1)
from waldur_api_client.api.openstack_ports import openstack_ports_update # (2)

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

body_data = OpenStackPortRequest(
    name="my-awesome-openstack-port"
)
response = openstack_ports_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await openstackPortsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openstack-port"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
fixed_ips array of objects
fixed_ips.ip_address any ✓ IP address to assign to the port
fixed_ips.subnet_id string ✓ ID of the subnet in which to assign the IP address
mac_address string MAC address of the port
allowed_address_pairs array of objects
allowed_address_pairs.ip_address string
Constraints: write-only, default: 192.168.42.0/24
allowed_address_pairs.mac_address string
target_tenant string (uri) Target tenant for shared network port creation. If not specified, defaults to network's tenant.
Constraints: write-only
network string (uri) Network to which this port belongs
port_security_enabled boolean If True, security groups and rules will be applied to this port
security_groups array of objects
security_groups.name 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 Port ID in OpenStack
access_url string
fixed_ips array of objects
fixed_ips.ip_address any IP address to assign to the port
fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
mac_address string MAC address of the port
allowed_address_pairs array of objects
allowed_address_pairs.mac_address string
tenant string (uri) OpenStack tenant this port belongs to
tenant_name string
tenant_uuid string (uuid)
network string (uri) Network to which this port belongs
network_name string
network_uuid string (uuid)
floating_ips array of string (uri)s
device_id string ID of device (instance, router etc) to which this port is connected
device_owner string Entity that uses this port (e.g. network:router_interface)
port_security_enabled boolean If True, security groups and rules will be applied to this port
security_groups array of objects
security_groups.uuid string (uuid)
security_groups.name string
security_groups.url string (uri)
admin_state_up boolean Administrative state of the port. If down, port does not forward packets
status string Port status in OpenStack (e.g. ACTIVE, DOWN)
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

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/openstack-ports/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_port_request import PatchedOpenStackPortRequest # (1)
from waldur_api_client.api.openstack_ports import openstack_ports_partial_update # (2)

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

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

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

try {
  const response = await openstackPortsPartialUpdate({
  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 Description
name string
description string
target_tenant string (uri) Target tenant for shared network port creation. If not specified, defaults to network's tenant.
Constraints: write-only
security_groups array of objects
security_groups.name 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 Port ID in OpenStack
access_url string
fixed_ips array of objects
fixed_ips.ip_address any IP address to assign to the port
fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
mac_address string MAC address of the port
allowed_address_pairs array of objects
allowed_address_pairs.mac_address string
tenant string (uri) OpenStack tenant this port belongs to
tenant_name string
tenant_uuid string (uuid)
network string (uri) Network to which this port belongs
network_name string
network_uuid string (uuid)
floating_ips array of string (uri)s
device_id string ID of device (instance, router etc) to which this port is connected
device_owner string Entity that uses this port (e.g. network:router_interface)
port_security_enabled boolean If True, security groups and rules will be applied to this port
security_groups array of objects
security_groups.uuid string (uuid)
security_groups.name string
security_groups.url string (uri)
admin_state_up boolean Administrative state of the port. If down, port does not forward packets
status string Port status in OpenStack (e.g. ACTIVE, DOWN)
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

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/openstack-ports/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_ports import openstack_ports_destroy # (1)

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

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

try {
  const response = await openstackPortsDestroy({
  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

Disable port

Disable port.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-ports/a1b2c3d4-e5f6-7890-abcd-ef1234567890/disable_port/ \
  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_ports import openstack_ports_disable_port # (1)

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

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

try {
  const response = await openstackPortsDisablePort({
  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 - No response body

Disable port security for the port

Disable port security for the port

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-ports/a1b2c3d4-e5f6-7890-abcd-ef1234567890/disable_port_security/ \
  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_ports import openstack_ports_disable_port_security # (1)

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

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

try {
  const response = await openstackPortsDisablePortSecurity({
  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 - No response body

Enable port

Enable port.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-ports/a1b2c3d4-e5f6-7890-abcd-ef1234567890/enable_port/ \
  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_ports import openstack_ports_enable_port # (1)

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

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

try {
  const response = await openstackPortsEnablePort({
  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 - No response body

Enable port security for the port

Enable port security for the port

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-ports/a1b2c3d4-e5f6-7890-abcd-ef1234567890/enable_port_security/ \
  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_ports import openstack_ports_enable_port_security # (1)

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

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

try {
  const response = await openstackPortsEnablePortSecurity({
  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 - No response body