getIpv4Baremetal
Bare Metal IPv4 Addresses
Details
- Method:
GET - Path:
/bare-metals/{baremetal-id}/ipv4 - Operation ID:
get-ipv4-baremetal
Parameters
{}Response Schema
{
"type": "object",
"properties": {
"ipv4s": {
"type": "array",
"items": {
"title": "baremetal-ipv4",
"type": "object",
"x-tags": [
"baremetal"
],
"description": "Bare Metal IPv4 information.",
"x-examples": {
"ipv4 example": {
"ip": "192.0.2.123",
"netmask": "255.255.254.0",
"gateway": "192.0.2.123",
"type": "main_ip",
"reverse": "192.0.2.123.vultr.com",
"mac_address": "00:00:5e:00:53:5e"
}
},
"properties": {
"ip": {
"type": "string",
"description": "The IPv4 address."
},
"netmask": {
"type": "string",
"description": "The IPv4 netmask in dot-decimal notation."
},
"gateway": {
"type": "string",
"description": "The gateway IP address."
},
"type": {
"type": "string",
"description": "The type of IP address.\n\n* main_ip"
},
"reverse": {
"type": "string",
"description": "The reverse DNS information for this IP address."
},
"mac_address": {
"type": "string",
"description": "The MAC address associated with this IP address."
}
}
}
},
"meta": {
"title": "meta",
"type": "object",
"x-examples": {
"meta response": {
"meta": {
"total": 31,
"links": {
"next": "WxYzExampleNext",
"prev": ""
}
}
}
},
"description": "The meta information object. See [Meta and Pagination](#section/Introduction/Meta-and-Pagination) for more information.",
"properties": {
"total": {
"type": "integer",
"description": "Total objects available in the list. This value may be greater than the number of objects returned if `per_page` is set."
},
"links": {
"type": "object",
"description": "Cursor values for pagination.",
"properties": {
"next": {
"type": "string",
"description": "Cursor value for the next page."
},
"prev": {
"type": "string",
"description": "Cursor value for the previous page."
}
}
}
}
}
}
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('vultr')
# Call this tool
result = await agent.call_tool('getIpv4Baremetal', {
# Add required parameters here
})