This type is used to create and manage the IP address resources. For example, to allocate an IP address (POST operation), specify the exact IP address in the ‘address’ property, which is inherited from the IPAddress type. To allocate any IP address from an IP pool, specify ‘0.0.0.0’ (IPv4) or ‘0.0.0.0.0.0’ (IPv6), or simply omit the ‘address’ property.
In this document:
The considered APS type (download)
extends the IPAddress APS type(s) and looks as follows:
{
"name": "PAIPAddress",
"id": "http://www.parallels.com/pa/pa-core-services/ip-management/PAIPAddress/1.0",
"apsVersion": "2.0",
"implements": [
"http://aps-standard.org/types/ip-address/1.0"
],
"relations": {
"subscription": {
"type": "http://parallels.com/aps/types/pa/subscription/1.0",
"required": true
},
"host": {
"type": "http://www.parallels.com/pa/pa-core-services/host-management/Host/1.0"
}
},
"properties": {
"poolId": {
"type": "integer",
"description": "IP pool for allocating IP"
},
"ipKind": {
"type": "string",
"required": true,
"enum": [
"EXCLUSIVE",
"SHARED"
]
}
}
}
| NAME | TYPE | ATTRIBUTES | DEFAULT | DESCRIPTION |
|---|---|---|---|---|
| ipKind | enum IPKind | Required | IP address allocation type. Values can be either ‘SHARED’ or ‘EXCLUSIVE’. IP address of the ‘EXCLUSIVE’ type can belong to a single subscription, while one of the ‘SHARED’ type can belong to many subscriptions at a time | |
| poolId | Integer | Not Required | Unique identifier of the IP address pool the IP address belongs to. |
| NAME | TYPE | REQUIRED | DESCRIPTION |
|---|---|---|---|
| host | Host | No | The host the IP address is bound to. |
| subscription | PASubscription | Yes | The subscription used to create the IP address. |
| NAME | VALUES | DESCRIPTION |
|---|---|---|
| IPKind |
|
IP address of the ‘EXCLUSIVE’ type can belong to a single subscription, while one of the ‘SHARED’ type can belong to many subscriptions at a time. |