Command line interface

usage: python -m egnyte [-h] [-c CONFIG_PATH] [-v] [--impersonate USERNAME] {config,token,test,audit,upload,download,settings} ...

Options:

-c, --config-path
	Path to config file
-v, --verbose	Be more verbose. Can be repeated for debugging
--impersonate	Impersonate another user (username or email)

Sub-commands:

config

commands related to configuration

usage: python -m egnyte config [-h] {show,create,update,token} ...

token

generate a new access token and print it

usage: python -m egnyte token [-h] [-d DOMAIN] [-l LOGIN] [-p PASSWORD] [-k API_KEY]

Options:

-d, --domain	domain name
-l, --login	login
-p, --password	password
-k, --key	API key

test

test if config is correct (connects to service)

usage: python -m egnyte test [-h]

audit

generate audit reports

usage: python -m egnyte audit [-h] {files,logins,permissions,get} ...

upload

send files to Egnyte

usage: python -m egnyte upload [-h] [-x EXCLUDE] paths [paths ...] target

Positional arguments:

paths	Paths (files to directories) to upload
target	Path in Cloud File System to upload to

Options:

-x, --exclude

Exclude items that match this glob pattern

download

download files from Egnyte

usage: python -m egnyte download [-h] [--target TARGET] [--overwrite] paths [paths ...]

Positional arguments:

paths

Paths (files to directories) to download

Options:

--target	Local directory to put downloaded files and directories in
--overwrite	Delete local files and directories that conflict with cloud content

settings

show domain settings

usage: python -m egnyte settings [-h]

config subcommand

usage: python -m egnyte config [-h] {show,create,update,token} ...

Sub-commands:

show

show configuration

usage: python -m egnyte config show [-h]

create

create a new configuration file

usage: python -m egnyte config create [-h] -d DOMAIN [-l LOGIN] [-p PASSWORD] -k API_KEY [-t ACCESS_TOKEN]

Options:

-d, --domain	domain name
-l, --login	login
-p, --password	password
-k, --key	API key
-t, --token	API access token

update

update a configuration file

usage: python -m egnyte config update [-h] [-d DOMAIN] [-l LOGIN] [-p PASSWORD] [-k API_KEY] [-t ACCESS_TOKEN]

Options:

-d, --domain	domain name
-l, --login	login
-p, --password	password
-k, --key	API key
-t, --token	API access token

token

generate a new access token and store it in config file

usage: python -m egnyte config token [-h]

audit subcommand

usage: python -m egnyte audit [-h] {files,logins,permissions,get} ...

Sub-commands:

files

create Files report

usage: python -m egnyte audit files [-h] [--save SAVE] [--format FORMAT] [--start START] [--end END] [--folder FOLDER] [--file FILE] [--users USERS] [--transaction_type TRANSACTION_TYPE]

Options:

--save	File to save to the report to (default is standard output)
--format	Report type (json or csv. Default is csv)
--start	Start date (YYYY-MM-DD)
--end	End date (YYYY-MM-DD)
--folder	Absolute folder path for the destination folder. ‘folder’ or ‘file’ is required. Can be used multiple times
--file	Absolute folder path for the destination file, wildcards allowed. ‘folder’ or ‘file’ is required
--users	Users to report on (comma separated list, default is all)
--transaction_type
	Transaction type: upload, download, preview, delete, copy, move, restore_trash, delete_trash, create_link, delete_link, download_link (comma separated list, default is all

logins

create Logins report

usage: python -m egnyte audit logins [-h] [--save SAVE] [--format FORMAT] [--start START] [--end END] --events EVENTS [--access-points ACCESS_POINTS] [--users USERS]

Options:

--save	File to save to the report to (default is standard output)
--format	Report type (json or csv. Default is csv)
--start	Start date (YYYY-MM-DD)
--end	End date (YYYY-MM-DD)
--events	Event types: logins, logouts, account_lockouts, password_resets, failed_attempts (comma separated list)
--access-points
	Access points to cover: Web, FTP, Mobile (comma separated list, default is all)
--users	Users to report on (comma separated list, default is all)

permissions

create Permissions report

usage: python -m egnyte audit permissions [-h] [--save SAVE] [--format FORMAT] [--start START] [--end END] --assigners ASSIGNERS --folder FOLDER [--users USERS] [--groups GROUPS]

Options:

--save	File to save to the report to (default is standard output)
--format	Report type (json or csv. Default is csv)
--start	Start date (YYYY-MM-DD)
--end	End date (YYYY-MM-DD)
--assigners	Permission assigners (comma separated list)
--folder	Absolute folder path for the destination folder. Can be used multiple times
--users	Users to report on (comma separated list)
--groups	Groups to report on (comma separated list)

get

get a previously generated report

usage: python -m egnyte audit get [-h] [--save SAVE] --id ID

Options:

--save	File to save to the report to (default is standard output)
--id	Id of the report