PHP Class Scalr\Service\CloudStack\DataType\IpAddressResponseData

Since: 4.5.2
Author: Vlad Dobrovolskiy ([email protected])
Inheritance: extends Scalr\Service\CloudStack\DataType\JobStatusData
Show file Open project: scalr/scalr

Public Properties

Property Type Description
$account string The account the public IP address is associated with
$allocated DateTime Date the public IP address was acquired
$associatednetworkid string The ID of the Network associated with the IP address
$associatednetworkname string The name of the Network associated with the IP address
$domain string The domain the public IP address is associated with
$domainid string The domain ID the public IP address is associated with
$forvirtualnetwork string The virtual network for the IP address
$id string Public IP address id
$ipaddress string Public IP address
$isportable string Is public IP portable across the zones
$issourcenat string True if the IP address is a source nat address, false otherwise
$isstaticnat string True if this ip is for static nat, false otherwise
$issystem string True if this ip is system ip (was allocated as a part of deployVm or createLbRule)
$networkid string The ID of the Network where ip belongs to
$physicalnetworkid string The physical network this belongs to
$project string The project name of the address
$projectid string The project id of the ipaddress
$purpose string In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value
$state string State of the ip address. Can be: Allocatin, Allocated and Releasing
$virtualmachinedisplayname string Virutal machine display name the ip address is assigned to (not null only for static nat Ip)
$virtualmachineid string Virutal machine id the ip address is assigned to (not null only for static nat Ip)
$virtualmachinename string Virutal machine name the ip address is assigned to (not null only for static nat Ip)
$vlanid string This parameter is visible to ROOT admins only
$vlanname string The VLAN associated with the IP address
$vmipaddress string Virutal machine (dnat) ip address (not null only for static nat Ip)
$vpcid string VPC the ip belongs to
$zoneid string The ID of the zone the public IP address belongs to
$zonename string The name of the zone the public IP address belongs to

Protected Properties

Property Type Description
$_properties array List of the public properties which is managed by magic getter and setters internally.

Public Methods

Method Description
setTags ( Scalr\Service\CloudStack\DataType\ResponseTagsList $tags = null ) : IpAddressResponseData Sets tags

Method Details

setTags() public method

Sets tags
public setTags ( Scalr\Service\CloudStack\DataType\ResponseTagsList $tags = null ) : IpAddressResponseData
$tags Scalr\Service\CloudStack\DataType\ResponseTagsList
return IpAddressResponseData

Property Details

$_properties protected property

List of the public properties which is managed by magic getter and setters internally.
protected array $_properties
return array

$account public property

The account the public IP address is associated with
public string $account
return string

$allocated public property

Date the public IP address was acquired
public DateTime $allocated
return DateTime

$associatednetworkid public property

The ID of the Network associated with the IP address
public string $associatednetworkid
return string

$associatednetworkname public property

The name of the Network associated with the IP address
public string $associatednetworkname
return string

$domain public property

The domain the public IP address is associated with
public string $domain
return string

$domainid public property

The domain ID the public IP address is associated with
public string $domainid
return string

$forvirtualnetwork public property

The virtual network for the IP address
public string $forvirtualnetwork
return string

$id public property

Public IP address id
public string $id
return string

$ipaddress public property

Public IP address
public string $ipaddress
return string

$isportable public property

Is public IP portable across the zones
public string $isportable
return string

$issourcenat public property

True if the IP address is a source nat address, false otherwise
public string $issourcenat
return string

$isstaticnat public property

True if this ip is for static nat, false otherwise
public string $isstaticnat
return string

$issystem public property

True if this ip is system ip (was allocated as a part of deployVm or createLbRule)
public string $issystem
return string

$networkid public property

The ID of the Network where ip belongs to
public string $networkid
return string

$physicalnetworkid public property

The physical network this belongs to
public string $physicalnetworkid
return string

$project public property

The project name of the address
public string $project
return string

$projectid public property

The project id of the ipaddress
public string $projectid
return string

$purpose public property

In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value
public string $purpose
return string

$state public property

State of the ip address. Can be: Allocatin, Allocated and Releasing
public string $state
return string

$virtualmachinedisplayname public property

Virutal machine display name the ip address is assigned to (not null only for static nat Ip)
public string $virtualmachinedisplayname
return string

$virtualmachineid public property

Virutal machine id the ip address is assigned to (not null only for static nat Ip)
public string $virtualmachineid
return string

$virtualmachinename public property

Virutal machine name the ip address is assigned to (not null only for static nat Ip)
public string $virtualmachinename
return string

$vlanid public property

This parameter is visible to ROOT admins only
public string $vlanid
return string

$vlanname public property

The VLAN associated with the IP address
public string $vlanname
return string

$vmipaddress public property

Virutal machine (dnat) ip address (not null only for static nat Ip)
public string $vmipaddress
return string

$vpcid public property

VPC the ip belongs to
public string $vpcid
return string

$zoneid public property

The ID of the zone the public IP address belongs to
public string $zoneid
return string

$zonename public property

The name of the zone the public IP address belongs to
public string $zonename
return string