Services Class Reference

Services defined for the system. More...

Inheritance diagram for Services:

Collaboration diagram for Services:

Public Member Functions
_.Library.Boolean	IsPublic ()
	Service is public. More...

Static Public Member Functions
_.Library.Boolean	Exists (_.Library.String Name, _.Library.ObjectHandle Service, _.Library.Status Status)
	Service exists. More...
_.Library.Status	Export (_.Library.String FileName, _.Library.Integer NumExported, _.Library.String Services)
	This method exports Service records to a file in xml format. More...
_.Library.Status	Get (_.Library.String Name, _.Library.String Properties)
	Get a service's properties. More...
_.Library.Status	Import (_.Library.String FileName, _.Library.Integer NumImported, _.Library.Integer Flags)
	Import Service records from an xml file. More...
_.Library.Status	Modify (_.Library.String Name, _.Library.String Properties)
	Modify a Service's properties. More...

Public Attributes
	AutheEnabled
	Authentication methods enabled for the service More...
	ClientSystems
	List of valid IP addresses allowed to connect for this service. More...
	Description
	Full name of the service. More...
	Enabled
	Service enabled. More...
	Name
	Name of the service. More...

Detailed Description

Services defined for the system.

The table for this class should be manipulated only through object access, the published API's or through the System Management Portal. It should not be updated through direct SQL access.

Member Function Documentation

Exists()

_.Library.Boolean Exists ( _.Library.String  Name, _.Library.ObjectHandle  Service, _.Library.Status  Status  )

static

Service exists.

This method checks for the existence of a Service in the security database.
Parameters:
Name - Name of the Service to check existence of
Return values:
If Value of the method = 0 (Service does not exist, or some error occured)
Service = Null
Status = Service "x" does not exist, or other error message<br>
If Value of the method = 1 (Service exists)
Service = Object handle to Service
Status = $$$OK

Export()

_.Library.Status Export ( _.Library.String  FileName, _.Library.Integer  NumExported, _.Library.String  Services  )

static

This method exports Service records to a file in xml format.

Parameters:
Filename - Output file name
NumExported (byref) - Returns number of records exported.
Services - Comma separated list of Services to export, "*" = All

Get()

_.Library.Status Get ( _.Library.String  Name, _.Library.String  Properties  )

static

Get a service's properties.

Gets a service's properties from the security database.
Parameters:
Name - Name of the Service to get
Return values:
Properties - Array of properties
Properties("AutheEnabled") - Enabled authentication options
Properties("AutheEnabledCapabilities") - Allowed authentication options (Internal use only)
Properties("Capabilities") - Additional capability options (Internal use only)
Properties("Enabled") - Service is enabled
Properties("Description") - Full name of the service
Properties("ClientSystems") - Semicolon separated list of allowed IP connections, "ipsec1;ipspec2;ipspec3" (On some services, an ipspec can be ip|role1,role2,etc.)

Import()

_.Library.Status Import ( _.Library.String  FileName, _.Library.Integer  NumImported, _.Library.Integer  Flags  )

static

Import Service records from an xml file.

Parameters:
FileName - Filename to import Service records from
NumImported (byref) - Returns number of records imported
Flags - Control import
Bit 0 - Do not import records, just return count
Note: On failure, no records will be imported

IsPublic()

_.Library.Boolean IsPublic

(

)

Service is public.

Modify()

_.Library.Status Modify ( _.Library.String  Name, _.Library.String  Properties  )

static

Modify a Service's properties.

Modifies a Service's properties from the security database.
Parameters:
Name - Name of the service to modify
Properties - Array of properties to modify.
See the Get() method for a description of the Properties parameter.
If a specific property is not passed in the properties array, the value is not modified. Note that some system defined properties are not changeable.

Member Data Documentation

AutheEnabled

AutheEnabled

Authentication methods enabled for the service

Bit 0 = AutheK5CCache
Bit 1 = AutheK5Prompt
Bit 2 = AutheK5API
Bit 3 = AutheK5KeyTab
Bit 4 = AutheOS
Bit 5 - AuthePassword
Bit 6 = AutheUnauthenticated
Bit 7 = AutheKB
Bit 8 = AutheKBEncryption
Bit 9 = AutheKBIntegrity
Bit 10 = AutheSystem
Bit 11 = AutheLDAP
Bit 13 = AutheDelegated
Bit 14 = AutheLoginToken
Bits 15-19 reserved
Bit 20 = TwoFactorSMS
Bit 21 = TwoFactorPW
Bits 22-24 reserved
Bit 25 = MutualTLS
 

ClientSystems

ClientSystems

List of valid IP addresses allowed to connect for this service.

 

Description

Description

Full name of the service.

 

Enabled

Enabled

Service enabled.

 

Name

Name

Name of the service.