management.models.notifications

Module that contains all models corresponding to the devices app.

Module Contents

management.models.notifications.log

class management.models.notifications.NotificationStatus(*args, **kwargs)

Bases: django.db.models.Model

Model representing a status a notification can have.

class StatusChoices(*args, **kwds)

Bases: django.db.models.TextChoices

Status Types.

NEW

CONFIRMED

IN_PROGRESS

SOLVED

NOT_SOLVED

ESCALATED

SUSPENDED

REJECTED

DELETED

CLOSED

ACKNOWLEDGED

FAILED

EXPIRED

PENDING

status

get_status_display()

Gets the status as human-readable string for displaying in the front-end.

Returns:

Human-readable string for displaying in the front-end.

Return type:

str

class Meta

Bases: django_stubs_ext.db.models.TypedModelMeta

Meta class configuration.

class management.models.notifications.NotificationMessageModel(*args, **kwargs)

Bases: django.db.models.Model

Message Model for Notifications with Short and Optional Long Descriptions.

short_description

long_description

class Meta

Bases: django_stubs_ext.db.models.TypedModelMeta

Meta class configuration.

class management.models.notifications.NotificationMessage(short_description, long_description='No description provided')

Class for notification content with short and optional long descriptions.

Parameters:

• short_description (django_stubs_ext.StrOrPromise)

• long_description (django_stubs_ext.StrOrPromise)

short_description: str

long_description: str = 'No description provided'

property short: str

Returns the short description.

Returns:

The short description.

Return type:

str

property long: str

Returns the long description.

Returns:

The long description.

Return type:

str

class management.models.notifications.NotificationModel(*args, **kwargs)

Bases: django.db.models.Model

Notifications Model.

class NotificationTypes(*args, **kwds)

Bases: django.db.models.TextChoices

Supported Notification Types.

SETUP

INFO

WARNING

CRITICAL

class NotificationSource(*args, **kwds)

Bases: django.db.models.TextChoices

Origin of the Notification.

SYSTEM

DOMAIN

DEVICE

ISSUING_CA

CERTIFICATE

class NotificationMessageType(*args, **kwds)

Bases: django.db.models.TextChoices

Types of messages (aka. unique strings to that particular notification).

CUSTOM = ('C', 'custom')

ISSUING_CA_TEST = 'TEST_CA'

DOMAIN_TEST = 'TEST_DOMAIN'

CERT_TEST = 'TEST_CERT'

DEVICE_TEST = 'TEST_DEVICE'

WELCOME_POPULATE_TEST_DATA = 'POP_TEST_DATA'

TRUSTPOINT_DOCUMENTATION = 'TP_DOCS'

TRUSTPOINT_PROJECT_INFO = 'TP_INFO'

WELCOME_MESSAGE = 'WELCOME'

SYSTEM_NOT_HEALTHY = 'SYS_NOT_HEALTHY'

VULNERABILITY = 'VULNERABILITY'

CERT_EXPIRING = 'CERT_EXPIRING'

CERT_EXPIRED = 'CERT_EXPIRED'

ISSUING_CA_EXPIRING = 'CA_EXPIRING'

ISSUING_CA_EXPIRED = 'CA_EXPIRED'

DOMAIN_NO_ISSUING_CA = 'DOMAIN_NO_CA'

DEVICE_NOT_ONBOARDED = 'DEV_NOT_ONBRD'

DEVICE_ONBOARDING_FAILED = 'DEV_ONBRD_FAIL'

DEVICE_CERT_REVOKED = 'DEV_CERT_REV'

WEAK_SIGNATURE_ALGORITHM = 'WEAK_SIG_ALGO'

INSUFFICIENT_KEY_LENGTH = 'INSUFF_KEY_LEN'

WEAK_ECC_CURVE = 'WEAK_ECC_CURVE'

get_message()

Returns the message for the given type.

Returns:

The notification message.

Return type:

NotificationMessage

notification_type

notification_source

message_type

message_data

domain

certificate

device

issuing_ca

event

message

statuses

created_at

get_notification_type_display()

Gets the notification type as human-readable string for displaying in the front-end.

Returns:

Human-readable string for displaying in the front-end.

Return type:

str

class Meta

Bases: django_stubs_ext.db.models.TypedModelMeta

Meta class configuration.

property short_translated: Any

Returns the translated short description.

Returns:

The translated short description.

Return type:

Any

property long_translated: Any

Returns the translated long description.

Returns:

The translated long description.

Return type:

Any

class management.models.notifications.WeakECCCurve(*args, **kwargs)

Bases: django.db.models.Model

Represents a weak or deprecated ECC curve.

objects: django.db.models.Manager[WeakECCCurve]

class ECCCurveChoices(*args, **kwds)

Bases: django.db.models.TextChoices

Enumeration of weak or deprecated ECC curve OIDs.

SECP160R1

SECP192R1

SECP224R1

SECP256K1

oid

class management.models.notifications.WeakSignatureAlgorithm(*args, **kwargs)

Bases: django.db.models.Model

Represents a weak or deprecated signature algorithm.

objects: django.db.models.Manager[WeakSignatureAlgorithm]

class SignatureChoices(*args, **kwds)

Bases: django.db.models.TextChoices

Enumeration of weak or deprecated signature algorithm OIDs.

MD5

SHA1

SHA224

oid

class management.models.notifications.NotificationConfig(*args, **kwargs)

Bases: django.db.models.Model

Stores global configuration for notification thresholds and behaviors.

objects: django.db.models.Manager[NotificationConfig]

enabled

notification_cycle_enabled

notification_cycle_interval_hours

last_notification_check_started_at

cert_expiry_warning_days

issuing_ca_expiry_warning_days

class Meta

Meta class configuration.

verbose_name

classmethod get()

Ensure there’s always one settings object to use.

Return type:

NotificationConfig

property next_notification_check_scheduled_at: datetime.datetime | None

Returns when the next notification check is scheduled.

Queries Django-Q2’s schedule table to find the next scheduled notification check.

Returns:

The scheduled time for the next notification check,

or None if not enabled or not scheduled.

Return type:

datetime | None

schedule_next_notification_check(cycle_interval_hours=None)

Schedule the next notification execution using Django-Q2.

Creates a scheduled task in Django-Q2 that will execute all notifications at the calculated time. The task will automatically trigger notification checks without manual intervention.

Parameters:

cycle_interval_hours (float | None) – The number of hours until the next notification check should run. If None, uses the model’s notification_cycle_interval_hours setting.

Return type:

None