Solaris ISP Server Attributes

This section describes the attributes used by object classes added to the basic schema for Solaris ISP Server. Some of these attributes are a part of the base schema, but are included here for ease of use. Attributes created for the Solaris ISP Server schema extension begin with "isp."

Attributes defined in the schema have one of the following syntaxes:

• bin: binary

• ces: case-exact string

  A case-sensitive alphanumeric string.

• cis: case-ignore string

  An alphanumeric string, not case-sensitive.

• dn: distinguished name

• protected: encrypted

  A value that has been encrypted using crypt

• int or long: integer

• tel: telephone number

• utctime: UTC time

The following list presents attributes in alphabetical order.

associatedDomain Attribute

Summary: cis, multi-valued, base schema

Purpose: Specifies the domain with which the object described by the entry is associated. For the OSI tree entry of a domain, must contain the name (in dot notation, for example, eng.sun.com) of the corresponding DC tree entry.

associatedName Attribute

Summary: dn, base schema

Purpose: Specifies the distinguished name of an entry associated with this entry. For the DC tree entry of a domain, must contain the distinguished name of the corresponding OSI tree entry.

commonName Attribute

Alternate name: cn

Summary: cis, multi-valued, base schema

Purpose: Specifies the full name of the object described by the entry.

Subscriber and administrator entries use the form Firstname Lastname (uid). For example, user John Smith who uses the login name jsmith would have an entry in the directory. Its commonName attribute would contain the value John Smith (jsmith).

The ispManagedService object class uses this attribute for the user-friendly name displayed in the Sun Internet Administrator GUI.

description Attribute

Summary: cis, multi-valued, base schema

Purpose: Specifies an arbitrary description of the entry object.

gidNumber Attribute

Summary: long, single-valued, base schema

Purpose: Specifies the UNIX group-ID of files created via FTP by this user.

homeDirectory Attribute

Summary: ces, single-valued, base schema

Purpose: Specifies the file system location of the home directory of the user described by the entry. This attribute is not used by Solaris ISP Server, but is left for general information required by the customer.

host Attribute

Summary: cis, multi-valued, base schema

Purpose: Specifies the name of the machine associated with or managed by the object described by the entry. When used with Solaris ISP Server object entries, the host attribute must contain the fully-qualified host name.

ispAdministeredService Attribute

Summary: dn, multi-valued, Solaris ISP Server schema extension

Purpose: Specifies the services (by distinguished names of the top-level service entries) that an administrator can manage. The top-level entry for a service is an ispService object under the root domain entry. For example, under ou=services,o=sun,c=us where sun.com is the root domain entry.

ispAuthorizedServices Attribute

Summary: dn, multivalued, Solaris ISP Server schema extension

Purpose: Specifies the services (by distinguished name) that an ispSubscriber is authorized to use.

ispCategory Attribute

Summary: cis, single-valued, Solaris ISP Server schema extension

Purpose: Specifies the category of graphical user interface supported by the service described by the entry. Acceptable values are:

• 2tier, indicating that the user interface is Web-based and uses the two-tier architecture supported by Sun Internet Administrator.

• 3tier, indicating that the user interface is Web-based and uses the three-tier architecture supported by Sun Internet Administrator.

• CLI, indicating that the user interface is a command-line utility.

• X, indicating that the user interface is an X-based program.

ispContentDirectory Attribute

Summary: ces, single-valued, Solaris ISP Server schema extension

Purpose: Specifies a directory location (which may be distinct from that in the homeDirectory attribute) where content belonging to a user is located. Used by ispAdministrator and ispSubscriber classes. For a user with virtually-hosted FTP services, must contain the path (relative to the ispDirectoryRoot of the domain) to the user's FTP content.

ispDirectoryRoot Attribute

Summary: ces, single-valued, Solaris ISP Server schema extension

Purpose: Specifies a root directory for an ISP service, usually on a per-domain basis.

ispImageFile Attribute

Summary: cis, single-valued, Solaris ISP Server schema extension

Purpose: Specifies the name of a file containing the image described by the entry. The ispManagedService object class uses this attribute to specify its GIF-format icon file.

ispPrivateData Attribute

