Skip to content

Load Balancer Models API Package

nautobot_load_balancer_models.models

Models for Load Balancer Models.

CertificateProfile

Bases: PrimaryModel

CertificateProfile model for nautobot_load_balancer_models.

Source code in nautobot_load_balancer_models/models.py 
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
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
@extras_features(
    "custom_links",
    "custom_validators",
    "export_templates",
    "graphql",
    "webhooks",
)
class CertificateProfile(PrimaryModel):  # pylint: disable=too-many-ancestors
    """CertificateProfile model for nautobot_load_balancer_models."""

    name = models.CharField(
        max_length=CHARFIELD_MAX_LENGTH,
        unique=True,
    )
    certificate_type = models.CharField(
        max_length=CHARFIELD_MAX_LENGTH,
        choices=choices.CertificateTypeChoices,
        blank=True,
    )
    certificate_file_path = models.CharField(
        max_length=CHARFIELD_MAX_LENGTH,
        blank=True,
        verbose_name="Certificate file path",
    )
    chain_file_path = models.CharField(
        max_length=CHARFIELD_MAX_LENGTH,
        blank=True,
        verbose_name="Chain file path",
    )
    key_file_path = models.CharField(
        max_length=CHARFIELD_MAX_LENGTH,
        blank=True,
        verbose_name="Key file path",
    )
    expiration_date = models.DateTimeField(
        blank=True,
        null=True,
    )
    cipher = models.CharField(
        max_length=CHARFIELD_MAX_LENGTH,
        blank=True,
    )
    tenant = models.ForeignKey(
        to="tenancy.Tenant",
        related_name="certificate_profiles",
        verbose_name="Tenant",
        on_delete=models.PROTECT,
        blank=True,
        null=True,
    )
    clone_fields = [
        "certificate_type",
        "certificate_file_path",
        "chain_file_path",
        "key_file_path",
        "expiration_date",
        "cipher",
        "tenant",
    ]

    class Meta:
        """Meta class for CertificateProfile."""

        ordering = ["name"]
        verbose_name = "Certificate Profile"

    def __str__(self):
        """Stringify instance."""
        return self.name

Meta

Meta class for CertificateProfile.

Source code in nautobot_load_balancer_models/models.py 
348
349
350
351
352
class Meta:
    """Meta class for CertificateProfile."""

    ordering = ["name"]
    verbose_name = "Certificate Profile"

__str__()

Stringify instance.

Source code in nautobot_load_balancer_models/models.py 
354
355
356
def __str__(self):
    """Stringify instance."""
    return self.name

HealthCheckMonitor

Bases: PrimaryModel

HealthCheckMonitor model for nautobot_load_balancer_models.

Source code in nautobot_load_balancer_models/models.py 
254
255
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
282
283
284
285
@extras_features("custom_links", "custom_validators", "export_templates", "graphql", "webhooks")
class HealthCheckMonitor(PrimaryModel):  # pylint: disable=too-many-ancestors
    """HealthCheckMonitor model for nautobot_load_balancer_models."""

    name = models.CharField(max_length=CHARFIELD_MAX_LENGTH, unique=True)
    interval = models.PositiveIntegerField(blank=True, null=True)
    retry = models.PositiveIntegerField(blank=True, null=True, help_text="Number of retries before marking as down")
    timeout = models.PositiveIntegerField(blank=True, null=True)
    port = models.PositiveIntegerField(blank=True, null=True)
    health_check_type = models.CharField(
        max_length=CHARFIELD_MAX_LENGTH,
        choices=choices.HealthCheckTypeChoices,
        blank=True,
    )
    tenant = models.ForeignKey(
        to="tenancy.Tenant",
        related_name="health_check_monitors",
        on_delete=models.PROTECT,
        blank=True,
        null=True,
    )
    clone_fields = ["interval", "retry", "timeout", "port", "health_check_type", "tenant"]

    class Meta:
        """Meta class for HealthCheckMonitor."""

        ordering = ["name"]
        verbose_name = "Health Check Monitor"

    def __str__(self):
        """Stringify instance."""
        return self.name

Meta

Meta class for HealthCheckMonitor.

Source code in nautobot_load_balancer_models/models.py 
277
278
279
280
281
class Meta:
    """Meta class for HealthCheckMonitor."""

    ordering = ["name"]
    verbose_name = "Health Check Monitor"

__str__()

Stringify instance.

Source code in nautobot_load_balancer_models/models.py 
283
284
285
def __str__(self):
    """Stringify instance."""
    return self.name

LoadBalancerPool

