nautobot 2.3.15b1__py3-none-any.whl → 2.4.0__py3-none-any.whl

nautobot/wireless/choices.py

@@ -0,0 +1,345 @@
+from nautobot.core.choices import ChoiceSet
+
+
+class RadioProfileChannelWidthChoices(ChoiceSet):
+    WIDTH_20MHZ = 20
+    WIDTH_40MHZ = 40
+    WIDTH_80MHZ = 80
+    WIDTH_160MHZ = 160
+
+    CHOICES = (
+        (WIDTH_20MHZ, "20 MHz"),
+        (WIDTH_40MHZ, "40 MHz"),
+        (WIDTH_80MHZ, "80 MHz"),
+        (WIDTH_160MHZ, "160 MHz"),
+    )
+
+
+class RadioProfileFrequencyChoices(ChoiceSet):
+    FREQUENCY_2_4G = "2.4GHz"
+    FREQUENCY_5G = "5GHz"
+    FREQUENCY_6G = "6GHz"
+
+    CHOICES = (
+        (FREQUENCY_2_4G, "2.4 GHz"),
+        (FREQUENCY_5G, "5 GHz"),
+        (FREQUENCY_6G, "6 GHz"),
+    )
+
+
+class SupportedDataRateStandardChoices(ChoiceSet):
+    A = "802.11a"
+    B = "802.11b"
+    G = "802.11g"
+    N = "802.11n"
+    AC = "802.11ac"
+    AX = "802.11ax"
+    BE = "802.11be"
+
+    CHOICES = (
+        (A, "802.11a"),
+        (B, "802.11b"),
+        (G, "802.11g"),
+        (N, "802.11n"),
+        (AC, "802.11ac"),
+        (AX, "802.11ax"),
+        (BE, "802.11be"),
+    )
+
+
+class WirelessNetworkModeChoices(ChoiceSet):
+    CENTRAL = "Central"
+    FABRIC = "Fabric"
+    STANDALONE = "Standalone (Autonomous)"
+    LOCAL = "Local (Flex)"
+    MESH = "Mesh"
+    BRIDGE = "Bridge"
+
+    CHOICES = (
+        (CENTRAL, "Central"),
+        (FABRIC, "Fabric"),
+        (STANDALONE, "Standalone (Autonomous)"),
+        (LOCAL, "Local (Flex)"),
+        (MESH, "Mesh"),
+        (BRIDGE, "Bridge"),
+    )
+
+
+class WirelessNetworkAuthenticationChoices(ChoiceSet):
+    OPEN = "Open"
+    WPA2_PERSONAL = "WPA2 Personal"
+    WPA2_ENTERPRISE = "WPA2 Enterprise"
+    ENHANCED_OPEN = "Enhanced Open"
+    WPA3_PERSONAL = "WPA3 Personal"
+    WPA3_SAE = "WPA3 SAE"
+    WPA3_ENTERPRISE = "WPA3 Enterprise"
+    WPA3_ENTERPRISE_192_BIT = "WPA3 Enterprise 192Bit"
+
+    CHOICES = (
+        (OPEN, "Open"),
+        (WPA2_PERSONAL, "WPA2 Personal"),
+        (WPA2_ENTERPRISE, "WPA2 Enterprise"),
+        (ENHANCED_OPEN, "Enhanced Open"),
+        (WPA3_PERSONAL, "WPA3 Personal"),
+        (WPA3_SAE, "WPA3 SAE"),
+        (WPA3_ENTERPRISE, "WPA3 Enterprise"),
+        (WPA3_ENTERPRISE_192_BIT, "WPA3 Enterprise 192Bit"),
+    )
+
+
+class RadioProfileRegulatoryDomainChoices(ChoiceSet):
+    AD = "AD"
+    AE = "AE"
+    AL = "AL"
+    AM = "AM"
+    AU = "AU"
+    AR = "AR"
+    AT = "AT"
+    AZ = "AZ"
+    BA = "BA"
+    BE = "BE"
+    BG = "BG"
+    BH = "BH"
+    BN = "BN"
+    BO = "BO"
+    BR = "BR"
+    BS = "BS"
+    BY = "BY"
+    BZ = "BZ"
+    CA = "CA"
+    CH = "CH"
+    CI = "CI"
+    CL = "CL"
+    CN = "CN"
+    CO = "CO"
+    CR = "CR"
+    RS = "RS"
+    CY = "CY"
+    CZ = "CZ"
+    DE = "DE"
+    DK = "DK"
+    DO = "DO"
+    DZ = "DZ"
+    EC = "EC"
+    EE = "EE"
+    EG = "EG"
+    ES = "ES"
+    FO = "FO"
+    FI = "FI"
+    FR = "FR"
+    GB = "GB"
+    GE = "GE"
+    GI = "GI"
+    GL = "GL"
+    GP = "GP"
+    GR = "GR"
+    GT = "GT"
+    GY = "GY"
+    HN = "HN"
+    HK = "HK"
+    HR = "HR"
+    HU = "HU"
+    IS = "IS"
+    IN = "IN"
+    ID = "ID"
+    IE = "IE"
+    IL = "IL"
+    IQ = "IQ"
+    IT = "IT"
+    IR = "IR"
+    JM = "JM"
+    JO = "JO"
+    JP = "JP"
+    KP = "KP"
+    KR = "KR"
+    KE = "KE"
+    KW = "KW"
+    KZ = "KZ"
+    LB = "LB"
+    LI = "LI"
+    LK = "LK"
+    LT = "LT"
+    LU = "LU"
+    LV = "LV"
+    LY = "LY"
+    MA = "MA"
+    MC = "MC"
+    MD = "MD"
+    MK = "MK"
+    MO = "MO"
+    MQ = "MQ"
+    MT = "MT"
+    MU = "MU"
+    MX = "MX"
+    MY = "MY"
+    NA = "NA"
+    NG = "NG"
+    NI = "NI"
+    NL = "NL"
+    NO = "NO"
+    NZ = "NZ"
+    OM = "OM"
+    PA = "PA"
+    PE = "PE"
+    PL = "PL"
+    PH = "PH"
+    PK = "PK"
+    PR = "PR"
+    PT = "PT"
+    PY = "PY"
+    QA = "QA"
+    RO = "RO"
+    RU = "RU"
+    SA = "SA"
+    SE = "SE"
+    SG = "SG"
+    SI = "SI"
+    SK = "SK"
+    SM = "SM"
+    SV = "SV"
+    SY = "SY"
+    TH = "TH"
+    TN = "TN"
+    TR = "TR"
+    TT = "TT"
+    TW = "TW"
+    UA = "UA"
+    US = "US"
+    UY = "UY"
+    UZ = "UZ"
+    VA = "VA"
+    VE = "VE"
+    VI = "VI"
+    VN = "VN"
+    YE = "YE"
+    ZA = "ZA"
+    ZW = "ZW"
+
+    CHOICES = (
+        (AD, "Andorra (AD)"),
+        (AE, "United Arab Emirates (AE)"),
+        (AL, "Albania (AL)"),
+        (AM, "Armenia (AM)"),
+        (AU, "Australia (AU)"),
+        (AR, "Argentina (AR)"),
+        (AT, "Austria (AT)"),
+        (AZ, "Azerbaijan (AZ)"),
+        (BA, "Bosnia and Herzegovina (BA)"),
+        (BE, "Belgium (BE)"),
+        (BG, "Bulgaria (BG)"),
+        (BH, "Bahrain (BH)"),
+        (BN, "Brunei Darussalam (BN)"),
+        (BO, "Bolivia (BO)"),
+        (BR, "Brazil (BR)"),
+        (BS, "Bahamas (BS)"),
+        (BY, "Belarus (BY)"),
+        (BZ, "Belize (BZ)"),
+        (CA, "Canada (CA)"),
+        (CH, "Switzerland (CH)"),
+        (CI, "Cote d'Ivoire (CI)"),
+        (CL, "Chile (CL)"),
+        (CN, "China (CN)"),
+        (CO, "Colombia (CO)"),
+        (CR, "Costa Rica (CR)"),
+        (RS, "Serbia (RS)"),
+        (CY, "Cyprus (CY)"),
+        (CZ, "Czech Republic (CZ)"),
+        (DE, "Germany (DE)"),
+        (DK, "Denmark (DK)"),
+        (DO, "Dominican Republic (DO)"),
+        (DZ, "Algeria (DZ)"),
+        (EC, "Ecuador (EC)"),
+        (EE, "Estonia (EE)"),
+        (EG, "Egypt (EG)"),
+        (ES, "Spain (ES)"),
+        (FO, "Faroe Islands (FO)"),
+        (FI, "Finland (FI)"),
+        (FR, "France (FR)"),
+        (GB, "United Kingdom (GB)"),
+        (GE, "Georgia (GE)"),
+        (GI, "Gibraltar (GI)"),
+        (GL, "Greenland (GL)"),
+        (GP, "Guadeloupe (GP)"),
+        (GR, "Greece (GR)"),
+        (GT, "Guatemala (GT)"),
+        (GY, "Guyana (GY)"),
+        (HN, "Honduras (HN)"),
+        (HK, "Hong Kong (HK)"),
+        (HR, "Croatia (HR)"),
+        (HU, "Hungary (HU)"),
+        (IS, "Iceland (IS)"),
+        (IN, "India (IN)"),
+        (ID, "Indonesia (ID)"),
+        (IE, "Ireland (IE)"),
+        (IL, "Israel (IL)"),
+        (IQ, "Iraq (IQ)"),
+        (IT, "Italy (IT)"),
+        (IR, "Iran (IR)"),
+        (JM, "Jamaica (JM)"),
+        (JO, "Jordan (JO)"),
+        (JP, "Japan (JP)"),
+        (KP, "North Korea (KP)"),
+        (KR, "South Korea (KR)"),
+        (KE, "Kenya (KE)"),
+        (KW, "Kuwait (KW)"),
+        (KZ, "Kazakhstan (KZ)"),
+        (LB, "Lebanon (LB)"),
+        (LI, "Liechtenstein (LI)"),
+        (LK, "Sri Lanka (LK)"),
+        (LT, "Lithuania (LT)"),
+        (LU, "Luxembourg (LU)"),
+        (LV, "Latvia (LV)"),
+        (LY, "Libya (LY)"),
+        (MA, "Morocco (MA)"),
+        (MC, "Monaco (MC)"),
+        (MD, "Moldova (MD)"),
+        (MK, "Macedonia (MK)"),
+        (MO, "Macau (MO)"),
+        (MQ, "Martinique (MQ)"),
+        (MT, "Malta (MT)"),
+        (MU, "Mauritius (MU)"),
+        (MX, "Mexico (MX)"),
+        (MY, "Malaysia (MY)"),
+        (NA, "Namibia (NA)"),
+        (NG, "Nigeria (NG)"),
+        (NI, "Nicaragua (NI)"),
+        (NL, "Netherlands (NL)"),
+        (NO, "Norway (NO)"),
+        (NZ, "New Zealand (NZ)"),
+        (OM, "Oman (OM)"),
+        (PA, "Panama (PA)"),
+        (PE, "Peru (PE)"),
+        (PL, "Poland (PL)"),
+        (PH, "Philippines (PH)"),
+        (PK, "Pakistan (PK)"),
+        (PR, "Puerto Rico (PR)"),
+        (PT, "Portugal (PT)"),
+        (PY, "Paraguay (PY)"),
+        (QA, "Qatar (QA)"),
+        (RO, "Romania (RO)"),
+        (RU, "Russia (RU)"),
+        (SA, "Saudi Arabia (SA)"),
+        (SE, "Sweden (SE)"),
+        (SG, "Singapore (SG)"),
+        (SI, "Slovenia (SI)"),
+        (SK, "Slovakia (SK)"),
+        (SM, "San Marino (SM)"),
+        (SV, "El Salvador (SV)"),
+        (SY, "Syria (SY)"),
+        (TH, "Thailand (TH)"),
+        (TN, "Tunisia (TN)"),
+        (TR, "Turkey (TR)"),
+        (TT, "Trinidad and Tobago (TT)"),
+        (TW, "Taiwan (TW)"),
+        (UA, "Ukraine (UA)"),
+        (US, "United States (US)"),
+        (UY, "Uruguay (UY)"),
+        (UZ, "Uzbekistan (UZ)"),
+        (VA, "Vatican City (VA)"),
+        (VE, "Venezuela (VE)"),
+        (VI, "Virgin Islands (VI)"),
+        (VN, "Vietnam (VN)"),
+        (YE, "Yemen (YE)"),
+        (ZA, "South Africa (ZA)"),
+        (ZW, "Zimbabwe (ZW)"),
+    )

