FTPFetcherPlugin¶

FTPFetcherPlugin - Create¶

Create ftp fetcher

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/FTPFetcherPlugin

Parameter

Field	Label in UI	Type	Description
charset	Charset	String	Existing LogPoint charset . Obtain the value of the required charset from Charsets - List API . Mandatory Field
device_id	-	String	Existing Device id . Obtain the value of the required device_id using Devices - List API. Optional Field
interval	Fetch Interval (minutes)	int	Fetch interval in minutes. Mandatory Field
namepattern	Filename Pattern	String	Regex pattern for filename match or empty for all. Optional Field
oldlogs	Forward Old Logs	String	Check point to extract old logs or not - If check should be “on” (exact) any other value is considered as “off”. Optional Field
parser	Parser	String	Pick one from the available parsers. Mandatory Field
password	Password	String	Password of the FTP fetcher. Mandatory Field
policy_id	-	String	Respective LCP policy ID. Obtain the value of the required policy_id using LogCollectionPolicies - List API. Optional Field
port	Port	int	Access port number. Mandatory Field
processpolicy	Processing Policy	String	Existing Processing Policy id . Obtain the value of the required Processing Policy using ProcessingPolicy - List API . Mandatory Field
remotepath	Relative FilePath	String	Remotepath to the file directory. Optional Field
username	Username	String	Username of the FTP fetcher. Mandatory Field

Request Example

{
    "data": {
        "charset": "utf_8",
        "device_id": "57724aacd8aaa40b569bcb1f",
        "interval": 5,
        "namepattern": "*.pyc",
        "oldlogs": "on",
        "parser": "LineParser",
        "password": "password",
        "port": 5800,
        "processpolicy": "57724aacd8aaa40b569bcb1fasd",
        "remotepath": "/base/collection/",
        "username": "TestCollector"
    }
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

FTPFetcherPlugin - Edit¶

Edit ftp fetcher with given ID

PUT

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/FTPFetcherPlugin/{id}

Parameter

Field	Label in UI	Type	Description
charset	Charset	String	Existing LogPoint charset . Obtain the value of the required charset from Charsets - List API . Mandatory Field
id	-	String	UUID of the respective FTPFetcherPlugin. To obtain the FTP fetcher uuid , execute Devices - List API if the collector was configured using device id or execute LogCollectionPolicies - List API if the collector was configured using log collection policy id . Mandatory Field
interval	Fetch Interval (minutes)	int	Fetch interval in minutes. Mandatory Field
namepattern	Filename Pattern	String	Regex pattern for filename match or empty for all. Optional Field
oldlogs	Forward Old Logs	String	Check point to extract old logs or not - If check should be “on” (exact) any other value is considered as “off”. Optional Field
parser	Parser	String	Pick one from the available parsers. Mandatory Field
password	Password	String	Password of the FTP fetcher. Mandatory Field
port	Port	int	Access port number. Mandatory Field
processpolicy	Processing Policy	String	Existing Processing Policy id . Obtain the value of the required Processing Policy using ProcessingPolicy - List API . Mandatory Field
remotepath	Relative FilePath	String	Remotepath to the file directory. Optional Field
username	Username	String	Username of the FTP fetcher. Mandatory Field

Request Example

{
    "data": {
        "charset": "utf_8",
        "interval": 5,
        "namepattern": "*.pyc",
        "oldlogs": "on",
        "parser": "LineParser",
        "password": "password",
        "port": 5800,
        "processpolicy": "57724aacd8aaa40b569bcb1fasd",
        "remotepath": "/base/collection/",
        "username": "TestCollector"
    }
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

FTPFetcherPlugin - TestExisting¶

Test ftp fetcher with given ID

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/FTPFetcherPlugin/{id}/testexistingftp

Parameter

Field	Label in UI	Type	Description
id	-	String	UUID of the respective FTPFetcherPlugin. Obtain the value of the required FTPFetcherPlugin uuid using Devices - List API. . Mandatory Field

Request Example

{
    "data": {}
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

FTPFetcherPlugin - TestNew¶

Test newly created ftp fetcher

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/FTPFetcherPlugin/testnewftp

Parameter

Field	Label in UI	Type	Description
device_id	-	String	Existing Device id . Obtain the value of the required device_id using DeviceGroups - List API. Mandatory Field
interval	Fetch Interval (minutes)	int	Fetch interval in minutes. Mandatory Field
namepattern	Filename Pattern	String	Regex pattern for filename match or empty for all. Optional Field
oldlogs	Forward Old Logs	String	Check point to extract old logs or not - If check should be “on” (exact) any other value is considered as “off”. Optional Field
password	Password	String	Password of the FTP fetcher. Mandatory Field
port	Port	int	Access port number. Mandatory Field
remotepath	Relative FilePath	String	Remotepath to the file directory. Optional Field
username	Username	String	Username of the FTP fetcher. Mandatory Field

Request Example

{
    "data": {
        "device_id": "57724aacd8aaa40b569bcb1f",
        "interval": 5,
        "namepattern": "*.pyc",
        "oldlogs": "on",
        "password": "password",
        "port": 5800,
        "remotepath": "/base/collection/",
        "username": "TestCollector"
    }
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

FTPFetcherPlugin - Trash¶

Delete ftp fetcher with given ID

DELETE

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/FTPFetcherPlugin/{id}

Parameter

Field	Label in UI	Type	Description
id	-	String	UUID of the respective FTPFetcherPlugin. To obtain the FTP fetcher uuid , execute Devices - List API if the collector was configured using device id or execute LogCollectionPolicies - List API if the collector was configured using log collection policy id . Mandatory Field

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

Helpful?