Advanced Firewall¶
Entity¶
Advanced firewall¶
Field |
Explanation |
|---|---|
id |
advanced firewall identifier |
status |
Status of the advanced firewall (offline, online) |
locked |
Is advanced firewall busy with an operation? |
hostname |
advanced firewall hostname |
template_id |
advanced firewall template id |
required_startup |
Is required to restart advanced firewall? |
cluster_id |
cluster identifier |
user_id |
user identifier |
vlan |
virtual LAN identifier |
location_id |
location identifier |
manager_url |
firewall manager URL (if FEATURE_FIREWALL_MANAGER) |
Advanced firewall list:
Operations¶
List advanced firewall¶
- Method
GET
- Url
/advanced_firewalls
- Success Code
200
- Returned Data
- Has Token
No
List all advanced firewalls in your account
Filters:
id: advanced firewall identifier.
status: advanced firewall status (online, offline)
locked: Is advanced firewall busy with an operation?
hostname: advanced firewall name
cluster_id: Cluster identifier
user_id: User identifier
vlan~: Filter by VLAN identifier
location_id: Location identifier
Get advanced firewall¶
- Method
GET
- Url
/advanced_firewall/<id>
- Success Code
200
- Returned Data
- Has Token
No
Get advanced_firewall resource.
Modify advanced firewall¶
- Method
PUT
- Url
/advanced_firewall/<id>
- Success Code
200
- Returned Data
- Has Token
No
Modify advanced firewall resource.
Optional parameters:
template_id: Template id to reinstall
required_startup: Start up the advanced firewall when it finishes
status: Modify the status for (online, offline)
cluster: Enable or disable clustering (0 or 1)
hostname: advanced firewall hostname
manager_url: Firewall manager URL (when FEATURE_FIREWALL_MANAGER)
List network interfaces¶
- Method
GET
- Url
/advanced_firewall/<id>/network_interfaces
- Success Code
200
- Returned Data
:
- Has Token
No
List network interfaces plug to the advanced firewall
Rebuild network¶
- Method
POST
- Url
/advanced_firewall/<id>/rebuild_network
- Success Code
200
- Returned Data
None
- Has Token
No
Rebuild network of advanced firewall
Reboot advanced firewall¶
- Method
POST
- Url
/advanced_firewall/<id>/reboot
- Success Code
200
- Returned Data
None
- Has Token
No
Reboot advanced firewall
Create network interface¶
- Method
POST
- Url
/advanced_firewall/<id>/network_interface
- Success Code
200
- Returned Data
- Has Token
No
Create interface to the virtual machine.
Get bandwidth stats¶
- Method
GET
- Url
/advanced_firewall/<id>/bw_stats
- Success Code
200
- Returned Data
None
- Has Token
No
Bandwidth stats of advanced firewall
Get cpu stats¶
- Method
GET
- Url
/advanced_firewall/<id>/cpu_stats
- Success Code
200
- Returned Data
None
- Has Token
No
CPU load stats of advanced firewall
Put segregation¶
- Method
PUT
- Url
/advanced_firewall/<origin_id>/segregation/<target_id>
- Success Code
200
- Returned Data
None
- Has Token
No
Segregate from a virtual machine id
Delete segregation¶
- Method
DELETE
- Url
/advanced_firewall/<origin_id>/segregation/<target_id>
- Success Code
200
- Returned Data
None
- Has Token
No
Delete segregation from a virtual machine id
Get IP addresses¶
- Method
GET
- Url
/advanced_firewall/<id>/ip_addresses
- Success Code
200
- Returned Data
None
- Has Token
No
Get the list of IP addresses of advanced firewall
Filters:
network_id: IP addresses by a selected network
interface_id: IP addresses by a selected interface
network_interface_id: IP addresses by a selected network interface
public: Filter public or private IPs