Firewall¶
This page describes operations you can perform on firewalls. List, create, get details for, update, and delete.
List Firewall¶
List all visible firewalls.
Synchronous / Asynchronous¶
- Synchronous
Request¶
HTTP Request Method¶
- GET
HTTP Request Path¶
{endpoint}/v2.0/firewalls
HTTP Request Parameters¶
Parameter | Style | Type | Format | Enumeration | Description | Required |
---|---|---|---|---|---|---|
admin_username | query | string | - | - | Username with admin access to VM instance | no |
availability_zone | query | string | - | - | Availability Zone, this can be referred to using Virtual Server (Nova)’s list availability zones | no |
default_gateway | query | string | ipv4 | - | IP address of default gateway | no |
description | query | string | - | - | Description of the Firewall | no |
firewall_plan_id | query | string | hyph-uuid | - | Firewall Plan | no |
id | query | string | hyph-uuid | - | Unique ID of the Firewall | no |
name | query | string | - | - | Name of the Firewall | no |
status | query | string | - | - | The Firewall status. | no |
tenant_id | query | string | non-hyph-uuid | - | Tenant ID of the owner (UUID) | no |
user_username | query | string | - | - | Username with user access to VM instance | no |
Response¶
HTTP Response Code List¶
Response Code | Description |
---|---|
200 | OK |
400 | Bad Request |
401 | UnAuthorized |
404 | Not Found |
500 | Internal Server Error |
HTTP Response Parameters¶
Parameter | Type | Format | Description |
---|---|---|---|
firewalls | array<object> | Firewall | - |
admin_username | string | - | Username with admin access to VM instance |
availability_zone | string | - | Availability Zone, this can be referred to using Virtual Server (Nova)’s list availability zones |
default_gateway | string | ipv4 | IP address of default gateway |
description | string | - | Description of the Firewall |
firewall_plan_id | string | hyph-uuid | Firewall Plan |
id | string | hyph-uuid | Unique ID of the Firewall |
name | string | - | Name of the Firewall |
status | string | - | The Firewall status. |
tenant_id | string | non-hyph-uuid | Tenant ID of the owner (UUID) |
user_username | string | - | Username with user access to VM instance |
Examples¶
Sample Request Body¶
This operation does not send a request body.
Sample Response Body¶
{
"firewalls": [
{
"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",
"name": "abcdefghijklmnopqrstuvwxyz",
"status": "ACTIVE",
"tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
"user_username": "user-read"
},
{
"admin_username": "user-admin",
"availability_zone": null,
"default_gateway": "192.168.1.1",
"description": "",
"firewall_plan_id": "2b757ea7-f346-4297-a598-4d054bc0ae58",
"id": "601665cf-c161-4e80-87f0-a3c0925d07a0",
"name": "isb_admin1_20151214",
"status": "ACTIVE",
"tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
"user_username": "user-read"
}
]
}
Create Firewall¶
Create firewall.
Synchronous / Asynchronous¶
- Asynchronous
Request¶
HTTP Request Method¶
- POST
HTTP Request Path¶
{endpoint}/v2.0/firewalls
HTTP Request Parameters¶
Parameter | Style | Type | Format | Enumeration | Default | Description | Required |
---|---|---|---|---|---|---|---|
firewall | plain | object | Firewall | - | - | - | yes |
availability_zone | plain | string | - | - | null | Availability Zone, this can be referred to using Virtual Server (Nova)’s list availability zones | no |
default_gateway | plain | string | ipv4 | - | null | IP address of default gateway | no |
description | plain | string | - | - | “” | Description of the Firewall | no |
firewall_plan_id | plain | string | hyph-uuid | - | - | Firewall Plan | yes |
name | plain | string | - | - | “” | Name of the Firewall | no |
tenant_id | plain | string | non-hyph-uuid | - | See notes. | Tenant ID of the owner (UUID) | no |
Note
tenant_id: The ID of default tenant to which user belongs.
Response¶
HTTP Response Code List¶
Response Code | Description |
---|---|
200 | OK |
400 | Bad Request |
401 | UnAuthorized |
404 | Not Found |
409 | Conflict |
500 | Internal Server Error |
HTTP Response Parameters¶
Parameter | Type | Format | Description |
---|---|---|---|
firewall | object | Firewall | - |
admin_password | string | - | Password for admin |
admin_username | string | - | Username with admin access to VM instance |
availability_zone | string | - | Availability Zone, this can be referred to using Virtual Server (Nova)’s list availability zones |
default_gateway | string | ipv4 | IP address of default gateway |
description | string | - | Description of the Firewall |
firewall_plan_id | string | hyph-uuid | Firewall Plan |
id | string | hyph-uuid | Unique ID of the Firewall |
interfaces | array<object> | - | Attached interfaces |
id | string | - | - |
ip_address | string | - | - |
name | string | - | - |
network_id | string | - | - |
slot_number | integer | - | - |
status | string | - | - |
name | string | - | Name of the Firewall |
status | string | - | The Firewall status. |
tenant_id | string | non-hyph-uuid | Tenant ID of the owner (UUID) |
user_password | string | - | Password for user |
user_username | string | - | Username with user access to VM instance |
Examples¶
Sample Request Body¶
{
"firewall": {
"availability_zone": "zone1-groupa",
"default_gateway": null,
"description": "abcdefghijklmnopqrstuvwxyz",
"firewall_plan_id": "bd12784a-c66e-4f13-9f72-5143d64762b6",
"name": "abcdefghijklmnopqrstuvwxyz",
"tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
}
}
Sample Response Body¶
{
"firewall": {
"admin_password": "ABCDabcd1234",
"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": "PENDING_CREATE",
"tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
"user_password": "ABCDabcd1234",
"user_username": "user-read"
}
}
Show Firewall¶
Show details for firewall.
Synchronous / Asynchronous¶
- Synchronous
Request¶
HTTP Request Method¶
- GET
HTTP Request Path¶
{endpoint}/v2.0/firewalls/{firewall_id}
HTTP Request Parameters¶
Parameter | Style | Type | Format | Enumeration | Description | Required |
---|---|---|---|---|---|---|
firewall_id | URI | string | hyph-uuid | - | Unique ID of the Firewall | yes |
Response¶
HTTP Response Code List¶
Response Code | Description |
---|---|
200 | OK |
400 | Bad Request |
401 | UnAuthorized |
404 | Not Found |
500 | Internal Server Error |
HTTP Response Parameters¶
Parameter | Type | Format | Description |
---|---|---|---|
firewall | object | Firewall | - |
admin_username | string | - | Username with admin access to VM instance |
availability_zone | string | - | Availability Zone, this can be referred to using Virtual Server (Nova)’s list availability zones |
default_gateway | string | ipv4 | IP address of default gateway |
description | string | - | Description of the Firewall |
firewall_plan_id | string | hyph-uuid | Firewall Plan |
id | string | hyph-uuid | Unique ID of the Firewall |
interfaces | array<object> | - | Attached interfaces |
id | string | - | - |
ip_address | string | - | - |
name | string | - | - |
network_id | string | - | - |
slot_number | integer | - | - |
status | string | - | - |
name | string | - | Name of the Firewall |
status | string | - | The Firewall status. |
tenant_id | string | non-hyph-uuid | Tenant ID of the owner (UUID) |
user_username | string | - | Username with user access to VM instance |
Examples¶
Sample Request Body¶
This operation does not send a request body.
Sample Response Body¶
{
"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"
}
}
Update Firewall¶
Update firewall.
Synchronous / Asynchronous¶
- Asynchronous
Request¶
HTTP Request Method¶
- PUT
HTTP Request Path¶
{endpoint}/v2.0/firewalls/{firewall_id}
HTTP Request Parameters¶
Parameter | Style | Type | Format | Enumeration | Description | Required |
---|---|---|---|---|---|---|
firewall_id | URI | string | hyph-uuid | - | Unique ID of the Firewall | yes |
firewall | plain | object | Firewall | - | - | yes |
default_gateway | plain | string | ipv4 | - | IP address of default gateway | no |
description | plain | string | - | - | Description of the Firewall | no |
firewall_plan_id | plain | string | hyph-uuid | - | Firewall Plan | no |
name | plain | string | - | - | Name of the Firewall | no |
Response¶
HTTP Response Code List¶
Response Code | Description |
---|---|
200 | OK |
400 | Bad Request |
401 | UnAuthorized |
404 | Not Found |
409 | Conflict |
500 | Internal Server Error |
HTTP Response Parameters¶
Parameter | Type | Format | Description |
---|---|---|---|
firewall | object | Firewall | - |
admin_username | string | - | Username with admin access to VM instance |
availability_zone | string | - | Availability Zone, this can be referred to using Virtual Server (Nova)’s list availability zones |
default_gateway | string | ipv4 | IP address of default gateway |
description | string | - | Description of the Firewall |
firewall_plan_id | string | hyph-uuid | Firewall Plan |
id | string | hyph-uuid | Unique ID of the Firewall |
interfaces | array<object> | - | Attached interfaces |
id | string | - | - |
ip_address | string | - | - |
name | string | - | - |
network_id | string | - | - |
slot_number | integer | - | - |
status | string | - | - |
name | string | - | Name of the Firewall |
status | string | - | The Firewall status. |
tenant_id | string | non-hyph-uuid | Tenant ID of the owner (UUID) |
user_username | string | - | Username with user access to VM instance |
Examples¶
Sample Request Body¶
{
"firewall": {
"default_gateway": null,
"description": "abcdefghijklmnopqrstuvwxyz",
"firewall_plan_id": "bd12784a-c66e-4f13-9f72-5143d64762b6",
"name": "abcdefghijklmnopqrstuvwxyz"
}
}
Sample Response Body¶
{
"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": "PENDING_UPDATE",
"tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
"user_username": "user-read"
}
}
Delete Firewall¶
Delete firewall.
Synchronous / Asynchronous¶
- Asynchronous
Request¶
HTTP Request Method¶
- DELETE
HTTP Request Path¶
{endpoint}/v2.0/firewalls/{firewall_id}
HTTP Request Parameters¶
Parameter | Style | Type | Format | Enumeration | Description | Required |
---|---|---|---|---|---|---|
firewall_id | URI | string | hyph-uuid | - | Unique ID of the Firewall | yes |