FtpClientProtocolConfig Object


Description:

Creates an FTP protocol client.

Parents: EmulatedDevice

Result children (automatically created): FtpClientResults

Relations:

Side name
(Type)
Relative Description
ClientLoadProfile
(AffiliatedClientLoadProfile)

ClientLoadProfile

Client load profile used by a client.

ClientProfile
(AffiliatedClientProfile)

ClientProfile

Client profile used by a client.

L4L7ProtocolConfigServerBase
(ConnectionDestination)

CifsServerProtocolConfig, DpgServerProtocolConfig, FtpServerProtocolConfig, HttpServerProtocolConfig, IperfServerProtocolConfig, RawTcpServerProtocolConfig, VideoServerProtocolConfig

Client-server association.

ViewControlPlaneMplsBindingResult
(ControlPlaneBindingResult)

ViewControlPlaneMplsBindingResult

ConvergenceConfig
(PrimaryPathProtocolConfig)

ConvergenceConfig, ConvergenceConfig

ResultChild
(ResultChild)

FtpClientResults

Use this to connect a results object to an object.

TimeComparisonPair
(TimeComparisonPairSrcProtocol)

TsnProtocolsTimeComparisonPair, TsnProtocolsTimeComparisonPair

UsesIf
(UsesIf)

Aal5If, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv6If, Ipv6SrhIf, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacsecIf, MplsIf, PppIf, PppoeIf, TrillIf, VbrasIf, VlanIf, VxlanGpeIf, VxlanIf

Specifies the interfaces used by the configuration object (configuration object examples: BgpRouterConfig, LdpRouterConfig, and so on).

FtpClientProtocolConfig Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
ClientName

User-defined name for the client. The name is relevant only to the user.

Type: string

Default: "" (empty string)

DoGetOp

Whether the client does a GET or a PUT.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Client does a GET.

FALSE

Client does a PUT.

DynamicLoad

Load value in units of the load profile, only used when Use Dynamic Load is true.

Type: s32

Default: 30

Range: 1 - 1000000

EnablePassiveDataXfer

Enable or disable passive mode data transfer.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable

FALSE

Disable

EndpointConnectionPattern

Pattern for connection of client endpoints to server/peer endpoints.

Type: enum

Default: PAIR

Possible Values:

Value Description
PAIR

Pair connections.

BACKBONE_SRC_FIRST

Backbone connections, varying the source address first.

BACKBONE_DST_FIRST

Backbone connections, varying the destination address first.

BACKBONE_INTERLEAVED

Backbone connections, interleaving source and destination addresses.

MaxTransactionsPerServer

Maximum number of transactions between a single client and server.

Type: u32

Default: 10

Range: 1 - 4294967295

UsePartialBlockState

Unused.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Unused.

FALSE

Unused.

FtpClientProtocolConfig Read-Only Attributes

Read-Only Attribute Description
LoadProfileRunState

Whether the client protocol configuration is running.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Is running.

FALSE

Is not running.