StaticIPAddressPools
Applies To: System Center 2016 - Service Provider Foundation, System Center Technical Preview
StaticIPAddressPools
Manages static IP address pools for Virtual Machine Manager (VMM).
HTTP Verbs
| GET | POST | PUT | DELETE |
|---|---|---|---|
| Yes | Yes | No | Yes |
GET
Reads static IP pool objects from VMM.
If you supply the ID property, the static IP address pool with that identifier is returned.
If you supply the Name property, the static IP address pool with that name is returned.
If you supply the LogicalNetworkDefinitionId property, the static IP address pools that are contained in any subnet of the identified logical network definition are returned.
Entity Properties
| Name | Type | Mandatory | Description |
|---|---|---|---|
| StampId | Edm.Guid | Yes | The identifier of the stamp to restrict the query to |
| Name | Edm.String | No | The name of the static IP address pool object |
| ID | Edm.Guid | No | The identifier of the static IP address pool object |
| LogicalNetworkDefinitionId | Edm.Guid | No | The identifier of a logical network |
POST
Creates a new static IP address pool.
Entity Properties
| Name | Type | Mandatory | Description |
|---|---|---|---|
| StampId | Edm.Guid | Yes | The identifier of the stamp to restrict the query to |
| Name | Edm.String | Yes | The name of the static IP address pool |
| Subnet | Edm.String | No | Specifies an IP subnet (IPv4 or IPv6) in Classless Inter-Domain Routing (CIDR) notation. Example format for an IPv4 subnet: 192.168.0.1/24 Example format for an IPv6 subnet: FD4A:29CD:184F:3A2C::/64 |
| VMSubnetId | Edm.Guid | No | Identifier of the virtual machine subnet |
| DefaultGatewayIPAddresses | Edm.String[] | Yes | IP addresses to use as the default gateway. Collection may be empty. |
| Description | Edm.String | No | The description of the static IP address object |
| DNSSearchSuffixes | Edm.String[] | Yes | Specifies one or more strings that are appended to a host name to resolve a Domain Name System (DNS) address. Collection may be empty. |
| DNSServers | Edm.String[] | Yes | Specifies the IP address of one or more DNS servers. Valid formats are either an IPv4 or IPv6 address. Collection may be empty. |
| DNSSuffix | Edm.String | No | Specifies the default DNS suffix. |
| EnableNetBIOS | Edm.Boolean | No | Indicates whether NetBIOS over TCP/IP is enabled. |
| IPAddressRangeEnd | Edm.String | No | Specifies the last IP address in a range of IP addresses. |
| IPAddressRangeStart | Edm.String | No | Specifies the first IP address in a range of IP addresses. |
| IPAddressReservedSet | Edm.String | No | Specifies a set of IP addresses within an IP subnet that is reserved for other use. |
| VIPAddressSet | Edm.String | No | Specifies a set of IP addresses within an IP subnet that is reserved for configuring virtual IPs (VIPs) in load balancers. |
| WINSServers | Edm.String[] | Yes | Specifies the IP address of one or more Windows Internet Name Service (WINS) servers. Valid formats are either an IPv4 or IPv6 address. Collection may be empty. |
| LogicalNetworkDefinitionId | Edm.Guid | No | The identifier of a logical network. |
DELETE
Deletes a static IP address pool object.
Entity Properties
| Name | Type | Description | |
|---|---|---|---|
| StampId | Edm.Guid | The identifier of the stamp to restrict the query to | |
| ID | Edm.Guid | The identifier of the static IP address pool object to delete |