Skip to content

connection

FMG connection

logger module-attribute #

logger = getLogger(__name__)

FMGSync #

Bases: FMG

Fortimanager connection class

add_cli_template #

add_cli_template(name: str, script: str, description: str = '', provision: Literal['disable', 'enable'] = 'disable', type: Literal['cli', 'jinja'] = 'jinja', variables: Optional[List[dict]] = None) -> FMGResponse

Add CLI template

Source code in fortimanager_template_sync/fmg_api/connection.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
def add_cli_template(
    self,
    name: str,
    script: str,
    description: str = "",
    provision: Literal["disable", "enable"] = "disable",
    type: Literal["cli", "jinja"] = "jinja",
    variables: Optional[List[dict]] = None,
) -> FMGResponse:
    """Add CLI template"""
    if not variables:
        variables = []
    if self._settings.adom == "global":
        url = "/pm/config/global/obj/cli/template"
    else:
        url = f"/pm/config/adom/{self._settings.adom}/obj/cli/template"
    request = {
        "data": {
            "description": description,
            "name": name,
            "provision": provision,
            "script": script,
            "type": type,
            "variables": [variable["name"] for variable in variables],
        },
        "url": url,
    }
    return self.add(request)

add_cli_template_group #

add_cli_template_group(name: str, description: str = '', member: Optional[List[str]] = None, variables: Optional[List[dict]] = None) -> FMGResponse

Add CLI template group

Source code in fortimanager_template_sync/fmg_api/connection.py 
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
def add_cli_template_group(
    self,
    name: str,
    description: str = "",
    member: Optional[List[str]] = None,
    variables: Optional[List[dict]] = None,
) -> FMGResponse:
    """Add CLI template group"""
    if not variables:
        variables = []
    if not member:
        member = []
    if self._settings.adom == "global":
        url = "/pm/config/global/obj/cli/template-group"
    else:
        url = f"/pm/config/adom/{self._settings.adom}/obj/cli/template-group"
    request = {
        "data": {
            "description": description,
            "name": name,
            "member": member,
            "variables": [variable["name"] for variable in variables],
        },
        "url": url,
    }
    return self.add(request)

add_fmg_variable #

add_fmg_variable(name: str, value: Optional[str] = None, description: Optional[str] = None) -> FMGResponse

Add metadata variable to use in CLI templates

Parameters:

Name Type Description Default
name str

variable name

 required
value str

default value

 None
description str

variable description

 None
Source code in fortimanager_template_sync/fmg_api/connection.py 
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
def add_fmg_variable(
    self, name: str, value: Optional[str] = None, description: Optional[str] = None
) -> FMGResponse:
    """Add metadata variable to use in CLI templates

    Args:
        name (str): variable name
        value (str): default value
        description (str): variable description
    """
    if self._settings.adom == "global":
        url = "/pm/config/global/obj/fmg/variable"
    else:
        url = f"/pm/config/adom/{self._settings.adom}/obj/fmg/variable"
    request = {
        "data": {
            "description": description,
            "name": name,
            "value": value,
        },
        "url": url,
    }
    return self.add(request)

assign_cli_template #

assign_cli_template(template: str, target: Union[Dict[str, str], List[Dict[str, str]]])

Assign group or device to template

Examples:

target = {"name": "mygroup"}

target = {"name": "myfw", "vdom": "root"}

target = [ {"name": "group1"}, {"name": "group2"} ]

Parameters:

Name Type Description Default
template str

name of template

 required
target Union[Dict[str, str], List[Dict[str, str]]]

a single object or a list of objects to assign to the template

 required
Source code in fortimanager_template_sync/fmg_api/connection.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
def assign_cli_template(self, template: str, target: Union[Dict[str, str], List[Dict[str, str]]]):
    """Assign group or device to template

    Examples:
        target = {"name": "mygroup"}

        target = {"name": "myfw", "vdom": "root"}

        target = [ {"name": "group1"}, {"name": "group2"} ]

    Args:
        template: name of template
        target: a single object or a list of objects to assign to the template
    """
    if not isinstance(target, list):
        target = [target]

    if self._settings.adom == "global":
        url = f"/pm/config/global/obj/cli/template/{template}/scope member"
    else:
        url = f"/pm/config/adom/{self._settings.adom}/obj/cli/template/{template}/scope member"
    request = {"data": target, "url": url}
    return self.add(request)

assign_cli_template_group #

assign_cli_template_group(template_group: str, target: Union[Dict[str, str], List[Dict[str, str]]])

Assign group or device to template group

Examples:

target = {"name": "mygroup"}

