MSFT_IPAM_Subnet, ROOT\Microsoft\IPAM\MS_409

Class | Methods (5) | Properties (29) | Qualifiers (3) | Instances | Namespaces (2)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

An IPConnectivitySubnet represents a group of related IPProtocolEndpoints that can communicate with each other, as members of a subnet. The class describes the characteristics of the subnet.

MSFT_IPAM_Subnet methods

MSFT_IPAM_Subnet has 5 methods (5 Local)

NameOriginReturn
AddIpamSubnetMSFT_IPAM_Subnetuint32 {'out':True}
BulkAddOrUpdateSubnetMSFT_IPAM_Subnetuint32 {'out':True}
BulkDeleteSubnetMSFT_IPAM_Subnetuint32 {'out':True}
ExportSubnetMSFT_IPAM_Subnetuint32 {'out':True}
ImportSubnetMSFT_IPAM_Subnetuint32 {'out':True}

MSFT_IPAM_Subnet properties

MSFT_IPAM_Subnet has 29 properties (20 Local, 9 Derived)

NameOriginCIMType
AddressSpaceMSFT_IPAM_Subnet8 [string]
AddressSpaceIdMSFT_IPAM_Subnet21 [uint64]
AddressTypeCIM_IPConnectivitySubnet18 [uint16]
AssignedAddressesMSFT_IPAM_Subnet5 [real64]
CaptionCIM_ManagedElement8 [string]
ConnectivityStatusCIM_ConnectivityCollection18 [uint16]
CustomConfigurationMSFT_IPAM_Subnet8 [string]
CustomerAddressSpaceMSFT_IPAM_Subnet8 [string]
DescriptionCIM_ManagedElement8 [string]
ElementNameCIM_ManagedElement8 [string]
key
InstanceID
CIM_ManagedElement8 [string]
LastModifiedTimeMSFT_IPAM_Subnet101 [datetime]
NameMSFT_IPAM_Subnet8 [string]
NetworkIdMSFT_IPAM_Subnet8 [string]
NetworkSiteMSFT_IPAM_Subnet8 [string]
NetworkTypeMSFT_IPAM_Subnet18 [uint16]
OverlappingMSFT_IPAM_Subnet11 [boolean]
OwnerMSFT_IPAM_Subnet8 [string]
PercentageUtilizedMSFT_IPAM_Subnet5 [real64]
PrefixLengthCIM_IPConnectivitySubnet17 [uint8]
ProviderAddressSpaceMSFT_IPAM_Subnet8 [string]
SubnetMaskCIM_IPConnectivitySubnet8 [string]
SubnetNumberCIM_IPConnectivitySubnet8 [string]
TotalAddressesMSFT_IPAM_Subnet5 [real64]
UtilizationMSFT_IPAM_Subnet18 [uint16]
UtilizedAddressesMSFT_IPAM_Subnet5 [real64]
VirtualSubnetIdMSFT_IPAM_Subnet19 [uint32]
VlanIdMSFT_IPAM_Subnet18 [uint16]
VmmLogicalNetworkMSFT_IPAM_Subnet8 [string]

Detailed description of MSFT_IPAM_Subnet methods

Local methods (5) of MSFT_IPAM_Subnet class