nautobot/wireless/factory.py

@@ -0,0 +1,138 @@
+import factory
+import faker
+
+from nautobot.core.factory import (
+    BaseModelFactory,
+    get_random_instances,
+    NautobotBoolIterator,
+    PrimaryModelFactory,
+    random_instance,
+    UniqueFaker,
+)
+from nautobot.dcim.factory import ControllerManagedDeviceGroupFactory, DeviceFactory
+from nautobot.ipam.models import VLAN
+from nautobot.tenancy.models import Tenant
+from nautobot.wireless import models
+from nautobot.wireless.choices import (
+    RadioProfileChannelWidthChoices,
+    RadioProfileFrequencyChoices,
+    RadioProfileRegulatoryDomainChoices,
+    SupportedDataRateStandardChoices,
+    WirelessNetworkAuthenticationChoices,
+    WirelessNetworkModeChoices,
+)
+
+
+class SupportedDataRateFactory(PrimaryModelFactory):
+    class Meta:
+        model = models.SupportedDataRate
+
+    standard = factory.Faker("random_element", elements=SupportedDataRateStandardChoices.values())
+    rate = UniqueFaker("pyint", min_value=1000, max_value=164000, step=1000)
+    mcs_index = factory.Faker("pyint", min_value=0, max_value=9)
+
+
+class RadioProfileFactory(PrimaryModelFactory):
+    class Meta:
+        model = models.RadioProfile
+
+    name = UniqueFaker("word")
+    frequency = factory.Faker("random_element", elements=RadioProfileFrequencyChoices.values())
+    channel_width = factory.LazyFunction(
+        lambda: sorted(faker.Faker().random_elements(RadioProfileChannelWidthChoices.values(), unique=True))
+    )
+    regulatory_domain = factory.Faker("random_element", elements=RadioProfileRegulatoryDomainChoices.values())
+    tx_power_min = factory.Faker("pyint", min_value=1, max_value=5)
+    tx_power_max = factory.Faker("pyint", min_value=6, max_value=30)
+    rx_power_min = factory.Faker("pyint", min_value=1, max_value=10)
+    allowed_channel_list = factory.LazyFunction(
+        lambda: sorted(faker.Faker().random_elements([1, 6, 11, 36, 161, 165], unique=True))
+    )
+
+    @factory.post_generation
+    def supported_data_rates(self, create, extracted, **kwargs):
+        if create:
+            if extracted:
+                self.supported_data_rates.set(extracted)
+            else:
+                self.supported_data_rates.set(get_random_instances(models.SupportedDataRate, minimum=0))
+
+
+class WirelessNetworkFactory(PrimaryModelFactory):
+    class Meta:
+        model = models.WirelessNetwork
+        exclude = ("has_description", "has_tenant")
+
+    name = UniqueFaker("word")
+    has_description = NautobotBoolIterator()
+    description = factory.Maybe("has_description", factory.Faker("sentence"), "")
+    ssid = factory.Faker("word")
+    mode = factory.Faker("random_element", elements=WirelessNetworkModeChoices.values())
+    enabled = NautobotBoolIterator()
+    authentication = factory.Faker("random_element", elements=WirelessNetworkAuthenticationChoices.values())
+    # TODO: once SecretsGroupFactory is implemented:
+    # has_secrets_group = NautobotBoolIterator()
+    # secrets_group = factory.Maybe(
+    #     "has_secrets_group",
+    #     random_instance(SecretsGroup),
+    # )
+    hidden = NautobotBoolIterator()
+    has_tenant = NautobotBoolIterator()
+    tenant = factory.Maybe("has_tenant", random_instance(Tenant), None)
+
+
+class ControllerManagedDeviceGroupWirelessNetworkAssignmentFactory(BaseModelFactory):
+    class Meta:
+        model = models.ControllerManagedDeviceGroupWirelessNetworkAssignment
+
+    controller_managed_device_group = factory.SubFactory(ControllerManagedDeviceGroupFactory, capabilities=["wireless"])
+    wireless_network = factory.SubFactory(WirelessNetworkFactory)
+    vlan = random_instance(VLAN, allow_null=True)
+
+
+class ControllerManagedDeviceGroupRadioProfileAssignmentFactory(BaseModelFactory):
+    class Meta:
+        model = models.ControllerManagedDeviceGroupRadioProfileAssignment
+
+    controller_managed_device_group = factory.SubFactory(ControllerManagedDeviceGroupFactory, capabilities=["wireless"])
+    radio_profile = factory.SubFactory(RadioProfileFactory)
+
+
+class ControllerManagedDeviceGroupWithMembersFactory(ControllerManagedDeviceGroupFactory):
+    capabilities = ["wireless"]
+    wireless1 = factory.RelatedFactory(
+        ControllerManagedDeviceGroupWirelessNetworkAssignmentFactory,
+        factory_related_name="controller_managed_device_group",
+    )
+    wireless2 = factory.RelatedFactory(
+        ControllerManagedDeviceGroupWirelessNetworkAssignmentFactory,
+        factory_related_name="controller_managed_device_group",
+    )
+    radio1 = factory.RelatedFactory(
+        ControllerManagedDeviceGroupRadioProfileAssignmentFactory,
+        factory_related_name="controller_managed_device_group",
+    )
+    radio2 = factory.RelatedFactory(
+        ControllerManagedDeviceGroupRadioProfileAssignmentFactory,
+        factory_related_name="controller_managed_device_group",
+    )
+    device1 = factory.RelatedFactory(DeviceFactory, factory_related_name="controller_managed_device_group")
+    device2 = factory.RelatedFactory(DeviceFactory, factory_related_name="controller_managed_device_group")
+
+
+class RadioProfilesWithMembersFactory(RadioProfileFactory):
+    controller_managed_device_group1 = factory.RelatedFactory(
+        ControllerManagedDeviceGroupRadioProfileAssignmentFactory, factory_related_name="radio_profile"
+    )
+    controller_managed_device_group2 = factory.RelatedFactory(
+        ControllerManagedDeviceGroupRadioProfileAssignmentFactory, factory_related_name="radio_profile"
+    )
+
+
+class WirelessNetworksWithMembersFactory(WirelessNetworkFactory):
+    controller_managed_device_group1 = factory.RelatedFactory(
+        ControllerManagedDeviceGroupWirelessNetworkAssignmentFactory, factory_related_name="wireless_network"
+    )
+    controller_managed_device_group2 = factory.RelatedFactory(
+        ControllerManagedDeviceGroupWirelessNetworkAssignmentFactory, factory_related_name="wireless_network"
+    )

