CLI: Audit Categories



On This Page


The CLI references “skysync.” This is expected.

Audit Categories

In the following examples, the authentication parameters are provided within the configuration file.  See the authentication section for more information.

List Audit Categories

parameter

description

required

default

parameter

description

required

default

search, q

Search text

optional

 

offset

Search offset

optional

0

limit

Search page size

optional

20

Example

Command

1 skysync-cli transfer-audit-categories list

Example results

1 2 3 4 5 6 7 8 9 10 11 12 13 ID Name Action Level Priority 414625577a8643fbb3498ba552b0220c ParamTest retry warn 9999 17cd1af5358f4a5cb718c7083dbed7ca License Failures retry error 5000 3024e963e1bf45578f6ef7c5722fea53 Conflict Failures retry error 5000 65c5e85659284d279f6dea0c71707fc0 Io Failures retry error 5000 480f984a7dd94343b107553dd017ca83 Invalid Item Failures retry error 5000 e92c5ec1a0f4415ba3efe79a8c78627b Duplicate Item Failures retry error 5000 009fa2b7578d488695a3f0db0dc53553 Item Not Found Failures retry error 5000 9ab945f3d3524f4a9b128eb717cf20fd Policy Failures retry error 5000 a4bdd7af71f6490c817155b4d1dabe51 Permission Failures retry error 5000 ae073f4b34a846ca9a71eabca31f475f Access Failures retry error 5000 9b3b464d77ab4fa5a03d097f6da9f745 Connectivity Failures retry error 5000 814d1fa15a974c83a8bcac10d266798b Unknown Failures retry error 5000

Example results (JSON)

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 [ { "id": "17cd1af5358f4a5cb718c7083dbed7ca", "name": "License Failures", "action": "retry", "level": "error", "priority": 5000, "description": "Files and folders that have failed due an unlicensed product feature.", "filter": { "rules": [ { "filter": { "name": "audit_type", "select": null, "op": "eq", "value": 5011 }, "type": "filter_context" } ] } }, { "id": "3024e963e1bf45578f6ef7c5722fea53", "name": "Conflict Failures", "action": "retry", "level": "error", "priority": 5000, "description": "Files that have failed due to unresolved conflicts.", "filter": { "rules": [ { "filter": { "name": "audit_type", "select": null, "op": "eq", "value": 5010 }, "type": "filter_context" } ] } } ]

 

Show an Audit Category

parameter

description

requires

parameter

description

requires

id

ID of the audit category to be shown

required

Example

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  

Command with variables

1 skysync-cli transfer-audit-categories show {{id}}

Command with example values

1 skysync-cli transfer-audit-categories show 17cd1af5358f4a5cb718c7083dbed7ca

Example results

1 2 3 4 5 6 ID 17cd1af5358f4a5cb718c7083dbed7ca Name License Failures Action retry Level error Priority 5000 Description Files and folders that have failed due an unlicensed product feature.

Example results (JSON)

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 [ { "id": "17cd1af5358f4a5cb718c7083dbed7ca", "name": "License Failures", "action": "retry", "level": "error", "priority": 5000, "description": "Files and folders that have failed due an unlicensed product feature.", "filter": { "rules": [ { "filter": { "name": "audit_type", "select": null, "op": "eq", "value": 5011 }, "type": "filter_context" } ] } } ]

 

Create an Audit Category

parameter

description

type

option 1

option 2

parameter

description

type

option 1

option 2

name

Audit category name

string

required

 

description

Audit category description

string

required

 

action

Action to take when audit category is triggered

string

required

 

level

Logging Level

string

required

 

priority

Priority in case multiple audit categories match an error

integer

required

 

auditType

Error code to match this audit category against

integer

required

 

options-input

parameter to specify that JSON should be read from pipeline

switch

 

required

Example with parameters

Command with variables

1 skysync-cli transfer-audit-categories add --name={{name}} --description={{description}} --action={{action}} --level={{level}} --priority={{priority}} --auditType={{auditType}}

Command with example values

1 skysync-cli transfer-audit-categories add --name='CreatedWithParameters' --description='Test Audit Category created with CLI parameters' --action 'retry' --level 'warn' --priority 4000 --auditType 5050

Expected result

1 2 3 4 5 6 7 id : 11726921eda448199ffd7710a4f4aa3a name : CreatedWithParameters action : retry level : warn priority : 4000 description : Test Audit Category created with CLI parameters filter : @{rules=System.Object[]}

Expected result (JSON)

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 [ { "id": "b0a0a2ec00ec42d6828e016c3bc335e1", "name": "CreatedWithParameters", "action": "retry", "level": "warn", "priority": 4000, "description": "Test Audit Category created with CLI parameters", "filter": { "rules": [ { "filter": { "name": "audit_type", "select": null, "op": "eq", "value": 5050 }, "type": "filter_context" } ] } } ]

 

Example with JSON

Command with variables

1 {{JSON}} | skysync-cli transfer-audit-categories add --options-input --name={{name}}

Command with example values

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 '{ "description": "Test Audit Category created with JSON block", "filter": { "rules": [ { "filter": { "name": "audit_type", "select": null, "op": "eq", "value": 5050 }, "type": "filter_context" } ] }, "action": "retry", "priority": 4000, "level": "warn" }' | skysync-cli transfer-audit-categories add --options-input --name="created with JSON"

Expected result

1 2 3 4 5 6 7 id : 325fc08fd69a44b88c0b2fb6f921e4ad name : CreatedWithJSON action : retry level : warn priority : 4000 description : Test Audit Category created with JSON block filter : @{rules=System.Object[]}

Expected result (JSON)

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 [ { "id": "f69ee246f7994693ae7f210702e9d88a", "name": "CreatedWithJSON", "action": "retry", "level": "warn", "priority": 4000, "description": "Test Audit Category created with JSON block", "filter": { "rules": [ { "filter": { "name": "audit_type", "select": null, "op": "eq", "value": 5050 }, "type": "filter_context" } ] } } ]

 

Delete an Audit Category

parameter

description

required

parameter

description

required

id

ID of the audit category to be deleted

required

Example

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.

Command with variables

1 skysync-cli transfer-audit-categories delete {{id}}

Command with example values

1 skysync-cli transfer-audit-categories delete 17cd1af5358f4a5cb718c7083dbed7ca

Expected result

1 The audit category was deleted successfully.

Error result

1 The audit category could not be deleted.