{
  "code_name": "unifi_api_import",
  "unique_prefix": "UNIFIAPI",
  "plugin_type": "device_scanner",
  "execution_order": "Layer_0",
  "enabled": true,
  "data_source": "script",
  "mapped_to_table": "CurrentScan",
  "data_filters": [
    {
      "compare_column": "Object_PrimaryID",
      "compare_operator": "==",
      "compare_field_id": "txtMacFilter",
      "compare_js_template": "'{value}'.toString()",
      "compare_use_quotes": true
    }
  ],
  "show_ui": true,
  "localized": [
    "display_name",
    "description",
    "icon"
  ],
  "display_name": [
    {
      "language_code": "en_us",
      "string": "UniFi import (API)"
    }
  ],
  "description": [
    {
      "language_code": "en_us",
      "string": "This plugin is used to import devices from an UNIFI controller via the Site Manager API."
    }
  ],
  "icon": [
    {
      "language_code": "en_us",
      "string": "<i class=\"fa-solid fa-shield-halved\"></i>"
    }
  ],
  "params": [],
  "settings": [
    {
      "function": "RUN",
      "events": [
        "run"
      ],
      "type": {
        "dataType": "string",
        "elements": [
          {
            "elementType": "select",
            "elementOptions": [],
            "transformers": []
          }
        ]
      },
      "default_value": "disabled",
      "options": [
        "disabled",
        "once",
        "schedule"
      ],
      "localized": [
        "name",
        "description"
      ],
      "name": [
        {
          "language_code": "en_us",
          "string": "When to run"
        }
      ],
      "description": [
        {
          "language_code": "en_us",
          "string": "When the plugin should run. Good options are <code>schedule</code>, <code>once</code>."
        }
      ]
    },
    {
      "function": "RUN_SCHD",
      "type": {
        "dataType": "string",
        "elements": [
          {
            "elementType": "span",
            "elementOptions": [
              {
                "cssClasses": "input-group-addon validityCheck"
              },
              {
                "getStringKey": "Gen_ValidIcon"
              }
            ],
            "transformers": []
          },
          {
            "elementType": "input",
            "elementOptions": [
              {
                "focusout": "validateRegex(this)"
              },
              {
                "base64Regex": "Xig/OlwqfCg/OlswLTldfFsxLTVdWzAtOV18WzAtOV0rLVswLTldK3xcKi9bMC05XSspKVxzKyg/OlwqfCg/OlswLTldfDFbMC05XXwyWzAtM118WzAtOV0rLVswLTldK3xcKi9bMC05XSspKVxzKyg/OlwqfCg/OlsxLTldfFsxMl1bMC05XXwzWzAxXXxbMC05XSstWzAtOV0rfFwqL1swLTldKykpXHMrKD86XCp8KD86WzEtOV18MVswLTJdfFswLTldKy1bMC05XSt8XCovWzAtOV0rKSlccysoPzpcKnwoPzpbMC02XXxbMC02XS1bMC02XXxcKi9bMC05XSspKSQ="
              }
            ],
            "transformers": []
          }
        ]
      },
      "default_value": "*/5 * * * *",
      "options": [],
      "localized": [
        "name",
        "description"
      ],
      "name": [
        {
          "language_code": "en_us",
          "string": "Schedule"
        }
      ],
      "description": [
        {
          "language_code": "en_us",
          "string": "Only enabled if you select <code>schedule</code> in the <a href=\"#UNIFIAPI_RUN\"><code>UNIFIAPI_RUN</code> setting</a>. Make sure you enter the schedule in the correct cron-like format (e.g. validate at <a href=\"https://crontab.guru/\" target=\"_blank\">crontab.guru</a>). For example entering <code>0 4 * * *</code> will run the scan after 4 am in the <a onclick=\"toggleAllSettings()\" href=\"#TIMEZONE\"><code>TIMEZONE</code> you set above</a>. Will be run NEXT time the time passes."
        }
      ]
    },
    {
      "function": "CMD",
      "type": {
        "dataType": "string",
        "elements": [
          {
            "elementType": "input",
            "elementOptions": [
              {
                "readonly": "true"
              }
            ],
            "transformers": []
          }
        ]
      },
      "default_value": "python3 /app/front/plugins/unifi_api_import/unifi_api_import.py",
      "options": [],
      "localized": [
        "name",
        "description"
      ],
      "name": [
        {
          "language_code": "en_us",
          "string": "Command"
        }
      ],
      "description": [
        {
          "language_code": "en_us",
          "string": "Command to run. This can not be changed"
        }
      ]
    },
    {
      "function": "RUN_TIMEOUT",
      "type": {
        "dataType": "integer",
        "elements": [
          {
            "elementType": "input",
            "elementOptions": [
              {
                "type": "number"
              }
            ],
            "transformers": []
          }
        ]
      },
      "default_value": 10,
      "options": [],
      "localized": [
        "name",
        "description"
      ],
      "name": [
        {
          "language_code": "en_us",
          "string": "Run timeout"
        }
      ],
      "description": [
        {
          "language_code": "en_us",
          "string": "Maximum time in seconds to wait for the script to finish. If this time is exceeded the script is aborted."
        }
      ]
    },
    {
      "function": "sites",
      "type": {
        "dataType": "array",
        "elements": [
          {
            "elementType": "button",
            "elementOptions": [
              {
                "sourceSuffixes": []
              },
              {
                "separator": ""
              },
              {
                "cssClasses": "col-xs-12"
              },
              {
                "onClick": "addViaPopupForm(this)"
              },
              {
                "getStringKey": "Gen_Add"
              }
            ],
            "transformers": []
          },
          {
            "elementType": "select",
            "elementHasInputValue": 1,
            "elementOptions": [
              {
                "multiple": "true"
              },
              {
                "readonly": "true"
              },
              {
                "editable": "true"
              },
              {
                "popupForm": [
                  {
                    "function": "UNIFIAPI_site_name",
                    "type": {
                      "dataType": "string",
                      "elements": [
                        {
                          "elementType": "input",
                          "elementOptions": [
                            {
                              "placeholder": "Enter value"
                            },
                            {
                              "cssClasses": "col-sm-10"
                            }
                          ],
                          "transformers": []
                        }
                      ]
                    },
                    "default_value": "default",
                    "options": [],
                    "localized": [
                      "name",
                      "description"
                    ],
                    "name": [
                      {
                        "language_code": "en_us",
                        "string": "Site name"
                      }
                    ],
                    "description": [
                      {
                        "language_code": "en_us",
                        "string": "The name of your site. Use a descriptive name."
                      }
                    ]
                  },
                  {
                    "function": "UNIFIAPI_base_url",
                    "type": {
                      "dataType": "string",
                      "elements": [
                        {
                          "elementType": "input",
                          "elementOptions": [
                            {
                              "placeholder": "https://host_ip/proxy/network/integration/"
                            },
                            {
                              "cssClasses": "col-sm-10"
                            }
                          ],
                          "transformers": []
                        }
                      ]
                    },
                    "default_value": "default",
                    "options": [],
                    "localized": [
                      "name",
                      "description"
                    ],
                    "name": [
                      {
                        "language_code": "en_us",
                        "string": "Base URL"
                      }
                    ],
                    "description": [
                      {
                        "language_code": "en_us",
                        "string": "You can find your base url in the UniFi Site Manager in <i>Settings -> Control Plane -> Integrations</i> in the <i>API Request Format</i> section, (e.g. <code>https://host_ip/proxy/network/integration/</code>)."
                      }
                    ]
                  },
                  {
                    "function": "UNIFIAPI_api_version",
                    "type": {
                      "dataType": "string",
                      "elements": [
                        {
                          "elementType": "input",
                          "elementOptions": [
                            {
                              "placeholder": "v1"
                            },
                            {
                              "cssClasses": "col-sm-10"
                            }
                          ],
                          "transformers": []
                        }
                      ]
                    },
                    "default_value": "default",
                    "options": [],
                    "localized": [
                      "name",
                      "description"
                    ],
                    "name": [
                      {
                        "language_code": "en_us",
                        "string": "API version"
                      }
                    ],
                    "description": [
                      {
                        "language_code": "en_us",
                        "string": "The version of the API (e.g.: <code>v1</code>)."
                      }
                    ]
                  },
                  {
                    "function": "UNIFIAPI_api_key",
                    "type": {
                      "dataType": "string",
                      "elements": [
                        {
                          "elementType": "input",
                          "elementOptions": [
                            {
                              "placeholder": "Enter value"
                            },
                            {
                              "cssClasses": "col-sm-10"
                            }
                          ],
                          "transformers": []
                        }
                      ]
                    },
                    "default_value": "default",
                    "options": [],
                    "localized": [
                      "name",
                      "description"
                    ],
                    "name": [
                      {
                        "language_code": "en_us",
                        "string": "API key"
                      }
                    ],
                    "description": [
                      {
                        "language_code": "en_us",
                        "string": "You can get an API key in your UniFi Site Manager in <i>Settings -> Control Plane -> Integrations</i>."
                      }
                    ]
                  },
                  {
                    "function": "UNIFIAPI_verify_ssl",
                    "type": {
                      "dataType": "boolean",
                      "elements": [
                        {
                          "elementType": "input",
                          "elementOptions": [
                            {
                              "type": "checkbox"
                            }
                          ],
                          "transformers": []
                        }
                      ]
                    },
                    "default_value": 1,
                    "options": [],
                    "localized": [
                      "name",
                      "description"
                    ],
                    "name": [
                      {
                        "language_code": "en_us",
                        "string": "Verify SSL"
                      }
                    ],
                    "description": [
                      {
                        "language_code": "en_us",
                        "string": "Disable if you do not have an SSL certificate set up."
                      }
                    ]
                  }
                ],
                "transformers": []
              }
            ],
            "transformers": [
              "name|base64"
            ]
          },
          {
            "elementType": "button",
            "elementOptions": [
              {
                "sourceSuffixes": []
              },
              {
                "separator": ""
              },
              {
                "cssClasses": "col-xs-6"
              },
              {
                "onClick": "removeFromList(this)"
              },
              {
                "getStringKey": "Gen_Remove_Last"
              }
            ],
            "transformers": []
          },
          {
            "elementType": "button",
            "elementOptions": [
              {
                "sourceSuffixes": []
              },
              {
                "separator": ""
              },
              {
                "cssClasses": "col-xs-6"
              },
              {
                "onClick": "removeAllOptions(this)"
              },
              {
                "getStringKey": "Gen_Remove_All"
              }
            ],
            "transformers": []
          }
        ]
      },
      "default_value": [],
      "options": [],
      "localized": [
        "name",
        "description"
      ],
      "name": [
        {
          "language_code": "en_us",
          "string": "Sites"
        }
      ],
      "description": [
        {
          "language_code": "en_us",
          "string": "UniFi site configurations. Use a unique name for each site. You can find necessary details to configure this in your controller under <i>Settings -> Control Plane -> Integrations</i>."
        }
      ]
    }
  ],
  "database_column_definitions": [
    {
      "column": "Index",
      "css_classes": "col-sm-2",
      "show": true,
      "type": "none",
      "default_value": "",
      "options": [],
      "localized": [
        "name"
      ],
      "name": [
        {
          "language_code": "en_us",
          "string": "Index"
        }
      ]
    },
    {
      "column": "Object_PrimaryID",
      "mapped_to_column": "cur_MAC",
      "css_classes": "col-sm-3",
      "show": true,
      "type": "device_name_mac",
      "default_value": "",
      "options": [],
      "localized": [
        "name"
      ],
      "name": [
        {
          "language_code": "en_us",
          "string": "MAC (name)"
        }
      ]
    },
    {
      "column": "Object_SecondaryID",
      "mapped_to_column": "cur_IP",
      "css_classes": "col-sm-2",
      "show": true,
      "type": "device_ip",
      "default_value": "",
      "options": [],
      "localized": [
        "name"
      ],
      "name": [
        {
          "language_code": "en_us",
          "string": "IP"
        }
      ]
    },
    {
      "column": "Watched_Value1",
      "mapped_to_column": "cur_Name",
      "css_classes": "col-sm-2",
      "show": true,
      "type": "label",
      "default_value": "",
      "options": [],
      "localized": [
        "name"
      ],
      "name": [
        {
          "language_code": "en_us",
          "string": "Name"
        }
      ]
    },
    {
      "column": "Watched_Value2",
      "mapped_to_column": "cur_Type",
      "css_classes": "col-sm-2",
      "show": true,
      "type": "label",
      "default_value": "",
      "options": [],
      "localized": [
        "name"
      ],
      "name": [
        {
          "language_code": "en_us",
          "string": "Device Type"
        }
      ]
    },
    {
      "column": "Watched_Value3",
      "css_classes": "col-sm-2",
      "show": true,
      "type": "label",
      "default_value": "",
      "options": [],
      "localized": [
        "name"
      ],
      "name": [
        {
          "language_code": "en_us",
          "string": "Connected"
        }
      ]
    },
    {
      "column": "Watched_Value4",
      "mapped_to_column": "cur_NetworkNodeMAC",
      "css_classes": "col-sm-2",
      "show": true,
      "type": "device_mac",
      "default_value": "",
      "options": [],
      "localized": [
        "name"
      ],
      "name": [
        {
          "language_code": "en_us",
          "string": "Parent"
        }
      ]
    },
    {
      "column": "Dummy",
      "mapped_to_column": "cur_ScanMethod",
      "mapped_to_column_data": {
        "value": "UNIFIAPI"
      },
      "css_classes": "col-sm-2",
      "show": false,
      "type": "label",
      "default_value": "",
      "options": [],
      "localized": [
        "name"
      ],
      "name": [
        {
          "language_code": "en_us",
          "string": "Scan method"
        }
      ]
    },
    {
      "column": "DateTimeCreated",
      "css_classes": "col-sm-2",
      "show": true,
      "type": "label",
      "default_value": "",
      "options": [],
      "localized": [
        "name"
      ],
      "name": [
        {
          "language_code": "en_us",
          "string": "Created"
        }
      ]
    },
    {
      "column": "DateTimeChanged",
      "css_classes": "col-sm-2",
      "show": true,
      "type": "label",
      "default_value": "",
      "options": [],
      "localized": [
        "name"
      ],
      "name": [
        {
          "language_code": "en_us",
          "string": "Changed"
        }
      ]
    },
    {
      "column": "Status",
      "css_classes": "col-sm-1",
      "show": true,
      "type": "replace",
      "default_value": "",
      "options": [
        {
          "equals": "watched-not-changed",
          "replacement": "<div style='text-align:center'><i class='fa-solid fa-square-check'></i><div></div>"
        },
        {
          "equals": "watched-changed",
          "replacement": "<div style='text-align:center'><i class='fa-solid fa-triangle-exclamation'></i></div>"
        },
        {
          "equals": "new",
          "replacement": "<div style='text-align:center'><i class='fa-solid fa-circle-plus'></i></div>"
        },
        {
          "equals": "missing-in-last-scan",
          "replacement": "<div style='text-align:center'><i class='fa-solid fa-question'></i></div>"
        }
      ],
      "localized": [
        "name"
      ],
      "name": [
        {
          "language_code": "en_us",
          "string": "Status"
        }
      ]
    }
  ]
}