Overview Package Class Deprecated Help

mediation
FileRetrievalPolicy

This class defines the criteria, used by the NFM-P server, to determine when and how to perform node FileRetrieval and restore related operations.

public class FileRetrievalPolicy

Properties
compressionMode Specifies the compression format to be used for the FileRetrieval files. Possible values - GZIP, ZIP, no compression.

type=mediation.BackupCompressionMode
default=none
displayedName Specifies the name assigned to this FileRetrieval policy.

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=Name
ftpServerIPAddrType

type=rtr.InetAddressType
default=ipv4
isDefaultPolicy

type=boolean
access=read-only
default=false
Displayed(tab/group)=Is Default Policy
policyId Specifies the ID assigned to this FileRetrieval policy.

type=int
access=read-create
default=1
minimum=1
maximum=65535
Displayed(tab/group)=Policy ID
policyType

type=mediation.FileRetrievalPolicyTypes
access=read-create
default=logRetrieval
Displayed(tab/group)=Policy Type
sftpPassword

type=string
minimum=0
maximum=255
Displayed(tab/group)=SFTP Password (/SFTP Settings)
sftpRootDir

type=string
default=/
minimum=0
maximum=255
Displayed(tab/group)=Root Directory (/SFTP Settings)
sftpServerIP

type=InetAddress
default=127.0.0.1
Displayed(tab/group)=SFTP Server IP (/SFTP Settings)
sftpServerPort

type=int
default=22
Displayed(tab/group)=SFTP Server Port (/SFTP Settings)
sftpUser

type=string
minimum=0
maximum=255
Displayed(tab/group)=SFTP User ID (/SFTP Settings)
sshHostKeyFingerPrint SFTP server's SSH Host Key Finger Print for ECDSA hostkey algorithm (Applicable for MSS-8/4).

type=string
maximum=32
Displayed(tab/group)=Host Key Fingerprint (/SFTP Settings)
testConnectionResult Status of test connection action.

type=mediation.TestConnectionStatus
access=read-only
default=connectionNotAttempted
Displayed(tab/group)=Connection Status (/SFTP Settings)
useActiveServer

type=boolean
default=true
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

configure

Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName : string - the full name of the object.
configInfo : config(mediation.FileRetrievalPolicy) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
mediation.FileRetrievalPolicy.configureException

testConnection

This operation will verify the sftp credentials for future file retrieval.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName : string - the full name of the object.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
mediation.FileRetrievalPolicy.testConnectionException
Supported Network Elements
Wavence SM