Bases: PrimaryModel

LoadBalancerPool model for Load Balancer Models app.

Source code in nautobot_load_balancer_models/models.py 
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
169
170
@extras_features(
    "custom_links",
    "custom_validators",
    "export_templates",
    "graphql",
    "webhooks",
)
class LoadBalancerPool(PrimaryModel):  # pylint: disable=too-many-ancestors
    """LoadBalancerPool model for Load Balancer Models app."""

    name = models.CharField(max_length=CHARFIELD_MAX_LENGTH)
    # We will attempt to use Constance for the load balancer algorithm options, or statically define in choices.
    load_balancing_algorithm = models.CharField(
        max_length=CHARFIELD_MAX_LENGTH,
        choices=choices.LoadBalancingAlgorithmChoices,
    )
    health_check_monitor = models.ForeignKey(
        to="nautobot_load_balancer_models.HealthCheckMonitor",
        related_name="load_balancer_pools",
        verbose_name="Health Check Monitor",
        on_delete=models.PROTECT,
        blank=True,
        null=True,
    )
    tenant = models.ForeignKey(
        to="tenancy.Tenant",
        related_name="load_balancer_pools",
        on_delete=models.PROTECT,
        blank=True,
        null=True,
    )

    natural_key_field_names = ["pk"]
    clone_fields = ["load_balancing_algorithm", "health_check_monitor", "tenant"]

    class Meta:
        """Meta class for LoadBalancerPool."""

        ordering = ["name"]
        verbose_name = "Load Balancer Pool"

    def __str__(self):
        """Stringify instance."""
        return self.name

Meta

Meta class for LoadBalancerPool.

Source code in nautobot_load_balancer_models/models.py 
162
163
164
165
166
class Meta:
    """Meta class for LoadBalancerPool."""

    ordering = ["name"]
    verbose_name = "Load Balancer Pool"

__str__()

Stringify instance.

Source code in nautobot_load_balancer_models/models.py 
168
169
170
def __str__(self):
    """Stringify instance."""
    return self.name

LoadBalancerPoolMember

Bases: PrimaryModel

LoadBalancerPoolMember model for nautobot_load_balancer_models.

Source code in nautobot_load_balancer_models/models.py 
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
226
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
@extras_features(
    "custom_links",
    "custom_validators",
    "export_templates",
    "graphql",
    "statuses",
    "webhooks",
)
class LoadBalancerPoolMember(PrimaryModel):  # pylint: disable=too-many-ancestors
    """LoadBalancerPoolMember model for nautobot_load_balancer_models."""

    label = models.CharField(
        max_length=CHARFIELD_MAX_LENGTH,
        blank=True,
        help_text="Optional label for the load balancer pool member.",
    )
    ip_address = models.ForeignKey(
        to="ipam.IPAddress",
        related_name="load_balancer_pool_members",
        on_delete=models.CASCADE,
        verbose_name="IP Address",
    )
    load_balancer_pool = models.ForeignKey(
        to="nautobot_load_balancer_models.LoadBalancerPool",
        related_name="load_balancer_pool_members",
        on_delete=models.PROTECT,
    )
    port = models.PositiveIntegerField()
    ssl_offload = models.BooleanField(
        default=False,
        verbose_name="SSL Offload",
    )
    health_check_monitor = models.ForeignKey(
        to="nautobot_load_balancer_models.HealthCheckMonitor",
        related_name="load_balancer_pool_members",
        verbose_name="Health Check Monitor",
        on_delete=models.PROTECT,
        blank=True,
        null=True,
    )
    certificate_profiles = models.ManyToManyField(
        to="nautobot_load_balancer_models.CertificateProfile",
        related_name="load_balancer_pool_members",
        verbose_name="Certificate Profile",
        blank=True,
        through="nautobot_load_balancer_models.LoadBalancerPoolMemberCertificateProfileAssignment",
    )
    tenant = models.ForeignKey(
        to="tenancy.Tenant",
        related_name="load_balancer_pool_members",
        on_delete=models.PROTECT,
        blank=True,
        null=True,
    )
    status = StatusField(blank=False, null=False)

    clone_fields = [
        "load_balancer_pool",
        "port",
        "ssl_offload",
        "health_check_monitor",
        "tenant",
        "status",
    ]

    class Meta:
        """Meta class for LoadBalancerPoolMember."""

        unique_together = ["ip_address", "port", "load_balancer_pool"]
        verbose_name = "Load Balancer Pool Member"

    def __str__(self):
        """Stringify instance."""
        return f"{self.ip_address.host}:{self.port}"

    @property
    def display(self):
        """Return a string display of the object."""
        return f"{self.ip_address.host}:{self.port}"

