IPAddress

A resource of the “IPAddress” type represents an IPv6 or IPv4 address.

The IPAdress type schema: download

   {
      "apsVersion": "2.0",

      "name": "IPAddress",

      "id": "http://aps-standard.org/types/ip-address/1.1",
      "implements": [ "http://aps-standard.org/types/core/resource/1.0" ],

      "properties": {
         "address": {
            "type": "string",
            "format": "ip-address",
            "required": true
         },
         
         "netmask": {
            "type": "string",
            "required": true
         },
         
         "gateway": {
            "type": "string"
         },
         
         "type": {
            "type": "string",
            "required": true
         },
         
         "private": {
             "type": "boolean",
             "required": false
         }
      }
   }

The properties have to be filled with the following data:

Property	Description
type	IP address type. Either IPv4 or IPv6
address	IP address
netmask	Subnet netmask in CIDR notation, see http://tools.ietf.org/html/rfc4632
gateway	Gateway host
private	If true, the IP address is private, otherwise it is public

When an IP address resource is allocated to a host, the APS controller forwards the IP properties to the platform that manages the host. If private is true, the IP address must be assigned to the interface connected to the private network. Otherwise, it is assigned to the interface connected to the public network.

← ResellerProfile

Multi-Language String →