Description

The addSyslogServer operation handles configuration related to SyslogServer model. 
This API call is not allowed on the standby unit in an HA pair.

HTTP request

POST /api/fdm/v6/object/syslogalerts

Data Parameters

Parameter Required Type Description
name False string A string that represents the name of the object
deviceInterface False object The interface by which the remote syslog server is reached.
Allowed types are: [BridgeGroupInterface, EtherChannelInterface, PhysicalInterface, SubInterface, VirtualTunnelInterface, VlanInterface]
useManagementInterface False boolean Use management interface to reach syslog server
host True string The IP address of the remote syslog server.
Field level constraints: cannot be null, must be a valid IP address. (Note: Additional constraints might exist)
port False string The port(TCP/UDP) of the remote syslog server.
Field level constraints: must be a valid port from 1 to 65535 or a valid port range. (Note: Additional constraints might exist)
protocol True string Protocol type (UDP/TCP)
Field level constraints: cannot be null. (Note: Additional constraints might exist)
type True string A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Example

curl -X POST \
    --header "Accept: application/json" \
    --header "Authorization: Bearer ${ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    -d '{
        "deviceInterface": {
            "id": "string",
            "name": "string",
            "type": "string",
            "version": "string"
        },
        "host": "string",
        "id": "string",
        "name": "string",
        "port": "string",
        "protocol": "TCP",
        "type": "syslogserver",
        "useManagementInterface": true,
        "version": "string"
    }' \
    "https://${HOST}:${PORT}/api/fdm/v6/object/syslogalerts"
from bravado.requests_client import RequestsClient
from bravado.client import SwaggerClient


def get_client(host, token):
    http_client = RequestsClient()
    http_client.ssl_verify = False
    http_client.set_api_key(
        host,
        "Bearer {}".format(token),
        param_name="Authorization",
        param_in="header"
    )
    return SwaggerClient.from_url(
        "https://{}/apispec/ngfw.json".format(host),
        http_client=http_client,
        config={
            "validate_responses": False,
            "validate_swagger_spec": False
        }
    )


def add_syslog_server(client, body):
    return client.SyslogServer.addSyslogServer(
        body=body
    ).response().result


if __name__ == "__main__":
    host = "ftd.example.com"
    token = "access_token"
    client = get_client(host, token)

    body = {'deviceInterface': {'id': 'string',
                     'name': 'string',
                     'type': 'string',
                     'version': 'string'},
 'host': 'string',
 'name': 'string',
 'port': 'string',
 'protocol': 'TCP',
 'type': 'syslogserver',
 'useManagementInterface': True}

    add_syslog_server(client, body)