Configuration and Compliance Functions

This section covers all Configuration and Compliance Management functions, their Names, their input and output parameters.

FTP Download

Downloads a file from a remote FTP server.

Function Name:

ftpDownload

Input Records:

1

Input Format:

Name

Type

Description

serverAddress

String

FTP server address

port

Integer

FTP server port

directory

String

Download directory

filename

String

Name of your file

username

String

User account name to log in

password

String

User account password

Output Records:

1

Output Format:

Name

Type

Description

configuration

String

Configuration file’s content

FTP Upload

Uploads a file to a remote FTP server.

Function Name:

ftpUpload

Input Records:

1

Input Format:

Name

Type

Description

serverAddress

String

FTP server address

port

Integer

FTP server port

directory

String

Download directory

filename

String

Name of your file

data

String

Uploaded data

username

String

User account name to log in

password

String

User account password

Output Records:

1

Output Format:

Name

Type

Description

configuration

String

Configuration file’s content

SCP Download

Downloads a file from a remote SCP server.

Function Name:

scpDownload

Input Records:

1

Input Format:

Name

Type

Description

serverAddress

String

FTP server address

port

Integer

FTP server port

directory

String

Download directory

filename

String

Name of your file

username

String

User account name to log in

password

String

User account password

Output Records:

1

Output Format:

Name

Type

Description

configuration

String

Configuration file’s content

SCP Upload

Uploads a file to a remote SCP server.

Function Name:

scpUpload

Input Records:

1

Input Format:

Name

Type

Description

serverAddress

String

FTP server address

port

String

FTP server port

directory

String

Download directory

filename

String

Name of your file

data

String

Uploaded data

username

String

User account name to log in

password

String

User account password

Output Records:

1

Output Format:

Name

Type

Description

configuration

String

Configuration file’s content

Read Configuration

Reads device configuration.

Function Name:

readConfiguration

Input Records:

1

Input Format:

Name

Type

Description

configurationType

String

Configuration type

Output Records:

1

Output Format:

Name

Type

Description

successful

Boolean

Indicates successful operations

resultError

String

Indicates errors

configuration

String

Configuration file’s content

configurationType

String

Type of changed configuration.

configurationTimestamp

Date

Configuration's creation date

backupConfigurationWasChanged

String

Identifies changes in backup configuration

policiesViolations

String

Policy violations list. See Policy Violation Reporting for details.

Restore Configuration

Restores device configuration.

Function Name:

writeConfiguration

Input Records:

1

Input Format:

Name

Type

Description

sequenceType

String

Restore sequence type. See Backup and Restore Sequences for details.

configuration

String

Configuration content

configurationType

String

Configuration type

reastoreParameters

String

Restore sequence parameters

Output Records:

1

Output Format:

Name

Type

Description

successful

Boolean

Indicates successful operations

resultError

String

Indicates errors

Was this page helpful?