target = {"name": "myfw", "vdom": "root"}

target = [ {"name": "group1"}, {"name": "group2"} ]

Parameters:

Name Type Description Default
template_group str

name of template

 required
target Union[Dict[str, str], List[Dict[str, str]]]

a single object or a list of objects to assign to the template

 required

Raises:

Type Description
FMGInvalidDataException

if target is invalid or non-existent
Source code in fortimanager_template_sync/fmg_api/connection.py 
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
def assign_cli_template_group(self, template_group: str, target: Union[Dict[str, str], List[Dict[str, str]]]):
    """Assign group or device to template group

    Examples:
        target = {"name": "mygroup"}

        target = {"name": "myfw", "vdom": "root"}

        target = [ {"name": "group1"}, {"name": "group2"} ]

    Args:
        template_group: name of template
        target: a single object or a list of objects to assign to the template

    Raises:
        FMGInvalidDataException: if target is invalid or non-existent
    """
    if not isinstance(target, list):
        target = [target]

    if self._settings.adom == "global":
        url = f"/pm/config/global/obj/cli/template-group/{template_group}/scope member"
    else:
        url = f"/pm/config/adom/{self._settings.adom}/obj/cli/template-group/{template_group}/scope member"
    request = {"data": target, "url": url}
    return self.add(request)

delete_cli_template #

delete_cli_template(name: str) -> FMGResponse

Delete CLI template

Source code in fortimanager_template_sync/fmg_api/connection.py 
189
190
191
192
193
194
195
196
197
198
def delete_cli_template(self, name: str) -> FMGResponse:
    """Delete CLI template"""
    if self._settings.adom == "global":
        url = f"/pm/config/global/obj/cli/template/{name}"
    else:
        url = f"/pm/config/adom/{self._settings.adom}/obj/cli/template/{name}"
    request = {
        "url": url,
    }
    return self.delete(request)

delete_cli_template_group #

delete_cli_template_group(name: str) -> FMGResponse

Delete CLI template

Source code in fortimanager_template_sync/fmg_api/connection.py 
312
313
314
315
316
317
318
319
320
321
def delete_cli_template_group(self, name: str) -> FMGResponse:
    """Delete CLI template"""
    if self._settings.adom == "global":
        url = f"/pm/config/global/obj/cli/template-group/{name}"
    else:
        url = f"/pm/config/adom/{self._settings.adom}/obj/cli/template-group/{name}"
    request = {
        "url": url,
    }
    return self.delete(request)

get_cli_template #

get_cli_template(name: str) -> FMGResponse

Get a specific CLI template

Source code in fortimanager_template_sync/fmg_api/connection.py 
162
163
164
165
166
167
168
169
170
171
172
def get_cli_template(self, name: str) -> FMGResponse:
    """Get a specific CLI template"""
    if self._settings.adom == "global":
        url = f"/pm/config/global/obj/cli/template/{name}"
    else:
        url = f"/pm/config/adom/{self._settings.adom}/obj/cli/template/{name}"
    request = {
        "url": url,
        "option": "scope member",
    }
    return self.get(request)

get_cli_template_group #

get_cli_template_group(name: str) -> FMGResponse

Get a specific CLI template group

Source code in fortimanager_template_sync/fmg_api/connection.py 
283
284
285
286
287
288
289
290
291
292
293
def get_cli_template_group(self, name: str) -> FMGResponse:
    """Get a specific CLI template group"""
    if self._settings.adom == "global":
        url = f"/pm/config/global/obj/cli/template-group/{name}"
    else:
        url = f"/pm/config/adom/{self._settings.adom}/obj/cli/template-group/{name}"
    request = {
        "url": url,
        "option": "scope member",
    }
    return self.get(request)

get_cli_template_groups #

get_cli_template_groups(filters: FILTER_TYPE = None) -> FMGResponse

Get CLI template groups

Source code in fortimanager_template_sync/fmg_api/connection.py 
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
def get_cli_template_groups(self, filters: FILTER_TYPE = None) -> FMGResponse:
    """Get CLI template groups"""
    if self._settings.adom == "global":
        url = "/pm/config/global/obj/cli/template-group"
    else:
        url = f"/pm/config/adom/{self._settings.adom}/obj/cli/template-group"
    request = {
        "url": url,
        "option": "scope member",
    }
    if filters:
        request["filter"] = self._get_filter_list(filters)
    try:
        return self.get(request)
    except FMGEmptyResultException:
        return FMGResponse(data={"data": []})

get_cli_templates #

get_cli_templates(filters: FILTER_TYPE = None) -> FMGResponse

Get CLI templates