AddIpamSubnet method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Namestring0-{'In':True}
NetworkIdstring1-{'In':True}
NetworkTypeuint162-{'In':True}
AddressSpacestring3-{'In':True}
Ownerstring4-{'In':True}
Descriptionstring5-{'In':True}
VlanIduint166-{'In':True}
CustomConfigurationstring7-{'In':True}
VmmLogicalNetworkstring8-{'In':True}
NetworkSitestring9-{'In':True}
VirtualSubnetIduint3210-{'In':True}
outputobject:MSFT_IPAM_Subnet11-{'Out':True}
Description'Adds a new Subnet object to IPAM'
AddIpamSubnet method is in 1 class (MSFT_IPAM_Subnet) of ROOT\Microsoft\IPAM\ms_409 and in 2 namespaces
BulkAddOrUpdateSubnet method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Subnetobject:MSFT_IPAM_Subnet0-{'In':True}
Outputobject:MSFT_IPAM_OperationStatus1-{'Out':True}
Description'Adds or updates a set of subnets in IPAM. This method takes an array of subnet objects as input'
BulkAddOrUpdateSubnet method is in 1 class (MSFT_IPAM_Subnet) of ROOT\Microsoft\IPAM\ms_409 and in 2 namespaces
BulkDeleteSubnet method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Subnetobject:MSFT_IPAM_Subnet0-{'In':True}
Outputobject:MSFT_IPAM_OperationStatus1-{'Out':True}
Description'Deletes a set of IP Address objects from IPAM'
BulkDeleteSubnet method is in 1 class (MSFT_IPAM_Subnet) of ROOT\Microsoft\IPAM\ms_409 and in 2 namespaces
ExportSubnet method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Pathstring0-{'In':True}
AddressTypeuint161-{'In':True}
NetworkTypeuint162-{'In':True}
AddressSpacestring3-{'In':True}
Outputobject:MSFT_IPAM_Subnet4-{'Out':True}
Description'Exports Subnets from IPAM Server to a .CSV file'
ExportSubnet method is in 1 class (MSFT_IPAM_Subnet) of ROOT\Microsoft\IPAM\ms_409 and in 2 namespaces
ImportSubnet method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Pathstring0-{'In':True}
ErrorPathstring1-{'In':True}
AddressFamilyuint162-{'In':True}
Outputstring3-{'Out':True}
Description'Imports Subnets into IPAM Server from a .CSV file'
ImportSubnet method is in 1 class (MSFT_IPAM_Subnet) of ROOT\Microsoft\IPAM\ms_409 and in 2 namespaces

Detailed description of MSFT_IPAM_Subnet properties

Local properties (20) of MSFT_IPAM_Subnet class

