StaticIPAddressPool [SPFSDK][VMMREF]
Applies To: Windows Azure Pack
The StaticIPAddressPool entity represents static IP address pool.
Inheritance Hierarchy
VMM
StaticIPAddressPool
Entity Properties
For more information about how the properties of an entity interact with HTTP operations, see Entity Basics.
Name |
Create (POST) |
Read (GET) |
Update (PUT) |
Delete (DELETE) |
Type |
Nullable |
Description |
|---|---|---|---|---|---|---|---|
ID |
- |
Optional |
Required |
Required |
Edm.Guid |
False |
Key Property The identifier of the entity. |
StampId |
Required |
Optional |
Required |
Required |
Edm.Guid |
False |
Key Property The identifier of the stamp that contains the entity. |
AddressFamily |
- |
Optional |
- |
- |
Edm.String |
True |
The type of IP addresses for the pool. Either InterNetwork (IPv4) or InterNetworkV6 (IPv6). |
AvailableAddresses |
- |
Optional |
- |
- |
Edm.Decimal |
True |
Total number of addresses available for allocation from the pool. |
AvailableDIPAddresses |
- |
Optional |
- |
- |
Edm.Decimal |
True |
Number of DIP (Dedicated IP) addresses available for allocation from the pool. |
AvailableVIPAddresses |
- |
Optional |
- |
- |
Edm.Decimal |
True |
Number of VIP (Virtual IP) addresses available for allocation from the pool. |
DefaultGatewayIPAddresses |
- |
Optional |
- |
- |
Collection(Edm.String) |
False |
Zero or more IP addresses to use as the default gateway. |
Description |
Optional |
Optional |
Optional |
- |
Edm.String |
True |
The description of the static IP address object. |
DNSSearchSuffixes |
Optional |
Optional |
Optional |
- |
Collection(Edm.String) |
False |
Zero or more strings that are appended to a host name to resolve a Domain Name System (DNS) address. |
DNSServers |
Optional |
Optional |
Optional |
- |
Collection(Edm.String) |
False |
The IP address of one or more DNS servers. |
DNSSuffix |
Optional |
Optional |
Optional |
- |
Edm.String |
True |
The default DNS suffix. |
EnableNetBIOS |
Optional |
Optional |
Optional |
- |
Edm.Boolean |
True |
Indicates whether NetBIOS over TCP/IP is enabled. |
ExternalId |
- |
Optional |
- |
- |
Edm.Guid |
True |
If the pool is provided by an external network manager, this represents the unique ID for the pool generated by the network manager. |
ExternalSyncTime |
- |
Optional |
- |
- |
Edm.DateTime |
True |
If the pool is provided by an external network manager, this represents the last time the pool was modified by the network manager. |
IPAddressRangeEnd |
Optional |
Optional |
Optional |
- |
Edm.String |
True |
The last IP address in a range of IP addresses. |
IPAddressRangeStart |
Optional |
Optional |
Optional |
- |
Edm.String |
True |
The first IP address in a range of IP addresses. |
IPAddressReservedSet |
Optional |
Optional |
Optional |
- |
Edm.String |
True |
A set of IP addresses within an IP subnet that is reserved for other use. |
IsFullyCached |
- |
Optional |
- |
- |
Edm.Boolean |
True |
If true, the data for this object and all of its child objects has been cached on the client. |
IsIPv4 |
- |
Optional |
- |
- |
Edm.Boolean |
True |
Indicates that the IP address pool is IPv4 |
IsMulticastPool |
- |
Optional |
- |
- |
Edm.Boolean |
True |
Whether the IP address pool contains a multicast IP address range. |
IsViewOnly |
- |
Optional |
- |
- |
Edm.Boolean |
True |
Whether or not this pool is read-only. |
LogicalNetworkDefinitionId |
Optional |
Optional |
- |
- |
Edm.Guid |
True |
The identifier of a logical network. |
MarkedForDeletion |
- |
Optional |
- |
- |
Edm.Boolean |
True |
Indicates that this object has flagged to be deleted by VMM. |
Name |
Required |
Optional |
Optional |
- |
Edm.String |
True |
The name of the entity. |
NetworkEntityAccessType |
- |
Optional |
- |
- |
Edm.String |
True |
Access state of pool. |
ReservedAddresses |
- |
Optional |
- |
- |
Edm.Decimal |
True |
Number of addresses reserved in the pool. |
Subnet |
Required |
Optional |
- |
- |
Edm.String |
True |
The IPv4 or IPv6 address of the subnet in Classless Inter-Domain Routing (CIDR) notation. |
TotalAddresses |
- |
Optional |
- |
- |
Edm.Decimal |
True |
Total number of addresses managed by the pool. |
TotalDIPAddresses |
- |
Optional |
- |
- |
Edm.Decimal |
True |
Total number of DIP (Dedicated IP) addresses managed by the pool. |
TotalVIPAddresses |
- |
Optional |
- |
- |
Edm.Decimal |
True |
Total number of VIP (Virtual IP) addresses managed by the pool. |
UnassignedAddresses |
- |
Optional |
- |
- |
Edm.Decimal |
True |
Total number of unassigned addresses in the pool. |
UnassignedDIPAddresses |
- |
Optional |
- |
- |
Edm.Decimal |
True |
Number of unassigned DIP (Dedicated IP) addresses in the pool. |
UnassignedVIPAddresses |
- |
Optional |
- |
- |
Edm.Decimal |
True |
Number of unassigned VIP (Virtual IP) addresses from the pool. |
VIPAddressSet |
Optional |
Optional |
Optional |
- |
Edm.String |
True |
A set of IP addresses within an IP subnet that is reserved for configuring virtual IPs (VIPs) in load balancers. |
VLanID |
- |
Optional |
- |
- |
Edm.Int32 |
True |
Identifies a Vlan. |
VMSubnetId |
Optional |
Optional |
- |
- |
Edm.Guid |
True |
The ID of the virtual machine subnet. |
WINSServers |
Optional |
Optional |
Optional |
- |
Collection(Edm.String) |
False |
The IPv4 or IPv6 address of zero or more Windows Internet Name Service (WINS) servers. |
Relationships
None
OData Operations
None
Examples
See Also
Entities [SPFSDK][VMMREF]
StaticIPAddressPools Collection [SPFSDK][VMMREF]