Source code in fortimanager_template_sync/fmg_api/connection.py 
174
175
176
177
178
179
180
181
182
183
184
185
186
187
def get_cli_templates(self, filters: FILTER_TYPE = None) -> FMGResponse:
    """Get CLI templates"""
    if self._settings.adom == "global":
        url = "/pm/config/global/obj/cli/template"
    else:
        url = f"/pm/config/adom/{self._settings.adom}/obj/cli/template"

    request = {
        "url": url,
        "option": "scope member",
    }
    if filters:
        request["filter"] = self._get_filter_list(filters)
    return self.get(request)

get_devices #

get_devices(filters: FILTER_TYPE = None)

Get devices

Source code in fortimanager_template_sync/fmg_api/connection.py 
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
def get_devices(self, filters: FILTER_TYPE = None):
    """Get devices"""
    if self._settings.adom == "global":
        url = "/dvmdb/device"
    else:
        url = f"/dvmdb/adom/{self._settings.adom}/device"

    request = {
        "url": url,
        "fields": ["name", "conf_status", "conn_status", "db_status", "dev_status"],
        "loadsub": 1,  # gather vdoms
        "option": [
            "extra info",
            "assignment info",
        ],
    }
    if filters:
        request["filter"] = self._get_filter_list(filters)
    return self.get(request)

get_fmg_variable #

get_fmg_variable(name: str) -> FMGResponse

Get a specific variable

Source code in fortimanager_template_sync/fmg_api/connection.py 
347
348
349
350
351
352
353
354
355
356
def get_fmg_variable(self, name: str) -> FMGResponse:
    """Get a specific variable"""
    if self._settings.adom == "global":
        url = f"/pm/config/global/obj/fmg/variable/{name}"
    else:
        url = f"/pm/config/adom/{self._settings.adom}/obj/fmg/variable/{name}"
    request = {
        "url": url,
    }
    return self.get(request)

get_fmg_variables #

get_fmg_variables(filters: FILTER_TYPE = None) -> FMGResponse

Get metadata variables based on filter

Source code in fortimanager_template_sync/fmg_api/connection.py 
358
359
360
361
362
363
364
365
366
367
368
369
def get_fmg_variables(self, filters: FILTER_TYPE = None) -> FMGResponse:
    """Get metadata variables based on filter"""
    if self._settings.adom == "global":
        url = "/pm/config/global/obj/fmg/variable"
    else:
        url = f"/pm/config/adom/{self._settings.adom}/obj/fmg/variable"
    request = {
        "url": url,
    }
    if filters:
        request["filter"] = self._get_filter_list(filters)
    return self.get(request)

get_group_members #

get_group_members(group_name: str)

Get group members

Source code in fortimanager_template_sync/fmg_api/connection.py 
439
440
441
442
443
444
445
446
447
def get_group_members(self, group_name: str):
    """Get group members"""
    if self._settings.adom == "global":
        url = f"/dvmdb/group/{group_name}"
    else:
        url = f"/dvmdb/adom/{self._settings.adom}/group/{group_name}"

    request = {"option": "object member", "url": url}
    return self.get(request)

set_cli_template #

set_cli_template(name: str, script: str, new_name: str = '', description: str = '', provision: Literal['disable', 'enable'] = 'disable', type: Literal['cli', 'jinja'] = 'jinja', variables: Optional[List[dict]] = None) -> FMGResponse

Update a CLI template

Source code in fortimanager_template_sync/fmg_api/connection.py 
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
def set_cli_template(
    self,
    name: str,
    script: str,
    new_name: str = "",
    description: str = "",
    provision: Literal["disable", "enable"] = "disable",
    type: Literal["cli", "jinja"] = "jinja",
    variables: Optional[List[dict]] = None,
) -> FMGResponse:
    """Update a CLI template"""
    if not variables:
        variables = []
    if self._settings.adom == "global":
        url = f"/pm/config/global/obj/cli/template/{name}"
    else:
        url = f"/pm/config/adom/{self._settings.adom}/obj/cli/template/{name}"
    if new_name:
        name = new_name
    request = {
        "data": {
            "description": description,
            "name": name,
            "provision": provision,
            "script": script,
            "type": type,
            "variables": [variable["name"] for variable in variables],
        },
        "url": url,
    }
    return self.set(request)

set_cli_template_group #

set_cli_template_group(name: str, description: str = '', member: Optional[List[str]] = None, variables: Optional[List[dict]] = None) -> FMGResponse

Set CLI template group

