Panorama / Client / create_job_for_devices

create_job_for_devices#

Panorama.Client.create_job_for_devices(**kwargs)#

Creates a job to run on a device. A job can update a device’s software or reboot it.

Request Syntax

response = client.create_job_for_devices(
    DeviceIds=[
        'string',
    ],
    DeviceJobConfig={
        'OTAJobConfig': {
            'AllowMajorVersionUpdate': True|False,
            'ImageVersion': 'string'
        }
    },
    JobType='OTA'|'REBOOT'
)

Parameters:

DeviceIds (list) –
[REQUIRED]

ID of target device.
- (string) –
DeviceJobConfig (dict) –
Configuration settings for a software update job.
- OTAJobConfig (dict) –
  
  A configuration for an over-the-air (OTA) upgrade. Required for OTA jobs.
  - AllowMajorVersionUpdate (boolean) –
    
    Whether to apply the update if it is a major version change.
  - ImageVersion (string) – [REQUIRED]
    
    The target version of the device software.
JobType (string) –
[REQUIRED]

The type of job to run.

Return type:

dict

Returns:

Response Syntax

{
    'Jobs': [
        {
            'DeviceId': 'string',
            'JobId': 'string'
        },
    ]
}

Response Structure

(dict) –
- Jobs (list) –
  
  A list of jobs.
  - (dict) –
    
    A job for a device.
    - DeviceId (string) –
      
      The target device’s ID.
    - JobId (string) –
      
      The job’s ID.

Exceptions

Panorama.Client.exceptions.ConflictException
Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.ResourceNotFoundException
Panorama.Client.exceptions.InternalServerException