AddressSpace property
CIMTYPE'string'
Description'Specifies the address space associated with the subnet.'
AddressSpace property is in 3 classes of ROOT\Microsoft\IPAM\ms_409 and in 2 namespaces
AddressSpaceId property
CIMTYPE'uint64'
Description'Specifies the address space associated with the subnet.'
AddressSpaceId property is in 3 classes of ROOT\Microsoft\IPAM\ms_409 and in 4 namespaces
AssignedAddresses property
CIMTYPE'real64'
Description'Specifies the total number of addresses contained in the subnet which map to a range in IPAM.'
AssignedAddresses property is in 3 classes of ROOT\Microsoft\IPAM\ms_409 and in 2 namespaces
CustomConfiguration property
CIMTYPE'string'
Description'Custom metadata associated with this address. This is specified as a semi-colon separated �name=value� pairs.'
CustomConfiguration property is in 5 classes of ROOT\Microsoft\IPAM\ms_409 and in 4 namespaces
CustomerAddressSpace property
CIMTYPE'string'
Description'Specifies the customer address space associated with the subnet.'
CustomerAddressSpace property is in 3 classes of ROOT\Microsoft\IPAM\ms_409 and in 2 namespaces
LastModifiedTime property
CIMTYPE'datetime'
Description'The latest date and time when any property of this subnet was modified'
LastModifiedTime property is in 4 classes of ROOT\Microsoft\IPAM\ms_409 and in 4 namespaces
Name property
CIMTYPE'string'
Description'User specified name for the subnet.'
Name property is in 26 classes of ROOT\Microsoft\IPAM\ms_409 and in 142 namespaces
NetworkId property
CIMTYPE'string'
Description'The network corresponding to this subnet. This is specified as NetworkId / Prefix Length.'
NetworkId property is in 3 classes of ROOT\Microsoft\IPAM\ms_409 and in 2 namespaces
NetworkSite property
CIMTYPE'string'
Description'This field, along with a logical network, forms an abstraction of the physical network. A given logical network can contain many network sites.'
NetworkSite property is in 3 classes of ROOT\Microsoft\IPAM\ms_409 and in 2 namespaces
NetworkType property
CIMTYPE'uint16'
Description'Specifies whether the IP address is being used as a virtualized or non-virtualized address.'
Values['NonVirtualized', 'Provider', 'Customer']
NetworkType property is in 3 classes of ROOT\Microsoft\IPAM\ms_409 and in 2 namespaces
Overlapping property
CIMTYPE'boolean'
Description'Indicates whether this subnet overlaps with another subnet in IPAM.'
Overlapping property is in 2 classes of ROOT\Microsoft\IPAM\ms_409 and in 2 namespaces
Owner property
CIMTYPE'string'
Description'Optional field specifying the owner of this subnet.'
Owner property is in 9 classes of ROOT\Microsoft\IPAM\ms_409 and in 142 namespaces
PercentageUtilized property
CIMTYPE'real64'
Description'The percentage of total assigned IP Addresses that are currently in use.'
PercentageUtilized property is in 3 classes of ROOT\Microsoft\IPAM\ms_409 and in 2 namespaces
ProviderAddressSpace property
CIMTYPE'string'
Description'Specifies the provider address space associated with the subnet.'
ProviderAddressSpace property is in 3 classes of ROOT\Microsoft\IPAM\ms_409 and in 2 namespaces
TotalAddresses property
CIMTYPE'real64'
Description'Specifies the total number of addresses contained in the subnet.'
TotalAddresses property is in 2 classes of ROOT\Microsoft\IPAM\ms_409 and in 4 namespaces
Utilization property
CIMTYPE'uint16'
Description'Indicates whether the given subnet is under utilized, over utilized or whether the utilization level is optimal.'
Values['None', 'Under', 'Optimal', 'Over']
Utilization property is in 3 classes of ROOT\Microsoft\IPAM\ms_409 and in 4 namespaces
UtilizedAddresses property
CIMTYPE'real64'
Description'Specifies the total number of subnet addresses which are currently being utilized.'
UtilizedAddresses property is in 3 classes of ROOT\Microsoft\IPAM\ms_409 and in 2 namespaces
VirtualSubnetId property
CIMTYPE'uint32'
Description'While using network virtualization, this property, along with Customer address and Provider address is used to route packets to a particular customer VM.'
VirtualSubnetId property is in 1 class (MSFT_IPAM_Subnet) of ROOT\Microsoft\IPAM\ms_409 and in 5 namespaces
VlanId property
CIMTYPE'uint16'
Description'List of VLANs that this subnet is a part of.'
VlanId property is in 1 class (MSFT_IPAM_Subnet) of ROOT\Microsoft\IPAM\ms_409 and in 6 namespaces
VmmLogicalNetwork property
CIMTYPE'string'
Description'The abstraction of physical network that describes a particular function in your environment.'
VmmLogicalNetwork property is in 3 classes of ROOT\Microsoft\IPAM\ms_409 and in 2 namespaces

Derived properties (9) of MSFT_IPAM_Subnet class