nautobot/wireless/filters.py

@@ -0,0 +1,167 @@
+import django_filters
+
+from nautobot.core.filters import (
+    BaseFilterSet,
+    NaturalKeyOrPKMultipleChoiceFilter,
+    NumericArrayFilter,
+    RelatedMembershipBooleanFilter,
+    SearchFilter,
+)
+from nautobot.dcim.models import ControllerManagedDeviceGroup
+from nautobot.extras.filters import NautobotFilterSet
+from nautobot.extras.models import SecretsGroup
+from nautobot.tenancy.filters import TenancyModelFilterSetMixin
+from nautobot.wireless import choices, models
+
+
+class SupportedDataRateFilterSet(BaseFilterSet):
+    q = SearchFilter(
+        filter_predicates={
+            "rate": {
+                "lookup_expr": "exact",
+                "preprocessor": int,
+            },
+            "standard": "icontains",
+            "mcs_index": {
+                "lookup_expr": "exact",
+                "preprocessor": int,
+            },
+        }
+    )
+    radio_profiles = NaturalKeyOrPKMultipleChoiceFilter(
+        queryset=models.RadioProfile.objects.all(),
+        to_field_name="name",
+        label="Radio Profile (name or ID)",
+    )
+    has_radio_profiles = RelatedMembershipBooleanFilter(
+        field_name="radio_profiles",
+        label="Has radio profiles",
+    )
+
+    class Meta:
+        model = models.SupportedDataRate
+        fields = "__all__"
+
+
+class RadioProfileFilterSet(NautobotFilterSet):
+    q = SearchFilter(
+        filter_predicates={
+            "name": "icontains",
+            "regulatory_domain": "icontains",
+            "frequency": "exact",
+        }
+    )
+    regulatory_domain = django_filters.MultipleChoiceFilter(
+        choices=choices.RadioProfileRegulatoryDomainChoices,
+        null_value=None,
+    )
+    channel_width = NumericArrayFilter(
+        field_name="channel_width",
+        lookup_expr="contains",
+    )
+    frequency = django_filters.MultipleChoiceFilter(
+        choices=choices.RadioProfileFrequencyChoices,
+        null_value=None,
+    )
+    controller_managed_device_groups = NaturalKeyOrPKMultipleChoiceFilter(
+        queryset=ControllerManagedDeviceGroup.objects.all(),
+        to_field_name="name",
+        label="Controller Managed Device Groups (name or ID)",
+    )
+    has_controller_managed_device_groups = RelatedMembershipBooleanFilter(
+        field_name="controller_managed_device_groups",
+        label="Has controller managed device groups",
+    )
+
+    class Meta:
+        model = models.RadioProfile
+        fields = "__all__"
+
+
+class WirelessNetworkFilterSet(NautobotFilterSet, TenancyModelFilterSetMixin):
+    q = SearchFilter(
+        filter_predicates={
+            "name": "icontains",
+            "description": "icontains",
+            "ssid": "icontains",
+        }
+    )
+    mode = django_filters.MultipleChoiceFilter(
+        choices=choices.WirelessNetworkModeChoices,
+        null_value=None,
+    )
+    enabled = django_filters.BooleanFilter()
+    authentication = django_filters.MultipleChoiceFilter(
+        choices=choices.WirelessNetworkAuthenticationChoices,
+        null_value=None,
+    )
+    secrets_group = NaturalKeyOrPKMultipleChoiceFilter(
+        field_name="secrets_group",
+        queryset=SecretsGroup.objects.all(),
+        to_field_name="name",
+        label="Secrets group (name or ID)",
+    )
+    controller_managed_device_groups = NaturalKeyOrPKMultipleChoiceFilter(
+        queryset=ControllerManagedDeviceGroup.objects.all(),
+        to_field_name="name",
+        label="Controller Managed Device Groups (name or ID)",
+    )
+    has_controller_managed_device_groups = RelatedMembershipBooleanFilter(
+        field_name="controller_managed_device_groups",
+        label="Has controller managed device groups",
+    )
+    hidden = django_filters.BooleanFilter()
+
+    class Meta:
+        model = models.WirelessNetwork
+        fields = "__all__"
+
+
+class ControllerManagedDeviceGroupWirelessNetworkAssignmentFilterSet(BaseFilterSet):
+    q = SearchFilter(
+        filter_predicates={
+            "controller_managed_device_group__name": "icontains",
+            "wireless_network__name": "icontains",
+        }
+    )
+    controller_managed_device_group = NaturalKeyOrPKMultipleChoiceFilter(
+        field_name="controller_managed_device_group",
+        queryset=ControllerManagedDeviceGroup.objects.all(),
+        to_field_name="name",
+        label="Controller Managed Device Group (name or ID)",
+    )
+    wireless_network = NaturalKeyOrPKMultipleChoiceFilter(
+        field_name="wireless_network",
+        queryset=models.WirelessNetwork.objects.all(),
+        to_field_name="name",
+        label="Wireless Network (name or ID)",
+    )
+
+    class Meta:
+        model = models.ControllerManagedDeviceGroupWirelessNetworkAssignment
+        fields = "__all__"
+
+
+class ControllerManagedDeviceGroupRadioProfileAssignmentFilterSet(BaseFilterSet):
+    q = SearchFilter(
+        filter_predicates={
+            "controller_managed_device_group__name": "icontains",
+            "radio_profile__name": "icontains",
+        }
+    )
+    controller_managed_device_group = NaturalKeyOrPKMultipleChoiceFilter(
+        field_name="controller_managed_device_group",
+        queryset=ControllerManagedDeviceGroup.objects.all(),
+        to_field_name="name",
+        label="Controller Managed Device Group (name or ID)",
+    )
+    radio_profile = NaturalKeyOrPKMultipleChoiceFilter(
+        field_name="radio_profile",
+        queryset=models.RadioProfile.objects.all(),
+        to_field_name="name",
+        label="Radio Profile (name or ID)",
+    )
+
+    class Meta:
+        model = models.ControllerManagedDeviceGroupRadioProfileAssignment
+        fields = "__all__"