Individual actions are detailed below.
The AssignPolicy operation assigns a named policy to a given object in eDirectory.
The cccFSFactoryActionResult attribute is set to Success if successful or an error message otherwise.
The trustee FDN specified for the cccFSFactoryActionTarget attribute may be entered in either typeful or typeless FDN format such as bob.hq.org or CN=bob.OU=hq.O=org, or in LDAP format such as cn=bob,ou=hq,o=org.
The policy name must match an existing policy in the configured system, however the policy name does not need to be a case exact match.
Policies will only be successfully assigned if the policy type is allowed to be assigned to the specified object type. Allowed assignment types are as follows:
The following LDIF file shows how to assign policy UserPolicy1 to the container hq.org.
#Example LDIF for AssignPolicy Action Object version: 1 dn: cn=assignpolicy,ou=actionObjects,o=org changetype: add objectClass: cccFSFactoryAction cccFSFactoryActionOperation: AssignPolicy cccFSFactoryActionOption: UserPolicy1 cccFSFactoryActionTarget: hq.org cccFSFactoryActionTrigger: Ready
The ClearTrustee operation removes the specified trustee from the designated path.
The cccFSFactoryActionResult attribute is set to Success if it is successful; otherwise, an error message displays.
NOTE:The trustee FDN specified for the cccFSFactoryActionTarget attribute should be entered as a typeless, dotted, fully distinguished name such as bob.hq.org.
The following LDIF file shows how to remove user1.hq.org as a trustee of Server1/Vol1:path1/subpath1.
#Example LDIF for ClearTrustee Action Object version: 1 dn: cn=cleartrusteetest,ou=actionObjects,o=org changetype: add objectClass: cccFSFactoryAction cccFSFactoryActionPath1: cn=SERVER1_VOL1,ou=resources,o=org# 0#/path1/subpath1 cccFSFactoryActionOperation: ClearTrustee cccFSFactoryActionTarget: user1.hq.org cccFSFactoryActionTrigger: Ready
The CopyDir operation recursively copies the contents from Path1 to Path2.
cccFSFactoryActionResult is set to Success if it is successful; otherwise, an error message displays.
This action generates a Generic Copy Data event which is eligible for Agent delegation.
CopyDir only works with contents under a specified directory, and not with single files. Use the CopyFile action to handle an individual file.
The following LDIF shows how to perform a copy of the entire contents of Server1/Vol1:path1/subpath1 to Server2/Data:users/bob.
#Example LDIF for CopyDir Action Object version: 1 dn: cn=copydirtest,ou=actionObjects,o=org changetype: add objectClass: cccFSFactoryAction cccFSFactoryActionPath1: cn=SERVER1_VOL1,ou=resources,o=org# 0#/path1/subpath1 cccFSFactoryActionPath2: cn=SERVER2_DATA,ou=servers,o=org# 0#/users/bob cccFSFactoryActionOption: <Option><ParentPaths>1</Parent Paths></Option> cccFSFactoryActionOperation: CopyDir cccFSFactoryActionTrigger: Ready
The CopyFile operation copies the contents of a single file from Path1 to Path2.
cccFSFactoryActionResult is set to Success if successful or an error message otherwise.
This action generates a Generic Copy Data event which is eligible for Agent delegation.
CopyFile requires that the target path include the target file name, not just the target parent folder.
The following LDIF shows how to perform a copy of the contents of file Server1/Vol1:path1/subpath1/file-a.txt to Server2/Data:users/bob/file-b.txt
#Example LDIF for CopyFile Action Object version: 1 dn: cn=copyfiletest,ou=actionObjects,o=org changetype: add objectClass: cccFSFactoryAction cccFSFactoryActionPath1: cn=SERVER1_VOL1,ou=resources,o=org# 0#/path1/subpath1/file-a.txt cccFSFactoryActionPath2: cn=SERVER2_DATA,ou=servers,o=org# 0#/users/bob/file-b.txt cccFSFactoryActionOption: <Option><ParentPaths>1</Parent Paths><Overwrite>1</Overwrite></Option> cccFSFactoryActionOperation: CopyFile cccFSFactoryActionTrigger: Ready
The CopyTrustee operation copies the rights of a specified trustee for Path1 to a specified trustee for Path2.
The cccFSFactoryActionResult attribute is set to Success if it is successful; otherwise, an error message displays.
NOTE:The FDNs specified for the <SourceObject> and <TargetObject> tags should be entered as a typeless, dotted, fully distinguished name such as bob.hq.org.
The following LDIF shows how to perform a copy the trustee assignment of user1 on Server1/Vol1:path1/subpath1 and assign those same rights to bob on Server2/Data:users/bob.
#Example LDIF for CopyTrustee Action Object version: 1 dn: cn=copytrustee,ou=ActionObjects,o=org changetype: add objectClass: cccFSFactoryAction cccFSFactoryActionPath1: cn=SERVER1_VOL1,ou=resources,o=org# 0#/path1/subpath1 cccFSFactoryActionPath2: cn=SERVER2_DATA,ou=servers,o=org# 0#/users/bob cccFSFactoryActionOption: <Option><SourceObject>user1.user s.org</SourceObject><TargetObject>bob.hq.org</TargetObject ></Option> cccFSFactoryActionTrigger: Ready
The CreateDir operation creates a directory at the specified path.
cccFSFactoryActionResult is set to Success if it is successful; otherwise, an error message displays.
NOTE:Even though the complete path is specified in cccFSFactoryActionPath1, all parent paths of the newly specified directory must exist, or the function fails.
The following LDIF example shows how to create subpath1 underneath Server1/Vol1:path1.
#Example LDIF for CreateDir Action Object version: 1 dn: cn=createdirtest,ou=actionObjects,o=org changetype: add objectClass: cccFSFactoryAction cccFSFactoryActionPath1: cn=SERVER1_VOL1,o=org#0#/path1/ subpath1 cccFSFactoryActionOption: <Option><ParentPaths>1</Parent Paths></Option> cccFSFactoryActionOperation: CreateDir cccFSFactoryActionTrigger: Ready
The DeleteDir operation deletes a directory at the specified path.
cccFSFactoryActionResult is set to Success if it is successful; otherwise, an error message displays.
The specified path must point to a directory, not a file.
Lack of an Option tag defaults to recursive mode with intermediate level of aggression for delete.
The following LDIF example shows how to delete the directory Server1/Vol1:path1/subpath1.
#Example LDIF for DeleteDir Action Object version: 1 dn: cn=deletetest,ou=actionObjects,o=org changetype: add objectClass: cccFSFactoryAction cccFSFactoryActionPath1: cn=SERVER1_VOL1,o=org#0#/path1/subpath cccFSFactoryActionOperation: DeleteDir cccFSFactoryActionOption: <Option><Level>3</Level><Recursive> 0</Recursive></Option> cccFSFactoryActionTrigger: Ready
The DeleteFile operation deletes a directory at the specified path.
cccFSFactoryActionResult is set to Success if successful or an error message otherwise.
NOTE:The specified path must point to a single file. File globbing or wildcards are not currently supported at this time.
The following LDIF example shows how to delete the file Server1/Vol1:path1/subpath1/file-a.txt
#Example LDIF for DeleteFile Action Object version: 1 dn: cn=deletefiletest,ou=actionObjects,o=org changetype: add objectClass: cccFSFactoryAction cccFSFactoryActionPath1: cn=SERVER1_VOL1,o=org#0#/path1/ subpath1/file-a.txt cccFSFactoryActionOperation: DeleteFile cccFSFactoryActionOption: <Option><Level>3</Level></Option> cccFSFactoryActionTrigger: Ready
The Rename operation renames an existing directory entry (file or folder).
cccFSFactoryActionResult is set to Success if it is successful; otherwise, an error message displays.
WARNING:Currently all Rename actions override (ignore) any Rename Inhibit / Delete Inhibit flags that would normally prevent renaming a file or directory.
The following LDIF file shows how to rename the file at Server1/Vol1:path1/file1 to file2.
#Example LDIF for Rename Action Object version: 1 dn: cn=renametest,ou=ActionObjects,o=org changetype: add objectClass: cccFSFactoryAction cccFSFactoryActionPath1: cn=SERVER1_VOL1,ou=resources,o=org #0#path1/file1 cccFSFactoryActionTarget: file2 cccFSFactoryActionOperation: Rename cccFSFactoryActionTrigger: Ready
The SetFlags operation sets the file system flags for Path1 to the specified values.
The cccFSFactoryActionResult attribute is set to Success if it is successful: otherwise, an error displays.
Currently, this action only overwrites the current flags. It does not add to existing flags that might already be set, but instead sets the flags to what has been explicitly listed in the cccFSFactoryActionOption attribute. Any flags not specified are cleared.
The following flags can be set:
Di – delete inhibit
Ri – rename inhibit
Hi – hidden
Ar – archive
Pi – purge immediate
Ic – compress immediate
Dc – do not compress
Ro – read only
Flag options are case sensitive
The following LDIF file shows how to set the rename inhibit and delete inhibit flags for the path Server1/Vol1:path1.
#Example LDIF for SetFlags Action Object version: 1 dn: cn=setflagstest,ou=ActionObjects,o=org changetype: add objectClass: cccFSFactoryAction cccFSFactoryActionPath1: cn=SERVER1_VOL1,ou=resources,o=org #0#path1 cccFSFactoryActionOption: RiDi cccFSFactoryActionOperation: SetFlags cccFSFactoryActionTrigger: Ready
The SetOwner operation sets the specified eDirectory object as the owner of Path1.
The cccFSFactoryActionResult attribute is set to Success if it is successful; otherwise, an error message displays.
NOTE:The owner FDN specified for the cccFSFactoryActionTarget attribute should be entered as a typeless, dotted, fully distinguished name such as bob.hq.org.
The following LDIF file shows how to set bob.hq.org as the owner for the path Server1/Vol1:path1.
#Example LDIF for SetFlags Action Object version: 1 dn: cn=setownertest,ou=ActionObjects,o=org changetype: add objectClass: cccFSFactoryAction cccFSFactoryActionPath1: cn=SERVER1_VOL1,ou=resources,o=org #0#path1 cccFSFactoryActionTarget: bob.hq.org cccFSFactoryActionOperation: SetOwner cccFSFactoryActionTrigger: Ready
The SetQuota operation is used to set, add, subtract, or clear a directory quota for a given target path.
The cccFSFactoryActionResult attribute is set to Success if it is successful; otherwise, an error message displays.
NOTE:Depending on the initial quota setting of the target path, the value of <SubCmd> produces the results in the table below.
If <SubCmd> is set to any value other than 0, 1, 2, or 3, the operation fails and cccFSFactoryActionResult is set to the error message.
The following LDIF file shows how to set a directory quota of 500 MB on the path Server1/Vol1:path1/subpath1.
#Example LDIF for SetQuota Action Object version: 1 dn: cn=setquotatest,ou=actionObjects,o=org changetype: add objectClass: cccFSFactoryAction cccFSFactoryActionPath1: cn=SERVER1_VOL1,ou=resources,o=org# 0#/path1/subpath1 cccFSFactoryActionOperation: SetQuota cccFSFactoryActionOption: <Option><SubCmd>1</SubCmd><Quanti ty>500</Quantity></Option> cccFSFactoryActionTrigger: Ready
The SetTrustee operation sets the specified rights for the trustee to the designated path.
The cccFSFactoryActionResult attribute is set to Success if it is successful; otherwise, or an error message displays.
The trustee FDN specified for the cccFSFactoryActionTarget attribute should be entered as a typeless, dotted, fully distinguished name such as bob.hq.org.
The rights are a simple text field with each letter representing a specified access control:
R – Read
W – Write
C – Create
E – Crase
M – Modify
F – File scan
A – Access control
SetTrustee overwrites any previous rights a trustee might have had to the specified path.
The following LDIF file shows how to set user1.hq.org as a trustee of Server1/Vol1:path1/subpath1 with read and file scan rights.
#Example LDIF for SetTrustee Action Object version: 1 dn: cn=settrusteetest,ou=actionObjects,o=org changetype: add objectClass: cccFSFactoryAction cccFSFactoryActionPath1: cn=SERVER1_VOL1,ou=resources,o=org# 0#/path1/subpath1 cccFSFactoryActionOperation: SetTrustee cccFSFactoryActionOption: RF cccFSFactoryActionTarget: user1.hq.org cccFSFactoryActionTrigger: Ready