display property

Return a string display of the object.

Meta

Meta class for LoadBalancerPoolMember.

Source code in nautobot_load_balancer_models/models.py 
238
239
240
241
242
class Meta:
    """Meta class for LoadBalancerPoolMember."""

    unique_together = ["ip_address", "port", "load_balancer_pool"]
    verbose_name = "Load Balancer Pool Member"

__str__()

Stringify instance.

Source code in nautobot_load_balancer_models/models.py 
244
245
246
def __str__(self):
    """Stringify instance."""
    return f"{self.ip_address.host}:{self.port}"

LoadBalancerPoolMemberCertificateProfileAssignment

Bases: BaseModel

LoadBalancerPoolMemberCertificateProfileAssignment model for nautobot_load_balancer_models.

Source code in nautobot_load_balancer_models/models.py 
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
@extras_features(
    "custom_links",
    "custom_validators",
    "export_templates",
    "graphql",
)
class LoadBalancerPoolMemberCertificateProfileAssignment(BaseModel):  # pylint: disable=too-many-ancestors
    """LoadBalancerPoolMemberCertificateProfileAssignment model for nautobot_load_balancer_models."""

    load_balancer_pool_member = models.ForeignKey(
        to="nautobot_load_balancer_models.LoadBalancerPoolMember",
        on_delete=models.CASCADE,
        related_name="certificate_profile_assignments",
    )
    certificate_profile = models.ForeignKey(
        to="nautobot_load_balancer_models.CertificateProfile",
        on_delete=models.CASCADE,
        related_name="load_balancer_pool_member_assignments",
    )
    is_metadata_associable_model = False

    class Meta:
        """Meta class for LoadBalancerPoolMemberCertificateProfileAssignment."""

        unique_together = ["load_balancer_pool_member", "certificate_profile"]
        ordering = ["load_balancer_pool_member", "certificate_profile"]

    def __str__(self):
        """Stringify instance."""
        return f"{self.load_balancer_pool_member}: {self.certificate_profile}"

Meta

Meta class for LoadBalancerPoolMemberCertificateProfileAssignment.

Source code in nautobot_load_balancer_models/models.py 
412
413
414
415
416
class Meta:
    """Meta class for LoadBalancerPoolMemberCertificateProfileAssignment."""

    unique_together = ["load_balancer_pool_member", "certificate_profile"]
    ordering = ["load_balancer_pool_member", "certificate_profile"]

__str__()

Stringify instance.

Source code in nautobot_load_balancer_models/models.py 
418
419
420
def __str__(self):
    """Stringify instance."""
    return f"{self.load_balancer_pool_member}: {self.certificate_profile}"

VirtualServer

Bases: PrimaryModel

Virtual Server model for Load Balancer Models app.

Source code in nautobot_load_balancer_models/models.py 
 10
 11
 12
 13
 14
 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
 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
