Skip to content

fmg

FMG API for humans

logger module-attribute #

logger = getLogger(__name__)

FMG #

FMG(settings: Optional[FMGSettings] = None, **kwargs)

Bases: FMGBase

FMG API for humans

Goal of this class to provide easy access to FMG features. This extends the base class capabilities with easy to use methods.

Parameters:

Name Type Description Default
settings Settings

FortiManager settings

 None

Other Parameters:

Name Type Description
base_url str

Base URL to access FMG (e.g.: https://myfmg/jsonrpc)
username str

User to authenticate
password str

Password for authentication
adom str

ADOM to use for this connection
verify bool

Verify SSL certificate (REQUESTS_CA_BUNDLE can set accepted CA cert)
timeout float

Connection timeout for requests in seconds
raise_on_error bool

Raise exception on error
discard_on_close bool

Discard changes after connection close (workspace mode)
discard_on_error bool

Discard changes when exception occurs (workspace mode)
Source code in pyfortinet/fmg_api/fmg.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
def __init__(self, settings: Optional[FMGSettings] = None, **kwargs):
    """Initializes FMG

    Args:
        settings (Settings): FortiManager settings

    Keyword Args:
        base_url (str): Base URL to access FMG (e.g.: https://myfmg/jsonrpc)
        username (str): User to authenticate
        password (str): Password for authentication
        adom (str): ADOM to use for this connection
        verify (bool): Verify SSL certificate (REQUESTS_CA_BUNDLE can set accepted CA cert)
        timeout (float): Connection timeout for requests in seconds
        raise_on_error (bool): Raise exception on error
        discard_on_close (bool): Discard changes after connection close (workspace mode)
        discard_on_error (bool): Discard changes when exception occurs (workspace mode)
    """
    super().__init__(settings, **kwargs)

add #

add(request: Union[dict[str, Any], FMGObject]) -> FMGResponse

Add operation

Parameters:

Name Type Description Default
request Union[dict[str, Any], FMGObject]

Add operation's data structure or object

 required

Examples:

Low-level - dict#
>>> settings = {...}
>>> address_request = {
...     "url": "/pm/config/global/obj/firewall/address",
...     "data": {
...         "name": "test-address",
...         "associated-interface": "inside",
...         "obj-type": "ip",
...         "type": "ipmask",
...         "start-ip": "10.0.0.1/24"
...     }
... }
>>> with FMG(**settings) as fmg:
...     fmg.add(address_request)
High-level - obj#
>>> from pyfortinet.fmg_api.firewall import Address
>>> settings = {...}
>>> address = Address(name="test-address", associated_interface="inside", obj_type="ip",
...                   type="ipmask", start_ip="10.0.0.1/24")
>>> with FMG(**settings) as fmg:
...     fmg.add(address)

Returns:

Type Description
FMGResponse

Result of operation
Source code in pyfortinet/fmg_api/fmg.py 
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
def add(self, request: Union[dict[str, Any], FMGObject]) -> FMGResponse:
    """Add operation

    Args:
        request: Add operation's data structure or object

    Examples:
        ## Low-level - dict

        ```pycon

        >>> settings = {...}
        >>> address_request = {
        ...     "url": "/pm/config/global/obj/firewall/address",
        ...     "data": {
        ...         "name": "test-address",
        ...         "associated-interface": "inside",
        ...         "obj-type": "ip",
        ...         "type": "ipmask",
        ...         "start-ip": "10.0.0.1/24"
        ...     }
        ... }
        >>> with FMG(**settings) as fmg:
        ...     fmg.add(address_request)
        ```

        ## High-level - obj

        ```pycon

        >>> from pyfortinet.fmg_api.firewall import Address
        >>> settings = {...}
        >>> address = Address(name="test-address", associated_interface="inside", obj_type="ip",
        ...                   type="ipmask", start_ip="10.0.0.1/24")
        >>> with FMG(**settings) as fmg:
        ...     fmg.add(address)
        ```

    Returns:
        (FMGResponse): Result of operation
    """
    response = FMGResponse(fmg=self)
    if isinstance(request, dict):  # dict input, low-level operation
        return super().add(request)

    elif isinstance(request, FMGObject):  # high-level operation
        request.fmg_scope = request.fmg_scope or self._settings.adom
        api_data = request.model_dump(by_alias=True, exclude_none=True)
        return super().add(request={"url": request.get_url, "data": api_data})
    else:
        response.data = {"error": f"Wrong type of request received: {request}"}
        response.status = 400
        logger.error(response.data["error"])
        if self._raise_on_error:
            raise FMGWrongRequestException(request)
        return response

delete #

delete(request: Union[dict[str, str], FMGObject]) -> FMGResponse

Delete operation

Parameters:

Name Type Description Default
request Union[dict[str, str], FMGObject]

dict or object to delete

 required

Examples:

Low-level - dict#
>>> settings = {...}
>>> address_request = {
...     "url": "/pm/config/global/obj/firewall/address/test-address",
... }
>>> with FMG(**settings) as fmg:
...     fmg.delete(address_request)
High-level - obj#
>>> from pyfortinet.fmg_api.firewall import Address
>>> settings = {...}
>>> address = Address(name="test-address")
>>> with FMG(**settings) as fmg:
...     fmg.delete(address)

Returns:

Type Description
FMGResponse

Result of operation
Source code in pyfortinet/fmg_api/fmg.py 
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
def delete(self, request: Union[dict[str, str], FMGObject]) -> FMGResponse:
    """Delete operation

    Args:
        request: dict or object to delete

    Examples:
        ## Low-level - dict

        ```pycon

        >>> settings = {...}
        >>> address_request = {
        ...     "url": "/pm/config/global/obj/firewall/address/test-address",
        ... }
        >>> with FMG(**settings) as fmg:
        ...     fmg.delete(address_request)
        ```

        ## High-level - obj

        ```pycon

        >>> from pyfortinet.fmg_api.firewall import Address
        >>> settings = {...}
        >>> address = Address(name="test-address")
        >>> with FMG(**settings) as fmg:
        ...     fmg.delete(address)
        ```

    Returns:
        (FMGResponse): Result of operation
    """
    response = FMGResponse(fmg=self)
    if isinstance(request, dict):  # JSON input, low-level operation
        return super().delete(request)

    elif isinstance(request, FMGObject):  # high-level operation
        request.fmg_scope = request.fmg_scope or self._settings.adom
        return super().delete(
            {"url": f"{request.get_url}/{request.name}"}
        )  # assume URL with name for del operation
    else:
        response.data = {"error": f"Wrong type of request received: {request}"}
        response.status = 400
        logger.error(response.data["error"])
        if self._raise_on_error:
            raise FMGWrongRequestException(request)
        return response

exec #

exec(request: Union[dict[str, Any], FMGExecObject]) -> FMGResponse

Execute on FMG

Source code in pyfortinet/fmg_api/fmg.py 
389
390
391
392
393
394
395
396
397
398
399
400
def exec(self, request: Union[dict[str, Any], FMGExecObject]) -> FMGResponse:
    """Execute on FMG"""
    if isinstance(request, dict):  # low-level operation
        return super().exec(request)
    elif isinstance(request, FMGExecObject):
        logger.info("requesting exec with high-level op to %s", request.get_url)
        request.fmg_scope = request.fmg_scope or self._settings.adom
        return super().exec({"url": request.get_url, "data": request.data})
    else:
        result = FMGResponse(fmg=self, data={"error": f"Wrong type of request received: {request}"}, status=400)
        logger.error(result.data["error"])
        return result

get #

get(request: Union[dict[str, Any], Type[FMGObject]], filters: FILTER_TYPE = None, scope: Optional[str] = None, fields: Optional[List[str]] = None, loadsub: bool = True, options: Optional[List[GetOption]] = None) -> FMGResponse

Get info from FMG

Parameters:

Name Type Description Default
request Union[dict[str, Any], Type[FMGObject]]

Get operation's data structure

 required
scope Optional[str]

Scope where the object is searched (defaults to FMG setting on connection)

 None
filters FILTER_TYPE

Filter expression

 None
fields Optional[List[str]]

Fields to return (default: None means all fields)

 None
loadsub bool

Load sub objects

 True
options Optional[List[GetOption]]

API request options

 None

Examples:

Low-level - dict#
>>> address_request = {
...    "url": "/pm/config/global/obj/firewall/address",
...    "filter": [ ["name", "==", "test-address"] ],
...    "fields": [ "name", "subnet" ]
...}
>>> settings = {...}
>>> with FMG(**settings) as fmg:
...    fmg.get(address_request)
High-level - obj#
>>> from pyfortinet.fmg_api.firewall import Address
>>> from pyfortinet.fmg_api.common import F
>>> settings = {...}
>>> with FMG(**settings) as fmg:
...    addresses = fmg.get(Address, F(name__like="test-%") & F(subnet="test-subnet"))

Returns:

Type Description
FMGResponse

response object with data
Source code in pyfortinet/fmg_api/fmg.py 
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
@auth_required
def get(
    self,
    request: Union[dict[str, Any], Type[FMGObject]],
    filters: FILTER_TYPE = None,
    scope: Optional[str] = None,
    fields: Optional[List[str]] = None,
    loadsub: bool = True,
    options: Optional[List[GetOption]] = None,
) -> FMGResponse:
    """Get info from FMG

    Args:
        request: Get operation's data structure
        scope: Scope where the object is searched (defaults to FMG setting on connection)
        filters: Filter expression
        fields: Fields to return (default: None means all fields)
        loadsub: Load sub objects
        options: API request options

    Examples:
        ## Low-level - dict

        ```pycon

        >>> address_request = {
        ...    "url": "/pm/config/global/obj/firewall/address",
        ...    "filter": [ ["name", "==", "test-address"] ],
        ...    "fields": [ "name", "subnet" ]
        ...}
        >>> settings = {...}
        >>> with FMG(**settings) as fmg:
        ...    fmg.get(address_request)
        ```

        ## High-level - obj

        ```pycon

        >>> from pyfortinet.fmg_api.firewall import Address
        >>> from pyfortinet.fmg_api.common import F
        >>> settings = {...}
        >>> with FMG(**settings) as fmg:
        ...    addresses = fmg.get(Address, F(name__like="test-%") & F(subnet="test-subnet"))
        ```

    Returns:
        (FMGResponse): response object with data
    """
    # Call base function for base arguments
    if isinstance(request, dict):
        return super().get(request)
    # High level arguments
    result = FMGResponse(fmg=self)
    if issubclass(request, FMGObject):
        # derive url from current scope and adom
        if not scope:  # get adom from FMG settings
            scope = "global" if self._settings.adom == "global" else f"adom/{self._settings.adom}"
        else:  # user specified
            scope = "global" if scope == "global" else f"adom/{scope}"
        url = request._url.default.replace("{scope}", scope)
        if self._settings.adom != "global":
            url = url.replace("{adom}", f"/adom/{self._settings.adom}")
        else:
            url = url.replace("{adom}", "")

        api_request = {
            "loadsub": 1 if loadsub else 0,
        }

        if filters:
            api_request["filter"] = self._get_filter_list(filters)

        if options:
            api_request["option"] = options

        body = {
            "method": "get",
            "params": [{"url": url, **api_request}],
            "verbose": 1,
            "session": self._token.get_secret_value(),
            "id": self._id,
        }
    else:
        result.data = {"error": f"Wrong type of request received: {request}"}
        result.status = 400
        logger.error(result.data["error"])
        if self._raise_on_error:
            raise FMGWrongRequestException(result)
        return result
    try:
        api_result = self._post(request=body)
    except FMGException as err:
        api_result = {"error": str(err)}
        logger.error("Error in get request: %s", api_result["error"])
        if self._raise_on_error:
            raise
        result.data = api_result
        return result
    # No need for the following. Pydantic "alias" can be used to handle space or dash in keys!
    # converting API names to object names (replace '-' and ' ' -> _)
    # obj_model = [
    #     {key.replace("-", "_").replace(" ", "_"): value for key, value in data.items()}
    #     for data in api_result.get("data")
    # ]
    # construct object list
    objects = []
    for value in api_result.get("data"):
        objects.append(request(**value, scope=scope, fmg=self))
    result.data = objects
    result.success = True
    return result

get_adom_list #

get_adom_list(filters: FILTER_TYPE = None) -> Optional[List[str]]

Gather adoms from FMG

Parameters:

Name Type Description Default
filters FILTER_TYPE

filter as list or F object

 None

Returns:

Type Description
Optional[List[str]]

list of adom strings or None in case of error
Source code in pyfortinet/fmg_api/fmg.py 
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
def get_adom_list(self, filters: FILTER_TYPE = None) -> Optional[List[str]]:
    """Gather adoms from FMG

    Args:
        filters: filter as list or F object

    Returns:
        list of adom strings or None in case of error
    """
    request = {"url": "/dvmdb/adom", "fields": ["name"]}
    if filters:
        request["filter"] = self._get_filter_list(filters)

    response: FMGResponse = self.get(request)
    if response.success:
        return [adom.get("name") for adom in response.data.get("data")]
    return None

get_obj #

get_obj(obj: Union[Type[FMGObject], Type[FMGExecObject], AnyFMGObject], **kwargs: Dict[str, Any]) -> AnyFMGObject

Get an object and tie it to this FMG

Parameters:

Name Type Description Default
obj Union[Type[FMGObject], Type[FMGExecObject], AnyFMGObject]

Any type or instance of FMGObject or FMGExecObject

 required

Other Parameters:

Name Type Description
kwargs Dict[str, Any]

fields for the new object initialization

Returns:

Type Description
AnyFMGObject

New object, tied to this FMG
Source code in pyfortinet/fmg_api/fmg.py 
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
def get_obj(
    self, obj: Union[Type[FMGObject], Type[FMGExecObject], AnyFMGObject], **kwargs: Dict[str, Any]
) -> AnyFMGObject:
    """Get an object and tie it to this FMG

    Arguments:
        obj: Any type or instance of FMGObject or FMGExecObject

    Keyword Args:
        kwargs: fields for the new object initialization

    Returns:
        (AnyFMGObject): New object, tied to this FMG
    """
    if isinstance(obj, Union[FMGObject, FMGExecObject]):
        obj._fmg = self
        return obj
    elif isclass(obj) and issubclass(obj, Union[FMGObject, FMGExecObject]):
        return obj(fmg=self, **kwargs)

    raise TypeError(f"Argument {obj} is not an FMGObject or FMGExecObject type")

set #

set(request: Union[dict[str, Any], FMGObject]) -> FMGResponse

Set operation

Parameters:

Name Type Description Default
request Union[dict[str, Any], FMGObject]

Update operation's data structure

 required

Examples:

Low-level - dict#
>>> settings = {...}
>>> address_request = {
...     "url": "/pm/config/global/obj/firewall/address",
...     "data": {
...         "name": "test-address",
...         "associated-interface": "inside",
...         "obj-type": "ip",
...         "type": "ipmask",
...         "start-ip": "10.0.0.1/24"
...     }
... }
>>> with FMGBase(**settings) as fmg:
...     fmg.set(address_request)
High-level - obj#
>>> from pyfortinet.fmg_api.firewall import Address
>>> settings = {...}
>>> address = Address(name="test-address", associated_interface="inside", obj_type="ip",
...                   type="ipmask", start_ip="10.0.0.1/24")
>>> with FMGBase(**settings) as fmg:
...     fmg.set(address)

Returns:

Type Description
FMGResponse

Result of operation
Source code in pyfortinet/fmg_api/fmg.py 
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
def set(self, request: Union[dict[str, Any], FMGObject]) -> FMGResponse:
    """Set operation

    Args:
        request: Update operation's data structure

    Examples:
        ## Low-level - dict

        ```pycon

        >>> settings = {...}
        >>> address_request = {
        ...     "url": "/pm/config/global/obj/firewall/address",
        ...     "data": {
        ...         "name": "test-address",
        ...         "associated-interface": "inside",
        ...         "obj-type": "ip",
        ...         "type": "ipmask",
        ...         "start-ip": "10.0.0.1/24"
        ...     }
        ... }
        >>> with FMGBase(**settings) as fmg:
        ...     fmg.set(address_request)
        ```

        ## High-level - obj

        ```pycon

        >>> from pyfortinet.fmg_api.firewall import Address
        >>> settings = {...}
        >>> address = Address(name="test-address", associated_interface="inside", obj_type="ip",
        ...                   type="ipmask", start_ip="10.0.0.1/24")
        >>> with FMGBase(**settings) as fmg:
        ...     fmg.set(address)
        ```

    Returns:
        (FMGResponse): Result of operation
    """
    response = FMGResponse(fmg=self)
    if isinstance(request, dict):  # JSON input, low-level operation
        return super().set(request)
    elif isinstance(request, FMGObject):  # high-level operation
        request.fmg_scope = request.fmg_scope or self._settings.adom
        api_data = request.model_dump(by_alias=True, exclude_none=True)
        return super().set({"url": request.get_url, "data": api_data})
    else:
        response.data = {"error": f"Wrong type of request received: {request}"}
        response.status = 400
        logger.error(response.data["error"])
        if self._raise_on_error:
            raise FMGWrongRequestException(request)
        return response

update #

update(request: Union[dict[str, Any], FMGObject]) -> FMGResponse

Update operation

Parameters:

Name Type Description Default
request Union[dict[str, Any], FMGObject]

Update operation's data structure

 required

Examples:

Low-level - dict#
>>> settings = {...}
>>> address_request = {
...     "url": "/pm/config/global/obj/firewall/address",
...     "data": {
...         "name": "test-address",
...         "associated-interface": "inside",
...         "obj-type": "ip",
...         "type": "ipmask",
...         "start-ip": "10.0.0.1/24"
...     }
... }
>>> with FMGBase(**settings) as fmg:
...     fmg.update(address_request)
High-level - obj#
>>> from pyfortinet.fmg_api.firewall import Address
>>> settings = {...}
>>> address = Address(name="test-address", associated_interface="inside", obj_type="ip",
...                   type="ipmask", start_ip="10.0.0.1/24")
>>> with FMGBase(**settings) as fmg:
...     fmg.update(address)

Returns:

Type Description
FMGResponse

Result of operation
Source code in pyfortinet/fmg_api/fmg.py 
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
def update(self, request: Union[dict[str, Any], FMGObject]) -> FMGResponse:
    """Update operation

    Args:
        request: Update operation's data structure

    Examples:
        ## Low-level - dict

        ```pycon

        >>> settings = {...}
        >>> address_request = {
        ...     "url": "/pm/config/global/obj/firewall/address",
        ...     "data": {
        ...         "name": "test-address",
        ...         "associated-interface": "inside",
        ...         "obj-type": "ip",
        ...         "type": "ipmask",
        ...         "start-ip": "10.0.0.1/24"
        ...     }
        ... }
        >>> with FMGBase(**settings) as fmg:
        ...     fmg.update(address_request)
        ```

        ## High-level - obj

        ```pycon

        >>> from pyfortinet.fmg_api.firewall import Address
        >>> settings = {...}
        >>> address = Address(name="test-address", associated_interface="inside", obj_type="ip",
        ...                   type="ipmask", start_ip="10.0.0.1/24")
        >>> with FMGBase(**settings) as fmg:
        ...     fmg.update(address)
        ```

    Returns:
        (FMGResponse): Result of operation
    """
    response = FMGResponse(fmg=self)
    if isinstance(request, dict):  # JSON input, low-level operation
        return super().update(request)
    elif isinstance(request, FMGObject):  # high-level operation
        request.fmg_scope = request.fmg_scope or self._settings.adom
        api_data = request.model_dump(by_alias=True, exclude_none=True)
        return super().update({"url": request.get_url, "data": api_data})
    else:
        response.data = {"error": f"Wrong type of request received: {request}"}
        response.status = 400
        logger.error(response.data["error"])
        if self._raise_on_error:
            raise FMGWrongRequestException(request)
        return response