{anchor:top}
h1. {anchor:ANOMB} Communications Suite Delegated Administrator LDAP Object Classes and Attributes
This chapter describes LDAP Schema 2 object classes and attributes used by Communications Suite Delegated Administrator.
Communications Suite Delegated Administrator provides web-based console and a command-line utility ({{commadmin}}) for provisioning (users, groups, resources, organizations) for Messaging Server and Calendar Server in an LDAP Schema 2 directory.
To provision Messaging Server users in an LDAP Schema 1 directory, you must use iPlanet Delegated Administrator, a deprecated tool. For information about object classes and attributes used by iPlanet Delegated Administrator, see [iPlanet Delegated Administrator LDAP Object Classes and Attributes (Schema 1)].
The chapter is divided into two sections:
* [Object Classes|#ANOMC]
* [Attributes|#ANOMI]
The object classes and attributes are listed alphabetically.
[Top|#top]
h2. {anchor:ANOMC} Object Classes
The following object classes are used by Delegated Administrator to provision users in an LDAP Schema 2 directory:
* [sunDelegatedOrganization|#ANOMD]
* [sunMailOrganization|#ANOME]
* [sunManagedLocation|#ANOMF]
* [sunManagedProvider|#ANOMG]
* [sunSharedDomain|#ANOMH]
[Top|#top]
h2. {anchor:ANOMD} sunDelegatedOrganization
[Top|#top]
h3. {anchor:GAIVR} Supported by
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIWF} Definition
Object class that defines the properties of a business organization. For example, one property of {{sunDelegatedOrganization}} can designate a list of domain names the business organization can use for its users. Also, it can define the list of services designated by the provider organization, as available to the business organization, to be assigned to the users.
[Top|#top]
h3. {anchor:GAIVE} Superior Class
{{top}}
[Top|#top]
h3. {anchor:GAIUU} Object Class Type
auxiliary
[Top|#top]
h3. {anchor:GAIVO} OID
Unknown
[Top|#top]
h3. {anchor:GAIVN} Required Attributes
{{sunOrgType}}
[Top|#top]
h3. {anchor:GAIVD} Allowed Attributes
{{sunAvailableServices}}, {{sunAvailableDomainNames}}, {{sunMaxUsers}}, {{sunNumUsers}}, {{sunMaxGroups}}, {{unNumGroups}}, {{sunEnableGAB}}, {{sunAllowMultipleServices}}, {{sunOrganizationSkin}}
[Top|#top]
h2. {anchor:ANOME} sunMailOrganization
[Top|#top]
h3. {anchor:GAIWE} Supported by
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIWA} Definition
Object class to be added to a shared business organization that has mail service. {{sunMailOrganization}} adds two attributes ({{preferredMailHost}} and {{preferredMailMessageStore}}) that specify the mail host and message store partition where mail is stored for all users in the business organization.\\
\\You can only add the {{sunMailOrganization}} object class to a shared business organization (defined as "shared" with the {{sunOrgType}} attribute).\\
\\Do not add {{sunMailOrganization}} to a full domain business organization (defined as "full" with the {{sunOrgType}} attribute). For a full domain business organization, add the {{mailDomain}} object class, which also uses the {{preferredMailHost}} and {{preferredMailMessageStore}} attributes for provisioning the preferred mail host and message store for the domain.
[Top|#top]
h3. {anchor:GAIVI} Superior Class
{{top}}
[Top|#top]
h3. {anchor:GAIVL} Object Class Type
auxiliary
[Top|#top]
h3. {anchor:GAIUJ} OID
oid-sunMailOrganization
[Top|#top]
h3. {anchor:GAIVM} Required Attributes
{{none}}
[Top|#top]
h3. {anchor:GAIVZ} Allowed Attributes
{{preferredMailHost, preferredMailMessageStore}}
[Top|#top]
h2. {anchor:ANOMF} sunManagedLocation
[Top|#top]
h3. {anchor:GAIUI} Supported by
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIUS} Definition
Object class to be added to the user/group root suffix. This class maintains a pointer (in the form of a DN) to the location of the Business Organization Tree and Residential Tree. For example, {{o=Business}} and {{o=Residential}}, respectively.
[Top|#top]
h3. {anchor:GAIUO} Superior Class
{{top}}
[Top|#top]
h3. {anchor:GAIVC} Object Class Type
auxiliary
[Top|#top]
h3. {anchor:GAIVA} OID
Unknown
[Top|#top]
h3. {anchor:GAIVH} Required Attributes
none
[Top|#top]
h3. {anchor:GAIVV} Allowed Attributes
{{sunBusinessRoot, sunResidentialRoot, sunServicesRoot}}
[Top|#top]
h2. {anchor:ANOMG} sunManagedProvider
[Top|#top]
h3. {anchor:GAIVY} Supported by
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIVP} Definition
Object class used for storing the properties of a provider organization. Following are some of the properties maintained by {{sunManagedProvider}}:
* Types of business organizations this provider can create
* Where to create the business organizations
* Services available to this provider
* Domain names that can be used by the shared business organizations created under this provider organization
[Top|#top]
h3. {anchor:GAIVU} Superior Class
{{top}}
[Top|#top]
h3. {anchor:GAIWG} Object Class Type
auxiliary
[Top|#top]
h3. {anchor:GAIUX} OID
oid-sunManagedProvider
[Top|#top]
h3. {anchor:GAIVB} Required Attributes
None
[Top|#top]
h3. {anchor:GAIVF} Allowed Attributes
{{sunAllowBusinessOrgType, sunBusinessOrgBase, sunIncludeServices, sunExcludeServices, sunAssignableDomains, sunAllowMultipleDomains, sunProviderOrgDN}}
[Top|#top]
h2. {anchor:ANOMH} sunSharedDomain
[Top|#top]
h3. {anchor:GAIUT} Supported by
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIUW} Definition
Object class to designate a domain that can be shared across multiple business organizations (such as {{sesta.com}}).\\
\\The {{sunSharedDomain}} object class can designate a hosted domain as a shared domain. Underneath this shared domain, there can be multiple Provider Organizations. Under the Provider Organizations you can create multiple Business Organizations, all sharing the same namespace as the shared domain.
[Top|#top]
h3. {anchor:GAIUQ} Superior Class
{{top}}
[Top|#top]
h3. {anchor:GAIUK} Object Class Type
auxiliary
[Top|#top]
h3. {anchor:GAIVX} OID
oid-sunSharedDomain
[Top|#top]
h3. {anchor:GAIUV} Required Attributes
{{none}}
[Top|#top]
h3. {anchor:GAIVW} Allowed Attributes
{{none}}
[Top|#top]
h2. {anchor:ANOMI} Attributes
The following attributes are used by Delegated Administrator to provision users in an LDAP Schema 2 directory:
* [mailParentalControl|#ANOMJ]
* [mailSieveRuleRef|#ANOMK]
* [preferredMailHost|#ANOML]
* [preferredMailMessageStore|#ANOMM]
* [psIncludeInGAB|#ANOMN]
* [sunAllowBusinessOrgType|#ANOMO]
* [sunAllowMultipleDomains|#ANOMP]
* [sunAllowMultipleServices|#ANOMQ]
* [sunAssignableDomains|#ANOMR]
* [sunAvailableDomainNames|#ANOMS]
* [sunAvailableServices|#ANOMT]
* [sunBusinessOrgBase|#ANOMU]
* [sunBusinessRoot|#ANOMV]
* [sunEnableGAB|#ANOMW]
* [sunExcludeServices|#ANOMX]
* [sunIncludeServices|#ANOMY]
* [sunMaxGroups|#ANOMZ]
* [sunMaxUsers|#ANONA]
* [sunNumGroups|#ANONB]
* [sunNumUsers|#ANONC]
* [sunOrganizationSkin|#ANOND]
* [sunOrgType|#ANONE]
* [sunProviderOrgDN|#ANONF]
* [sunResidentialRoot|#ANONG]
* [sunServicesRoot|#ANONH]
[Top|#top]
h2. {anchor:ANOMJ} mailParentalControl
[Top|#top]
h3. {anchor:GAIWB} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIWD} Syntax
cis, single-valued
[Top|#top]
h3. {anchor:GAIWC} Object Class
[inetMailUser FIX|Title#ANOCE]
[Top|#top]
h3. {anchor:GAIVJ} Definition
Set to true when parental control is enabled for a user.\\
\\Messaging Server uses sieve rules to implement parental control (the ability of a family administrative account to specify mail delivery rules for one or more sub-accounts).\\
\\Parental control rules are stored in the family group entry (implemented by using {{mailSieveRuleSource}} as an attribute of the {{inetManagedGroup}} object class). When a head of family specifies parental control rules, the rules are transformed to sieve rules and stored in the family group entry.\\
\\When a sub-account is tagged for parental control, the DN of the family group entry is stored in the sub-account’s user entry (implemented with the {{mailSieveRuleRef}} attribute). In addition, the {{mailParentalControl}} attribute is set to {{true}}.\\
\\Allowed values: true, false\\
\\Default value: false
[Top|#top]
h3. {anchor:GAIUL} Example
{{mailParentalControl: true}}
[Top|#top]
h3. {anchor:GAIVK} OID
oid-mailParentalControl
[Top|#top]
h2. {anchor:ANOMK} mailSieveRuleRef
[Top|#top]
h3. {anchor:GAIVG} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIUR} Syntax
dn, single-valued
[Top|#top]
h3. {anchor:GAIVS} Object Class
[inetMailUser FIX|Title#ANOCE]
[Top|#top]
h3. {anchor:GAIUM} Definition
Specifies the DN of an LDAP entry. The referenced LDAP entry can contain additional mail filters in the entry’s {{mailSieveRuleSource}} attribute. Sieve rules specified in the referenced LDAP entry are applied before sieve rules specified in this user entry. This reference is used only when the {{mailParentalControl}} attribute is set to {{true}}.
[Top|#top]
h3. {anchor:GAIUH} Example
{{mailSieveRuleRef: cn=Sample Family Group,o=groups,o=Residential,o=userGroupRoot}}
[Top|#top]
h3. {anchor:GAIUZ} OID
oid-mailSieveRuleRef
[Top|#top]
h2. {anchor:ANOML} preferredMailHost
[Top|#top]
h3. {anchor:GAIUN} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIUP} Syntax
cis, single-valued
[Top|#top]
h3. {anchor:GAIWH} Object Classes
[mailDomain FIX|Title#ANOCK], [sunMailOrganization|#ANOME]
[Top|#top]
h3. {anchor:GAIVT} Definition
If you are provisioning an LDAP Schema 2 directory with Communications Suite Delegated Administrator, use the following definition:\\
\\Sets the mail host name for new users in this business organization. When a user is created, the {{mailHost}} attribute of the user entry is filled by the value of {{preferredMailHost}}.\\
\\The {{preferredMailHost}} attribute is required when the business organization has a mail service.\\
\\If this is a full business organization, {{preferredMailHost}} is an attribute of the {{mailDomain}} object class. If this is a shared business organization, {{preferredMailHost}} is an attribute of the {{sunMailOrganization}} object class.\\
\\If you are provisioning an LDAP Schema 1 directory with iPlanet Delegated Administrator:\\
\\See [preferredMailHost FIX|Title#ANOJF] for a definition of how to use this attribute with Schema 1.
[Top|#top]
h3. {anchor:GAIXV} Example
{{preferredMailHost: mail.siroe.com}}
[Top|#top]
h3. {anchor:GAIXR} OID
2.16.840.1.113730.3.1.761
[Top|#top]
h2. {anchor:ANOMM} preferredMailMessageStore
[Top|#top]
h3. {anchor:GAIXY} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIWY} Syntax
cis, single-valued
[Top|#top]
h3. {anchor:GAIYA} Object Classes
[mailDomain FIX|Title#ANOCK], [sunMailOrganization|#ANOME]
[Top|#top]
h3. {anchor:GAIYD} Definition
If you are provisioning an LDAP Schema 2 directory with Communications Suite Delegated Administrator, use the following definition:\\
\\Sets the message store partition name for new users in this business organization. When a user is created, the {{mailMessageStore}} attribute of the user entry is filled by the value of {{preferredMailMessageStore}}.\\
\\If the {{preferredMailMessageStore}} attribute is missing, Delegate Administrator leaves the {{mailMessageStore}} attribute empty and the access server assumes that the user’s mailbox is in the default partition of the server instance.\\
\\If this is a full business organization, {{preferredMailMessageStore}} is an attribute of the {{mailDomain}} object class. If this is a shared business organization, {{preferredMailMessageStore}} is an attribute of the {{sunMailOrganization}} object class.\\
\\If you are provisioning an LDAP Schema 1 directory with iPlanet Delegated Administrator:\\
\\See [preferredMailMessageStore FIX|Title#ANOJG] for a definition of how to use this attribute with Schema 1.
[Top|#top]
h3. {anchor:GAIYC} Example
{{preferredMailMessageStore: primary}}
[Top|#top]
h3. {anchor:GAIXJ} OID
2.16.840.1.113730.3.1.762
[Top|#top]
h2. {anchor:ANOMN} psIncludeInGAB
[Top|#top]
h3. {anchor:GAIWP} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIYB} Syntax
cis, single-valued
[Top|#top]
h3. {anchor:GAIXA} Object Class
[ipUser|Messaging Server and Calendar Server LDAP Object Classes and Attributes#ipUser]
[Top|#top]
h3. {anchor:GAIXO} Definition
Includes this user in the Global Address Book (GAB) and gives this user access to the Global Address Book.\\
\\Allowed values: {{true}}, {{false}}\\
\\Default value: {{true}}
[Top|#top]
h3. {anchor:GAIXH} Example
{{psIncludeInGAB: false}}
[Top|#top]
h3. {anchor:GAIWW} OID
oid-psIncludeInGAB
[Top|#top]
h2. {anchor:ANOMO} sunAllowBusinessOrgType
[Top|#top]
h3. {anchor:GAIWO} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIWJ} Syntax
cis, multi-valued
[Top|#top]
h3. {anchor:GAIWT} Object Class
[sunManagedProvider|#ANOMG]
[Top|#top]
h3. {anchor:GAIXF} Definition
Defines the types of business organizations this provider administrator can create.\\
\\This is a required attribute.\\
\\Allowed values:
* {{shared}}*— Designates a business organization that is assigned to a shared domain. Multiple business organizations can be part of a shared domain. The business organization being created shares its namespace with the other organizations in the domain.*
* {{full}}— Designates a business organization that is a full-fledged domain with an authorized domain name and its own unique namespace.
The {{sunAllowBusinessOrgType}} attribute can enable the provider to create
* Only shared business organizations ({{shared}} value only)
* Only business organizations that are real, full-fledged domains ({{full}} value only)
* Both shared and full-fledged business organizations ({{shared}} and {{full}} values)
[Top|#top]
h3. {anchor:GAIXS} Example
{{sunAllowBusinessOrgType: sharedsunAllowBusinessOrgType: full}}
[Top|#top]
h3. {anchor:GAIXN} OID
oid-sunAllowBusinessOrgType
[Top|#top]
h2. {anchor:ANOMP} sunAllowMultipleDomains
[Top|#top]
h3. {anchor:GAIYE} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIXX} Syntax
cis, single-valued
[Top|#top]
h3. {anchor:GAIWR} Object Class
[sunManagedProvider|#ANOMG]
[Top|#top]
h3. {anchor:GAIXG} Definition
Determines whether this provider organization can create business organizations that permit multiple domain names or a single domain name for their users.\\
\\The {{sunAllowMultipleDomains}} attribute applies only to business organizations created in shared domains. If a business organization is created as a domain with its own namespace, it can always have multiple domain names specified with the {{associatedDomain}} attribute.\\
\\If the {{sunAllowMultipleDomains}} attribute is not present, the LDAP semantics allow multiple domain names for the users of the business organizations. (The default value is true.)\\
\\Allowed values: {{true}}, {{false}}
[Top|#top]
h3. {anchor:GAIXP} Example
{{sunAllowMultipleDomains:}} {{true}}
[Top|#top]
h3. {anchor:GAIWQ} OID
oid-sunAllowMultipleDomains
[Top|#top]
h2. {anchor:ANOMQ} sunAllowMultipleServices
[Top|#top]
h3. {anchor:GAIWX} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIWM} Syntax
cis, single-valued
[Top|#top]
h3. {anchor:GAIWN} Object Class
[sunDelegatedOrganization|#ANOMD]
[Top|#top]
h3. {anchor:GAIYG} Definition
NOTE: This attribute is not being used for this release.\\
\\Enables you to assign multiple classes-of-service to users in this business organization.\\
\\Allowed values: {{true}}, {{false}}\\
\\Default value: {{true}}\\
\\If {{sunAllowMultipleServices}} has a value of {{false}}, users in this business organization can have at most one class-of-service.
[Top|#top]
h3. {anchor:GAIXE} Example
{{sunAllowMultipleServices: false}}
[Top|#top]
h3. {anchor:GAIXT} OID
oid-sunAllowMultipleServices
[Top|#top]
h2. {anchor:ANOMR} sunAssignableDomains
[Top|#top]
h3. {anchor:GAIWV} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIXB} Syntax
cis, multi-valued
[Top|#top]
h3. {anchor:GAIYF} Object Class
[sunManagedProvider|#ANOMG]
[Top|#top]
h3. {anchor:GAIWK} Definition
Specifies a list of domain names the provider administrator can choose from when assigning domains to business organizations in this provider organization. This list is derived from the domain names specified in the {{sunPreferredDomain}} and {{associatedDomain}} attributes of the parent or ancestor shared domain node.\\
\\If the sunAssignableDomains attribute is not present, all of the {{sunPreferredDomain}} and {{associatedDomain}} attributes are available to be assigned to business organizations by this provider.
[Top|#top]
h3. {anchor:GAIXW} Example
{{sunAssignableDomains:}} {{sesta.com}} {{sunAssignableDomains:}} {{siroe.com}} {{sunAssignableDomains:}} {{varius.com}}
[Top|#top]
h3. {anchor:GAIWZ} OID
oid-sunAssignableDomains
[Top|#top]
h2. {anchor:ANOMS} sunAvailableDomainNames
[Top|#top]
h3. {anchor:GAIXD} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIXQ} Syntax
cis, multi-valued
[Top|#top]
h3. {anchor:GAIXZ} Object Class
[sunDelegatedOrganization|#ANOMD]
[Top|#top]
h3. {anchor:GAIXM} Definition
Specifies a list of domain names available for use by the business organization. This list is a subset of domain names derived from the {{sunAssignableDomains}} attribute in the provider organization.\\
\\If the {{sunAvailableDomainNames}} attribute is not present, all domains from the {{sunAssignableDomains}} attribute in the provider organization are available for use by this business organization.
[Top|#top]
h3. {anchor:GAIXI} Example
{{sunAvailableDomainNames: sesta.comsunAvailableDomainNames: siroe.com}}
[Top|#top]
h3. {anchor:GAIWU} OID
oid-sunAvailableDomainNames
[Top|#top]
h2. {anchor:ANOMT} sunAvailableServices
h3. {anchor:GAIXU} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
h3. {anchor:GAIXK} Syntax
cis, multi-valued
h3. {anchor:GAIXC} Object Class
[sunDelegatedOrganization|#ANOMD]
h3. {anchor:GAIWS} Definition
Specifies a list of Service Packages available to the business organization for its users and groups. Also specifies the number of instances of each named class-of-service.\\
\\This is a required attribute.
h3. {anchor:GAIWL} Format
The value of the attribute has two possible formats:
h4. Limited Allocation
_servicename_:_number_:_number_assigned_
* _number_ is the number of service packages allocated to the organization\\
* _number_assigned_ is the number of service packages assigned to users or groups in the organization. If no service packages have been assigned, the value of _number_assigned_ is {{-1}}.\\
h4. Unlimted
_servicename_
If you specify _servicename_ only—if you do not specify the _number_ of services allocated and assigned—an unlimited number of that service is available to the business organization.
h3. {anchor:GAIXL} Example
{panel}
{{sunAvailableServices:Gold:10:–1}}
{{sunAvailableServices:Mercury:20:5 }}
{{sunAvailableServices:Silver}}
{panel}
In this example, 10 Gold services are available to the organization, 0 have been assigned. 20 Mercury services are available to the organization, 5 have been assigned. An unlimited number of Silver services are available to the organization.
h3. {anchor:GAIZD} OID
oid-sunAvailableServices
h2. {anchor:ANOMU} sunBusinessOrgBase
[Top|#top]
h3. {anchor:GAIZO} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIYZ} Syntax
dn, single-valued
[Top|#top]
h3. {anchor:GAIZE} Object Class
[sunManagedProvider|#ANOMG]
[Top|#top]
h3. {anchor:GAIZI} Definition
Contains the DN for the node underneath which all full domains for this provider organization are to be created.\\
\\You can assign this attribute only if the {{sunAllowBusinessOrgType}} attribute was provisioned to allow full domains ({{sunAllowBusinessOrgType: full}}).
[Top|#top]
h3. {anchor:GAIYV} Example
{{sunBusinessOrgBase: o=providerorgDomainsRoot,o=Business,o=userGroupRoot}}
[Top|#top]
h3. {anchor:GAJAG} OID
oid-sunBusinessOrgBase
h2. {anchor:ANOMV} sunBusinessRoot
[Top|#top]
h3. {anchor:GAJAF} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIZS} Syntax
dn, single-valued
[Top|#top]
h3. {anchor:GAIYU} Object Class
[sunManagedLocation|#ANOMF]
[Top|#top]
h3. {anchor:GAIYW} Definition
Holds th[Top|#top]
e DN of the root entry that contains the business organization tree.
[Top|#top]
h3. {anchor:GAIZW} Example
{{sunBusinessRoot: o=Business,o=userGroupRoot}}
[Top|#top]
h3. {anchor:GAIYS} OID
oid-sunBusinessRoot
[Top|#top]
h2. {anchor:ANOMW} sunEnableGAB
[Top|#top]
h3. {anchor:GAJAC} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIZU} Syntax
cis, single-valued
[Top|#top]
h3. {anchor:GAIZQ} Object Class
[sunDelegatedOrganization|#ANOMD]
[Top|#top]
h3. {anchor:GAIYY} Definition
Enables use of a global address book for this business organization.\\
\\Allowed values: {{true}}, {{false}}\\
\\Default value: {{false}}
[Top|#top]
h3. {anchor:GAIZK} Example
{{sunEnableGAB: true}}
[Top|#top]
h3. {anchor:GAJAD} OID
oid-sunEnableGAB
[Top|#top]
h2. {anchor:ANOMX} sunExcludeServices
[Top|#top]
h3. {anchor:GAIYK} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIYP} Syntax
cis, multi-valued
[Top|#top]
h3. {anchor:GAIZJ} Object Class
[sunManagedProvider|#ANOMG]
[Top|#top]
h3. {anchor:GAIZL} Definition
Specifies a list of classes-of-service that will be excluded from the business organizations in this provider organization.\\
\\If both the {{sunIncludeServices}} and {{sunExcludeServices}} attributes are specified, only {{sunIncludeServices}} takes effect. If neither attribute is present, all classes-of-service found underneath the container specified with the {{sunServicesRoot}} attribute will also be available to the business organizations in this provider organization.
[Top|#top]
h3. {anchor:GAIZB} Example
{{sunExcludeServices: Bronze}}
[Top|#top]
h3. {anchor:GAIZZ} OID
oid-sunExcludeServices
[Top|#top]
h2. {anchor:ANOMY} sunIncludeServices
[Top|#top]
h3. {anchor:GAIYI} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIZT} Syntax
cis, multi-valued
[Top|#top]
h3. {anchor:GAIZN} Object Class
[sunManagedProvider|#ANOMG]
[Top|#top]
h3. {anchor:GAIZR} Definition
Specifies a list of the classes-of-service available to business organizations in this provider organization.\\
\\The complete list of classes-of-service available in this directory is found underneath the container specified with the {{sunServicesRoot}} attribute.\\
\\If the {{sunIncludeServices}} attribute is not present, all classes-of-service specified underneath the class-of-service container will also be available to the business organizations in this provider organization.
[Top|#top]
h3. {anchor:GAIYH} Example
{{sunIncludeServices: Gold}}
[Top|#top]
h3. {anchor:GAIZH} OID
oid-sunIncludeServices
[Top|#top]
h2. {anchor:ANOMZ} sunMaxGroups
[Top|#top]
h3. {anchor:GAIYO} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIYL} Syntax
integer, single-valued
[Top|#top]
h3. {anchor:GAIZC} Object Class
[sunDelegatedOrganization|#ANOMD]
[Top|#top]
h3. {anchor:GAIYX} Definition
Specifies the maximum number of groups that can be created in this business organization.\\
\\To enable the business organization to contain an unlimited number of groups, specify a value of {{-1}}.\\
\\Allowed values are integers.
[Top|#top]
h3. {anchor:GAIYQ} Example
{{sunMaxGroups: 20}}
[Top|#top]
h3. {anchor:GAIZV} OID
oid-sunMaxGroups
[Top|#top]
h2. {anchor:ANONA} sunMaxUsers
[Top|#top]
h3. {anchor:GAIZA} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAJAA} Syntax
integer, single-valued
[Top|#top]
h3. {anchor:GAIZF} Object Class
[sunDelegatedOrganization|#ANOMD]
[Top|#top]
h3. {anchor:GAIZX} Definition
Specifies the maximum number of users who can be created in this business organization.\\
\\To enable the business organization to contain an unlimited number of users, specify a value of {{-1}}.\\
\\Allowed values are integers.
[Top|#top]
h3. {anchor:GAJAB} Example
{{sunMaxUsers: 50}}
[Top|#top]
h3. {anchor:GAIYM} OID
oid-sunMaxUsers
[Top|#top]
h2. {anchor:ANONB} sunNumGroups
[Top|#top]
h3. {anchor:GAIZP} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIYT} Syntax
integer, single-valued
[Top|#top]
h3. {anchor:GAIZY} Object Class
[sunDelegatedOrganization|#ANOMD]
[Top|#top]
h3. {anchor:GAIZM} Definition
Specifies the current number of groups in this business organization.\\
\\Allowed values are integers.
[Top|#top]
h3. {anchor:GAIYR} Example
{{sunNumGroups: 8}}
[Top|#top]
h3. {anchor:GAIYN} OID
oid-sunNumGroups
[Top|#top]
h2. {anchor:ANONC} sunNumUsers
[Top|#top]
h3. {anchor:GAIYJ} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIZG} Syntax
integer, single-valued
[Top|#top]
h3. {anchor:GAJAE} Object Class
[sunDelegatedOrganization|#ANOMD]
[Top|#top]
h3. {anchor:GAJBA} Definition
Specifies the current number of users in this business organization.\\
\\Allowed values are integers.
NOTE: This number is maintained by Delegated Administrator. Manual changes to the number of users (using ldapmodify) will not be reflected in the count.
[Top|#top]
h3. {anchor:GAJAH} Example
{{sunNumUsers: 12}}
[Top|#top]
h3. {anchor:GAJBO} OID
oid-sunNumUsers
[Top|#top]
h2. {anchor:ANOND} sunOrganizationSkin
[Top|#top]
h3. {anchor:GAJBF} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAJAU} Syntax
cis, multi-valued
[Top|#top]
h3. {anchor:GAJAT} Object Class
[sunDelegatedOrganization|#ANOMD]
[Top|#top]
h3. {anchor:GAJCC} Definition
This attribute is not currently implemented.\\
\\Enables this business organization to use a specified customization of the user interface (UI) to provide a specific look and feel for users in the organization.\\
\\The {{sunOrganizationSkin}} attribute is specified with a key-value pair. The key is the name of a skin to be used for the organization’s customized UI. The value identifies the jar file containing the skin.
[Top|#top]
h3. {anchor:GAJAM} Format
_skinname_:_jarfile_
[Top|#top]
h3. {anchor:GAJAS} Examples
{{sunOrganizationSkin: classic: classiclookandfeel.jarsunOrganizationSkin: modern: modernlookandfeel.jar}}
[Top|#top]
h3. {anchor:GAJAP} OID
oid-sunOrganizationSkin
[Top|#top]
h2. {anchor:ANONE} sunOrgType
[Top|#top]
h3. {anchor:GAJAW} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAJAN} Syntax
cis, single-valued
[Top|#top]
h3. {anchor:GAJBP} Object Class
[sunDelegatedOrganization|#ANOMD]
[Top|#top]
h3. {anchor:GAJCG} Definition
Determines whether this business organization is part of a shared domain ({{shared}}) or is a full-fledged domain with its own namespace ({{full}}).\\
\\This is a required attribute.\\
\\Allowed values:
* {{shared}}*— Designates a business organization that is assigned to a shared domain. Multiple business organizations can be part of a shared domain. This business organization shares its namespace with the other organizations in the domain.*
* {{full}}— Designates a business organization that is a full-fledged domain with an authorized domain name and its own unique namespace.
[Top|#top]
h3. {anchor:GAJCD} Example
{{sunOrgType: shared}}
{{sunorgtype: full}}
[Top|#top]
h3. {anchor:GAJBJ} OID
oid-sunOrgType
[Top|#top]
h2. {anchor:ANONF} sunProviderOrgDN
[Top|#top]
h3. {anchor:GAJBW} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAJAL} Syntax
dn, single-valued
[Top|#top]
h3. {anchor:GAJBZ} Object Class
[sunManagedProvider|#ANOMG]
[Top|#top]
h3. {anchor:GAJAR} Definition
Contains the base DN that points to the business organization for this provider organization. The users of this provider organization are created in this business organization.\\
\\The provider organization cannot have any user entries directly under the provider organization node. All users in the provider organization must be managed in the separate business organization identified by the {{sunProviderOrgDN}} attribute. This business organization is like any other business organization.
[Top|#top]
h3. {anchor:GAJAX} Example
{{sunProviderOrgDN: o=providerorg,o=sesta.com,o=sharedDomainsRoot,o=Business}}
[Top|#top]
h3. {anchor:GAJBH} OID
oid-sunProviderOrgDN
[Top|#top]
h2. {anchor:ANONG} sunResidentialRoot
[Top|#top]
h3. {anchor:GAJBX} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAJBL} Syntax
dn, single-valued
[Top|#top]
h3. {anchor:GAJBM} Object Class
[sunManagedLocation|#ANOMF]
[Top|#top]
h3. {anchor:GAJBG} Definition
Holds the DN of the root entry that contains the residential tree.
[Top|#top]
h3. {anchor:GAJAJ} Example
{{sunResidentialRoot: o=Residential,o=userGroupRoot}}
[Top|#top]
h3. {anchor:GAJBE} OID
Unknown
[Top|#top]
h2. {anchor:ANONH} sunServicesRoot
[Top|#top]
h3. {anchor:GAJAI} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAJBI} Syntax
dn, single-valued
[Top|#top]
h3. {anchor:GAJAY} Object Class
[sunManagedLocation|#ANOMF]
[Top|#top]
h3. {anchor:GAJCB} Definition
Specifies the DN of the container of all the class-of-service definitions available to provider organizations in the directory.
[Top|#top]
h3. {anchor:GAJBT} Example
{{sunServicesRoot: o=Services,o=Business,o=userGroupRoot}}
[Top|#top]
h3. {anchor:GAJBY} OID
Unknown
{excerpt:hidden=true}Converted by tech dogg's sgml2wiki on Fri 15 Feb 2008 at 3:08:03 PM{excerpt}
h1. {anchor:ANOMB} Communications Suite Delegated Administrator LDAP Object Classes and Attributes
This chapter describes LDAP Schema 2 object classes and attributes used by Communications Suite Delegated Administrator.
Communications Suite Delegated Administrator provides web-based console and a command-line utility ({{commadmin}}) for provisioning (users, groups, resources, organizations) for Messaging Server and Calendar Server in an LDAP Schema 2 directory.
To provision Messaging Server users in an LDAP Schema 1 directory, you must use iPlanet Delegated Administrator, a deprecated tool. For information about object classes and attributes used by iPlanet Delegated Administrator, see [iPlanet Delegated Administrator LDAP Object Classes and Attributes (Schema 1)].
The chapter is divided into two sections:
* [Object Classes|#ANOMC]
* [Attributes|#ANOMI]
The object classes and attributes are listed alphabetically.
[Top|#top]
h2. {anchor:ANOMC} Object Classes
The following object classes are used by Delegated Administrator to provision users in an LDAP Schema 2 directory:
* [sunDelegatedOrganization|#ANOMD]
* [sunMailOrganization|#ANOME]
* [sunManagedLocation|#ANOMF]
* [sunManagedProvider|#ANOMG]
* [sunSharedDomain|#ANOMH]
[Top|#top]
h2. {anchor:ANOMD} sunDelegatedOrganization
[Top|#top]
h3. {anchor:GAIVR} Supported by
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIWF} Definition
Object class that defines the properties of a business organization. For example, one property of {{sunDelegatedOrganization}} can designate a list of domain names the business organization can use for its users. Also, it can define the list of services designated by the provider organization, as available to the business organization, to be assigned to the users.
[Top|#top]
h3. {anchor:GAIVE} Superior Class
{{top}}
[Top|#top]
h3. {anchor:GAIUU} Object Class Type
auxiliary
[Top|#top]
h3. {anchor:GAIVO} OID
Unknown
[Top|#top]
h3. {anchor:GAIVN} Required Attributes
{{sunOrgType}}
[Top|#top]
h3. {anchor:GAIVD} Allowed Attributes
{{sunAvailableServices}}, {{sunAvailableDomainNames}}, {{sunMaxUsers}}, {{sunNumUsers}}, {{sunMaxGroups}}, {{unNumGroups}}, {{sunEnableGAB}}, {{sunAllowMultipleServices}}, {{sunOrganizationSkin}}
[Top|#top]
h2. {anchor:ANOME} sunMailOrganization
[Top|#top]
h3. {anchor:GAIWE} Supported by
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIWA} Definition
Object class to be added to a shared business organization that has mail service. {{sunMailOrganization}} adds two attributes ({{preferredMailHost}} and {{preferredMailMessageStore}}) that specify the mail host and message store partition where mail is stored for all users in the business organization.\\
\\You can only add the {{sunMailOrganization}} object class to a shared business organization (defined as "shared" with the {{sunOrgType}} attribute).\\
\\Do not add {{sunMailOrganization}} to a full domain business organization (defined as "full" with the {{sunOrgType}} attribute). For a full domain business organization, add the {{mailDomain}} object class, which also uses the {{preferredMailHost}} and {{preferredMailMessageStore}} attributes for provisioning the preferred mail host and message store for the domain.
[Top|#top]
h3. {anchor:GAIVI} Superior Class
{{top}}
[Top|#top]
h3. {anchor:GAIVL} Object Class Type
auxiliary
[Top|#top]
h3. {anchor:GAIUJ} OID
oid-sunMailOrganization
[Top|#top]
h3. {anchor:GAIVM} Required Attributes
{{none}}
[Top|#top]
h3. {anchor:GAIVZ} Allowed Attributes
{{preferredMailHost, preferredMailMessageStore}}
[Top|#top]
h2. {anchor:ANOMF} sunManagedLocation
[Top|#top]
h3. {anchor:GAIUI} Supported by
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIUS} Definition
Object class to be added to the user/group root suffix. This class maintains a pointer (in the form of a DN) to the location of the Business Organization Tree and Residential Tree. For example, {{o=Business}} and {{o=Residential}}, respectively.
[Top|#top]
h3. {anchor:GAIUO} Superior Class
{{top}}
[Top|#top]
h3. {anchor:GAIVC} Object Class Type
auxiliary
[Top|#top]
h3. {anchor:GAIVA} OID
Unknown
[Top|#top]
h3. {anchor:GAIVH} Required Attributes
none
[Top|#top]
h3. {anchor:GAIVV} Allowed Attributes
{{sunBusinessRoot, sunResidentialRoot, sunServicesRoot}}
[Top|#top]
h2. {anchor:ANOMG} sunManagedProvider
[Top|#top]
h3. {anchor:GAIVY} Supported by
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIVP} Definition
Object class used for storing the properties of a provider organization. Following are some of the properties maintained by {{sunManagedProvider}}:
* Types of business organizations this provider can create
* Where to create the business organizations
* Services available to this provider
* Domain names that can be used by the shared business organizations created under this provider organization
[Top|#top]
h3. {anchor:GAIVU} Superior Class
{{top}}
[Top|#top]
h3. {anchor:GAIWG} Object Class Type
auxiliary
[Top|#top]
h3. {anchor:GAIUX} OID
oid-sunManagedProvider
[Top|#top]
h3. {anchor:GAIVB} Required Attributes
None
[Top|#top]
h3. {anchor:GAIVF} Allowed Attributes
{{sunAllowBusinessOrgType, sunBusinessOrgBase, sunIncludeServices, sunExcludeServices, sunAssignableDomains, sunAllowMultipleDomains, sunProviderOrgDN}}
[Top|#top]
h2. {anchor:ANOMH} sunSharedDomain
[Top|#top]
h3. {anchor:GAIUT} Supported by
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIUW} Definition
Object class to designate a domain that can be shared across multiple business organizations (such as {{sesta.com}}).\\
\\The {{sunSharedDomain}} object class can designate a hosted domain as a shared domain. Underneath this shared domain, there can be multiple Provider Organizations. Under the Provider Organizations you can create multiple Business Organizations, all sharing the same namespace as the shared domain.
[Top|#top]
h3. {anchor:GAIUQ} Superior Class
{{top}}
[Top|#top]
h3. {anchor:GAIUK} Object Class Type
auxiliary
[Top|#top]
h3. {anchor:GAIVX} OID
oid-sunSharedDomain
[Top|#top]
h3. {anchor:GAIUV} Required Attributes
{{none}}
[Top|#top]
h3. {anchor:GAIVW} Allowed Attributes
{{none}}
[Top|#top]
h2. {anchor:ANOMI} Attributes
The following attributes are used by Delegated Administrator to provision users in an LDAP Schema 2 directory:
* [mailParentalControl|#ANOMJ]
* [mailSieveRuleRef|#ANOMK]
* [preferredMailHost|#ANOML]
* [preferredMailMessageStore|#ANOMM]
* [psIncludeInGAB|#ANOMN]
* [sunAllowBusinessOrgType|#ANOMO]
* [sunAllowMultipleDomains|#ANOMP]
* [sunAllowMultipleServices|#ANOMQ]
* [sunAssignableDomains|#ANOMR]
* [sunAvailableDomainNames|#ANOMS]
* [sunAvailableServices|#ANOMT]
* [sunBusinessOrgBase|#ANOMU]
* [sunBusinessRoot|#ANOMV]
* [sunEnableGAB|#ANOMW]
* [sunExcludeServices|#ANOMX]
* [sunIncludeServices|#ANOMY]
* [sunMaxGroups|#ANOMZ]
* [sunMaxUsers|#ANONA]
* [sunNumGroups|#ANONB]
* [sunNumUsers|#ANONC]
* [sunOrganizationSkin|#ANOND]
* [sunOrgType|#ANONE]
* [sunProviderOrgDN|#ANONF]
* [sunResidentialRoot|#ANONG]
* [sunServicesRoot|#ANONH]
[Top|#top]
h2. {anchor:ANOMJ} mailParentalControl
[Top|#top]
h3. {anchor:GAIWB} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIWD} Syntax
cis, single-valued
[Top|#top]
h3. {anchor:GAIWC} Object Class
[inetMailUser FIX|Title#ANOCE]
[Top|#top]
h3. {anchor:GAIVJ} Definition
Set to true when parental control is enabled for a user.\\
\\Messaging Server uses sieve rules to implement parental control (the ability of a family administrative account to specify mail delivery rules for one or more sub-accounts).\\
\\Parental control rules are stored in the family group entry (implemented by using {{mailSieveRuleSource}} as an attribute of the {{inetManagedGroup}} object class). When a head of family specifies parental control rules, the rules are transformed to sieve rules and stored in the family group entry.\\
\\When a sub-account is tagged for parental control, the DN of the family group entry is stored in the sub-account’s user entry (implemented with the {{mailSieveRuleRef}} attribute). In addition, the {{mailParentalControl}} attribute is set to {{true}}.\\
\\Allowed values: true, false\\
\\Default value: false
[Top|#top]
h3. {anchor:GAIUL} Example
{{mailParentalControl: true}}
[Top|#top]
h3. {anchor:GAIVK} OID
oid-mailParentalControl
[Top|#top]
h2. {anchor:ANOMK} mailSieveRuleRef
[Top|#top]
h3. {anchor:GAIVG} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIUR} Syntax
dn, single-valued
[Top|#top]
h3. {anchor:GAIVS} Object Class
[inetMailUser FIX|Title#ANOCE]
[Top|#top]
h3. {anchor:GAIUM} Definition
Specifies the DN of an LDAP entry. The referenced LDAP entry can contain additional mail filters in the entry’s {{mailSieveRuleSource}} attribute. Sieve rules specified in the referenced LDAP entry are applied before sieve rules specified in this user entry. This reference is used only when the {{mailParentalControl}} attribute is set to {{true}}.
[Top|#top]
h3. {anchor:GAIUH} Example
{{mailSieveRuleRef: cn=Sample Family Group,o=groups,o=Residential,o=userGroupRoot}}
[Top|#top]
h3. {anchor:GAIUZ} OID
oid-mailSieveRuleRef
[Top|#top]
h2. {anchor:ANOML} preferredMailHost
[Top|#top]
h3. {anchor:GAIUN} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIUP} Syntax
cis, single-valued
[Top|#top]
h3. {anchor:GAIWH} Object Classes
[mailDomain FIX|Title#ANOCK], [sunMailOrganization|#ANOME]
[Top|#top]
h3. {anchor:GAIVT} Definition
If you are provisioning an LDAP Schema 2 directory with Communications Suite Delegated Administrator, use the following definition:\\
\\Sets the mail host name for new users in this business organization. When a user is created, the {{mailHost}} attribute of the user entry is filled by the value of {{preferredMailHost}}.\\
\\The {{preferredMailHost}} attribute is required when the business organization has a mail service.\\
\\If this is a full business organization, {{preferredMailHost}} is an attribute of the {{mailDomain}} object class. If this is a shared business organization, {{preferredMailHost}} is an attribute of the {{sunMailOrganization}} object class.\\
\\If you are provisioning an LDAP Schema 1 directory with iPlanet Delegated Administrator:\\
\\See [preferredMailHost FIX|Title#ANOJF] for a definition of how to use this attribute with Schema 1.
[Top|#top]
h3. {anchor:GAIXV} Example
{{preferredMailHost: mail.siroe.com}}
[Top|#top]
h3. {anchor:GAIXR} OID
2.16.840.1.113730.3.1.761
[Top|#top]
h2. {anchor:ANOMM} preferredMailMessageStore
[Top|#top]
h3. {anchor:GAIXY} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIWY} Syntax
cis, single-valued
[Top|#top]
h3. {anchor:GAIYA} Object Classes
[mailDomain FIX|Title#ANOCK], [sunMailOrganization|#ANOME]
[Top|#top]
h3. {anchor:GAIYD} Definition
If you are provisioning an LDAP Schema 2 directory with Communications Suite Delegated Administrator, use the following definition:\\
\\Sets the message store partition name for new users in this business organization. When a user is created, the {{mailMessageStore}} attribute of the user entry is filled by the value of {{preferredMailMessageStore}}.\\
\\If the {{preferredMailMessageStore}} attribute is missing, Delegate Administrator leaves the {{mailMessageStore}} attribute empty and the access server assumes that the user’s mailbox is in the default partition of the server instance.\\
\\If this is a full business organization, {{preferredMailMessageStore}} is an attribute of the {{mailDomain}} object class. If this is a shared business organization, {{preferredMailMessageStore}} is an attribute of the {{sunMailOrganization}} object class.\\
\\If you are provisioning an LDAP Schema 1 directory with iPlanet Delegated Administrator:\\
\\See [preferredMailMessageStore FIX|Title#ANOJG] for a definition of how to use this attribute with Schema 1.
[Top|#top]
h3. {anchor:GAIYC} Example
{{preferredMailMessageStore: primary}}
[Top|#top]
h3. {anchor:GAIXJ} OID
2.16.840.1.113730.3.1.762
[Top|#top]
h2. {anchor:ANOMN} psIncludeInGAB
[Top|#top]
h3. {anchor:GAIWP} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIYB} Syntax
cis, single-valued
[Top|#top]
h3. {anchor:GAIXA} Object Class
[ipUser|Messaging Server and Calendar Server LDAP Object Classes and Attributes#ipUser]
[Top|#top]
h3. {anchor:GAIXO} Definition
Includes this user in the Global Address Book (GAB) and gives this user access to the Global Address Book.\\
\\Allowed values: {{true}}, {{false}}\\
\\Default value: {{true}}
[Top|#top]
h3. {anchor:GAIXH} Example
{{psIncludeInGAB: false}}
[Top|#top]
h3. {anchor:GAIWW} OID
oid-psIncludeInGAB
[Top|#top]
h2. {anchor:ANOMO} sunAllowBusinessOrgType
[Top|#top]
h3. {anchor:GAIWO} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIWJ} Syntax
cis, multi-valued
[Top|#top]
h3. {anchor:GAIWT} Object Class
[sunManagedProvider|#ANOMG]
[Top|#top]
h3. {anchor:GAIXF} Definition
Defines the types of business organizations this provider administrator can create.\\
\\This is a required attribute.\\
\\Allowed values:
* {{shared}}*— Designates a business organization that is assigned to a shared domain. Multiple business organizations can be part of a shared domain. The business organization being created shares its namespace with the other organizations in the domain.*
* {{full}}— Designates a business organization that is a full-fledged domain with an authorized domain name and its own unique namespace.
The {{sunAllowBusinessOrgType}} attribute can enable the provider to create
* Only shared business organizations ({{shared}} value only)
* Only business organizations that are real, full-fledged domains ({{full}} value only)
* Both shared and full-fledged business organizations ({{shared}} and {{full}} values)
[Top|#top]
h3. {anchor:GAIXS} Example
{{sunAllowBusinessOrgType: sharedsunAllowBusinessOrgType: full}}
[Top|#top]
h3. {anchor:GAIXN} OID
oid-sunAllowBusinessOrgType
[Top|#top]
h2. {anchor:ANOMP} sunAllowMultipleDomains
[Top|#top]
h3. {anchor:GAIYE} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIXX} Syntax
cis, single-valued
[Top|#top]
h3. {anchor:GAIWR} Object Class
[sunManagedProvider|#ANOMG]
[Top|#top]
h3. {anchor:GAIXG} Definition
Determines whether this provider organization can create business organizations that permit multiple domain names or a single domain name for their users.\\
\\The {{sunAllowMultipleDomains}} attribute applies only to business organizations created in shared domains. If a business organization is created as a domain with its own namespace, it can always have multiple domain names specified with the {{associatedDomain}} attribute.\\
\\If the {{sunAllowMultipleDomains}} attribute is not present, the LDAP semantics allow multiple domain names for the users of the business organizations. (The default value is true.)\\
\\Allowed values: {{true}}, {{false}}
[Top|#top]
h3. {anchor:GAIXP} Example
{{sunAllowMultipleDomains:}} {{true}}
[Top|#top]
h3. {anchor:GAIWQ} OID
oid-sunAllowMultipleDomains
[Top|#top]
h2. {anchor:ANOMQ} sunAllowMultipleServices
[Top|#top]
h3. {anchor:GAIWX} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIWM} Syntax
cis, single-valued
[Top|#top]
h3. {anchor:GAIWN} Object Class
[sunDelegatedOrganization|#ANOMD]
[Top|#top]
h3. {anchor:GAIYG} Definition
NOTE: This attribute is not being used for this release.\\
\\Enables you to assign multiple classes-of-service to users in this business organization.\\
\\Allowed values: {{true}}, {{false}}\\
\\Default value: {{true}}\\
\\If {{sunAllowMultipleServices}} has a value of {{false}}, users in this business organization can have at most one class-of-service.
[Top|#top]
h3. {anchor:GAIXE} Example
{{sunAllowMultipleServices: false}}
[Top|#top]
h3. {anchor:GAIXT} OID
oid-sunAllowMultipleServices
[Top|#top]
h2. {anchor:ANOMR} sunAssignableDomains
[Top|#top]
h3. {anchor:GAIWV} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIXB} Syntax
cis, multi-valued
[Top|#top]
h3. {anchor:GAIYF} Object Class
[sunManagedProvider|#ANOMG]
[Top|#top]
h3. {anchor:GAIWK} Definition
Specifies a list of domain names the provider administrator can choose from when assigning domains to business organizations in this provider organization. This list is derived from the domain names specified in the {{sunPreferredDomain}} and {{associatedDomain}} attributes of the parent or ancestor shared domain node.\\
\\If the sunAssignableDomains attribute is not present, all of the {{sunPreferredDomain}} and {{associatedDomain}} attributes are available to be assigned to business organizations by this provider.
[Top|#top]
h3. {anchor:GAIXW} Example
{{sunAssignableDomains:}} {{sesta.com}} {{sunAssignableDomains:}} {{siroe.com}} {{sunAssignableDomains:}} {{varius.com}}
[Top|#top]
h3. {anchor:GAIWZ} OID
oid-sunAssignableDomains
[Top|#top]
h2. {anchor:ANOMS} sunAvailableDomainNames
[Top|#top]
h3. {anchor:GAIXD} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIXQ} Syntax
cis, multi-valued
[Top|#top]
h3. {anchor:GAIXZ} Object Class
[sunDelegatedOrganization|#ANOMD]
[Top|#top]
h3. {anchor:GAIXM} Definition
Specifies a list of domain names available for use by the business organization. This list is a subset of domain names derived from the {{sunAssignableDomains}} attribute in the provider organization.\\
\\If the {{sunAvailableDomainNames}} attribute is not present, all domains from the {{sunAssignableDomains}} attribute in the provider organization are available for use by this business organization.
[Top|#top]
h3. {anchor:GAIXI} Example
{{sunAvailableDomainNames: sesta.comsunAvailableDomainNames: siroe.com}}
[Top|#top]
h3. {anchor:GAIWU} OID
oid-sunAvailableDomainNames
[Top|#top]
h2. {anchor:ANOMT} sunAvailableServices
h3. {anchor:GAIXU} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
h3. {anchor:GAIXK} Syntax
cis, multi-valued
h3. {anchor:GAIXC} Object Class
[sunDelegatedOrganization|#ANOMD]
h3. {anchor:GAIWS} Definition
Specifies a list of Service Packages available to the business organization for its users and groups. Also specifies the number of instances of each named class-of-service.\\
\\This is a required attribute.
h3. {anchor:GAIWL} Format
The value of the attribute has two possible formats:
h4. Limited Allocation
_servicename_:_number_:_number_assigned_
* _number_ is the number of service packages allocated to the organization\\
* _number_assigned_ is the number of service packages assigned to users or groups in the organization. If no service packages have been assigned, the value of _number_assigned_ is {{-1}}.\\
h4. Unlimted
_servicename_
If you specify _servicename_ only—if you do not specify the _number_ of services allocated and assigned—an unlimited number of that service is available to the business organization.
h3. {anchor:GAIXL} Example
{panel}
{{sunAvailableServices:Gold:10:–1}}
{{sunAvailableServices:Mercury:20:5 }}
{{sunAvailableServices:Silver}}
{panel}
In this example, 10 Gold services are available to the organization, 0 have been assigned. 20 Mercury services are available to the organization, 5 have been assigned. An unlimited number of Silver services are available to the organization.
h3. {anchor:GAIZD} OID
oid-sunAvailableServices
h2. {anchor:ANOMU} sunBusinessOrgBase
[Top|#top]
h3. {anchor:GAIZO} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIYZ} Syntax
dn, single-valued
[Top|#top]
h3. {anchor:GAIZE} Object Class
[sunManagedProvider|#ANOMG]
[Top|#top]
h3. {anchor:GAIZI} Definition
Contains the DN for the node underneath which all full domains for this provider organization are to be created.\\
\\You can assign this attribute only if the {{sunAllowBusinessOrgType}} attribute was provisioned to allow full domains ({{sunAllowBusinessOrgType: full}}).
[Top|#top]
h3. {anchor:GAIYV} Example
{{sunBusinessOrgBase: o=providerorgDomainsRoot,o=Business,o=userGroupRoot}}
[Top|#top]
h3. {anchor:GAJAG} OID
oid-sunBusinessOrgBase
h2. {anchor:ANOMV} sunBusinessRoot
[Top|#top]
h3. {anchor:GAJAF} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIZS} Syntax
dn, single-valued
[Top|#top]
h3. {anchor:GAIYU} Object Class
[sunManagedLocation|#ANOMF]
[Top|#top]
h3. {anchor:GAIYW} Definition
Holds th[Top|#top]
e DN of the root entry that contains the business organization tree.
[Top|#top]
h3. {anchor:GAIZW} Example
{{sunBusinessRoot: o=Business,o=userGroupRoot}}
[Top|#top]
h3. {anchor:GAIYS} OID
oid-sunBusinessRoot
[Top|#top]
h2. {anchor:ANOMW} sunEnableGAB
[Top|#top]
h3. {anchor:GAJAC} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIZU} Syntax
cis, single-valued
[Top|#top]
h3. {anchor:GAIZQ} Object Class
[sunDelegatedOrganization|#ANOMD]
[Top|#top]
h3. {anchor:GAIYY} Definition
Enables use of a global address book for this business organization.\\
\\Allowed values: {{true}}, {{false}}\\
\\Default value: {{false}}
[Top|#top]
h3. {anchor:GAIZK} Example
{{sunEnableGAB: true}}
[Top|#top]
h3. {anchor:GAJAD} OID
oid-sunEnableGAB
[Top|#top]
h2. {anchor:ANOMX} sunExcludeServices
[Top|#top]
h3. {anchor:GAIYK} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIYP} Syntax
cis, multi-valued
[Top|#top]
h3. {anchor:GAIZJ} Object Class
[sunManagedProvider|#ANOMG]
[Top|#top]
h3. {anchor:GAIZL} Definition
Specifies a list of classes-of-service that will be excluded from the business organizations in this provider organization.\\
\\If both the {{sunIncludeServices}} and {{sunExcludeServices}} attributes are specified, only {{sunIncludeServices}} takes effect. If neither attribute is present, all classes-of-service found underneath the container specified with the {{sunServicesRoot}} attribute will also be available to the business organizations in this provider organization.
[Top|#top]
h3. {anchor:GAIZB} Example
{{sunExcludeServices: Bronze}}
[Top|#top]
h3. {anchor:GAIZZ} OID
oid-sunExcludeServices
[Top|#top]
h2. {anchor:ANOMY} sunIncludeServices
[Top|#top]
h3. {anchor:GAIYI} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIZT} Syntax
cis, multi-valued
[Top|#top]
h3. {anchor:GAIZN} Object Class
[sunManagedProvider|#ANOMG]
[Top|#top]
h3. {anchor:GAIZR} Definition
Specifies a list of the classes-of-service available to business organizations in this provider organization.\\
\\The complete list of classes-of-service available in this directory is found underneath the container specified with the {{sunServicesRoot}} attribute.\\
\\If the {{sunIncludeServices}} attribute is not present, all classes-of-service specified underneath the class-of-service container will also be available to the business organizations in this provider organization.
[Top|#top]
h3. {anchor:GAIYH} Example
{{sunIncludeServices: Gold}}
[Top|#top]
h3. {anchor:GAIZH} OID
oid-sunIncludeServices
[Top|#top]
h2. {anchor:ANOMZ} sunMaxGroups
[Top|#top]
h3. {anchor:GAIYO} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIYL} Syntax
integer, single-valued
[Top|#top]
h3. {anchor:GAIZC} Object Class
[sunDelegatedOrganization|#ANOMD]
[Top|#top]
h3. {anchor:GAIYX} Definition
Specifies the maximum number of groups that can be created in this business organization.\\
\\To enable the business organization to contain an unlimited number of groups, specify a value of {{-1}}.\\
\\Allowed values are integers.
[Top|#top]
h3. {anchor:GAIYQ} Example
{{sunMaxGroups: 20}}
[Top|#top]
h3. {anchor:GAIZV} OID
oid-sunMaxGroups
[Top|#top]
h2. {anchor:ANONA} sunMaxUsers
[Top|#top]
h3. {anchor:GAIZA} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAJAA} Syntax
integer, single-valued
[Top|#top]
h3. {anchor:GAIZF} Object Class
[sunDelegatedOrganization|#ANOMD]
[Top|#top]
h3. {anchor:GAIZX} Definition
Specifies the maximum number of users who can be created in this business organization.\\
\\To enable the business organization to contain an unlimited number of users, specify a value of {{-1}}.\\
\\Allowed values are integers.
[Top|#top]
h3. {anchor:GAJAB} Example
{{sunMaxUsers: 50}}
[Top|#top]
h3. {anchor:GAIYM} OID
oid-sunMaxUsers
[Top|#top]
h2. {anchor:ANONB} sunNumGroups
[Top|#top]
h3. {anchor:GAIZP} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIYT} Syntax
integer, single-valued
[Top|#top]
h3. {anchor:GAIZY} Object Class
[sunDelegatedOrganization|#ANOMD]
[Top|#top]
h3. {anchor:GAIZM} Definition
Specifies the current number of groups in this business organization.\\
\\Allowed values are integers.
[Top|#top]
h3. {anchor:GAIYR} Example
{{sunNumGroups: 8}}
[Top|#top]
h3. {anchor:GAIYN} OID
oid-sunNumGroups
[Top|#top]
h2. {anchor:ANONC} sunNumUsers
[Top|#top]
h3. {anchor:GAIYJ} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAIZG} Syntax
integer, single-valued
[Top|#top]
h3. {anchor:GAJAE} Object Class
[sunDelegatedOrganization|#ANOMD]
[Top|#top]
h3. {anchor:GAJBA} Definition
Specifies the current number of users in this business organization.\\
\\Allowed values are integers.
NOTE: This number is maintained by Delegated Administrator. Manual changes to the number of users (using ldapmodify) will not be reflected in the count.
[Top|#top]
h3. {anchor:GAJAH} Example
{{sunNumUsers: 12}}
[Top|#top]
h3. {anchor:GAJBO} OID
oid-sunNumUsers
[Top|#top]
h2. {anchor:ANOND} sunOrganizationSkin
[Top|#top]
h3. {anchor:GAJBF} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAJAU} Syntax
cis, multi-valued
[Top|#top]
h3. {anchor:GAJAT} Object Class
[sunDelegatedOrganization|#ANOMD]
[Top|#top]
h3. {anchor:GAJCC} Definition
This attribute is not currently implemented.\\
\\Enables this business organization to use a specified customization of the user interface (UI) to provide a specific look and feel for users in the organization.\\
\\The {{sunOrganizationSkin}} attribute is specified with a key-value pair. The key is the name of a skin to be used for the organization’s customized UI. The value identifies the jar file containing the skin.
[Top|#top]
h3. {anchor:GAJAM} Format
_skinname_:_jarfile_
[Top|#top]
h3. {anchor:GAJAS} Examples
{{sunOrganizationSkin: classic: classiclookandfeel.jarsunOrganizationSkin: modern: modernlookandfeel.jar}}
[Top|#top]
h3. {anchor:GAJAP} OID
oid-sunOrganizationSkin
[Top|#top]
h2. {anchor:ANONE} sunOrgType
[Top|#top]
h3. {anchor:GAJAW} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAJAN} Syntax
cis, single-valued
[Top|#top]
h3. {anchor:GAJBP} Object Class
[sunDelegatedOrganization|#ANOMD]
[Top|#top]
h3. {anchor:GAJCG} Definition
Determines whether this business organization is part of a shared domain ({{shared}}) or is a full-fledged domain with its own namespace ({{full}}).\\
\\This is a required attribute.\\
\\Allowed values:
* {{shared}}*— Designates a business organization that is assigned to a shared domain. Multiple business organizations can be part of a shared domain. This business organization shares its namespace with the other organizations in the domain.*
* {{full}}— Designates a business organization that is a full-fledged domain with an authorized domain name and its own unique namespace.
[Top|#top]
h3. {anchor:GAJCD} Example
{{sunOrgType: shared}}
{{sunorgtype: full}}
[Top|#top]
h3. {anchor:GAJBJ} OID
oid-sunOrgType
[Top|#top]
h2. {anchor:ANONF} sunProviderOrgDN
[Top|#top]
h3. {anchor:GAJBW} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAJAL} Syntax
dn, single-valued
[Top|#top]
h3. {anchor:GAJBZ} Object Class
[sunManagedProvider|#ANOMG]
[Top|#top]
h3. {anchor:GAJAR} Definition
Contains the base DN that points to the business organization for this provider organization. The users of this provider organization are created in this business organization.\\
\\The provider organization cannot have any user entries directly under the provider organization node. All users in the provider organization must be managed in the separate business organization identified by the {{sunProviderOrgDN}} attribute. This business organization is like any other business organization.
[Top|#top]
h3. {anchor:GAJAX} Example
{{sunProviderOrgDN: o=providerorg,o=sesta.com,o=sharedDomainsRoot,o=Business}}
[Top|#top]
h3. {anchor:GAJBH} OID
oid-sunProviderOrgDN
[Top|#top]
h2. {anchor:ANONG} sunResidentialRoot
[Top|#top]
h3. {anchor:GAJBX} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAJBL} Syntax
dn, single-valued
[Top|#top]
h3. {anchor:GAJBM} Object Class
[sunManagedLocation|#ANOMF]
[Top|#top]
h3. {anchor:GAJBG} Definition
Holds the DN of the root entry that contains the residential tree.
[Top|#top]
h3. {anchor:GAJAJ} Example
{{sunResidentialRoot: o=Residential,o=userGroupRoot}}
[Top|#top]
h3. {anchor:GAJBE} OID
Unknown
[Top|#top]
h2. {anchor:ANONH} sunServicesRoot
[Top|#top]
h3. {anchor:GAJAI} Origin
Messaging Server 6 2006Q2; Communications Suite Delegated Administrator
[Top|#top]
h3. {anchor:GAJBI} Syntax
dn, single-valued
[Top|#top]
h3. {anchor:GAJAY} Object Class
[sunManagedLocation|#ANOMF]
[Top|#top]
h3. {anchor:GAJCB} Definition
Specifies the DN of the container of all the class-of-service definitions available to provider organizations in the directory.
[Top|#top]
h3. {anchor:GAJBT} Example
{{sunServicesRoot: o=Services,o=Business,o=userGroupRoot}}
[Top|#top]
h3. {anchor:GAJBY} OID
Unknown
{excerpt:hidden=true}Converted by tech dogg's sgml2wiki on Fri 15 Feb 2008 at 3:08:03 PM{excerpt}