getLoadbalancerFirewallRule
Get Firewall Rule
Details
- Method:
GET - Path:
/load-balancers/{loadbalancer-id}/firewall-rules/{firewall-rule-id} - Operation ID:
get-loadbalancer-firewall-rule
Parameters
{}Response Schema
{
"description": "Load Balancer firewall rule information.",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"description": "The unique ID for the firewall rule"
},
"port": {
"type": "integer",
"description": "Port for this rule.\n"
},
"source": {
"type": "string",
"minLength": 1,
"description": "If the source string is given a value of \"cloudflare\" then cloudflare IPs will be supplied. Otherwise enter a IP address with subnet size that you wish to permit through the firewall.\n\nPossible values:\n\n| | Value | Description |\n| - | ------ | ------------- |\n| | \"192.168.1.1/16\" | Ip address with a subnet size. |\n| | cloudflare | Allow all of Cloudflare's IP space through the firewall |"
},
"ip_type": {
"type": "string",
"minLength": 1,
"description": "The type of IP rule.\n\n* v4\n* v6\n"
}
},
"x-examples": {
"Example": {
"id": "9fea55b93016eafb",
"port": 80,
"source": "192.168.1.1/16",
"ip_type": "v4"
}
}
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('vultr')
# Call this tool
result = await agent.call_tool('getLoadbalancerFirewallRule', {
# Add required parameters here
})