class MtasSubsDataMgmt

ManagedElement
+-MtasFunction
+-MtasSubsData
+-MtasSubsDataMgmt

This MtasSubsDataMgmt MO specifies data that is to be used for subscriber data management in an MTAS node.

Administrative operations:
- mtasSubsDataMgmtRunQuery: It provides the operator the ability to query the cached subscriber data and scheduled conference data on the MTAS and to place the result of the query into a file which may be retrieved by the operator. The "mtasSubsDataMgmtRunQueryPui" parameter (string; 0-255 characters) of the operation defines the PUI / ServiceNumber to be used as filter for the Query action. The parameter may contain a full PUI / ServiceNumber (including Sip: or Tel:) or a wild carded string which is to be used as a filter to match MMTel / Scheduled Conference data related to the specified PUIs / ServiceNumbers stored (cached) in the MTAS. The wild card character * may be used to match any number of characters including the sip: or tel: URI prefix. No URI-attributes are considered when matching the input PUI / ServiceNumber to those held on the MTAS.
The status of the asynchronous operation - that is either Finished (0) or Processing Query (1) - is reflected in the mtasSubsDataMgmtStatus attribute.

- mtasSubsDataMgmtRunPurge: It provides the operator the ability to purge the cached subscriber data and scheduled conference data on the MTAS and to place the result of the purge into a file which may be retrieved by the operator. The "mtasSubsDataMgmtRunPurgePui" parameter (string; 0-255 characters) of the operation defines the PUI / ServiceNumber to be used as filter for the Purge action. The parameter may contain a full PUI / ServiceNumber (including Sip: or Tel:) or a wild carded string which is to be used as a filter to match MMTel / Scheduled Conference data related to the specified PUIs / ServiceNumbers stored (cached) in the MTAS. The wild card character * may be used to match any number of characters including the sip: or tel: URI prefix. No URI-attributes are considered when matching the input PUI / ServiceNumber to those held on the MTAS.
The status of the asynchronous operation - that is either Finished (0) or Processing Purge (2) - is reflected in the mtasSubsDataMgmtStatus attribute.

- mtasSubsDataMgmtStop: It allows the operator to stop the processing of an ongoing query or purge operation.

For further details on how to invoke an administrative operation, see the LDAP Interface Description (2/155 19-CRA 119 638/4; chapter "Extended Operation").


This MO is created by the system.

Actions
string
mtasSubsDataMgmtRunPurge ( MtasString0to255DT mtasSubsDataMgmtRunPurgePui );
The mtasSubsDataMgmtRunPurge adminsitrative operation provides the operator the ability to purge the cached subscriber data on the MTAS and to place the result of the purge into a file which may be retrieved by the operator.
The status of the asynchronous operation - that is either FINISHED (0) or PROCESSING_PURGE (2) - is reflected in the mtasSubsDataMgmtStatus attribute.


Dependencies: The administrative operation can't be invoked unless the value of the mtasSubsDataMgmtStatus attribute is FINISHED (0).

Parameters

Name: mtasSubsDataMgmtRunPurgePui
Description: This parameter defines the PUI to be used for the Purge action.
The parameter may contain a full PUI (including Sip: or Tel:) or a wild carded string which is to be used to match PUIs stored in the MTAS. The wild card character * may be used to match any number of characters including the sip: or tel: URI prefix. No URI-attributes are considered when matching the input PUI to those held on the MTAS.


string
mtasSubsDataMgmtRunQuery ( MtasString0to255DT mtasSubsDataMgmtRunQueryPui );
The mtasSubsDataMgmtRunQuery administrative operation provides the operator the ability to query the cached subscriber data on the MTAS and to place the result of the query into a file which may be retrieved by the operator.
The status of the asynchronous operation - that is either FINISHED (0) or PROCESSING_QUERY (1) - is reflected in the mtasSubsDataMgmtStatus attribute.


Dependencies: The administrative operation can't be invoked unless the value of the mtasSubsDataMgmtStatus attribute is FINISHED (0).

Parameters

Name: mtasSubsDataMgmtRunQueryPui
Description: This parameter defines the PUI to be used for the Query action.
The parameter may contain a full PUI (including Sip: or Tel:) or a wild carded string which is to be used to match PUIs stored in the MTAS. The wild card character * may be used to match any number of characters including the sip: or tel: URI prefix. No URI-attributes are considered when matching the input PUI to those held on the MTAS.


string
mtasSubsDataMgmtStop ( );
The mtasSubsDataMgmtStop administrative operation allows the operator to stop the processing of an ongoing query or purge operation.

Dependencies: The administrative operation can't be invoked unless the value of the mtasSubsDataMgmtStatus attribute is PROCESSING_QUERY (1) or PROCESSING_PURGE (2).

Attributes
integerKeyString
key
mandatory
noNotification
restricted
mtasSubsDataMgmt
This attribute defines the primary key of MtasSubsDataMgmt and this section describes the MtasSubsDataMgmt attributes.
MtasString0to255DT[0..1]
nonPersistent
readOnly
mtasSubsDataMgmtFile
This attribute defines a read only attribute which advises the operator of the output file location and filename on the MTAS from where the operator can retrieve the output file after a query or purge has completed processing. The string is to commence with the root directory of the MTAS file system and consists of a file location/name including "/" characters which delimit
individual directory names and the file name.
MtasString0to255DT[0..1]
mtasSubsDataMgmtPui
This attribute defines the PUI to be used for the Purge or Query action.
This attribute may contain a full PUI (including Sip: or Tel:) or a wild carded string which is to be used to match PUIs stored in the MTAS. The wild card character * may be used to match any number of characters including the sip: or tel: URI prefix. No URI-attributes are considered when matching the input PUI to those held on the MTAS.


Deprecated: 

Dependencies: May only be updated when the previously stored value of mtasSubsDataMgmtStatus had the value of finished.
The mtasSubsDataMgmtStatus attribute may be updated to run query or run purge in the same update as the PUI is entered.
Takes effect: New query or purge
MtasSubsDataMgmtStatusDT
nonPersistent
readOnly
mtasSubsDataMgmtStatus = FINISHED
This attribute provides information about the status of the mtasSubsDataMgmtRunQuery and the mtasSubsDataMgmtRunPurge administrative operations.
- If there is no active query or purge operation, its value is FINISHED (0);
- If the mtasSubsDataMgmtRunQuery is invoked, its value becomes PROCESSING_QUERY (1);
- If the mtasSubsDataMgmtRunPurge is invoked, its value becomes PROCESSING_PURGE (2).

  class MtasSubsDataMgmt