Source code in fortimanager_template_sync/fmg_api/connection.py 
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
def set_cli_template_group(
    self,
    name: str,
    description: str = "",
    member: Optional[List[str]] = None,
    variables: Optional[List[dict]] = None,
) -> FMGResponse:
    """Set CLI template group"""
    if not variables:
        variables = []
    if not member:
        member = []
    if self._settings.adom == "global":
        url = "/pm/config/global/obj/cli/template-group"
    else:
        url = f"/pm/config/adom/{self._settings.adom}/obj/cli/template-group"
    request = {
        "data": {
            "description": description,
            "name": name,
            "member": member,
            "variables": [variable["name"] for variable in variables],
        },
        "url": url,
    }
    return self.set(request)

set_fmg_variable #

set_fmg_variable(name: str, value: Optional[str] = None, description: Optional[str] = None) -> FMGResponse

Update metadata variable to use in CLI templates

Parameters:

Name Type Description Default
name str

variable name

 required
value str

default value

 None
description str

variable description

 None
Source code in fortimanager_template_sync/fmg_api/connection.py 
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
def set_fmg_variable(
    self, name: str, value: Optional[str] = None, description: Optional[str] = None
) -> FMGResponse:
    """Update metadata variable to use in CLI templates

    Args:
        name (str): variable name
        value (str): default value
        description (str): variable description
    """
    if self._settings.adom == "global":
        url = "/pm/config/global/obj/fmg/variable"
    else:
        url = f"/pm/config/adom/{self._settings.adom}/obj/fmg/variable"
    request = {
        "data": {
            "description": description,
            "name": name,
            "value": value,
        },
        "url": url,
    }
    return self.set(request)

update_cli_template #

update_cli_template(name: str, script: str, new_name: str = '', description: str = '', provision: Literal['disable', 'enable'] = 'disable', type: Literal['cli', 'jinja'] = 'jinja', variables: Optional[List[dict]] = None) -> FMGResponse

Update a CLI template

Source code in fortimanager_template_sync/fmg_api/connection.py 
 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
def update_cli_template(
    self,
    name: str,
    script: str,
    new_name: str = "",
    description: str = "",
    provision: Literal["disable", "enable"] = "disable",
    type: Literal["cli", "jinja"] = "jinja",
    variables: Optional[List[dict]] = None,
) -> FMGResponse:
    """Update a CLI template"""
    if not variables:
        variables = []
    if self._settings.adom == "global":
        url = f"/pm/config/global/obj/cli/template/{name}"
    else:
        url = f"/pm/config/adom/{self._settings.adom}/obj/cli/template/{name}"
    if new_name:
        name = new_name
    request = {
        "data": {
            "description": description,
            "name": name,
            "provision": provision,
            "script": script,
            "type": type,
            "variables": [variable["name"] for variable in variables],
        },
        "url": url,
    }
    return self.update(request)

update_cli_template_group #

update_cli_template_group(name: str, description: str = '', member: Optional[List[str]] = None, variables: Optional[List[dict]] = None) -> FMGResponse

Update CLI template group

Source code in fortimanager_template_sync/fmg_api/connection.py 
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
def update_cli_template_group(
    self,
    name: str,
    description: str = "",
    member: Optional[List[str]] = None,
    variables: Optional[List[dict]] = None,
) -> FMGResponse:
    """Update CLI template group"""
    if not variables:
        variables = []
    if not member:
        member = []
    if self._settings.adom == "global":
        url = "/pm/config/global/obj/cli/template-group"
    else:
        url = f"/pm/config/adom/{self._settings.adom}/obj/cli/template-group"
    request = {
        "data": {
            "description": description,
            "name": name,
            "member": member,
            "variables": [variable["name"] for variable in variables],
        },
        "url": url,
    }
    return self.update(request)

update_fmg_variable #

update_fmg_variable(name: str, value: Optional[str] = None, description: Optional[str] = None) -> FMGResponse

Update metadata variable to use in CLI templates

Parameters:

Name Type Description Default
name str

variable name

 required
value str

default value

 None
description str

variable description

 None
Source code in fortimanager_template_sync/fmg_api/connection.py 
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
def update_fmg_variable(
    self, name: str, value: Optional[str] = None, description: Optional[str] = None
) -> FMGResponse:
    """Update metadata variable to use in CLI templates

    Args:
        name (str): variable name
        value (str): default value
        description (str): variable description
    """
    if self._settings.adom == "global":
        url = "/pm/config/global/obj/fmg/variable"
    else:
        url = f"/pm/config/adom/{self._settings.adom}/obj/fmg/variable"
    request = {
        "data": {
            "description": description,
            "name": name,
            "value": value,
        },
        "url": url,
    }
    return self.update(request)