ARX::FileChangeNotification::start_notifications

Introduced : ARX V5.02.000 Start processing file and directory changes. If the from_snapshot parameter is non-zero, then the changes that occurred between the creation time of the snapshot specified by from_snapshot and the creation time of the snapshot specified by to_snapshot will be processed. If the from_snapshot parameter is 0, then all files that exist in the snapshot specified by to_snapshot will be processed. This function creates a new file change notification session that the caller uses to get all file changes that occurred between from_snapshot and to_snapshot. The caller passes the returned session id to FileChangeNotification__get_notifications to get file changes and FileChangeNotificationfinish_notifications to complete the session. In case of error, this function generates a SOAP fault.

Prototype

String start_notifications(
    in String namespace,
    in String volume,
    in String rule,
    in long from_snapshot,
    in long to_snapshot,
    in boolean all_files
);

Parameters

Parameter Type Description
namespace String Namespace name.
volume String Volume name.
rule String Notification rule name.
from_snapshot long Timestamp of source snapshot. If 0 is specified, the entire volume is scanned.
to_snapshot long Timestamp of destination snapshot. It must be the creation time of the next consecutive snapshot after from_snapshot.
all_files boolean File changes to be returned, and should be set to true.

Return Type

Type Description
String A unique file change notification session identifier.

Exceptions

Exception Description

See Also

` <https://devcentral.f5.com/wiki/iControl..ashx>`__iControl ` <https://devcentral.f5.com/wiki/iControl..ashx>`__ :: ARX :: ` <https://devcentral.f5.com/wiki/iControl..ashx>`__FileChangeNotification

Warning

The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.

Sample Code

  • ARX File Change - This example shows how to retrieve the set of ARX file changes that occurred in a managed volume between two snapshots.

Copyright © 1996-2012, F5 Networks, Inc. All rights reserved.

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.