Jobs Models
Overview
The Jobs models provide a structured way to track and monitor job status and details in Palo Alto Networks' Strata Cloud Manager. These models support both individual job status queries and paginated job list responses. The models handle validation and serialization of job data when interacting with the SCM API.
Attributes
JobDetails Model
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
| info | List[str] | No | [] | List of informational messages |
| errors | List[str] | No | [] | List of error messages |
| warnings | List[str] | No | [] | List of warning messages |
| description | str | No | None | Description of the job |
JobStatusData Model
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
| id | str | Yes | None | Unique identifier for the job |
| cfg_id | str | No | "" | Configuration ID |
| details | str | Yes | None | Job details in JSON format |
| dev_serial | str | No | "" | Device serial number |
| dev_uuid | str | No | "" | Device UUID |
| device_name | str | No | "" | Name of the device |
| device_type | str | No | "" | Type of device |
| end_ts | datetime | No | None | Job end timestamp |
| insert_ts | datetime | Yes | None | Job creation timestamp |
| job_result | str | Yes | None | Result of the job |
| job_status | str | Yes | None | Current status of the job |
| job_type | str | Yes | None | Type of job |
| last_update | datetime | Yes | None | Last update timestamp |
| owner | str | Yes | None | Job owner |
| parent_id | str | No | "0" | Parent job ID |
| percent | str | Yes | None | Job completion percentage |
| result_i | str | Yes | None | Numeric result code |
| result_str | str | Yes | None | String result description |
| session_id | str | No | "" | Session ID |
| start_ts | datetime | Yes | None | Job start timestamp |
| status_i | str | Yes | None | Numeric status code |
| status_str | str | Yes | None | String status description |
| summary | str | No | "" | Job summary |
| type_i | str | Yes | None | Numeric job type code |
| type_str | str | Yes | None | String job type description |
| uname | str | Yes | None | Username |
JobListItem Model
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
| id | str | Yes | None | Unique identifier for the job |
| device_name | str | No | "" | Name of the device |
| end_ts | str | No | None | Job end timestamp |
| job_result | str | Yes | None | Result of the job |
| job_status | str | Yes | None | Current status of the job |
| job_type | str | Yes | None | Type of job |
| parent_id | str | Yes | None | Parent job ID |
| percent | str | No | "" | Job completion percentage |
| result_str | str | Yes | None | String result description |
| start_ts | str | Yes | None | Job start timestamp |
| status_str | str | Yes | None | String status description |
| summary | str | No | "" | Job summary |
| type_str | str | Yes | None | String job type description |
| uname | str | Yes | None | Username |
| description | str | No | "" | Job description |
Model Validators
Timestamp Validation
The JobListItem model validates timestamp fields to handle empty strings:
from scm.models.operations import JobListItem
# Empty string timestamps are converted to Nonejob = JobListItem(
id="123",
job_result="SUCCESS",
job_status="COMPLETED",
job_type="CONFIG",
parent_id="0",
result_str="Success",
start_ts="2023-01-01T00:00:00",
end_ts="", # Will be converted to None
status_str="Completed",
type_str="Configuration",
uname="admin"
)
print(job.end_ts) # None
# Empty string timestamps are converted to Nonejob = JobListItem(
id="123",
job_result="SUCCESS",
job_status="COMPLETED",
job_type="CONFIG",
parent_id="0",
result_str="Success",
start_ts="2023-01-01T00:00:00",
end_ts="", # Will be converted to None
status_str="Completed",
type_str="Configuration",
uname="admin"
)
print(job.end_ts) # None
Datetime Serialization
The JobStatusData model automatically serializes datetime fields to ISO format strings:
from datetime import datetime
from scm.models.operations import JobStatusData
job = JobStatusData(
id="123",
details="{}",
insert_ts=datetime.now(),
job_result="SUCCESS",
job_status="COMPLETED",
job_type="CONFIG",
last_update=datetime.now(),
owner="admin",
percent="100",
result_i="1",
result_str="Success",
start_ts=datetime.now(),
status_i="2",
status_str="Completed",
type_i="3",
type_str="Configuration",
uname="admin"
)
data = job.model_dump()
print(data["start_ts"]) # "2023-12-20T10:15:30.123456"
from scm.models.operations import JobStatusData
job = JobStatusData(
id="123",
details="{}",
insert_ts=datetime.now(),
job_result="SUCCESS",
job_status="COMPLETED",
job_type="CONFIG",
last_update=datetime.now(),
owner="admin",
percent="100",
result_i="1",
result_str="Success",
start_ts=datetime.now(),
status_i="2",
status_str="Completed",
type_i="3",
type_str="Configuration",
uname="admin"
)
data = job.model_dump()
print(data["start_ts"]) # "2023-12-20T10:15:30.123456"
Usage Examples
Working with Job Details
from scm.models.operations import JobDetails
# Create job details with messagesdetails = JobDetails(
info=["Starting configuration push", "Configuration applied"],
warnings=["Device connection slow"],
errors=[],
description="Configuration update job"
)
# Access job detailsprint(details.info) # ["Starting configuration push", "Configuration applied"]
print(details.warnings) # ["Device connection slow"]
print(details.description) # "Configuration update job"
# Create job details with messagesdetails = JobDetails(
info=["Starting configuration push", "Configuration applied"],
warnings=["Device connection slow"],
errors=[],
description="Configuration update job"
)
# Access job detailsprint(details.info) # ["Starting configuration push", "Configuration applied"]
print(details.warnings) # ["Device connection slow"]
print(details.description) # "Configuration update job"
Processing Job Status Data
from scm.models.operations import JobStatusResponse, JobStatusData
from datetime import datetime
# Create job status datajob_data = JobStatusData(
id="123",
details="{}",
insert_ts=datetime.now(),
job_result="SUCCESS",
job_status="COMPLETED",
job_type="CONFIG",
last_update=datetime.now(),
owner="admin",
percent="100",
result_i="1",
result_str="Success",
start_ts=datetime.now(),
status_i="2",
status_str="Completed",
type_i="3",
type_str="Configuration",
uname="admin"
)
# Create response with job dataresponse = JobStatusResponse(data=[job_data])
# Access job status informationfor job in response.data:
print(f"Job {job.id}: {job.status_str} ({job.percent}%)")
from datetime import datetime
# Create job status datajob_data = JobStatusData(
id="123",
details="{}",
insert_ts=datetime.now(),
job_result="SUCCESS",
job_status="COMPLETED",
job_type="CONFIG",
last_update=datetime.now(),
owner="admin",
percent="100",
result_i="1",
result_str="Success",
start_ts=datetime.now(),
status_i="2",
status_str="Completed",
type_i="3",
type_str="Configuration",
uname="admin"
)
# Create response with job dataresponse = JobStatusResponse(data=[job_data])
# Access job status informationfor job in response.data:
print(f"Job {job.id}: {job.status_str} ({job.percent}%)")
Working with Job Lists
from scm.models.operations import JobListResponse, JobListItem
# Create job list itemsjobs = [
JobListItem(
id="123",
job_result="SUCCESS",
job_status="COMPLETED",
job_type="CONFIG",
parent_id="0",
result_str="Success",
start_ts="2023-01-01T00:00:00",
status_str="Completed",
type_str="Configuration",
uname="admin"
),
JobListItem(
id="124",
job_result="IN_PROGRESS",
job_status="RUNNING",
job_type="COMMIT",
parent_id="0",
result_str="In Progress",
start_ts="2023-01-01T00:15:00",
status_str="Running",
type_str="Commit",
uname="admin"
)
]
# Create paginated responseresponse = JobListResponse(
data=jobs,
total=100,
limit=10,
offset=0
)
# Process job listfor job in response.data:
print(f"Job {job.id}: {job.type_str} - {job.status_str}")
# Access pagination infoprint(f"Showing {len(response.data)} of {response.total} jobs")
# Create job list itemsjobs = [
JobListItem(
id="123",
job_result="SUCCESS",
job_status="COMPLETED",
job_type="CONFIG",
parent_id="0",
result_str="Success",
start_ts="2023-01-01T00:00:00",
status_str="Completed",
type_str="Configuration",
uname="admin"
),
JobListItem(
id="124",
job_result="IN_PROGRESS",
job_status="RUNNING",
job_type="COMMIT",
parent_id="0",
result_str="In Progress",
start_ts="2023-01-01T00:15:00",
status_str="Running",
type_str="Commit",
uname="admin"
)
]
# Create paginated responseresponse = JobListResponse(
data=jobs,
total=100,
limit=10,
offset=0
)
# Process job listfor job in response.data:
print(f"Job {job.id}: {job.type_str} - {job.status_str}")
# Access pagination infoprint(f"Showing {len(response.data)} of {response.total} jobs")