Skip to content

sync_run

logger module-attribute #

logger = getLogger('fortimanager_template_sync.sync_run')

sync_run #

sync_run(template_repo: Annotated[str, Option(--template - repo, -t, envvar=FMGSYNC_TEMPLATE_REPO, help='Template repository URL')] = None, template_branch: Annotated[str, Option(--template - branch, -b, envvar=FMGSYNC_TEMPLATE_BRANCH, help='Branch in repository to sync')] = 'main', git_token: Annotated[str, Option(--git - token, envvar=FMGSYNC_GIT_TOKEN)] = None, local_repo: Annotated[Path, Option(--local - path, -l, envvar=FMGSYNC_LOCAL_REPO)] = './fmg-templates/', fmg_url: Annotated[str, Option(--fmg - url, -url, envvar=FMGSYNC_FMG_URL)] = None, fmg_user: Annotated[str, Option(--fmg - user, -u, envvar=FMGSYNC_FMG_USER)] = None, fmg_pass: Annotated[str, Option('--fmg-pass', -p, envvar=FMGSYNC_FMG_PASS)] = None, fmg_adom: Annotated[str, Option(--fmg - adom, -a, envvar=FMGSYNC_FMG_ADOM)] = 'root', fmg_verify: Annotated[bool, Option(envvar=FMGSYNC_FMG_VERIFY)] = True, protected_fw_group: Annotated[str, Option(--protected - firewall - group, -pg, envvar=FMGSYNC_PROTECTED_FW_GROUP, help='This group in FMG will be checked for FW status. Also this group will be deployed only')] = 'automation', delete_unused_templates: Annotated[bool, Option(--delete - unused - templates, -d)] = False, prod_run: Annotated[bool, Option(--force - changes, -f, help='do changes')] = False)

GIT/FMG sync operation

Source code in fortimanager_template_sync/sync_run.py 
15
16
17
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
def sync_run(
    template_repo: Annotated[
        str, typer.Option("--template-repo", "-t", envvar="FMGSYNC_TEMPLATE_REPO", help="Template repository URL")
    ] = None,
    template_branch: Annotated[
        str,
        typer.Option("--template-branch", "-b", envvar="FMGSYNC_TEMPLATE_BRANCH", help="Branch in repository to sync"),
    ] = "main",
    git_token: Annotated[str, typer.Option("--git-token", envvar="FMGSYNC_GIT_TOKEN")] = None,
    local_repo: Annotated[Path, typer.Option("--local-path", "-l", envvar="FMGSYNC_LOCAL_REPO")] = "./fmg-templates/",
    fmg_url: Annotated[str, typer.Option("--fmg-url", "-url", envvar="FMGSYNC_FMG_URL")] = None,
    fmg_user: Annotated[str, typer.Option("--fmg-user", "-u", envvar="FMGSYNC_FMG_USER")] = None,
    fmg_pass: Annotated[str, typer.Option("--fmg-pass", "-p", envvar="FMGSYNC_FMG_PASS")] = None,
    fmg_adom: Annotated[str, typer.Option("--fmg-adom", "-a", envvar="FMGSYNC_FMG_ADOM")] = "root",
    fmg_verify: Annotated[bool, typer.Option(envvar="FMGSYNC_FMG_VERIFY")] = True,
    protected_fw_group: Annotated[
        str,
        typer.Option(
            "--protected-firewall-group",
            "-pg",
            envvar="FMGSYNC_PROTECTED_FW_GROUP",
            help="This group in FMG will be checked for FW status. Also this group will be deployed only",
        ),
    ] = "automation",
    delete_unused_templates: Annotated[bool, typer.Option("--delete-unused-templates", "-d")] = False,
    prod_run: Annotated[bool, typer.Option("--force-changes", "-f", help="do changes")] = False,
):
    """GIT/FMG sync operation"""

    settings = FMGSyncSettings(
        template_repo=template_repo,
        template_branch=template_branch,
        git_token=git_token,
        local_repo=local_repo,
        fmg_url=fmg_url,
        fmg_user=fmg_user,
        fmg_pass=fmg_pass,
        fmg_adom=fmg_adom,
        fmg_verify=fmg_verify,
        protected_fw_group=protected_fw_group,
        delete_unused_templates=delete_unused_templates,
        prod_run=prod_run,
    )
    if not fmg_verify:
        urllib3.disable_warnings(category=urllib3.exceptions.InsecureRequestWarning)
    start_time = time.time()
    result = False
    try:
        task = FMGSyncTask(settings)
        result = task.run()
    except Exception as err:
        logger.error(err)
    finally:
        logger.info("Operation took %ss", round(time.time() - start_time, 2))
        if result:
            logger.info("Sync task finished successfully!")
            exit(0)
        else:
            logger.warning("Sync task finished with problems!")
            exit(1)