Skip to main content

Quarantined Devices Models

Overview​

Quarantined Devices allow you to manage devices that have been quarantined in Palo Alto Networks' Strata Cloud Manager. These models define the structure for creating and retrieving quarantined device configurations.

Models​

The module provides the following Pydantic models:

  • QuarantinedDevicesBaseModel: Base model with fields common to all quarantined device operations
  • QuarantinedDevicesCreateModel: Model for creating new quarantined devices
  • QuarantinedDevicesResponseModel: Response model for quarantined device operations
  • QuarantinedDevicesListParamsModel: Model for list operation filter parameters

All models use extra="forbid" configuration, which rejects any fields not explicitly defined in the model.

Base Models​

QuarantinedDevicesBaseModel​

The QuarantinedDevicesBaseModel contains fields common to all quarantined device CRUD operations.

AttributeTypeRequiredDefaultDescription
host_idstrYes-Device host ID
serial_numberOptional[str]NoNoneDevice serial number

QuarantinedDevicesCreateModel​

The QuarantinedDevicesCreateModel extends the base model for creating new quarantined devices.

AttributeTypeRequiredDefaultDescription
All attributes from QuarantinedDevicesBaseModel

QuarantinedDevicesResponseModel​

The QuarantinedDevicesResponseModel extends the base model and represents the API response.

AttributeTypeRequiredDefaultDescription
All attributes from QuarantinedDevicesBaseModel

QuarantinedDevicesListParamsModel​

The QuarantinedDevicesListParamsModel defines parameters for filtering list operations.

AttributeTypeRequiredDefaultDescription
host_idOptional[str]NoNoneFilter by device host ID
serial_numberOptional[str]NoNoneFilter by device serial number

Usage Examples​

Creating a Quarantined Device​

from scm.client import Scm

# Initialize client
client = Scm(
    client_id="your_client_id",
    client_secret="your_client_secret",
    tsg_id="your_tsg_id"
)

# Using dictionary
device_data = {
    "host_id": "device-12345",
    "serial_number": "PA-987654321"
}

response = client.quarantined_device.create(device_data)
print(f"Created device: {response.host_id}")

Listing Quarantined Devices with Filters​

# List all quarantined devices
all_devices = client.quarantined_device.list()

# List with host_id filter
filtered = client.quarantined_device.list(host_id="device-12345")

# List with serial_number filter
by_serial = client.quarantined_device.list(serial_number="PA-987654321")

# List with both filters
specific = client.quarantined_device.list(
    host_id="device-12345",
    serial_number="PA-987654321"
)

Deleting a Quarantined Device​

# Delete by host_id
client.quarantined_device.delete("device-12345")
print("Device deleted successfully")