PowerScale OneFS API Reference

PDF

File matching patterns

You can apply the following file matching pattern to filter specific objects in SyncIQ.

<file_matching_pattern> := { 
    "or_criteria" : [
        {
            "and_criteria": [
                <file_criterion>,
                <file_criterion>,
                ...
            ]
        },
        {
            "and_criteria": [
                <file_criterion>,
                <file_criterion>,
                ...
            ]
        },
        ...
    ]
}

<file_criterion> = {
 "type": <string>,
 "operator": <string>,
 "value": {<string> | <integer>}
}

The following table defines available operators.


operator	Description
==	Equal
!=	Does not equal
>	Greater than
>=	Greater than or equal
<	Less than
<=	Less than or equal
!	Not

The following table defines available file criteria types.


Type	Conditions
name	Paired with operators "==" or "!=".
path	Paired with operators "==" or "!=".
posix_regex_name	Paired with operators "==" or "!=".
accessed_time	No operator is required; every operation is set to "==". The value must be in the following form: {<mm>/<dd>/<yyyy> [<HH>:<mm>] \| <integer> {days \| weeks \| months \| years} ago}
accessed_before	No operator is required; every operation is set to "==". The value must be in the following form: {<mm>/<dd>/<yyyy> [<HH>:<mm>] \| <integer> {days \| weeks \| months \| years} ago}
accessed_after	No operator is required; every operation is set to "==". The value must be in the following form: {<mm>/<dd>/<yyyy> [<HH>:<mm>] \| <integer> {days \| weeks \| months \| years} ago}
birth_time	No operator is required; every operation is set to "==". The value must be in the following form: {<mm>/<dd>/<yyyy> [<HH>:<mm>] \| <integer> {days \| weeks \| months \| years} ago}
birth_before	No operator is required; every operation is set to "==". The value must be in the following form: {<mm>/<dd>/<yyyy> [<HH>:<mm>] \| <integer> {days \| weeks \| months \| years} ago}
birth_after	No operator is required; every operation is set to "==". The value must be in the following form: {<mm>/<dd>/<yyyy> [<HH>:<mm>] \| <integer> {days \| weeks \| months \| years} ago}
changed_time	No operator is required; every operation is set to "==". The value must be in the following form: {<mm>/<dd>/<yyyy> [<HH>:<mm>] \| <integer> {days \| weeks \| months \| years} ago}
changed_before	No operator is required; every operation is set to "==". The value must be in the following form: {<mm>/<dd>/<yyyy> [<HH>:<mm>] \| <integer> {days \| weeks \| months \| years} ago}
changed_after	No operator is required; every operation is set to "==". The value must be in the following form: {<mm>/<dd>/<yyyy> [<HH>:<mm>] \| <integer> {days \| weeks \| months \| years} ago}
size	Paired with all operators except for "!". The value must be in the following form: An integer, followed by B, KB, MB, GB, or TB (such as 100B or 12TB).
file_type	Paired with operators "==" or "!=". The value must be in the following form: 'file', 'directory', or 'symlink'.
user_name	Paired with operators "==" or "!=".
user_id	Paired with operators "==" or "!=".
group_name	Paired with operators "==" or "!=".
group_id	Paired with operators "==" or "!=".
no_user	Paired with operators "!".
no_group	Paired with operators "!". Does not require a value.

The following example shows a sync policy filter.

"file_matching_filter": { 
    "or_criteria" : [
        {
            "and_criteria": [
                {
                    "type": "size",
                    "operator": ">=",
                    "value": "500000KB"
                },
                {
                    "type": "file_type",
                    "operator": "==",
                    "value": "file"
                }
            ]
        },
        {
            "and_criteria": [
                {
                    "type": "posix_regex_name",
                    "operator": "==",
                    "value": "some_special_prefix_*"
                }
            ]
        },
        {
            "and_criteria": [
                {
                    "type": "file_type",
                    "operator": "==",
                    "value": "symlink"
                }
            ]
        }
    ]
}