editSRUUpdateImmediate

The editSRUUpdateImmediate operation handles configuration related to SRUUpdateImmediate model. 

Description

This API call is not allowed on the standby unit in an HA pair.

Data Parameters

Parameter Required Type Description
version False string A unique string version assigned by the system when the object is created or modified. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete an existing object. As the version will change every time the object is modified, the value provided in this identifier must match exactly what is present in the system or the request will be rejected.
scheduleType False string A mandatory enum value that specifies the type of job schedule. Only allowed value is:

IMMEDIATE - the job will be posted when the request is received.

Note that the job will be posted in the queue when it is received, but the actual execution can be delayed if other jobs were scheduled for execution at the same time or are being currently processed. After a system restart the job will not be recovered.

user False string The name of the user who requested the Rule Update.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
forceOperation False boolean For Internal use.
jobHistoryUuid False string The ID of the job status object created by this schedule object. Use this ID in the corresponding job API to check the job status.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
ipAddress False string IP address of actor who initiated a job execution
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
name False string The name of this Rule Update.
Field level constraints: length must be between 0 and 128 (inclusive), must match pattern ^[a-zA-Z0-9][a-zA-Z0-9_+-]*$. (Note: Additional constraints might exist)
description False string A string describing this object.
Field level constraints: length must be between 0 and 200 (inclusive). (Note: Additional constraints might exist)
sruImmediateJobType False string A value that indicates where the Rule Update originated.
forceUpdate False boolean A Boolean value, TRUE or FALSE (the default). The TRUE value indicates that the update will be performed even if the new update is older than the current Rule Update version.
deployAfterUpdate False boolean A Boolean value, TRUE or FALSE (the default). The TRUE value indicates that the Rule Update will be deployed after it is completed.
jobName False string See derived class.
id False string A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
type True string A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Path Parameters

Parameter Required Type Description
objId True string

Example

- name: Execute 'editSRUUpdateImmediate' operation
  ftd_configuration:
    operation: "editSRUUpdateImmediate"
    data:
        version: "{{ version }}"
        scheduleType: "{{ schedule_type }}"
        user: "{{ user }}"
        forceOperation: "{{ force_operation }}"
        jobHistoryUuid: "{{ job_history_uuid }}"
        ipAddress: "{{ ip_address }}"
        name: "{{ name }}"
        description: "{{ description }}"
        sruImmediateJobType: "{{ sru_immediate_job_type }}"
        forceUpdate: "{{ force_update }}"
        deployAfterUpdate: "{{ deploy_after_update }}"
        jobName: "{{ job_name }}"
        id: "{{ id }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"