@extras_features("custom_links", "custom_validators", "export_templates", "graphql", "webhooks")
class VirtualServer(PrimaryModel):  # pylint: disable=too-many-ancestors
    """Virtual Server model for Load Balancer Models app."""

    vip = models.ForeignKey(
        to="ipam.IPAddress", on_delete=models.PROTECT, related_name="virtual_servers", verbose_name="VIP"
    )
    name = models.CharField(max_length=CHARFIELD_MAX_LENGTH)
    port = models.PositiveIntegerField(blank=True, null=True)
    protocol = models.CharField(max_length=CHARFIELD_MAX_LENGTH, blank=True, choices=choices.ProtocolChoices)
    source_nat_pool = models.ForeignKey(
        to="ipam.Prefix",
        on_delete=models.PROTECT,
        blank=True,
        null=True,
        related_name="virtual_servers",
        verbose_name="Source NAT Pool",
    )
    source_nat_type = models.CharField(
        max_length=CHARFIELD_MAX_LENGTH,
        choices=choices.SourceNATTypeChoices,
        blank=True,
        verbose_name="Source NAT Type",
    )
    load_balancer_type = models.CharField(
        max_length=CHARFIELD_MAX_LENGTH, choices=choices.LoadBalancerTypeChoices, blank=True
    )
    enabled = models.BooleanField(default=True)
    ssl_offload = models.BooleanField(default=False, verbose_name="SSL Offload")
    # Assignment to a device, device redundancy group, cloud service or virtual chassis
    device = models.ForeignKey(
        to="dcim.Device",
        on_delete=models.PROTECT,
        blank=True,
        null=True,
        related_name="virtual_servers",
    )
    device_redundancy_group = models.ForeignKey(
        to="dcim.DeviceRedundancyGroup",
        on_delete=models.PROTECT,
        blank=True,
        null=True,
        related_name="virtual_servers",
    )
    cloud_service = models.ForeignKey(
        to="cloud.CloudService",
        on_delete=models.PROTECT,
        blank=True,
        null=True,
        related_name="virtual_servers",
    )
    virtual_chassis = models.ForeignKey(
        to="dcim.VirtualChassis",
        on_delete=models.PROTECT,
        blank=True,
        null=True,
        related_name="virtual_servers",
    )
    tenant = models.ForeignKey(
        to="tenancy.Tenant",
        on_delete=models.PROTECT,
        blank=True,
        null=True,
        related_name="virtual_servers",
    )
    load_balancer_pool = models.ForeignKey(
        to="nautobot_load_balancer_models.LoadBalancerPool",
        on_delete=models.PROTECT,
        blank=True,
        null=True,
        related_name="virtual_servers",
    )
    health_check_monitor = models.ForeignKey(
        to="nautobot_load_balancer_models.HealthCheckMonitor",
        related_name="virtual_servers",
        verbose_name="Health Check Monitor",
        on_delete=models.PROTECT,
        blank=True,
        null=True,
    )
    certificate_profiles = models.ManyToManyField(
        to="nautobot_load_balancer_models.CertificateProfile",
        related_name="virtual_servers",
        verbose_name="Certificate Profile",
        blank=True,
        through="nautobot_load_balancer_models.VirtualServerCertificateProfileAssignment",
    )

    clone_fields = [
        "port",
        "protocol",
        "source_nat_pool",
        "source_nat_type",
        "load_balancer_type",
        "enabled",
        "ssl_offload",
        "device",
        "device_redundancy_group",
        "cloud_service",
        "virtual_chassis",
        "tenant",
        "load_balancer_pool",
        "health_check_monitor",
    ]

    class Meta:
        """Meta class."""

        ordering = ["name"]
        unique_together = ["vip", "port", "protocol"]
        verbose_name = "Virtual Server"

    def __str__(self):
        """Stringify instance."""
        return self.name

Meta

Meta class.

Source code in nautobot_load_balancer_models/models.py 
115
116
117
118
119
120
class Meta:
    """Meta class."""

    ordering = ["name"]
    unique_together = ["vip", "port", "protocol"]
    verbose_name = "Virtual Server"

__str__()

Stringify instance.

Source code in nautobot_load_balancer_models/models.py 
122
123
124
def __str__(self):
    """Stringify instance."""
    return self.name

VirtualServerCertificateProfileAssignment

Bases: BaseModel

VirtualServerCertificateProfileAssignment model for nautobot_load_balancer_models.

Source code in nautobot_load_balancer_models/models.py 
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
388
@extras_features(
    "custom_links",
    "custom_validators",
    "export_templates",
    "graphql",
)
class VirtualServerCertificateProfileAssignment(BaseModel):  # pylint: disable=too-many-ancestors
    """VirtualServerCertificateProfileAssignment model for nautobot_load_balancer_models."""

    virtual_server = models.ForeignKey(
        to="nautobot_load_balancer_models.VirtualServer",
        on_delete=models.CASCADE,
        related_name="certificate_profile_assignments",
    )
    certificate_profile = models.ForeignKey(
        to="nautobot_load_balancer_models.CertificateProfile",
        on_delete=models.CASCADE,
        related_name="virtual_server_assignments",
    )
    is_metadata_associable_model = False

    class Meta:
        """Meta class for VirtualServerCertificateProfileAssignment."""

        unique_together = ["virtual_server", "certificate_profile"]
        ordering = ["virtual_server", "certificate_profile"]

    def __str__(self):
        """Stringify instance."""
        return f"{self.virtual_server}: {self.certificate_profile}"

Meta

Meta class for VirtualServerCertificateProfileAssignment.

Source code in nautobot_load_balancer_models/models.py 
380
381
382
383
384
class Meta:
    """Meta class for VirtualServerCertificateProfileAssignment."""

    unique_together = ["virtual_server", "certificate_profile"]
    ordering = ["virtual_server", "certificate_profile"]

__str__()

Stringify instance.

Source code in nautobot_load_balancer_models/models.py 
386
387
388
def __str__(self):
    """Stringify instance."""
    return f"{self.virtual_server}: {self.certificate_profile}"