health monitor method ftp¶

FTP type

ftp Specification¶

Parameter Value

Type Configuration Resource

Element Name ftp

Element URI /axapi/v3/health/monitor/{name}/method/ftp

Element Attributes ftp_attributes

Partition Visibility shared

Schema ftp schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/health/monitor/{name}/method/ftp	ftp attributes
POST /axapi/v3/health/monitor/a/method/ftp Payload: { "ftp": { "ftp": 1, "ftp-port": 1 } }
Get Object	GET	/axapi/v3/health/monitor/{name}/method/ftp	ftp attributes
GET /axapi/v3/health/monitor/a/method/ftp Reponse: { "ftp": { "ftp": 1, "ftp-port": 1, "uuid": "0f81dcd4-4fc9-11ee-8c93-17f0fbeb6d81", "a10-url": "/axapi/v3/health/monitor/a/method/ftp" } }
Modify Object	POST	/axapi/v3/health/monitor/{name}/method/ftp	ftp attributes
Replace Object	PUT	/axapi/v3/health/monitor/{name}/method/ftp	ftp attributes
PUT /axapi/v3/health/monitor/a/method/ftp Payload: { "ftp": { "ftp": 1, "ftp-port": 2 } }
Delete Object	DELETE	/axapi/v3/health/monitor/{name}/method/ftp	ftp attributes
DELETE /axapi/v3/health/monitor/a/method/ftp Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

ftp attributes¶

ftp

Description FTP type

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ftp-encrypted

Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

ftp-password

Description Specify the user password

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ftp-password-string

Description Specify the user password, ‘’ means empty password

Type: string

Format: password

Maximum Length: 31 characters

Maximum Length: 1 characters

ftp-port

Description Specify FTP port (Specify port number, default is 21)

Type: number

Range: 1-65534

Default: 21

ftp-username

Description Specify the username

Type: string

Format: string-rlx

Maximum Length: 31 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters