WMIFetcherPlugin¶

WMIFetcherPlugin - Create¶

Creates a WMI Fetcher using Device ID or Policy ID.

POST

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

Parameter

Field	Label in UI	Type	Description
charset	Charset	String	Existing LogPoint charset. Obtain the value of the required charset using Charsets - List API. Mandatory Field
device_id	-	String	Device id . Obtain the value of the required Device id using Devices - List API. Optional Field
facility	Facility	String	One of the available facilities. Mandatory Field
interval	Fetch Interval (minutes)	int	Fetch interval in minutes. Mandatory Field
parser	Parser	String	Value must be “WmiParser”(exact). Mandatory Field
password	Password	String	WMI Fetcher password . Mandatory Field
policy_id	-	String	Respective LCP policy ID. Obtain the value of the required policy_id using LogCollectionPolicies - List API. Optional Field
processpolicy	Processing Policy	String	Existing Processing Policy id or “None”. Obtain the value of the required Processing Policy id using ProcessingPolicy - List API. Mandatory Field
severity	Severity	String	One of the available severities. Mandatory Field
username	Username	String	WMI Fetcher username . Mandatory Field

Request Example

{
    "data": {
        "charset": "utf_8",
        "device_id": "57724aacd8aaa40b569bcb1f",
        "facility": "Kernel",
        "interval": 33,
        "parser": "WmiParser",
        "password": "hercules",
        "processpolicy": "57724aacd8aaa40b569bcb1fasd",
        "severity": "Emergency",
        "username": "TestWMIFetcher"
    }
}

Success Response

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

WMIFetcherPlugin - Edit¶

Edits a WMI fetcher with given ID.

PUT

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

Parameter

Field	Label in UI	Type	Description
charset	Charset	String	Existing LogPoint charset. Obtain the value of the required charset using Charsets - List API. Mandatory Field
facility	Facility	String	One facility from the available facilities. Mandatory Field
id	-	String	WMI Fetcher Plugin uuid . To obtain the WMI 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
parser	Parser	String	Value must be “WmiParser”. Mandatory Field
password	Password	String	WMI Fetcher password . Mandatory Field
processpolicy	Processing Policy	String	Existing Processing Policy id or “None”. Obtain the value of the required Processing Policy id using ProcessingPolicy - List API. . Mandatory Field
severity	Severity	String	One severity from the available severities. Mandatory Field
username	Username	String	WMI Fetcher username . Mandatory Field

Request Example

{
    "data": {
        "charset": "utf_8",
        "facility": "Kernel",
        "interval": 33,
        "parser": "WmiParser",
        "password": "hercules",
        "processpolicy": "57724aacd8aaa40b569bcb1fasd",
        "severity": "Emergency",
        "username": "TestWMIFetcher"
    }
}

Success Response

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

WMIFetcherPlugin - TestExisting¶

Tests the existing WMI Fetcher connection.

POST

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

Parameter

Field	Label in UI	Type	Description
id	-	String	WMI Fetcher Plugin uuid . Execute the Devices - List API to obtain the uuid of the required WMI Fetcher Plugin. Mandatory Field

Request Example

{
    "data": {}
}

Success Response

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

WMIFetcherPlugin - TestNew¶

Tests newly created WMI fetcher connection.

POST

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

Parameter

Field	Label in UI	Type	Description
charset	Charset	String	Existing LogPoint charset. Obtain the value of the required charset using Charsets - List API. Mandatory Field
device_id	-	String	Device id . Obtain the value of the required Device id using Devices - List API. Mandatory Field
facility	Facility	String	One facility from the available facilities. Mandatory Field
interval	Fetch Interval (minutes)	int	Fetch interval in minutes. Mandatory Field
parser	Parser	String	Accepts only WmiParser (exact). Mandatory Field
password	Password	String	WMI Fetcher password . Mandatory Field
processpolicy	Processing Policy	String	Existing Processing Policy id . Obtain the value of the required Processing Policy id using ProcessingPolicy - List API. Mandatory Field
severity	Severity	String	One severity from the available severities. Mandatory Field
username	Username	String	WMI Fetcher username . Mandatory Field

Request Example

{
    "data": {
        "charset": "utf_8",
        "device_id": "57724aacd8aaa40b569bcb1f",
        "facility": "Kernel",
        "interval": 33,
        "parser": "WmiParser",
        "password": "hercules",
        "processpolicy": "57724aacd8aaa40b569bcb1fasd",
        "severity": "Emergency",
        "username": "TestWMIFetcher"
    }
}

Success Response

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

WMIFetcherPlugin - Trash¶

Deletes the WMI fetcher with given ID.

DELETE

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

Parameter

Field	Label in UI	Type	Description
id	-	String	WMI Fetcher Plugin uuid . To obtain the WMI 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?