2.2.4.332 LogicalGroup

  • Article

The LogicalGroup complex type specifies the definition of a logical group.

 <xs:complexType name="LogicalGroup">
   <xs:complexContent mixed="false">
     <xs:extension base="ipam:BaseIpamObject">
       <xs:sequence>
         <xs:element minOccurs="0" name="BuiltInLogicalGroupNumber" type="ipam:BuiltInLogicalGroup" />
         <xs:element minOccurs="0" name="Fields" nillable="true" type="ipam:ArrayOfLogicalGroupField" />
         <xs:element minOccurs="0" name="Name" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="Origin" type="ipam:LogicalGroupOrigin" />
         <xs:element minOccurs="0" name="RecordId" nillable="true" type="xsd:long" />
         <xs:element minOccurs="0" name="Users" type="ipam:LogicalGroupUsers" />
       </xs:sequence>
     </xs:extension>
   </xs:complexContent>
 </xs:complexType>

BuiltInLogicalGroupNumber:  If the logical group is a built-in logical group, this specifies a unique identifier for the built-in logical group.

Fields:  This specifies the array of LogicalGroupField specifying the multivalued custom fields whose values form the various levels of the logical group hierarchy.

Name:  This specifies the name of the logical group. This MUST NOT be NULL and MUST have a length of at least 2 characters and no more than 50 characters.

Origin:  This specifies the origin of the logical group – whether it was a built-in logical group or user-defined logical group.

RecordId:  This specifies a unique identifier for the data in the IPAM data store.

Users:  This specifies functional areas to which the specific logical group is applicable. It can be used for either address space management or active server management.