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"
},
"publicIP": {
"type": "string",
"description": "Public IP",
"readonly": true
},
"ipKind": {
"type": "string",
"required": true,
"enum": [
"EXCLUSIVE",
"SHARED"
]
}
}
}
The APS type is used to manage a collection of APS resources. To get a list of resources from that collection, use the following API call:
GET /aps/2/collections/pa-ip-addresses?<RQL-filter>
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
---|---|---|---|---|
poolId |
Integer |
Not Required |
Unique identifier of the IP address pool the IP address belongs to. |
|
publicIP |
String |
Not Required Read Only |
The public network IP which is mapped to frontnetIP address. This property is not null if in IP Translation screen exist translation which has frontnetIP that is equal to address prop of this type. |
|
ipKind |
Enum |
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
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.
|
NAME |
TYPE |
REQUIRED |
DESCRIPTION |
---|---|---|---|
subscription |
Yes |
The subscription used to create the IP address. |
|
host |
No |
The host the IP address is bound to. |