Summary: ces, single-valued, Solaris ISP Server schema extension

Purpose: Specifies software component password information used by Sun Internet Administrator. This attribute is protected by ACLs from access by users other than the Sun Directory Services root administrator.

ispServiceContext Attribute

Summary: ces, single-valued, Solaris ISP Server schema extension

Purpose: Specifies a service context for use by an ISP service. For Sun Internet FTP Server and Sun Internet News Server, this is a CORBA naming context.

ispServiceLocation Attribute

Summary: ces, single-valued, Solaris ISP Server schema extension

Purpose: Specifies the location of the ispService object described by the entry.

Sun Internet FTP Server and Sun Internet News Server use this attribute in an ispService object to store a CORBA stringified object reference to their administration servers. Sun Internet Administrator uses this attribute in an ispManagedService object to store the path to an X-based user interface application.

ispServlets Attribute

Summary: ces, multivalued, Solaris ISP Server schema extension

Purpose: Specifies the fully-qualified Java class name of a servlet used in an ispManagedService's administration user interface. For each servlet used, assign an ispServlets attribute with the following value:

1. The path to the servlet, relative to the document root of the administration Web server (part of Sun Internet Administrator)

2. The fully-qualified Java class name of the servlet

3. Any required servlet arguments, listed by name and value

ispServletClasspath Attribute

Summary: ces, single-valued, Solaris ISP Server schema extension

Purpose: Specifies the Java classpath for classes required by an ispManagedService's administration user interface. A Java classpath may contain several paths; separate them with colons (:).

ispParameterizedOperation Attribute

Summary: ces, multivalued, Solaris ISP Server schema extension

Purpose: Specifies information about a command-line function that takes parameters. For an ispManagedService object, three space-delimited fields of information are required:

1. The complete path to the command-line utility

2. The complete path to a help file for the utility, or NONE if there is no help information for the utility.

3. An arbitrary string, containing the space-delimited parameters required by the utility. If parameters are accepted from the user on the command line, this field holds the string SOME.

ispSupplementaryInformation Attribute

Summary: cis, multivalued, base schema

Purpose: Holds additional information concerning the object described by the entry. In object classes that extend the base schema, this attribute is reserved for Solaris ISP Server service-specific needs.

ispSupportedOperation Attribute

Summary: ces, multivalued, Solaris ISP Server schema extension

Purpose: Stores information on a supported command-line utility that accepts no parameters. For an ispManagedService object, three space-delimited fields of information are required:

1. The complete path to the command-line utility

2. The complete path to a help file for the utility, or NONE if there is no help information for the utility.

3. The string NONE.

ispVersion Attribute

Summary: ces, single-valued, Solaris ISP Server schema extension

Purpose: Specifies the release version of the ispService object described by this entry. Solaris ISP Server uses the form major.minor for the version attribute.

labeledURI Attribute

Alternate name: labeledURL

Summary: ces, multi-valued, base schema

Purpose: Specifies a Uniform Resource Identifier (URI) and label associated with the object described by the entry.

mail Attribute

Alternate name: preferredRfc822Originator

Summary: cis, multi-valued, base schema

Purpose: Specifies the advertised electronic mail address, in RFC822 format, of the object described by the entry. Sun Internet FTP Server uses this attribute as an error-reporting address.

objectClass Attribute

Summary: cis, multivalued, base schema

Purpose: Specifies the object class of the type of entry.

ou Attribute

Alternate name: organizationUnitName

Summary: cis, base schema

Purpose: Specifies the name of the organization unit to which the object described by the entry belongs.

surname Attribute

Alternate name: sn

Summary: cis, base schema

Purpose: Specifies the surname of the person described by the entry.

uidNumber Attribute

Summary: long, single-valued, base schema

Purpose: Specifies the UNIX user-ID of files created via FTP by this user.

userCertificate Attribute

Summary: bin, base schema

Purpose: Specifies a certificate containing the public key of the user described by the entry.

userid Attribute

Alternate name: uid

Summary: cis, multi-valued, base schema

Purpose: Specifies the login name of the user described by the entry.

userPassword Attribute

Summary: protected, multi-valued, base schema

Purpose: Specifies the password for the entity described by the entry.