AddressType property
CIMTYPE'uint16'
Description'An enumeration that describes the format of the address properties in IPConnectivitySubnet.'
Values['Unknown', 'IPv4', 'IPv6']
AddressType property is in 7 classes of ROOT\Microsoft\IPAM\ms_409 and in 9 namespaces
Caption property
CIMTYPE'string'
Description'The Caption property is a short textual description (one- line string) of the object.'
Caption property is in 45 classes of ROOT\Microsoft\IPAM\ms_409 and in 37 namespaces
ConnectivityStatus property
CIMTYPE'uint16'
Description'An enumeration describing the current or potential connectivity between endpoints in this collection. Connectivity may be provided or not, or may be in a degraded/partitioned state if one or more endpoints or links have failed. The latter would prevent full connectivity between all elements in the Collection, but would permit connectivity between subsets.'
Values['Unknown', 'Connectivity/Up', 'No Connectivity/Down', 'Partitioned']
ConnectivityStatus property is in 3 classes of ROOT\Microsoft\IPAM\ms_409 and in 6 namespaces
Description property
CIMTYPE'string'
Description'The Description property provides a textual description of the object.'
Description property is in 46 classes of ROOT\Microsoft\IPAM\ms_409 and in 142 namespaces
ElementName property
CIMTYPE'string'
Description'A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information.
Note that the Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties. Note that if there is an associated instance of CIM_EnabledLogicalElementCapabilities, restrictions on this properties may exist as defined in ElementNameMask and MaxElementNameLen properties defined in that class.'
ElementName property is in 45 classes of ROOT\Microsoft\IPAM\ms_409 and in 21 namespaces
InstanceID property
CIMTYPE'string'
Description'Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following \'preferred\' algorithm:
:
Where and are separated by a colon \':\', and where must include a unique name. It can be a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID. Or, it could be a registered ID that is assigned to the business entity by a recognized global authority.(This requirement is similar to the _ structure of Schema class names.) In addition, to ensure uniqueness must not contain a colon (\':\'). When using this algorithm, the first colon to appear in InstanceID must appear between and .
is chosen by the business entity and should not be re-used to identify different underlying (real-world) elements. If the above \'preferred\' algorithm is not used, the defining entity must ensure that the resulting InstanceID is not re-used as any of InstanceIDs produced by this or other providers for the NameSpace of this instance.
For DMTF-defined instances, the \'preferred\' algorithm must be used with the set to \'CIM\'.'
keyTrue
InstanceID property is in 45 classes of ROOT\Microsoft\IPAM\ms_409 and in 21 namespaces
PrefixLength property
CIMTYPE'uint8'
Description'The prefix length for IPv6 addresses in the IP subnet, if needed (i.e., if the AddressType property is 2, "IPv6").'
PrefixLength property is in 4 classes of ROOT\Microsoft\IPAM\ms_409 and in 9 namespaces
SubnetMask property
CIMTYPE'string'
Description'The mask for the starting IPv4 address of the IP subnet, if needed (i.e., if the AddressType property is 1, "IPv4").'
SubnetMask property is in 5 classes of ROOT\Microsoft\IPAM\ms_409 and in 16 namespaces
SubnetNumber property
CIMTYPE'string'
Description'The IP address of the entire subnet, formatted according to the appropriate convention as defined in the AddressType property of this class.'
SubnetNumber property is in 2 classes of ROOT\Microsoft\IPAM\ms_409 and in 4 namespaces

MSFT_IPAM_Subnet Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
AMENDMENTTrue
Description'An IPConnectivitySubnet represents a group of related IPProtocolEndpoints that can communicate with each other, as members of a subnet. The class describes the characteristics of the subnet.'
LOCALE'MS_409'

MSFT_IPAM_Subnet System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\Microsoft\IPAM\ms_409:MSFT_IPAM_Subnet'___SYSTEM8
__NAMESPACE'ROOT\Microsoft\IPAM\ms_409'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_IPConnectivitySubnet', 'CIM_ConnectivityCollection', 'CIM_SystemSpecificCollection', 'CIM_Collection', 'CIM_ManagedElement']___SYSTEM8
__PROPERTY_COUNT29___SYSTEM3
__RELPATH'MSFT_IPAM_Subnet'___SYSTEM8
__DYNASTY'CIM_ManagedElement'___SYSTEM8
__SUPERCLASS'CIM_IPConnectivitySubnet'___SYSTEM8
__CLASS'MSFT_IPAM_Subnet'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to MSFT_IPAM_Subnet

Number of classes:4
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
CIM_IPConnectivitySubnet190----
MSFT_IPAM_Address_Subnet_Association020----
MSFT_IPAM_Range_Subnet_Association020----
MSFT_IPAM_Subnet_Block_Association020----
comments powered by Disqus
WUtils.com