StaticIPAddressPool

System Center
 

Updated: June 27, 2017

Applies To: System Center 2016 - Service Provider Foundation, System Center Technical Preview

Manages static IP address pools for Virtual Machine Manager (VMM).

GETPOSTPUTDELETE
YesYesNoYes

GET

Gets the specified static IP pool objects from Virtual Machine Manager (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

NameTypeMandatoryDescription
StampIdEdm.GuidYesThe identifier of the stamp that restricts the query.
NameEdm.StringNoThe name of the static IP address pool object.
IDEdm.GuidNoThe identifier of the static IP address pool object.
LogicalNetworkDefinitionIdEdm.GuidNoThe identifier of a logical network.
IPAddressEdm.StringNoAn IP address
IPv4Edm.Int16NoTBD
IPv6Edm.Int16NoTBD
CloudIdEdm.GuidNoAn identifier of a cloud.
VMHostGroupEdm.StringNoA virtual machine host group.

POST

Creates a new static IP address pool.

Entity Properties

NameTypeMandatoryDescription
StampIdEdm.GuidYesThe identifier of the stamp that restricts the query.
NameEdm.StringYesThe name of the static IP address pool.
SubnetEdm.StringNoSpecifies 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
VMSubnetNameEdm.StringNoThe name of the virtual machine subnet.
DefaultGatewayIPAddressesEdm.String[]YesIP addresses to use as the default gateway.

 Collection may be empty.
DescriptionEdm.StringNoThe description of the static IP address object.
DNSSearchSuffixesEdm.String[]NoSpecifies one or more strings that are appended to a host name to resolve a Domain Name System (DNS) address.

 Collection may be empty.
DNSServersEdm.String[]NoSpecifies the IP address of one or more DNS servers. Valid formats are either an IPv4 or IPv6 address.

 Collection may be empty.
DNSSuffixEdm.StringNoSpecifies the default DNS suffix.
EnableNetBIOSEdm.BooleanNoIndicates whether NetBIOS over TCP/IP is enabled.
IPAddressRangeEndEdm.StringNoSpecifies the last IP address in a range of IP addresses.
IPAddressRangeStartEdm.StringNoSpecifies the first IP address in a range of IP addresses.
IPAddressReservedSetEdm.StringNoSpecifies a set of IP addresses within an IP subnet that is reserved for other use.
VIPAddressSetEdm.StringNoSpecifies a set of IP addresses within an IP subnet that is reserved for configuring virtual IPs (VIPs) in load balancers.
WINSServerEdm.StringNoSpecifies 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.
LogicalNetworkDefinitionIdEdm.GuidNoThe identifier of a logical network.
DefaultGatewayCollection(Edm.String)NoTBD
PROTipIDEdm.GuidNoSpecifies the ID of the PRO tip that triggered this action. This enables the auditing of PRO tips.

DELETE

Deletes a static IP address pool object.

Entity Properties

NameTypeMandatoryDescription
StampIdEdm.GuidYesThe identifier of the stamp that restricts the query.
IDEdm.GuidYesThe identifier of the static IP address pool object to delete.

VMM Collections Reference R2

Show: